Class SeamHttpPhones

constructor

• new SeamHttpPhones(apiKeyOrOptions?): SeamHttpPhones

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpPhones

client

Readonlydefaults

simulate

• get simulate(): SeamHttpPhonesSimulate

• Returns SeamHttpPhonesSimulate

deactivate

• deactivate(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        device_id: string;
    }

    • device_id: string

  Returns SeamHttpRequest<void, undefined>

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      phones: {
          can_hvac_cool?: boolean;
          can_hvac_heat?: boolean;
          can_hvac_heat_cool?: boolean;
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_connection?: boolean;
          can_simulate_disconnection?: boolean;
          can_simulate_removal?: boolean;
          can_turn_off_hvac?: boolean;
          capabilities_supported: (
              | "access_code"
              | "phone"
              | "lock"
              | "noise_detection"
              | "thermostat"
              | "battery")[];
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "ios_phone" | "android_phone";
          display_name: string;
          errors: (
              | {
                  error_code: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "account_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "salto_site_user_limit_reached";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: string;
                  is_connected_account_error: true;
                  message: string;
              })[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              assa_abloy_credential_service_metadata?: {
                  endpoints: {
                      endpoint_id: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "phones">, "phones">

• Parameters

  • Optionalbody: {
        acs_credential_id?: string;
        owner_user_identity_id?: string;
    }

    • Optionalacs_credential_id?: string

    • Optionalowner_user_identity_id?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      phones: {
          can_hvac_cool?: boolean;
          can_hvac_heat?: boolean;
          can_hvac_heat_cool?: boolean;
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_connection?: boolean;
          can_simulate_disconnection?: boolean;
          can_simulate_removal?: boolean;
          can_turn_off_hvac?: boolean;
          capabilities_supported: (
              | "access_code"
              | "phone"
              | "lock"
              | "noise_detection"
              | "thermostat"
              | "battery")[];
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "ios_phone" | "android_phone";
          display_name: string;
          errors: (
              | {
                  error_code: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "account_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "salto_site_user_limit_reached";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: string;
                  is_connected_account_error: true;
                  message: string;
              })[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              assa_abloy_credential_service_metadata?: {
                  endpoints: {
                      endpoint_id: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "phones">, "phones">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpPhones

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpPhones

StaticfromClient

• fromClient(client, options?): SeamHttpPhones

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpPhones

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpPhones

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpPhones

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpPhones

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpPhones

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpPhones

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpPhones

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpPhones>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpPhones>