windmill-client 0.2.1 → 0.3.2

package/dist/src/models/VersionId.js

@@ -0,0 +1,6 @@
+"use strict";
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{models → src/models}/WorkerPing.js

@@ -1,4 +1,5 @@
 "use strict";
+/* generated using openapi-typescript-codegen -- do no edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

package/dist/{models → src/models}/Workspace.js

@@ -1,4 +1,5 @@
 "use strict";
+/* generated using openapi-typescript-codegen -- do no edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

package/dist/src/models/WorkspaceId.d.ts

@@ -0,0 +1 @@
+export type WorkspaceId = string;

package/dist/src/models/WorkspaceId.js

@@ -0,0 +1,6 @@
+"use strict";
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{models → src/models}/WorkspaceInvite.js

@@ -1,4 +1,5 @@
 "use strict";
+/* generated using openapi-typescript-codegen -- do no edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */

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

@@ -70,6 +70,24 @@ export declare class AppService {
          */
         starredOnly?: boolean;
     }): CancelablePromise<Array<ListableApp>>;
+    /**
+     * create app
+     * @returns string app created
+     * @throws ApiError
+     */
+    static createApp({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * new app
+         */
+        requestBody: {
+            path: string;
+            value: any;
+            summary: string;
+            policy: Policy;
+            draft_only?: boolean;
+        };
+    }): CancelablePromise<string>;
     /**
      * does an app exisst at path
      * @returns boolean app exists
@@ -124,24 +142,6 @@ export declare class AppService {
         workspace: string;
         id: number;
     }): CancelablePromise<AppWithLastVersion>;
-    /**
-     * create app
-     * @returns string app created
-     * @throws ApiError
-     */
-    static createApp({ workspace, requestBody, }: {
-        workspace: string;
-        /**
-         * new app
-         */
-        requestBody: {
-            path: string;
-            value: any;
-            summary: string;
-            policy: Policy;
-            draft_only?: boolean;
-        };
-    }): CancelablePromise<string>;
     /**
      * delete app
      * @returns string app deleted
@@ -181,6 +181,7 @@ export declare class AppService {
          * update app
          */
         requestBody: {
+            component: string;
             path?: string;
             args: any;
             raw_code?: {
@@ -188,7 +189,7 @@ export declare class AppService {
                 language: string;
                 path?: string;
             };
-            force_viewer_static_fields?: any;
+            force_viewer_static_fields?: Record<string, any>;
         };
     }): CancelablePromise<string>;
 }

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

@@ -13,4 +13,14 @@ export declare class DraftService {
             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/{services → src/services}/DraftService.js

@@ -20,5 +20,21 @@ class DraftService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * delete draft
+     * @returns string draft deleted
+     * @throws ApiError
+     */
+    static deleteDraft({ workspace, kind, path, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/drafts/delete/{kind}/{path}',
+            path: {
+                'workspace': workspace,
+                'kind': kind,
+                'path': path,
+            },
+        });
+    }
 }
 exports.DraftService = DraftService;

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

@@ -9,7 +9,7 @@ export declare class FavoriteService {
         workspace: string;
         requestBody?: {
             path?: string;
-            favorite_kind?: 'flow' | 'app' | 'script';
+            favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
         };
     }): CancelablePromise<any>;
     /**
@@ -21,7 +21,7 @@ export declare class FavoriteService {
         workspace: string;
         requestBody?: {
             path?: string;
-            favorite_kind?: 'flow' | 'app' | 'script';
+            favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
         };
     }): CancelablePromise<any>;
 }

package/{src → dist/src}/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 → src/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, invisibleToOwner, }: {
+    static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, invisibleToOwner, }: {
         workspace: string;
         path: string;
         /**
@@ -30,17 +30,53 @@ export declare class JobService {
          * The parent job that is at the origin and responsible for the execution of this script if any
          */
         parentJob?: string;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
         /**
          * make the run invisible to the the script owner (default false)
          */
         invisibleToOwner?: boolean;
     }): CancelablePromise<string>;
