windmill-cli 1.519.2 → 1.520.0

package/types/gen/types.gen.d.ts

@@ -324,6 +324,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;
 };
@@ -516,18 +519,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 = {
@@ -603,15 +639,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;
@@ -697,52 +752,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 = {
@@ -1790,6 +1978,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;
@@ -2915,6 +3106,9 @@ export type GetOidcTokenData = {
 };
 export type GetOidcTokenResponse = (string);
 export type CreateVariableData = {
+    /**
+     * whether the variable is already encrypted (default false)
+     */
     alreadyEncrypted?: boolean;
     /**
      * new variable
@@ -2937,6 +3131,9 @@ export type DeleteVariableData = {
 };
 export type DeleteVariableResponse = (string);
 export type UpdateVariableData = {
+    /**
+     * whether the variable is already encrypted (default false)
+     */
     alreadyEncrypted?: boolean;
     path: string;
     /**
@@ -2977,6 +3174,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)
@@ -3202,6 +3402,9 @@ export type CreateResourceData = {
      * new resource
      */
     requestBody: CreateResource;
+    /**
+     * update the resource if it already exists (default false)
+     */
     updateIfExists?: boolean;
     workspace: string;
 };
@@ -3260,6 +3463,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)
@@ -5346,6 +5552,7 @@ export type GetJobUpdatesSseData = {
     noLogs?: boolean;
     onlyResult?: boolean;
     running?: boolean;
+    streamOffset?: number;
     workspace: string;
 };
 export type GetJobUpdatesSseResponse = (string);
@@ -5605,6 +5812,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)
@@ -5614,6 +5824,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)
@@ -6253,12 +6466,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
@@ -6269,6 +6488,9 @@ export type CreatePostgresPublicationData = {
 export type CreatePostgresPublicationResponse = (string);
 export type UpdatePostgresPublicationData = {
     path: string;
+    /**
+     * The name of the publication
+     */
     publication: string;
     /**
      * update publication for postgres
@@ -6279,6 +6501,9 @@ export type UpdatePostgresPublicationData = {
 export type UpdatePostgresPublicationResponse = (string);
 export type DeletePostgresPublicationData = {
     path: string;
+    /**
+     * The name of the publication
+     */
     publication: string;
     workspace: string;
 };