windmill-components 1.13.0

package/gen/models/AuditLog.d.ts

@@ -0,0 +1,32 @@
+export declare type AuditLog = {
+    id: number;
+    timestamp: string;
+    username: string;
+    operation: AuditLog.operation;
+    action_kind: AuditLog.action_kind;
+    resource?: string;
+    parameters?: any;
+};
+export declare namespace AuditLog {
+    enum operation {
+        JOBS_RUN = "jobs.run",
+        SCRIPTS_CREATE = "scripts.create",
+        SCRIPTS_UPDATE = "scripts.update",
+        USERS_CREATE = "users.create",
+        USERS_DELETE = "users.delete",
+        USERS_SETPASSWORD = "users.setpassword",
+        USERS_UPDATE = "users.update",
+        USERS_LOGIN = "users.login",
+        USERS_TOKEN_CREATE = "users.token.create",
+        USERS_TOKEN_DELETE = "users.token.delete",
+        VARIABLES_CREATE = "variables.create",
+        VARIABLES_DELETE = "variables.delete",
+        VARIABLES_UPDATE = "variables.update"
+    }
+    enum action_kind {
+        CREATED = "Created",
+        UPDATED = "Updated",
+        DELETE = "Delete",
+        EXECUTE = "Execute"
+    }
+}

package/gen/models/CompletedJob.d.ts

@@ -0,0 +1,48 @@
+import type { FlowStatus } from './FlowStatus';
+import type { FlowValue } from './FlowValue';
+import type { ScriptArgs } from './ScriptArgs';
+export declare type CompletedJob = {
+    workspace_id?: string;
+    id: string;
+    parent_job?: string;
+    created_by: string;
+    created_at: string;
+    started_at: string;
+    duration: number;
+    success: boolean;
+    script_path?: string;
+    script_hash?: string;
+    args?: ScriptArgs;
+    result?: any;
+    logs?: string;
+    deleted?: boolean;
+    raw_code?: string;
+    canceled: boolean;
+    canceled_by?: string;
+    canceled_reason?: string;
+    job_kind: CompletedJob.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?: CompletedJob.language;
+};
+export declare namespace CompletedJob {
+    enum job_kind {
+        SCRIPT = "script",
+        PREVIEW = "preview",
+        DEPENDENCIES = "dependencies",
+        FLOW = "flow",
+        FLOWPREVIEW = "flowpreview"
+    }
+    enum language {
+        PYTHON3 = "python3",
+        DENO = "deno"
+    }
+}

package/gen/models/ContextualVariable.d.ts

@@ -0,0 +1,5 @@
+export declare type ContextualVariable = {
+    name: string;
+    value: string;
+    description: string;
+};

package/gen/models/CreateResource.d.ts

@@ -0,0 +1,6 @@
+export declare type CreateResource = {
+    path: string;
+    value: any;
+    description?: string;
+    resource_type: string;
+};

package/gen/models/CreateVariable.d.ts

@@ -0,0 +1,6 @@
+export declare type CreateVariable = {
+    path: string;
+    value: string;
+    is_secret: boolean;
+    description: string;
+};

package/gen/models/CreateWorkspace.d.ts

@@ -0,0 +1,6 @@
+export declare type CreateWorkspace = {
+    id: string;
+    name: string;
+    username: string;
+    domain: string;
+};

package/gen/models/EditResource.d.ts

@@ -0,0 +1,5 @@
+export declare type EditResource = {
+    path?: string;
+    description?: string;
+    value?: any;
+};

package/gen/models/EditResourceType.d.ts

@@ -0,0 +1,4 @@
+export declare type EditResourceType = {
+    schema?: string;
+    description?: string;
+};

package/gen/models/EditSchedule.d.ts

@@ -0,0 +1,7 @@
+import type { ScriptArgs } from './ScriptArgs';
+export declare type EditSchedule = {
+    schedule: string;
+    script_path: string;
+    is_flow: boolean;
+    args: ScriptArgs;
+};

package/gen/models/EditVariable.d.ts

@@ -0,0 +1,6 @@
+export declare type EditVariable = {
+    path?: string;
+    value?: string;
+    is_secret?: boolean;
+    description?: string;
+};

package/gen/models/EditWorkspaceUser.d.ts

@@ -0,0 +1,3 @@
+export declare type EditWorkspaceUser = {
+    is_admin?: boolean;
+};

package/gen/models/Flow.d.ts

@@ -0,0 +1,13 @@
+import type { FlowValue } from './FlowValue';
+export declare type Flow = {
+    workspace_id?: string;
+    path: string;
+    summary: string;
+    description?: string;
+    value: FlowValue;
+    edited_by: string;
+    edited_at: string;
+    archived: boolean;
+    schema?: any;
+    extra_perms: Record<string, boolean>;
+};

package/gen/models/FlowModule.d.ts

@@ -0,0 +1,6 @@
+import type { FlowModuleValue } from './FlowModuleValue';
+import type { InputTransform } from './InputTransform';
+export declare type FlowModule = {
+    input_transform: Record<string, InputTransform>;
+    value: FlowModuleValue;
+};

package/gen/models/FlowModuleValue.d.ts

@@ -0,0 +1,10 @@
+export declare type FlowModuleValue = {
+    path: string;
+    type: FlowModuleValue.type;
+};
+export declare namespace FlowModuleValue {
+    enum type {
+        SCRIPT = "script",
+        FLOW = "flow"
+    }
+}

package/gen/models/FlowPreview.d.ts

@@ -0,0 +1,7 @@
+import type { FlowValue } from './FlowValue';
+import type { ScriptArgs } from './ScriptArgs';
+export declare type FlowPreview = {
+    value: FlowValue;
+    path?: string;
+    args: ScriptArgs;
+};

package/gen/models/FlowStatus.d.ts

@@ -0,0 +1,6 @@
+import type { FlowStatusModule } from './FlowStatusModule';
+export declare type FlowStatus = {
+    step: number;
+    modules: Array<FlowStatusModule>;
+    failure_module: FlowStatusModule;
+};

package/gen/models/FlowStatusModule.d.ts

@@ -0,0 +1,15 @@
+export declare type FlowStatusModule = {
+    type: FlowStatusModule.type;
+    job?: string;
+    event?: string;
+};
+export declare namespace FlowStatusModule {
+    enum type {
+        WAITING_FOR_PRIOR_STEPS = "WaitingForPriorSteps",
+        WAITING_FOR_EVENT = "WaitingForEvent",
+        WAITING_FOR_EXECUTOR = "WaitingForExecutor",
+        IN_PROGRESS = "InProgress",
+        SUCCESS = "Success",
+        FAILURE = "Failure"
+    }
+}

package/gen/models/FlowValue.d.ts

@@ -0,0 +1,5 @@
+import type { FlowModule } from './FlowModule';
+export declare type FlowValue = {
+    modules: Array<FlowModule>;
+    failure_module?: FlowModule;
+};

package/gen/models/GlobalUserInfo.d.ts

@@ -0,0 +1,14 @@
+export declare type GlobalUserInfo = {
+    email: string;
+    login_type: GlobalUserInfo.login_type;
+    super_admin: boolean;
+    verified: boolean;
+    name?: string;
+    company?: string;
+};
+export declare namespace GlobalUserInfo {
+    enum login_type {
+        PASSWORD = "password",
+        GITHUB = "github"
+    }
+}

package/gen/models/Group.d.ts

@@ -0,0 +1,6 @@
+export declare type Group = {
+    name: string;
+    summary?: string;
+    members?: Array<string>;
+    extra_perms?: Record<string, boolean>;
+};

package/gen/models/InputTransform.d.ts

@@ -0,0 +1,12 @@
+export declare type InputTransform = {
+    type?: InputTransform.type;
+    step?: number;
+    value?: any;
+    expr?: string;
+};
+export declare namespace InputTransform {
+    enum type {
+        STATIC = "static",
+        JAVASCRIPT = "javascript"
+    }
+}

package/gen/models/Job.d.ts

@@ -0,0 +1,11 @@
+import type { CompletedJob } from './CompletedJob';
+import type { QueuedJob } from './QueuedJob';
+export declare type Job = ((CompletedJob | QueuedJob) & {
+    type?: Job.type;
+});
+export declare namespace Job {
+    enum type {
+        COMPLETED_JOB = "CompletedJob",
+        QUEUED_JOB = "QueuedJob"
+    }
+}

package/gen/models/ListableVariable.d.ts

@@ -0,0 +1,8 @@
+export declare type ListableVariable = {
+    workspace_id: string;
+    path: string;
+    value?: string;
+    is_secret: boolean;
+    description?: string;
+    extra_perms: Record<string, boolean>;
+};

package/gen/models/Login.d.ts

@@ -0,0 +1,4 @@
+export declare type Login = {
+    email: string;
+    password: string;
+};

package/gen/models/MainArgSignature.d.ts

@@ -0,0 +1,14 @@
+export declare type MainArgSignature = {
+    star_args: boolean;
+    star_kwargs?: boolean;
+    args: Array<{
+        name: string;
+        typ: ('str' | 'float' | 'int' | 'bool' | 'email' | 'unknown' | {
+            resource: string;
+        } | {
+            list: 'str' | 'float' | 'int' | 'email';
+        });
+        has_default?: boolean;
+        default?: any;
+    }>;
+};

package/gen/models/NewSchedule.d.ts

@@ -0,0 +1,9 @@
+import type { ScriptArgs } from './ScriptArgs';
+export declare type NewSchedule = {
+    path: string;
+    schedule: string;
+    offset?: number;
+    script_path: string;
+    is_flow: boolean;
+    args: ScriptArgs;
+};

package/gen/models/NewToken.d.ts

@@ -0,0 +1,4 @@
+export declare type NewToken = {
+    label?: string;
+    expiration?: string;
+};

package/gen/models/NewUser.d.ts

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

package/gen/models/Preview.d.ts

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

package/gen/models/QueuedJob.d.ts

@@ -0,0 +1,47 @@
+import type { FlowStatus } from './FlowStatus';
+import type { FlowValue } from './FlowValue';
+import type { ScriptArgs } from './ScriptArgs';
+export declare 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;
+};
+export declare namespace QueuedJob {
+    enum job_kind {
+        SCRIPT = "script",
+        PREVIEW = "preview",
+        DEPENDENCIES = "dependencies",
+        FLOW = "flow",
+        FLOWPREVIEW = "flowpreview"
+    }
+    enum language {
+        PYTHON3 = "python3",
+        DENO = "deno"
+    }
+}

package/gen/models/Resource.d.ts

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

package/gen/models/ResourceType.d.ts

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

package/gen/models/Schedule.d.ts

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

package/gen/models/Script.d.ts

@@ -0,0 +1,29 @@
+export declare 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;
+};
+export declare namespace Script {
+    enum language {
+        PYTHON3 = "python3",
+        DENO = "deno"
+    }
+}

package/gen/models/ScriptArgs.d.ts

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

package/gen/models/TruncatedToken.d.ts

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

package/gen/models/User.d.ts

@@ -0,0 +1,10 @@
+export declare type User = {
+    email: string;
+    username: string;
+    is_admin: boolean;
+    is_super_admin: boolean;
+    created_at: string;
+    operator: boolean;
+    disabled: boolean;
+    groups?: Array<string>;
+};

package/gen/models/UserWorkspaceList.d.ts

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

package/gen/models/WorkerPing.d.ts

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

package/gen/models/Workspace.d.ts

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

package/gen/models/WorkspaceInvite.d.ts

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

package/gen/services/AdminService.d.ts

@@ -0,0 +1,35 @@
+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/gen/services/AuditService.d.ts

@@ -0,0 +1,37 @@
+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/gen/services/FlowService.d.ts

@@ -0,0 +1,82 @@
+import type { Flow } from '../models/Flow';
+import type { FlowValue } from '../models/FlowValue';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class FlowService {
+    /**
+     * list all available flows
+     * @returns Flow All available flow
+     * @throws ApiError
+     */
+    static listFlows({ workspace, page, perPage, orderDesc, createdBy, pathStart, pathExact, showArchived, }: {
+        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 parh **/
+        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;
+    }): CancelablePromise<Array<Flow>>;
+    /**
+     * get flow by path
+     * @returns Flow flow details
+     * @throws ApiError
+     */
+    static getFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<Flow>;
+    /**
+     * create flow
+     * @returns string flow created
+     * @throws ApiError
+     */
+    static createFlow({ workspace, requestBody, }: {
+        workspace: string;
+        /** Partially filled flow **/
+        requestBody: {
+            path: string;
+            summary: string;
+            description: string;
+            value: FlowValue;
+            schema?: any;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * update flow
+     * @returns string flow updated
+     * @throws ApiError
+     */
+    static updateFlow({ workspace, path, requestBody, }: {
+        workspace: string;
+        path: string;
+        /** Partially filled flow **/
+        requestBody: {
+            path: string;
+            summary: string;
+            description: string;
+            value: FlowValue;
+            schema?: any;
+        };
+    }): CancelablePromise<string>;
+    /**
+     * archive flow by path
+     * @returns string flow archived
+     * @throws ApiError
+     */
+    static archiveFlowByPath({ workspace, path, }: {
+        workspace: string;
+        path: string;
+    }): CancelablePromise<string>;
+}