windmill-client 1.519.2 → 1.520.1

package/dist/core/OpenAPI.js

@@ -39,7 +39,7 @@ exports.OpenAPI = {
     PASSWORD: undefined,
     TOKEN: getEnv("WM_TOKEN"),
     USERNAME: undefined,
-    VERSION: '1.519.2',
+    VERSION: '1.520.1',
     WITH_CREDENTIALS: true,
     interceptors: {
         request: new Interceptors(),

package/dist/services.gen.d.ts

@@ -1147,7 +1147,7 @@ export declare class VariableService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.requestBody new variable
-     * @param data.alreadyEncrypted
+     * @param data.alreadyEncrypted whether the variable is already encrypted (default false)
      * @returns string variable created
      * @throws ApiError
      */
@@ -1176,7 +1176,7 @@ export declare class VariableService {
      * @param data.workspace
      * @param data.path
      * @param data.requestBody updated variable
-     * @param data.alreadyEncrypted
+     * @param data.alreadyEncrypted whether the variable is already encrypted (default false)
      * @returns string variable updated
      * @throws ApiError
      */
@@ -1217,7 +1217,7 @@ export declare class VariableService {
      * list variables
      * @param data The data for the request.
      * @param data.workspace
-     * @param data.pathStart
+     * @param data.pathStart filter variables by path prefix
      * @param data.page which page to return (start at 1, default 1)
      * @param data.perPage number of items to return for a given page (default 30, max 100)
      * @returns ListableVariable variable list
@@ -1357,7 +1357,7 @@ export declare class ResourceService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.requestBody new resource
-     * @param data.updateIfExists
+     * @param data.updateIfExists update the resource if it already exists (default false)
      * @returns string resource created
      * @throws ApiError
      */
@@ -1436,7 +1436,7 @@ export declare class ResourceService {
      * @param data.perPage number of items to return for a given page (default 30, max 100)
      * @param data.resourceType resource_types to list from, separated by ',',
      * @param data.resourceTypeExclude resource_types to not list from, separated by ',',
-     * @param data.pathStart
+     * @param data.pathStart filter resources by path prefix
      * @returns ListableResource resource list
      * @throws ApiError
      */
@@ -2929,6 +2929,7 @@ export declare class JobService {
      * @param data.id
      * @param data.running
      * @param data.logOffset
+     * @param data.streamOffset
      * @param data.getProgress
      * @param data.onlyResult
      * @param data.noLogs
@@ -3352,8 +3353,8 @@ export declare class ScheduleService {
      * @param data.perPage number of items to return for a given page (default 30, max 100)
      * @param data.args filter on jobs containing those args as a json subset (@> in postgres)
      * @param data.path filter by path
-     * @param data.isFlow
-     * @param data.pathStart
+     * @param data.isFlow filter schedules by whether they target a flow
+     * @param data.pathStart filter schedules by path prefix
      * @returns Schedule schedule list
      * @throws ApiError
      */
@@ -4066,7 +4067,7 @@ export declare class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @returns PublicationData postgres publication get
      * @throws ApiError
      */
@@ -4076,7 +4077,7 @@ export declare class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @param data.requestBody new publication for postgres
      * @returns string publication created
      * @throws ApiError
@@ -4087,7 +4088,7 @@ export declare class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @param data.requestBody update publication for postgres
      * @returns string publication updated
      * @throws ApiError
@@ -4098,7 +4099,7 @@ export declare class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @returns string postgres publication deleted
      * @throws ApiError
      */

package/dist/services.gen.js

@@ -2280,7 +2280,7 @@ class VariableService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.requestBody new variable
-     * @param data.alreadyEncrypted
+     * @param data.alreadyEncrypted whether the variable is already encrypted (default false)
      * @returns string variable created
      * @throws ApiError
      */
@@ -2341,7 +2341,7 @@ class VariableService {
      * @param data.workspace
      * @param data.path
      * @param data.requestBody updated variable
-     * @param data.alreadyEncrypted
+     * @param data.alreadyEncrypted whether the variable is already encrypted (default false)
      * @returns string variable updated
      * @throws ApiError
      */
@@ -2427,7 +2427,7 @@ class VariableService {
      * list variables
      * @param data The data for the request.
      * @param data.workspace
-     * @param data.pathStart
+     * @param data.pathStart filter variables by path prefix
      * @param data.page which page to return (start at 1, default 1)
      * @param data.perPage number of items to return for a given page (default 30, max 100)
      * @returns ListableVariable variable list
@@ -2704,7 +2704,7 @@ class ResourceService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.requestBody new resource
-     * @param data.updateIfExists
+     * @param data.updateIfExists update the resource if it already exists (default false)
      * @returns string resource created
      * @throws ApiError
      */
@@ -2866,7 +2866,7 @@ class ResourceService {
      * @param data.perPage number of items to return for a given page (default 30, max 100)
      * @param data.resourceType resource_types to list from, separated by ',',
      * @param data.resourceTypeExclude resource_types to not list from, separated by ',',
-     * @param data.pathStart
+     * @param data.pathStart filter resources by path prefix
      * @returns ListableResource resource list
      * @throws ApiError
      */
@@ -5867,6 +5867,7 @@ class JobService {
      * @param data.id
      * @param data.running
      * @param data.logOffset
+     * @param data.streamOffset
      * @param data.getProgress
      * @param data.onlyResult
      * @param data.noLogs
@@ -5884,6 +5885,7 @@ class JobService {
             query: {
                 running: data.running,
                 log_offset: data.logOffset,
+                stream_offset: data.streamOffset,
                 get_progress: data.getProgress,
                 only_result: data.onlyResult,
                 no_logs: data.noLogs
@@ -6745,8 +6747,8 @@ class ScheduleService {
      * @param data.perPage number of items to return for a given page (default 30, max 100)
      * @param data.args filter on jobs containing those args as a json subset (@> in postgres)
      * @param data.path filter by path
-     * @param data.isFlow
-     * @param data.pathStart
+     * @param data.isFlow filter schedules by whether they target a flow
+     * @param data.pathStart filter schedules by path prefix
      * @returns Schedule schedule list
      * @throws ApiError
      */
@@ -8221,7 +8223,7 @@ class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @returns PublicationData postgres publication get
      * @throws ApiError
      */
@@ -8241,7 +8243,7 @@ class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @param data.requestBody new publication for postgres
      * @returns string publication created
      * @throws ApiError
@@ -8264,7 +8266,7 @@ class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @param data.requestBody update publication for postgres
      * @returns string publication updated
      * @throws ApiError
@@ -8287,7 +8289,7 @@ class PostgresTriggerService {
      * @param data The data for the request.
      * @param data.workspace
      * @param data.path
-     * @param data.publication
+     * @param data.publication The name of the publication
      * @returns string postgres publication deleted
      * @throws ApiError
      */

package/dist/types.gen.d.ts

@@ -319,6 +319,9 @@ export type ScriptHistory = {
     script_hash: string;
     deployment_msg?: string;
 };
+/**
+ * The arguments to pass to the script or flow
+ */
 export type ScriptArgs = {
     [key: string]: unknown;
 };
@@ -509,18 +512,51 @@ export type ContextualVariable = {
     is_custom: boolean;
 };
 export type CreateVariable = {
+    /**
+     * The path to the variable
+     */
     path: string;
+    /**
+     * The value of the variable
+     */
     value: string;
+    /**
+     * Whether the variable is a secret
+     */
     is_secret: boolean;
+    /**
+     * The description of the variable
+     */
     description: string;
+    /**
+     * The account identifier
+     */
     account?: number;
+    /**
+     * Whether the variable is an OAuth variable
+     */
     is_oauth?: boolean;
+    /**
+     * The expiration date of the variable
+     */
     expires_at?: string;
 };
 export type EditVariable = {
+    /**
+     * The path to the variable
+     */
     path?: string;
+    /**
+     * The new value of the variable
+     */
     value?: string;
+    /**
+     * Whether the variable is a secret
+     */
     is_secret?: boolean;
+    /**
+     * The new description of the variable
+     */
     description?: string;
 };
 export type AuditLog = {
@@ -592,15 +628,34 @@ export type WorkflowStatus = {
     name?: string;
 };
 export type CreateResource = {
+    /**
+     * The path to the resource
+     */
     path: string;
     value: unknown;
+    /**
+     * The description of the resource
+     */
     description?: string;
+    /**
+     * The resource_type associated with the resource
+     */
     resource_type: string;
 };
 export type EditResource = {
+    /**
+     * The path to the resource
+     */
     path?: string;
+    /**
+     * The new description of the resource
+     */
     description?: string;
     value?: unknown;
+    /**
+     * The new resource_type to be associated with the resource
+     */
+    resource_type?: string;
 };
 export type Resource = {
     workspace_id?: string;
@@ -686,52 +741,185 @@ export type ScheduleWJobs = Schedule & {
         duration_ms: number;
     }>;
 };
+export type ErrorHandler = 'custom' | 'slack' | 'teams' | 'email';
 export type NewSchedule = {
+    /**
+     * The path where the schedule will be created
+     */
     path: string;
+    /**
+     * The cron schedule to trigger the script or flow. Should include seconds.
+     */
     schedule: string;
+    /**
+     * The timezone to use for the cron schedule
+     */
     timezone: string;
+    /**
+     * The path to the script or flow to trigger
+     */
     script_path: string;
+    /**
+     * Whether the schedule is for a flow
+     */
     is_flow: boolean;
+    /**
+     * The arguments to pass to the script or flow
+     */
     args: ScriptArgs;
+    /**
+     * Whether the schedule is enabled
+     */
     enabled?: boolean;
+    /**
+     * The path to the script or flow to trigger on failure
+     */
     on_failure?: string;
+    /**
+     * The number of times to retry on failure
+     */
     on_failure_times?: number;
+    /**
+     * Whether the schedule should only run on the exact time
+     */
     on_failure_exact?: boolean;
+    /**
+     * The arguments to pass to the script or flow on failure
+     */
     on_failure_extra_args?: ScriptArgs;
+    /**
+     * The path to the script or flow to trigger on recovery
+     */
     on_recovery?: string;
+    /**
+     * The number of times to retry on recovery
+     */
     on_recovery_times?: number;
+    /**
+     * The arguments to pass to the script or flow on recovery
+     */
     on_recovery_extra_args?: ScriptArgs;
+    /**
+     * The path to the script or flow to trigger on success
+     */
     on_success?: string;
+    /**
+     * The arguments to pass to the script or flow on success
+     */
     on_success_extra_args?: ScriptArgs;
+    /**
+     * Whether the WebSocket error handler is muted
+     */
     ws_error_handler_muted?: boolean;
+    /**
+     * The retry configuration for the schedule
+     */
     retry?: Retry;
+    /**
+     * Whether the schedule should not run if a flow is already running
+     */
     no_flow_overlap?: boolean;
+    /**
+     * The summary of the schedule
+     */
     summary?: string;
+    /**
+     * The description of the schedule
+     */
     description?: string;
+    /**
+     * The tag of the schedule
+     */
     tag?: string;
+    /**
+     * The date and time the schedule will be paused until
+     */
     paused_until?: string;
+    /**
+     * The version of the cron schedule to use (last is v2)
+     */
     cron_version?: string;
 };
 export type EditSchedule = {
+    /**
+     * The cron schedule to trigger the script or flow. Should include seconds.
+     */
     schedule: string;
+    /**
+     * The timezone to use for the cron schedule
+     */
     timezone: string;
+    /**
+     * The arguments to pass to the script or flow
+     */
     args: ScriptArgs;
+    /**
+     * The path to the script or flow to trigger on failure
+     */
     on_failure?: string;
+    /**
+     * The number of times to retry on failure
+     */
     on_failure_times?: number;
+    /**
+     * Whether the schedule should only run on the exact time
+     */
     on_failure_exact?: boolean;
+    /**
+     * The arguments to pass to the script or flow on failure
+     */
     on_failure_extra_args?: ScriptArgs;
+    /**
+     * The path to the script or flow to trigger on recovery
+     */
     on_recovery?: string;
+    /**
+     * The number of times to retry on recovery
+     */
     on_recovery_times?: number;
+    /**
+     * The arguments to pass to the script or flow on recovery
+     */
     on_recovery_extra_args?: ScriptArgs;
+    /**
+     * The path to the script or flow to trigger on success
+     */
     on_success?: string;
+    /**
+     * The arguments to pass to the script or flow on success
+     */
     on_success_extra_args?: ScriptArgs;
+    /**
+     * Whether the WebSocket error handler is muted
+     */
     ws_error_handler_muted?: boolean;
+    /**
+     * The retry configuration for the schedule
+     */
     retry?: Retry;
+    /**
+     * Whether the schedule should not run if a flow is already running
+     */
     no_flow_overlap?: boolean;
+    /**
+     * The summary of the schedule
+     */
     summary?: string;
+    /**
+     * The description of the schedule
+     */
     description?: string;
+    /**
+     * The tag of the schedule
+     */
     tag?: string;
+    /**
+     * The date and time the schedule will be paused until
+     */
     paused_until?: string;
+    /**
+     * The version of the cron schedule to use (last is v2)
+     */
     cron_version?: string;
 };
 export type TriggerExtraProperty = {
@@ -1772,6 +1960,9 @@ export type Asset = {
 export type ParameterId = string;
 export type ParameterKey = string;
 export type ParameterWorkspaceId = string;
+/**
+ * The name of the publication
+ */
 export type ParameterPublicationName = string;
 export type ParameterVersionId = number;
 export type ParameterToken = string;
@@ -2954,6 +3145,9 @@ export type GetOidcTokenData = {
 };
 export type GetOidcTokenResponse = string;
 export type CreateVariableData = {
+    /**
+     * whether the variable is already encrypted (default false)
+     */
     alreadyEncrypted?: boolean;
     /**
      * new variable
@@ -2976,6 +3170,9 @@ export type DeleteVariableData = {
 };
 export type DeleteVariableResponse = string;
 export type UpdateVariableData = {
+    /**
+     * whether the variable is already encrypted (default false)
+     */
     alreadyEncrypted?: boolean;
     path: string;
     /**
@@ -3016,6 +3213,9 @@ export type ListVariableData = {
      * which page to return (start at 1, default 1)
      */
     page?: number;
+    /**
+     * filter variables by path prefix
+     */
     pathStart?: string;
     /**
      * number of items to return for a given page (default 30, max 100)
@@ -3184,6 +3384,9 @@ export type CreateResourceData = {
      * new resource
      */
     requestBody: CreateResource;
+    /**
+     * update the resource if it already exists (default false)
+     */
     updateIfExists?: boolean;
     workspace: string;
 };
@@ -3242,6 +3445,9 @@ export type ListResourceData = {
      * which page to return (start at 1, default 1)
      */
     page?: number;
+    /**
+     * filter resources by path prefix
+     */
     pathStart?: string;
     /**
      * number of items to return for a given page (default 30, max 100)
@@ -5282,6 +5488,7 @@ export type GetJobUpdatesSseData = {
     noLogs?: boolean;
     onlyResult?: boolean;
     running?: boolean;
+    streamOffset?: number;
     workspace: string;
 };
 export type GetJobUpdatesSseResponse = string;
@@ -5730,6 +5937,9 @@ export type ListSchedulesData = {
      * filter on jobs containing those args as a json subset (@> in postgres)
      */
     args?: string;
+    /**
+     * filter schedules by whether they target a flow
+     */
     isFlow?: boolean;
     /**
      * which page to return (start at 1, default 1)
@@ -5739,6 +5949,9 @@ export type ListSchedulesData = {
      * filter by path
      */
     path?: string;
+    /**
+     * filter schedules by path prefix
+     */
     pathStart?: string;
     /**
      * number of items to return for a given page (default 30, max 100)
@@ -6378,12 +6591,18 @@ export type ListPostgresPublicationData = {
 export type ListPostgresPublicationResponse = Array<(string)>;
 export type GetPostgresPublicationData = {
     path: string;
+    /**
+     * The name of the publication
+     */
     publication: string;
     workspace: string;
 };
 export type GetPostgresPublicationResponse = PublicationData;
 export type CreatePostgresPublicationData = {
     path: string;
+    /**
+     * The name of the publication
+     */
     publication: string;
     /**
      * new publication for postgres
@@ -6394,6 +6613,9 @@ export type CreatePostgresPublicationData = {
 export type CreatePostgresPublicationResponse = string;
 export type UpdatePostgresPublicationData = {
     path: string;
+    /**
+     * The name of the publication
+     */
     publication: string;
     /**
      * update publication for postgres
@@ -6404,6 +6626,9 @@ export type UpdatePostgresPublicationData = {
 export type UpdatePostgresPublicationResponse = string;
 export type DeletePostgresPublicationData = {
     path: string;
+    /**
+     * The name of the publication
+     */
     publication: string;
     workspace: string;
 };
@@ -9532,6 +9757,9 @@ export type $OpenApiTs = {
     '/w/{workspace}/variables/create': {
         post: {
             req: {
+                /**
+                 * whether the variable is already encrypted (default false)
+                 */
                 alreadyEncrypted?: boolean;
                 /**
                  * new variable
@@ -9581,6 +9809,9 @@ export type $OpenApiTs = {
     '/w/{workspace}/variables/update/{path}': {
         post: {
             req: {
+                /**
+                 * whether the variable is already encrypted (default false)
+                 */
                 alreadyEncrypted?: boolean;
                 path: string;
                 /**
@@ -9657,6 +9888,9 @@ export type $OpenApiTs = {
                  * which page to return (start at 1, default 1)
                  */
                 page?: number;
+                /**
+                 * filter variables by path prefix
+                 */
                 pathStart?: string;
                 /**
                  * number of items to return for a given page (default 30, max 100)
@@ -9969,6 +10203,9 @@ export type $OpenApiTs = {
                  * new resource
                  */
                 requestBody: CreateResource;
+                /**
+                 * update the resource if it already exists (default false)
+                 */
                 updateIfExists?: boolean;
                 workspace: string;
             };
@@ -10099,6 +10336,9 @@ export type $OpenApiTs = {
                  * which page to return (start at 1, default 1)
                  */
                 page?: number;
+                /**
+                 * filter resources by path prefix
+                 */
                 pathStart?: string;
                 /**
                  * number of items to return for a given page (default 30, max 100)
@@ -13298,6 +13538,7 @@ export type $OpenApiTs = {
                 noLogs?: boolean;
                 onlyResult?: boolean;
                 running?: boolean;
+                streamOffset?: number;
                 workspace: string;
             };
             res: {
@@ -14064,6 +14305,9 @@ export type $OpenApiTs = {
                  * filter on jobs containing those args as a json subset (@> in postgres)
                  */
                 args?: string;
+                /**
+                 * filter schedules by whether they target a flow
+                 */
                 isFlow?: boolean;
                 /**
                  * which page to return (start at 1, default 1)
@@ -14073,6 +14317,9 @@ export type $OpenApiTs = {
                  * filter by path
                  */
                 path?: string;
+                /**
+                 * filter schedules by path prefix
+                 */
                 pathStart?: string;
                 /**
                  * number of items to return for a given page (default 30, max 100)
@@ -15360,6 +15607,9 @@ export type $OpenApiTs = {
         get: {
             req: {
                 path: string;
+                /**
+                 * The name of the publication
+                 */
                 publication: string;
                 workspace: string;
             };
@@ -15375,6 +15625,9 @@ export type $OpenApiTs = {
         post: {
             req: {
                 path: string;
+                /**
+                 * The name of the publication
+                 */
                 publication: string;
                 /**
                  * new publication for postgres
@@ -15394,6 +15647,9 @@ export type $OpenApiTs = {
         post: {
             req: {
                 path: string;
+                /**
+                 * The name of the publication
+                 */
                 publication: string;
                 /**
                  * update publication for postgres
@@ -15413,6 +15669,9 @@ export type $OpenApiTs = {
         delete: {
             req: {
                 path: string;
+                /**
+                 * The name of the publication
+                 */
                 publication: string;
                 workspace: string;
             };

package/package.json

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