windmill-components 1.55.0 → 1.55.2

package/gen/index.d.ts

@@ -24,6 +24,7 @@ export type { FlowPreview } from './models/FlowPreview';
 export type { FlowStatus } from './models/FlowStatus';
 export { FlowStatusModule } from './models/FlowStatusModule';
 export type { FlowValue } from './models/FlowValue';
+export type { Folder } from './models/Folder';
 export type { ForloopFlow } from './models/ForloopFlow';
 export { GlobalUserInfo } from './models/GlobalUserInfo';
 export type { Group } from './models/Group';
@@ -69,6 +70,7 @@ export { AuditService } from './services/AuditService';
 export { CaptureService } from './services/CaptureService';
 export { FavoriteService } from './services/FavoriteService';
 export { FlowService } from './services/FlowService';
+export { FolderService } from './services/FolderService';
 export { GranularAclService } from './services/GranularAclService';
 export { GroupService } from './services/GroupService';
 export { JobService } from './services/JobService';

package/gen/index.js

@@ -22,6 +22,7 @@ export { AuditService } from './services/AuditService';
 export { CaptureService } from './services/CaptureService';
 export { FavoriteService } from './services/FavoriteService';
 export { FlowService } from './services/FlowService';
+export { FolderService } from './services/FolderService';
 export { GranularAclService } from './services/GranularAclService';
 export { GroupService } from './services/GroupService';
 export { JobService } from './services/JobService';

package/gen/models/CompletedJob.d.ts

@@ -34,6 +34,7 @@ export type CompletedJob = {
     language?: CompletedJob.language;
     is_skipped: boolean;
     email: string;
+    visible_to_owner: boolean;
 };
 export declare namespace CompletedJob {
     enum job_kind {

package/gen/models/EditSchedule.d.ts

@@ -1,7 +1,5 @@
 import type { ScriptArgs } from './ScriptArgs';
 export type EditSchedule = {
     schedule: string;
-    script_path: string;
-    is_flow: boolean;
     args: ScriptArgs;
 };

package/gen/models/Folder.d.ts

@@ -0,0 +1,5 @@
+export type Folder = {
+    name: string;
+    owners: Array<string>;
+    extra_perms: Record<string, boolean>;
+};

package/gen/models/Folder.js

@@ -0,0 +1,4 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/gen/models/QueuedJob.d.ts

@@ -32,6 +32,7 @@ export type QueuedJob = {
     is_flow_step: boolean;
     language?: QueuedJob.language;
     email: string;
+    visible_to_owner: boolean;
 };
 export declare namespace QueuedJob {
     enum job_kind {

package/gen/models/Script.d.ts

@@ -8,7 +8,7 @@ export type Script = {
      */
     parent_hashes?: Array<string>;
     summary: string;
-    description?: string;
+    description: string;
     content: string;
     created_by: string;
     created_at: string;

package/gen/models/User.d.ts

@@ -8,5 +8,6 @@ export type User = {
     operator: boolean;
     disabled: boolean;
     groups?: Array<string>;
+    folders: Array<string>;
     usage?: Usage;
 };

package/gen/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/gen/services/FolderService.js

@@ -0,0 +1,151 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+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/gen/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';
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder';
     }): 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';
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder';
         /**
          * 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';
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder';
         /**
          * acl to add
          */

package/gen/services/GroupService.d.ts

@@ -22,8 +22,12 @@ export declare class GroupService {
      * @returns string group list
      * @throws ApiError
      */
-    static listGroupNames({ workspace, }: {
+    static listGroupNames({ workspace, onlyMemberOf, }: {
         workspace: string;
+        /**
+         * only list the groups the user is member of (default false)
+         */
+        onlyMemberOf?: boolean;
     }): CancelablePromise<Array<string>>;
     /**
      * create group

package/gen/services/GroupService.js

@@ -24,13 +24,16 @@ export class GroupService {
      * @returns string group list
      * @throws ApiError
      */
-    static listGroupNames({ workspace, }) {
+    static listGroupNames({ workspace, onlyMemberOf, }) {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/w/{workspace}/groups/listnames',
             path: {
                 'workspace': workspace,
             },
+            query: {
+                'only_member_of': onlyMemberOf,
+            },
         });
     }
     /**

package/gen/services/JobService.d.ts

@@ -11,7 +11,7 @@ export declare class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, }: {
+    static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, invisibleToOwner, }: {
         workspace: string;
         path: string;
         /**
@@ -30,6 +30,10 @@ export declare class JobService {
          * The parent job that is at the origin and responsible for the execution of this script if any
          */
         parentJob?: string;
+        /**
+         * make the run invisible to the the script owner (default false)
+         */
+        invisibleToOwner?: boolean;
     }): CancelablePromise<string>;
     /**
      * run script by path
@@ -81,7 +85,7 @@ export declare class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, }: {
+    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, invisibleToOwner, }: {
         workspace: string;
         path: string;
         /**
@@ -106,13 +110,17 @@ export declare class JobService {
          *
          */
         includeHeader?: string;
+        /**
+         * make the run invisible to the the flow owner (default false)
+         */
+        invisibleToOwner?: boolean;
     }): CancelablePromise<string>;
     /**
      * run script by hash
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, }: {
+    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, invisibleToOwner, }: {
         workspace: string;
         hash: string;
         /**
@@ -137,13 +145,17 @@ export declare class JobService {
          *
          */
         includeHeader?: string;
+        /**
+         * make the run invisible to the the script owner (default false)
+         */
+        invisibleToOwner?: boolean;
     }): CancelablePromise<string>;
     /**
      * run script preview
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptPreview({ workspace, requestBody, includeHeader, }: {
+    static runScriptPreview({ workspace, requestBody, includeHeader, invisibleToOwner, }: {
         workspace: string;
         /**
          * preview
@@ -155,13 +167,17 @@ export declare class JobService {
          *
          */
         includeHeader?: string;
