windmill-client 1.219.1 → 1.221.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.
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.OpenAPI = void 0;
4
4
  exports.OpenAPI = {
5
5
  BASE: '/api',
6
- VERSION: '1.219.1',
6
+ VERSION: '1.221.0',
7
7
  WITH_CREDENTIALS: false,
8
8
  CREDENTIALS: 'include',
9
9
  TOKEN: undefined,
package/dist/index.d.ts CHANGED
@@ -5,6 +5,7 @@ export type { OpenAPIConfig } from './core/OpenAPI';
5
5
  export type { AccountId } from './models/AccountId';
6
6
  export { ActionKind } from './models/ActionKind';
7
7
  export type { After } from './models/After';
8
+ export type { AppHistory } from './models/AppHistory';
8
9
  export { AppWithLastVersion } from './models/AppWithLastVersion';
9
10
  export type { AppWithLastVersionWDraft } from './models/AppWithLastVersionWDraft';
10
11
  export type { ArgsFilter } from './models/ArgsFilter';
@@ -79,6 +80,7 @@ export type { Path } from './models/Path';
79
80
  export type { PathFlow } from './models/PathFlow';
80
81
  export type { PathId } from './models/PathId';
81
82
  export type { PathScript } from './models/PathScript';
83
+ export type { PathVersion } from './models/PathVersion';
82
84
  export type { Payload } from './models/Payload';
83
85
  export type { PerPage } from './models/PerPage';
84
86
  export type { PolarsClientKwargs } from './models/PolarsClientKwargs';
@@ -106,6 +108,7 @@ export type { ScriptArgs } from './models/ScriptArgs';
106
108
  export type { ScriptExactHash } from './models/ScriptExactHash';
107
109
  export type { ScriptExactPath } from './models/ScriptExactPath';
108
110
  export type { ScriptHash } from './models/ScriptHash';
111
+ export type { ScriptHistory } from './models/ScriptHistory';
109
112
  export type { ScriptPath } from './models/ScriptPath';
110
113
  export type { ScriptStartPath } from './models/ScriptStartPath';
111
114
  export type { SlackToken } from './models/SlackToken';
@@ -129,6 +132,7 @@ export { WindmillFilePreview } from './models/WindmillFilePreview';
129
132
  export type { WindmillLargeFile } from './models/WindmillLargeFile';
130
133
  export type { WorkerPing } from './models/WorkerPing';
131
134
  export type { Workspace } from './models/Workspace';
135
+ export type { WorkspaceGitSync } from './models/WorkspaceGitSync';
132
136
  export type { WorkspaceId } from './models/WorkspaceId';
133
137
  export type { WorkspaceInvite } from './models/WorkspaceInvite';
134
138
  export { AdminService } from './services/AdminService';
@@ -0,0 +1,4 @@
1
+ export type AppHistory = {
2
+ version: number;
3
+ deployment_msg?: string;
4
+ };
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ /* generated using openapi-typescript-codegen -- do no edit */
3
+ /* istanbul ignore file */
4
+ /* tslint:disable */
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -49,7 +49,8 @@ export declare namespace CompletedJob {
49
49
  APPDEPENDENCIES = "appdependencies",
50
50
  FLOWPREVIEW = "flowpreview",
51
51
  SCRIPT_HUB = "script_hub",
52
- IDENTITY = "identity"
52
+ IDENTITY = "identity",
53
+ DEPLOYMENTCALLBACK = "deploymentcallback"
53
54
  }
54
55
  enum language {
55
56
  PYTHON3 = "python3",
@@ -18,6 +18,7 @@ var CompletedJob;
18
18
  job_kind["FLOWPREVIEW"] = "flowpreview";
19
19
  job_kind["SCRIPT_HUB"] = "script_hub";
20
20
  job_kind["IDENTITY"] = "identity";
21
+ job_kind["DEPLOYMENTCALLBACK"] = "deploymentcallback";
21
22
  })(job_kind = CompletedJob.job_kind || (CompletedJob.job_kind = {}));
22
23
  let language;
