Class SeamHttpPhonesSimulate

constructor

• new SeamHttpPhonesSimulate(apiKeyOrOptions?): SeamHttpPhonesSimulate

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpPhonesSimulate

client

Readonly defaults

createSandboxPhone

• createSandboxPhone(body?): SeamHttpRequest<SetNonNullable<Required<{
      phone: {
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_removal?: boolean;
          capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "ios_phone" | "android_phone";
          display_name: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: 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;
      };
  }>, "phone">, "phone">

• Parameters

  • Optional body: {
        assa_abloy_metadata?: {
            application_version?: string;
            ble_capability?: boolean;
            hce_capability?: boolean;
            nfc_capability?: boolean;
            seos_applet_version?: string;
            seos_tsm_endpoint_id?: number;
        };
        custom_sdk_installation_id?: string;
        phone_metadata?: {
            device_manufacturer?: string;
            device_model?: string;
            operating_system?: "android" | "ios";
            os_version?: string;
        };
        user_identity_id: string;
    }

    • Optional assa_abloy_metadata?: {
          application_version?: string;
          ble_capability?: boolean;
          hce_capability?: boolean;
          nfc_capability?: boolean;
          seos_applet_version?: string;
          seos_tsm_endpoint_id?: number;
      }

      • Optional application_version?: string

      • Optional ble_capability?: boolean

      • Optional hce_capability?: boolean

      • Optional nfc_capability?: boolean

      • Optional seos_applet_version?: string

      • Optional seos_tsm_endpoint_id?: number

    • Optional custom_sdk_installation_id?: string

    • Optional phone_metadata?: {
          device_manufacturer?: string;
          device_model?: string;
          operating_system?: "android" | "ios";
          os_version?: string;
      }

      • Optional device_manufacturer?: string

      • Optional device_model?: string

      • Optional operating_system?: "android" | "ios"

      • Optional os_version?: string

    • user_identity_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      phone: {
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_removal?: boolean;
          capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          device_id: string;
          device_type: "ios_phone" | "android_phone";
          display_name: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: 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;
      };
  }>, "phone">, "phone">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpPhonesSimulate

• Parameters

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

  Returns SeamHttpPhonesSimulate

Static fromClient

• fromClient(client, options?): SeamHttpPhonesSimulate

• Parameters

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

  Returns SeamHttpPhonesSimulate

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpPhonesSimulate

• Parameters

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

  Returns SeamHttpPhonesSimulate

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpPhonesSimulate

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpPhonesSimulate

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpPhonesSimulate>