Class SeamHttpSeamInstantKeyV1ClientSessions

constructor

• new SeamHttpSeamInstantKeyV1ClientSessions(apiKeyOrOptions?): SeamHttpSeamInstantKeyV1ClientSessions

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamInstantKeyV1ClientSessions

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>

exchangeShortCode

• exchangeShortCode(body?): SeamHttpRequest<SetNonNullable<Required<{
      client_session: {
          client_session_id: string;
          connect_webview_ids: string[];
          connected_account_ids: string[];
          created_at: string;
          customer_id?: string;
          device_count: number;
          expires_at: string;
          token: string;
          user_identifier_key: null | string;
          user_identity_id?: string;
          user_identity_ids: string[];
          workspace_id: string;
      };
  }>, "client_session">, "client_session">

• Parameters

  • Optionalbody: {
        short_code: string;
    }

    • short_code: string

      Short code that you want to exchange for a client session token.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      client_session: {
          client_session_id: string;
          connect_webview_ids: string[];
          connected_account_ids: string[];
          created_at: string;
          customer_id?: string;
          device_count: number;
          expires_at: string;
          token: string;
          user_identifier_key: null | string;
          user_identity_id?: string;
          user_identity_ids: string[];
          workspace_id: string;
      };
  }>, "client_session">, "client_session">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamInstantKeyV1ClientSessions

• Parameters

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

  Returns SeamHttpSeamInstantKeyV1ClientSessions

StaticfromClient

• fromClient(client, options?): SeamHttpSeamInstantKeyV1ClientSessions

• Parameters

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

  Returns SeamHttpSeamInstantKeyV1ClientSessions

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamInstantKeyV1ClientSessions

• Parameters

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

  Returns SeamHttpSeamInstantKeyV1ClientSessions

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSeamInstantKeyV1ClientSessions

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSeamInstantKeyV1ClientSessions

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamInstantKeyV1ClientSessions>