windmill-client 0.1.0 → 0.2.1

package/dist/services/WorkspaceService.d.ts

@@ -0,0 +1,227 @@
+import type { CreateWorkspace } from '../models/CreateWorkspace';
+import type { UserWorkspaceList } from '../models/UserWorkspaceList';
+import type { Workspace } from '../models/Workspace';
+import type { WorkspaceInvite } from '../models/WorkspaceInvite';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class WorkspaceService {
+    /**
+     * list all workspaces visible to me
+     * @returns Workspace all workspaces
+     * @throws ApiError
+     */
+    static listWorkspaces(): CancelablePromise<Array<Workspace>>;
+    /**
+     * is domain allowed for auto invi
+     * @returns boolean domain allowed or not
+     * @throws ApiError
+     */
+    static isDomainAllowed(): CancelablePromise<boolean>;
+    /**
+     * list all workspaces visible to me with user info
+     * @returns UserWorkspaceList workspace with associated username
+     * @throws ApiError
+     */
+    static listUserWorkspaces(): CancelablePromise<UserWorkspaceList>;
+    /**
+     * list all workspaces as super admin (require to be super admin)
+     * @returns Workspace workspaces
+     * @throws ApiError
+     */
+    static listWorkspacesAsSuperAdmin({ page, perPage, }: {
+        /**
+         * 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<Workspace>>;
+    /**
+     * create workspace
+     * @returns string token created
+     * @throws ApiError
+     */
+    static createWorkspace({ requestBody, }: {
+        /**
+         * new token
+         */
+        requestBody: CreateWorkspace;
+    }): CancelablePromise<string>;
+    /**
+     * exists workspace
+     * @returns boolean status
+     * @throws ApiError
+     */
+    static existsWorkspace({ requestBody, }: {
+        /**
+         * id of workspace
+         */
+        requestBody: {
+            id: string;
+        };
+    }): CancelablePromise<boolean>;
+    /**
+     * exists username
+     * @returns boolean status
+     * @throws ApiError
+     */
+    static existsUsername({ requestBody, }: {
+        requestBody: {
+            id: string;
+            username: string;
+        };
+    }): CancelablePromise<boolean>;
+    /**
+     * invite user to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static inviteUser({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            email: string;
+            is_admin: boolean;
+            operator: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * add user to workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static addUser({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            email: string;
+            is_admin: boolean;
+            username: string;
+            operator: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * delete user invite
+     * @returns string status
+     * @throws ApiError
+     */
+    static deleteInvite({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            email: string;
+            is_admin: boolean;
+            operator: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * archive workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static archiveWorkspace({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<string>;
+    /**
+     * unarchive workspace
+     * @returns string status
+     * @throws ApiError
+     */
+    static unarchiveWorkspace({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<string>;
+    /**
+     * delete workspace (require super admin)
+     * @returns string status
+     * @throws ApiError
+     */
+    static deleteWorkspace({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<string>;
+    /**
+     * list pending invites for a workspace
+     * @returns WorkspaceInvite user
+     * @throws ApiError
+     */
+    static listPendingInvites({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<Array<WorkspaceInvite>>;
+    /**
+     * get settings
+     * @returns any status
+     * @throws ApiError
+     */
+    static getSettings({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<{
+        workspace_id?: string;
+        slack_name?: string;
+        slack_team_id?: string;
+        slack_command_script?: string;
+        auto_invite_domain?: string;
+        auto_invite_operator?: boolean;
+        plan?: string;
+        customer_id?: string;
+        webhook?: string;
+    }>;
+    /**
+     * get premium info
+     * @returns any status
+     * @throws ApiError
+     */
+    static getPremiumInfo({ workspace, }: {
+        workspace: string;
+    }): CancelablePromise<{
+        premium: boolean;
+        usage?: number;
+    }>;
+    /**
+     * edit slack command
+     * @returns string status
+     * @throws ApiError
+     */
+    static editSlackCommand({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            slack_command_script?: string;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * edit auto invite
+     * @returns string status
+     * @throws ApiError
+     */
+    static editAutoInvite({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceInvite
+         */
+        requestBody: {
+            operator?: boolean;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * edit webhook
+     * @returns string status
+     * @throws ApiError
+     */
+    static editWebhook({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * WorkspaceWebhook
+         */
+        requestBody: {
+            webhook?: string;
+        };
+    }): CancelablePromise<string>;
+}

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,12 @@
 {
   "name": "windmill-client",
   "description": "Windmill SDK client for browsers and Node.js",
-  "version": "0.1.0",
+  "version": "0.2.1",
+  "author": "Ruben Fiszel",
+  "license": "Apache 2.0",
   "dependencies": {},
-  "devDependencies": {}
+  "devDependencies": {},
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "prepublish": "tsc"
 }

package/src/core/ApiError.d.ts

@@ -0,0 +1,10 @@
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { ApiResult } from './ApiResult';
+export declare class ApiError extends Error {
+    readonly url: string;
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: any;
+    readonly request: ApiRequestOptions;
+    constructor(request: ApiRequestOptions, response: ApiResult, message: string);
+}

package/src/core/ApiRequestOptions.d.ts

@@ -0,0 +1,13 @@
+export type ApiRequestOptions = {
+    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
+    readonly url: string;
+    readonly path?: Record<string, any>;
+    readonly cookies?: Record<string, any>;
+    readonly headers?: Record<string, any>;
+    readonly query?: Record<string, any>;
+    readonly formData?: Record<string, any>;
+    readonly body?: any;
+    readonly mediaType?: string;
+    readonly responseHeader?: string;
+    readonly errors?: Record<number, string>;
+};

package/src/core/ApiResult.d.ts

@@ -0,0 +1,7 @@
+export type ApiResult = {
+    readonly url: string;
+    readonly ok: boolean;
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: any;
+};

package/src/core/CancelablePromise.d.ts

@@ -0,0 +1,26 @@
+export declare class CancelError extends Error {
+    constructor(message: string);
+    get isCancelled(): boolean;
+}
+export interface OnCancel {
+    readonly isResolved: boolean;
+    readonly isRejected: boolean;
+    readonly isCancelled: boolean;
+    (cancelHandler: () => void): void;
+}
+export declare class CancelablePromise<T> implements Promise<T> {
+    readonly [Symbol.toStringTag]: string;
+    private _isResolved;
+    private _isRejected;
+    private _isCancelled;
+    private readonly _cancelHandlers;
+    private readonly _promise;
+    private _resolve?;
+    private _reject?;
+    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
+    then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    finally(onFinally?: (() => void) | null): Promise<T>;
+    cancel(): void;
+    get isCancelled(): boolean;
+}

package/src/core/OpenAPI.d.ts

@@ -0,0 +1,16 @@
+import type { ApiRequestOptions } from './ApiRequestOptions';
+type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
+type Headers = Record<string, string>;
+export type OpenAPIConfig = {
+    BASE: string;
+    VERSION: string;
+    WITH_CREDENTIALS: boolean;
+    CREDENTIALS: 'include' | 'omit' | 'same-origin';
+    TOKEN?: string | Resolver<string>;
+    USERNAME?: string | Resolver<string>;
+    PASSWORD?: string | Resolver<string>;
+    HEADERS?: Headers | Resolver<Headers>;
+    ENCODE_PATH?: (path: string) => string;
+};
+export declare const OpenAPI: OpenAPIConfig;
+export {};

package/src/core/request.d.ts

@@ -0,0 +1,13 @@
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import { CancelablePromise } from './CancelablePromise';
+import type { OnCancel } from './CancelablePromise';
+import type { OpenAPIConfig } from './OpenAPI';
+export declare const sendRequest: (config: OpenAPIConfig, options: ApiRequestOptions, url: string, body: any, formData: FormData | undefined, headers: Headers, onCancel: OnCancel) => Promise<Response>;
+/**
+ * Request method
+ * @param config The OpenAPI configuration object
+ * @param options The request options from the service
+ * @returns CancelablePromise<T>
+ * @throws ApiError
+ */
+export declare const request: <T>(config: OpenAPIConfig, options: ApiRequestOptions) => CancelablePromise<T>;