windmill-client 0.1.0 → 0.2.1

package/src/services/UserService.d.ts

@@ -0,0 +1,284 @@
+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 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>;
+    /**
+     * 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/src/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/src/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/src/services/WorkspaceService.d.ts

@@ -0,0 +1,227 @@
+import type { CreateWorkspace } from '../models/CreateWorkspace';
+import type { UserWorkspaceList } from '../models/UserWorkspaceList';
+import type { Workspace } from '../models/Workspace';
+import type { WorkspaceInvite } from '../models/WorkspaceInvite';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class WorkspaceService {
+    /**
+     * list all workspaces visible to me
+     * @returns Workspace all workspaces
+     * @throws ApiError
+     */
+    static listWorkspaces(): CancelablePromise<Array<Workspace>>;
+    /**
+     * is domain allowed for auto invi
+     * @returns boolean domain allowed or not
+     * @throws ApiError
+     */
+    static isDomainAllowed(): CancelablePromise<boolean>;
+    /**
+     * list all workspaces visible to me with user info
+     * @returns UserWorkspaceList workspace with associated username
+     * @throws ApiError
+     */
+    static listUserWorkspaces(): CancelablePromise<UserWorkspaceList>;
+    /**
+     * list all workspaces as super admin (require to be super admin)
+     * @returns Workspace workspaces
+     * @throws ApiError
+     */
+    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>>;
+    /**
+     * create workspace
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createWorkspace({ requestBody, }: {
+        /**
+         * new token
+         */
+        requestBody: CreateWorkspace;
+    }): CancelablePromise<string>;
+    /**
+     * exists workspace
+     * @returns boolean status
+     * @throws ApiError
+     */
+    static existsWorkspace({ requestBody, }: {
+        /**
+         * id of workspace
+         */
+        requestBody: {
+            id: string;
+        };
+    }): CancelablePromise<boolean>;
+    /**
+     * exists username
+     * @returns boolean status
+     * @throws ApiError
+     */
+    static existsUsername({ requestBody, }: {
+        requestBody: {
+            id: string;
+            username: string;
+        };
+    }): CancelablePromise<boolean>;
+    /**
+     * invite user to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static inviteUser({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            email: string;
+            is_admin: boolean;
+            operator: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * add user to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static addUser({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            email: string;
+            is_admin: boolean;
+            username: string;
+            operator: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * delete user invite
+     * @returns string status
+     * @throws ApiError
+     */
+    static deleteInvite({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            email: string;
+            is_admin: boolean;
+            operator: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * archive workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static archiveWorkspace({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<string>;
+    /**
+     * unarchive workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static unarchiveWorkspace({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<string>;
+    /**
+     * delete workspace (require super admin)
+     * @returns string status
+     * @throws ApiError
+     */
+    static deleteWorkspace({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<string>;
+    /**
+     * list pending invites for a workspace
+     * @returns WorkspaceInvite user
+     * @throws ApiError
+     */
+    static listPendingInvites({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<WorkspaceInvite>>;
+    /**
+     * get settings
+     * @returns any status
+     * @throws ApiError
+     */
+    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;
+        plan?: string;
+        customer_id?: string;
+        webhook?: string;
+    }>;
+    /**
+     * get premium info
+     * @returns any status
+     * @throws ApiError
+     */
+    static getPremiumInfo({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<{
+        premium: boolean;
+        usage?: number;
+    }>;
+    /**
+     * edit slack command
+     * @returns string status
+     * @throws ApiError
+     */
+    static editSlackCommand({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            slack_command_script?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * edit auto invite
+     * @returns string status
+     * @throws ApiError
+     */
+    static editAutoInvite({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            operator?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * edit webhook
+     * @returns string status
+     * @throws ApiError
+     */
+    static editWebhook({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceWebhook
+         */
+        requestBody: {
+            webhook?: string;
+        };
+    }): CancelablePromise<string>;
+}