Class SeamHttpPhones

constructor

• new SeamHttpPhones(apiKeyOrOptions?: string | SeamHttpOptions): SeamHttpPhones

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpPhones

client

Readonlydefaults

simulate

• get simulate(): SeamHttpPhonesSimulate

  Client for the Seam API /phones/simulate routes.

  Returns SeamHttpPhonesSimulate

createPaginator

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

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

deactivate

• deactivate(
      parameters: PhonesDeactivateParameters,
      options?: PhonesDeactivateOptions,
  ): PhonesDeactivateRequest

  Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see App User Lost Phone Process.

  Parameters

  • parameters: PhonesDeactivateParameters
  • options: PhonesDeactivateOptions = {}

  Returns PhonesDeactivateRequest

get

• get(
      parameters: PhonesGetParameters,
      options?: PhonesGetOptions,
  ): PhonesGetRequest

  Returns a specified phone.

  Parameters

  • parameters: PhonesGetParameters
  • options: PhonesGetOptions = {}

  Returns PhonesGetRequest

list

• list(
      parameters?: PhonesListParameters,
      options?: PhonesListOptions,
  ): PhonesListRequest

  Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the owner_user_identity_id or acs_credential_id, respectively, in the request body.

  Parameters

  • Optionalparameters: PhonesListParameters
  • options: PhonesListOptions = {}

  Returns PhonesListRequest

updateClientSessionToken

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

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpPhones authenticated with an API key.

  Parameters

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

  Returns SeamHttpPhones

StaticfromClient

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

  Creates a new SeamHttpPhones from an existing HTTP client.

  Parameters

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

  Returns SeamHttpPhones

StaticfromClientSessionToken

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

  Creates a new SeamHttpPhones authenticated with a client session token.

  Parameters

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

  Returns SeamHttpPhones

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpPhones authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpPhones

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpPhones authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpPhones

StaticfromPublishableKey

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

  Creates a new SeamHttpPhones authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpPhones>