Class SeamHttpPhonesSimulate

constructor

• new SeamHttpPhonesSimulate(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpPhonesSimulate

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpPhonesSimulate

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

createSandboxPhone

• createSandboxPhone(
      parameters?: {
          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;
      },
      options?: PhonesSimulateCreateSandboxPhoneOptions,
  ): PhonesSimulateCreateSandboxPhoneRequest

  Parameters

  • Optionalparameters: {
        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;
    }

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

      ASSA ABLOY metadata that you want to associate with the simulated phone.

      • Optionalapplication_version?: string

        Application version that you want to use for the simulated phone.

      • Optionalble_capability?: boolean

        Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.

      • Optionalhce_capability?: boolean

        Indicates whether the simulated phone should have host card emulation (HCE) capability.

      • Optionalnfc_capability?: boolean

        Indicates whether the simulated phone should have near-field communication (NFC) capability.

      • Optionalseos_applet_version?: string

        SEOS applet version that you want to use for the simulated phone.

      • Optionalseos_tsm_endpoint_id?: number

        ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.

    • Optionalcustom_sdk_installation_id?: string

      ID of the custom SDK installation that you want to use for the simulated phone.

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

      Metadata that you want to associate with the simulated phone.

      • Optionaldevice_manufacturer?: string

        Manufacturer that you want to use for the simulated phone.

      • Optionaldevice_model?: string

        Device model that you want to use for the simulated phone.

      • Optionaloperating_system?: "android" | "ios"

        Mobile operating system that you want to use for the simulated phone.

      • Optionalos_version?: string

        Mobile operating system version that you want to use for the simulated phone.

    • user_identity_id: string

      ID of the user identity that you want to associate with the simulated phone.
  • options: PhonesSimulateCreateSandboxPhoneOptions = {}

  Returns PhonesSimulateCreateSandboxPhoneRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpPhonesSimulate

  Parameters

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

  Returns SeamHttpPhonesSimulate

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpPhonesSimulate

  Parameters

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

  Returns SeamHttpPhonesSimulate

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpPhonesSimulate

  Parameters

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

  Returns SeamHttpPhonesSimulate

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpPhonesSimulate

  Parameters

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

  Returns SeamHttpPhonesSimulate

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpPhonesSimulate

  Parameters

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

  Returns SeamHttpPhonesSimulate

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpPhonesSimulate>