windmill-client 0.1.0 → 0.2.1

package/src/models/NewUser.d.ts

@@ -0,0 +1,5 @@
+export type NewUser = {
+    email: string;
+    username: string;
+    is_admin: boolean;
+};

package/src/models/OpenFlow.d.ts

@@ -0,0 +1,7 @@
+import type { FlowValue } from './FlowValue';
+export type OpenFlow = {
+    summary: string;
+    description?: string;
+    value: FlowValue;
+    schema?: any;
+};

package/src/models/OpenFlowWPath.d.ts

@@ -0,0 +1,4 @@
+import type { OpenFlow } from './OpenFlow';
+export type OpenFlowWPath = (OpenFlow & {
+    path: string;
+});

package/src/models/PathFlow.d.ts

@@ -0,0 +1,6 @@
+import type { InputTransform } from './InputTransform';
+export type PathFlow = {
+    input_transforms: Record<string, InputTransform>;
+    path: string;
+    type: 'flow';
+};

package/src/models/PathScript.d.ts

@@ -0,0 +1,7 @@
+import type { InputTransform } from './InputTransform';
+export type PathScript = {
+    input_transforms: Record<string, InputTransform>;
+    path: string;
+    hash?: string;
+    type: 'script';
+};

package/src/models/Policy.d.ts

@@ -0,0 +1,13 @@
+export type Policy = {
+    triggerables?: Record<string, any>;
+    execution_mode?: Policy.execution_mode;
+    on_behalf_of?: string;
+    on_behalf_of_email?: string;
+};
+export declare namespace Policy {
+    enum execution_mode {
+        VIEWER = "viewer",
+        PUBLISHER = "publisher",
+        ANONYMOUS = "anonymous"
+    }
+}

package/src/models/Preview.d.ts

@@ -0,0 +1,16 @@
+import type { ScriptArgs } from './ScriptArgs';
+export type Preview = {
+    content: string;
+    path?: string;
+    args: ScriptArgs;
+    language: Preview.language;
+    tag?: string;
+};
+export declare namespace Preview {
+    enum language {
+        PYTHON3 = "python3",
+        DENO = "deno",
+        GO = "go",
+        BASH = "bash"
+    }
+}

package/src/models/QueuedJob.d.ts

@@ -0,0 +1,55 @@
+import type { FlowStatus } from './FlowStatus';
+import type { FlowValue } from './FlowValue';
+import type { ScriptArgs } from './ScriptArgs';
+export type QueuedJob = {
+    workspace_id?: string;
+    id: string;
+    parent_job?: string;
+    created_by?: string;
+    created_at?: string;
+    started_at?: string;
+    scheduled_for?: string;
+    running: boolean;
+    script_path?: string;
+    script_hash?: string;
+    args?: ScriptArgs;
+    logs?: string;
+    raw_code?: string;
+    canceled: boolean;
+    canceled_by?: string;
+    canceled_reason?: string;
+    last_ping?: string;
+    job_kind: QueuedJob.job_kind;
+    schedule_path?: string;
+    /**
+     * The user (u/userfoo) or group (g/groupfoo) whom
+     * the execution of this script will be permissioned_as and by extension its DT_TOKEN.
+     *
+     */
+    permissioned_as: string;
+    flow_status?: FlowStatus;
+    raw_flow?: FlowValue;
+    is_flow_step: boolean;
+    language?: QueuedJob.language;
+    email: string;
+    visible_to_owner: boolean;
+    mem_peak?: number;
+    tag: string;
+};
+export declare namespace QueuedJob {
+    enum job_kind {
+        SCRIPT = "script",
+        PREVIEW = "preview",
+        DEPENDENCIES = "dependencies",
+        FLOW = "flow",
+        FLOWPREVIEW = "flowpreview",
+        SCRIPT_HUB = "script_hub",
+        IDENTITY = "identity"
+    }
+    enum language {
+        PYTHON3 = "python3",
+        DENO = "deno",
+        GO = "go",
+        BASH = "bash"
+    }
+}

package/src/models/RawScript.d.ts

@@ -0,0 +1,18 @@
+import type { InputTransform } from './InputTransform';
+export type RawScript = {
+    input_transforms: Record<string, InputTransform>;
+    content: string;
+    language: RawScript.language;
+    path?: string;
+    lock?: string;
+    type: 'rawscript';
+    tag?: string;
+};
+export declare namespace RawScript {
+    enum language {
+        DENO = "deno",
+        PYTHON3 = "python3",
+        GO = "go",
+        BASH = "bash"
+    }
+}

package/src/models/Resource.d.ts

@@ -0,0 +1,9 @@
+export type Resource = {
+    workspace_id?: string;
+    path: string;
+    description?: string;
+    resource_type: string;
+    value?: any;
+    is_oauth: boolean;
+    extra_perms?: Record<string, boolean>;
+};

package/src/models/ResourceType.d.ts

@@ -0,0 +1,6 @@
+export type ResourceType = {
+    workspace_id?: string;
+    name: string;
+    schema?: any;
+    description?: string;
+};

package/src/models/Retry.d.ts

@@ -0,0 +1,11 @@
+export type Retry = {
+    constant?: {
+        attempts?: number;
+        seconds?: number;
+    };
+    exponential?: {
+        attempts?: number;
+        multiplier?: number;
+        seconds?: number;
+    };
+};

package/src/models/RunnableType.d.ts

@@ -0,0 +1,5 @@
+export declare enum RunnableType {
+    SCRIPT_HASH = "ScriptHash",
+    SCRIPT_PATH = "ScriptPath",
+    FLOW_PATH = "FlowPath"
+}

package/src/models/Schedule.d.ts

@@ -0,0 +1,15 @@
+import type { ScriptArgs } from './ScriptArgs';
+export type Schedule = {
+    path: string;
+    edited_by: string;
+    edited_at: string;
+    schedule: string;
+    timezone: string;
+    enabled: boolean;
+    script_path: string;
+    is_flow: boolean;
+    args?: ScriptArgs;
+    extra_perms: Record<string, boolean>;
+    email: string;
+    error?: string;
+};

package/src/models/Script.d.ts

@@ -0,0 +1,43 @@
+export type Script = {
+    workspace_id?: string;
+    hash: string;
+    path: string;
+    /**
+     * The first element is the direct parent of the script, the second is the parent of the first, etc
+     *
+     */
+    parent_hashes?: Array<string>;
+    summary: string;
+    description: string;
+    content: string;
+    created_by: string;
+    created_at: string;
+    archived: boolean;
+    schema?: any;
+    deleted: boolean;
+    is_template: boolean;
+    extra_perms: Record<string, boolean>;
+    lock?: string;
+    lock_error_logs?: string;
+    language: Script.language;
+    kind: Script.kind;
+    starred: boolean;
+    tag?: string;
+    has_draft?: boolean;
+    draft_only?: boolean;
+};
+export declare namespace Script {
+    enum language {
+        PYTHON3 = "python3",
+        DENO = "deno",
+        GO = "go",
+        BASH = "bash"
+    }
+    enum kind {
+        SCRIPT = "script",
+        FAILURE = "failure",
+        TRIGGER = "trigger",
+        COMMAND = "command",
+        APPROVAL = "approval"
+    }
+}

package/src/models/ScriptArgs.d.ts

@@ -0,0 +1 @@
+export type ScriptArgs = Record<string, any>;

package/src/models/SlackToken.d.ts

@@ -0,0 +1,8 @@
+export type SlackToken = {
+    access_token: string;
+    team_id: string;
+    team_name: string;
+    bot: {
+        bot_access_token?: string;
+    };
+};

package/src/models/StaticTransform.d.ts

@@ -0,0 +1,4 @@
+export type StaticTransform = {
+    value?: any;
+    type: 'static';
+};

package/src/models/TokenResponse.d.ts

@@ -0,0 +1,6 @@
+export type TokenResponse = {
+    access_token: string;
+    expires_in?: number;
+    refresh_token?: string;
+    scope?: Array<string>;
+};

package/src/models/TruncatedToken.d.ts

@@ -0,0 +1,7 @@
+export type TruncatedToken = {
+    label?: string;
+    expiration?: string;
+    token_prefix: string;
+    created_at: string;
+    last_used_at: string;
+};

package/src/models/UpdateInput.d.ts

@@ -0,0 +1,5 @@
+export type UpdateInput = {
+    id: string;
+    name: string;
+    is_public: boolean;
+};

package/src/models/Usage.d.ts

@@ -0,0 +1,3 @@
+export type Usage = {
+    executions?: number;
+};

package/src/models/User.d.ts

@@ -0,0 +1,14 @@
+import type { Usage } from './Usage';
+export type User = {
+    email: string;
+    username: string;
+    is_admin: boolean;
+    is_super_admin: boolean;
+    created_at: string;
+    operator: boolean;
+    disabled: boolean;
+    groups?: Array<string>;
+    folders: Array<string>;
+    folders_owners: Array<string>;
+    usage?: Usage;
+};

package/src/models/UserWorkspaceList.d.ts

@@ -0,0 +1,8 @@
+export type UserWorkspaceList = {
+    email: string;
+    workspaces: Array<{
+        id: string;
+        name: string;
+        username: string;
+    }>;
+};

package/src/models/WorkerPing.d.ts

@@ -0,0 +1,8 @@
+export type WorkerPing = {
+    worker: string;
+    worker_instance: string;
+    last_ping?: number;
+    started_at: string;
+    ip: string;
+    jobs_executed: number;
+};

package/src/models/Workspace.d.ts

@@ -0,0 +1,6 @@
+export type Workspace = {
+    id: string;
+    name: string;
+    owner: string;
+    domain?: string;
+};

package/src/models/WorkspaceInvite.d.ts

@@ -0,0 +1,6 @@
+export type WorkspaceInvite = {
+    workspace_id: string;
+    email: string;
+    is_admin: boolean;
+    operator: boolean;
+};

package/src/services/AdminService.d.ts

@@ -0,0 +1,39 @@
+import type { EditWorkspaceUser } from '../models/EditWorkspaceUser';
+import type { NewUser } from '../models/NewUser';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AdminService {
+    /**
+     * create user (require admin privilege)
+     * @returns string user created
+     * @throws ApiError
+     */
+    static createUser({ workspace, requestBody, }: {
+        workspace: string;
+        /**
+         * new user
+         */
+        requestBody: NewUser;
+    }): CancelablePromise<string>;
+    /**
+     * update user (require admin privilege)
+     * @returns string edited user
+     * @throws ApiError
+     */
+    static updateUser({ workspace, username, requestBody, }: {
+        workspace: string;
+        username: string;
+        /**
+         * new user
+         */
+        requestBody: EditWorkspaceUser;
+    }): CancelablePromise<string>;
+    /**
+     * delete user (require admin privilege)
+     * @returns string delete user
+     * @throws ApiError
+     */
+    static deleteUser({ workspace, username, }: {
+        workspace: string;
+        username: string;
+    }): CancelablePromise<string>;
+}

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>;
+}