windmill-components 1.408.1 → 1.430.2

package/package/gen/services/WorkspaceService.d.ts

@@ -1,517 +0,0 @@
-import type { CreateWorkspace } from '../models/CreateWorkspace';
-import type { LargeFileStorage } from '../models/LargeFileStorage';
-import type { ScriptArgs } from '../models/ScriptArgs';
-import type { UserWorkspaceList } from '../models/UserWorkspaceList';
-import type { Workspace } from '../models/Workspace';
-import type { WorkspaceDefaultScripts } from '../models/WorkspaceDefaultScripts';
-import type { WorkspaceGitSyncSettings } from '../models/WorkspaceGitSyncSettings';
-import type { WorkspaceInvite } from '../models/WorkspaceInvite';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class WorkspaceService {
-    /**
-     * list all workspaces visible to me
-     * @returns Workspace all workspaces
-     * @throws ApiError
-     */
-    static listWorkspaces(): CancelablePromise<Array<Workspace>>;
-    /**
-     * is domain allowed for auto invi
-     * @returns boolean domain allowed or not
-     * @throws ApiError
-     */
-    static isDomainAllowed(): CancelablePromise<boolean>;
-    /**
-     * list all workspaces visible to me with user info
-     * @returns UserWorkspaceList workspace with associated username
-     * @throws ApiError
-     */
-    static listUserWorkspaces(): CancelablePromise<UserWorkspaceList>;
-    /**
-     * list all workspaces as super admin (require to be super admin)
-     * @returns Workspace workspaces
-     * @throws ApiError
-     */
-    static listWorkspacesAsSuperAdmin({ page, perPage }: {
-        /**
-         * which page to return (start at 1, default 1)
-         */
-        page?: number;
-        /**
-         * number of items to return for a given page (default 30, max 100)
-         */
-        perPage?: number;
-    }): CancelablePromise<Array<Workspace>>;
-    /**
-     * create workspace
-     * @returns string token created
-     * @throws ApiError
-     */
-    static createWorkspace({ requestBody }: {
-        /**
-         * new token
-         */
-        requestBody: CreateWorkspace;
-    }): CancelablePromise<string>;
-    /**
-     * exists workspace
-     * @returns boolean status
-     * @throws ApiError
-     */
-    static existsWorkspace({ requestBody }: {
-        /**
-         * id of workspace
-         */
-        requestBody: {
-            id: string;
-        };
-    }): CancelablePromise<boolean>;
-    /**
-     * exists username
-     * @returns boolean status
-     * @throws ApiError
-     */
-    static existsUsername({ requestBody }: {
-        requestBody: {
-            id: string;
-            username: string;
-        };
-    }): CancelablePromise<boolean>;
-    /**
-     * invite user to workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static inviteUser({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceInvite
-         */
-        requestBody: {
-            email: string;
-            is_admin: boolean;
-            operator: boolean;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * add user to workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static addUser({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceInvite
-         */
-        requestBody: {
-            email: string;
-            is_admin: boolean;
-            username?: string;
-            operator: boolean;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * delete user invite
-     * @returns string status
-     * @throws ApiError
-     */
-    static deleteInvite({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceInvite
-         */
-        requestBody: {
-            email: string;
-            is_admin: boolean;
-            operator: boolean;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * archive workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static archiveWorkspace({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<string>;
-    /**
-     * unarchive workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static unarchiveWorkspace({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<string>;
-    /**
-     * delete workspace (require super admin)
-     * @returns string status
-     * @throws ApiError
-     */
-    static deleteWorkspace({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<string>;
-    /**
-     * leave workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static leaveWorkspace({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<string>;
-    /**
-     * get workspace name
-     * @returns string status
-     * @throws ApiError
-     */
-    static getWorkspaceName({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<string>;
-    /**
-     * change workspace name
-     * @returns string status
-     * @throws ApiError
-     */
-    static changeWorkspaceName({ workspace, requestBody }: {
-        workspace: string;
-        requestBody?: {
-            new_name?: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * change workspace id
-     * @returns string status
-     * @throws ApiError
-     */
-    static changeWorkspaceId({ workspace, requestBody }: {
-        workspace: string;
-        requestBody?: {
-            new_id?: string;
-            new_name?: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * list pending invites for a workspace
-     * @returns WorkspaceInvite user
-     * @throws ApiError
-     */
-    static listPendingInvites({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<Array<WorkspaceInvite>>;
-    /**
-     * get settings
-     * @returns any status
-     * @throws ApiError
-     */
-    static getSettings({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<{
-        workspace_id?: string;
-        slack_name?: string;
-        slack_team_id?: string;
-        slack_command_script?: string;
-        auto_invite_domain?: string;
-        auto_invite_operator?: boolean;
-        auto_add?: boolean;
-        plan?: string;
-        automatic_billing: boolean;
-        customer_id?: string;
-        webhook?: string;
-        deploy_to?: string;
-        openai_resource_path?: string;
-        code_completion_enabled: boolean;
-        error_handler?: string;
-        error_handler_extra_args?: ScriptArgs;
-        error_handler_muted_on_cancel: boolean;
-        large_file_storage?: LargeFileStorage;
-        git_sync?: WorkspaceGitSyncSettings;
-        default_app?: string;
-        default_scripts?: WorkspaceDefaultScripts;
-    }>;
-    /**
-     * get deploy to
-     * @returns any status
-     * @throws ApiError
-     */
-    static getDeployTo({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<{
-        deploy_to?: string;
-    }>;
-    /**
-     * get if workspace is premium
-     * @returns boolean status
-     * @throws ApiError
-     */
-    static getIsPremium({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<boolean>;
-    /**
-     * get premium info
-     * @returns any status
-     * @throws ApiError
-     */
-    static getPremiumInfo({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<{
-        premium: boolean;
-        usage?: number;
-        seats?: number;
-        automatic_billing: boolean;
-    }>;
-    /**
-     * set automatic billing
-     * @returns string status
-     * @throws ApiError
-     */
-    static setAutomaticBilling({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * automatic billing
-         */
-        requestBody: {
-            automatic_billing: boolean;
-            seats?: number;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * edit slack command
-     * @returns string status
-     * @throws ApiError
-     */
-    static editSlackCommand({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceInvite
-         */
-        requestBody: {
-            slack_command_script?: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * run a job that sends a message to Slack
-     * @returns any status
-     * @throws ApiError
-     */
-    static runSlackMessageTestJob({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * path to hub script to run and its corresponding args
-         */
-        requestBody: {
-            hub_script_path?: string;
-            channel?: string;
-            test_msg?: string;
-        };
-    }): CancelablePromise<{
-        job_uuid?: string;
-    }>;
-    /**
-     * edit deploy to
-     * @returns string status
-     * @throws ApiError
-     */
-    static editDeployTo({ workspace, requestBody }: {
-        workspace: string;
-        requestBody: {
-            deploy_to?: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * edit auto invite
-     * @returns string status
-     * @throws ApiError
-     */
-    static editAutoInvite({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceInvite
-         */
-        requestBody: {
-            operator?: boolean;
-            invite_all?: boolean;
-            auto_add?: boolean;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * edit webhook
-     * @returns string status
-     * @throws ApiError
-     */
-    static editWebhook({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceWebhook
-         */
-        requestBody: {
-            webhook?: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * edit copilot config
-     * @returns string status
-     * @throws ApiError
-     */
-    static editCopilotConfig({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceCopilotConfig
-         */
-        requestBody: {
-            openai_resource_path?: string;
-            code_completion_enabled: boolean;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * get copilot info
-     * @returns any status
-     * @throws ApiError
-     */
-    static getCopilotInfo({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<{
-        exists_openai_resource_path: boolean;
-        code_completion_enabled: boolean;
-    }>;
-    /**
-     * edit error handler
-     * @returns string status
-     * @throws ApiError
-     */
-    static editErrorHandler({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * WorkspaceErrorHandler
-         */
-        requestBody: {
-            error_handler?: string;
-            error_handler_extra_args?: ScriptArgs;
-            error_handler_muted_on_cancel?: boolean;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * edit large file storage settings
-     * @returns any status
-     * @throws ApiError
-     */
-    static editLargeFileStorageConfig({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * LargeFileStorage info
-         */
-        requestBody: {
-            large_file_storage?: LargeFileStorage;
-        };
-    }): CancelablePromise<any>;
-    /**
-     * edit workspace git sync settings
-     * @returns any status
-     * @throws ApiError
-     */
-    static editWorkspaceGitSyncConfig({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * Workspace Git sync settings
-         */
-        requestBody: {
-            git_sync_settings?: WorkspaceGitSyncSettings;
-        };
-    }): CancelablePromise<any>;
-    /**
-     * edit default app for workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static editWorkspaceDefaultApp({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * Workspace default app
-         */
-        requestBody: {
-            default_app_path?: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * edit default scripts for workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static editDefaultScripts({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * Workspace default app
-         */
-        requestBody?: WorkspaceDefaultScripts;
-    }): CancelablePromise<string>;
-    /**
-     * get default scripts for workspace
-     * @returns WorkspaceDefaultScripts status
-     * @throws ApiError
-     */
-    static getDefaultScripts({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<WorkspaceDefaultScripts>;
-    /**
-     * set environment variable
-     * @returns string status
-     * @throws ApiError
-     */
-    static setEnvironmentVariable({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * Workspace default app
-         */
-        requestBody: {
-            name: string;
-            value?: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * retrieves the encryption key for this workspace
-     * @returns any status
-     * @throws ApiError
-     */
-    static getWorkspaceEncryptionKey({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<{
-        key: string;
-    }>;
-    /**
-     * update the encryption key for this workspace
-     * @returns string status
-     * @throws ApiError
-     */
-    static setWorkspaceEncryptionKey({ workspace, requestBody }: {
-        workspace: string;
-        /**
-         * New encryption key
-         */
-        requestBody: {
-            new_key: string;
-        };
-    }): CancelablePromise<string>;
-    /**
-     * get default app for workspace
-     * @returns any status
-     * @throws ApiError
-     */
-    static getWorkspaceDefaultApp({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<{
-        default_app_path?: string;
-    }>;
-    /**
-     * get large file storage config
-     * @returns LargeFileStorage status
-     * @throws ApiError
-     */
-    static getLargeFileStorageConfig({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<LargeFileStorage>;
-    /**
-     * get usage
-     * @returns number usage
-     * @throws ApiError
-     */
-    static getWorkspaceUsage({ workspace }: {
-        workspace: string;
-    }): CancelablePromise<number>;
-}