windmill-client 0.2.0 → 0.2.1

package/dist/services/UserService.js

@@ -0,0 +1,376 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class UserService {
+    /**
+     * login with password
+     * @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
+     */
+    static login({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/auth/login',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * logout
+     * @returns string clear cookies and clear token (if applicable)
+     * @throws ApiError
+     */
+    static logout() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/auth/logout',
+        });
+    }
+    /**
+     * create user (require admin privilege)
+     * @returns string user created
+     * @throws ApiError
+     */
+    static createUser({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/users/add',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * update user (require admin privilege)
+     * @returns string edited user
+     * @throws ApiError
+     */
+    static updateUser({ workspace, username, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/users/update/{username}',
+            path: {
+                'workspace': workspace,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * is owner of path
+     * @returns boolean is owner
+     * @throws ApiError
+     */
+    static isOwnerOfPath({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/is_owner/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * set password
+     * @returns string password set
+     * @throws ApiError
+     */
+    static setPassword({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/users/setpassword',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * create user
+     * @returns string user created
+     * @throws ApiError
+     */
+    static createUserGlobally({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/users/create',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * global update user (require super admin)
+     * @returns string user updated
+     * @throws ApiError
+     */
+    static globalUserUpdate({ email, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/users/update/{email}',
+            path: {
+                'email': email,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * global delete user (require super admin)
+     * @returns string user deleted
+     * @throws ApiError
+     */
+    static globalUserDelete({ email, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/users/delete/{email}',
+            path: {
+                'email': email,
+            },
+        });
+    }
+    /**
+     * delete user (require admin privilege)
+     * @returns string delete user
+     * @throws ApiError
+     */
+    static deleteUser({ workspace, username, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/users/delete/{username}',
+            path: {
+                'workspace': workspace,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * get current user email (if logged in)
+     * @returns string user email
+     * @throws ApiError
+     */
+    static getCurrentEmail() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/users/email',
+        });
+    }
+    /**
+     * get current usage outside of premium workspaces
+     * @returns number free usage
+     * @throws ApiError
+     */
+    static getUsage() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/users/usage',
+        });
+    }
+    /**
+     * get current global whoami (if logged in)
+     * @returns GlobalUserInfo user email
+     * @throws ApiError
+     */
+    static globalWhoami() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/users/whoami',
+        });
+    }
+    /**
+     * list all workspace invites
+     * @returns WorkspaceInvite list all workspace invites
+     * @throws ApiError
+     */
+    static listWorkspaceInvites() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/users/list_invites',
+        });
+    }
+    /**
+     * whoami
+     * @returns User user
+     * @throws ApiError
+     */
+    static whoami({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/whoami',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * leave workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static leaveWorkspace({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/users/leave_workspace',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * accept invite to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static acceptInvite({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/users/accept_invite',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * decline invite to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static declineInvite({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/users/decline_invite',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * whois
+     * @returns User user
+     * @throws ApiError
+     */
+    static whois({ workspace, username, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/whois/{username}',
+            path: {
+                'workspace': workspace,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * list all users as super admin (require to be super amdin)
+     * @returns GlobalUserInfo user
+     * @throws ApiError
+     */
+    static listUsersAsSuperAdmin({ page, perPage, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/users/list_as_super_admin',
+            query: {
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+    /**
+     * list users
+     * @returns User user
+     * @throws ApiError
+     */
+    static listUsers({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/list',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * list usernames
+     * @returns string user
+     * @throws ApiError
+     */
+    static listUsernames({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/list_usernames',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * create token
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createToken({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/users/tokens/create',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * create token to impersonate a user (require superadmin)
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createTokenImpersonate({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/users/tokens/impersonate',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete token
+     * @returns string delete token
+     * @throws ApiError
+     */
+    static deleteToken({ tokenPrefix, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/users/tokens/delete/{token_prefix}',
+            path: {
+                'token_prefix': tokenPrefix,
+            },
+        });
+    }
+    /**
+     * list token
+     * @returns TruncatedToken truncated token
+     * @throws ApiError
+     */
+    static listTokens() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/users/tokens/list',
+        });
+    }
+    /**
+     * login with oauth authorization flow
+     * @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
+     */
+    static loginWithOauth({ clientName, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/oauth/login_callback/{client_name}',
+            path: {
+                'client_name': clientName,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.UserService = UserService;

package/dist/services/VariableService.d.ts

@@ -0,0 +1,83 @@
+import type { ContextualVariable } from '../models/ContextualVariable';
+import type { CreateVariable } from '../models/CreateVariable';
+import type { EditVariable } from '../models/EditVariable';
+import type { ListableVariable } from '../models/ListableVariable';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class VariableService {
+    /**
+     * create variable
+     * @returns string variable created
+     * @throws ApiError
+     */
+    static createVariable({ workspace, requestBody, alreadyEncrypted, }: {
+        workspace: string;
+        /**
+         * new variable
+         */
+        requestBody: CreateVariable;
+        alreadyEncrypted?: boolean;
+    }): CancelablePromise<string>;
+    /**
+     * delete variable
+     * @returns string variable deleted
+     * @throws ApiError
+     */
+    static deleteVariable({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * update variable
+     * @returns string variable updated
+     * @throws ApiError
+     */
+    static updateVariable({ workspace, path, requestBody, alreadyEncrypted, }: {
+        workspace: string;
+        path: string;
+        /**
+         * updated variable
+         */
+        requestBody: EditVariable;
+        alreadyEncrypted?: boolean;
+    }): CancelablePromise<string>;
+    /**
+     * get variable
+     * @returns ListableVariable variable
+     * @throws ApiError
+     */
+    static getVariable({ workspace, path, decryptSecret, }: {
+        workspace: string;
+        path: string;
+        /**
+         * ask to decrypt secret if this variable is secret
+         * (if not secret no effect, default: true)
+         *
+         */
+        decryptSecret?: boolean;
+    }): CancelablePromise<ListableVariable>;
+    /**
+     * does variable exists at path
+     * @returns boolean variable
+     * @throws ApiError
+     */
+    static existsVariable({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * list variables
+     * @returns ListableVariable variable list
+     * @throws ApiError
+     */
+    static listVariable({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<ListableVariable>>;
+    /**
+     * list contextual variables
+     * @returns ContextualVariable contextual variable list
+     * @throws ApiError
+     */
+    static listContextualVariables({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<ContextualVariable>>;
+}

package/dist/services/VariableService.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VariableService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class VariableService {
+    /**
+     * create variable
+     * @returns string variable created
+     * @throws ApiError
+     */
+    static createVariable({ workspace, requestBody, alreadyEncrypted, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/variables/create',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'already_encrypted': alreadyEncrypted,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete variable
+     * @returns string variable deleted
+     * @throws ApiError
+     */
+    static deleteVariable({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/variables/delete/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * update variable
+     * @returns string variable updated
+     * @throws ApiError
+     */
+    static updateVariable({ workspace, path, requestBody, alreadyEncrypted, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/variables/update/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'already_encrypted': alreadyEncrypted,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * get variable
+     * @returns ListableVariable variable
+     * @throws ApiError
+     */
+    static getVariable({ workspace, path, decryptSecret, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/variables/get/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'decrypt_secret': decryptSecret,
+            },
+        });
+    }
+    /**
+     * does variable exists at path
+     * @returns boolean variable
+     * @throws ApiError
+     */
+    static existsVariable({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/variables/exists/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * list variables
+     * @returns ListableVariable variable list
+     * @throws ApiError
+     */
+    static listVariable({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/variables/list',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * list contextual variables
+     * @returns ContextualVariable contextual variable list
+     * @throws ApiError
+     */
+    static listContextualVariables({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/variables/list_contextual',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+}
+exports.VariableService = VariableService;

package/dist/services/WorkerService.d.ts

@@ -0,0 +1,25 @@
+import type { WorkerPing } from '../models/WorkerPing';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class WorkerService {
+    /**
+     * get all instance custom tags (tags are used to dispatch jobs to different worker groups)
+     * @returns string list of custom tags
+     * @throws ApiError
+     */
+    static getCustomTags(): CancelablePromise<Array<string>>;
+    /**
+     * list workers
+     * @returns WorkerPing a list of workers
+     * @throws ApiError
+     */
+    static listWorkers({ 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<WorkerPing>>;
+}

package/dist/services/WorkerService.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkerService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class WorkerService {
+    /**
+     * get all instance custom tags (tags are used to dispatch jobs to different worker groups)
+     * @returns string list of custom tags
+     * @throws ApiError
+     */
+    static getCustomTags() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/workers/custom_tags',
+        });
+    }
+    /**
+     * list workers
+     * @returns WorkerPing a list of workers
+     * @throws ApiError
+     */
+    static listWorkers({ page, perPage, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/workers/list',
+            query: {
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+}
+exports.WorkerService = WorkerService;