Class SeamHttpWorkspaces

constructor

• new SeamHttpWorkspaces(apiKeyOrOptions?): SeamHttpWorkspaces

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWorkspaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      workspace: {
          company_name: string;
          connect_partner_name: null | string;
          connect_webview_customization: {
              inviter_logo_url?: string;
              logo_shape?: "circle" | "square";
              primary_button_color?: string;
              primary_button_text_color?: string;
              success_message?: string;
          };
          is_sandbox: boolean;
          is_suspended: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

• Parameters

  • Optionalbody: {
        company_name?: string;
        connect_partner_name?: null | string;
        connect_webview_customization?: {
            logo_shape?: null | "circle" | "square";
            primary_button_color?: null | string;
            primary_button_text_color?: null | string;
            success_message?: null | string;
        };
        is_sandbox?: boolean;
        name: string;
        webview_logo_shape?: "circle" | "square";
        webview_primary_button_color?: string;
        webview_primary_button_text_color?: string;
        webview_success_message?: string;
    }

    • Optionalcompany_name?: string

      Company name for the new workspace.

    • Optionalconnect_partner_name?: null | string

      Connect partner name for the new workspace.

    • Optionalconnect_webview_customization?: {
          logo_shape?: null | "circle" | "square";
          primary_button_color?: null | string;
          primary_button_text_color?: null | string;
          success_message?: null | string;
      }

      Connect Webview customizations for the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionallogo_shape?: null | "circle" | "square"

        Logo shape for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalprimary_button_color?: null | string

        Primary button color for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalprimary_button_text_color?: null | string

        Primary button text color for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalsuccess_message?: null | string

        Success message for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

    • Optionalis_sandbox?: boolean

      Indicates whether the new workspace is a sandbox workspace.

    • name: string

      Name of the new workspace.

    • Optionalwebview_logo_shape?: "circle" | "square"

      Deprecated

      Use connect_webview_customization.webview_logo_shape instead.

    • Optionalwebview_primary_button_color?: string

      Deprecated

      Use connect_webview_customization.webview_primary_button_color instead.

    • Optionalwebview_primary_button_text_color?: string

      Deprecated

      Use connect_webview_customization.webview_primary_button_text_color instead.

    • Optionalwebview_success_message?: string

      Deprecated

      Use connect_webview_customization.webview_success_message instead.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      workspace: {
          company_name: string;
          connect_partner_name: null | string;
          connect_webview_customization: {
              inviter_logo_url?: string;
              logo_shape?: "circle" | "square";
              primary_button_color?: string;
              primary_button_text_color?: string;
              success_message?: string;
          };
          is_sandbox: boolean;
          is_suspended: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      workspace: {
          company_name: string;
          connect_partner_name: null | string;
          connect_webview_customization: {
              inviter_logo_url?: string;
              logo_shape?: "circle" | "square";
              primary_button_color?: string;
              primary_button_text_color?: string;
              success_message?: string;
          };
          is_sandbox: boolean;
          is_suspended: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

• Parameters

  • Optionalparams: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      workspace: {
          company_name: string;
          connect_partner_name: null | string;
          connect_webview_customization: {
              inviter_logo_url?: string;
              logo_shape?: "circle" | "square";
              primary_button_color?: string;
              primary_button_text_color?: string;
              success_message?: string;
          };
          is_sandbox: boolean;
          is_suspended: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      workspaces: {
          company_name: string;
          connect_partner_name: null | string;
          connect_webview_customization: {
              inviter_logo_url?: string;
              logo_shape?: "circle" | "square";
              primary_button_color?: string;
              primary_button_text_color?: string;
              success_message?: string;
          };
          is_sandbox: boolean;
          is_suspended: boolean;
          name: string;
          workspace_id: string;
      }[];
  }>, "workspaces">, "workspaces">

• Parameters

  • Optionalparams: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      workspaces: {
          company_name: string;
          connect_partner_name: null | string;
          connect_webview_customization: {
              inviter_logo_url?: string;
              logo_shape?: "circle" | "square";
              primary_button_color?: string;
              primary_button_text_color?: string;
              success_message?: string;
          };
          is_sandbox: boolean;
          is_suspended: boolean;
          name: string;
          workspace_id: string;
      }[];
  }>, "workspaces">, "workspaces">

resetSandbox

• resetSandbox(body?, options?): SeamHttpRequest<SetNonNullable<Required<{
      action_attempt:
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: {
                  acs_credential_on_encoder: null | {
                      card_number: null | string;
                      created_at: null | string;
                      ends_at: null | string;
                      is_issued: null | boolean;
                      starts_at: null | string;
                      visionline_metadata?: {
                          cancelled: ...;
                          card_format: ...;
                          card_holder?: ...;
                          card_id: ...;
                          common_acs_entrance_ids?: ...;
                          discarded: ...;
                          expired: ...;
                          guest_acs_entrance_ids?: ...;
                          number_of_issued_cards: ...;
                          overridden?: ...;
                          overwritten: ...;
                          pending_auto_update: ...;
                      };
                  };
                  acs_credential_on_seam: null | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: true;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  } | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: false;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  };
                  warnings: {
                      warning_code: "acs_credential_on_encoder_out_of_sync" | "acs_credential_on_seam_not_found";
                      warning_message: string;
                  }[];
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: {
                  message: string;
                  type: "uncategorized_error";
              } | {
                  message: string;
                  type: "action_attempt_expired";
              } | {
                  message: string;
                  type: "no_credential_on_encoder";
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: {
                  access_method_id: string;
                  created_at: string;
                  display_name: string;
                  instant_key_url?: string;
                  is_card_encoding_required?: boolean;
                  issued_at?: string;
                  mode: "code" | "card" | "mobile_key";
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: true;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              } | {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: false;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          };
  }>, "action_attempt">, "action_attempt">

• Parameters

  • Optionalbody: {}
  • options: WorkspacesResetSandboxOptions = {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      action_attempt:
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: {
                  acs_credential_on_encoder: null | {
                      card_number: null | string;
                      created_at: null | string;
                      ends_at: null | string;
                      is_issued: null | boolean;
                      starts_at: null | string;
                      visionline_metadata?: {
                          cancelled: ...;
                          card_format: ...;
                          card_holder?: ...;
                          card_id: ...;
                          common_acs_entrance_ids?: ...;
                          discarded: ...;
                          expired: ...;
                          guest_acs_entrance_ids?: ...;
                          number_of_issued_cards: ...;
                          overridden?: ...;
                          overwritten: ...;
                          pending_auto_update: ...;
                      };
                  };
                  acs_credential_on_seam: null | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: true;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  } | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: false;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  };
                  warnings: {
                      warning_code: "acs_credential_on_encoder_out_of_sync" | "acs_credential_on_seam_not_found";
                      warning_message: string;
                  }[];
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: {
                  message: string;
                  type: "uncategorized_error";
              } | {
                  message: string;
                  type: "action_attempt_expired";
              } | {
                  message: string;
                  type: "no_credential_on_encoder";
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: {
                  access_method_id: string;
                  created_at: string;
                  display_name: string;
                  instant_key_url?: string;
                  is_card_encoding_required?: boolean;
                  issued_at?: string;
                  mode: "code" | "card" | "mobile_key";
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: true;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              } | {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: false;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          };
  }>, "action_attempt">, "action_attempt">