23
24
  (function (language) {
@@ -12,4 +12,5 @@ export type FlowMetadata = {
12
12
  ws_error_handler_muted?: boolean;
13
13
  priority?: number;
14
14
  dedicated_worker?: boolean;
15
+ timeout?: number;
15
16
  };
@@ -11,6 +11,7 @@ export type FlowModule = {
11
11
  sleep?: InputTransform;
12
12
  cache_ttl?: number;
13
13
  timeout?: number;
14
+ delete_after_use?: boolean;
14
15
  summary?: string;
15
16
  mock?: {
16
17
  enabled?: boolean;
@@ -18,6 +18,10 @@ export type NewScript = {
18
18
  dedicated_worker?: boolean;
19
19
  ws_error_handler_muted?: boolean;
20
20
  priority?: number;
21
+ restart_unless_cancelled?: boolean;
22
+ timeout?: number;
23
+ delete_after_use?: boolean;
24
+ deployment_message?: string;
21
25
  };
22
26
  export declare namespace NewScript {
23
27
  enum language {
@@ -5,4 +5,5 @@ export type OpenFlowWPath = (OpenFlow & {
5
5
  ws_error_handler_muted?: boolean;
6
6
  priority?: number;
7
7
  dedicated_worker?: boolean;
8
+ timeout?: number;
8
9
  });
@@ -0,0 +1 @@
1
+ export type PathVersion = number;
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ /* generated using openapi-typescript-codegen -- do no edit */
3
+ /* istanbul ignore file */
4
+ /* tslint:disable */
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -47,7 +47,8 @@ export declare namespace QueuedJob {
47
47
  FLOW = "flow",
48
48
  FLOWPREVIEW = "flowpreview",
49
49
  SCRIPT_HUB = "script_hub",
50
- IDENTITY = "identity"
50
+ IDENTITY = "identity",
51
+ DEPLOYMENTCALLBACK = "deploymentcallback"
51
52
  }
52
53
  enum language {
53
54
  PYTHON3 = "python3",
@@ -18,6 +18,7 @@ var QueuedJob;
18
18
  job_kind["FLOWPREVIEW"] = "flowpreview";
19
19
  job_kind["SCRIPT_HUB"] = "script_hub";
20
20
  job_kind["IDENTITY"] = "identity";
21
+ job_kind["DEPLOYMENTCALLBACK"] = "deploymentcallback";
21
22
  })(job_kind = QueuedJob.job_kind || (QueuedJob.job_kind = {}));
22
23
  let language;
23
24
  (function (language) {
@@ -32,6 +32,9 @@ export type Script = {
32
32
  dedicated_worker?: boolean;
33
33
  ws_error_handler_muted?: boolean;
34
34
  priority?: number;
35
+ restart_unless_cancelled?: boolean;
36
+ timeout?: number;
37
+ delete_after_use?: boolean;
35
38
  };
36
39
  export declare namespace Script {
37
40
  enum language {
@@ -0,0 +1,4 @@
1
+ export type ScriptHistory = {
2
+ script_hash: string;
3
+ deployment_msg?: string;
4
+ };
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ /* generated using openapi-typescript-codegen -- do no edit */
3
+ /* istanbul ignore file */
4
+ /* tslint:disable */
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,4 @@
1
+ export type WorkspaceGitSync = {
2
+ script_path: string;
3
+ git_repo_resource_path: string;
4
+ };
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ /* generated using openapi-typescript-codegen -- do no edit */
3
+ /* istanbul ignore file */
4
+ /* tslint:disable */
5
+ /* eslint-disable */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,3 +1,4 @@
1
+ import type { AppHistory } from '../models/AppHistory';
1
2
  import type { AppWithLastVersion } from '../models/AppWithLastVersion';
2
3
  import type { AppWithLastVersionWDraft } from '../models/AppWithLastVersionWDraft';
3
4
  import type { ListableApp } from '../models/ListableApp';
@@ -97,6 +98,7 @@ export declare class AppService {
97
98
  summary: string;
98
99
  policy: Policy;
99
100
  draft_only?: boolean;
101
+ deployment_message?: string;
100
102
  };
101
103
  }): CancelablePromise<string>;
102
104
  /**
@@ -126,6 +128,31 @@ export declare class AppService {
126
128
  workspace: string;
127
129
  path: string;
128
130
  }): CancelablePromise<AppWithLastVersionWDraft>;
131
+ /**
132
+ * get app history by path
133
+ * @returns AppHistory app history
134
+ * @throws ApiError
135
+ */
136
+ static getAppHistoryByPath({ workspace, path, }: {
137
+ workspace: string;
138
+ path: string;
139
+ }): CancelablePromise<Array<AppHistory>>;
140
+ /**
141
+ * update app history
142
+ * @returns string success
143
+ * @throws ApiError
144
+ */
145
+ static updateAppHistory({ workspace, id, version, requestBody, }: {
146
+ workspace: string;
147
+ id: number;
148
+ version: number;
149
+ /**
150
+ * App deployment message
151
+ */
152
+ requestBody: {
153
+ deployment_msg?: string;
154
+ };
155
+ }): CancelablePromise<string>;
129
156
  /**
130
157
  * get public app by secret
131
158
  * @returns AppWithLastVersion app details
@@ -187,6 +214,7 @@ export declare class AppService {
187
214
  summary?: string;
188
215
  value?: any;
189
216
  policy?: Policy;
217
+ deployment_message?: string;
190
218
  };
191
219
  }): CancelablePromise<string>;
192
220
  /**
@@ -127,6 +127,39 @@ class AppService {
127
127
  },
128
128
  });
129
129
  }
130
+ /**
131
+ * get app history by path
132
+ * @returns AppHistory app history
133
+ * @throws ApiError
134
+ */
135
+ static getAppHistoryByPath({ workspace, path, }) {
136
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
137
+ method: 'GET',
138
+ url: '/w/{workspace}/apps/history/p/{path}',
139
+ path: {
140
+ 'workspace': workspace,
141
+ 'path': path,
142
+ },
143
+ });
144
+ }
145
+ /**
146
+ * update app history
147
+ * @returns string success
148
+ * @throws ApiError
149
+ */
150
+ static updateAppHistory({ workspace, id, version, requestBody, }) {
151
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
152
+ method: 'POST',
153
+ url: '/w/{workspace}/apps/history_update/a/{id}/v/{version}',
154
+ path: {
155
+ 'workspace': workspace,
156
+ 'id': id,
157
+ 'version': version,
158
+ },
159
+ body: requestBody,
160
+ mediaType: 'application/json',
161
+ });
162
+ }
130
163
  /**
131
164
  * get public app by secret
132
165
  * @returns AppWithLastVersion app details
@@ -153,6 +153,7 @@ export declare class FlowService {
153
153
  */
154
154
  requestBody: (OpenFlowWPath & {
155
155
  draft_only?: boolean;
156
+ deployment_message?: string;
156
157
  });
157
158
  }): CancelablePromise<string>;
158
159
  /**
@@ -166,7 +167,9 @@ export declare class FlowService {
166
167
  /**
167
168
  * Partially filled flow
168
169
  */
169
- requestBody: OpenFlowWPath;
170
+ requestBody: (OpenFlowWPath & {
171
+ deployment_message?: string;
172
+ });
170
173
  }): CancelablePromise<string>;
