windmill-client 0.2.0 → 0.2.1

package/dist/services/GranularAclService.d.ts

@@ -0,0 +1,46 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class GranularAclService {
+    /**
+     * get granular acls
+     * @returns boolean acls
+     * @throws ApiError
+     */
+    static getGranularAcls({ workspace, path, kind, }: {
+        workspace: string;
+        path: string;
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app';
+    }): CancelablePromise<Record<string, boolean>>;
+    /**
+     * add granular acls
+     * @returns string granular acl added
+     * @throws ApiError
+     */
+    static addGranularAcls({ workspace, path, kind, requestBody, }: {
+        workspace: string;
+        path: string;
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app';
+        /**
+         * acl to add
+         */
+        requestBody: {
+            owner: string;
+            write?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * remove granular acls
+     * @returns string granular acl removed
+     * @throws ApiError
+     */
+    static removeGranularAcls({ workspace, path, kind, requestBody, }: {
+        workspace: string;
+        path: string;
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app';
+        /**
+         * acl to add
+         */
+        requestBody: {
+            owner: string;
+        };
+    }): CancelablePromise<string>;
+}

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.d.ts

@@ -0,0 +1,110 @@
+import type { Group } from '../models/Group';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class GroupService {
+    /**
+     * list groups
+     * @returns Group group list
+     * @throws ApiError
+     */
+    static listGroups({ workspace, page, perPage, }: {
+        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;
+    }): CancelablePromise<Array<Group>>;
+    /**
+     * list group names
+     * @returns string group list
+     * @throws ApiError
+     */
+    static listGroupNames({ workspace, onlyMemberOf, }: {
+        workspace: string;
+        /**
+         * only list the groups the user is member of (default false)
+         */
+        onlyMemberOf?: boolean;
+    }): CancelablePromise<Array<string>>;
+    /**
+     * create group
+     * @returns string group created
+     * @throws ApiError
+     */
+    static createGroup({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * create group
+         */
+        requestBody: {
+            name: string;
+            summary?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * update group
+     * @returns string group updated
+     * @throws ApiError
+     */
+    static updateGroup({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /**
+         * updated group
+         */
+        requestBody: {
+            summary?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * delete group
+     * @returns string group deleted
+     * @throws ApiError
+     */
+    static deleteGroup({ workspace, name, }: {
+        workspace: string;
+        name: string;
+    }): CancelablePromise<string>;
+    /**
+     * get group
+     * @returns Group group
+     * @throws ApiError
+     */
+    static getGroup({ workspace, name, }: {
+        workspace: string;
+        name: string;
+    }): CancelablePromise<Group>;
+    /**
+     * add user to group
+     * @returns string user added to group
+     * @throws ApiError
+     */
+    static addUserToGroup({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /**
+         * added user to group
+         */
+        requestBody: {
+            username?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * remove user to group
+     * @returns string user removed from group
+     * @throws ApiError
+     */
+    static removeUserToGroup({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /**
+         * added user to group
+         */
+        requestBody: {
+            username?: string;
+        };
+    }): CancelablePromise<string>;
+}

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.d.ts

@@ -0,0 +1,78 @@
+import type { CreateInput } from '../models/CreateInput';
+import type { Input } from '../models/Input';
+import type { RunnableType } from '../models/RunnableType';
+import type { UpdateInput } from '../models/UpdateInput';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare 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, }: {
+        workspace: string;
+        runnableId?: string;
+        runnableType?: RunnableType;
+        /**
+         * 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>>;
+    /**
+     * List saved Inputs for a Runnable
+     * @returns Input Saved Inputs for a Runnable
+     * @throws ApiError
+     */
+    static listInputs({ workspace, runnableId, runnableType, page, perPage, }: {
+        workspace: string;
+        runnableId?: string;
+        runnableType?: RunnableType;
+        /**
+         * 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>>;
+    /**
+     * Create an Input for future use in a script or flow
+     * @returns string Input created
+     * @throws ApiError
+     */
+    static createInput({ workspace, requestBody, runnableId, runnableType, }: {
+        workspace: string;
+        /**
+         * Input
+         */
+        requestBody: CreateInput;
+        runnableId?: string;
+        runnableType?: RunnableType;
+    }): CancelablePromise<string>;
+    /**
+     * Update an Input
+     * @returns string Input updated
+     * @throws ApiError
+     */
+    static updateInput({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * UpdateInput
+         */
+        requestBody: UpdateInput;
+    }): CancelablePromise<string>;
+    /**
+     * Delete a Saved Input
+     * @returns string Input deleted
+     * @throws ApiError
+     */
+    static deleteInput({ workspace, input, }: {
+        workspace: string;
+        input: string;
+    }): CancelablePromise<string>;
+}

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;