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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010/* 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, }, }); }
}