import { type Client } from '../../../../seam/connect/client.js'; import { type SeamHttpFromPublishableKeyOptions, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions } from '../../../../seam/connect/options.js'; import type { ActionAttempt } from '../../../../seam/connect/resources/action-attempt.js'; import type { Workspace } from '../../../../seam/connect/resources/workspace.js'; import { SeamHttpRequest } from '../../../../seam/connect/seam-http-request.js'; import { SeamPaginator } from '../../../../seam/connect/seam-paginator.js'; export declare class SeamHttpWorkspaces { client: Client; readonly defaults: Required; readonly ltsVersion = "1.0.0"; static ltsVersion: string; constructor(apiKeyOrOptions?: string | SeamHttpOptions); static fromClient(client: SeamHttpOptionsWithClient['client'], options?: Omit): SeamHttpWorkspaces; static fromApiKey(apiKey: SeamHttpOptionsWithApiKey['apiKey'], options?: Omit): SeamHttpWorkspaces; static fromClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options?: Omit): SeamHttpWorkspaces; static fromPublishableKey(publishableKey: string, userIdentifierKey: string, options?: SeamHttpFromPublishableKeyOptions): Promise; static fromConsoleSessionToken(consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options?: Omit): SeamHttpWorkspaces; static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit): SeamHttpWorkspaces; createPaginator(request: SeamHttpRequest): SeamPaginator; updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise; /** * Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). */ create(parameters: WorkspacesCreateParameters, options?: WorkspacesCreateOptions): WorkspacesCreateRequest; /** * Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. */ get(parameters?: WorkspacesGetParameters, options?: WorkspacesGetOptions): WorkspacesGetRequest; /** * Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. */ list(parameters?: WorkspacesListParameters, options?: WorkspacesListOptions): WorkspacesListRequest; /** * Resets the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. */ resetSandbox(parameters?: WorkspacesResetSandboxParameters, options?: WorkspacesResetSandboxOptions): WorkspacesResetSandboxRequest; /** * Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. */ update(parameters?: WorkspacesUpdateParameters, options?: WorkspacesUpdateOptions): WorkspacesUpdateRequest; } export type WorkspacesCreateParameters = { /** * Company name for the new workspace. */ company_name?: string | undefined; /** * Connect partner name for the new workspace. * @deprecated Use `company_name` instead. */ connect_partner_name?: string | undefined; /** * [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ connect_webview_customization?: { /** * Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ logo_shape?: 'circle' | 'square' | undefined; /** * Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_color?: string | undefined; /** * Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_text_color?: string | undefined; /** * Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ success_message?: string | undefined; } | undefined; /** * Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). */ is_sandbox?: boolean | undefined; /** * Name of the new workspace. */ name: string; /** * ID of the organization to associate with the new workspace. */ organization_id?: string | undefined; /** * @deprecated Use `connect_webview_customization.webview_logo_shape` instead. */ webview_logo_shape?: 'circle' | 'square' | undefined; /** * @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */ webview_primary_button_color?: string | undefined; /** * @deprecated Use `connect_webview_customization.webview_primary_button_text_color` instead. */ webview_primary_button_text_color?: string | undefined; /** * @deprecated Use `connect_webview_customization.webview_success_message` instead. */ webview_success_message?: string | undefined; }; /** * @deprecated Use WorkspacesCreateRequest instead. */ export type WorkspacesCreateResponse = { workspace: Workspace; }; export type WorkspacesCreateRequest = SeamHttpRequest; export interface WorkspacesCreateOptions { } export type WorkspacesGetParameters = {}; /** * @deprecated Use WorkspacesGetRequest instead. */ export type WorkspacesGetResponse = { workspace: Workspace; }; export type WorkspacesGetRequest = SeamHttpRequest; export interface WorkspacesGetOptions { } export type WorkspacesListParameters = {}; /** * @deprecated Use WorkspacesListRequest instead. */ export type WorkspacesListResponse = { workspaces: Array; }; export type WorkspacesListRequest = SeamHttpRequest; export interface WorkspacesListOptions { } export type WorkspacesResetSandboxParameters = {}; /** * @deprecated Use WorkspacesResetSandboxRequest instead. */ export type WorkspacesResetSandboxResponse = { action_attempt: ActionAttempt; }; export type WorkspacesResetSandboxRequest = SeamHttpRequest; export type WorkspacesResetSandboxOptions = Pick; export type WorkspacesUpdateParameters = { /** * Connect partner name for the workspace. */ connect_partner_name?: string | undefined; /** * [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ connect_webview_customization?: { /** * Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ logo_shape?: 'circle' | 'square' | undefined; /** * Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_color?: string | undefined; /** * Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_text_color?: string | undefined; /** * Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ success_message?: string | undefined; } | undefined; /** * Indicates whether publishable key authentication is enabled for this workspace. */ is_publishable_key_auth_enabled?: boolean | undefined; /** * Indicates whether the workspace is suspended. */ is_suspended?: boolean | undefined; /** * Name of the workspace. */ name?: string | undefined; /** * ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization. */ organization_id?: string | undefined; }; /** * @deprecated Use WorkspacesUpdateRequest instead. */ export type WorkspacesUpdateResponse = void; export type WorkspacesUpdateRequest = SeamHttpRequest; export interface WorkspacesUpdateOptions { }