171
174
  /**
172
175
  * archive flow by path
@@ -21,6 +21,22 @@ export declare class HelpersService {
21
21
  }): CancelablePromise<{
22
22
  connection_settings_str?: string;
23
23
  }>;
24
+ /**
25
+ * Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
26
+ * @returns any Connection settings
27
+ * @throws ApiError
28
+ */
29
+ static duckdbConnectionSettingsV2({ workspace, requestBody, }: {
30
+ workspace: string;
31
+ /**
32
+ * S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
33
+ */
34
+ requestBody: {
35
+ s3_resource_path?: string;
36
+ };
37
+ }): CancelablePromise<{
38
+ connection_settings_str: string;
39
+ }>;
24
40
  /**
25
41
  * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
26
42
  * @returns any Connection settings
@@ -42,6 +58,36 @@ export declare class HelpersService {
42
58
  cache_regions: boolean;
43
59
  client_kwargs: PolarsClientKwargs;
44
60
  }>;
61
+ /**
62
+ * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
63
+ * @returns any Connection settings
64
+ * @throws ApiError
65
+ */
66
+ static polarsConnectionSettingsV2({ workspace, requestBody, }: {
67
+ workspace: string;
68
+ /**
69
+ * S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
70
+ */
71
+ requestBody: {
72
+ s3_resource_path?: string;
73
+ };
74
+ }): CancelablePromise<{
75
+ s3fs_args: {
76
+ endpoint_url: string;
77
+ key?: string;
78
+ secret?: string;
79
+ use_ssl: boolean;
80
+ cache_regions: boolean;
81
+ client_kwargs: PolarsClientKwargs;
82
+ };
83
+ polars_cloud_options?: {
84
+ aws_endpoint_url: string;
85
+ aws_access_key_id?: string;
86
+ aws_secret_access_key?: string;
87
+ aws_region: string;
88
+ aws_allow_http: boolean;
89
+ };
90
+ }>;
45
91
  /**
46
92
  * Test connection to the workspace datasets storage
47
93
  * @returns any Connection settings
@@ -77,12 +123,13 @@ export declare class HelpersService {
77
123
  * @returns WindmillFilePreview FilePreview
78
124
  * @throws ApiError
79
125
  */
