@seamapi/http - v2.0.0
    Preparing search index...

    Type Alias Workspace

    Represents a Seam workspace. A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A sandbox workspace is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a production workspace.

    type Workspace = {
        company_name: string;
        connect_partner_name: string | null;
        connect_webview_customization: {
            inviter_logo_url?: string;
            logo_shape?: "circle" | "square";
            primary_button_color?: string;
            primary_button_text_color?: string;
            success_message?: string;
        };
        is_publishable_key_auth_enabled: boolean;
        is_sandbox: boolean;
        is_suspended: boolean;
        name: string;
        organization_id: string
        | null;
        publishable_key?: string;
        workspace_id: string;
    }
    Index
    company_name connect_partner_name connect_webview_customization is_publishable_key_auth_enabled is_sandbox is_suspended name organization_id publishable_key? workspace_id
    company_name: string

    Company name associated with the workspace.

    connect_partner_name: string | null

    Use company_name instead.

    connect_webview_customization: {
        inviter_logo_url?: string;
        logo_shape?: "circle" | "square";
        primary_button_color?: string;
        primary_button_text_color?: string;
        success_message?: string;
    }

    Type Declaration

    is_publishable_key_auth_enabled: boolean

    Indicates whether publishable key authentication is enabled for this workspace.

    is_sandbox: boolean

    Indicates whether the workspace is a sandbox workspace.

    is_suspended: boolean

    Indicates whether the sandbox workspace is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.

    name: string

    Name of the workspace.

    organization_id: string | null

    ID of the organization to which the workspace belongs, or null if the workspace is not assigned to an organization.

    publishable_key?: string

    Publishable key for the workspace. This key is used to identify the workspace in client-side applications.

    workspace_id: string

    ID of the workspace.

    Settings
    Member Visibility

    On This Page
    Properties