windmill-client 0.3.11 → 0.3.13

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

@@ -0,0 +1,258 @@
+import type { NewScript } from '../models/NewScript';
+import type { NewScriptWithDraft } from '../models/NewScriptWithDraft';
+import type { Script } from '../models/Script';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ScriptService {
+    /**
+     * list all available hub scripts
+     * @returns any hub scripts list
+     * @throws ApiError
+     */
+    static listHubScripts(): CancelablePromise<{
+        asks?: Array<{
+            id: number;
+            ask_id: number;
+            summary: string;
+            app: string;
+            approved: boolean;
+            kind: 'script' | 'failure' | 'trigger' | 'command' | 'approval';
+            votes: number;
+            views: number;
+        }>;
+    }>;
+    /**
+     * get hub script content by path
+     * @returns string script details
+     * @throws ApiError
+     */
+    static getHubScriptContentByPath({ path, }: {
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * get full hub script by path
+     * @returns any script details
+     * @throws ApiError
+     */
+    static getHubScriptByPath({ path, }: {
+        path: string;
+    }): CancelablePromise<{
+        content: string;
+        lockfile?: string;
+        schema?: any;
+        language: string;
+        summary?: string;
+    }>;
+    /**
+     * list all available scripts
+     * @returns Script All available scripts
+     * @throws ApiError
+     */
+    static listScripts({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, firstParentHash, lastParentHash, parentHash, showArchived, isTemplate, kind, 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;
+        /**
+         * mask to filter scripts whom first direct parent has exact hash
+         */
+        firstParentHash?: string;
+        /**
+         * mask to filter scripts whom last parent in the chain has exact hash.
+         * Beware that each script stores only a limited number of parents. Hence
+         * the last parent hash for a script is not necessarily its top-most parent.
+         * To find the top-most parent you will have to jump from last to last hash
+         * until finding the parent
+         *
+         */
+        lastParentHash?: string;
+        /**
+         * is the hash present in the array of stored parent hashes for this script.
+         * The same warning applies than for last_parent_hash. A script only store a
+         * limited number of direct parent
+         *
+         */
+        parentHash?: 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
+         * ed.
+         *
+         */
+        showArchived?: boolean;
+        /**
+         * (default regardless)
+         * if true show only the templates
+         * if false show only the non templates
+         * if not defined, show all regardless of if the script is a template
+         *
+         */
+        isTemplate?: boolean;
+        /**
+         * (default regardless)
+         * script kind
+         *
+         */
+        kind?: string;
+        /**
+         * (default false)
+         * show only the starred items
+         *
+         */
+        starredOnly?: boolean;
+    }): CancelablePromise<Array<Script>>;
+    /**
+     * list all available scripts paths
+     * @returns string list of script paths
+     * @throws ApiError
+     */
+    static listScriptPaths({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<string>>;
+    /**
+     * create script
+     * @returns string script created
+     * @throws ApiError
+     */
+    static createScript({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * Partially filled script
+         */
+        requestBody: NewScript;
+    }): CancelablePromise<string>;
+    /**
+     * archive script by path
+     * @returns string script archived
+     * @throws ApiError
+     */
+    static archiveScriptByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * archive script by hash
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static archiveScriptByHash({ workspace, hash, }: {
+        workspace: string;
+        hash: string;
+    }): CancelablePromise<Script>;
+    /**
+     * delete script by hash (erase content but keep hash, require admin)
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static deleteScriptByHash({ workspace, hash, }: {
+        workspace: string;
+        hash: string;
+    }): CancelablePromise<Script>;
+    /**
+     * delete all scripts at a given path (require admin)
+     * @returns string script path
+     * @throws ApiError
+     */
+    static deleteScriptByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * get script by path
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static getScriptByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<Script>;
+    /**
+     * get script by path with draft
+     * @returns NewScriptWithDraft script details
+     * @throws ApiError
+     */
+    static getScriptByPathWithDraft({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<NewScriptWithDraft>;
+    /**
+     * raw script by path
+     * @returns string script content
+     * @throws ApiError
+     */
+    static rawScriptByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
+     * @returns string script content
+     * @throws ApiError
+     */
+    static rawScriptByPathTokened({ workspace, token, path, }: {
+        workspace: string;
+        token: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * exists script by path
+     * @returns boolean does it exists
+     * @throws ApiError
+     */
+    static existsScriptByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<boolean>;
+    /**
+     * get script by hash
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static getScriptByHash({ workspace, hash, }: {
+        workspace: string;
+        hash: string;
+    }): CancelablePromise<Script>;
+    /**
+     * raw script by hash
+     * @returns string script content
+     * @throws ApiError
+     */
+    static rawScriptByHash({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+    /**
+     * get script deployment status
+     * @returns any script details
+     * @throws ApiError
+     */
+    static getScriptDeploymentStatus({ workspace, hash, }: {
+        workspace: string;
+        hash: string;
+    }): CancelablePromise<{
+        lock?: string;
+        lock_error_logs?: string;
+    }>;
+}

package/dist/src/services/ScriptService.js

@@ -0,0 +1,283 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ScriptService {
+    /**
+     * list all available hub scripts
+     * @returns any hub scripts list
+     * @throws ApiError
+     */
+    static listHubScripts() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/scripts/hub/list',
+        });
+    }
+    /**
+     * get hub script content by path
+     * @returns string script details
+     * @throws ApiError
+     */
+    static getHubScriptContentByPath({ path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/scripts/hub/get/{path}',
+            path: {
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get full hub script by path
+     * @returns any script details
+     * @throws ApiError
+     */
+    static getHubScriptByPath({ path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/scripts/hub/get_full/{path}',
+            path: {
+                'path': path,
+            },
+        });
+    }
+    /**
+     * list all available scripts
+     * @returns Script All available scripts
+     * @throws ApiError
+     */
+    static listScripts({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, firstParentHash, lastParentHash, parentHash, showArchived, isTemplate, kind, starredOnly, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+                'order_desc': orderDesc,
+                'created_by': createdBy,
+                'path_start': pathStart,
+                'path_exact': pathExact,
+                'first_parent_hash': firstParentHash,
+                'last_parent_hash': lastParentHash,
+                'parent_hash': parentHash,
+                'show_archived': showArchived,
+                'is_template': isTemplate,
+                'kind': kind,
+                'starred_only': starredOnly,
+            },
+        });
+    }
+    /**
+     * list all available scripts paths
+     * @returns string list of script paths
+     * @throws ApiError
+     */
+    static listScriptPaths({ workspace, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/list_paths',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * create script
+     * @returns string script created
+     * @throws ApiError
+     */
+    static createScript({ workspace, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/scripts/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * archive script by path
+     * @returns string script archived
+     * @throws ApiError
+     */
+    static archiveScriptByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/scripts/archive/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * archive script by hash
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static archiveScriptByHash({ workspace, hash, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/scripts/archive/h/{hash}',
+            path: {
+                'workspace': workspace,
+                'hash': hash,
+            },
+        });
+    }
+    /**
+     * delete script by hash (erase content but keep hash, require admin)
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static deleteScriptByHash({ workspace, hash, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/scripts/delete/h/{hash}',
+            path: {
+                'workspace': workspace,
+                'hash': hash,
+            },
+        });
+    }
+    /**
+     * delete all scripts at a given path (require admin)
+     * @returns string script path
+     * @throws ApiError
+     */
+    static deleteScriptByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/scripts/delete/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get script by path
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static getScriptByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/get/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get script by path with draft
+     * @returns NewScriptWithDraft script details
+     * @throws ApiError
+     */
+    static getScriptByPathWithDraft({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/get/draft/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * raw script by path
+     * @returns string script content
+     * @throws ApiError
+     */
+    static rawScriptByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/raw/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
+     * @returns string script content
+     * @throws ApiError
+     */
+    static rawScriptByPathTokened({ workspace, token, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/scripts_u/tokened_raw/{workspace}/{token}/{path}',
+            path: {
+                'workspace': workspace,
+                'token': token,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * exists script by path
+     * @returns boolean does it exists
+     * @throws ApiError
+     */
+    static existsScriptByPath({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/exists/p/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get script by hash
+     * @returns Script script details
+     * @throws ApiError
+     */
+    static getScriptByHash({ workspace, hash, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/get/h/{hash}',
+            path: {
+                'workspace': workspace,
+                'hash': hash,
+            },
+        });
+    }
+    /**
+     * raw script by hash
+     * @returns string script content
+     * @throws ApiError
+     */
+    static rawScriptByHash({ workspace, path, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/raw/h/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+    /**
+     * get script deployment status
+     * @returns any script details
+     * @throws ApiError
+     */
+    static getScriptDeploymentStatus({ workspace, hash, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/scripts/deployment_status/h/{hash}',
+            path: {
+                'workspace': workspace,
+                'hash': hash,
+            },
+        });
+    }
+}

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

@@ -0,0 +1,27 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SettingsService {
+    /**
+     * get backend version
+     * @returns string git version of backend
+     * @throws ApiError
+     */
+    static backendVersion(): CancelablePromise<string>;
+    /**
+     * is backend up to date
+     * @returns string is backend up to date
+     * @throws ApiError
+     */
+    static backendUptodate(): CancelablePromise<string>;
+    /**
+     * get license id
+     * @returns string get license id (empty if not ee)
+     * @throws ApiError
+     */
+    static getLicenseId(): CancelablePromise<string>;
+    /**
+     * get openapi yaml spec
+     * @returns string openapi yaml file content
+     * @throws ApiError
+     */
+    static getOpenApiYaml(): CancelablePromise<string>;
+}

package/dist/src/services/SettingsService.js

@@ -0,0 +1,48 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class SettingsService {
+    /**
+     * get backend version
+     * @returns string git version of backend
+     * @throws ApiError
+     */
+    static backendVersion() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/version',
+        });
+    }
+    /**
+     * is backend up to date
+     * @returns string is backend up to date
+     * @throws ApiError
+     */
+    static backendUptodate() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/uptodate',
+        });
+    }
+    /**
+     * get license id
+     * @returns string get license id (empty if not ee)
+     * @throws ApiError
+     */
+    static getLicenseId() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/ee_license',
+        });
+    }
+    /**
+     * get openapi yaml spec
+     * @returns string openapi yaml file content
+     * @throws ApiError
+     */
+    static getOpenApiYaml() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/openapi.yaml',
+        });
+    }
+}