Class SeamHttpWorkspaces

constructor

• new SeamHttpWorkspaces(apiKeyOrOptions?): SeamHttpWorkspaces

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWorkspaces

client

Readonly defaults

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      workspace: {
          connect_partner_name: null | string;
          is_sandbox: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

• Parameters

  • Optional body: {
        connect_partner_name: string;
        is_sandbox?: boolean;
        name: string;
        webview_logo_shape?: "square" | "circle";
        webview_primary_button_color?: string;
    }

    • connect_partner_name: string

      The name shown inside the connect webview

    • Optional is_sandbox?: boolean

    • name: string

    • Optional webview_logo_shape?: "square" | "circle"

    • Optional webview_primary_button_color?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      workspace: {
          connect_partner_name: null | string;
          is_sandbox: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      workspace?: {
          connect_partner_name: null | string;
          is_sandbox: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

• Parameters

  • Optional body: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      workspace?: {
          connect_partner_name: null | string;
          is_sandbox: boolean;
          name: string;
          workspace_id: string;
      };
  }>, "workspace">, "workspace">

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      workspaces: {
          connect_partner_name: null | string;
          is_sandbox: boolean;
          name: string;
          workspace_id: string;
      }[];
  }>, "workspaces">, "workspaces">

• Parameters

  • Optional body: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      workspaces: {
          connect_partner_name: null | string;
          is_sandbox: boolean;
          name: string;
          workspace_id: string;
      }[];
  }>, "workspaces">, "workspaces">

resetSandbox

• resetSandbox(body?, options?): SeamHttpRequest<SetNonNullable<Required<{
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: {
              message: string;
              type: string;
          };
          result: null;
          status: "error";
      };
  }>, "action_attempt">, "action_attempt">

• Parameters

  • Optional body: {}
  • options: Pick<SeamHttpRequestOptions, "waitForActionAttempt"> = {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: {
              message: string;
              type: string;
          };
          result: null;
          status: "error";
      };
  }>, "action_attempt">, "action_attempt">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpWorkspaces

• Parameters

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

  Returns SeamHttpWorkspaces

Static fromClient

• fromClient(client, options?): SeamHttpWorkspaces

• Parameters

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

  Returns SeamHttpWorkspaces

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpWorkspaces

• Parameters

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

  Returns SeamHttpWorkspaces

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpWorkspaces

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpWorkspaces

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpWorkspaces>