Class SeamHttpEndpointsWithoutWorkspace

constructor

• new SeamHttpEndpointsWithoutWorkspace(options?): SeamHttpEndpointsWithoutWorkspace

• Parameters

  • options: SeamHttpWithoutWorkspaceOptions = {}

  Returns SeamHttpEndpointsWithoutWorkspace

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

/workspaces/create

• get /workspaces/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)

• Returns ((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?, options?): 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.

      • Optionaloptions: WorkspacesCreateOptions

      Returns WorkspacesCreateRequest

/workspaces/list

• get /workspaces/list(): ((parameters?: {}, options?: WorkspacesListOptions) => WorkspacesListRequest)

• Returns ((parameters?: {}, options?: WorkspacesListOptions) => WorkspacesListRequest)

  • • (parameters?, options?): WorkspacesListRequest

    • Parameters

      • Optionalparameters: {}
      • Optionaloptions: WorkspacesListOptions

      Returns WorkspacesListRequest

StaticfromClient

• fromClient(client, options?): SeamHttpEndpointsWithoutWorkspace

• Parameters

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

  Returns SeamHttpEndpointsWithoutWorkspace

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, options?): SeamHttpEndpointsWithoutWorkspace

• Parameters

  • consoleSessionToken: string
  • options: Omit<SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken, "consoleSessionToken"> = {}

  Returns SeamHttpEndpointsWithoutWorkspace

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, options?): SeamHttpEndpointsWithoutWorkspace

• Parameters

  • personalAccessToken: string
  • options: Omit<SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken, "personalAccessToken"> = {}

  Returns SeamHttpEndpointsWithoutWorkspace