windmill-client 1.769.0 → 1.771.0

package/dist/types.gen.d.ts

@@ -1480,6 +1480,48 @@ export type NewWorkspaceDependencies = {
     description?: string;
     content: string;
 };
+/**
+ * A row in the merged runnables listing. `type` is the discriminator;
+ * kind-specific fields (hash/language/kind for scripts, execution_mode/
+ * version for apps) are present only for that kind. `edited_at` is the
+ * unified last-updated time (a script's created_at, a flow/app's edit
+ * time).
+ *
+ */
+export type RunnableItem = {
+    type: 'script' | 'flow' | 'app';
+    path: string;
+    summary?: string;
+    workspace_id?: string;
+    extra_perms?: {
+        [key: string]: (boolean);
+    };
+    starred?: boolean;
+    archived?: boolean;
+    is_draft?: boolean;
+    draft_only?: boolean | null;
+    draft_path?: string;
+    draft_users?: Array<{
+        [key: string]: unknown;
+    }>;
+    labels?: Array<(string)>;
+    inherited_labels?: Array<(string)>;
+    ws_error_handler_muted?: boolean;
+    edited_at?: string;
+    /**
+     * script version hash as a 16-char hex string
+     */
+    hash?: string;
+    language?: string;
+    kind?: string;
+    auto_kind?: string;
+    use_codebase?: boolean;
+    has_deploy_errors?: boolean;
+    raw_app?: boolean;
+    execution_mode?: string;
+    id?: number;
+    version?: number;
+};
 export type Script = {
     workspace_id?: string;
     hash: string;
@@ -1730,6 +1772,20 @@ export type CompletedJob = {
     aggregate_wait_time_ms?: number;
     preprocessed?: boolean;
     is_retry?: boolean;
+    /**
+     * whether this failure has been marked as handled
+     */
+    resolved?: boolean;
+    /**
+     * who resolved the failure. Enterprise-only, so also absent for a manual resolution outside enterprise; use resolved_automatically to tell the two apart
+     */
+    resolved_by?: string;
+    resolved_at?: string;
+    resolution_note?: string;
+    /**
+     * true when a succeeding retry resolved this rather than a person. Explicit rather than inferred from an absent resolved_by, which is also absent for a manual resolution outside enterprise
+     */
+    resolved_automatically?: boolean;
     worker?: string;
 };
 /**
@@ -6173,6 +6229,18 @@ export type PipelineRecordingBody = {
         [key: string]: unknown;
     };
 };
+export type ProjectLogoBody = {
+    /**
+     * the logo to set, or null to clear the project's current logo
+     */
+    logo: {
+        /**
+         * base64-encoded image bytes (decoded size max 512KB)
+         */
+        b64: string;
+        mime: 'image/png' | 'image/svg+xml';
+    } | null;
+};
 export type PublishResourceTypeBody = {
     name: string;
     schema?: {
@@ -10418,6 +10486,47 @@ export type DiffRawScriptsWithDeployedData = {
     workspace: string;
 };
 export type DiffRawScriptsWithDeployedResponse = Array<(string)>;
+export type ListRunnablesData = {
+    /**
+     * opaque keyset cursor from a previous page's next_cursor
+     */
+    cursor?: string;
+    /**
+     * include library scripts (no runnable main)
+     */
+    includeWithoutMain?: boolean;
+    /**
+     * comma-separated subset of script,flow,app (default all)
+     */
+    kinds?: string;
+    label?: string;
+    /**
+     * sort key: 'updated' (default) or 'name'
+     */
+    orderBy?: 'updated' | 'name';
+    /**
+     * order by desc order (default true)
+     */
+    orderDesc?: boolean;
+    /**
+     * restrict to paths under this prefix
+     */
+    pathStart?: string;
+    /**
+     * number of items to return for a given page (default 30, max 100)
+     */
+    perPage?: number;
+    /**
+     * case-insensitive substring match on summary or path
+     */
+    search?: string;
+    showArchived?: boolean;
+    workspace: string;
+};
+export type ListRunnablesResponse = {
+    items: Array<RunnableItem>;
+    next_cursor?: string;
+};
 export type ListDraftsData = {
     /**
      * List every draft in the workspace (all users), not just the current user's own + legacy rows. Other users' rows come back with `mine=false` (view-only).
@@ -11808,6 +11917,10 @@ export type ListFilteredJobsUuidsData = {
      * number of items to return for a given page (default 30, max 100)
      */
     perPage?: number;
+    /**
+     * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+     */
+    resolved?: boolean;
     /**
      * filter on jobs containing those result as a json subset (@> in postgres)
      */
@@ -12030,6 +12143,10 @@ export type ListCompletedJobsData = {
      * number of items to return for a given page (default 30, max 100)
      */
     perPage?: number;
+    /**
+     * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+     */
+    resolved?: boolean;
     /**
      * filter on jobs containing those result as a json subset (@> in postgres)
      */
@@ -12197,6 +12314,10 @@ export type ListJobsData = {
      * number of items to return for a given page (default 30, max 100)
      */
     perPage?: number;
+    /**
+     * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+     */
+    resolved?: boolean;
     /**
      * filter on jobs containing those result as a json subset (@> in postgres)
      */
@@ -12479,6 +12600,28 @@ export type DeleteCompletedJobData = {
     workspace: string;
 };
 export type DeleteCompletedJobResponse = CompletedJob;
+export type ResolveCompletedJobsData = {
+    requestBody: {
+        job_ids: Array<(string)>;
+        /**
+         * a person's explanation of why the failure is considered handled. Enterprise-only: ignored outside enterprise
+         */
+        note?: string;
+        /**
+         * id of a later successful run of the same runnable that supersedes the failure. Verified server-side, and the resulting note is the server's own wording, so it is recorded regardless of licence. A claim that cannot be verified resolves nothing
+         */
+        superseded_by?: string;
+    };
+    workspace: string;
+};
+export type ResolveCompletedJobsResponse = Array<(string)>;
+export type UnresolveCompletedJobsData = {
+    requestBody: {
+        job_ids: Array<(string)>;
+    };
+    workspace: string;
+};
+export type UnresolveCompletedJobsResponse = Array<(string)>;
 export type CancelQueuedJobData = {
     id: string;
     /**
@@ -12549,6 +12692,20 @@ export type GetResumeUrlsResponse = {
     resume: string;
     cancel: string;
 };
+export type GetWacApprovalUrlsData = {
+    approver?: string;
+    id: string;
+    /**
+     * checkpoint key of the wait_for_approval step, as passed to `wait_for_approval(key=...)`
+     */
+    stepKey: string;
+    workspace: string;
+};
+export type GetWacApprovalUrlsResponse = {
+    approvalPage: string;
+    resume: string;
+    cancel: string;
+};
 export type GetSlackApprovalPayloadData = {
     approver?: string;
     cancelButtonText?: string;
@@ -12796,6 +12953,10 @@ export type ListExtendedJobsData = {
      * number of items to return for a given page (default 30, max 100)
      */
     perPage?: number;
+    /**
+     * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+     */
+    resolved?: boolean;
     /**
      * filter on jobs containing those result as a json subset (@> in postgres)
      */
@@ -14727,6 +14888,14 @@ export type ListFolderNamesData = {
      * only list the folders the user is member of (default false)
      */
     onlyMemberOf?: boolean;
+    /**
+     * 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;
     workspace: string;
 };
 export type ListFolderNamesResponse = Array<(string)>;
@@ -15197,6 +15366,10 @@ export type S3ResourceInfoData = {
 };
 export type S3ResourceInfoResponse = S3Resource;
 export type DatasetStorageTestConnectionData = {
+    /**
+     * When set, test the connection of this object storage resource instead of the workspace storage
+     */
+    s3ResourcePath?: string;
     storage?: string;
     workspace: string;
 };
@@ -15224,6 +15397,10 @@ export type ListStoredFilesData = {
     marker?: string;
     maxKeys: number;
     prefix?: string;
+    /**
+     * When set, list the files of this object storage resource instead of the workspace storage
+     */
+    s3ResourcePath?: string;
     storage?: string;
     workspace: string;
 };
@@ -15234,6 +15411,10 @@ export type ListStoredFilesResponse = {
 };
 export type LoadFileMetadataData = {
     fileKey: string;
+    /**
+     * When set, load the file metadata from this object storage resource instead of the workspace storage
+     */
+    s3ResourcePath?: string;
     storage?: string;
     workspace: string;
 };
@@ -15246,6 +15427,10 @@ export type LoadFilePreviewData = {
     fileSizeInBytes?: number;
     readBytesFrom?: number;
     readBytesLength?: number;
+    /**
+     * When set, load the file preview from this object storage resource instead of the workspace storage
+     */
+    s3ResourcePath?: string;
     storage?: string;
     workspace: string;
 };
@@ -15341,12 +15526,20 @@ export type LoadCsvPreviewData = {
 export type LoadCsvPreviewResponse = unknown;
 export type DeleteS3FileData = {
     fileKey: string;
+    /**
+     * When set, delete the file from this object storage resource instead of the workspace storage
+     */
+    s3ResourcePath?: string;
     storage?: string;
     workspace: string;
 };
 export type DeleteS3FileResponse = unknown;
 export type MoveS3FileData = {
     destFileKey: string;
+    /**
+     * When set, move the file within this object storage resource instead of the workspace storage
+     */
+    s3ResourcePath?: string;
     srcFileKey: string;
     storage?: string;
     workspace: string;
@@ -15974,6 +16167,22 @@ export type PublishHubRawAppEmbedData = {
     workspace: string;
 };
 export type PublishHubRawAppEmbedResponse = string;
+export type PublishHubRawAppRecordingData = {
+    /**
+     * workspace folder scoping the Hub publication: a workspace can publish
+     * one Hub project per folder and the Hub-side source key is
+     * `{workspace}:{folder}`
+     *
+     */
+    folder: string;
+    /**
+     * hub id of the raw app
+     */
+    id: number;
+    requestBody: RecordingBody;
+    workspace: string;
+};
+export type PublishHubRawAppRecordingResponse = string;
 export type PublishHubScriptRecordingData = {
     /**
      * hub ask id of the script
@@ -16082,6 +16291,22 @@ export type GetHubProjectExportData = {
     workspace: string;
 };
 export type GetHubProjectExportResponse = string;
+export type PublishHubProjectLogoData = {
+    /**
+     * workspace folder scoping the Hub publication: a workspace can publish
+     * one Hub project per folder and the Hub-side source key is
+     * `{workspace}:{folder}`
+     *
+     */
+    folder: string;
+    requestBody: ProjectLogoBody;
+    /**
+     * hub project slug
+     */
+    slug: HubProjectSlug;
+    workspace: string;
+};
+export type PublishHubProjectLogoResponse = string;
 export type SubmitHubProjectData = {
     /**
      * workspace folder scoping the Hub publication: a workspace can publish
@@ -23688,6 +23913,56 @@ export type $OpenApiTs = {
             };
         };
     };
+    '/w/{workspace}/runnables/list': {
+        get: {
+            req: {
+                /**
+                 * opaque keyset cursor from a previous page's next_cursor
+                 */
+                cursor?: string;
+                /**
+                 * include library scripts (no runnable main)
+                 */
+                includeWithoutMain?: boolean;
+                /**
+                 * comma-separated subset of script,flow,app (default all)
+                 */
+                kinds?: string;
+                label?: string;
+                /**
+                 * sort key: 'updated' (default) or 'name'
+                 */
+                orderBy?: 'updated' | 'name';
+                /**
+                 * order by desc order (default true)
+                 */
+                orderDesc?: boolean;
+                /**
+                 * restrict to paths under this prefix
+                 */
+                pathStart?: string;
+                /**
+                 * number of items to return for a given page (default 30, max 100)
+                 */
+                perPage?: number;
+                /**
+                 * case-insensitive substring match on summary or path
+                 */
+                search?: string;
+                showArchived?: boolean;
+                workspace: string;
+            };
+            res: {
+                /**
+                 * a page of merged, ordered runnables
+                 */
+                200: {
+                    items: Array<RunnableItem>;
+                    next_cursor?: string;
+                };
+            };
+        };
+    };
     '/w/{workspace}/drafts/list': {
         get: {
             req: {
@@ -25594,6 +25869,10 @@ export type $OpenApiTs = {
                  * number of items to return for a given page (default 30, max 100)
                  */
                 perPage?: number;
+                /**
+                 * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+                 */
+                resolved?: boolean;
                 /**
                  * filter on jobs containing those result as a json subset (@> in postgres)
                  */
@@ -25852,6 +26131,10 @@ export type $OpenApiTs = {
                  * number of items to return for a given page (default 30, max 100)
                  */
                 perPage?: number;
+                /**
+                 * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+                 */
+                resolved?: boolean;
                 /**
                  * filter on jobs containing those result as a json subset (@> in postgres)
                  */
@@ -26073,6 +26356,10 @@ export type $OpenApiTs = {
                  * number of items to return for a given page (default 30, max 100)
                  */
                 perPage?: number;
+                /**
+                 * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+                 */
+                resolved?: boolean;
                 /**
                  * filter on jobs containing those result as a json subset (@> in postgres)
                  */
@@ -26551,6 +26838,46 @@ export type $OpenApiTs = {
             };
         };
     };
+    '/w/{workspace}/jobs/completed/resolve': {
+        post: {
+            req: {
+                requestBody: {
+                    job_ids: Array<(string)>;
+                    /**
+                     * a person's explanation of why the failure is considered handled. Enterprise-only: ignored outside enterprise
+                     */
+                    note?: string;
+                    /**
+                     * id of a later successful run of the same runnable that supersedes the failure. Verified server-side, and the resulting note is the server's own wording, so it is recorded regardless of licence. A claim that cannot be verified resolves nothing
+                     */
+                    superseded_by?: string;
+                };
+                workspace: string;
+            };
+            res: {
+                /**
+                 * ids of the jobs that were resolved
+                 */
+                200: Array<(string)>;
+            };
+        };
+    };
+    '/w/{workspace}/jobs/completed/unresolve': {
+        post: {
+            req: {
+                requestBody: {
+                    job_ids: Array<(string)>;
+                };
+                workspace: string;
+            };
+            res: {
+                /**
+                 * ids of the jobs that were unresolved
+                 */
+                200: Array<(string)>;
+            };
+        };
+    };
     '/w/{workspace}/jobs_u/queue/cancel/{id}': {
         post: {
             req: {
@@ -26684,6 +27011,29 @@ export type $OpenApiTs = {
             };
         };
     };
+    '/w/{workspace}/jobs/wac_approval_urls/{id}/{step_key}': {
+        get: {
+            req: {
+                approver?: string;
+                id: string;
+                /**
+                 * checkpoint key of the wait_for_approval step, as passed to `wait_for_approval(key=...)`
+                 */
+                stepKey: string;
+                workspace: string;
+            };
+            res: {
+                /**
+                 * url endpoints
+                 */
+                200: {
+                    approvalPage: string;
+                    resume: string;
+                    cancel: string;
+                };
+            };
+        };
+    };
     '/w/{workspace}/jobs/slack_approval/{id}': {
         get: {
             req: {
@@ -27035,6 +27385,10 @@ export type $OpenApiTs = {
                  * number of items to return for a given page (default 30, max 100)
                  */
                 perPage?: number;
+                /**
+                 * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
+                 */
+                resolved?: boolean;
                 /**
                  * filter on jobs containing those result as a json subset (@> in postgres)
                  */
@@ -30514,6 +30868,14 @@ export type $OpenApiTs = {
                  * only list the folders the user is member of (default false)
                  */
                 onlyMemberOf?: boolean;
+                /**
+                 * 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;
                 workspace: string;
             };
             res: {
@@ -31416,6 +31778,10 @@ export type $OpenApiTs = {
     '/w/{workspace}/job_helpers/test_connection': {
         get: {
             req: {
+                /**
+                 * When set, test the connection of this object storage resource instead of the workspace storage
+                 */
+                s3ResourcePath?: string;
                 storage?: string;
                 workspace: string;
             };
@@ -31461,6 +31827,10 @@ export type $OpenApiTs = {
                 marker?: string;
                 maxKeys: number;
                 prefix?: string;
+                /**
+                 * When set, list the files of this object storage resource instead of the workspace storage
+                 */
+                s3ResourcePath?: string;
                 storage?: string;
                 workspace: string;
             };
@@ -31480,6 +31850,10 @@ export type $OpenApiTs = {
         get: {
             req: {
                 fileKey: string;
+                /**
+                 * When set, load the file metadata from this object storage resource instead of the workspace storage
+                 */
+                s3ResourcePath?: string;
                 storage?: string;
                 workspace: string;
             };
@@ -31501,6 +31875,10 @@ export type $OpenApiTs = {
                 fileSizeInBytes?: number;
                 readBytesFrom?: number;
                 readBytesLength?: number;
+                /**
+                 * When set, load the file preview from this object storage resource instead of the workspace storage
+                 */
+                s3ResourcePath?: string;
                 storage?: string;
                 workspace: string;
             };
@@ -31668,6 +32046,10 @@ export type $OpenApiTs = {
         delete: {
             req: {
                 fileKey: string;
+                /**
+                 * When set, delete the file from this object storage resource instead of the workspace storage
+                 */
+                s3ResourcePath?: string;
                 storage?: string;
                 workspace: string;
             };
@@ -31683,6 +32065,10 @@ export type $OpenApiTs = {
         get: {
             req: {
                 destFileKey: string;
+                /**
+                 * When set, move the file within this object storage resource instead of the workspace storage
+                 */
+                s3ResourcePath?: string;
                 srcFileKey: string;
                 storage?: string;
                 workspace: string;
@@ -32696,6 +33082,31 @@ export type $OpenApiTs = {
             };
         };
     };
+    '/w/{workspace}/hub/raw_apps/{id}/recording': {
+        post: {
+            req: {
+                /**
+                 * workspace folder scoping the Hub publication: a workspace can publish
+                 * one Hub project per folder and the Hub-side source key is
+                 * `{workspace}:{folder}`
+                 *
+                 */
+                folder: string;
+                /**
+                 * hub id of the raw app
+                 */
+                id: number;
+                requestBody: RecordingBody;
+                workspace: string;
+            };
+            res: {
+                /**
+                 * raw Hub response body (status code is passed through from the Hub)
+                 */
+                200: string;
+            };
+        };
+    };
     '/w/{workspace}/hub/scripts/{ask_id}/recording': {
         post: {
             req: {
@@ -32876,6 +33287,31 @@ export type $OpenApiTs = {
             };
         };
     };
+    '/w/{workspace}/hub/projects/{slug}/logo': {
+        post: {
+            req: {
+                /**
+                 * workspace folder scoping the Hub publication: a workspace can publish
+                 * one Hub project per folder and the Hub-side source key is
+                 * `{workspace}:{folder}`
+                 *
+                 */
+                folder: string;
+                requestBody: ProjectLogoBody;
+                /**
+                 * hub project slug
+                 */
+                slug: HubProjectSlug;
+                workspace: string;
+            };
+            res: {
+                /**
+                 * raw Hub response body (status code is passed through from the Hub)
+                 */
+                200: string;
+            };
+        };
+    };
     '/w/{workspace}/hub/projects/{slug}/submit': {
         post: {
             req: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "windmill-client",
   "description": "Windmill SDK client for browsers and Node.js",
-  "version": "1.769.0",
+  "version": "1.771.0",
   "author": "Ruben Fiszel",
   "license": "Apache 2.0",
   "homepage": "https://github.com/windmill-labs/windmill/tree/main/typescript-client#readme",