windmill-components 1.13.0

package/gen/services/GranularAclService.d.ts

@@ -0,0 +1,42 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class GranularAclService {
+    /**
+     * get granular acls
+     * @returns boolean acls
+     * @throws ApiError
+     */
+    static getGranularAcls({ workspace, path, kind, }: {
+        workspace: string;
+        path: string;
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow';
+    }): CancelablePromise<Record<string, boolean>>;
+    /**
+     * add granular acls
+     * @returns string granular acl added
+     * @throws ApiError
+     */
+    static addGranularAcls({ workspace, path, kind, requestBody, }: {
+        workspace: string;
+        path: string;
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow';
+        /** acl to add **/
+        requestBody: {
+            owner: string;
+            write?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * remove granular acls
+     * @returns string granular acl removed
+     * @throws ApiError
+     */
+    static removeGranularAcls({ workspace, path, kind, requestBody, }: {
+        workspace: string;
+        path: string;
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow';
+        /** acl to add **/
+        requestBody: {
+            owner: string;
+        };
+    }): CancelablePromise<string>;
+}

package/gen/services/GroupService.d.ts

@@ -0,0 +1,94 @@
+import type { Group } from '../models/Group';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class GroupService {
+    /**
+     * list groups
+     * @returns Group group list
+     * @throws ApiError
+     */
+    static listGroups({ workspace, page, perPage, }: {
+        workspace: string;
+        /** which page to return (start at 1, default 1) **/
+        page?: number;
+        /** number of items to return for a given page (default 30, max 100) **/
+        perPage?: number;
+    }): CancelablePromise<Array<Group>>;
+    /**
+     * list group names
+     * @returns string group list
+     * @throws ApiError
+     */
+    static listGroupNames({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<string>>;
+    /**
+     * create group
+     * @returns string group created
+     * @throws ApiError
+     */
+    static createGroup({ workspace, requestBody, }: {
+        workspace: string;
+        /** create group **/
+        requestBody: {
+            name: string;
+            summary?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * update group
+     * @returns string group updated
+     * @throws ApiError
+     */
+    static updateGroup({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /** updated group **/
+        requestBody: {
+            summary?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * delete group
+     * @returns string group deleted
+     * @throws ApiError
+     */
+    static deleteGroup({ workspace, name, }: {
+        workspace: string;
+        name: string;
+    }): CancelablePromise<string>;
+    /**
+     * get group
+     * @returns Group group
+     * @throws ApiError
+     */
+    static getGroup({ workspace, name, }: {
+        workspace: string;
+        name: string;
+    }): CancelablePromise<Group>;
+    /**
+     * add user to group
+     * @returns string user added to group
+     * @throws ApiError
+     */
+    static addUserToGroup({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /** added user to group **/
+        requestBody: {
+            username?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * remove user to group
+     * @returns string user removed from group
+     * @throws ApiError
+     */
+    static removeUserToGroup({ workspace, name, requestBody, }: {
+        workspace: string;
+        name: string;
+        /** added user to group **/
+        requestBody: {
+            username?: string;
+        };
+    }): CancelablePromise<string>;
+}

package/gen/services/JobService.d.ts

@@ -0,0 +1,217 @@
+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, }: {
+        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;
+    }): CancelablePromise<string>;
+    /**
+     * run flow by path
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, }: {
+        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;
+    }): CancelablePromise<string>;
+    /**
+     * run script by hash
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, }: {
+        workspace: string;
+        hash: string;
+        /** Partially filled args **/
+        requestBody: 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;
+    }): CancelablePromise<string>;
+    /**
+     * run script preview
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runScriptPreview({ workspace, requestBody, }: {
+        workspace: string;
+        /** previw **/
+        requestBody: Preview;
+    }): CancelablePromise<string>;
+    /**
+     * run flow preview
+     * @returns string job created
+     * @throws ApiError
+     */
+    static runFlowPreview({ workspace, requestBody, }: {
+        workspace: string;
+        /** preview **/
+        requestBody: FlowPreview;
+    }): CancelablePromise<string>;
+    /**
+     * list all available queued jobs
+     * @returns QueuedJob All available queued jobs
+     * @throws ApiError
+     */
+    static listQueue({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, scriptHash, createdBefore, createdAfter, success, jobKinds, }: {
+        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 exact matching path **/
+        scriptHash?: string;
+        /** filter on created before (inclusive) timestamp **/
+        createdBefore?: string;
+        /** filter on created after (exclusive) timestamp **/
+        createdAfter?: string;
+        /** filter on successful jobs **/
+        success?: boolean;
+        /** filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, **/
+        jobKinds?: 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, scriptHash, createdBefore, createdAfter, success, jobKinds, }: {
+        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 exact matching path **/
+        scriptHash?: string;
+        /** filter on created before (inclusive) timestamp **/
+        createdBefore?: string;
+        /** filter on created after (exclusive) timestamp **/
+        createdAfter?: string;
+        /** filter on successful jobs **/
+        success?: boolean;
+        /** filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, **/
+        jobKinds?: string;
+    }): CancelablePromise<Array<CompletedJob>>;
+    /**
+     * list all available jobs
+     * @returns Job All jobs
+     * @throws ApiError
+     */
+    static listJobs({ workspace, createdBy, parentJob, scriptPathExact, scriptPathStart, scriptHash, createdBefore, createdAfter, jobKinds, 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 exact matching path **/
+        scriptHash?: string;
+        /** filter on created before (inclusive) timestamp **/
+        createdBefore?: string;
+        /** filter on created after (exclusive) timestamp **/
+        createdAfter?: string;
+        /** filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, **/
+        jobKinds?: string;
+        /** 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 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;
+    }>;
+    /**
+     * get completed job
+     * @returns CompletedJob job details
+     * @throws ApiError
+     */
+    static getCompletedJob({ workspace, id, }: {
+        workspace: string;
+        id: string;
+    }): CancelablePromise<CompletedJob>;
+    /**
+     * 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>;
+}

package/gen/services/ResourceService.d.ts

@@ -0,0 +1,116 @@
+import type { CreateResource } from '../models/CreateResource';
+import type { EditResource } from '../models/EditResource';
+import type { EditResourceType } from '../models/EditResourceType';
+import type { Resource } from '../models/Resource';
+import type { ResourceType } from '../models/ResourceType';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ResourceService {
+    /**
+     * create resource
+     * @returns string resource created
+     * @throws ApiError
+     */
+    static createResource({ workspace, requestBody, }: {
+        workspace: string;
+        /** new resource **/
+        requestBody: CreateResource;
+    }): CancelablePromise<string>;
+    /**
+     * delete resource
+     * @returns string resource deleted
+     * @throws ApiError
+     */
+    static deleteResource({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * update resource
+     * @returns string resource updated
+     * @throws ApiError
+     */
+    static updateResource({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /** updated resource **/
+        requestBody: EditResource;
+    }): CancelablePromise<string>;
+    /**
+     * get resource
+     * @returns Resource resource deleted
+     * @throws ApiError
+     */
+    static getResource({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<Resource>;
+    /**
+     * list resources
+     * @returns Resource resource list
+     * @throws ApiError
+     */
+    static listResource({ workspace, page, perPage, resourceType, }: {
+        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;
+        /** resource_type to list from **/
+        resourceType?: string;
+    }): CancelablePromise<Array<Resource>>;
+    /**
+     * create resource_type
+     * @returns string resource_type created
+     * @throws ApiError
+     */
+    static createResourceType({ workspace, requestBody, }: {
+        workspace: string;
+        /** new resource_type **/
+        requestBody: ResourceType;
+    }): CancelablePromise<string>;
+    /**
+     * delete resource_type
+     * @returns string resource_type deleted
+     * @throws ApiError
+     */
+    static deleteResourceType({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * update resource_type
+     * @returns string resource_type updated
+     * @throws ApiError
+     */
+    static updateResourceType({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /** updated resource_type **/
+        requestBody: EditResourceType;
+    }): CancelablePromise<string>;
+    /**
+     * get resource_type
+     * @returns ResourceType resource_type deleted
+     * @throws ApiError
+     */
+    static getResourceType({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<ResourceType>;
+    /**
+     * list resource_types
+     * @returns ResourceType resource_type list
+     * @throws ApiError
+     */
+    static listResourceType({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<ResourceType>>;
+    /**
+     * list resource_types names
+     * @returns string resource_type list
+     * @throws ApiError
+     */
+    static listResourceTypeNames({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<string>>;
+}

package/gen/services/ScheduleService.d.ts

@@ -0,0 +1,73 @@
+import type { EditSchedule } from '../models/EditSchedule';
+import type { NewSchedule } from '../models/NewSchedule';
+import type { Schedule } from '../models/Schedule';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ScheduleService {
+    /**
+     * preview schedule
+     * @returns string the preview of the next 10 time this schedule would apply to
+     * @throws ApiError
+     */
+    static previewSchedule({ requestBody, }: {
+        /** schedule **/
+        requestBody: {
+            schedule: string;
+            offset?: number;
+        };
+    }): CancelablePromise<Array<string>>;
+    /**
+     * create schedule
+     * @returns string schedule created
+     * @throws ApiError
+     */
+    static createSchedule({ workspace, requestBody, }: {
+        workspace: string;
+        /** new schedule **/
+        requestBody: NewSchedule;
+    }): CancelablePromise<string>;
+    /**
+     * update schedule
+     * @returns string schedule updated
+     * @throws ApiError
+     */
+    static updateSchedule({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /** updated schedule **/
+        requestBody: EditSchedule;
+    }): CancelablePromise<string>;
+    /**
+     * set enabled schedule
+     * @returns string schedule enabled set
+     * @throws ApiError
+     */
+    static setScheduleEnabled({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /** updated schedule enable **/
+        requestBody: {
+            enabled: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * get schedule
+     * @returns Schedule schedule deleted
+     * @throws ApiError
+     */
+    static getSchedule({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<Schedule>;
+    /**
+     * list schedules
+     * @returns Schedule schedule list
+     * @throws ApiError
+     */
+    static listSchedules({ 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<Schedule>>;
+}