windmill-client 0.1.0 → 0.2.0

package/src/services/AppService.d.ts

@@ -0,0 +1,194 @@
+import type { AppWithLastVersion } from '../models/AppWithLastVersion';
+import type { AppWithLastVersionWDraft } from '../models/AppWithLastVersionWDraft';
+import type { ListableApp } from '../models/ListableApp';
+import type { Policy } from '../models/Policy';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AppService {
+    /**
+     * list all available hub apps
+     * @returns any hub apps list
+     * @throws ApiError
+     */
+    static listHubApps(): CancelablePromise<{
+        apps?: Array<{
+            id: number;
+            app_id: number;
+            summary: string;
+            apps: Array<string>;
+            approved: boolean;
+            votes: number;
+        }>;
+    }>;
+    /**
+     * get hub app by id
+     * @returns any app
+     * @throws ApiError
+     */
+    static getHubAppById({ id, }: {
+        id: number;
+    }): CancelablePromise<{
+        app: {
+            summary: string;
+            value: any;
+        };
+    }>;
+    /**
+     * list all available apps
+     * @returns ListableApp All available apps
+     * @throws ApiError
+     */
+    static listApps({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, starredOnly, }: {
+        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;
+        /**
+         * order by desc order (default true)
+         */
+        orderDesc?: boolean;
+        /**
+         * mask to filter exact matching user creator
+         */
+        createdBy?: string;
+        /**
+         * mask to filter matching starting path
+         */
+        pathStart?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        pathExact?: string;
+        /**
+         * (default false)
+         * show only the starred items
+         *
+         */
+        starredOnly?: boolean;
+    }): CancelablePromise<Array<ListableApp>>;
+    /**
+     * does an app exisst at path
+     * @returns boolean app exists
+     * @throws ApiError
+     */
+    static existsApp({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * get app by path
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getAppByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<AppWithLastVersion>;
+    /**
+     * get app by path with draft
+     * @returns AppWithLastVersionWDraft app details with draft
+     * @throws ApiError
+     */
+    static getAppByPathWithDraft({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<AppWithLastVersionWDraft>;
+    /**
+     * get public app by secret
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getPublicAppBySecret({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<AppWithLastVersion>;
+    /**
+     * get public secret of app
+     * @returns string app secret
+     * @throws ApiError
+     */
+    static getPublicSecretOfApp({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * get app by version
+     * @returns AppWithLastVersion app details
+     * @throws ApiError
+     */
+    static getAppByVersion({ workspace, id, }: {
+        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
+     * @throws ApiError
+     */
+    static deleteApp({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * update app
+     * @returns string app updated
+     * @throws ApiError
+     */
+    static updateApp({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * update app
+         */
+        requestBody: {
+            path?: string;
+            summary?: string;
+            value?: any;
+            policy?: Policy;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * executeComponent
+     * @returns string job uuid
+     * @throws ApiError
+     */
+    static executeComponent({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * update app
+         */
+        requestBody: {
+            path?: string;
+            args: any;
+            raw_code?: {
+                content: string;
+                language: string;
+                path?: string;
+            };
+            force_viewer_static_fields?: any;
+        };
+    }): CancelablePromise<string>;
+}

package/src/services/AuditService.d.ts

@@ -0,0 +1,53 @@
+import type { AuditLog } from '../models/AuditLog';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AuditService {
+    /**
+     * get audit log (requires admin privilege)
+     * @returns AuditLog an audit log
+     * @throws ApiError
+     */
+    static getAuditLog({ workspace, id, }: {
+        workspace: string;
+        id: number;
+    }): CancelablePromise<AuditLog>;
+    /**
+     * list audit logs (requires admin privilege)
+     * @returns AuditLog a list of audit logs
+     * @throws ApiError
+     */
+    static listAuditLogs({ workspace, page, perPage, before, after, username, operation, resource, actionKind, }: {
+        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;
+        /**
+         * filter on created before (exclusive) timestamp
+         */
+        before?: string;
+        /**
+         * filter on created after (exclusive) timestamp
+         */
+        after?: string;
+        /**
+         * filter on exact username of user
+         */
+        username?: string;
+        /**
+         * filter on exact or prefix name of operation
+         */
+        operation?: string;
+        /**
+         * filter on exact or prefix name of resource
+         */
+        resource?: string;
+        /**
+         * filter on type of operation
+         */
+        actionKind?: 'Create' | 'Update' | 'Delete' | 'Execute';
+    }): CancelablePromise<Array<AuditLog>>;
+}

package/src/services/CaptureService.d.ts

@@ -0,0 +1,30 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class CaptureService {
+    /**
+     * update flow preview capture
+     * @returns void
+     * @throws ApiError
+     */
+    static updateCapture({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<void>;
+    /**
+     * create flow preview capture
+     * @returns any flow preview capture created
+     * @throws ApiError
+     */
+    static createCapture({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<any>;
+    /**
+     * get flow preview capture
+     * @returns any captured flow preview
+     * @throws ApiError
+     */
+    static getCapture({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<any>;
+}

package/src/services/DraftService.d.ts

@@ -0,0 +1,16 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class DraftService {
+    /**
+     * create draft
+     * @returns string draft created
+     * @throws ApiError
+     */
+    static createDraft({ workspace, requestBody, }: {
+        workspace: string;
+        requestBody: {
+            path: string;
+            typ: 'flow' | 'script' | 'app';
+            value?: any;
+        };
+    }): CancelablePromise<string>;
+}

package/src/services/FavoriteService.d.ts

@@ -0,0 +1,27 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class FavoriteService {
+    /**
+     * star item
+     * @returns any star item
+     * @throws ApiError
+     */
+    static star({ workspace, requestBody, }: {
+        workspace: string;
+        requestBody?: {
+            path?: string;
+            favorite_kind?: 'flow' | 'app' | 'script';
+        };
+    }): CancelablePromise<any>;
+    /**
+     * unstar item
+     * @returns any unstar item
+     * @throws ApiError
+     */
+    static unstar({ workspace, requestBody, }: {
+        workspace: string;
+        requestBody?: {
+            path?: string;
+            favorite_kind?: 'flow' | 'app' | 'script';
+        };
+    }): CancelablePromise<any>;
+}

package/src/services/FlowService.d.ts

@@ -0,0 +1,186 @@
+import type { Flow } from '../models/Flow';
+import type { Input } from '../models/Input';
+import type { OpenFlow } from '../models/OpenFlow';
+import type { OpenFlowWPath } from '../models/OpenFlowWPath';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class FlowService {
+    /**
+     * list all available hub flows
+     * @returns any hub flows list
+     * @throws ApiError
+     */
+    static listHubFlows(): CancelablePromise<{
+        flows?: Array<{
+            id: number;
+            flow_id: number;
+            summary: string;
+            apps: Array<string>;
+            approved: boolean;
+            votes: number;
+        }>;
+    }>;
+    /**
+     * get hub flow by id
+     * @returns any flow
+     * @throws ApiError
+     */
+    static getHubFlowById({ id, }: {
+        id: number;
+    }): CancelablePromise<{
+        flow?: OpenFlow;
+    }>;
+    /**
+     * list all available flow paths
+     * @returns string list of flow paths
+     * @throws ApiError
+     */
+    static listFlowPaths({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<string>>;
+    /**
+     * list all available flows
+     * @returns any All available flow
+     * @throws ApiError
+     */
+    static listFlows({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, showArchived, starredOnly, }: {
+        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;
+        /**
+         * order by desc order (default true)
+         */
+        orderDesc?: boolean;
+        /**
+         * mask to filter exact matching user creator
+         */
+        createdBy?: string;
+        /**
+         * mask to filter matching starting path
+         */
+        pathStart?: string;
+        /**
+         * mask to filter exact matching path
+         */
+        pathExact?: string;
+        /**
+         * (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.
+         *
+         */
+        showArchived?: boolean;
+        /**
+         * (default false)
+         * show only the starred items
+         *
+         */
+        starredOnly?: boolean;
+    }): CancelablePromise<Array<(Flow & {
+        has_draft?: boolean;
+        draft_only?: boolean;
+    })>>;
+    /**
+     * get flow by path
+     * @returns Flow flow details
+     * @throws ApiError
+     */
+    static getFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<Flow>;
+    /**
+     * get flow by path with draft
+     * @returns any flow details with draft
+     * @throws ApiError
+     */
+    static getFlowByPathWithDraft({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<(Flow & {
+        draft?: Flow;
+    })>;
+    /**
+     * exists flow by path
+     * @returns boolean flow details
+     * @throws ApiError
+     */
+    static existsFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * create flow
+     * @returns string flow created
+     * @throws ApiError
+     */
+    static createFlow({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * Partially filled flow
+         */
+        requestBody: (OpenFlowWPath & {
+            draft_only?: boolean;
+        });
+    }): CancelablePromise<string>;
+    /**
+     * update flow
+     * @returns string flow updated
+     * @throws ApiError
+     */
+    static updateFlow({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * Partially filled flow
+         */
+        requestBody: OpenFlowWPath;
+    }): CancelablePromise<string>;
+    /**
+     * archive flow by path
+     * @returns string flow archived
+     * @throws ApiError
+     */
+    static archiveFlowByPath({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /**
+         * archiveFlow
+         */
+        requestBody: {
+            archived?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * delete flow by path
+     * @returns string flow delete
+     * @throws ApiError
+     */
+    static deleteFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * list inputs for previous completed flow jobs
+     * @returns Input input history for completed jobs with this flow path
+     * @throws ApiError
+     */
+    static getFlowInputHistoryByPath({ workspace, path, page, perPage, }: {
+        workspace: string;
+        path: 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<Input>>;
+}

package/src/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/src/services/GranularAclService.d.ts

@@ -0,0 +1,46 @@
+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' | 'folder' | 'app';
+    }): 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' | 'folder' | 'app';
+        /**
+         * 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' | 'folder' | 'app';
+        /**
+         * acl to add
+         */
+        requestBody: {
+            owner: string;
+        };
+    }): CancelablePromise<string>;
+}