windmill-client 1.815.0 → 1.817.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -357,20 +357,6 @@ var UserService = class {
357
357
  });
358
358
  }
359
359
  /**
360
- * consume a single-use login link from its confirmation page, set the session cookie and answer where to go
361
- * @param data The data for the request.
362
- * @param data.token
363
- * @returns unknown the post-login destination, or /user/login_link_expired when the link is used, expired or unknown
364
- * @throws ApiError
365
- */
366
- static confirmLoginLink(data) {
367
- return request(OpenAPI, {
368
- method: "POST",
369
- url: "/auth/login_link/{token}",
370
- path: { token: data.token }
371
- });
372
- }
373
- /**
374
360
  * reset password using token
375
361
  * @param data The data for the request.
376
362
  * @param data.requestBody token and new password
@@ -2217,6 +2203,77 @@ var WorkspaceService = class {
2217
2203
  });
2218
2204
  }
2219
2205
  /**
2206
+ * get the workspace's deploy target on another instance, and the caller's connection to it
2207
+ * Once connected, deploy calls aimed at the target go through
2208
+ * `/w/{workspace}/remote_deploy/proxy/{proxy_key}/{route}`, which forwards any method to
2209
+ * `{base_url}/api/w/{target workspace}/{route}` with the caller's stored token.
2210
+ *
2211
+ * @param data The data for the request.
2212
+ * @param data.workspace
2213
+ * @returns RemoteDeployStatus remote deploy target and the caller's connection to it
2214
+ * @throws ApiError
2215
+ */
2216
+ static getRemoteDeployTarget(data) {
2217
+ return request(OpenAPI, {
2218
+ method: "GET",
2219
+ url: "/w/{workspace}/remote_deploy/target",
2220
+ path: { workspace: data.workspace }
2221
+ });
2222
+ }
2223
+ /**
2224
+ * set or clear the workspace's deploy target on another instance
2225
+ * Changing the target drops every token stored for the previous one.
2226
+ * @param data The data for the request.
2227
+ * @param data.workspace
2228
+ * @param data.requestBody
2229
+ * @returns string status
2230
+ * @throws ApiError
2231
+ */
2232
+ static setRemoteDeployTarget(data) {
2233
+ return request(OpenAPI, {
2234
+ method: "POST",
2235
+ url: "/w/{workspace}/remote_deploy/target",
2236
+ path: { workspace: data.workspace },
2237
+ body: data.requestBody,
2238
+ mediaType: "application/json"
2239
+ });
2240
+ }
2241
+ /**
2242
+ * store the caller's own token for the remote deploy target
2243
+ * The token is checked against the target's whoami before it is stored. `target` names the
2244
+ * target the token was obtained for, and the request is refused if the workspace now points
2245
+ * elsewhere, so a token is never sent to an instance it was not meant for.
2246
+ *
2247
+ * @param data The data for the request.
2248
+ * @param data.workspace
2249
+ * @param data.requestBody
2250
+ * @returns RemoteDeployConnection the stored connection
2251
+ * @throws ApiError
2252
+ */
2253
+ static connectRemoteDeploy(data) {
2254
+ return request(OpenAPI, {
2255
+ method: "POST",
2256
+ url: "/w/{workspace}/remote_deploy/connect",
2257
+ path: { workspace: data.workspace },
2258
+ body: data.requestBody,
2259
+ mediaType: "application/json"
2260
+ });
2261
+ }
2262
+ /**
2263
+ * forget the caller's token for the remote deploy target
2264
+ * @param data The data for the request.
2265
+ * @param data.workspace
2266
+ * @returns string status
2267
+ * @throws ApiError
2268
+ */
2269
+ static disconnectRemoteDeploy(data) {
2270
+ return request(OpenAPI, {
2271
+ method: "POST",
2272
+ url: "/w/{workspace}/remote_deploy/disconnect",
2273
+ path: { workspace: data.workspace }
2274
+ });
2275
+ }
2276
+ /**
2220
2277
  * get if workspace is premium
2221
2278
  * @param data The data for the request.
2222
2279
  * @param data.workspace
@@ -2787,6 +2844,74 @@ var WorkspaceService = class {
2787
2844
  });
2788
2845
  }
2789
2846
  /**
2847
+ * read the owner and grants of an instance data table's database, schema or table
2848
+ * @param data The data for the request.
2849
+ * @param data.workspace
2850
+ * @param data.datatableName
2851
+ * @param data.kind
2852
+ * @param data.schema
2853
+ * @param data.table
2854
+ * @returns DatatableAclInfo owner and grants
2855
+ * @throws ApiError
2856
+ */
2857
+ static getDatatableAcl(data) {
2858
+ return request(OpenAPI, {
2859
+ method: "GET",
2860
+ url: "/w/{workspace}/workspaces/datatable_acl/{datatable_name}",
2861
+ path: {
2862
+ workspace: data.workspace,
2863
+ datatable_name: data.datatableName
2864
+ },
2865
+ query: {
2866
+ kind: data.kind,
2867
+ schema: data.schema,
2868
+ table: data.table
2869
+ }
2870
+ });
2871
+ }
2872
+ /**
2873
+ * preview the SQL an ownership or grant change would run (data table administrators only)
2874
+ * @param data The data for the request.
2875
+ * @param data.workspace
2876
+ * @param data.datatableName
2877
+ * @param data.requestBody
2878
+ * @returns AclPlan statements that would run, in a single transaction
2879
+ * @throws ApiError
2880
+ */
2881
+ static planDatatableAcl(data) {
2882
+ return request(OpenAPI, {
2883
+ method: "POST",
2884
+ url: "/w/{workspace}/workspaces/datatable_acl/{datatable_name}/plan",
2885
+ path: {
2886
+ workspace: data.workspace,
2887
+ datatable_name: data.datatableName
2888
+ },
2889
+ body: data.requestBody,
2890
+ mediaType: "application/json"
2891
+ });
2892
+ }
2893
+ /**
2894
+ * run an ownership or grant change exactly as planned (data table administrators only)
2895
+ * @param data The data for the request.
2896
+ * @param data.workspace
2897
+ * @param data.datatableName
2898
+ * @param data.requestBody
2899
+ * @returns string change applied
2900
+ * @throws ApiError
2901
+ */
2902
+ static applyDatatableAcl(data) {
2903
+ return request(OpenAPI, {
2904
+ method: "POST",
2905
+ url: "/w/{workspace}/workspaces/datatable_acl/{datatable_name}/apply",
2906
+ path: {
2907
+ workspace: data.workspace,
2908
+ datatable_name: data.datatableName
2909
+ },
2910
+ body: data.requestBody,
2911
+ mediaType: "application/json"
2912
+ });
2913
+ }
2914
+ /**
2790
2915
  * list the data table roles the caller may connect as
2791
2916
  * @param data The data for the request.
2792
2917
  * @param data.workspace
@@ -2840,6 +2965,9 @@ var WorkspaceService = class {
2840
2965
  * list tables of all connected Datatables
2841
2966
  * @param data The data for the request.
2842
2967
  * @param data.workspace
2968
+ * @param data.datatableName list only this data table; each listed data table opens a connection to its database
2969
+ * @param data.roleFor the data table `role` applies to; every other one is listed as its default role
2970
+ * @param data.role the role to list `role_for` as; refused, in that entry's `error`, if the caller may not use it
2843
2971
  * @returns DataTableTables table metadata of all datatables
2844
2972
  * @throws ApiError
2845
2973
  */
