windmill-client 0.2.0 → 0.2.1

package/dist/services/AppService.d.ts

@@ -0,0 +1,194 @@
+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>>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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: {
+            path?: string;
+            args: any;
+            raw_code?: {
+                content: string;
+                language: string;
+                path?: string;
+            };
+            force_viewer_static_fields?: any;
+        };
+    }): CancelablePromise<string>;
+}

package/dist/services/AppService.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class AppService {
+    /**
+     * list all available hub apps
+     * @returns any hub apps list
+     * @throws ApiError
+     */
+    static listHubApps() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/apps/hub/list',
+        });
+    }
+    /**
+     * get hub app by id
+     * @returns any app
+     * @throws ApiError
+     */
+    static getHubAppById({ id, }) {
+        return (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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,
+            },
+        });
+    }
+    /**
+     * does an app exisst at path
+     * @returns boolean app exists
+     * @throws ApiError
+     */
+    static existsApp({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/get/v/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * create app
+     * @returns string app created
+     * @throws ApiError
+     */
+    static createApp({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/apps/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete app
+     * @returns string app deleted
+     * @throws ApiError
+     */
+    static deleteApp({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/apps_u/execute_component/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.AppService = AppService;

package/dist/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/services/AuditService.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class AuditService {
+    /**
+     * get audit log (requires admin privilege)
+     * @returns AuditLog an audit log
+     * @throws ApiError
+     */
+    static getAuditLog({ workspace, id, }) {
+        return (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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,
+            },
+        });
+    }
+}
+exports.AuditService = AuditService;

package/dist/services/CaptureService.d.ts

@@ -0,0 +1,30 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class CaptureService {
+    /**
+     * update flow preview capture
+     * @returns void
+     * @throws ApiError
+     */
+    static updateCapture({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<void>;
+    /**
+     * create flow preview capture
+     * @returns any flow preview capture created
+     * @throws ApiError
+     */
+    static createCapture({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<any>;
+    /**
+     * get flow preview capture
+     * @returns any captured flow preview
+     * @throws ApiError
+     */
+    static getCapture({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<any>;
+}

package/dist/services/CaptureService.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptureService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class CaptureService {
+    /**
+     * update flow preview capture
+     * @returns void
+     * @throws ApiError
+     */
+    static updateCapture({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/capture_u/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * create flow preview capture
+     * @returns any flow preview capture created
+     * @throws ApiError
+     */
+    static createCapture({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'PUT',
+            url: '/w/{workspace}/capture/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get flow preview capture
+     * @returns any captured flow preview
+     * @throws ApiError
+     */
+    static getCapture({ workspace, path, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/capture/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            errors: {
+                404: `capture does not exist for this flow`,
+            },
+        });
+    }
+}
+exports.CaptureService = CaptureService;

package/dist/services/DraftService.d.ts

@@ -0,0 +1,16 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class DraftService {
+    /**
+     * create draft
+     * @returns string draft created
+     * @throws ApiError
+     */
+    static createDraft({ workspace, requestBody, }: {
+        workspace: string;
+        requestBody: {
+            path: string;
+            typ: 'flow' | 'script' | 'app';
+            value?: any;
+        };
+    }): CancelablePromise<string>;
+}

package/dist/services/DraftService.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DraftService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class DraftService {
+    /**
+     * create draft
+     * @returns string draft created
+     * @throws ApiError
+     */
+    static createDraft({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/drafts/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.DraftService = DraftService;

package/dist/services/FavoriteService.d.ts

@@ -0,0 +1,27 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class FavoriteService {
+    /**
+     * star item
+     * @returns any star item
+     * @throws ApiError
+     */
+    static star({ workspace, requestBody, }: {
+        workspace: string;
+        requestBody?: {
+            path?: string;
+            favorite_kind?: 'flow' | 'app' | 'script';
+        };
+    }): CancelablePromise<any>;
+    /**
+     * unstar item
+     * @returns any unstar item
+     * @throws ApiError
+     */
+    static unstar({ workspace, requestBody, }: {
+        workspace: string;
+        requestBody?: {
+            path?: string;
+            favorite_kind?: 'flow' | 'app' | 'script';
+        };
+    }): CancelablePromise<any>;
+}

package/dist/services/FavoriteService.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FavoriteService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class FavoriteService {
+    /**
+     * star item
+     * @returns any star item
+     * @throws ApiError
+     */
+    static star({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/favorites/star',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * unstar item
+     * @returns any unstar item
+     * @throws ApiError
+     */
+    static unstar({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/favorites/unstar',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.FavoriteService = FavoriteService;