windmill-client 0.3.11 → 0.3.13

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

@@ -0,0 +1,761 @@
+import type { CompletedJob } from '../models/CompletedJob';
+import type { FlowPreview } from '../models/FlowPreview';
+import type { Job } from '../models/Job';
+import type { Preview } from '../models/Preview';
+import type { QueuedJob } from '../models/QueuedJob';
+import type { ScriptArgs } from '../models/ScriptArgs';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class JobService {
+    /**
+     * run script by path
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, invisibleToOwner, }: {
+        workspace: string;
+        path: string;
+        /**
+         * script args
+         */
+        requestBody: ScriptArgs;
+        /**
+         * when to schedule this job (leave empty for immediate run)
+         */
+        scheduledFor?: string;
+        /**
+         * schedule the script to execute in the number of seconds starting now
+         */
+        scheduledInSecs?: number;
+        /**
+         * 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, 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 with get
+     * @returns any job result
+     * @throws ApiError
+     */
+    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
+         *
+         */
+        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 base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
+         * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
+         *
+         */
+        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, 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>;
+    /**
+     * get job result by id
+     * @returns any job result
+     * @throws ApiError
+     */
+    static resultById({ workspace, flowJobId, nodeId, }: {
+        workspace: string;
+        flowJobId: string;
+        nodeId: string;
+    }): CancelablePromise<any>;
+    /**
+     * run flow by path
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, jobId, includeHeader, invisibleToOwner, }: {
+        workspace: string;
+        path: string;
+        /**
+         * flow args
+         */
+        requestBody: ScriptArgs;
+        /**
+         * when to schedule this job (leave empty for immediate run)
+         */
+        scheduledFor?: string;
+        /**
+         * schedule the script to execute in the number of seconds starting now
+         */
+        scheduledInSecs?: number;
+        /**
+         * 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;
+        /**
+         * 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, jobId, includeHeader, invisibleToOwner, }: {
+        workspace: string;
+        hash: string;
+        /**
+         * Partially filled args
+         */
+        requestBody: Record<string, any>;
+        /**
+         * when to schedule this job (leave empty for immediate run)
+         */
+        scheduledFor?: string;
+        /**
+         * schedule the script to execute in the number of seconds starting now
+         */
+        scheduledInSecs?: number;
+        /**
+         * 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;
+        /**
+         * 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, invisibleToOwner, jobId, }: {
+        workspace: string;
+        /**
+         * preview
+         */
+        requestBody: Preview;
+        /**
+         * 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;
+        /**
+         * 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, jobId, }: {
+        workspace: string;
+        /**
+         * preview
+         */
+        requestBody: FlowPreview;
+        /**
+         * 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;
+        /**
+         * 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, schedulePath, scriptHash, startedBefore, startedAfter, success, jobKinds, suspended, running, args, result, tag, }: {
+        workspace: string;
+        /**
+         * order by desc order (default true)
+         */
+        orderDesc?: boolean;
+        /**
+         * mask to filter exact matching user creator
+         */
+        createdBy?: string;
+        /**
+         * The parent job that is at the origin and responsible for the execution of this script if any
+         */
+        parentJob?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        scriptPathExact?: string;
+        /**
+         * mask to filter matching starting path
+         */
+        scriptPathStart?: string;
+        /**
+         * mask to filter by schedule path
+         */
+        schedulePath?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        scriptHash?: string;
+        /**
+         * filter on created before (inclusive) timestamp
+         */
+        startedBefore?: string;
+        /**
+         * filter on created after (exclusive) timestamp
+         */
+        startedAfter?: string;
+        /**
+         * filter on successful jobs
+         */
+        success?: boolean;
+        /**
+         * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
+         */
+        jobKinds?: string;
+        /**
+         * filter on suspended jobs
+         */
+        suspended?: boolean;
+        /**
+         * filter on running jobs
+         */
+        running?: boolean;
+        /**
+         * filter on jobs containing those args as a json subset (@> in postgres)
+         */
+        args?: string;
+        /**
+         * filter on jobs containing those result as a json subset (@> in postgres)
+         */
+        result?: string;
+        /**
+         * filter on jobs with a given tag/worker group
+         */
+        tag?: string;
+    }): CancelablePromise<Array<QueuedJob>>;
+    /**
+     * 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, }: {
+        workspace: string;
+        /**
+         * order by desc order (default true)
+         */
+        orderDesc?: boolean;
+        /**
+         * mask to filter exact matching user creator
+         */
+        createdBy?: string;
+        /**
+         * The parent job that is at the origin and responsible for the execution of this script if any
+         */
+        parentJob?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        scriptPathExact?: string;
+        /**
+         * mask to filter matching starting path
+         */
+        scriptPathStart?: string;
+        /**
+         * mask to filter by schedule path
+         */
+        schedulePath?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        scriptHash?: string;
+        /**
+         * filter on created before (inclusive) timestamp
+         */
+        startedBefore?: string;
+        /**
+         * filter on created after (exclusive) timestamp
+         */
+        startedAfter?: string;
+        /**
+         * filter on successful jobs
+         */
+        success?: boolean;
+        /**
+         * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
+         */
+        jobKinds?: string;
+        /**
+         * filter on jobs containing those args as a json subset (@> in postgres)
+         */
+        args?: string;
+        /**
+         * filter on jobs containing those result as a json subset (@> in postgres)
+         */
+        result?: string;
+        /**
+         * filter on jobs with a given tag/worker group
+         */
+        tag?: string;
+        /**
+         * is the job skipped
+         */
+        isSkipped?: boolean;
+        /**
+         * is the job a flow step
+         */
+        isFlowStep?: boolean;
+    }): CancelablePromise<Array<CompletedJob>>;
+    /**
+     * 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, }: {
+        workspace: string;
+        /**
+         * mask to filter exact matching user creator
+         */
+        createdBy?: string;
+        /**
+         * The parent job that is at the origin and responsible for the execution of this script if any
+         */
+        parentJob?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        scriptPathExact?: string;
+        /**
+         * mask to filter matching starting path
+         */
+        scriptPathStart?: string;
+        /**
+         * mask to filter by schedule path
+         */
+        schedulePath?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        scriptHash?: string;
+        /**
+         * filter on created before (inclusive) timestamp
+         */
+        startedBefore?: string;
+        /**
+         * filter on created after (exclusive) timestamp
+         */
+        startedAfter?: string;
+        /**
+         * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
+         */
+        jobKinds?: string;
+        /**
+         * filter on jobs containing those args as a json subset (@> in postgres)
+         */
+        args?: string;
+        /**
+         * filter on jobs with a given tag/worker group
+         */
+        tag?: string;
+        /**
+         * filter on jobs containing those result as a json subset (@> in postgres)
+         */
+        result?: string;
+        /**
+         * is the job skipped
+         */
+        isSkipped?: boolean;
+        /**
+         * is the job a flow step
+         */
+        isFlowStep?: boolean;
+        /**
+         * filter on successful jobs
+         */
+        success?: boolean;
+    }): CancelablePromise<Array<Job>>;
+    /**
+     * get job
+     * @returns Job job details
+     * @throws ApiError
+     */
+    static getJob({ workspace, id, }: {
+        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
+     * @throws ApiError
+     */
+    static getJobUpdates({ workspace, id, running, logOffset, }: {
+        workspace: string;
+        id: string;
+        running?: boolean;
+        logOffset?: number;
+    }): CancelablePromise<{
+        running?: boolean;
+        completed?: boolean;
+        new_logs?: string;
+        mem_peak?: number;
+    }>;
+    /**
+     * get completed job
+     * @returns CompletedJob job details
+     * @throws ApiError
+     */
+    static getCompletedJob({ workspace, id, }: {
+        workspace: string;
+        id: string;
+    }): CancelablePromise<CompletedJob>;
+    /**
+     * get completed job result
+     * @returns any result
+     * @throws ApiError
+     */
+    static getCompletedJobResult({ workspace, id, }: {
+        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
+     * @throws ApiError
+     */
+    static deleteCompletedJob({ workspace, id, }: {
+        workspace: string;
+        id: string;
+    }): CancelablePromise<CompletedJob>;
+    /**
+     * cancel queued job
+     * @returns string job canceled
+     * @throws ApiError
+     */
+    static cancelQueuedJob({ workspace, id, requestBody, }: {
+        workspace: string;
+        id: string;
+        /**
+         * reason
+         */
+        requestBody: {
+            reason?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * force cancel queued job
+     * @returns string job canceled
+     * @throws ApiError
+     */
+    static forceCancelQueuedJob({ workspace, id, requestBody, }: {
+        workspace: string;
+        id: string;
+        /**
+         * reason
+         */
+        requestBody: {
+            reason?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * create an HMac signature given a job id and a resume id
+     * @returns string job signature
+     * @throws ApiError
+     */
+    static createJobSignature({ workspace, id, resumeId, approver, }: {
+        workspace: string;
+        id: string;
+        resumeId: number;
+        approver?: string;
+    }): CancelablePromise<string>;
+    /**
+     * 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, }: {
+        workspace: string;
+        id: string;
+        resumeId: number;
+        approver?: string;
+    }): CancelablePromise<{
+        approvalPage: string;
+        resume: string;
+        cancel: string;
+    }>;
+    /**
+     * resume a job for a suspended flow
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static resumeSuspendedJobGet({ workspace, id, resumeId, signature, payload, approver, }: {
+        workspace: string;
+        id: string;
+        resumeId: number;
+        signature: string;
+        /**
+         * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
+         * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
+         *
+         */
+        payload?: string;
+        approver?: string;
+    }): CancelablePromise<string>;
+    /**
+     * resume a job for a suspended flow
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static resumeSuspendedJobPost({ workspace, id, resumeId, signature, requestBody, approver, }: {
+        workspace: string;
+        id: string;
+        resumeId: number;
+        signature: string;
+        requestBody: Record<string, any>;
+        approver?: string;
+    }): CancelablePromise<string>;
+    /**
+     * resume a job for a suspended flow as an owner
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static resumeSuspendedFlowAsOwner({ workspace, id, requestBody, }: {
+        workspace: string;
+        id: string;
+        requestBody: Record<string, any>;
+    }): CancelablePromise<string>;
+    /**
+     * cancel a job for a suspended flow
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static cancelSuspendedJobGet({ workspace, id, resumeId, signature, approver, }: {
+        workspace: string;
+        id: string;
+        resumeId: number;
+        signature: string;
+        approver?: string;
+    }): CancelablePromise<string>;
+    /**
+     * cancel a job for a suspended flow
+     * @returns string job resumed
+     * @throws ApiError
+     */
+    static cancelSuspendedJobPost({ workspace, id, resumeId, signature, requestBody, approver, }: {
+        workspace: string;
+        id: string;
+        resumeId: number;
+        signature: string;
+        requestBody: Record<string, any>;
+        approver?: string;
+    }): CancelablePromise<string>;
+    /**
+     * get parent flow job of suspended job
+     * @returns any parent flow details
+     * @throws ApiError
+     */
+    static getSuspendedJobFlow({ workspace, id, resumeId, signature, approver, }: {
+        workspace: string;
+        id: string;
+        resumeId: number;
+        signature: string;
+        approver?: string;
+    }): CancelablePromise<{
+        job: Job;
+        approvers: Array<{
+            resume_id: number;
+            approver: string;
+        }>;
+    }>;
+}