Class SeamHttpWorkspaces

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWorkspaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

customizationProfiles

• get customizationProfiles(): SeamHttpWorkspacesCustomizationProfiles

  Returns SeamHttpWorkspacesCustomizationProfiles

create

• create(
      parameters?: {
          company_name?: string;
          connect_partner_name?: null | string;
          connect_webview_customization?: {
              logo_shape?: null | "circle" | "square";
              primary_button_color?: null | string;
              primary_button_text_color?: null | string;
              success_message?: null | string;
          };
          is_sandbox?: boolean;
          name: string;
          webview_logo_shape?: "circle"
          | "square";
          webview_primary_button_color?: string;
          webview_primary_button_text_color?: string;
          webview_success_message?: string;
      },
      options?: WorkspacesCreateOptions,
  ): WorkspacesCreateRequest

  Parameters

  • Optionalparameters: {
        company_name?: string;
        connect_partner_name?: null | string;
        connect_webview_customization?: {
            logo_shape?: null | "circle" | "square";
            primary_button_color?: null | string;
            primary_button_text_color?: null | string;
            success_message?: null | string;
        };
        is_sandbox?: boolean;
        name: string;
        webview_logo_shape?: "circle"
        | "square";
        webview_primary_button_color?: string;
        webview_primary_button_text_color?: string;
        webview_success_message?: string;
    }

    • Optionalcompany_name?: string

      Company name for the new workspace.

    • Optionalconnect_partner_name?: null | string

      Connect partner name for the new workspace.

    • Optionalconnect_webview_customization?: {
          logo_shape?: null | "circle" | "square";
          primary_button_color?: null | string;
          primary_button_text_color?: null | string;
          success_message?: null | string;
      }

      Connect Webview customizations for the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionallogo_shape?: null | "circle" | "square"

        Logo shape for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalprimary_button_color?: null | string

        Primary button color for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalprimary_button_text_color?: null | string

        Primary button text color for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalsuccess_message?: null | string

        Success message for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

    • Optionalis_sandbox?: boolean

      Indicates whether the new workspace is a sandbox workspace.

    • name: string

      Name of the new workspace.

    • Optionalwebview_logo_shape?: "circle" | "square"

      Deprecated

      Use connect_webview_customization.webview_logo_shape instead.

    • Optionalwebview_primary_button_color?: string

      Deprecated

      Use connect_webview_customization.webview_primary_button_color instead.

    • Optionalwebview_primary_button_text_color?: string

      Deprecated

      Use connect_webview_customization.webview_primary_button_text_color instead.

    • Optionalwebview_success_message?: string

      Deprecated

      Use connect_webview_customization.webview_success_message instead.

  • options: WorkspacesCreateOptions = {}

  Returns WorkspacesCreateRequest

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>

findAnything

• findAnything(
      parameters?: { search: string },
      options?: WorkspacesFindAnythingOptions,
  ): WorkspacesFindAnythingRequest

  Parameters

  • Optionalparameters: { search: string }
  • options: WorkspacesFindAnythingOptions = {}

  Returns WorkspacesFindAnythingRequest

get

• get(parameters?: {}, options?: WorkspacesGetOptions): WorkspacesGetRequest

  Parameters

  • Optionalparameters: {}
  • options: WorkspacesGetOptions = {}

  Returns WorkspacesGetRequest

list

• list(parameters?: {}, options?: WorkspacesListOptions): WorkspacesListRequest

  Parameters

  • Optionalparameters: {}
  • options: WorkspacesListOptions = {}

  Returns WorkspacesListRequest

resetSandbox

• resetSandbox(
      parameters?: {},
      options?: WorkspacesResetSandboxOptions,
  ): WorkspacesResetSandboxRequest

  Parameters

  • Optionalparameters: {}
  • options: WorkspacesResetSandboxOptions = {}

  Returns WorkspacesResetSandboxRequest

update

• update(
      parameters?: {
          connect_partner_name?: string;
          connect_webview_customization?: {
              logo_shape?: null | "circle" | "square";
              primary_button_color?: null | string;
              primary_button_text_color?: null | string;
              success_message?: null | string;
          };
          is_publishable_key_auth_enabled?: boolean;
          is_suspended?: boolean;
          name?: string;
      },
      options?: WorkspacesUpdateOptions,
  ): WorkspacesUpdateRequest

  Parameters

  • Optionalparameters: {
        connect_partner_name?: string;
        connect_webview_customization?: {
            logo_shape?: null | "circle" | "square";
            primary_button_color?: null | string;
            primary_button_text_color?: null | string;
            success_message?: null | string;
        };
        is_publishable_key_auth_enabled?: boolean;
        is_suspended?: boolean;
        name?: string;
    }

    • Optionalconnect_partner_name?: string

      Connect partner name for the workspace.

    • Optionalconnect_webview_customization?: {
          logo_shape?: null | "circle" | "square";
          primary_button_color?: null | string;
          primary_button_text_color?: null | string;
          success_message?: null | string;
      }

      Connect Webview customizations for the workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionallogo_shape?: null | "circle" | "square"

        Logo shape for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalprimary_button_color?: null | string

        Primary button color for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalprimary_button_text_color?: null | string

        Primary button text color for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

      • Optionalsuccess_message?: null | string

        Success message for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.

    • Optionalis_publishable_key_auth_enabled?: boolean

      Indicates whether publishable key authentication is enabled for this workspace.

    • Optionalis_suspended?: boolean

      Indicates whether the workspace is suspended.

    • Optionalname?: string

      Name of the workspace.
  • options: WorkspacesUpdateOptions = {}

  Returns WorkspacesUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromClient

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

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpWorkspaces

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpWorkspaces>