windmill-client 0.3.11 → 0.3.13

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

@@ -0,0 +1,128 @@
+import type { Folder } from '../models/Folder';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class FolderService {
+    /**
+     * list folders
+     * @returns Folder folder list
+     * @throws ApiError
+     */
+    static listFolders({ 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<Folder>>;
+    /**
+     * list folder names
+     * @returns string folder list
+     * @throws ApiError
+     */
+    static listFolderNames({ workspace, onlyMemberOf, }: {
+        workspace: string;
+        /**
+         * only list the folders the user is member of (default false)
+         */
+        onlyMemberOf?: boolean;
+    }): CancelablePromise<Array<string>>;
+    /**
+     * create folder
+     * @returns string folder created
+     * @throws ApiError
+     */
+    static createFolder({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * create folder
+         */
+        requestBody: {
+            name: string;
+            owners?: Array<string>;
+            extra_perms?: any;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * update folder
+     * @returns string folder updated
+     * @throws ApiError
+     */
+    static updateFolder({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /**
+         * update folder
+         */
+        requestBody: {
+            owners?: Array<string>;
+            extra_perms?: any;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * delete folder
+     * @returns string folder deleted
+     * @throws ApiError
+     */
+    static deleteFolder({ workspace, name, }: {
+        workspace: string;
+        name: string;
+    }): CancelablePromise<string>;
+    /**
+     * get folder
+     * @returns Folder folder
+     * @throws ApiError
+     */
+    static getFolder({ workspace, name, }: {
+        workspace: string;
+        name: string;
+    }): CancelablePromise<Folder>;
+    /**
+     * get folder usage
+     * @returns any folder
+     * @throws ApiError
+     */
+    static getFolderUsage({ workspace, name, }: {
+        workspace: string;
+        name: string;
+    }): CancelablePromise<{
+        scripts: number;
+        flows: number;
+        apps: number;
+        resources: number;
+        variables: number;
+        schedules: number;
+    }>;
+    /**
+     * add owner to folder
+     * @returns string owner added to folder
+     * @throws ApiError
+     */
+    static addOwnerToFolder({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /**
+         * owner user to folder
+         */
+        requestBody: {
+            owner?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * remove owner to folder
+     * @returns string owner removed from folder
+     * @throws ApiError
+     */
+    static removeOwnerToFolder({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /**
+         * added owner to folder
+         */
+        requestBody: {
+            owner?: string;
+        };
+    }): CancelablePromise<string>;
+}

package/dist/src/services/FolderService.js

@@ -0,0 +1,151 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class FolderService {
+    /**
+     * list folders
+     * @returns Folder folder list
+     * @throws ApiError
+     */
+    static listFolders({ workspace, page, perPage, }) {
+        return __request(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 __request(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 __request(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 __request(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 __request(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 __request(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 __request(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 __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/folders/removeowner/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}

package/dist/src/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' | 'raw_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' | 'raw_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' | 'raw_app';
+        /**
+         * acl to add
+         */
+        requestBody: {
+            owner: string;
+        };
+    }): CancelablePromise<string>;
+}

package/dist/src/services/GranularAclService.js

@@ -0,0 +1,56 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class GranularAclService {
+    /**
+     * get granular acls
+     * @returns boolean acls
+     * @throws ApiError
+     */
+    static getGranularAcls({ workspace, path, kind, }) {
+        return __request(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 __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/acls/remove/{kind}/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+                'kind': kind,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}

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

@@ -0,0 +1,136 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class GroupService {
+    /**
+     * list groups
+     * @returns Group group list
+     * @throws ApiError
+     */
+    static listGroups({ workspace, page, perPage, }) {
+        return __request(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 __request(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 __request(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 __request(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 __request(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 __request(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 __request(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 __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/groups/removeuser/{name}',
+            path: {
+                'workspace': workspace,
+                'name': name,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}

package/dist/src/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>;
+}