windmill-client 0.2.0 → 0.3.1

package/dist/services/WorkspaceService.js

@@ -0,0 +1,275 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class WorkspaceService {
+    /**
+     * list all workspaces visible to me
+     * @returns Workspace all workspaces
+     * @throws ApiError
+     */
+    static listWorkspaces() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/workspaces/list',
+        });
+    }
+    /**
+     * is domain allowed for auto invi
+     * @returns boolean domain allowed or not
+     * @throws ApiError
+     */
+    static isDomainAllowed() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/workspaces/allowed_domain_auto_invite',
+        });
+    }
+    /**
+     * list all workspaces visible to me with user info
+     * @returns UserWorkspaceList workspace with associated username
+     * @throws ApiError
+     */
+    static listUserWorkspaces() {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/workspaces/users',
+        });
+    }
+    /**
+     * list all workspaces as super admin (require to be super admin)
+     * @returns Workspace workspaces
+     * @throws ApiError
+     */
+    static listWorkspacesAsSuperAdmin({ page, perPage, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/workspaces/list_as_superadmin',
+            query: {
+                'page': page,
+                'per_page': perPage,
+            },
+        });
+    }
+    /**
+     * create workspace
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createWorkspace({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/workspaces/create',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * exists workspace
+     * @returns boolean status
+     * @throws ApiError
+     */
+    static existsWorkspace({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/workspaces/exists',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * exists username
+     * @returns boolean status
+     * @throws ApiError
+     */
+    static existsUsername({ requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/workspaces/exists_username',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * invite user to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static inviteUser({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/workspaces/invite_user',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * add user to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static addUser({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/workspaces/add_user',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * delete user invite
+     * @returns string status
+     * @throws ApiError
+     */
+    static deleteInvite({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/workspaces/delete_invite',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * archive workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static archiveWorkspace({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/workspaces/archive',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * unarchive workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static unarchiveWorkspace({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/workspaces/unarchive/{workspace}',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * delete workspace (require super admin)
+     * @returns string status
+     * @throws ApiError
+     */
+    static deleteWorkspace({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/workspaces/delete/{workspace}',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * list pending invites for a workspace
+     * @returns WorkspaceInvite user
+     * @throws ApiError
+     */
+    static listPendingInvites({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/workspaces/list_pending_invites',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * get settings
+     * @returns any status
+     * @throws ApiError
+     */
+    static getSettings({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/workspaces/get_settings',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * get premium info
+     * @returns any status
+     * @throws ApiError
+     */
+    static getPremiumInfo({ workspace, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/workspaces/premium_info',
+            path: {
+                'workspace': workspace,
+            },
+        });
+    }
+    /**
+     * edit slack command
+     * @returns string status
+     * @throws ApiError
+     */
+    static editSlackCommand({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/workspaces/edit_slack_command',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * edit auto invite
+     * @returns string status
+     * @throws ApiError
+     */
+    static editAutoInvite({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/workspaces/edit_auto_invite',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * edit webhook
+     * @returns string status
+     * @throws ApiError
+     */
+    static editWebhook({ workspace, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/workspaces/edit_webhook',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+exports.WorkspaceService = WorkspaceService;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "windmill-client",
   "description": "Windmill SDK client for browsers and Node.js",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "author": "Ruben Fiszel",
   "license": "Apache 2.0",
   "dependencies": {},

package/publish.sh

@@ -0,0 +1,3 @@
+./build.sh
+tsc
+npm publish

package/src/core/OpenAPI.ts

@@ -20,7 +20,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: '/api',
-    VERSION: '1.95.1',
+    VERSION: '1.100.1',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -40,6 +40,7 @@ export type { InputTransform } from './models/InputTransform';
 export type { JavascriptTransform } from './models/JavascriptTransform';
 export { Job } from './models/Job';
 export { ListableApp } from './models/ListableApp';
+export type { ListableRawApp } from './models/ListableRawApp';
 export type { ListableResource } from './models/ListableResource';
 export type { ListableVariable } from './models/ListableVariable';
 export type { Login } from './models/Login';
@@ -90,6 +91,7 @@ export { GroupService } from './services/GroupService';
 export { InputService } from './services/InputService';
 export { JobService } from './services/JobService';
 export { OauthService } from './services/OauthService';
+export { RawAppService } from './services/RawAppService';
 export { ResourceService } from './services/ResourceService';
 export { ScheduleService } from './services/ScheduleService';
 export { ScriptService } from './services/ScriptService';

package/src/models/ListableRawApp.ts

@@ -0,0 +1,14 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type ListableRawApp = {
+    workspace_id: string;
+    path: string;
+    summary: string;
+    extra_perms: Record<string, boolean>;
+    starred?: boolean;
+    version: number;
+    edited_at: string;
+};
+

package/src/services/AppService.ts

@@ -122,6 +122,38 @@ export class AppService {
         });
     }
 
+    /**
+     * create app
+     * @returns string app created
+     * @throws ApiError
+     */
+    public static createApp({
+        workspace,
+        requestBody,
+    }: {
+        workspace: string,
+        /**
+         * new app
+         */
+        requestBody: {
+            path: string;
+            value: any;
+            summary: string;
+            policy: Policy;
+            draft_only?: boolean;
+        },
+    }): CancelablePromise<string> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/apps/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
     /**
      * does an app exisst at path
      * @returns boolean app exists
@@ -254,38 +286,6 @@ export class AppService {
         });
     }
 
-    /**
-     * create app
-     * @returns string app created
-     * @throws ApiError
-     */
-    public static createApp({
-        workspace,
-        requestBody,
-    }: {
-        workspace: string,
-        /**
-         * new app
-         */
-        requestBody: {
-            path: string;
-            value: any;
-            summary: string;
-            policy: Policy;
-            draft_only?: boolean;
-        },
-    }): CancelablePromise<string> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/w/{workspace}/apps/create',
-            path: {
-                'workspace': workspace,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-
     /**
      * delete app
      * @returns string app deleted
@@ -358,6 +358,7 @@ export class AppService {
          * update app
          */
         requestBody: {
+            component: string;
             path?: string;
             args: any;
             raw_code?: {

package/src/services/FavoriteService.ts

@@ -19,7 +19,7 @@ export class FavoriteService {
         workspace: string,
         requestBody?: {
             path?: string;
-            favorite_kind?: 'flow' | 'app' | 'script';
+            favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
         },
     }): CancelablePromise<any> {
         return __request(OpenAPI, {
@@ -45,7 +45,7 @@ export class FavoriteService {
         workspace: string,
         requestBody?: {
             path?: string;
-            favorite_kind?: 'flow' | 'app' | 'script';
+            favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
         },
     }): CancelablePromise<any> {
         return __request(OpenAPI, {

package/src/services/GranularAclService.ts

@@ -19,7 +19,7 @@ export class GranularAclService {
     }: {
         workspace: string,
         path: string,
-        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app',
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app',
     }): CancelablePromise<Record<string, boolean>> {
         return __request(OpenAPI, {
             method: 'GET',
@@ -45,7 +45,7 @@ export class GranularAclService {
     }: {
         workspace: string,
         path: string,
-        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app',
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app',
         /**
          * acl to add
          */
@@ -80,7 +80,7 @@ export class GranularAclService {
     }: {
         workspace: string,
         path: string,
-        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app',
+        kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app',
         /**
          * acl to add
          */

package/src/services/JobService.ts

@@ -883,6 +883,31 @@ export class JobService {
         });
     }
 
+    /**
+     * get completed job result if job is completed
+     * @returns any result
+     * @throws ApiError
+     */
+    public static getCompletedJobResultMaybe({
+        workspace,
+        id,
+    }: {
+        workspace: string,
+        id: string,
+    }): CancelablePromise<{
+        completed: boolean;
+        result: any;
+    }> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/completed/get_result_maybe/{id}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+            },
+        });
+    }
+
     /**
      * delete completed job (erase content but keep run id)
      * @returns CompletedJob job details

package/src/services/RawAppService.ts

@@ -0,0 +1,209 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ListableRawApp } from '../models/ListableRawApp';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class RawAppService {
+
+    /**
+     * list all available raw apps
+     * @returns ListableRawApp All available raw apps
+     * @throws ApiError
+     */
+    public static listRawApps({
+        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<ListableRawApp>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/raw_apps/list',
+            path: {
+                'workspace': workspace,
+            },
+            query: {
+                'page': page,
+                'per_page': perPage,
+                'order_desc': orderDesc,
+                'created_by': createdBy,
+                'path_start': pathStart,
+                'path_exact': pathExact,
+                'starred_only': starredOnly,
+            },
+        });
+    }
+
+    /**
+     * does an app exisst at path
+     * @returns boolean app exists
+     * @throws ApiError
+     */
+    public static existsRawApp({
+        workspace,
+        path,
+    }: {
+        workspace: string,
+        path: string,
+    }): CancelablePromise<boolean> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/raw_apps/exists/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+
+    /**
+     * get app by path
+     * @returns string app details
+     * @throws ApiError
+     */
+    public static getRawAppData({
+        workspace,
+        version,
+        path,
+    }: {
+        workspace: string,
+        version: number,
+        path: string,
+    }): CancelablePromise<string> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/apps/get_data/{version}/{path}',
+            path: {
+                'workspace': workspace,
+                'version': version,
+                'path': path,
+            },
+        });
+    }
+
+    /**
+     * create raw app
+     * @returns string raw app created
+     * @throws ApiError
+     */
+    public static createRawApp({
+        workspace,
+        requestBody,
+    }: {
+        workspace: string,
+        /**
+         * new raw app
+         */
+        requestBody: {
+            path: string;
+            value: string;
+            summary: string;
+        },
+    }): CancelablePromise<string> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/raw_apps/create',
+            path: {
+                'workspace': workspace,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * update app
+     * @returns string app updated
+     * @throws ApiError
+     */
+    public static updateRawApp({
+        workspace,
+        path,
+        requestBody,
+    }: {
+        workspace: string,
+        path: string,
+        /**
+         * updateraw  app
+         */
+        requestBody: {
+            path?: string;
+            summary?: string;
+            value?: string;
+        },
+    }): CancelablePromise<string> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/raw_apps/update/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * delete raw app
+     * @returns string app deleted
+     * @throws ApiError
+     */
+    public static deleteRawApp({
+        workspace,
+        path,
+    }: {
+        workspace: string,
+        path: string,
+    }): CancelablePromise<string> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/w/{workspace}/raw_apps/delete/{path}',
+            path: {
+                'workspace': workspace,
+                'path': path,
+            },
+        });
+    }
+
+}