windmill-client 0.2.0 → 0.3.1

package/dist/services/FlowService.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class FlowService {
+    /**
+     * list all available hub flows
+     * @returns any hub flows list
+     * @throws ApiError
+     */
+    static listHubFlows() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/flows/hub/list',
+        });
+    }
+    /**
+     * get hub flow by id
+     * @returns any flow
+     * @throws ApiError
+     */
+    static getHubFlowById({ id, }) {
+        return (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.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 (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/flows/input_history/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+}
+exports.FlowService = FlowService;

package/dist/services/FolderService.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FolderService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class FolderService {
+    /**
+     * list folders
+     * @returns Folder folder list
+     * @throws ApiError
+     */
+    static listFolders({ workspace, page, perPage, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/folders/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+    /**
+     * list folder names
+     * @returns string folder list
+     * @throws ApiError
+     */
+    static listFolderNames({ workspace, onlyMemberOf, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/folders/listnames',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'only_member_of': onlyMemberOf,
+            },
+        });
+    }
+    /**
+     * create folder
+     * @returns string folder created
+     * @throws ApiError
+     */
+    static createFolder({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/folders/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * update folder
+     * @returns string folder updated
+     * @throws ApiError
+     */
+    static updateFolder({ workspace, name, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/folders/update/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete folder
+     * @returns string folder deleted
+     * @throws ApiError
+     */
+    static deleteFolder({ workspace, name, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/folders/delete/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+        });
+    }
+    /**
+     * get folder
+     * @returns Folder folder
+     * @throws ApiError
+     */
+    static getFolder({ workspace, name, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/folders/get/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+        });
+    }
+    /**
+     * get folder usage
+     * @returns any folder
+     * @throws ApiError
+     */
+    static getFolderUsage({ workspace, name, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/folders/getusage/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+        });
+    }
+    /**
+     * add owner to folder
+     * @returns string owner added to folder
+     * @throws ApiError
+     */
+    static addOwnerToFolder({ workspace, name, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/folders/addowner/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * remove owner to folder
+     * @returns string owner removed from folder
+     * @throws ApiError
+     */
+    static removeOwnerToFolder({ workspace, name, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/folders/removeowner/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.FolderService = FolderService;

package/{src → dist}/services/GranularAclService.d.ts

@@ -8,7 +8,7 @@ export declare class GranularAclService {
     static getGranularAcls({ workspace, path, kind, }: {
         workspace: string;
         path: string;
-        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app';
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
     }): CancelablePromise<Record<string, boolean>>;
     /**
      * add granular acls
@@ -18,7 +18,7 @@ export declare class GranularAclService {
     static addGranularAcls({ workspace, path, kind, requestBody, }: {
         workspace: string;
         path: string;
-        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app';
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
         /**
          * acl to add
          */
@@ -35,7 +35,7 @@ export declare class GranularAclService {
     static removeGranularAcls({ workspace, path, kind, requestBody, }: {
         workspace: string;
         path: string;
-        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app';
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
         /**
          * acl to add
          */

package/dist/services/GranularAclService.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GranularAclService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class GranularAclService {
+    /**
+     * get granular acls
+     * @returns boolean acls
+     * @throws ApiError
+     */
+    static getGranularAcls({ workspace, path, kind, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/acls/get/{kind}/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+                'kind': kind,
+            },
+        });
+    }
+    /**
+     * add granular acls
+     * @returns string granular acl added
+     * @throws ApiError
+     */
+    static addGranularAcls({ workspace, path, kind, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/acls/add/{kind}/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+                'kind': kind,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * remove granular acls
+     * @returns string granular acl removed
+     * @throws ApiError
+     */
+    static removeGranularAcls({ workspace, path, kind, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/acls/remove/{kind}/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+                'kind': kind,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.GranularAclService = GranularAclService;

package/dist/services/GroupService.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class GroupService {
+    /**
+     * list groups
+     * @returns Group group list
+     * @throws ApiError
+     */
+    static listGroups({ workspace, page, perPage, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/groups/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+    /**
+     * list group names
+     * @returns string group list
+     * @throws ApiError
+     */
+    static listGroupNames({ workspace, onlyMemberOf, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/groups/listnames',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'only_member_of': onlyMemberOf,
+            },
+        });
+    }
+    /**
+     * create group
+     * @returns string group created
+     * @throws ApiError
+     */
+    static createGroup({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/groups/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * update group
+     * @returns string group updated
+     * @throws ApiError
+     */
+    static updateGroup({ workspace, name, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/groups/update/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete group
+     * @returns string group deleted
+     * @throws ApiError
+     */
+    static deleteGroup({ workspace, name, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/groups/delete/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+        });
+    }
+    /**
+     * get group
+     * @returns Group group
+     * @throws ApiError
+     */
+    static getGroup({ workspace, name, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/groups/get/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+        });
+    }
+    /**
+     * add user to group
+     * @returns string user added to group
+     * @throws ApiError
+     */
+    static addUserToGroup({ workspace, name, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/groups/adduser/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * remove user to group
+     * @returns string user removed from group
+     * @throws ApiError
+     */
+    static removeUserToGroup({ workspace, name, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/groups/removeuser/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.GroupService = GroupService;

package/dist/services/InputService.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class InputService {
+    /**
+     * List Inputs used in previously completed jobs
+     * @returns Input Input history for completed jobs
+     * @throws ApiError
+     */
+    static getInputHistory({ workspace, runnableId, runnableType, page, perPage, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/inputs/history',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'runnable_id': runnableId,
+                'runnable_type': runnableType,
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+    /**
+     * List saved Inputs for a Runnable
+     * @returns Input Saved Inputs for a Runnable
+     * @throws ApiError
+     */
+    static listInputs({ workspace, runnableId, runnableType, page, perPage, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/inputs/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'runnable_id': runnableId,
+                'runnable_type': runnableType,
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+    /**
+     * Create an Input for future use in a script or flow
+     * @returns string Input created
+     * @throws ApiError
+     */
+    static createInput({ workspace, requestBody, runnableId, runnableType, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/inputs/create',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'runnable_id': runnableId,
+                'runnable_type': runnableType,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update an Input
+     * @returns string Input updated
+     * @throws ApiError
+     */
+    static updateInput({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/inputs/update',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete a Saved Input
+     * @returns string Input deleted
+     * @throws ApiError
+     */
+    static deleteInput({ workspace, input, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/inputs/delete/{input}',
+            path: {
+                'workspace': workspace,
+                'input': input,
+            },
+        });
+    }
+}
+exports.InputService = InputService;

package/{src → dist}/services/JobService.d.ts

@@ -484,6 +484,18 @@ export declare class JobService {
         workspace: string;
         id: string;
     }): CancelablePromise<any>;
+    /**
+     * get completed job result if job is completed
+     * @returns any result
+     * @throws ApiError
+     */
+    static getCompletedJobResultMaybe({ workspace, id, }: {
+        workspace: string;
+        id: string;
+    }): CancelablePromise<{
+        completed: boolean;
+        result: any;
+    }>;
     /**
      * delete completed job (erase content but keep run id)
      * @returns CompletedJob job details