80
- static loadFilePreview({ workspace, fileKey, fileSizeInBytes, fileMimeType, csvSeparator, readBytesFrom, readBytesLength, }: {
126
+ static loadFilePreview({ workspace, fileKey, fileSizeInBytes, fileMimeType, csvSeparator, csvHasHeader, readBytesFrom, readBytesLength, }: {
81
127
  workspace: string;
82
128
  fileKey: string;
83
129
  fileSizeInBytes?: number;
84
130
  fileMimeType?: string;
85
131
  csvSeparator?: string;
132
+ csvHasHeader?: boolean;
86
133
  readBytesFrom?: number;
87
134
  readBytesLength?: number;
88
135
  }): CancelablePromise<WindmillFilePreview>;
@@ -20,6 +20,22 @@ class HelpersService {
20
20
  mediaType: 'application/json',
21
21
  });
22
22
  }
23
+ /**
24
+ * Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
25
+ * @returns any Connection settings
26
+ * @throws ApiError
27
+ */
28
+ static duckdbConnectionSettingsV2({ workspace, requestBody, }) {
29
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
30
+ method: 'POST',
31
+ url: '/w/{workspace}/job_helpers/v2/duckdb_connection_settings',
32
+ path: {
33
+ 'workspace': workspace,
34
+ },
35
+ body: requestBody,
36
+ mediaType: 'application/json',
37
+ });
38
+ }
23
39
  /**
24
40
  * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
25
41
  * @returns any Connection settings
@@ -36,6 +52,22 @@ class HelpersService {
36
52
  mediaType: 'application/json',
37
53
  });
38
54
  }
55
+ /**
56
+ * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
57
+ * @returns any Connection settings
58
+ * @throws ApiError
59
+ */
60
+ static polarsConnectionSettingsV2({ workspace, requestBody, }) {
61
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
62
+ method: 'POST',
63
+ url: '/w/{workspace}/job_helpers/v2/polars_connection_settings',
64
+ path: {
65
+ 'workspace': workspace,
66
+ },
67
+ body: requestBody,
68
+ mediaType: 'application/json',
69
+ });
70
+ }
39
71
  /**
40
72
  * Test connection to the workspace datasets storage
41
73
  * @returns any Connection settings
@@ -90,7 +122,7 @@ class HelpersService {
90
122
  * @returns WindmillFilePreview FilePreview
91
123
  * @throws ApiError
92
124
  */
