windmill-client 0.3.11 → 0.3.13

package/dist/src/models/UserWorkspaceList.d.ts

@@ -0,0 +1,8 @@
+export type UserWorkspaceList = {
+    email: string;
+    workspaces: Array<{
+        id: string;
+        name: string;
+        username: string;
+    }>;
+};

package/dist/src/models/UserWorkspaceList.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/src/models/Username.d.ts

@@ -0,0 +1,4 @@
+/**
+ * filter on exact username of user
+ */
+export type Username = string;

package/dist/src/models/Username.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/src/models/VersionId.d.ts

@@ -0,0 +1 @@
+export type VersionId = number;

package/dist/src/models/VersionId.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/src/models/WorkerPing.d.ts

@@ -0,0 +1,8 @@
+export type WorkerPing = {
+    worker: string;
+    worker_instance: string;
+    last_ping?: number;
+    started_at: string;
+    ip: string;
+    jobs_executed: number;
+};

package/dist/src/models/WorkerPing.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/src/models/Workspace.d.ts

@@ -0,0 +1,6 @@
+export type Workspace = {
+    id: string;
+    name: string;
+    owner: string;
+    domain?: string;
+};

package/dist/src/models/Workspace.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/src/models/WorkspaceId.d.ts

@@ -0,0 +1 @@
+export type WorkspaceId = string;

package/dist/src/models/WorkspaceId.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/src/models/WorkspaceInvite.d.ts

@@ -0,0 +1,6 @@
+export type WorkspaceInvite = {
+    workspace_id: string;
+    email: string;
+    is_admin: boolean;
+    operator: boolean;
+};

package/dist/src/models/WorkspaceInvite.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

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

@@ -0,0 +1,39 @@
+import type { EditWorkspaceUser } from '../models/EditWorkspaceUser';
+import type { NewUser } from '../models/NewUser';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AdminService {
+    /**
+     * 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>;
+    /**
+     * delete user (require admin privilege)
+     * @returns string delete user
+     * @throws ApiError
+     */
+    static deleteUser({ workspace, username, }: {
+        workspace: string;
+        username: string;
+    }): CancelablePromise<string>;
+}

package/dist/src/services/AdminService.js