+        /**
+         * make the run invisible to the the script owner (default false)
+         */
+        invisibleToOwner?: boolean;
     }): CancelablePromise<string>;
     /**
      * run flow preview
      * @returns string job created
      * @throws ApiError
      */
-    static runFlowPreview({ workspace, requestBody, includeHeader, }: {
+    static runFlowPreview({ workspace, requestBody, includeHeader, invisibleToOwner, }: {
         workspace: string;
         /**
          * preview
@@ -173,6 +189,10 @@ export declare class JobService {
          *
          */
         includeHeader?: string;
+        /**
+         * make the run invisible to the the script owner (default false)
+         */
+        invisibleToOwner?: boolean;
     }): CancelablePromise<string>;
     /**
      * list all available queued jobs

package/gen/services/JobService.js

@@ -6,7 +6,7 @@ export class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, }) {
+    static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, invisibleToOwner, }) {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/w/{workspace}/jobs/run/p/{path}',
@@ -18,6 +18,7 @@ export class JobService {
                 'scheduled_for': scheduledFor,
                 'scheduled_in_secs': scheduledInSecs,
                 'parent_job': parentJob,
+                'invisible_to_owner': invisibleToOwner,
             },
             body: requestBody,
             mediaType: 'application/json',
@@ -70,7 +71,7 @@ export class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, }) {
+    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, invisibleToOwner, }) {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/w/{workspace}/jobs/run/f/{path}',
@@ -83,6 +84,7 @@ export class JobService {
                 'scheduled_in_secs': scheduledInSecs,
                 'parent_job': parentJob,
                 'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
             },
             body: requestBody,
             mediaType: 'application/json',
@@ -93,7 +95,7 @@ export class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, }) {
+    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, invisibleToOwner, }) {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/w/{workspace}/jobs/run/h/{hash}',
@@ -106,6 +108,7 @@ export class JobService {
                 'scheduled_in_secs': scheduledInSecs,
                 'parent_job': parentJob,
                 'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
             },
             body: requestBody,
             mediaType: 'application/json',
@@ -116,7 +119,7 @@ export class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptPreview({ workspace, requestBody, includeHeader, }) {
+    static runScriptPreview({ workspace, requestBody, includeHeader, invisibleToOwner, }) {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/w/{workspace}/jobs/run/preview',
@@ -125,6 +128,7 @@ export class JobService {
             },
             query: {
                 'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
             },
             body: requestBody,
             mediaType: 'application/json',
@@ -135,7 +139,7 @@ export class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runFlowPreview({ workspace, requestBody, includeHeader, }) {
+    static runFlowPreview({ workspace, requestBody, includeHeader, invisibleToOwner, }) {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/w/{workspace}/jobs/run/preview_flow',
@@ -144,6 +148,7 @@ export class JobService {
             },
             query: {
                 'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
             },
             body: requestBody,
             mediaType: 'application/json',

package/gen/services/ScriptService.d.ts

@@ -96,7 +96,8 @@ export declare class ScriptService {
          * (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.
+         * are
+         * ed.
          *
          */
         showArchived?: boolean;

package/gen/services/UserService.d.ts

@@ -51,6 +51,15 @@ export declare class UserService {
          */
         requestBody: EditWorkspaceUser;
     }): CancelablePromise<string>;
+    /**
+     * is owner of path
+     * @returns boolean is owner
+     * @throws ApiError
+     */
+    static isOwnerOfPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
     /**
      * set password
      * @returns string password set

package/gen/services/UserService.js

@@ -59,6 +59,21 @@ export class UserService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * is owner of path
+     * @returns boolean is owner
+     * @throws ApiError
+     */
+    static isOwnerOfPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/users/is_owner/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
     /**
      * set password
      * @returns string password set