Class SeamHttpPhones

constructor

• new SeamHttpPhones(apiKeyOrOptions?): SeamHttpPhones

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpPhones

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

simulate

• get simulate(): SeamHttpPhonesSimulate

• Returns SeamHttpPhonesSimulate

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>

deactivate

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

• Parameters

  • Optionalparams: {
        device_id: string;
    }

    • device_id: string

      Device ID of the phone that you want to deactivate.

  Returns SeamHttpRequest<void, undefined>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      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;
          }[];
          nickname?: string;
          properties: {
              assa_abloy_credential_service_metadata?: {
                  endpoints: {
                      endpoint_id: string;
                      is_active: boolean;
                  }[];
                  has_active_endpoint: boolean;
              };
              salto_space_credential_service_metadata?: {
                  has_active_phone: boolean;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
  }>, "phone">, "phone">

• Parameters

  • Optionalparams: {
        device_id: string;
    }

    • device_id: string

      Device ID of the phone that you want to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      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;
          }[];
          nickname?: string;
          properties: {
              assa_abloy_credential_service_metadata?: {
                  endpoints: {
                      endpoint_id: string;
                      is_active: boolean;
                  }[];
                  has_active_endpoint: boolean;
              };
              salto_space_credential_service_metadata?: {
                  has_active_phone: boolean;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
  }>, "phone">, "phone">

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      phones: {
          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;
          }[];
          nickname?: string;
          properties: {
              assa_abloy_credential_service_metadata?: {
                  endpoints: {
                      endpoint_id: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
              salto_space_credential_service_metadata?: {
                  has_active_phone: boolean;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "phones">, "phones">

• Parameters

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

    • Optionalacs_credential_id?: string

      ID of the credential by which you want to filter the list of returned phones.

    • Optionalowner_user_identity_id?: string

      ID of the user identity that represents the owner by which you want to filter the list of returned phones.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      phones: {
          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;
          }[];
          nickname?: string;
          properties: {
              assa_abloy_credential_service_metadata?: {
                  endpoints: {
                      endpoint_id: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
              salto_space_credential_service_metadata?: {
                  has_active_phone: 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>