UNPKG

windmill-utils-internal

Version:

Internal utility functions for Windmill

1,309 lines (1,308 loc) 327 kB
"use strict"; // This file is auto-generated by @hey-api/openapi-ts Object.defineProperty(exports, "__esModule", { value: true }); exports.updateTutorialProgress = exports.getTutorialProgress = exports.refreshUserToken = exports.getCurrentEmail = exports.listGlobalSettings = exports.testMetadata = exports.createCustomerPortalSession = exports.renewLicenseKey = exports.getLatestKeyRenewalAttempt = exports.sendStats = exports.testObjectStorageConfig = exports.testLicenseKey = exports.acknowledgeAllCriticalAlerts = exports.acknowledgeCriticalAlert = exports.getCriticalAlerts = exports.testCriticalChannels = exports.testSmtp = exports.getLocal = exports.setGlobal = exports.getGlobal = exports.existsUsername = exports.existsWorkspace = exports.createWorkspace = exports.listWorkspacesAsSuperAdmin = exports.listUserWorkspaces = exports.isDomainAllowed = exports.listWorkspaces = exports.getGlobalConnectedRepositories = exports.deleteUser = exports.globalUsersExport = exports.globalUsersOverwrite = exports.globalUserDelete = exports.globalUserRename = exports.globalUsernameInfo = exports.globalUserUpdate = exports.createUserGlobally = exports.setLoginTypeForUser = exports.setPasswordForUser = exports.setPassword = exports.isOwnerOfPath = exports.updateUser = exports.getUser = exports.logout = exports.login = exports.listAuditLogs = exports.getAuditLog = exports.getOpenApiYaml = exports.getLicenseId = exports.backendUptodate = exports.backendVersion = void 0; exports.editWorkspaceGitSyncConfig = exports.editLargeFileStorageConfig = exports.editErrorHandler = exports.getCopilotInfo = exports.editCopilotConfig = exports.editWebhook = exports.editAutoInvite = exports.editDeployTo = exports.runTeamsMessageTestJob = exports.runSlackMessageTestJob = exports.connectTeams = exports.listAvailableTeamsChannels = exports.listAvailableTeamsIds = exports.editTeamsCommand = exports.editSlackCommand = exports.setThresholdAlert = exports.getThresholdAlert = exports.getPremiumInfo = exports.getIsPremium = exports.getDeployTo = exports.getSettings = exports.listPendingInvites = exports.listUsersAsSuperAdmin = exports.existsEmail = exports.updateOperatorSettings = exports.whois = exports.changeWorkspaceColor = exports.changeWorkspaceId = exports.changeWorkspaceName = exports.getWorkspaceName = exports.leaveWorkspace = exports.deleteWorkspace = exports.unarchiveWorkspace = exports.archiveWorkspace = exports.deleteInvite = exports.addUser = exports.inviteUser = exports.declineInvite = exports.acceptInvite = exports.importInstallation = exports.exportInstallation = exports.deleteFromWorkspace = exports.installFromWorkspace = exports.getGithubAppToken = exports.whoami = exports.listWorkspaceInvites = exports.globalWhoami = exports.getRunnable = exports.getUsage = exports.leaveInstance = void 0; exports.getOauthConnect = exports.listOauthConnects = exports.listOauthLogins = exports.disconnectTeams = exports.disconnectSlack = exports.disconnectAccount = exports.refreshToken = exports.connectClientCredentials = exports.createAccount = exports.connectCallback = exports.connectSlackCallbackInstance = exports.connectSlackCallback = exports.loginWithOauth = exports.workspaceMuteCriticalAlertsUi = exports.workspaceAcknowledgeAllCriticalAlerts = exports.workspaceAcknowledgeCriticalAlert = exports.workspaceGetCriticalAlerts = exports.getSecondaryStorageNames = exports.listContextualVariables = exports.listVariable = exports.existsVariable = exports.getVariableValue = exports.getVariable = exports.updateVariable = exports.deleteVariable = exports.encryptValue = exports.createVariable = exports.getOidcToken = exports.listTokens = exports.deleteToken = exports.createTokenImpersonate = exports.createToken = exports.listAvailableScopes = exports.usernameToEmail = exports.listUsernames = exports.listUsersUsage = exports.listUsers = exports.getUsedTriggers = exports.getWorkspaceUsage = exports.getLargeFileStorageConfig = exports.getWorkspaceDefaultApp = exports.setWorkspaceEncryptionKey = exports.getWorkspaceEncryptionKey = exports.setEnvironmentVariable = exports.getDefaultScripts = exports.editDefaultScripts = exports.editWorkspaceDefaultApp = exports.editWorkspaceDeployUiSettings = exports.deleteGitSyncRepository = exports.editGitSyncRepository = void 0; exports.getScriptByPathWithDraft = exports.listTokensOfScript = exports.getTriggersCountOfScript = exports.getScriptByPath = exports.deleteScriptByPath = exports.deleteScriptByHash = exports.archiveScriptByHash = exports.archiveScriptByPath = exports.isDefaultTagsPerWorkspace = exports.geDefaultTags = exports.getCustomTags = exports.toggleWorkspaceErrorHandlerForScript = exports.createScript = exports.deleteDraft = exports.createDraft = exports.listScriptPaths = exports.listScripts = exports.listSearchScript = exports.queryHubScripts = exports.getTopHubScripts = exports.getHubScriptByPath = exports.getHubScriptContentByPath = exports.getPublicAppByCustomPath = exports.getHubAppById = exports.listHubApps = exports.getHubFlowById = exports.listHubFlows = exports.listHubIntegrations = exports.queryResourceTypes = exports.listResourceTypeNames = exports.listResourceType = exports.existsResourceType = exports.getResourceType = exports.updateResourceType = exports.deleteResourceType = exports.fileResourceTypeToFileExtMap = exports.createResourceType = exports.listResourceNames = exports.listSearchResource = exports.listResource = exports.existsResource = exports.getResourceValue = exports.getResourceValueInterpolated = exports.getResource = exports.updateResourceValue = exports.updateResource = exports.deleteResource = exports.createResource = exports.sendMessageToConversation = exports.syncTeams = void 0; exports.getAppLatestVersion = exports.getAppHistoryByPath = exports.getAppByPathWithDraft = exports.getAppLiteByPath = exports.getAppByPath = exports.existsApp = exports.createAppRaw = exports.createApp = exports.listApps = exports.listSearchApp = exports.getRawAppData = exports.existsRawApp = exports.listRawApps = exports.deleteFlowByPath = exports.archiveFlowByPath = exports.updateFlow = exports.createFlow = exports.existsFlowByPath = exports.getFlowByPathWithDraft = exports.toggleWorkspaceErrorHandlerForFlow = exports.listTokensOfFlow = exports.getTriggersCountOfFlow = exports.getFlowDeploymentStatus = exports.getFlowByPath = exports.updateFlowHistory = exports.getFlowVersion = exports.listFlowPathsFromWorkspaceRunnable = exports.getFlowLatestVersion = exports.getFlowHistory = exports.listFlows = exports.listSearchFlow = exports.listFlowPaths = exports.resultById = exports.runWaitResultFlowByPath = exports.openaiSyncFlowByPath = exports.runWaitResultScriptByPathGet = exports.runWaitResultScriptByPath = exports.openaiSyncScriptByPath = exports.runScriptByPath = exports.listSelectedJobGroups = exports.getScriptDeploymentStatus = exports.rawScriptByHash = exports.getScriptByHash = exports.existsScriptByPath = exports.rawScriptByPathTokened = exports.rawScriptByPath = exports.updateScriptHistory = exports.getScriptLatestVersion = exports.listScriptPathsFromWorkspaceRunnable = exports.getScriptHistoryByPath = void 0; exports.cancelPersistentQueuedJobs = exports.cancelQueuedJob = exports.deleteCompletedJob = exports.getCompletedJobResultMaybe = exports.getCompletedJobResult = exports.getCompletedJob = exports.getFlowDebugInfo = exports.getLogFileFromStore = exports.getJobUpdatesSse = exports.getJobUpdates = exports.getJobArgs = exports.getJobLogs = exports.getRootJobId = exports.getJob = exports.countJobsByTag = exports.getDbClock = exports.listJobs = exports.listCompletedJobs = exports.cancelSelection = exports.listFilteredQueueUuids = exports.listFilteredJobsUuids = exports.countCompletedJobs = exports.getCompletedCount = exports.getQueueCount = exports.listQueue = exports.runFlowPreview = exports.runRawScriptDependencies = exports.runCodeWorkflowTask = exports.runScriptPreview = exports.runScriptByHash = exports.restartFlowAtStep = exports.batchReRunJobs = exports.runFlowByPath = exports.deleteS3FileFromApp = exports.uploadS3FileFromApp = exports.executeComponent = exports.signS3Objects = exports.customPathExists = exports.updateAppRaw = exports.updateApp = exports.deleteApp = exports.deleteRawApp = exports.updateRawApp = exports.createRawApp = exports.getAppByVersion = exports.getPublicSecretOfApp = exports.getPublicResource = exports.getPublicAppBySecret = exports.updateAppHistory = exports.listAppPathsFromWorkspaceRunnable = void 0; exports.createNatsTrigger = exports.testKafkaConnection = exports.setKafkaTriggerEnabled = exports.existsKafkaTrigger = exports.listKafkaTriggers = exports.getKafkaTrigger = exports.deleteKafkaTrigger = exports.updateKafkaTrigger = exports.createKafkaTrigger = exports.testWebsocketConnection = exports.setWebsocketTriggerEnabled = exports.existsWebsocketTrigger = exports.listWebsocketTriggers = exports.getWebsocketTrigger = exports.deleteWebsocketTrigger = exports.updateWebsocketTrigger = exports.createWebsocketTrigger = exports.existsRoute = exports.existsHttpTrigger = exports.listHttpTriggers = exports.getHttpTrigger = exports.deleteHttpTrigger = exports.updateHttpTrigger = exports.createHttpTrigger = exports.createHttpTriggers = exports.downloadOpenapiSpec = exports.generateOpenapiSpec = exports.setDefaultErrorOrRecoveryHandler = exports.listSchedulesWithJobs = exports.listSchedules = exports.existsSchedule = exports.getSchedule = exports.deleteSchedule = exports.setScheduleEnabled = exports.updateSchedule = exports.createSchedule = exports.previewSchedule = exports.getSuspendedJobFlow = exports.cancelSuspendedJobPost = exports.cancelSuspendedJobGet = exports.resumeSuspendedFlowAsOwner = exports.getFlowUserState = exports.setFlowUserState = exports.resumeSuspendedJobPost = exports.resumeSuspendedJobGet = exports.getTeamsApprovalPayload = exports.getSlackApprovalPayload = exports.getResumeUrls = exports.createJobSignature = exports.forceCancelQueuedJob = void 0; exports.getPostgresTrigger = exports.deletePostgresTrigger = exports.updatePostgresTrigger = exports.createPostgresTrigger = exports.deletePostgresPublication = exports.updatePostgresPublication = exports.createPostgresPublication = exports.getPostgresPublication = exports.listPostgresPublication = exports.deletePostgresReplicationSlot = exports.createPostgresReplicationSlot = exports.listPostgresReplicationSlot = exports.getTemplateScript = exports.createTemplateScript = exports.isValidPostgresConfiguration = exports.getPostgresVersion = exports.listAllTgoogleTopicSubscriptions = exports.listGoogleTopics = exports.deleteGcpSubscription = exports.testGcpConnection = exports.setGcpTriggerEnabled = exports.existsGcpTrigger = exports.listGcpTriggers = exports.getGcpTrigger = exports.deleteGcpTrigger = exports.updateGcpTrigger = exports.createGcpTrigger = exports.testMqttConnection = exports.setMqttTriggerEnabled = exports.existsMqttTrigger = exports.listMqttTriggers = exports.getMqttTrigger = exports.deleteMqttTrigger = exports.updateMqttTrigger = exports.createMqttTrigger = exports.testSqsConnection = exports.setSqsTriggerEnabled = exports.existsSqsTrigger = exports.listSqsTriggers = exports.getSqsTrigger = exports.deleteSqsTrigger = exports.updateSqsTrigger = exports.createSqsTrigger = exports.testNatsConnection = exports.setNatsTriggerEnabled = exports.existsNatsTrigger = exports.listNatsTriggers = exports.getNatsTrigger = exports.deleteNatsTrigger = exports.updateNatsTrigger = void 0; exports.setCaptureConfig = exports.removeGranularAcls = exports.addGranularAcls = exports.getGranularAcls = exports.listBlacklistedAgentTokens = exports.removeBlacklistAgentToken = exports.blacklistAgentToken = exports.createAgentToken = exports.listAvailablePythonVersions = exports.listAutoscalingEvents = exports.listConfigs = exports.deleteConfig = exports.updateConfig = exports.getConfig = exports.listWorkerGroups = exports.getCountsOfJobsWaitingPerTag = exports.getQueueMetrics = exports.existsWorkerWithTag = exports.listWorkers = exports.removeOwnerToFolder = exports.addOwnerToFolder = exports.getFolderUsage = exports.existsFolder = exports.getFolder = exports.deleteFolder = exports.updateFolder = exports.createFolder = exports.listFolderNames = exports.listFolders = exports.removeUserToGroup = exports.addUserToGroup = exports.getGroup = exports.deleteGroup = exports.updateGroup = exports.createGroup = exports.listGroupNames = exports.listGroups = exports.overwriteInstanceGroups = exports.exportInstanceGroups = exports.removeUserFromInstanceGroup = exports.addUserToInstanceGroup = exports.deleteInstanceGroup = exports.updateInstanceGroup = exports.createInstanceGroup = exports.getInstanceGroup = exports.listInstanceGroups = exports.testPostgresConnection = exports.setPostgresTriggerEnabled = exports.existsPostgresTrigger = exports.listPostgresTriggers = void 0; exports.listAssetsByUsage = exports.listAssets = exports.clearIndex = exports.countSearchLogsIndex = exports.searchLogsIndex = exports.searchJobsIndex = exports.listExtendedJobs = exports.getConcurrencyKey = exports.deleteConcurrencyGroup = exports.listConcurrencyGroups = exports.getLogFile = exports.listLogFiles = exports.getJobProgress = exports.setJobProgress = exports.getJobMetrics = exports.fileDownloadParquetAsCsv = exports.fileDownload = exports.fileUpload = exports.moveS3File = exports.deleteS3File = exports.loadCsvPreview = exports.loadTableRowCount = exports.loadParquetPreview = exports.loadFilePreview = exports.loadFileMetadata = exports.listStoredFiles = exports.datasetStorageTestConnection = exports.s3ResourceInfo = exports.polarsConnectionSettingsV2 = exports.polarsConnectionSettings = exports.duckdbConnectionSettingsV2 = exports.duckdbConnectionSettings = exports.deleteInput = exports.updateInput = exports.createInput = exports.listInputs = exports.getArgsFromHistoryOrSavedInput = exports.getInputHistory = exports.unstar = exports.star = exports.deleteCapture = exports.getCapture = exports.moveCapturesAndConfigs = exports.listCaptures = exports.getCaptureConfigs = exports.pingCaptureConfig = void 0; const OpenAPI_1 = require("./core/OpenAPI"); const request_1 = require("./core/request"); /** * get backend version * @returns string git version of backend * @throws ApiError */ const backendVersion = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/version' }); }; exports.backendVersion = backendVersion; /** * is backend up to date * @returns string is backend up to date * @throws ApiError */ const backendUptodate = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/uptodate' }); }; exports.backendUptodate = backendUptodate; /** * get license id * @returns string get license id (empty if not ee) * @throws ApiError */ const getLicenseId = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/ee_license' }); }; exports.getLicenseId = getLicenseId; /** * get openapi yaml spec * @returns string openapi yaml file content * @throws ApiError */ const getOpenApiYaml = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/openapi.yaml' }); }; exports.getOpenApiYaml = getOpenApiYaml; /** * get audit log (requires admin privilege) * @param data The data for the request. * @param data.workspace * @param data.id * @returns AuditLog an audit log * @throws ApiError */ const getAuditLog = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/audit/get/{id}', path: { workspace: data.workspace, id: data.id } }); }; exports.getAuditLog = getAuditLog; /** * list audit logs (requires admin privilege) * @param data The data for the request. * @param data.workspace * @param data.page which page to return (start at 1, default 1) * @param data.perPage number of items to return for a given page (default 30, max 100) * @param data.before filter on started before (inclusive) timestamp * @param data.after filter on created after (exclusive) timestamp * @param data.username filter on exact username of user * @param data.operation filter on exact or prefix name of operation * @param data.operations comma separated list of exact operations to include * @param data.excludeOperations comma separated list of operations to exclude * @param data.resource filter on exact or prefix name of resource * @param data.actionKind filter on type of operation * @param data.allWorkspaces get audit logs for all workspaces * @returns AuditLog a list of audit logs * @throws ApiError */ const listAuditLogs = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/audit/list', path: { workspace: data.workspace }, query: { page: data.page, per_page: data.perPage, before: data.before, after: data.after, username: data.username, operation: data.operation, operations: data.operations, exclude_operations: data.excludeOperations, resource: data.resource, action_kind: data.actionKind, all_workspaces: data.allWorkspaces } }); }; exports.listAuditLogs = listAuditLogs; /** * login with password * @param data The data for the request. * @param data.requestBody credentials * @returns string Successfully authenticated. The session ID is returned in a cookie named `token` and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience. * * @throws ApiError */ const login = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/auth/login', body: data.requestBody, mediaType: 'application/json' }); }; exports.login = login; /** * logout * @returns string clear cookies and clear token (if applicable) * @throws ApiError */ const logout = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/auth/logout' }); }; exports.logout = logout; /** * get user (require admin privilege) * @param data The data for the request. * @param data.workspace * @param data.username * @returns User user created * @throws ApiError */ const getUser = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/users/get/{username}', path: { workspace: data.workspace, username: data.username } }); }; exports.getUser = getUser; /** * update user (require admin privilege) * @param data The data for the request. * @param data.workspace * @param data.username * @param data.requestBody new user * @returns string edited user * @throws ApiError */ const updateUser = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/users/update/{username}', path: { workspace: data.workspace, username: data.username }, body: data.requestBody, mediaType: 'application/json' }); }; exports.updateUser = updateUser; /** * is owner of path * @param data The data for the request. * @param data.workspace * @param data.path * @returns boolean is owner * @throws ApiError */ const isOwnerOfPath = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/users/is_owner/{path}', path: { workspace: data.workspace, path: data.path } }); }; exports.isOwnerOfPath = isOwnerOfPath; /** * set password * @param data The data for the request. * @param data.requestBody set password * @returns string password set * @throws ApiError */ const setPassword = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/setpassword', body: data.requestBody, mediaType: 'application/json' }); }; exports.setPassword = setPassword; /** * set password for a specific user (require super admin) * @param data The data for the request. * @param data.user * @param data.requestBody set password * @returns string password set * @throws ApiError */ const setPasswordForUser = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/set_password_of/{user}', path: { user: data.user }, body: data.requestBody, mediaType: 'application/json' }); }; exports.setPasswordForUser = setPasswordForUser; /** * set login type for a specific user (require super admin) * @param data The data for the request. * @param data.user * @param data.requestBody set login type * @returns string login type set * @throws ApiError */ const setLoginTypeForUser = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/set_login_type/{user}', path: { user: data.user }, body: data.requestBody, mediaType: 'application/json' }); }; exports.setLoginTypeForUser = setLoginTypeForUser; /** * create user * @param data The data for the request. * @param data.requestBody user info * @returns string user created * @throws ApiError */ const createUserGlobally = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/create', body: data.requestBody, mediaType: 'application/json' }); }; exports.createUserGlobally = createUserGlobally; /** * global update user (require super admin) * @param data The data for the request. * @param data.email * @param data.requestBody new user info * @returns string user updated * @throws ApiError */ const globalUserUpdate = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/update/{email}', path: { email: data.email }, body: data.requestBody, mediaType: 'application/json' }); }; exports.globalUserUpdate = globalUserUpdate; /** * global username info (require super admin) * @param data The data for the request. * @param data.email * @returns unknown user renamed * @throws ApiError */ const globalUsernameInfo = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/username_info/{email}', path: { email: data.email } }); }; exports.globalUsernameInfo = globalUsernameInfo; /** * global rename user (require super admin) * @param data The data for the request. * @param data.email * @param data.requestBody new username * @returns string user renamed * @throws ApiError */ const globalUserRename = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/rename/{email}', path: { email: data.email }, body: data.requestBody, mediaType: 'application/json' }); }; exports.globalUserRename = globalUserRename; /** * global delete user (require super admin) * @param data The data for the request. * @param data.email * @returns string user deleted * @throws ApiError */ const globalUserDelete = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'DELETE', url: '/users/delete/{email}', path: { email: data.email } }); }; exports.globalUserDelete = globalUserDelete; /** * global overwrite users (require super admin and EE) * @param data The data for the request. * @param data.requestBody List of users * @returns string Success message * @throws ApiError */ const globalUsersOverwrite = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/overwrite', body: data.requestBody, mediaType: 'application/json' }); }; exports.globalUsersOverwrite = globalUsersOverwrite; /** * global export users (require super admin and EE) * @returns ExportedUser exported users * @throws ApiError */ const globalUsersExport = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/export' }); }; exports.globalUsersExport = globalUsersExport; /** * delete user (require admin privilege) * @param data The data for the request. * @param data.workspace * @param data.username * @returns string delete user * @throws ApiError */ const deleteUser = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'DELETE', url: '/w/{workspace}/users/delete/{username}', path: { workspace: data.workspace, username: data.username } }); }; exports.deleteUser = deleteUser; /** * get connected repositories * @returns GithubInstallations connected repositories * @throws ApiError */ const getGlobalConnectedRepositories = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/github_app/connected_repositories' }); }; exports.getGlobalConnectedRepositories = getGlobalConnectedRepositories; /** * list all workspaces visible to me * @returns Workspace all workspaces * @throws ApiError */ const listWorkspaces = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/workspaces/list' }); }; exports.listWorkspaces = listWorkspaces; /** * is domain allowed for auto invi * @returns boolean domain allowed or not * @throws ApiError */ const isDomainAllowed = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/workspaces/allowed_domain_auto_invite' }); }; exports.isDomainAllowed = isDomainAllowed; /** * list all workspaces visible to me with user info * @returns UserWorkspaceList workspace with associated username * @throws ApiError */ const listUserWorkspaces = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/workspaces/users' }); }; exports.listUserWorkspaces = listUserWorkspaces; /** * list all workspaces as super admin (require to be super admin) * @param data The data for the request. * @param data.page which page to return (start at 1, default 1) * @param data.perPage number of items to return for a given page (default 30, max 100) * @returns Workspace workspaces * @throws ApiError */ const listWorkspacesAsSuperAdmin = (data = {}) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/workspaces/list_as_superadmin', query: { page: data.page, per_page: data.perPage } }); }; exports.listWorkspacesAsSuperAdmin = listWorkspacesAsSuperAdmin; /** * create workspace * @param data The data for the request. * @param data.requestBody new token * @returns string token created * @throws ApiError */ const createWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/workspaces/create', body: data.requestBody, mediaType: 'application/json' }); }; exports.createWorkspace = createWorkspace; /** * exists workspace * @param data The data for the request. * @param data.requestBody id of workspace * @returns boolean status * @throws ApiError */ const existsWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/workspaces/exists', body: data.requestBody, mediaType: 'application/json' }); }; exports.existsWorkspace = existsWorkspace; /** * exists username * @param data The data for the request. * @param data.requestBody * @returns boolean status * @throws ApiError */ const existsUsername = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/workspaces/exists_username', body: data.requestBody, mediaType: 'application/json' }); }; exports.existsUsername = existsUsername; /** * get global settings * @param data The data for the request. * @param data.key * @returns unknown status * @throws ApiError */ const getGlobal = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/settings/global/{key}', path: { key: data.key } }); }; exports.getGlobal = getGlobal; /** * post global settings * @param data The data for the request. * @param data.key * @param data.requestBody value set * @returns string status * @throws ApiError */ const setGlobal = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/global/{key}', path: { key: data.key }, body: data.requestBody, mediaType: 'application/json' }); }; exports.setGlobal = setGlobal; /** * get local settings * @returns unknown status * @throws ApiError */ const getLocal = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/settings/local' }); }; exports.getLocal = getLocal; /** * test smtp * @param data The data for the request. * @param data.requestBody test smtp payload * @returns string status * @throws ApiError */ const testSmtp = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/test_smtp', body: data.requestBody, mediaType: 'application/json' }); }; exports.testSmtp = testSmtp; /** * test critical channels * @param data The data for the request. * @param data.requestBody test critical channel payload * @returns string status * @throws ApiError */ const testCriticalChannels = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/test_critical_channels', body: data.requestBody, mediaType: 'application/json' }); }; exports.testCriticalChannels = testCriticalChannels; /** * Get all critical alerts * @param data The data for the request. * @param data.page * @param data.pageSize * @param data.acknowledged * @returns unknown Successfully retrieved all critical alerts * @throws ApiError */ const getCriticalAlerts = (data = {}) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/settings/critical_alerts', query: { page: data.page, page_size: data.pageSize, acknowledged: data.acknowledged } }); }; exports.getCriticalAlerts = getCriticalAlerts; /** * Acknowledge a critical alert * @param data The data for the request. * @param data.id The ID of the critical alert to acknowledge * @returns string Successfully acknowledged the critical alert * @throws ApiError */ const acknowledgeCriticalAlert = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/critical_alerts/{id}/acknowledge', path: { id: data.id } }); }; exports.acknowledgeCriticalAlert = acknowledgeCriticalAlert; /** * Acknowledge all unacknowledged critical alerts * @returns string Successfully acknowledged all unacknowledged critical alerts. * @throws ApiError */ const acknowledgeAllCriticalAlerts = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/critical_alerts/acknowledge_all' }); }; exports.acknowledgeAllCriticalAlerts = acknowledgeAllCriticalAlerts; /** * test license key * @param data The data for the request. * @param data.requestBody test license key * @returns string status * @throws ApiError */ const testLicenseKey = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/test_license_key', body: data.requestBody, mediaType: 'application/json' }); }; exports.testLicenseKey = testLicenseKey; /** * test object storage config * @param data The data for the request. * @param data.requestBody test object storage config * @returns string status * @throws ApiError */ const testObjectStorageConfig = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/test_object_storage_config', body: data.requestBody, mediaType: 'application/json' }); }; exports.testObjectStorageConfig = testObjectStorageConfig; /** * send stats * @returns string status * @throws ApiError */ const sendStats = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/send_stats' }); }; exports.sendStats = sendStats; /** * get latest key renewal attempt * @returns unknown status * @throws ApiError */ const getLatestKeyRenewalAttempt = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/settings/latest_key_renewal_attempt' }); }; exports.getLatestKeyRenewalAttempt = getLatestKeyRenewalAttempt; /** * renew license key * @param data The data for the request. * @param data.licenseKey * @returns string status * @throws ApiError */ const renewLicenseKey = (data = {}) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/renew_license_key', query: { license_key: data.licenseKey } }); }; exports.renewLicenseKey = renewLicenseKey; /** * create customer portal session * @param data The data for the request. * @param data.licenseKey * @returns string url to portal * @throws ApiError */ const createCustomerPortalSession = (data = {}) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/settings/customer_portal', query: { license_key: data.licenseKey } }); }; exports.createCustomerPortalSession = createCustomerPortalSession; /** * test metadata * @param data The data for the request. * @param data.requestBody test metadata * @returns string status * @throws ApiError */ const testMetadata = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/saml/test_metadata', body: data.requestBody, mediaType: 'application/json' }); }; exports.testMetadata = testMetadata; /** * list global settings * @returns GlobalSetting list of settings * @throws ApiError */ const listGlobalSettings = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/settings/list_global' }); }; exports.listGlobalSettings = listGlobalSettings; /** * get current user email (if logged in) * @returns string user email * @throws ApiError */ const getCurrentEmail = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/email' }); }; exports.getCurrentEmail = getCurrentEmail; /** * refresh the current token * @param data The data for the request. * @param data.ifExpiringInLessThanS * @returns string new token * @throws ApiError */ const refreshUserToken = (data = {}) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/refresh_token', query: { if_expiring_in_less_than_s: data.ifExpiringInLessThanS } }); }; exports.refreshUserToken = refreshUserToken; /** * get tutorial progress * @returns unknown tutorial progress * @throws ApiError */ const getTutorialProgress = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/tutorial_progress' }); }; exports.getTutorialProgress = getTutorialProgress; /** * update tutorial progress * @param data The data for the request. * @param data.requestBody progress update * @returns string tutorial progress * @throws ApiError */ const updateTutorialProgress = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/tutorial_progress', body: data.requestBody, mediaType: 'application/json' }); }; exports.updateTutorialProgress = updateTutorialProgress; /** * leave instance * @returns string status * @throws ApiError */ const leaveInstance = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/leave_instance' }); }; exports.leaveInstance = leaveInstance; /** * get current usage outside of premium workspaces * @returns number free usage * @throws ApiError */ const getUsage = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/usage' }); }; exports.getUsage = getUsage; /** * get all runnables in every workspace * @returns unknown free all runnables * @throws ApiError */ const getRunnable = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/all_runnables' }); }; exports.getRunnable = getRunnable; /** * get current global whoami (if logged in) * @returns GlobalUserInfo user email * @throws ApiError */ const globalWhoami = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/whoami' }); }; exports.globalWhoami = globalWhoami; /** * list all workspace invites * @returns WorkspaceInvite list all workspace invites * @throws ApiError */ const listWorkspaceInvites = () => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/list_invites' }); }; exports.listWorkspaceInvites = listWorkspaceInvites; /** * whoami * @param data The data for the request. * @param data.workspace * @returns User user * @throws ApiError */ const whoami = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/users/whoami', path: { workspace: data.workspace } }); }; exports.whoami = whoami; /** * get github app token * @param data The data for the request. * @param data.workspace * @param data.requestBody jwt job token * @returns unknown github app token * @throws ApiError */ const getGithubAppToken = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/github_app/token', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.getGithubAppToken = getGithubAppToken; /** * Install a GitHub installation from another workspace * @param data The data for the request. * @param data.workspace * @param data.requestBody * @returns unknown Installation successfully copied * @throws ApiError */ const installFromWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/github_app/install_from_workspace', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.installFromWorkspace = installFromWorkspace; /** * Delete a GitHub installation from a workspace * Removes a GitHub installation from the specified workspace. Requires admin privileges. * @param data The data for the request. * @param data.workspace * @param data.installationId The ID of the GitHub installation to delete * @returns unknown Installation successfully deleted * @throws ApiError */ const deleteFromWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'DELETE', url: '/w/{workspace}/github_app/installation/{installation_id}', path: { workspace: data.workspace, installation_id: data.installationId } }); }; exports.deleteFromWorkspace = deleteFromWorkspace; /** * Export GitHub installation JWT token * Exports the JWT token for a specific GitHub installation in the workspace * @param data The data for the request. * @param data.workspace * @param data.installationId * @returns unknown Successfully exported the JWT token * @throws ApiError */ const exportInstallation = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/github_app/export/{installationId}', path: { workspace: data.workspace, installationId: data.installationId } }); }; exports.exportInstallation = exportInstallation; /** * Import GitHub installation from JWT token * Imports a GitHub installation from a JWT token exported from another instance * @param data The data for the request. * @param data.workspace * @param data.requestBody * @returns unknown Successfully imported the installation * @throws ApiError */ const importInstallation = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/github_app/import', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.importInstallation = importInstallation; /** * accept invite to workspace * @param data The data for the request. * @param data.requestBody accept invite * @returns string status * @throws ApiError */ const acceptInvite = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/accept_invite', body: data.requestBody, mediaType: 'application/json' }); }; exports.acceptInvite = acceptInvite; /** * decline invite to workspace * @param data The data for the request. * @param data.requestBody decline invite * @returns string status * @throws ApiError */ const declineInvite = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/users/decline_invite', body: data.requestBody, mediaType: 'application/json' }); }; exports.declineInvite = declineInvite; /** * invite user to workspace * @param data The data for the request. * @param data.workspace * @param data.requestBody WorkspaceInvite * @returns string status * @throws ApiError */ const inviteUser = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/invite_user', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.inviteUser = inviteUser; /** * add user to workspace * @param data The data for the request. * @param data.workspace * @param data.requestBody WorkspaceInvite * @returns string status * @throws ApiError */ const addUser = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/add_user', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.addUser = addUser; /** * delete user invite * @param data The data for the request. * @param data.workspace * @param data.requestBody WorkspaceInvite * @returns string status * @throws ApiError */ const deleteInvite = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/delete_invite', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.deleteInvite = deleteInvite; /** * archive workspace * @param data The data for the request. * @param data.workspace * @returns string status * @throws ApiError */ const archiveWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/archive', path: { workspace: data.workspace } }); }; exports.archiveWorkspace = archiveWorkspace; /** * unarchive workspace * @param data The data for the request. * @param data.workspace * @returns string status * @throws ApiError */ const unarchiveWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/workspaces/unarchive/{workspace}', path: { workspace: data.workspace } }); }; exports.unarchiveWorkspace = unarchiveWorkspace; /** * delete workspace (require super admin) * @param data The data for the request. * @param data.workspace * @returns string status * @throws ApiError */ const deleteWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'DELETE', url: '/workspaces/delete/{workspace}', path: { workspace: data.workspace } }); }; exports.deleteWorkspace = deleteWorkspace; /** * leave workspace * @param data The data for the request. * @param data.workspace * @returns string status * @throws ApiError */ const leaveWorkspace = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/leave', path: { workspace: data.workspace } }); }; exports.leaveWorkspace = leaveWorkspace; /** * get workspace name * @param data The data for the request. * @param data.workspace * @returns string status * @throws ApiError */ const getWorkspaceName = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/workspaces/get_workspace_name', path: { workspace: data.workspace } }); }; exports.getWorkspaceName = getWorkspaceName; /** * change workspace name * @param data The data for the request. * @param data.workspace * @param data.requestBody * @returns string status * @throws ApiError */ const changeWorkspaceName = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/change_workspace_name', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.changeWorkspaceName = changeWorkspaceName; /** * change workspace id * @param data The data for the request. * @param data.workspace * @param data.requestBody * @returns string status * @throws ApiError */ const changeWorkspaceId = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/change_workspace_id', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.changeWorkspaceId = changeWorkspaceId; /** * change workspace id * @param data The data for the request. * @param data.workspace * @param data.requestBody * @returns string status * @throws ApiError */ const changeWorkspaceColor = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/change_workspace_color', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.changeWorkspaceColor = changeWorkspaceColor; /** * whois * @param data The data for the request. * @param data.workspace * @param data.username * @returns User user * @throws ApiError */ const whois = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/w/{workspace}/users/whois/{username}', path: { workspace: data.workspace, username: data.username } }); }; exports.whois = whois; /** * Update operator settings for a workspace * Updates the operator settings for a specific workspace. Requires workspace admin privileges. * @param data The data for the request. * @param data.workspace * @param data.requestBody * @returns string Operator settings updated successfully * @throws ApiError */ const updateOperatorSettings = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'POST', url: '/w/{workspace}/workspaces/operator_settings', path: { workspace: data.workspace }, body: data.requestBody, mediaType: 'application/json' }); }; exports.updateOperatorSettings = updateOperatorSettings; /** * exists email * @param data The data for the request. * @param data.email * @returns boolean user * @throws ApiError */ const existsEmail = (data) => { return (0, request_1.request)(OpenAPI_1.OpenAPI, { method: 'GET', url: '/users/exists/{email}', path: { email: data.email } }); }; exports.existsEmail = existsEmail; /** * list all users as super admin (require to be super amdin) * @param data The data for the request. * @param data.page which page to return (start at 1, default 1) * @param data.perPage number of items to return for a given page (default 30, max 100) * @param data.activeOnly filter only active users * @returns GlobalUserInfo user * @throws ApiError */ const listUsersAsSuperAdmin = (data = {}) => {