Class SeamHttpWorkspaces

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWorkspaces

client

Readonlydefaults

create

• create(
      parameters: WorkspacesCreateParameters,
      options?: WorkspacesCreateOptions,
  ): WorkspacesCreateRequest

  Creates a new workspace.

  Parameters

  • parameters: WorkspacesCreateParameters
  • options: WorkspacesCreateOptions = {}

  Returns WorkspacesCreateRequest

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>

get

• get(
      parameters?: WorkspacesGetParameters,
      options?: WorkspacesGetOptions,
  ): WorkspacesGetRequest

  Returns the workspace associated with the authentication value.

  Parameters

  • Optionalparameters: WorkspacesGetParameters
  • options: WorkspacesGetOptions = {}

  Returns WorkspacesGetRequest

list

• list(
      parameters?: WorkspacesListParameters,
      options?: WorkspacesListOptions,
  ): WorkspacesListRequest

  Returns a list of workspaces associated with the authentication value.

  Parameters

  • Optionalparameters: WorkspacesListParameters
  • options: WorkspacesListOptions = {}

  Returns WorkspacesListRequest

resetSandbox

• resetSandbox(
      parameters?: WorkspacesResetSandboxParameters,
      options?: WorkspacesResetSandboxOptions,
  ): WorkspacesResetSandboxRequest

  Resets the sandbox workspace associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.

  Parameters

  • Optionalparameters: WorkspacesResetSandboxParameters
  • options: WorkspacesResetSandboxOptions = {}

  Returns WorkspacesResetSandboxRequest

update

• update(
      parameters?: WorkspacesUpdateParameters,
      options?: WorkspacesUpdateOptions,
  ): WorkspacesUpdateRequest

  Updates the workspace associated with the authentication value.

  Parameters

  • Optionalparameters: WorkspacesUpdateParameters
  • options: WorkspacesUpdateOptions = {}

  Returns WorkspacesUpdateRequest

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

  Creates a new SeamHttpWorkspaces authenticated with an API key.

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromClient

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

  Creates a new SeamHttpWorkspaces from an existing HTTP client.

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromClientSessionToken

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

  Creates a new SeamHttpWorkspaces authenticated with a client session token.

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromPublishableKey

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

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