@@ -2847,7 +2975,12 @@ var WorkspaceService = class {
2847
2975
  return request(OpenAPI, {
2848
2976
  method: "GET",
2849
2977
  url: "/w/{workspace}/workspaces/list_datatable_tables",
2850
- path: { workspace: data.workspace }
2978
+ path: { workspace: data.workspace },
2979
+ query: {
2980
+ datatable_name: data.datatableName,
2981
+ role_for: data.roleFor,
2982
+ role: data.role
2983
+ }
2851
2984
  });
2852
2985
  }
2853
2986
  /**
@@ -2857,6 +2990,7 @@ var WorkspaceService = class {
2857
2990
  * @param data.datatableName
2858
2991
  * @param data.schemaName
2859
2992
  * @param data.tableName
2993
+ * @param data.role the data table role to read the table as; defaults to the data table's default role
2860
2994
  * @returns DataTableTableSchema schema of one datatable table
2861
2995
  * @throws ApiError
2862
2996
  */
@@ -2868,7 +3002,8 @@ var WorkspaceService = class {
2868
3002
  query: {
2869
3003
  datatable_name: data.datatableName,
2870
3004
  schema_name: data.schemaName,
2871
- table_name: data.tableName
3005
+ table_name: data.tableName,
3006
+ role: data.role
2872
3007
  }
2873
3008
  });
2874
3009
  }
@@ -6029,6 +6164,8 @@ var FlowService = class {
6029
6164
  * @param data The data for the request.
6030
6165
  * @param data.workspace
6031
6166
  * @param data.path
6167
+ * @param data.page which page to return (start at 1, default 1)
6168
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
6032
6169
  * @returns FlowVersion Flow history
6033
6170
  * @throws ApiError
6034
6171
  */
@@ -6039,6 +6176,10 @@ var FlowService = class {
6039
6176
  path: {
6040
6177
  workspace: data.workspace,
6041
6178
  path: data.path
6179
+ },
6180
+ query: {
6181
+ page: data.page,
6182
+ per_page: data.perPage
6042
6183
  }
6043
6184
  });
6044
6185
  }
@@ -6638,6 +6779,8 @@ var AppService = class {
6638
6779
  * @param data The data for the request.
6639
6780
  * @param data.workspace
6640
6781
  * @param data.path
6782
+ * @param data.page which page to return (start at 1, default 1)
6783
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
6641
6784
  * @returns AppHistory app history
6642
6785
  * @throws ApiError
6643
6786
  */
@@ -6648,6 +6791,10 @@ var AppService = class {
6648
6791
  path: {
6649
6792
  workspace: data.workspace,
6650
6793
  path: data.path
6794
+ },
6795
+ query: {
6796
+ page: data.page,
6797
+ per_page: data.perPage
6651
6798
  }
6652
6799
  });
6653
6800
  }
@@ -6866,7 +7013,7 @@ var AppService = class {
6866
7013
  * @param data.workspace
6867
7014
  * @param data.path
6868
7015
  * @param data.requestBody update app
6869
- * @returns string app updated
7016
+ * @returns AppDeployed app updated
6870
7017
  * @throws ApiError
6871
7018
  */
6872
7019
  static updateApp(data) {
@@ -6904,7 +7051,7 @@ var AppService = class {
6904
7051
  * @param data.workspace
6905
7052
  * @param data.path
6906
7053
  * @param data.requestBody raw app sources to bundle and deploy
6907
- * @returns string app updated
7054
+ * @returns AppDeployed app updated
6908
7055
  * @throws ApiError
6909
7056
  */
6910
7057
  static updateAppRawSource(data) {
@@ -6925,7 +7072,7 @@ var AppService = class {
6925
7072
  * @param data.workspace
6926
7073
  * @param data.path
6927
7074
  * @param data.formData update app
6928
- * @returns string app updated
7075
+ * @returns AppDeployed app updated
6929
7076
  * @throws ApiError
6930
7077
  */
6931
7078
  static updateAppRaw(data) {
@@ -7685,6 +7832,8 @@ var ScriptService = class {
7685
7832
  * @param data The data for the request.
7686
7833
  * @param data.workspace
7687
7834
  * @param data.path
7835
+ * @param data.page which page to return (start at 1, default 1)
7836
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
7688
7837
  * @returns ScriptHistory script history
7689
7838
  * @throws ApiError
7690
7839
  */
@@ -7695,6 +7844,10 @@ var ScriptService = class {
7695
7844
  path: {
7696
7845
  workspace: data.workspace,
7697
7846
  path: data.path
7847
+ },
7848
+ query: {
7849
+ page: data.page,
7850
+ per_page: data.perPage
7698
7851
  }
7699
7852
  });
7700
7853
  }
@@ -8131,6 +8284,30 @@ var DraftService = class {
8131
8284
  });
8132
8285
  }
8133
8286
  /**
8287
+ * move the current user's draft-only item to another path
8288
+ * Relocates the authed user's own draft row, along with both path keys inside its value (the typed path and the mirror the editors keep beside it). Only for draft-only items — a deployed item must be moved through its own deploy endpoint, which carries every draft with it. Restricted to script, flow, app and raw_app; any other kind is rejected with 400, because only these keep their deploy target where this endpoint rewrites it.
8289
+ * @param data The data for the request.
8290
+ * @param data.workspace
8291
+ * @param data.kind script, flow, app or raw_app only.
8292
+ * @param data.path
8293
+ * @param data.requestBody
8294
+ * @returns string move result
8295
+ * @throws ApiError
8296
+ */
8297
+ static moveDraft(data) {
8298
+ return request(OpenAPI, {
8299
+ method: "POST",
8300
+ url: "/w/{workspace}/drafts/move/{kind}/{path}",
8301
+ path: {
8302
+ workspace: data.workspace,
8303
+ kind: data.kind,
8304
+ path: data.path
8305
+ },
8306
+ body: data.requestBody,
8307
+ mediaType: "application/json"
8308
+ });
8309
+ }
8310
+ /**
8134
8311
  * resolve a legacy (workspace-level) draft (admin only)
8135
8312
  * Delete a legacy draft (email NULL) or assign it to the authed admin as a per-user draft. Workspace admins / superadmins only.
8136
8313
  * @param data The data for the request.