+    /**
+     * run script by path in openai format
+     * @returns any job result
+     * @throws ApiError
+     */
+    static openaiSyncScriptByPath({ workspace, path, requestBody, parentJob, jobId, includeHeader, queueLimit, }: {
+        workspace: string;
+        path: string;
+        /**
+         * script args
+         */
+        requestBody: ScriptArgs;
+        /**
+         * The parent job that is at the origin and responsible for the execution of this script if any
+         */
+        parentJob?: string;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
+        /**
+         * List of headers's keys (separated with ',') whove value are added to the args
+         * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
+         *
+         */
+        includeHeader?: string;
+        /**
+         * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
+         *
+         */
+        queueLimit?: string;
+    }): CancelablePromise<any>;
     /**
      * run script by path
      * @returns any job result
      * @throws ApiError
      */
-    static runWaitResultScriptByPath({ workspace, path, requestBody, parentJob, includeHeader, queueLimit, }: {
+    static runWaitResultScriptByPath({ workspace, path, requestBody, parentJob, jobId, includeHeader, queueLimit, }: {
         workspace: string;
         path: string;
         /**
@@ -51,6 +87,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;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
         /**
          * List of headers's keys (separated with ',') whove value are added to the args
          * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
@@ -68,13 +108,17 @@ export declare class JobService {
      * @returns any job result
      * @throws ApiError
      */
-    static runWaitResultScriptByPathGet({ workspace, path, parentJob, includeHeader, queueLimit, payload, }: {
+    static runWaitResultScriptByPathGet({ workspace, path, parentJob, jobId, includeHeader, queueLimit, payload, }: {
         workspace: string;
         path: string;
         /**
          * The parent job that is at the origin and responsible for the execution of this script if any
          */
         parentJob?: string;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
         /**
          * List of headers's keys (separated with ',') whove value are added to the args
          * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
@@ -93,12 +137,40 @@ export declare class JobService {
          */
         payload?: string;
     }): CancelablePromise<any>;
+    /**
+     * run flow by path and wait until completion in openai format
+     * @returns any job result
+     * @throws ApiError
+     */
+    static openaiSyncFlowByPath({ workspace, path, requestBody, includeHeader, queueLimit, jobId, }: {
+        workspace: string;
+        path: string;
+        /**
+         * script args
+         */
+        requestBody: ScriptArgs;
+        /**
+         * List of headers's keys (separated with ',') whove value are added to the args
+         * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
+         *
+         */
+        includeHeader?: string;
+        /**
+         * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
+         *
+         */
+        queueLimit?: string;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
+    }): CancelablePromise<any>;
     /**
      * run flow by path and wait until completion
      * @returns any job result
      * @throws ApiError
      */
-    static runWaitResultFlowByPath({ workspace, path, requestBody, includeHeader, queueLimit, }: {
+    static runWaitResultFlowByPath({ workspace, path, requestBody, includeHeader, queueLimit, jobId, }: {
         workspace: string;
         path: string;
         /**
@@ -116,6 +188,10 @@ export declare class JobService {
          *
          */
         queueLimit?: string;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
     }): CancelablePromise<any>;
     /**
      * get job result by id
@@ -132,7 +208,7 @@ export declare class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, invisibleToOwner, }: {
+    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, includeHeader, invisibleToOwner, }: {
         workspace: string;
         path: string;
         /**
@@ -151,6 +227,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;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
         /**
          * List of headers's keys (separated with ',') whove value are added to the args
          * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
@@ -167,13 +247,13 @@ export declare class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, includeHeader, invisibleToOwner, }: {
+    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, includeHeader, invisibleToOwner, }: {
         workspace: string;
         hash: string;
         /**
          * Partially filled args
          */
-        requestBody: any;
+        requestBody: Record<string, any>;
         /**
          * when to schedule this job (leave empty for immediate run)
          */
@@ -186,6 +266,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;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
         /**
          * List of headers's keys (separated with ',') whove value are added to the args
          * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
@@ -202,7 +286,7 @@ export declare class JobService {
      * @returns string job created
      * @throws ApiError
      */
-    static runScriptPreview({ workspace, requestBody, includeHeader, invisibleToOwner, }: {
+    static runScriptPreview({ workspace, requestBody, includeHeader, invisibleToOwner, jobId, }: {
         workspace: string;
         /**
          * preview
@@ -218,13 +302,17 @@ export declare class JobService {
          * make the run invisible to the the script owner (default false)
          */
         invisibleToOwner?: boolean;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
     }): CancelablePromise<string>;
     /**
      * run flow preview
      * @returns string job created
      * @throws ApiError
      */
-    static runFlowPreview({ workspace, requestBody, includeHeader, invisibleToOwner, }: {
+    static runFlowPreview({ workspace, requestBody, includeHeader, invisibleToOwner, jobId, }: {
         workspace: string;
         /**
          * preview
@@ -240,13 +328,17 @@ export declare class JobService {
          * make the run invisible to the the script owner (default false)
          */
         invisibleToOwner?: boolean;
+        /**
+         * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
+         */
+        jobId?: string;
     }): CancelablePromise<string>;
     /**
      * list all available queued jobs
      * @returns QueuedJob All available queued jobs
      * @throws ApiError
      */
-    static listQueue({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, scriptHash, startedBefore, startedAfter, success, jobKinds, suspended, running, args, result, tag, }: {
+    static listQueue({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, success, jobKinds, suspended, running, args, result, tag, }: {
         workspace: string;
         /**
          * order by desc order (default true)
@@ -268,6 +360,10 @@ export declare class JobService {
          * mask to filter matching starting path
          */
         scriptPathStart?: string;
+        /**
+         * mask to filter by schedule path
+         */
+        schedulePath?: string;
         /**
          * mask to filter exact matching path
          */
@@ -314,7 +410,7 @@ export declare class JobService {
      * @returns CompletedJob All available completed jobs
      * @throws ApiError
      */
-    static listCompletedJobs({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, scriptHash, startedBefore, startedAfter, success, jobKinds, args, result, tag, isSkipped, isFlowStep, }: {
+    static listCompletedJobs({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, success, jobKinds, args, result, tag, isSkipped, isFlowStep, }: {
         workspace: string;
         /**
          * order by desc order (default true)
@@ -336,6 +432,10 @@ export declare class JobService {
          * mask to filter matching starting path
          */
         scriptPathStart?: string;
+        /**
+         * mask to filter by schedule path
+         */
+        schedulePath?: string;
         /**
          * mask to filter exact matching path
          */
@@ -382,7 +482,7 @@ export declare class JobService {
      * @returns Job All jobs
      * @throws ApiError
      */
-    static listJobs({ workspace, createdBy, parentJob, scriptPathExact, scriptPathStart, scriptHash, startedBefore, startedAfter, jobKinds, args, tag, result, isSkipped, isFlowStep, success, }: {
+    static listJobs({ workspace, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, jobKinds, args, tag, result, isSkipped, isFlowStep, success, }: {
         workspace: string;
         /**
          * mask to filter exact matching user creator
@@ -400,6 +500,10 @@ export declare class JobService {
          * mask to filter matching starting path
          */
         scriptPathStart?: string;
+        /**
+         * mask to filter by schedule path
+         */
+        schedulePath?: string;
         /**
          * mask to filter exact matching path
          */
@@ -450,6 +554,15 @@ export declare class JobService {
         workspace: string;
         id: string;
     }): CancelablePromise<Job>;
+    /**
+     * get job logs
+     * @returns string job details
+     * @throws ApiError
+     */
+    static getJobLogs({ workspace, id, }: {
+        workspace: string;
+        id: string;
+    }): CancelablePromise<string>;
     /**
      * get job updates
      * @returns any job details
@@ -484,6 +597,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
@@ -577,7 +702,7 @@ export declare class JobService {
         id: string;
         resumeId: number;
         signature: string;
-        requestBody: any;
+        requestBody: Record<string, any>;
         approver?: string;
     }): CancelablePromise<string>;
     /**
@@ -588,7 +713,7 @@ export declare class JobService {
     static resumeSuspendedFlowAsOwner({ workspace, id, requestBody, }: {
         workspace: string;
         id: string;
-        requestBody: any;
+        requestBody: Record<string, any>;
     }): CancelablePromise<string>;
     /**
      * cancel a job for a suspended flow
@@ -612,7 +737,7 @@ export declare class JobService {
         id: string;
         resumeId: number;
         signature: string;
-        requestBody: any;
+        requestBody: Record<string, any>;
         approver?: string;
     }): CancelablePromise<string>;
     /**