Module

x/windmill/windmill-api/index.ts>WorkspaceService

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
windmill-labs/windmill-deno-client
Very Popular
Go to Latest
class WorkspaceService
import { WorkspaceService } from "https://dotland.deno.dev/x/windmill@v1.415.1/windmill-api/index.ts";

Static Methods

addUser(unnamed 0: { workspace: string; requestBody: { email: string; is_admin: boolean; username?: string; operator: boolean; }; }): CancelablePromise<string>

add user to workspace

archiveWorkspace(unnamed 0: { workspace: string; }): CancelablePromise<string>

archive workspace

changeWorkspaceId(unnamed 0: { workspace: string; requestBody?: { new_id?: string; new_name?: string; }; }): CancelablePromise<string>

change workspace id

changeWorkspaceName(unnamed 0: { workspace: string; requestBody?: { new_name?: string; }; }): CancelablePromise<string>

change workspace name

createWorkspace(unnamed 0: { requestBody: CreateWorkspace; }): CancelablePromise<string>

create workspace

deleteInvite(unnamed 0: { workspace: string; requestBody: { email: string; is_admin: boolean; operator: boolean; }; }): CancelablePromise<string>

delete user invite

deleteWorkspace(unnamed 0: { workspace: string; }): CancelablePromise<string>

delete workspace (require super admin)

editAutoInvite(unnamed 0: { workspace: string; requestBody: { operator?: boolean; invite_all?: boolean; auto_add?: boolean; }; }): CancelablePromise<string>

edit auto invite

editCopilotConfig(unnamed 0: { workspace: string; requestBody: { openai_resource_path?: string; code_completion_enabled: boolean; }; }): CancelablePromise<string>

edit copilot config

editDefaultScripts(unnamed 0: { workspace: string; requestBody?: WorkspaceDefaultScripts; }): CancelablePromise<string>

edit default scripts for workspace

editDeployTo(unnamed 0: { workspace: string; requestBody: { deploy_to?: string; }; }): CancelablePromise<string>

edit deploy to

editErrorHandler(unnamed 0: { workspace: string; requestBody: { error_handler?: string; error_handler_extra_args?: ScriptArgs; error_handler_muted_on_cancel?: boolean; }; }): CancelablePromise<string>

edit error handler

editLargeFileStorageConfig(unnamed 0: { workspace: string; requestBody: { large_file_storage?: LargeFileStorage; }; }): CancelablePromise<any>

edit large file storage settings

editSlackCommand(unnamed 0: { workspace: string; requestBody: { slack_command_script?: string; }; }): CancelablePromise<string>

edit slack command

editWebhook(unnamed 0: { workspace: string; requestBody: { webhook?: string; }; }): CancelablePromise<string>

edit webhook

editWorkspaceDefaultApp(unnamed 0: { workspace: string; requestBody: { default_app_path?: string; }; }): CancelablePromise<string>

edit default app for workspace

editWorkspaceDeployUiSettings(unnamed 0: { workspace: string; requestBody: { deploy_ui_settings?: WorkspaceDeployUISettings; }; }): CancelablePromise<any>

edit workspace deploy ui settings

editWorkspaceGitSyncConfig(unnamed 0: { workspace: string; requestBody: { git_sync_settings?: WorkspaceGitSyncSettings; }; }): CancelablePromise<any>

edit workspace git sync settings

existsUsername(unnamed 0: { requestBody: { id: string; username: string; }; }): CancelablePromise<boolean>

exists username

existsWorkspace(unnamed 0: { requestBody: { id: string; }; }): CancelablePromise<boolean>

exists workspace

getCopilotInfo(unnamed 0: { workspace: string; }): CancelablePromise<{ exists_openai_resource_path: boolean; code_completion_enabled: boolean; }>

get copilot info

getDefaultScripts(unnamed 0: { workspace: string; }): CancelablePromise<WorkspaceDefaultScripts>

get default scripts for workspace

getDeployTo(unnamed 0: { workspace: string; }): CancelablePromise<{ deploy_to?: string; }>

get deploy to

getIsPremium(unnamed 0: { workspace: string; }): CancelablePromise<boolean>

get if workspace is premium

getLargeFileStorageConfig(unnamed 0: { workspace: string; }): CancelablePromise<LargeFileStorage>

get large file storage config

getPremiumInfo(unnamed 0: { workspace: string; }): CancelablePromise<{ premium: boolean; usage?: number; seats?: number; automatic_billing: boolean; }>

get premium info

getSettings(unnamed 0: { 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; deploy_ui?: WorkspaceDeployUISettings; default_app?: string; default_scripts?: WorkspaceDefaultScripts; }>

get settings

getUsedTriggers(unnamed 0: { workspace: string; }): CancelablePromise<{ http_routes_used: boolean; websocket_used: boolean; }>

get used triggers

getWorkspaceDefaultApp(unnamed 0: { workspace: string; }): CancelablePromise<{ default_app_path?: string; }>

get default app for workspace

getWorkspaceEncryptionKey(unnamed 0: { workspace: string; }): CancelablePromise<{ key: string; }>

retrieves the encryption key for this workspace

getWorkspaceName(unnamed 0: { workspace: string; }): CancelablePromise<string>

get workspace name

getWorkspaceUsage(unnamed 0: { workspace: string; }): CancelablePromise<number>

get usage

inviteUser(unnamed 0: { workspace: string; requestBody: { email: string; is_admin: boolean; operator: boolean; }; }): CancelablePromise<string>

invite user to workspace

isDomainAllowed(): CancelablePromise<boolean>

is domain allowed for auto invi

leaveWorkspace(unnamed 0: { workspace: string; }): CancelablePromise<string>

leave workspace

listPendingInvites(unnamed 0: { workspace: string; }): CancelablePromise<Array<WorkspaceInvite>>

list pending invites for a workspace

listUserWorkspaces(): CancelablePromise<UserWorkspaceList>

list all workspaces visible to me with user info

listWorkspaces(): CancelablePromise<Array<Workspace>>

list all workspaces visible to me

listWorkspacesAsSuperAdmin(unnamed 0: { page?: number; perPage?: number; }): CancelablePromise<Array<Workspace>>

list all workspaces as super admin (require to be super admin)

runSlackMessageTestJob(unnamed 0: { workspace: string; requestBody: { hub_script_path?: string; channel?: string; test_msg?: string; }; }): CancelablePromise<{ job_uuid?: string; }>

run a job that sends a message to Slack

setAutomaticBilling(unnamed 0: { workspace: string; requestBody: { automatic_billing: boolean; seats?: number; }; }): CancelablePromise<string>

set automatic billing

setEnvironmentVariable(unnamed 0: { workspace: string; requestBody: { name: string; value?: string; }; }): CancelablePromise<string>

set environment variable

setWorkspaceEncryptionKey(unnamed 0: { workspace: string; requestBody: { new_key: string; skip_reencrypt?: boolean; }; }): CancelablePromise<string>

update the encryption key for this workspace

unarchiveWorkspace(unnamed 0: { workspace: string; }): CancelablePromise<string>

unarchive workspace