Class SeamHttpPhones

constructor

• new SeamHttpPhones(apiKeyOrOptions?): SeamHttpPhones

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpPhones

client

Readonly defaults

deactivate

• deactivate(body?): Promise<void>

• Parameters

  • Optional body: {
        device_id: string;
    }

    • device_id: string

  Returns Promise<void>

list

• list(body?): Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      created_at: string;
      custom_metadata?: Record<string, null | string | boolean>;
      device_id: string;
      device_type: "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        owner_user_identity_id?: string;
    }

    • Optional owner_user_identity_id?: string

  Returns Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      created_at: string;
      custom_metadata?: Record<string, null | string | boolean>;
      device_id: string;
      device_type: "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpPhones

• Parameters

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

  Returns SeamHttpPhones

Static fromClient

• fromClient(client, options?): SeamHttpPhones

• Parameters

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

  Returns SeamHttpPhones

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpPhones

• Parameters

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

  Returns SeamHttpPhones

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpPhones

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpPhones

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpPhones>