windmill-client 1.815.0 → 1.817.0

package/dist/types.gen.d.ts

@@ -189,6 +189,14 @@ export type DbtAssetProvenance = {
 export type UserDraftOverlay = {
     is_draft: boolean;
     draft_saved_at?: string;
+    /**
+     * The deployed version the draft forked from, as text whatever the
+     * kind (script hash, flow version id, app version id). Compare to the
+     * deployed head to tell a draft that is behind. Absent when there is
+     * no draft or it was never forked from a deploy.
+     *
+     */
+    draft_base?: string;
     no_deployed?: boolean;
     draft?: {
         [key: string]: unknown;
@@ -1964,6 +1972,12 @@ export type AIConfig = {
     model_pricing?: {
         [key: string]: ModelPriceOverride;
     };
+    /**
+     * Context window in tokens per `provider:model`, overriding the built-in table the AI chat uses to decide when to compact its history.
+     */
+    context_window_per_model?: {
+        [key: string]: (number);
+    };
     /**
      * Hides the Windmill AI assistant (chat, sessions, code generation, completion, fixes) from the workspace UI. Read from the workspace's own settings even when the providers served fall back to the instance config. AI agent steps and the AI sandbox in flows are unaffected.
      */
@@ -2350,6 +2364,8 @@ export type NewScript = {
 export type ScriptHistory = {
     script_hash: string;
     deployment_msg?: string;
+    created_at?: string;
+    created_by?: string;
 };
 /**
  * The arguments to pass to the script or flow
@@ -4846,6 +4862,7 @@ export type CustomInstanceDbLogs = {
     grant_permissions?: LoggedWizardStatus;
     replication_user?: LoggedWizardStatus;
     replication_user_error?: string;
+    user_connect?: LoggedWizardStatus;
 };
 export type CustomInstanceDbTag = 'ducklake' | 'datatable';
 export type InstanceDatatableRole = {
@@ -4867,6 +4884,13 @@ export type DatatablePermissions = {
     default_role: string;
     roles: Array<DatatableRoleTenants>;
     governing_workspace_id?: string;
+    /**
+     * for a clone, the data table whose roles it takes
+     */
+    clone_of?: {
+        workspace_id: string;
+        datatable: string;
+    };
     editable: boolean;
     available_roles: Array<InstanceDatatableRole>;
     ungoverned_reachers?: Array<{
@@ -4874,6 +4898,134 @@ export type DatatablePermissions = {
         datatable: string;
     }>;
 };
+/**
+ * what access is read or changed on
+ */
+export type AclTarget = AclTargetDatabase | AclTargetSchema | AclTargetTable;
+export type AclTargetDatabase = {
+    kind: 'database';
+};
+export type AclTargetSchema = {
+    kind: 'schema';
+    schema: string;
+};
+export type AclTargetTable = {
+    kind: 'table';
+    schema: string;
+    table: string;
+};
+/**
+ * one change to plan or apply
+ */
+export type AclChange = AclChangeSetOwner | AclChangeGrant | AclChangeRevoke;
+/**
+ * hands the target to role — for a schema, with everything already in it but an extension's members, which stay with the extension
+ */
+export type AclChangeSetOwner = {
+    type: 'set_owner';
+    /**
+     * a data table role of the instance, or admin
+     */
+    role: string;
+};
+export type AclChangeGrant = {
+    type: 'grant';
+    /**
+     * a data table role of the instance, or admin
+     */
+    role: string;
+    privileges: Array<(string)>;
+    scope: AclGrantScope;
+};
+export type AclChangeRevoke = {
+    type: 'revoke';
+    /**
+     * a data table role of the instance, other than admin
+     */
+    role: string;
+    privileges: Array<(string)>;
+    scope: AclGrantScope;
+    /**
+     * objects inside the target the revoke covers, empty for the target itself. Only with the target scope; a revoke on all objects of a kind is refused, since it cannot say which grants it takes back.
+     */
+    objects?: Array<AclObject>;
+};
+export type AclGrantScope = 'target' | 'all_tables' | 'all_sequences' | 'all_functions' | 'future_tables' | 'future_sequences' | 'future_functions';
+export type AclChangeRequest = {
+    target: AclTarget;
+    change: AclChange;
+    /**
+     * The statements the plan showed. Required to apply, which plans again and refuses if the result differs.
+     */
+    statements?: Array<(string)>;
+};
+export type AclPlan = {
+    statements: Array<(string)>;
+    warnings: Array<(string)>;
+};
+export type AclObject = {
+    name: string;
+    /**
+     * TABLE, SEQUENCE, FUNCTION, PROCEDURE or TYPE — what the object is. A revoke turns it into the keyword it takes, ROUTINE for both routine kinds; a type's grants are read only.
+     */
+    kind: string;
+    /**
+     * identity arguments of a routine, which is what tells two of the same name apart
+     */
+    args?: string;
+};
+export type AclGrant = {
+    grantee: string;
+    privileges: Array<(string)>;
+    object?: AclObject;
+    /**
+     * set for a default privilege, naming the kind of object it covers (TABLES, SEQUENCES, FUNCTIONS, TYPES, or SCHEMAS). On a schema, the defaults set in that schema; on the database, the ones set database-wide, which apply in every schema and which no schema's own defaults take back.
+     */
+    future?: string;
+    /**
+     * the roles the grant comes from, each once — who granted it, or for a default privilege the role whose future objects it covers. A revoke of some of the grant's privileges takes them back from every source that gave them.
+     */
+    sources: Array<AclSource>;
+};
+export type AclSource = {
+    role: string;
+    /**
+     * what role gave of the grant's privileges. A revoke is held back only by a source out of reach that gave some of what it takes back.
+     */
+    privileges: Array<(string)>;
+    /**
+     * whether the data table's connection can take back what role gave. On an object that is the owner, when the connection acts for the owner, and otherwise the connection itself; for a default privilege, a creating role the connection acts for. What a source out of reach gave is not revocable from here; privileges only other sources gave still are.
+     */
+    reachable: boolean;
+};
+export type DatatableAclInfo = {
+    owner: string;
+    /**
+     * the roles a change may name; empty unless the caller may change anything
+     */
+    roles: Array<(string)>;
+    /**
+     * whether the caller may plan and apply changes
+     */
+    editable: boolean;
+    /**
+     * whether this is a clone, whose grants stay as they were copied
+     */
+    clone: boolean;
+    /**
+     * whether the server is Postgres 17+, which added the MAINTAIN table privilege
+     */
+    supports_maintain: boolean;
+    /**
+     * the database the target lives in
+     */
+    dbname: string;
+    grants: Array<AclGrant>;
+    /**
+     * a database's schemas, or a schema's tables
+     */
+    children: Array<(string)>;
+};
 export type CustomInstanceDb = {
     logs: CustomInstanceDbLogs;
     /**
@@ -5672,6 +5824,10 @@ export type CreateWorkspaceFork = {
          * New database name for the fork
          */
         new_dbname: string;
+        /**
+         * What the fork request copies into `new_dbname`, which it creates — with the owners and grants of a data table under roles. This server refuses an entry without it; servers predating it expect `new_dbname` created and filled beforehand.
+         */
+        fork_behavior?: 'schema_only' | 'schema_and_data';
     }>;
     /**
      * Lake names the fork SHARES with the parent (reads and writes the parent's lake directly). Every lake not listed gets the default isolated fork namespace with read-defer to the parent.
@@ -5997,9 +6153,21 @@ export type AppWithLastVersion = {
     bundle_secret?: string;
     labels?: Array<(string)>;
 };
+/**
+ * What a deploy of an existing app answers with. `version` is the one this call wrote, which is what an editor pins as the fork base of the draft it starts next: reading the head back afterwards cannot tell it from a deploy that landed beside it. A metadata-only update writes none and reports the head it kept.
+ */
+export type AppDeployed = {
+    /**
+     * Where the app now lives, which differs from the request path on a rename.
+     */
+    path: string;
+    version: number;
+};
 export type AppHistory = {
     version: number;
     deployment_msg?: string;
+    created_at?: string;
+    created_by?: string;
 };
 export type EmbedTokenResponse = {
     /**
@@ -6043,6 +6211,7 @@ export type FlowVersion = {
     id: number;
     created_at: string;
     deployment_msg?: string;
+    created_by?: string;
 };
 export type SlackToken = {
     access_token: string;
@@ -6157,6 +6326,13 @@ export type DataTableSettings = {
                 workspace_id: string;
                 datatable: string;
             };
+            /**
+             * On a clone, the data table it was copied from, whose roles it takes. Server-owned like `reference`.
+             */
+            governed_by?: {
+                workspace_id: string;
+                datatable: string;
+            };
             /**
              * Whether the SQL migrations feature is opted in for this data table
              */
@@ -6212,6 +6388,24 @@ export type DataTableTables = {
         [key: string]: Array<(string)>;
     };
     error?: string;
+    /**
+     * on the instance database, the only kind that can be under roles or have its access edited
+     */
+    instance: boolean;
+    permissioned: boolean;
+    /**
+     * the roles the caller may connect as, by name; empty when not under roles
+     */
+    usable_roles: Array<(string)>;
+    default_role: string;
+    /**
+     * whether the role the listing connected as may create schemas
+     */
+    can_create_schema: boolean;
+    /**
+     * the schemas the role the listing connected as may create in
+     */
+    creatable_schemas: Array<(string)>;
 };
 export type DataTableTableSchema = {
     datatable_name: string;
@@ -6298,6 +6492,31 @@ export type WorkspaceDeployUISettings = {
     include_path?: Array<(string)>;
     include_type?: Array<GitSyncObjectType>;
 };
+export type RemoteDeployTarget = {
+    /**
+     * root URL of the remote Windmill instance, without /api
+     */
+    base_url: string;
+    /**
+     * workspace on the remote instance that deploys land in
+     */
+    workspace_id: string;
+};
+export type RemoteDeployConnection = {
+    /**
+     * identity the stored token has on the remote instance
+     */
+    remote_email: string;
+    /**
+     * goes in every proxy URL, `/w/{workspace}/remote_deploy/proxy/{proxy_key}/{route}`
+     */
+    proxy_key: string;
+    connected_at: string;
+};
+export type RemoteDeployStatus = {
+    target?: RemoteDeployTarget;
+    connection?: RemoteDeployConnection;
+};
 export type WorkspaceDefaultScripts = {
     order?: Array<(string)>;
     hidden?: Array<(string)>;
@@ -7740,12 +7959,6 @@ export type ConsumeLoginLinkData = {
     rd?: string;
     token: string;
 };
-export type ConfirmLoginLinkData = {
-    token: string;
-};
-export type ConfirmLoginLinkResponse = {
-    location: string;
-};
 export type ResetPasswordData = {
     /**
      * token and new password
@@ -8076,7 +8289,7 @@ export type CreateLoginLinkData = {
     requestBody: {
         email: string;
         /**
-         * link lifetime in seconds, at most 7200 (default 600)
+         * link lifetime in seconds, at most 900 (default 600)
          */
         expires_in_s?: number;
         /**
@@ -8087,10 +8300,6 @@ export type CreateLoginLinkData = {
          * mint only while the account still has this login type (for example pending_oauth), so a link stops working once the owner has set a password or signed in with a provider
          */
         require_login_type?: string;
-        /**
-         * return a /user/login_link page that signs in only when its button is clicked, instead of a link spent by opening it; set it for links sent by email, which mail scanners open on delivery (default false)
-         */
-        confirm?: boolean;
     };
 };
 export type CreateLoginLinkResponse = {
@@ -8656,6 +8865,29 @@ export type GetDeployToData = {
 export type GetDeployToResponse = {
     deploy_to?: string;
 };
+export type GetRemoteDeployTargetData = {
+    workspace: string;
+};
+export type GetRemoteDeployTargetResponse = RemoteDeployStatus;
+export type SetRemoteDeployTargetData = {
+    requestBody: {
+        target?: RemoteDeployTarget;
+    };
+    workspace: string;
+};
+export type SetRemoteDeployTargetResponse = string;
+export type ConnectRemoteDeployData = {
+    requestBody: {
+        token: string;
+        target: RemoteDeployTarget;
+    };
+    workspace: string;
+};
+export type ConnectRemoteDeployResponse = RemoteDeployConnection;
+export type DisconnectRemoteDeployData = {
+    workspace: string;
+};
+export type DisconnectRemoteDeployResponse = string;
 export type GetIsPremiumData = {
     workspace: string;
 };
@@ -9005,6 +9237,26 @@ export type SetDatatablePermissionsData = {
     workspace: string;
 };
 export type SetDatatablePermissionsResponse = string;
+export type GetDatatableAclData = {
+    datatableName: string;
+    kind: 'database' | 'schema' | 'table';
+    schema?: string;
+    table?: string;
+    workspace: string;
+};
+export type GetDatatableAclResponse = DatatableAclInfo;
+export type PlanDatatableAclData = {
+    datatableName: string;
+    requestBody: AclChangeRequest;
+    workspace: string;
+};
+export type PlanDatatableAclResponse = AclPlan;
+export type ApplyDatatableAclData = {
+    datatableName: string;
+    requestBody: AclChangeRequest;
+    workspace: string;
+};
+export type ApplyDatatableAclResponse = string;
 export type ListUsableDatatableRolesData = {
     datatableName: string;
     workspace: string;
@@ -9032,11 +9284,27 @@ export type TestDataTableConnectionResponse = {
     suggested_search_path?: string;
 };
 export type ListDataTableTablesData = {
+    /**
+     * list only this data table; each listed data table opens a connection to its database
+     */
+    datatableName?: string;
+    /**
+     * the role to list `role_for` as; refused, in that entry's `error`, if the caller may not use it
+     */
+    role?: string;
+    /**
+     * the data table `role` applies to; every other one is listed as its default role
+     */
+    roleFor?: string;
     workspace: string;
 };
 export type ListDataTableTablesResponse = Array<DataTableTables>;
 export type GetDataTableTableSchemaData = {
     datatableName: string;
+    /**
+     * the data table role to read the table as; defaults to the data table's default role
+     */
+    role?: string;
     schemaName: string;
     tableName: string;
     workspace: string;
@@ -10985,7 +11253,15 @@ export type ListFlowsResponse = Array<(Flow & {
     }>;
 })>;
 export type GetFlowHistoryData = {
+    /**
+     * which page to return (start at 1, default 1)
+     */
+    page?: number;
     path: string;
+    /**
+     * number of items to return for a given page (default 30, max 100)
+     */
+    perPage?: number;
     workspace: string;
 };
 export type GetFlowHistoryResponse = Array<FlowVersion>;
@@ -11332,7 +11608,15 @@ export type GetAppLiteByPathData = {
 };
 export type GetAppLiteByPathResponse = AppWithLastVersion;
 export type GetAppHistoryByPathData = {
+    /**
+     * which page to return (start at 1, default 1)
+     */
+    page?: number;
     path: string;
+    /**
+     * number of items to return for a given page (default 30, max 100)
+     */
+    perPage?: number;
     workspace: string;
 };
 export type GetAppHistoryByPathResponse = Array<AppHistory>;
@@ -11432,7 +11716,7 @@ export type UpdateAppData = {
     };
     workspace: string;
 };
-export type UpdateAppResponse = string;
+export type UpdateAppResponse = AppDeployed;
 export type CreateAppRawSourceData = {
     /**
      * raw app sources to bundle and deploy
@@ -11511,7 +11795,7 @@ export type UpdateAppRawSourceData = {
     };
     workspace: string;
 };
-export type UpdateAppRawSourceResponse = string;
+export type UpdateAppRawSourceResponse = AppDeployed;
 export type UpdateAppRawData = {
     /**
      * update app
@@ -11544,7 +11828,7 @@ export type UpdateAppRawData = {
     path: string;
     workspace: string;
 };
-export type UpdateAppRawResponse = string;
+export type UpdateAppRawResponse = AppDeployed;
 export type CustomPathExistsData = {
     customPath: string;
     workspace: string;
@@ -12060,7 +12344,15 @@ export type ListTokensOfScriptData = {
 };
 export type ListTokensOfScriptResponse = Array<TruncatedToken>;
 export type GetScriptHistoryByPathData = {
+    /**
+     * which page to return (start at 1, default 1)
+     */
+    page?: number;
     path: string;
+    /**
+     * number of items to return for a given page (default 30, max 100)
+     */
+    perPage?: number;
     workspace: string;
 };
 export type GetScriptHistoryByPathResponse = Array<ScriptHistory>;
@@ -12373,7 +12665,27 @@ export type UpdateDraftData = {
 export type UpdateDraftResponse = {
     status: 'saved' | 'conflict';
     current_timestamp: string;
+    /**
+     * `saved` only, upsert or delete: where the write landed. Differs from the URL path when the item had moved away from it; the editor follows it there. Absent when a delete found nothing to remove and the caller cannot read the path it moved to.
+     */
+    path?: string;
+};
+export type MoveDraftData = {
+    /**
+     * script, flow, app or raw_app only.
+     */
+    kind: 'script' | 'flow' | 'app' | 'raw_app';
+    path: string;
+    requestBody: {
+        new_path: string;
+        /**
+         * Also restate the draft's summary.
+         */
+        summary?: string;
+    };
+    workspace: string;
 };
+export type MoveDraftResponse = string;
 export type MigrateLegacyDraftData = {
     kind: UserDraftItemKind;
     path: string;
@@ -19042,19 +19354,6 @@ export type $OpenApiTs = {
                 302: unknown;
             };
         };
-        post: {
-            req: {
-                token: string;
-            };
-            res: {
-                /**
-                 * the post-login destination, or /user/login_link_expired when the link is used, expired or unknown
-                 */
-                200: {
-                    location: string;
-                };
-            };
-        };
     };
     '/auth/reset_password': {
         post: {
@@ -19822,7 +20121,7 @@ export type $OpenApiTs = {
                 requestBody: {
                     email: string;
                     /**
-                     * link lifetime in seconds, at most 7200 (default 600)
+                     * link lifetime in seconds, at most 900 (default 600)
                      */
                     expires_in_s?: number;
                     /**
@@ -19833,10 +20132,6 @@ export type $OpenApiTs = {
                      * mint only while the account still has this login type (for example pending_oauth), so a link stops working once the owner has set a password or signed in with a provider
                      */
                     require_login_type?: string;
-                    /**
-                     * return a /user/login_link page that signs in only when its button is clicked, instead of a link spent by opening it; set it for links sent by email, which mail scanners open on delivery (default false)
-                     */
-                    confirm?: boolean;
                 };
             };
             res: {
@@ -20958,6 +21253,63 @@ export type $OpenApiTs = {
             };
         };
     };
+    '/w/{workspace}/remote_deploy/target': {
+        get: {
+            req: {
+                workspace: string;
+            };
+            res: {
+                /**
+                 * remote deploy target and the caller's connection to it
+                 */
+                200: RemoteDeployStatus;
+            };
+        };
+        post: {
+            req: {
+                requestBody: {
+                    target?: RemoteDeployTarget;
+                };
+                workspace: string;
+            };
+            res: {
+                /**
+                 * status
+                 */
+                200: string;
+            };
+        };
+    };
+    '/w/{workspace}/remote_deploy/connect': {
+        post: {
+            req: {
+                requestBody: {
+                    token: string;
+                    target: RemoteDeployTarget;
+                };
+                workspace: string;
+            };
+            res: {
+                /**
+                 * the stored connection
+                 */
+                200: RemoteDeployConnection;
+            };
+        };
+    };
+    '/w/{workspace}/remote_deploy/disconnect': {
+        post: {
+            req: {
+                workspace: string;
+            };
+            res: {
+                /**
+                 * status
+                 */
+                200: string;
+            };
+        };
+    };
     '/w/{workspace}/workspaces/is_premium': {
         get: {
             req: {
@@ -21614,6 +21966,53 @@ export type $OpenApiTs = {
             };
         };
     };
+    '/w/{workspace}/workspaces/datatable_acl/{datatable_name}': {
+        get: {
+            req: {
+                datatableName: string;
+                kind: 'database' | 'schema' | 'table';
+                schema?: string;
+                table?: string;
+                workspace: string;
+            };
+            res: {
+                /**
+                 * owner and grants
+                 */
+                200: DatatableAclInfo;
+            };
+        };
+    };
+    '/w/{workspace}/workspaces/datatable_acl/{datatable_name}/plan': {
+        post: {
+            req: {
+                datatableName: string;
+                requestBody: AclChangeRequest;
+                workspace: string;
+            };
+            res: {
+                /**
+                 * statements that would run, in a single transaction
+                 */
+                200: AclPlan;
+            };
+        };
+    };
+    '/w/{workspace}/workspaces/datatable_acl/{datatable_name}/apply': {
+        post: {
+            req: {
+                datatableName: string;
+                requestBody: AclChangeRequest;
+                workspace: string;
+            };
+            res: {
+                /**
+                 * change applied
+                 */
+                200: string;
+            };
+        };
+    };
     '/w/{workspace}/workspaces/datatable_usable_roles/{datatable_name}': {
         get: {
             req: {
@@ -21670,6 +22069,18 @@ export type $OpenApiTs = {
     '/w/{workspace}/workspaces/list_datatable_tables': {
         get: {
             req: {
+                /**
+                 * list only this data table; each listed data table opens a connection to its database
+                 */
+                datatableName?: string;
+                /**
+                 * the role to list `role_for` as; refused, in that entry's `error`, if the caller may not use it
+                 */
+                role?: string;
+                /**
+                 * the data table `role` applies to; every other one is listed as its default role
+                 */
+                roleFor?: string;
                 workspace: string;
             };
             res: {
@@ -21684,6 +22095,10 @@ export type $OpenApiTs = {
         get: {
             req: {
                 datatableName: string;
+                /**
+                 * the data table role to read the table as; defaults to the data table's default role
+                 */
+                role?: string;
                 schemaName: string;
                 tableName: string;
                 workspace: string;
@@ -25321,7 +25736,15 @@ export type $OpenApiTs = {
     '/w/{workspace}/flows/history/p/{path}': {
         get: {
             req: {
+                /**
+                 * which page to return (start at 1, default 1)
+                 */
+                page?: number;
                 path: string;
+                /**
+                 * number of items to return for a given page (default 30, max 100)
+                 */
+                perPage?: number;
                 workspace: string;
             };
             res: {
@@ -25956,7 +26379,15 @@ export type $OpenApiTs = {
     '/w/{workspace}/apps/history/p/{path}': {
         get: {
             req: {
+                /**
+                 * which page to return (start at 1, default 1)
+                 */
+                page?: number;
                 path: string;
+                /**
+                 * number of items to return for a given page (default 30, max 100)
+                 */
+                perPage?: number;
                 workspace: string;
             };
             res: {
@@ -26168,7 +26599,7 @@ export type $OpenApiTs = {
                 /**
                  * app updated
                  */
-                200: string;
+                200: AppDeployed;
             };
         };
     };
@@ -26265,7 +26696,7 @@ export type $OpenApiTs = {
                 /**
                  * app updated
                  */
-                200: string;
+                200: AppDeployed;
             };
         };
     };
@@ -26307,7 +26738,7 @@ export type $OpenApiTs = {
                 /**
                  * app updated
                  */
-                200: string;
+                200: AppDeployed;
             };
         };
     };
@@ -27098,7 +27529,15 @@ export type $OpenApiTs = {
     '/w/{workspace}/scripts/history/p/{path}': {
         get: {
             req: {
+                /**
+                 * which page to return (start at 1, default 1)
+                 */
+                page?: number;
                 path: string;
+                /**
+                 * number of items to return for a given page (default 30, max 100)
+                 */
+                perPage?: number;
                 workspace: string;
             };
             res: {
@@ -27608,10 +28047,39 @@ export type $OpenApiTs = {
                 200: {
                     status: 'saved' | 'conflict';
                     current_timestamp: string;
+                    /**
+                     * `saved` only, upsert or delete: where the write landed. Differs from the URL path when the item had moved away from it; the editor follows it there. Absent when a delete found nothing to remove and the caller cannot read the path it moved to.
+                     */
+                    path?: string;
                 };
             };
         };
     };
+    '/w/{workspace}/drafts/move/{kind}/{path}': {
+        post: {
+            req: {
+                /**
+                 * script, flow, app or raw_app only.
+                 */
+                kind: 'script' | 'flow' | 'app' | 'raw_app';
+                path: string;
+                requestBody: {
+                    new_path: string;
+                    /**
+                     * Also restate the draft's summary.
+                     */
+                    summary?: string;
+                };
+                workspace: string;
+            };
+            res: {
+                /**
+                 * move result
+                 */
+                200: string;
+            };
+        };
+    };
     '/w/{workspace}/drafts/migrate_legacy/{kind}/{path}': {
         post: {
             req: {