@@ -0,0 +1,52 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class AdminService {
+    /**
+     * 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',
+        });
+    }
+    /**
+     * 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,
+            },
+        });
+    }
+}

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

@@ -0,0 +1,195 @@
+import type { AppWithLastVersion } from '../models/AppWithLastVersion';
+import type { AppWithLastVersionWDraft } from '../models/AppWithLastVersionWDraft';
+import type { ListableApp } from '../models/ListableApp';
+import type { Policy } from '../models/Policy';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AppService {
+    /**
+     * list all available hub apps
+     * @returns any hub apps list
+     * @throws ApiError
+     */
+    static listHubApps(): CancelablePromise<{
+        apps?: Array<{
+            id: number;
+            app_id: number;
+            summary: string;
+            apps: Array<string>;
+            approved: boolean;
+            votes: number;
+        }>;
+    }>;
+    /**
+     * get hub app by id
+     * @returns any app
+     * @throws ApiError
+     */
+    static getHubAppById({ id, }: {
+        id: number;
+    }): CancelablePromise<{
+        app: {
+            summary: string;
+            value: any;
+        };
+    }>;
+    /**
+     * list all available apps
+     * @returns ListableApp All available apps
+     * @throws ApiError
+     */
+    static listApps({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, starredOnly, }: {
+        workspace: string;
+        /**
+         * 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;
+        /**
+         * order by desc order (default true)
+         */
+        orderDesc?: boolean;
+        /**
+         * mask to filter exact matching user creator
+         */
+        createdBy?: string;
+        /**
+         * mask to filter matching starting path
+         */
+        pathStart?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        pathExact?: string;
+        /**
+         * (default false)
+         * show only the starred items
+         *
+         */
+        starredOnly?: boolean;
+    }): CancelablePromise<Array<ListableApp>>;
+    /**
+     * create app
+     * @returns string app created
+     * @throws ApiError
+     */
+    static createApp({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * new app
+         */
+        requestBody: {
+            path: string;
+            value: any;
+            summary: string;
+            policy: Policy;
+            draft_only?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * does an app exisst at path
+     * @returns boolean app exists
+     * @throws ApiError
+     */
+    static existsApp({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * get app by path
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getAppByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<AppWithLastVersion>;
+    /**
+     * get app by path with draft
+     * @returns AppWithLastVersionWDraft app details with draft
+     * @throws ApiError
+     */
+    static getAppByPathWithDraft({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<AppWithLastVersionWDraft>;
+    /**
+     * get public app by secret
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getPublicAppBySecret({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<AppWithLastVersion>;
+    /**
+     * get public secret of app
+     * @returns string app secret
+     * @throws ApiError
+     */
+    static getPublicSecretOfApp({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * get app by version
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getAppByVersion({ workspace, id, }: {
+        workspace: string;
+        id: number;
+    }): CancelablePromise<AppWithLastVersion>;
+    /**
+     * delete app
+     * @returns string app deleted
+     * @throws ApiError
+     */
+    static deleteApp({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * update app
+     * @returns string app updated
+     * @throws ApiError
+     */
+    static updateApp({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * update app
+         */
+        requestBody: {
+            path?: string;
+            summary?: string;
+            value?: any;
+            policy?: Policy;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * executeComponent
+     * @returns string job uuid
+     * @throws ApiError
+     */
+    static executeComponent({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * update app
+         */
+        requestBody: {
+            component: string;
+            path?: string;
+            args: any;
+            raw_code?: {
+                content: string;
+                language: string;
+                path?: string;
+            };
+            force_viewer_static_fields?: Record<string, any>;
+        };
+    }): CancelablePromise<string>;
+}

package/dist/src/services/AppService.js

@@ -0,0 +1,207 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class AppService {
+    /**
+     * list all available hub apps
+     * @returns any hub apps list
+     * @throws ApiError
+     */
+    static listHubApps() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/apps/hub/list',
+        });
+    }
+    /**
+     * get hub app by id
+     * @returns any app
+     * @throws ApiError
+     */
+    static getHubAppById({ id, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/apps/hub/get/{id}',
+            path: {
+                'id': id,
+            },
+        });
+    }
+    /**
+     * list all available apps
+     * @returns ListableApp All available apps
+     * @throws ApiError
+     */
+    static listApps({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, starredOnly, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+                'order_desc': orderDesc,
+                'created_by': createdBy,
+                'path_start': pathStart,
+                'path_exact': pathExact,
+                'starred_only': starredOnly,
+            },
+        });
+    }
+    /**
+     * create app
+     * @returns string app created
+     * @throws ApiError
+     */
+    static createApp({ workspace, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/apps/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * does an app exisst at path
+     * @returns boolean app exists
+     * @throws ApiError
+     */
+    static existsApp({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/exists/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get app by path
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getAppByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/get/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get app by path with draft
+     * @returns AppWithLastVersionWDraft app details with draft
+     * @throws ApiError
+     */
+    static getAppByPathWithDraft({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/get/draft/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get public app by secret
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getPublicAppBySecret({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps_u/public_app/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get public secret of app
+     * @returns string app secret
+     * @throws ApiError
+     */
+    static getPublicSecretOfApp({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/secret_of/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get app by version
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getAppByVersion({ workspace, id, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/get/v/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * delete app
+     * @returns string app deleted
+     * @throws ApiError
+     */
+    static deleteApp({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/apps/delete/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * update app
+     * @returns string app updated
+     * @throws ApiError
+     */
+    static updateApp({ workspace, path, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/apps/update/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * executeComponent
+     * @returns string job uuid
+     * @throws ApiError
+     */
+    static executeComponent({ workspace, path, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/apps_u/execute_component/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}

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

@@ -0,0 +1,53 @@
+import type { AuditLog } from '../models/AuditLog';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AuditService {
+    /**
+     * get audit log (requires admin privilege)
+     * @returns AuditLog an audit log
+     * @throws ApiError
+     */
+    static getAuditLog({ workspace, id, }: {
+        workspace: string;
+        id: number;
+    }): CancelablePromise<AuditLog>;
+    /**
+     * list audit logs (requires admin privilege)
+     * @returns AuditLog a list of audit logs
+     * @throws ApiError
+     */
+    static listAuditLogs({ workspace, page, perPage, before, after, username, operation, resource, actionKind, }: {
+        workspace: string;
+        /**
+         * 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;
+        /**
+         * filter on created before (exclusive) timestamp
+         */
+        before?: string;
+        /**
+         * filter on created after (exclusive) timestamp
+         */
+        after?: string;
+        /**
+         * filter on exact username of user
+         */
+        username?: string;
+        /**
+         * filter on exact or prefix name of operation
+         */
+        operation?: string;
+        /**
+         * filter on exact or prefix name of resource
+         */
+        resource?: string;
+        /**
+         * filter on type of operation
+         */
+        actionKind?: 'Create' | 'Update' | 'Delete' | 'Execute';
+    }): CancelablePromise<Array<AuditLog>>;
+}

package/dist/src/services/AuditService.js

@@ -0,0 +1,43 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class AuditService {
+    /**
+     * get audit log (requires admin privilege)
+     * @returns AuditLog an audit log
+     * @throws ApiError
+     */
+    static getAuditLog({ workspace, id, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/audit/get/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * list audit logs (requires admin privilege)
+     * @returns AuditLog a list of audit logs
+     * @throws ApiError
+     */
+    static listAuditLogs({ workspace, page, perPage, before, after, username, operation, resource, actionKind, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/audit/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+                'before': before,
+                'after': after,
+                'username': username,
+                'operation': operation,
+                'resource': resource,
+                'action_kind': actionKind,
+            },
+        });
+    }
+}