93
- static loadFilePreview({ workspace, fileKey, fileSizeInBytes, fileMimeType, csvSeparator, readBytesFrom, readBytesLength, }) {
125
+ static loadFilePreview({ workspace, fileKey, fileSizeInBytes, fileMimeType, csvSeparator, csvHasHeader, readBytesFrom, readBytesLength, }) {
94
126
  return (0, request_1.request)(OpenAPI_1.OpenAPI, {
95
127
  method: 'GET',
96
128
  url: '/w/{workspace}/job_helpers/load_file_preview',
@@ -102,6 +134,7 @@ class HelpersService {
102
134
  'file_size_in_bytes': fileSizeInBytes,
103
135
  'file_mime_type': fileMimeType,
104
136
  'csv_separator': csvSeparator,
137
+ 'csv_has_header': csvHasHeader,
105
138
  'read_bytes_from': readBytesFrom,
106
139
  'read_bytes_length': readBytesLength,
107
140
  },
@@ -2,6 +2,7 @@ import type { HubScriptKind } from '../models/HubScriptKind';
2
2
  import type { NewScript } from '../models/NewScript';
3
3
  import type { NewScriptWithDraft } from '../models/NewScriptWithDraft';
4
4
  import type { Script } from '../models/Script';
5
+ import type { ScriptHistory } from '../models/ScriptHistory';
5
6
  import type { CancelablePromise } from '../core/CancelablePromise';
6
7
  export declare class ScriptService {
7
8
  /**
@@ -268,6 +269,31 @@ export declare class ScriptService {
268
269
  workspace: string;
269
270
  path: string;
270
271
  }): CancelablePromise<NewScriptWithDraft>;
272
+ /**
273
+ * get history of a script by path
274
+ * @returns ScriptHistory script history
275
+ * @throws ApiError
276
+ */
277
+ static getScriptHistoryByPath({ workspace, path, }: {
278
+ workspace: string;
279
+ path: string;
280
+ }): CancelablePromise<Array<ScriptHistory>>;
281
+ /**
282
+ * update history of a script
283
+ * @returns string success
284
+ * @throws ApiError
285
+ */
286
+ static updateScriptHistory({ workspace, hash, path, requestBody, }: {
287
+ workspace: string;
288
+ hash: string;
289
+ path: string;
290
+ /**
291
+ * Script deployment message
292
+ */
293
+ requestBody: {
294
+ deployment_msg?: string;
295
+ };
296
+ }): CancelablePromise<string>;
271
297
  /**
272
298
  * raw script by path
273
299
  * @returns string script content
@@ -245,6 +245,39 @@ class ScriptService {
245
245
  },
246
246
  });
247
247
  }
248
+ /**
249
+ * get history of a script by path
250
+ * @returns ScriptHistory script history
251
+ * @throws ApiError
252
+ */
253
+ static getScriptHistoryByPath({ workspace, path, }) {
254
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
255
+ method: 'GET',
256
+ url: '/w/{workspace}/scripts/history/p/{path}',
257
+ path: {
258
+ 'workspace': workspace,
259
+ 'path': path,
260
+ },
261
+ });
262
+ }
263
+ /**
264
+ * update history of a script
265
+ * @returns string success
266
+ * @throws ApiError
267
+ */
268
+ static updateScriptHistory({ workspace, hash, path, requestBody, }) {
269
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
270
+ method: 'POST',
271
+ url: '/w/{workspace}/scripts/history_update/h/{hash}/p/{path}',
272
+ path: {
273
+ 'workspace': workspace,
274
+ 'hash': hash,
275
+ 'path': path,
276
+ },
277
+ body: requestBody,
278
+ mediaType: 'application/json',
279
+ });
280
+ }
248
281
  /**
249
282
  * raw script by path
250
283
  * @returns string script content
@@ -3,6 +3,7 @@ import type { LargeFileStorage } from '../models/LargeFileStorage';
3
3
  import type { ScriptArgs } from '../models/ScriptArgs';
4
4
  import type { UserWorkspaceList } from '../models/UserWorkspaceList';
5
5
  import type { Workspace } from '../models/Workspace';
6
+ import type { WorkspaceGitSync } from '../models/WorkspaceGitSync';
6
7
  import type { WorkspaceInvite } from '../models/WorkspaceInvite';
7
8
  import type { CancelablePromise } from '../core/CancelablePromise';
8
9
  export declare class WorkspaceService {
@@ -187,6 +188,7 @@ export declare class WorkspaceService {
187
188
  error_handler_extra_args?: ScriptArgs;
188
189
  error_handler_muted_on_cancel?: boolean;
189
190
  large_file_storage?: LargeFileStorage;
191
+ git_sync?: WorkspaceGitSync;
190
192
  }>;
191
193
  /**
192
194
  * get deploy to
@@ -346,6 +348,20 @@ export declare class WorkspaceService {
346
348
  large_file_storage?: LargeFileStorage;
347
349
  };
348
350
  }): CancelablePromise<any>;
351
+ /**
352
+ * edit workspace git sync settings
353
+ * @returns any status
354
+ * @throws ApiError
355
+ */
356
+ static editWorkspaceGitSyncConfig({ workspace, requestBody, }: {
357
+ workspace: string;
358
+ /**
359
+ * Workspace Git sync settings
360
+ */
361
+ requestBody: {
362
+ git_sync_settings?: WorkspaceGitSync;
363
+ };
364
+ }): CancelablePromise<any>;
349
365
  /**
350
366
  * get large file storage config
351
367
  * @returns LargeFileStorage status
@@ -407,6 +407,22 @@ class WorkspaceService {
407
407
  mediaType: 'application/json',
408
408
  });
409
409
  }
410
+ /**
411
+ * edit workspace git sync settings
412
+ * @returns any status
413
+ * @throws ApiError
414
+ */
415
+ static editWorkspaceGitSyncConfig({ workspace, requestBody, }) {
416
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
417
+ method: 'POST',
418
+ url: '/w/{workspace}/workspaces/edit_git_sync_config',
419
+ path: {
420
+ 'workspace': workspace,
421
+ },
422
+ body: requestBody,
423
+ mediaType: 'application/json',
424
+ });
425
+ }
410
426
  /**
411
427
  * get large file storage config
412
428
  * @returns LargeFileStorage status
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "windmill-client",
3
3
  "description": "Windmill SDK client for browsers and Node.js",
4
- "version": "1.219.1",
4
+ "version": "1.221.0",
5
5
  "author": "Ruben Fiszel",
6
6
  "license": "Apache 2.0",
7
7
  "devDependencies": {