Class SeamHttpConnectedAccounts

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectedAccounts

client

Readonlydefaults

simulate

• get simulate(): SeamHttpConnectedAccountsSimulate

  Client for the Seam API /connected_accounts/simulate routes.

  Returns SeamHttpConnectedAccountsSimulate

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>

delete

• delete(
      parameters: ConnectedAccountsDeleteParameters,
      options?: ConnectedAccountsDeleteOptions,
  ): ConnectedAccountsDeleteRequest

  Deletes a specified connected account.

  Deleting a connected account triggers a connected_account.deleted event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.

  For example, if you delete a connected account with a device that has an access code, Seam sends a connected_account.deleted event, a device.deleted event, and an access_code.deleted event, but Seam does not remove the access code from the device.

  Parameters

  • parameters: ConnectedAccountsDeleteParameters
  • options: ConnectedAccountsDeleteOptions = {}

  Returns ConnectedAccountsDeleteRequest

get

• get(
      parameters: ConnectedAccountsGetParameters,
      options?: ConnectedAccountsGetOptions,
  ): ConnectedAccountsGetRequest

  Returns a specified connected account.

  Parameters

  • parameters: ConnectedAccountsGetParameters
  • options: ConnectedAccountsGetOptions = {}

  Returns ConnectedAccountsGetRequest

list

• list(
      parameters?: ConnectedAccountsListParameters,
      options?: ConnectedAccountsListOptions,
  ): ConnectedAccountsListRequest

  Returns a list of all connected accounts.

  Parameters

  • Optionalparameters: ConnectedAccountsListParameters
  • options: ConnectedAccountsListOptions = {}

  Returns ConnectedAccountsListRequest

sync

• sync(
      parameters: ConnectedAccountsSyncParameters,
      options?: ConnectedAccountsSyncOptions,
  ): ConnectedAccountsSyncRequest

  Request a connected account sync attempt for the specified connected_account_id.

  Parameters

  • parameters: ConnectedAccountsSyncParameters
  • options: ConnectedAccountsSyncOptions = {}

  Returns ConnectedAccountsSyncRequest

update

• update(
      parameters: ConnectedAccountsUpdateParameters,
      options?: ConnectedAccountsUpdateOptions,
  ): ConnectedAccountsUpdateRequest

  Updates a connected account.

  Parameters

  • parameters: ConnectedAccountsUpdateParameters
  • options: ConnectedAccountsUpdateOptions = {}

  Returns ConnectedAccountsUpdateRequest

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">,
  ): SeamHttpConnectedAccounts

  Creates a new SeamHttpConnectedAccounts authenticated with an API key.

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromClient

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

  Creates a new SeamHttpConnectedAccounts from an existing HTTP client.

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromClientSessionToken

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

  Creates a new SeamHttpConnectedAccounts authenticated with a client session token.

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpConnectedAccounts

StaticfromPublishableKey

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

  Creates a new SeamHttpConnectedAccounts 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<SeamHttpConnectedAccounts>