windmill-client 1.145.2 → 1.146.0

package/dist/services/JobService.js

@@ -0,0 +1,650 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class JobService {
+    /**
+     * run script by path
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, invisibleToOwner, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/run/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'scheduled_for': scheduledFor,
+                'scheduled_in_secs': scheduledInSecs,
+                'parent_job': parentJob,
+                'job_id': jobId,
+                'invisible_to_owner': invisibleToOwner,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * run script by path in openai format
+     * @returns any job result
+     * @throws ApiError
+     */
+    static openaiSyncScriptByPath({ workspace, path, requestBody, parentJob, jobId, includeHeader, queueLimit, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/openai_sync/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'parent_job': parentJob,
+                'job_id': jobId,
+                'include_header': includeHeader,
+                'queue_limit': queueLimit,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * run script by path
+     * @returns any job result
+     * @throws ApiError
+     */
+    static runWaitResultScriptByPath({ workspace, path, requestBody, parentJob, jobId, includeHeader, queueLimit, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/run_wait_result/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'parent_job': parentJob,
+                'job_id': jobId,
+                'include_header': includeHeader,
+                'queue_limit': queueLimit,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * run script by path with get
+     * @returns any job result
+     * @throws ApiError
+     */
+    static runWaitResultScriptByPathGet({ workspace, path, parentJob, jobId, includeHeader, queueLimit, payload, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/run_wait_result/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'parent_job': parentJob,
+                'job_id': jobId,
+                'include_header': includeHeader,
+                'queue_limit': queueLimit,
+                'payload': payload,
+            },
+        });
+    }
+    /**
+     * 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, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/openai_sync/f/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'include_header': includeHeader,
+                'queue_limit': queueLimit,
+                'job_id': jobId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * run flow by path and wait until completion
+     * @returns any job result
+     * @throws ApiError
+     */
+    static runWaitResultFlowByPath({ workspace, path, requestBody, includeHeader, queueLimit, jobId, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/run_wait_result/f/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'include_header': includeHeader,
+                'queue_limit': queueLimit,
+                'job_id': jobId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * get job result by id
+     * @returns any job result
+     * @throws ApiError
+     */
+    static resultById({ workspace, flowJobId, nodeId, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/result_by_id/{flow_job_id}/{node_id}',
+            path: {
+                'workspace': workspace,
+                'flow_job_id': flowJobId,
+                'node_id': nodeId,
+            },
+        });
+    }
+    /**
+     * run flow by path
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, includeHeader, invisibleToOwner, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/run/f/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            query: {
+                'scheduled_for': scheduledFor,
+                'scheduled_in_secs': scheduledInSecs,
+                'parent_job': parentJob,
+                'job_id': jobId,
+                'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * run script by hash
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, includeHeader, invisibleToOwner, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/run/h/{hash}',
+            path: {
+                'workspace': workspace,
+                'hash': hash,
+            },
+            query: {
+                'scheduled_for': scheduledFor,
+                'scheduled_in_secs': scheduledInSecs,
+                'parent_job': parentJob,
+                'job_id': jobId,
+                'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * run script preview
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runScriptPreview({ workspace, requestBody, includeHeader, invisibleToOwner, jobId, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/run/preview',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
+                'job_id': jobId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * run flow preview
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runFlowPreview({ workspace, requestBody, includeHeader, invisibleToOwner, jobId, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/run/preview_flow',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'include_header': includeHeader,
+                'invisible_to_owner': invisibleToOwner,
+                'job_id': jobId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * list all available queued jobs
+     * @returns QueuedJob All available queued jobs
+     * @throws ApiError
+     */
+    static listQueue({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, success, jobKinds, suspended, running, args, result, tag, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/queue/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'order_desc': orderDesc,
+                'created_by': createdBy,
+                'parent_job': parentJob,
+                'script_path_exact': scriptPathExact,
+                'script_path_start': scriptPathStart,
+                'schedule_path': schedulePath,
+                'script_hash': scriptHash,
+                'started_before': startedBefore,
+                'started_after': startedAfter,
+                'success': success,
+                'job_kinds': jobKinds,
+                'suspended': suspended,
+                'running': running,
+                'args': args,
+                'result': result,
+                'tag': tag,
+            },
+        });
+    }
+    /**
+     * list all available completed jobs
+     * @returns CompletedJob All available completed jobs
+     * @throws ApiError
+     */
+    static listCompletedJobs({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, success, jobKinds, args, result, tag, isSkipped, isFlowStep, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/completed/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'order_desc': orderDesc,
+                'created_by': createdBy,
+                'parent_job': parentJob,
+                'script_path_exact': scriptPathExact,
+                'script_path_start': scriptPathStart,
+                'schedule_path': schedulePath,
+                'script_hash': scriptHash,
+                'started_before': startedBefore,
+                'started_after': startedAfter,
+                'success': success,
+                'job_kinds': jobKinds,
+                'args': args,
+                'result': result,
+                'tag': tag,
+                'is_skipped': isSkipped,
+                'is_flow_step': isFlowStep,
+            },
+        });
+    }
+    /**
+     * list all available jobs
+     * @returns Job All jobs
+     * @throws ApiError
+     */
+    static listJobs({ workspace, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, jobKinds, args, tag, result, isSkipped, isFlowStep, success, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'created_by': createdBy,
+                'parent_job': parentJob,
+                'script_path_exact': scriptPathExact,
+                'script_path_start': scriptPathStart,
+                'schedule_path': schedulePath,
+                'script_hash': scriptHash,
+                'started_before': startedBefore,
+                'started_after': startedAfter,
+                'job_kinds': jobKinds,
+                'args': args,
+                'tag': tag,
+                'result': result,
+                'is_skipped': isSkipped,
+                'is_flow_step': isFlowStep,
+                'success': success,
+            },
+        });
+    }
+    /**
+     * get job
+     * @returns Job job details
+     * @throws ApiError
+     */
+    static getJob({ workspace, id, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/get/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * get job logs
+     * @returns string job details
+     * @throws ApiError
+     */
+    static getJobLogs({ workspace, id, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/get_logs/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * get job updates
+     * @returns any job details
+     * @throws ApiError
+     */
+    static getJobUpdates({ workspace, id, running, logOffset, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/getupdate/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+            query: {
+                'running': running,
+                'log_offset': logOffset,
+            },
+        });
+    }
+    /**
+     * get completed job
+     * @returns CompletedJob job details
+     * @throws ApiError
+     */
+    static getCompletedJob({ workspace, id, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/completed/get/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * get completed job result
+     * @returns any result
+     * @throws ApiError
+     */
+    static getCompletedJobResult({ workspace, id, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/completed/get_result/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * get completed job result if job is completed
+     * @returns any result
+     * @throws ApiError
+     */
+    static getCompletedJobResultMaybe({ workspace, id, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/completed/get_result_maybe/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * delete completed job (erase content but keep run id)
+     * @returns CompletedJob job details
+     * @throws ApiError
+     */
+    static deleteCompletedJob({ workspace, id, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/completed/delete/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * cancel queued job
+     * @returns string job canceled
+     * @throws ApiError
+     */
+    static cancelQueuedJob({ workspace, id, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs_u/queue/cancel/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * force cancel queued job
+     * @returns string job canceled
+     * @throws ApiError
+     */
+    static forceCancelQueuedJob({ workspace, id, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs_u/queue/force_cancel/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * create an HMac signature given a job id and a resume id
+     * @returns string job signature
+     * @throws ApiError
+     */
+    static createJobSignature({ workspace, id, resumeId, approver, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/job_signature/{id}/{resume_id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'resume_id': resumeId,
+            },
+            query: {
+                'approver': approver,
+            },
+        });
+    }
+    /**
+     * get resume urls given a job_id, resume_id and a nonce to resume a flow
+     * @returns any url endpoints
+     * @throws ApiError
+     */
+    static getResumeUrls({ workspace, id, resumeId, approver, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/resume_urls/{id}/{resume_id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'resume_id': resumeId,
+            },
+            query: {
+                'approver': approver,
+            },
+        });
+    }
+    /**
+     * resume a job for a suspended flow
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static resumeSuspendedJobGet({ workspace, id, resumeId, signature, payload, approver, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'resume_id': resumeId,
+                'signature': signature,
+            },
+            query: {
+                'payload': payload,
+                'approver': approver,
+            },
+        });
+    }
+    /**
+     * resume a job for a suspended flow
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static resumeSuspendedJobPost({ workspace, id, resumeId, signature, requestBody, approver, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'resume_id': resumeId,
+                'signature': signature,
+            },
+            query: {
+                'approver': approver,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * resume a job for a suspended flow as an owner
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static resumeSuspendedFlowAsOwner({ workspace, id, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/flow/resume/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * cancel a job for a suspended flow
+     * @returns string job canceled
+     * @throws ApiError
+     */
+    static cancelSuspendedJobGet({ workspace, id, resumeId, signature, approver, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'resume_id': resumeId,
+                'signature': signature,
+            },
+            query: {
+                'approver': approver,
+            },
+        });
+    }
+    /**
+     * cancel a job for a suspended flow
+     * @returns string job canceled
+     * @throws ApiError
+     */
+    static cancelSuspendedJobPost({ workspace, id, resumeId, signature, requestBody, approver, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'resume_id': resumeId,
+                'signature': signature,
+            },
+            query: {
+                'approver': approver,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * get parent flow job of suspended job
+     * @returns any parent flow details
+     * @throws ApiError
+     */
+    static getSuspendedJobFlow({ workspace, id, resumeId, signature, approver, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'resume_id': resumeId,
+                'signature': signature,
+            },
+            query: {
+                'approver': approver,
+            },
+        });
+    }
+}
+exports.JobService = JobService;