windmill-client 0.3.11 → 0.3.13

package/dist/src/services/UserService.d.ts

@@ -0,0 +1,306 @@
+import type { EditWorkspaceUser } from '../models/EditWorkspaceUser';
+import type { GlobalUserInfo } from '../models/GlobalUserInfo';
+import type { Login } from '../models/Login';
+import type { NewToken } from '../models/NewToken';
+import type { NewTokenImpersonate } from '../models/NewTokenImpersonate';
+import type { NewUser } from '../models/NewUser';
+import type { TruncatedToken } from '../models/TruncatedToken';
+import type { User } from '../models/User';
+import type { WorkspaceInvite } from '../models/WorkspaceInvite';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare 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, }: {
+        /**
+         * credentials
+         */
+        requestBody: Login;
+    }): CancelablePromise<string>;
+    /**
+     * logout
+     * @returns string clear cookies and clear token (if applicable)
+     * @throws ApiError
+     */
+    static logout(): CancelablePromise<string>;
+    /**
+     * create user (require admin privilege)
+     * @returns string user created
+     * @throws ApiError
+     */
+    static createUser({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * new user
+         */
+        requestBody: NewUser;
+    }): CancelablePromise<string>;
+    /**
+     * update user (require admin privilege)
+     * @returns string edited user
+     * @throws ApiError
+     */
+    static updateUser({ workspace, username, requestBody, }: {
+        workspace: string;
+        username: string;
+        /**
+         * new user
+         */
+        requestBody: EditWorkspaceUser;
+    }): CancelablePromise<string>;
+    /**
+     * is owner of path
+     * @returns boolean is owner
+     * @throws ApiError
+     */
+    static isOwnerOfPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * set password
+     * @returns string password set
+     * @throws ApiError
+     */
+    static setPassword({ requestBody, }: {
+        /**
+         * set password
+         */
+        requestBody: {
+            password: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * create user
+     * @returns string user created
+     * @throws ApiError
+     */
+    static createUserGlobally({ requestBody, }: {
+        /**
+         * user info
+         */
+        requestBody: {
+            email: string;
+            password: string;
+            super_admin: boolean;
+            name?: string;
+            company?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * global update user (require super admin)
+     * @returns string user updated
+     * @throws ApiError
+     */
+    static globalUserUpdate({ email, requestBody, }: {
+        email: string;
+        /**
+         * new user info
+         */
+        requestBody: {
+            is_super_admin?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * global delete user (require super admin)
+     * @returns string user deleted
+     * @throws ApiError
+     */
+    static globalUserDelete({ email, }: {
+        email: string;
+    }): CancelablePromise<string>;
+    /**
+     * delete user (require admin privilege)
+     * @returns string delete user
+     * @throws ApiError
+     */
+    static deleteUser({ workspace, username, }: {
+        workspace: string;
+        username: string;
+    }): CancelablePromise<string>;
+    /**
+     * get current user email (if logged in)
+     * @returns string user email
+     * @throws ApiError
+     */
+    static getCurrentEmail(): CancelablePromise<string>;
+    /**
+     * get current usage outside of premium workspaces
+     * @returns number free usage
+     * @throws ApiError
+     */
+    static getUsage(): CancelablePromise<number>;
+    /**
+     * get all runnables in every workspace
+     * @returns any free all runnables
+     * @throws ApiError
+     */
+    static getRunnable(): CancelablePromise<{
+        workspace: string;
+        endpoint_async: string;
+        endpoint_sync: string;
+        endpoint_openai_sync: string;
+        summary: string;
+        description?: string;
+        kind: string;
+    }>;
+    /**
+     * get current global whoami (if logged in)
+     * @returns GlobalUserInfo user email
+     * @throws ApiError
+     */
+    static globalWhoami(): CancelablePromise<GlobalUserInfo>;
+    /**
+     * list all workspace invites
+     * @returns WorkspaceInvite list all workspace invites
+     * @throws ApiError
+     */
+    static listWorkspaceInvites(): CancelablePromise<Array<WorkspaceInvite>>;
+    /**
+     * whoami
+     * @returns User user
+     * @throws ApiError
+     */
+    static whoami({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<User>;
+    /**
+     * leave workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static leaveWorkspace({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<string>;
+    /**
+     * accept invite to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static acceptInvite({ requestBody, }: {
+        /**
+         * accept invite
+         */
+        requestBody: {
+            workspace_id: string;
+            username: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * decline invite to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static declineInvite({ requestBody, }: {
+        /**
+         * decline invite
+         */
+        requestBody: {
+            workspace_id: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * whois
+     * @returns User user
+     * @throws ApiError
+     */
+    static whois({ workspace, username, }: {
+        workspace: string;
+        username: string;
+    }): CancelablePromise<User>;
+    /**
+     * exists email
+     * @returns boolean user
+     * @throws ApiError
+     */
+    static existsEmail({ email, }: {
+        email: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * list all users as super admin (require to be super amdin)
+     * @returns GlobalUserInfo user
+     * @throws ApiError
+     */
+    static listUsersAsSuperAdmin({ 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<GlobalUserInfo>>;
+    /**
+     * list users
+     * @returns User user
+     * @throws ApiError
+     */
+    static listUsers({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<User>>;
+    /**
+     * list usernames
+     * @returns string user
+     * @throws ApiError
+     */
+    static listUsernames({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<string>>;
+    /**
+     * create token
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createToken({ requestBody, }: {
+        /**
+         * new token
+         */
+        requestBody: NewToken;
+    }): CancelablePromise<string>;
+    /**
+     * create token to impersonate a user (require superadmin)
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createTokenImpersonate({ requestBody, }: {
+        /**
+         * new token
+         */
+        requestBody: NewTokenImpersonate;
+    }): CancelablePromise<string>;
+    /**
+     * delete token
+     * @returns string delete token
+     * @throws ApiError
+     */
+    static deleteToken({ tokenPrefix, }: {
+        tokenPrefix: string;
+    }): CancelablePromise<string>;
+    /**
+     * list token
+     * @returns TruncatedToken truncated token
+     * @throws ApiError
+     */
+    static listTokens(): CancelablePromise<Array<TruncatedToken>>;
+    /**
+     * 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, }: {
+        clientName: string;
+        /**
+         * Partially filled script
+         */
+        requestBody: {
+            code?: string;
+            state?: string;
+        };
+    }): CancelablePromise<string>;
+}

package/dist/src/services/UserService.js

@@ -0,0 +1,397 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export 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 __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/auth/logout',
+        });
+    }
+    /**
+     * create user (require admin privilege)
+     * @returns string user created
+     * @throws ApiError
+     */
+    static createUser({ workspace, requestBody, }) {
+        return __request(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 __request(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 __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/users/setpassword',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * create user
+     * @returns string user created
+     * @throws ApiError
+     */
+    static createUserGlobally({ requestBody, }) {
+        return __request(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 __request(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 __request(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 __request(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 __request(OpenAPI, {
+            method: 'GET',
+            url: '/users/email',
+        });
+    }
+    /**
+     * get current usage outside of premium workspaces
+     * @returns number free usage
+     * @throws ApiError
+     */
+    static getUsage() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/users/usage',
+        });
+    }
+    /**
+     * get all runnables in every workspace
+     * @returns any free all runnables
+     * @throws ApiError
+     */
+    static getRunnable() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/users/all_runnables',
+        });
+    }
+    /**
+     * get current global whoami (if logged in)
+     * @returns GlobalUserInfo user email
+     * @throws ApiError
+     */
+    static globalWhoami() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/users/whoami',
+        });
+    }
+    /**
+     * list all workspace invites
+     * @returns WorkspaceInvite list all workspace invites
+     * @throws ApiError
+     */
+    static listWorkspaceInvites() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/users/list_invites',
+        });
+    }
+    /**
+     * whoami
+     * @returns User user
+     * @throws ApiError
+     */
+    static whoami({ workspace, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/whoami',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * leave workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static leaveWorkspace({ workspace, }) {
+        return __request(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 __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/users/decline_invite',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * whois
+     * @returns User user
+     * @throws ApiError
+     */
+    static whois({ workspace, username, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/whois/{username}',
+            path: {
+                'workspace': workspace,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * exists email
+     * @returns boolean user
+     * @throws ApiError
+     */
+    static existsEmail({ email, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/users/exists/{email}',
+            path: {
+                'email': email,
+            },
+        });
+    }
+    /**
+     * list all users as super admin (require to be super amdin)
+     * @returns GlobalUserInfo user
+     * @throws ApiError
+     */
+    static listUsersAsSuperAdmin({ page, perPage, }) {
+        return __request(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 __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/list',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * list usernames
+     * @returns string user
+     * @throws ApiError
+     */
+    static listUsernames({ workspace, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/list_usernames',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * create token
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createToken({ requestBody, }) {
+        return __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/users/tokens/impersonate',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete token
+     * @returns string delete token
+     * @throws ApiError
+     */
+    static deleteToken({ tokenPrefix, }) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/users/tokens/delete/{token_prefix}',
+            path: {
+                'token_prefix': tokenPrefix,
+            },
+        });
+    }
+    /**
+     * list token
+     * @returns TruncatedToken truncated token
+     * @throws ApiError
+     */
+    static listTokens() {
+        return __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/oauth/login_callback/{client_name}',
+            path: {
+                'client_name': clientName,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}