Class SeamHttpClientSessions

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpClientSessions

client

Readonlydefaults

create

• create(
      parameters?: ClientSessionsCreateParameters,
      options?: ClientSessionsCreateOptions,
  ): ClientSessionsCreateRequest

  Creates a new client session.

  Parameters

  • Optionalparameters: ClientSessionsCreateParameters
  • options: ClientSessionsCreateOptions = {}

  Returns ClientSessionsCreateRequest

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: ClientSessionsDeleteParameters,
      options?: ClientSessionsDeleteOptions,
  ): ClientSessionsDeleteRequest

  Deletes a client session.

  Parameters

  • parameters: ClientSessionsDeleteParameters
  • options: ClientSessionsDeleteOptions = {}

  Returns ClientSessionsDeleteRequest

get

• get(
      parameters?: ClientSessionsGetParameters,
      options?: ClientSessionsGetOptions,
  ): ClientSessionsGetRequest

  Returns a specified client session.

  Parameters

  • Optionalparameters: ClientSessionsGetParameters
  • options: ClientSessionsGetOptions = {}

  Returns ClientSessionsGetRequest

getOrCreate

• getOrCreate(
      parameters?: ClientSessionsGetOrCreateParameters,
      options?: ClientSessionsGetOrCreateOptions,
  ): ClientSessionsGetOrCreateRequest

  Returns a client session with specific characteristics or creates a new client session with these characteristics if it does not yet exist.

  Parameters

  • Optionalparameters: ClientSessionsGetOrCreateParameters
  • options: ClientSessionsGetOrCreateOptions = {}

  Returns ClientSessionsGetOrCreateRequest

grantAccess

• grantAccess(
      parameters: ClientSessionsGrantAccessParameters,
      options?: ClientSessionsGrantAccessOptions,
  ): ClientSessionsGrantAccessRequest

  Grants a client session access to one or more resources, such as Connect Webviews, user identities, and so on.

  Parameters

  • parameters: ClientSessionsGrantAccessParameters
  • options: ClientSessionsGrantAccessOptions = {}

  Returns ClientSessionsGrantAccessRequest

list

• list(
      parameters?: ClientSessionsListParameters,
      options?: ClientSessionsListOptions,
  ): ClientSessionsListRequest

  Returns a list of all client sessions.

  Parameters

  • Optionalparameters: ClientSessionsListParameters
  • options: ClientSessionsListOptions = {}

  Returns ClientSessionsListRequest

revoke

• revoke(
      parameters: ClientSessionsRevokeParameters,
      options?: ClientSessionsRevokeOptions,
  ): ClientSessionsRevokeRequest

  Revokes a client session.

  Note that deleting a client session is a separate action.

  Parameters

  • parameters: ClientSessionsRevokeParameters
  • options: ClientSessionsRevokeOptions = {}

  Returns ClientSessionsRevokeRequest

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

  Creates a new SeamHttpClientSessions authenticated with an API key.

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromClient

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

  Creates a new SeamHttpClientSessions from an existing HTTP client.

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromClientSessionToken

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

  Creates a new SeamHttpClientSessions authenticated with a client session token.

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpClientSessions

StaticfromPublishableKey

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

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