Module
x/windmill/windmill-api/services/WorkspaceService.ts
Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029/* istanbul ignore file *//* tslint:disable *//* eslint-disable */import type { CreateWorkspace } from '../models/CreateWorkspace.ts';import type { LargeFileStorage } from '../models/LargeFileStorage.ts';import type { ScriptArgs } from '../models/ScriptArgs.ts';import type { UserWorkspaceList } from '../models/UserWorkspaceList.ts';import type { Workspace } from '../models/Workspace.ts';import type { WorkspaceDefaultScripts } from '../models/WorkspaceDefaultScripts.ts';import type { WorkspaceGitSyncSettings } from '../models/WorkspaceGitSyncSettings.ts';import type { WorkspaceInvite } from '../models/WorkspaceInvite.ts';
import type { CancelablePromise } from '../core/CancelablePromise.ts';import { OpenAPI } from '../core/OpenAPI.ts';import { request as __request } from '../core/request.ts';
export class WorkspaceService {
/** * list all workspaces visible to me * @returns Workspace all workspaces * @throws ApiError */ public static listWorkspaces(): CancelablePromise<Array<Workspace>> { return __request(OpenAPI, { method: 'GET', url: '/workspaces/list', }); }
/** * is domain allowed for auto invi * @returns boolean domain allowed or not * @throws ApiError */ public static isDomainAllowed(): CancelablePromise<boolean> { return __request(OpenAPI, { method: 'GET', url: '/workspaces/allowed_domain_auto_invite', }); }
/** * list all workspaces visible to me with user info * @returns UserWorkspaceList workspace with associated username * @throws ApiError */ public static listUserWorkspaces(): CancelablePromise<UserWorkspaceList> { return __request(OpenAPI, { method: 'GET', url: '/workspaces/users', }); }
/** * list all workspaces as super admin (require to be super admin) * @returns Workspace workspaces * @throws ApiError */ public 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>> { return __request(OpenAPI, { method: 'GET', url: '/workspaces/list_as_superadmin', query: { 'page': page, 'per_page': perPage, }, }); }
/** * create workspace * @returns string token created * @throws ApiError */ public static createWorkspace({ requestBody, }: { /** * new token */ requestBody: CreateWorkspace, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/workspaces/create', body: requestBody, mediaType: 'application/json', }); }
/** * exists workspace * @returns boolean status * @throws ApiError */ public static existsWorkspace({ requestBody, }: { /** * id of workspace */ requestBody: { id: string; }, }): CancelablePromise<boolean> { return __request(OpenAPI, { method: 'POST', url: '/workspaces/exists', body: requestBody, mediaType: 'application/json', }); }
/** * exists username * @returns boolean status * @throws ApiError */ public static existsUsername({ requestBody, }: { requestBody: { id: string; username: string; }, }): CancelablePromise<boolean> { return __request(OpenAPI, { method: 'POST', url: '/workspaces/exists_username', body: requestBody, mediaType: 'application/json', }); }
/** * invite user to workspace * @returns string status * @throws ApiError */ public static inviteUser({ workspace, requestBody, }: { workspace: string, /** * WorkspaceInvite */ requestBody: { email: string; is_admin: boolean; operator: boolean; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/invite_user', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * add user to workspace * @returns string status * @throws ApiError */ public static addUser({ workspace, requestBody, }: { workspace: string, /** * WorkspaceInvite */ requestBody: { email: string; is_admin: boolean; username?: string; operator: boolean; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/add_user', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * delete user invite * @returns string status * @throws ApiError */ public static deleteInvite({ workspace, requestBody, }: { workspace: string, /** * WorkspaceInvite */ requestBody: { email: string; is_admin: boolean; operator: boolean; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/delete_invite', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * archive workspace * @returns string status * @throws ApiError */ public static archiveWorkspace({ workspace, }: { workspace: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/archive', path: { 'workspace': workspace, }, }); }
/** * unarchive workspace * @returns string status * @throws ApiError */ public static unarchiveWorkspace({ workspace, }: { workspace: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/workspaces/unarchive/{workspace}', path: { 'workspace': workspace, }, }); }
/** * delete workspace (require super admin) * @returns string status * @throws ApiError */ public static deleteWorkspace({ workspace, }: { workspace: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'DELETE', url: '/workspaces/delete/{workspace}', path: { 'workspace': workspace, }, }); }
/** * leave workspace * @returns string status * @throws ApiError */ public static leaveWorkspace({ workspace, }: { workspace: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/leave', path: { 'workspace': workspace, }, }); }
/** * get workspace name * @returns string status * @throws ApiError */ public static getWorkspaceName({ workspace, }: { workspace: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/get_workspace_name', path: { 'workspace': workspace, }, }); }
/** * change workspace name * @returns string status * @throws ApiError */ public static changeWorkspaceName({ workspace, requestBody, }: { workspace: string, requestBody?: { new_name?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/change_workspace_name', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * change workspace id * @returns string status * @throws ApiError */ public static changeWorkspaceId({ workspace, requestBody, }: { workspace: string, requestBody?: { new_id?: string; new_name?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/change_workspace_id', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * list pending invites for a workspace * @returns WorkspaceInvite user * @throws ApiError */ public static listPendingInvites({ workspace, }: { workspace: string, }): CancelablePromise<Array<WorkspaceInvite>> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/list_pending_invites', path: { 'workspace': workspace, }, }); }
/** * get settings * @returns any status * @throws ApiError */ public 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; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/get_settings', path: { 'workspace': workspace, }, }); }
/** * get deploy to * @returns any status * @throws ApiError */ public static getDeployTo({ workspace, }: { workspace: string, }): CancelablePromise<{ deploy_to?: string; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/get_deploy_to', path: { 'workspace': workspace, }, }); }
/** * get if workspace is premium * @returns boolean status * @throws ApiError */ public static getIsPremium({ workspace, }: { workspace: string, }): CancelablePromise<boolean> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/is_premium', path: { 'workspace': workspace, }, }); }
/** * get premium info * @returns any status * @throws ApiError */ public static getPremiumInfo({ workspace, }: { workspace: string, }): CancelablePromise<{ premium: boolean; usage?: number; seats?: number; automatic_billing: boolean; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/premium_info', path: { 'workspace': workspace, }, }); }
/** * set automatic billing * @returns string status * @throws ApiError */ public static setAutomaticBilling({ workspace, requestBody, }: { workspace: string, /** * automatic billing */ requestBody: { automatic_billing: boolean; seats?: number; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/set_automatic_billing', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit slack command * @returns string status * @throws ApiError */ public static editSlackCommand({ workspace, requestBody, }: { workspace: string, /** * WorkspaceInvite */ requestBody: { slack_command_script?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_slack_command', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * run a job that sends a message to Slack * @returns any status * @throws ApiError */ public 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; }> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/run_slack_message_test_job', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit deploy to * @returns string status * @throws ApiError */ public static editDeployTo({ workspace, requestBody, }: { workspace: string, requestBody: { deploy_to?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_deploy_to', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit auto invite * @returns string status * @throws ApiError */ public static editAutoInvite({ workspace, requestBody, }: { workspace: string, /** * WorkspaceInvite */ requestBody: { operator?: boolean; invite_all?: boolean; auto_add?: boolean; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_auto_invite', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit webhook * @returns string status * @throws ApiError */ public static editWebhook({ workspace, requestBody, }: { workspace: string, /** * WorkspaceWebhook */ requestBody: { webhook?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_webhook', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit copilot config * @returns string status * @throws ApiError */ public static editCopilotConfig({ workspace, requestBody, }: { workspace: string, /** * WorkspaceCopilotConfig */ requestBody: { openai_resource_path?: string; code_completion_enabled: boolean; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_copilot_config', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * get copilot info * @returns any status * @throws ApiError */ public static getCopilotInfo({ workspace, }: { workspace: string, }): CancelablePromise<{ exists_openai_resource_path: boolean; code_completion_enabled: boolean; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/get_copilot_info', path: { 'workspace': workspace, }, }); }
/** * edit error handler * @returns string status * @throws ApiError */ public static editErrorHandler({ workspace, requestBody, }: { workspace: string, /** * WorkspaceErrorHandler */ requestBody: { error_handler?: string; error_handler_extra_args?: ScriptArgs; error_handler_muted_on_cancel?: boolean; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_error_handler', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit large file storage settings * @returns any status * @throws ApiError */ public static editLargeFileStorageConfig({ workspace, requestBody, }: { workspace: string, /** * LargeFileStorage info */ requestBody: { large_file_storage?: LargeFileStorage; }, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_large_file_storage_config', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit workspace git sync settings * @returns any status * @throws ApiError */ public static editWorkspaceGitSyncConfig({ workspace, requestBody, }: { workspace: string, /** * Workspace Git sync settings */ requestBody: { git_sync_settings?: WorkspaceGitSyncSettings; }, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_git_sync_config', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit default app for workspace * @returns string status * @throws ApiError */ public static editWorkspaceDefaultApp({ workspace, requestBody, }: { workspace: string, /** * Workspace default app */ requestBody: { default_app_path?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/edit_default_app', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * edit default scripts for workspace * @returns string status * @throws ApiError */ public static editDefaultScripts({ workspace, requestBody, }: { workspace: string, /** * Workspace default app */ requestBody?: WorkspaceDefaultScripts, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/default_scripts', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * get default scripts for workspace * @returns WorkspaceDefaultScripts status * @throws ApiError */ public static getDefaultScripts({ workspace, }: { workspace: string, }): CancelablePromise<WorkspaceDefaultScripts> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/default_scripts', path: { 'workspace': workspace, }, }); }
/** * set environment variable * @returns string status * @throws ApiError */ public static setEnvironmentVariable({ workspace, requestBody, }: { workspace: string, /** * Workspace default app */ requestBody: { name: string; value?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/set_environment_variable', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * retrieves the encryption key for this workspace * @returns any status * @throws ApiError */ public static getWorkspaceEncryptionKey({ workspace, }: { workspace: string, }): CancelablePromise<{ key: string; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/encryption_key', path: { 'workspace': workspace, }, }); }
/** * update the encryption key for this workspace * @returns string status * @throws ApiError */ public static setWorkspaceEncryptionKey({ workspace, requestBody, }: { workspace: string, /** * New encryption key */ requestBody: { new_key: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/encryption_key', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * get default app for workspace * @returns any status * @throws ApiError */ public static getWorkspaceDefaultApp({ workspace, }: { workspace: string, }): CancelablePromise<{ default_app_path?: string; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/default_app', path: { 'workspace': workspace, }, }); }
/** * get large file storage config * @returns LargeFileStorage status * @throws ApiError */ public static getLargeFileStorageConfig({ workspace, }: { workspace: string, }): CancelablePromise<LargeFileStorage> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/get_large_file_storage_config', path: { 'workspace': workspace, }, }); }
/** * get usage * @returns number usage * @throws ApiError */ public static getWorkspaceUsage({ workspace, }: { workspace: string, }): CancelablePromise<number> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/usage', path: { 'workspace': workspace, }, }); }
}