windmill-client 0.3.11 → 0.3.13

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

@@ -0,0 +1,52 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class CaptureService {
+    /**
+     * update flow preview capture
+     * @returns void
+     * @throws ApiError
+     */
+    static updateCapture({ workspace, path, }) {
+        return __request(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 __request(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 __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/capture/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            errors: {
+                404: `capture does not exist for this flow`,
+            },
+        });
+    }
+}

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

@@ -0,0 +1,26 @@
+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>;
+    /**
+     * delete draft
+     * @returns string draft deleted
+     * @throws ApiError
+     */
+    static deleteDraft({ workspace, kind, path, }: {
+        workspace: string;
+        kind: 'script' | 'flow' | 'app';
+        path: string;
+    }): CancelablePromise<string>;
+}

package/dist/src/services/DraftService.js

@@ -0,0 +1,36 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class DraftService {
+    /**
+     * create draft
+     * @returns string draft created
+     * @throws ApiError
+     */
+    static createDraft({ workspace, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/drafts/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete draft
+     * @returns string draft deleted
+     * @throws ApiError
+     */
+    static deleteDraft({ workspace, kind, path, }) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/drafts/delete/{kind}/{path}',
+            path: {
+                'workspace': workspace,
+                'kind': kind,
+                'path': path,
+            },
+        });
+    }
+}

package/dist/src/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' | 'raw_app';
+        };
+    }): CancelablePromise<any>;
+    /**
+     * unstar item
+     * @returns any unstar item
+     * @throws ApiError
+     */
+    static unstar({ workspace, requestBody, }: {
+        workspace: string;
+        requestBody?: {
+            path?: string;
+            favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
+        };
+    }): CancelablePromise<any>;
+}

package/dist/src/services/FavoriteService.js

@@ -0,0 +1,36 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class FavoriteService {
+    /**
+     * star item
+     * @returns any star item
+     * @throws ApiError
+     */
+    static star({ workspace, requestBody, }) {
+        return __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/favorites/unstar',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}

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

@@ -0,0 +1,186 @@
+import type { Flow } from '../models/Flow';
+import type { Input } from '../models/Input';
+import type { OpenFlow } from '../models/OpenFlow';
+import type { OpenFlowWPath } from '../models/OpenFlowWPath';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class FlowService {
+    /**
+     * list all available hub flows
+     * @returns any hub flows list
+     * @throws ApiError
+     */
+    static listHubFlows(): CancelablePromise<{
+        flows?: Array<{
+            id: number;
+            flow_id: number;
+            summary: string;
+            apps: Array<string>;
+            approved: boolean;
+            votes: number;
+        }>;
+    }>;
+    /**
+     * get hub flow by id
+     * @returns any flow
+     * @throws ApiError
+     */
+    static getHubFlowById({ id, }: {
+        id: number;
+    }): CancelablePromise<{
+        flow?: OpenFlow;
+    }>;
+    /**
+     * list all available flow paths
+     * @returns string list of flow paths
+     * @throws ApiError
+     */
+    static listFlowPaths({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<string>>;
+    /**
+     * list all available flows
+     * @returns any All available flow
+     * @throws ApiError
+     */
+    static listFlows({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, showArchived, 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 also the archived files.
+         * when multiple archived hash share the same path, only the ones with the latest create_at
+         * are displayed.
+         *
+         */
+        showArchived?: boolean;
+        /**
+         * (default false)
+         * show only the starred items
+         *
+         */
+        starredOnly?: boolean;
+    }): CancelablePromise<Array<(Flow & {
+        has_draft?: boolean;
+        draft_only?: boolean;
+    })>>;
+    /**
+     * get flow by path
+     * @returns Flow flow details
+     * @throws ApiError
+     */
+    static getFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<Flow>;
+    /**
+     * get flow by path with draft
+     * @returns any flow details with draft
+     * @throws ApiError
+     */
+    static getFlowByPathWithDraft({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<(Flow & {
+        draft?: Flow;
+    })>;
+    /**
+     * exists flow by path
+     * @returns boolean flow details
+     * @throws ApiError
+     */
+    static existsFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * create flow
+     * @returns string flow created
+     * @throws ApiError
+     */
+    static createFlow({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * Partially filled flow
+         */
+        requestBody: (OpenFlowWPath & {
+            draft_only?: boolean;
+        });
+    }): CancelablePromise<string>;
+    /**
+     * update flow
+     * @returns string flow updated
+     * @throws ApiError
+     */
+    static updateFlow({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * Partially filled flow
+         */
+        requestBody: OpenFlowWPath;
+    }): CancelablePromise<string>;
+    /**
+     * archive flow by path
+     * @returns string flow archived
+     * @throws ApiError
+     */
+    static archiveFlowByPath({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * archiveFlow
+         */
+        requestBody: {
+            archived?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * delete flow by path
+     * @returns string flow delete
+     * @throws ApiError
+     */
+    static deleteFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * list inputs for previous completed flow jobs
+     * @returns Input input history for completed jobs with this flow path
+     * @throws ApiError
+     */
+    static getFlowInputHistoryByPath({ workspace, path, page, perPage, }: {
+        workspace: string;
+        path: 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;
+    }): CancelablePromise<Array<Input>>;
+}

package/dist/src/services/FlowService.js

@@ -0,0 +1,196 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class FlowService {
+    /**
+     * list all available hub flows
+     * @returns any hub flows list
+     * @throws ApiError
+     */
+    static listHubFlows() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/flows/hub/list',
+        });
+    }
+    /**
+     * get hub flow by id
+     * @returns any flow
+     * @throws ApiError
+     */
+    static getHubFlowById({ id, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/flows/hub/get/{id}',
+            path: {
+                'id': id,
+            },
+        });
+    }
+    /**
+     * list all available flow paths
+     * @returns string list of flow paths
+     * @throws ApiError
+     */
+    static listFlowPaths({ workspace, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/flows/list_paths',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * list all available flows
+     * @returns any All available flow
+     * @throws ApiError
+     */
+    static listFlows({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, showArchived, starredOnly, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/flows/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+                'order_desc': orderDesc,
+                'created_by': createdBy,
+                'path_start': pathStart,
+                'path_exact': pathExact,
+                'show_archived': showArchived,
+                'starred_only': starredOnly,
+            },
+        });
+    }
+    /**
+     * get flow by path
+     * @returns Flow flow details
+     * @throws ApiError
+     */
+    static getFlowByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/flows/get/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get flow by path with draft
+     * @returns any flow details with draft
+     * @throws ApiError
+     */
+    static getFlowByPathWithDraft({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/flows/get/draft/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * exists flow by path
+     * @returns boolean flow details
+     * @throws ApiError
+     */
+    static existsFlowByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/flows/exists/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * create flow
+     * @returns string flow created
+     * @throws ApiError
+     */
+    static createFlow({ workspace, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/flows/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * update flow
+     * @returns string flow updated
+     * @throws ApiError
+     */
+    static updateFlow({ workspace, path, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/flows/update/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * archive flow by path
+     * @returns string flow archived
+     * @throws ApiError
+     */
+    static archiveFlowByPath({ workspace, path, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/flows/archive/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete flow by path
+     * @returns string flow delete
+     * @throws ApiError
+     */
+    static deleteFlowByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/flows/delete/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * list inputs for previous completed flow jobs
+     * @returns Input input history for completed jobs with this flow path
+     * @throws ApiError
+     */
+    static getFlowInputHistoryByPath({ workspace, path, page, perPage, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/flows/input_history/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+}