Class SeamHttpClientSessions

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpClientSessions

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(
      parameters?: {
          connect_webview_ids?: string[];
          connected_account_ids?: string[];
          customer_id?: string;
          customer_key?: string;
          expires_at?: Date;
          user_identifier_key?: string;
          user_identity_id?: string;
          user_identity_ids?: string[];
      },
      options?: ClientSessionsCreateOptions,
  ): ClientSessionsCreateRequest

  Parameters

  • Optionalparameters: {
        connect_webview_ids?: string[];
        connected_account_ids?: string[];
        customer_id?: string;
        customer_key?: string;
        expires_at?: Date;
        user_identifier_key?: string;
        user_identity_id?: string;
        user_identity_ids?: string[];
    }

    • Optionalconnect_webview_ids?: string[]

      IDs of the Connect Webviews for which you want to create a client session.

    • Optionalconnected_account_ids?: string[]

      IDs of the connected accounts for which you want to create a client session.

    • Optionalcustomer_id?: string

      Customer ID that you want to associate with the new client session.

    • Optionalcustomer_key?: string

      Customer key that you want to associate with the new client session.

    • Optionalexpires_at?: Date

      Date and time at which the client session should expire, in ISO 8601 format.

    • Optionaluser_identifier_key?: string

      Your user ID for the user for whom you want to create a client session.

    • Optionaluser_identity_id?: string

      ID of the user identity for which you want to create a client session.

    • Optionaluser_identity_ids?: string[]

      IDs of the user identities that you want to associate with the client session.

      Deprecated

      Use user_identity_id instead.

  • options: ClientSessionsCreateOptions = {}

  Returns ClientSessionsCreateRequest

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>

delete

• delete(
      parameters?: { client_session_id: string },
      options?: ClientSessionsDeleteOptions,
  ): ClientSessionsDeleteRequest

  Parameters

  • Optionalparameters: { client_session_id: string }

    • client_session_id: string

      ID of the client session that you want to delete.
  • options: ClientSessionsDeleteOptions = {}

  Returns ClientSessionsDeleteRequest

get

• get(
      parameters?: {
          client_session_id?: string;
          user_identifier_key?: string;
      },
      options?: ClientSessionsGetOptions,
  ): ClientSessionsGetRequest

  Parameters

  • Optionalparameters: { client_session_id?: string; user_identifier_key?: string }

    • Optionalclient_session_id?: string

      ID of the client session that you want to get.

    • Optionaluser_identifier_key?: string

      User identifier key associated with the client session that you want to get.
  • options: ClientSessionsGetOptions = {}

  Returns ClientSessionsGetRequest

getOrCreate

• getOrCreate(
      parameters?: {
          connect_webview_ids?: string[];
          connected_account_ids?: string[];
          expires_at?: Date;
          user_identifier_key?: string;
          user_identity_id?: string;
          user_identity_ids?: string[];
      },
      options?: ClientSessionsGetOrCreateOptions,
  ): ClientSessionsGetOrCreateRequest

  Parameters

  • Optionalparameters: {
        connect_webview_ids?: string[];
        connected_account_ids?: string[];
        expires_at?: Date;
        user_identifier_key?: string;
        user_identity_id?: string;
        user_identity_ids?: string[];
    }

    • Optionalconnect_webview_ids?: string[]

      IDs of the Connect Webviews that you want to associate with the client session (or that are already associated with the existing client session).

    • Optionalconnected_account_ids?: string[]

      IDs of the connected accounts that you want to associate with the client session (or that are already associated with the existing client session).

    • Optionalexpires_at?: Date

      Date and time at which the client session should expire in ISO 8601 format. If the client session already exists, this will update the expiration before returning it.

    • Optionaluser_identifier_key?: string

      Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to associate with the client session (or that are already associated with the existing client session).

    • Optionaluser_identity_ids?: string[]

      IDs of the user identities that you want to associate with the client session.

      Deprecated

      Use user_identity_id.

  • options: ClientSessionsGetOrCreateOptions = {}

  Returns ClientSessionsGetOrCreateRequest

grantAccess

• grantAccess(
      parameters?: {
          client_session_id?: string;
          connect_webview_ids?: string[];
          connected_account_ids?: string[];
          user_identifier_key?: string;
          user_identity_id?: string;
          user_identity_ids?: string[];
      },
      options?: ClientSessionsGrantAccessOptions,
  ): ClientSessionsGrantAccessRequest

  Parameters

  • Optionalparameters: {
        client_session_id?: string;
        connect_webview_ids?: string[];
        connected_account_ids?: string[];
        user_identifier_key?: string;
        user_identity_id?: string;
        user_identity_ids?: string[];
    }

    • Optionalclient_session_id?: string

      ID of the client session to which you want to grant access to resources.

    • Optionalconnect_webview_ids?: string[]

      IDs of the Connect Webviews that you want to associate with the client session.

    • Optionalconnected_account_ids?: string[]

      IDs of the connected accounts that you want to associate with the client session.

    • Optionaluser_identifier_key?: string

      Your user ID for the user that you want to associate with the client session.

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to associate with the client session.

    • Optionaluser_identity_ids?: string[]

      IDs of the user identities that you want to associate with the client session.

      Deprecated

      Use user_identity_id.

  • options: ClientSessionsGrantAccessOptions = {}

  Returns ClientSessionsGrantAccessRequest

list

• list(
      parameters?: {
          client_session_id?: string;
          connect_webview_id?: string;
          user_identifier_key?: string;
          user_identity_id?: string;
          without_user_identifier_key?: boolean;
      },
      options?: ClientSessionsListOptions,
  ): ClientSessionsListRequest

  Parameters

  • Optionalparameters: {
        client_session_id?: string;
        connect_webview_id?: string;
        user_identifier_key?: string;
        user_identity_id?: string;
        without_user_identifier_key?: boolean;
    }

    • Optionalclient_session_id?: string

      ID of the client session that you want to retrieve.

    • Optionalconnect_webview_id?: string

      ID of the Connect Webview for which you want to retrieve client sessions.

    • Optionaluser_identifier_key?: string

      Your user ID for the user by which you want to filter client sessions.

    • Optionaluser_identity_id?: string

      ID of the user identity for which you want to retrieve client sessions.

    • Optionalwithout_user_identifier_key?: boolean

      Indicates whether to retrieve only client sessions without associated user identifier keys.
  • options: ClientSessionsListOptions = {}

  Returns ClientSessionsListRequest

revoke

• revoke(
      parameters?: { client_session_id: string },
      options?: ClientSessionsRevokeOptions,
  ): ClientSessionsRevokeRequest

  Parameters

  • Optionalparameters: { client_session_id: string }

    • client_session_id: string

      ID of the client session that you want to revoke.
  • options: ClientSessionsRevokeOptions = {}

  Returns ClientSessionsRevokeRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromClient

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

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpClientSessions>