Class SeamHttpSeamMobileSdkV1PhoneSessions

constructor

• new SeamHttpSeamMobileSdkV1PhoneSessions(apiKeyOrOptions?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

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>

getOrCreate

• getOrCreate(body?): SeamHttpRequest<SetNonNullable<Required<{
      phone_session: {
          provider_sessions: {
              acs_credentials: {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: null | string;
                  acs_credential_pool_id?: string;
                  acs_entrances: {
                      acs_entrance_id: ...;
                      acs_system_id: ...;
                      assa_abloy_vostio_metadata?: ...;
                      connected_account_id: ...;
                      created_at: ...;
                      display_name: ...;
                      dormakaba_community_metadata?: ...;
                      errors: ...;
                      latch_metadata?: ...;
                      salto_ks_metadata?: ...;
                      salto_space_metadata?: ...;
                      visionline_metadata?: ...;
                  }[];
                  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;
              }[];
              phone_registration: {
                  is_being_activated: boolean;
                  phone_registration_id: string;
                  provider_name: null | string;
                  provider_state?: any;
              };
          }[];
      };
  }>, "phone_session">, "phone_session">

• Parameters

  • Optionalbody: {
        custom_sdk_installation_id: string;
        phone_device_metadata?: {
            manufacturer?: string;
            model?: string;
            os_version?: string;
        };
        phone_os: "android" | "ios";
    }

    • custom_sdk_installation_id: string

      ID of the custom SDK installation that you want to use for the new session.

    • Optionalphone_device_metadata?: {
          manufacturer?: string;
          model?: string;
          os_version?: string;
      }

      Phone device metadata that you want to use for the new session.

      • Optionalmanufacturer?: string

      • Optionalmodel?: string

      • Optionalos_version?: string

    • phone_os: "android" | "ios"

      Phone operating system that you want to use for the new session.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      phone_session: {
          provider_sessions: {
              acs_credentials: {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: null | string;
                  acs_credential_pool_id?: string;
                  acs_entrances: {
                      acs_entrance_id: ...;
                      acs_system_id: ...;
                      assa_abloy_vostio_metadata?: ...;
                      connected_account_id: ...;
                      created_at: ...;
                      display_name: ...;
                      dormakaba_community_metadata?: ...;
                      errors: ...;
                      latch_metadata?: ...;
                      salto_ks_metadata?: ...;
                      salto_space_metadata?: ...;
                      visionline_metadata?: ...;
                  }[];
                  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;
              }[];
              phone_registration: {
                  is_being_activated: boolean;
                  phone_registration_id: string;
                  provider_name: null | string;
                  provider_state?: any;
              };
          }[];
      };
  }>, "phone_session">, "phone_session">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromClient

• fromClient(client, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamMobileSdkV1PhoneSessions>