windmill-cli 1.396.0 → 1.397.3

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.
Files changed (89) hide show
  1. package/esm/apps.js +6 -5
  2. package/esm/bootstrap/script_bootstrap.js +18 -0
  3. package/esm/context.js +4 -3
  4. package/esm/deps.js +19 -2
  5. package/esm/flow.js +9 -8
  6. package/esm/folder.js +6 -5
  7. package/esm/gen/core/ApiError.js +41 -0
  8. package/esm/gen/core/ApiRequestOptions.js +1 -0
  9. package/esm/gen/core/ApiResult.js +1 -0
  10. package/esm/gen/core/CancelablePromise.js +130 -0
  11. package/esm/gen/core/OpenAPI.js +41 -0
  12. package/esm/gen/core/request.js +305 -0
  13. package/esm/gen/index.js +6 -0
  14. package/esm/gen/services.gen.js +6782 -0
  15. package/esm/gen/types.gen.js +2 -0
  16. package/esm/hub.js +5 -4
  17. package/esm/instance.js +5 -4
  18. package/esm/main.js +5 -3
  19. package/esm/metadata.js +1 -1
  20. package/esm/resource-type.js +6 -5
  21. package/esm/resource.js +11 -5
  22. package/esm/schedule.js +6 -5
  23. package/esm/script.js +42 -10
  24. package/esm/script_common.js +6 -0
  25. package/esm/settings.js +28 -27
  26. package/esm/sync.js +89 -23
  27. package/esm/types.js +9 -3
  28. package/esm/user.js +27 -27
  29. package/esm/utils.js +7 -0
  30. package/esm/variable.js +7 -6
  31. package/esm/workspace.js +7 -6
  32. package/package.json +1 -2
  33. package/types/apps.d.ts +2 -1
  34. package/types/apps.d.ts.map +1 -1
  35. package/types/bootstrap/script_bootstrap.d.ts +2 -0
  36. package/types/bootstrap/script_bootstrap.d.ts.map +1 -1
  37. package/types/context.d.ts +1 -1
  38. package/types/context.d.ts.map +1 -1
  39. package/types/deps.d.ts +1 -1
  40. package/types/deps.d.ts.map +1 -1
  41. package/types/flow.d.ts +2 -1
  42. package/types/flow.d.ts.map +1 -1
  43. package/types/folder.d.ts +5 -2
  44. package/types/folder.d.ts.map +1 -1
  45. package/types/gen/core/ApiError.d.ts +11 -0
  46. package/types/gen/core/ApiError.d.ts.map +1 -0
  47. package/types/gen/core/ApiRequestOptions.d.ts +15 -0
  48. package/types/gen/core/ApiRequestOptions.d.ts.map +1 -0
  49. package/types/gen/core/ApiResult.d.ts +8 -0
  50. package/types/gen/core/ApiResult.d.ts.map +1 -0
  51. package/types/gen/core/CancelablePromise.d.ts +27 -0
  52. package/types/gen/core/CancelablePromise.d.ts.map +1 -0
  53. package/types/gen/core/OpenAPI.d.ts +28 -0
  54. package/types/gen/core/OpenAPI.d.ts.map +1 -0
  55. package/types/gen/core/request.d.ts +30 -0
  56. package/types/gen/core/request.d.ts.map +1 -0
  57. package/types/gen/index.d.ts +6 -0
  58. package/types/gen/index.d.ts.map +1 -0
  59. package/types/gen/services.gen.d.ts +3339 -0
  60. package/types/gen/services.gen.d.ts.map +1 -0
  61. package/types/gen/types.gen.d.ts +4831 -0
  62. package/types/gen/types.gen.d.ts.map +1 -0
  63. package/types/hub.d.ts.map +1 -1
  64. package/types/instance.d.ts.map +1 -1
  65. package/types/main.d.ts +1 -1
  66. package/types/main.d.ts.map +1 -1
  67. package/types/metadata.d.ts +1 -1
  68. package/types/metadata.d.ts.map +1 -1
  69. package/types/resource-type.d.ts +2 -1
  70. package/types/resource-type.d.ts.map +1 -1
  71. package/types/resource.d.ts +2 -1
  72. package/types/resource.d.ts.map +1 -1
  73. package/types/schedule.d.ts +2 -1
  74. package/types/schedule.d.ts.map +1 -1
  75. package/types/script.d.ts +1 -0
  76. package/types/script.d.ts.map +1 -1
  77. package/types/script_common.d.ts +1 -1
  78. package/types/script_common.d.ts.map +1 -1
  79. package/types/settings.d.ts.map +1 -1
  80. package/types/sync.d.ts +2 -1
  81. package/types/sync.d.ts.map +1 -1
  82. package/types/types.d.ts +1 -1
  83. package/types/types.d.ts.map +1 -1
  84. package/types/user.d.ts.map +1 -1
  85. package/types/utils.d.ts +1 -0
  86. package/types/utils.d.ts.map +1 -1
  87. package/types/variable.d.ts +2 -1
  88. package/types/variable.d.ts.map +1 -1
  89. package/types/workspace.d.ts.map +1 -1
@@ -0,0 +1,4831 @@
1
+ export type Script = {
2
+ workspace_id?: string;
3
+ hash: string;
4
+ path: string;
5
+ /**
6
+ * The first element is the direct parent of the script, the second is the parent of the first, etc
7
+ *
8
+ */
9
+ parent_hashes?: Array<(string)>;
10
+ summary: string;
11
+ description: string;
12
+ content: string;
13
+ created_by: string;
14
+ created_at: string;
15
+ archived: boolean;
16
+ schema?: {
17
+ [key: string]: unknown;
18
+ };
19
+ deleted: boolean;
20
+ is_template: boolean;
21
+ extra_perms: {
22
+ [key: string]: (boolean);
23
+ };
24
+ lock?: string;
25
+ lock_error_logs?: string;
26
+ language: 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible';
27
+ kind: 'script' | 'failure' | 'trigger' | 'command' | 'approval';
28
+ starred: boolean;
29
+ tag?: string;
30
+ has_draft?: boolean;
31
+ draft_only?: boolean;
32
+ envs?: Array<(string)>;
33
+ concurrent_limit?: number;
34
+ concurrency_time_window_s?: number;
35
+ concurrency_key?: string;
36
+ cache_ttl?: number;
37
+ dedicated_worker?: boolean;
38
+ ws_error_handler_muted?: boolean;
39
+ priority?: number;
40
+ restart_unless_cancelled?: boolean;
41
+ timeout?: number;
42
+ delete_after_use?: boolean;
43
+ visible_to_runner_only?: boolean;
44
+ no_main_func: boolean;
45
+ codebase?: string;
46
+ };
47
+ export type language = 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible';
48
+ export type kind = 'script' | 'failure' | 'trigger' | 'command' | 'approval';
49
+ export type NewScript = {
50
+ path: string;
51
+ parent_hash?: string;
52
+ summary: string;
53
+ description: string;
54
+ content: string;
55
+ schema?: {
56
+ [key: string]: unknown;
57
+ };
58
+ is_template?: boolean;
59
+ lock?: string;
60
+ language: 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible';
61
+ kind?: 'script' | 'failure' | 'trigger' | 'command' | 'approval';
62
+ tag?: string;
63
+ draft_only?: boolean;
64
+ envs?: Array<(string)>;
65
+ concurrent_limit?: number;
66
+ concurrency_time_window_s?: number;
67
+ cache_ttl?: number;
68
+ dedicated_worker?: boolean;
69
+ ws_error_handler_muted?: boolean;
70
+ priority?: number;
71
+ restart_unless_cancelled?: boolean;
72
+ timeout?: number;
73
+ delete_after_use?: boolean;
74
+ deployment_message?: string;
75
+ concurrency_key?: string;
76
+ visible_to_runner_only?: boolean;
77
+ no_main_func?: boolean;
78
+ codebase?: string;
79
+ };
80
+ export type NewScriptWithDraft = NewScript & {
81
+ draft?: NewScript;
82
+ hash: string;
83
+ };
84
+ export type ScriptHistory = {
85
+ script_hash: string;
86
+ deployment_msg?: string;
87
+ };
88
+ export type ScriptArgs = {
89
+ [key: string]: unknown;
90
+ };
91
+ export type Input = {
92
+ id: string;
93
+ name: string;
94
+ created_by: string;
95
+ created_at: string;
96
+ is_public: boolean;
97
+ success?: boolean;
98
+ };
99
+ export type CreateInput = {
100
+ name: string;
101
+ args: {
102
+ [key: string]: unknown;
103
+ };
104
+ };
105
+ export type UpdateInput = {
106
+ id: string;
107
+ name: string;
108
+ is_public: boolean;
109
+ };
110
+ export type RunnableType = 'ScriptHash' | 'ScriptPath' | 'FlowPath';
111
+ export type QueuedJob = {
112
+ workspace_id?: string;
113
+ id: string;
114
+ parent_job?: string;
115
+ created_by?: string;
116
+ created_at?: string;
117
+ started_at?: string;
118
+ scheduled_for?: string;
119
+ running: boolean;
120
+ script_path?: string;
121
+ script_hash?: string;
122
+ args?: ScriptArgs;
123
+ logs?: string;
124
+ raw_code?: string;
125
+ canceled: boolean;
126
+ canceled_by?: string;
127
+ canceled_reason?: string;
128
+ last_ping?: string;
129
+ job_kind: 'script' | 'preview' | 'dependencies' | 'flowdependencies' | 'appdependencies' | 'flow' | 'flowpreview' | 'script_hub' | 'identity' | 'deploymentcallback' | 'singlescriptflow';
130
+ schedule_path?: string;
131
+ /**
132
+ * The user (u/userfoo) or group (g/groupfoo) whom
133
+ * the execution of this script will be permissioned_as and by extension its DT_TOKEN.
134
+ *
135
+ */
136
+ permissioned_as: string;
137
+ flow_status?: FlowStatus;
138
+ raw_flow?: FlowValue;
139
+ is_flow_step: boolean;
140
+ language?: 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible';
141
+ email: string;
142
+ visible_to_owner: boolean;
143
+ mem_peak?: number;
144
+ tag: string;
145
+ priority?: number;
146
+ self_wait_time_ms?: number;
147
+ aggregate_wait_time_ms?: number;
148
+ };
149
+ export type job_kind = 'script' | 'preview' | 'dependencies' | 'flowdependencies' | 'appdependencies' | 'flow' | 'flowpreview' | 'script_hub' | 'identity' | 'deploymentcallback' | 'singlescriptflow';
150
+ export type CompletedJob = {
151
+ workspace_id?: string;
152
+ id: string;
153
+ parent_job?: string;
154
+ created_by: string;
155
+ created_at: string;
156
+ started_at: string;
157
+ duration_ms: number;
158
+ success: boolean;
159
+ script_path?: string;
160
+ script_hash?: string;
161
+ args?: ScriptArgs;
162
+ result?: unknown;
163
+ logs?: string;
164
+ deleted?: boolean;
165
+ raw_code?: string;
166
+ canceled: boolean;
167
+ canceled_by?: string;
168
+ canceled_reason?: string;
169
+ job_kind: 'script' | 'preview' | 'dependencies' | 'flow' | 'flowdependencies' | 'appdependencies' | 'flowpreview' | 'script_hub' | 'identity' | 'deploymentcallback' | 'singlescriptflow';
170
+ schedule_path?: string;
171
+ /**
172
+ * The user (u/userfoo) or group (g/groupfoo) whom
173
+ * the execution of this script will be permissioned_as and by extension its DT_TOKEN.
174
+ *
175
+ */
176
+ permissioned_as: string;
177
+ flow_status?: FlowStatus;
178
+ raw_flow?: FlowValue;
179
+ is_flow_step: boolean;
180
+ language?: 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible';
181
+ is_skipped: boolean;
182
+ email: string;
183
+ visible_to_owner: boolean;
184
+ mem_peak?: number;
185
+ tag: string;
186
+ priority?: number;
187
+ labels?: Array<(string)>;
188
+ self_wait_time_ms?: number;
189
+ aggregate_wait_time_ms?: number;
190
+ };
191
+ export type ObscuredJob = {
192
+ typ?: string;
193
+ started_at?: string;
194
+ duration_ms?: number;
195
+ };
196
+ export type Job = (CompletedJob & {
197
+ type?: 'CompletedJob';
198
+ }) | (QueuedJob & {
199
+ type?: 'QueuedJob';
200
+ });
201
+ export type type = 'CompletedJob';
202
+ export type User = {
203
+ email: string;
204
+ username: string;
205
+ is_admin: boolean;
206
+ is_super_admin: boolean;
207
+ created_at: string;
208
+ operator: boolean;
209
+ disabled: boolean;
210
+ groups?: Array<(string)>;
211
+ folders: Array<(string)>;
212
+ folders_owners: Array<(string)>;
213
+ };
214
+ export type UserUsage = {
215
+ email?: string;
216
+ executions?: number;
217
+ };
218
+ export type Login = {
219
+ email: string;
220
+ password: string;
221
+ };
222
+ export type EditWorkspaceUser = {
223
+ is_admin?: boolean;
224
+ operator?: boolean;
225
+ disabled?: boolean;
226
+ };
227
+ export type TruncatedToken = {
228
+ label?: string;
229
+ expiration?: string;
230
+ token_prefix: string;
231
+ created_at: string;
232
+ last_used_at: string;
233
+ scopes?: Array<(string)>;
234
+ };
235
+ export type NewToken = {
236
+ label?: string;
237
+ expiration?: string;
238
+ scopes?: Array<(string)>;
239
+ };
240
+ export type NewTokenImpersonate = {
241
+ label?: string;
242
+ expiration?: string;
243
+ impersonate_email: string;
244
+ };
245
+ export type ListableVariable = {
246
+ workspace_id: string;
247
+ path: string;
248
+ value?: string;
249
+ is_secret: boolean;
250
+ description?: string;
251
+ account?: number;
252
+ is_oauth?: boolean;
253
+ extra_perms: {
254
+ [key: string]: (boolean);
255
+ };
256
+ is_expired?: boolean;
257
+ refresh_error?: string;
258
+ is_linked?: boolean;
259
+ is_refreshed?: boolean;
260
+ expires_at?: string;
261
+ };
262
+ export type ContextualVariable = {
263
+ name: string;
264
+ value: string;
265
+ description: string;
266
+ is_custom: boolean;
267
+ };
268
+ export type CreateVariable = {
269
+ path: string;
270
+ value: string;
271
+ is_secret: boolean;
272
+ description: string;
273
+ account?: number;
274
+ is_oauth?: boolean;
275
+ expires_at?: string;
276
+ };
277
+ export type EditVariable = {
278
+ path?: string;
279
+ value?: string;
280
+ is_secret?: boolean;
281
+ description?: string;
282
+ };
283
+ export type AuditLog = {
284
+ id: number;
285
+ timestamp: string;
286
+ username: string;
287
+ operation: 'jobs.run' | 'jobs.run.script' | 'jobs.run.preview' | 'jobs.run.flow' | 'jobs.run.flow_preview' | 'jobs.run.script_hub' | 'jobs.run.dependencies' | 'jobs.run.identity' | 'jobs.run.noop' | 'jobs.flow_dependencies' | 'jobs' | 'jobs.cancel' | 'jobs.force_cancel' | 'jobs.disapproval' | 'jobs.delete' | 'account.delete' | 'openai.request' | 'resources.create' | 'resources.update' | 'resources.delete' | 'resource_types.create' | 'resource_types.update' | 'resource_types.delete' | 'schedule.create' | 'schedule.setenabled' | 'schedule.edit' | 'schedule.delete' | 'scripts.create' | 'scripts.update' | 'scripts.archive' | 'scripts.delete' | 'users.create' | 'users.delete' | 'users.update' | 'users.login' | 'users.logout' | 'users.accept_invite' | 'users.decline_invite' | 'users.token.create' | 'users.token.delete' | 'users.add_to_workspace' | 'users.add_global' | 'users.setpassword' | 'users.impersonate' | 'users.leave_workspace' | 'oauth.login' | 'oauth.signup' | 'variables.create' | 'variables.delete' | 'variables.update' | 'flows.create' | 'flows.update' | 'flows.delete' | 'flows.archive' | 'apps.create' | 'apps.update' | 'apps.delete' | 'folder.create' | 'folder.update' | 'folder.delete' | 'folder.add_owner' | 'folder.remove_owner' | 'group.create' | 'group.delete' | 'group.edit' | 'group.adduser' | 'group.removeuser' | 'igroup.create' | 'igroup.delete' | 'igroup.adduser' | 'igroup.removeuser' | 'variables.decrypt_secret' | 'workspaces.edit_command_script' | 'workspaces.edit_deploy_to' | 'workspaces.edit_auto_invite_domain' | 'workspaces.edit_webhook' | 'workspaces.edit_copilot_config' | 'workspaces.edit_error_handler' | 'workspaces.create' | 'workspaces.update' | 'workspaces.archive' | 'workspaces.unarchive' | 'workspaces.delete';
288
+ action_kind: 'Created' | 'Updated' | 'Delete' | 'Execute';
289
+ resource?: string;
290
+ parameters?: {
291
+ [key: string]: unknown;
292
+ };
293
+ };
294
+ export type operation = 'jobs.run' | 'jobs.run.script' | 'jobs.run.preview' | 'jobs.run.flow' | 'jobs.run.flow_preview' | 'jobs.run.script_hub' | 'jobs.run.dependencies' | 'jobs.run.identity' | 'jobs.run.noop' | 'jobs.flow_dependencies' | 'jobs' | 'jobs.cancel' | 'jobs.force_cancel' | 'jobs.disapproval' | 'jobs.delete' | 'account.delete' | 'openai.request' | 'resources.create' | 'resources.update' | 'resources.delete' | 'resource_types.create' | 'resource_types.update' | 'resource_types.delete' | 'schedule.create' | 'schedule.setenabled' | 'schedule.edit' | 'schedule.delete' | 'scripts.create' | 'scripts.update' | 'scripts.archive' | 'scripts.delete' | 'users.create' | 'users.delete' | 'users.update' | 'users.login' | 'users.logout' | 'users.accept_invite' | 'users.decline_invite' | 'users.token.create' | 'users.token.delete' | 'users.add_to_workspace' | 'users.add_global' | 'users.setpassword' | 'users.impersonate' | 'users.leave_workspace' | 'oauth.login' | 'oauth.signup' | 'variables.create' | 'variables.delete' | 'variables.update' | 'flows.create' | 'flows.update' | 'flows.delete' | 'flows.archive' | 'apps.create' | 'apps.update' | 'apps.delete' | 'folder.create' | 'folder.update' | 'folder.delete' | 'folder.add_owner' | 'folder.remove_owner' | 'group.create' | 'group.delete' | 'group.edit' | 'group.adduser' | 'group.removeuser' | 'igroup.create' | 'igroup.delete' | 'igroup.adduser' | 'igroup.removeuser' | 'variables.decrypt_secret' | 'workspaces.edit_command_script' | 'workspaces.edit_deploy_to' | 'workspaces.edit_auto_invite_domain' | 'workspaces.edit_webhook' | 'workspaces.edit_copilot_config' | 'workspaces.edit_error_handler' | 'workspaces.create' | 'workspaces.update' | 'workspaces.archive' | 'workspaces.unarchive' | 'workspaces.delete';
295
+ export type action_kind = 'Created' | 'Updated' | 'Delete' | 'Execute';
296
+ export type MainArgSignature = {
297
+ type: 'Valid' | 'Invalid';
298
+ error: string;
299
+ star_args: boolean;
300
+ star_kwargs?: boolean;
301
+ args: Array<{
302
+ name: string;
303
+ typ: ('float' | 'int' | 'bool' | 'email' | 'unknown' | 'bytes' | 'dict' | 'datetime' | 'sql' | {
304
+ resource: (string) | null;
305
+ } | {
306
+ str: Array<(string)> | null;
307
+ } | {
308
+ object: Array<{
309
+ key: string;
310
+ typ: ('float' | 'int' | 'bool' | 'email' | 'unknown' | 'bytes' | 'dict' | 'datetime' | 'sql' | {
311
+ str: unknown;
312
+ });
313
+ }>;
314
+ } | {
315
+ list: (('float' | 'int' | 'bool' | 'email' | 'unknown' | 'bytes' | 'dict' | 'datetime' | 'sql' | {
316
+ str: unknown;
317
+ }) | null);
318
+ });
319
+ has_default?: boolean;
320
+ default?: unknown;
321
+ }>;
322
+ no_main_func: (boolean) | null;
323
+ };
324
+ export type type2 = 'Valid' | 'Invalid';
325
+ export type Preview = {
326
+ content?: string;
327
+ path?: string;
328
+ args: ScriptArgs;
329
+ language?: 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible';
330
+ tag?: string;
331
+ kind?: 'code' | 'identity' | 'http';
332
+ dedicated_worker?: boolean;
333
+ lock?: string;
334
+ };
335
+ export type kind2 = 'code' | 'identity' | 'http';
336
+ export type WorkflowTask = {
337
+ args: ScriptArgs;
338
+ };
339
+ export type WorkflowStatusRecord = {
340
+ [key: string]: WorkflowStatus;
341
+ };
342
+ export type WorkflowStatus = {
343
+ scheduled_for?: string;
344
+ started_at?: string;
345
+ duration_ms?: number;
346
+ name?: string;
347
+ };
348
+ export type CreateResource = {
349
+ path: string;
350
+ value: unknown;
351
+ description?: string;
352
+ resource_type: string;
353
+ };
354
+ export type EditResource = {
355
+ path?: string;
356
+ description?: string;
357
+ value?: unknown;
358
+ };
359
+ export type Resource = {
360
+ workspace_id?: string;
361
+ path: string;
362
+ description?: string;
363
+ resource_type: string;
364
+ value?: unknown;
365
+ is_oauth: boolean;
366
+ extra_perms?: {
367
+ [key: string]: (boolean);
368
+ };
369
+ created_by?: string;
370
+ edited_at?: string;
371
+ };
372
+ export type ListableResource = {
373
+ workspace_id?: string;
374
+ path: string;
375
+ description?: string;
376
+ resource_type: string;
377
+ value?: unknown;
378
+ is_oauth: boolean;
379
+ extra_perms?: {
380
+ [key: string]: (boolean);
381
+ };
382
+ is_expired?: boolean;
383
+ refresh_error?: string;
384
+ is_linked: boolean;
385
+ is_refreshed: boolean;
386
+ account?: number;
387
+ created_by?: string;
388
+ edited_at?: string;
389
+ };
390
+ export type ResourceType = {
391
+ workspace_id?: string;
392
+ name: string;
393
+ schema?: unknown;
394
+ description?: string;
395
+ created_by?: string;
396
+ edited_at?: string;
397
+ format_extension?: string;
398
+ };
399
+ export type EditResourceType = {
400
+ schema?: unknown;
401
+ description?: string;
402
+ };
403
+ export type Schedule = {
404
+ path: string;
405
+ edited_by: string;
406
+ edited_at: string;
407
+ schedule: string;
408
+ timezone: string;
409
+ enabled: boolean;
410
+ script_path: string;
411
+ is_flow: boolean;
412
+ args?: ScriptArgs;
413
+ extra_perms: {
414
+ [key: string]: (boolean);
415
+ };
416
+ email: string;
417
+ error?: string;
418
+ on_failure?: string;
419
+ on_failure_times?: number;
420
+ on_failure_exact?: boolean;
421
+ on_failure_extra_args?: ScriptArgs;
422
+ on_recovery?: string;
423
+ on_recovery_times?: number;
424
+ on_recovery_extra_args?: ScriptArgs;
425
+ on_success?: string;
426
+ on_success_extra_args?: ScriptArgs;
427
+ ws_error_handler_muted?: boolean;
428
+ retry?: Retry;
429
+ summary?: string;
430
+ no_flow_overlap?: boolean;
431
+ tag?: string;
432
+ paused_until?: string;
433
+ };
434
+ export type ScheduleWJobs = Schedule & {
435
+ jobs?: Array<{
436
+ id: string;
437
+ success: boolean;
438
+ duration_ms: number;
439
+ }>;
440
+ };
441
+ export type NewSchedule = {
442
+ path: string;
443
+ schedule: string;
444
+ timezone: string;
445
+ script_path: string;
446
+ is_flow: boolean;
447
+ args: ScriptArgs;
448
+ enabled?: boolean;
449
+ on_failure?: string;
450
+ on_failure_times?: number;
451
+ on_failure_exact?: boolean;
452
+ on_failure_extra_args?: ScriptArgs;
453
+ on_recovery?: string;
454
+ on_recovery_times?: number;
455
+ on_recovery_extra_args?: ScriptArgs;
456
+ on_success?: string;
457
+ on_success_extra_args?: ScriptArgs;
458
+ ws_error_handler_muted?: boolean;
459
+ retry?: Retry;
460
+ no_flow_overlap?: boolean;
461
+ summary?: string;
462
+ tag?: string;
463
+ paused_until?: string;
464
+ };
465
+ export type EditSchedule = {
466
+ schedule: string;
467
+ timezone: string;
468
+ args: ScriptArgs;
469
+ on_failure?: string;
470
+ on_failure_times?: number;
471
+ on_failure_exact?: boolean;
472
+ on_failure_extra_args?: ScriptArgs;
473
+ on_recovery?: string;
474
+ on_recovery_times?: number;
475
+ on_recovery_extra_args?: ScriptArgs;
476
+ on_success?: string;
477
+ on_success_extra_args?: ScriptArgs;
478
+ ws_error_handler_muted?: boolean;
479
+ retry?: Retry;
480
+ no_flow_overlap?: boolean;
481
+ summary?: string;
482
+ tag?: string;
483
+ paused_until?: string;
484
+ };
485
+ export type Group = {
486
+ name: string;
487
+ summary?: string;
488
+ members?: Array<(string)>;
489
+ extra_perms?: {
490
+ [key: string]: (boolean);
491
+ };
492
+ };
493
+ export type InstanceGroup = {
494
+ name: string;
495
+ summary?: string;
496
+ emails?: Array<(string)>;
497
+ };
498
+ export type Folder = {
499
+ name: string;
500
+ owners: Array<(string)>;
501
+ extra_perms: {
502
+ [key: string]: (boolean);
503
+ };
504
+ summary?: string;
505
+ created_by?: string;
506
+ edited_at?: string;
507
+ };
508
+ export type WorkerPing = {
509
+ worker: string;
510
+ worker_instance: string;
511
+ last_ping?: number;
512
+ started_at: string;
513
+ ip: string;
514
+ jobs_executed: number;
515
+ custom_tags?: Array<(string)>;
516
+ worker_group: string;
517
+ wm_version: string;
518
+ last_job_id?: string;
519
+ last_job_workspace_id?: string;
520
+ occupancy_rate?: number;
521
+ memory?: number;
522
+ vcpus?: number;
523
+ memory_usage?: number;
524
+ wm_memory_usage?: number;
525
+ };
526
+ export type UserWorkspaceList = {
527
+ email: string;
528
+ workspaces: Array<{
529
+ id: string;
530
+ name: string;
531
+ username: string;
532
+ }>;
533
+ };
534
+ export type CreateWorkspace = {
535
+ id: string;
536
+ name: string;
537
+ username?: string;
538
+ };
539
+ export type Workspace = {
540
+ id: string;
541
+ name: string;
542
+ owner: string;
543
+ domain?: string;
544
+ };
545
+ export type WorkspaceInvite = {
546
+ workspace_id: string;
547
+ email: string;
548
+ is_admin: boolean;
549
+ operator: boolean;
550
+ };
551
+ export type GlobalUserInfo = {
552
+ email: string;
553
+ login_type: 'password' | 'github';
554
+ super_admin: boolean;
555
+ verified: boolean;
556
+ name?: string;
557
+ company?: string;
558
+ username?: string;
559
+ };
560
+ export type login_type = 'password' | 'github';
561
+ export type Flow = OpenFlow & FlowMetadata;
562
+ export type ExtraPerms = {
563
+ [key: string]: (boolean);
564
+ };
565
+ export type FlowMetadata = {
566
+ workspace_id?: string;
567
+ path: string;
568
+ edited_by: string;
569
+ edited_at: string;
570
+ archived: boolean;
571
+ extra_perms: ExtraPerms;
572
+ starred?: boolean;
573
+ draft_only?: boolean;
574
+ tag?: string;
575
+ ws_error_handler_muted?: boolean;
576
+ priority?: number;
577
+ dedicated_worker?: boolean;
578
+ timeout?: number;
579
+ visible_to_runner_only?: boolean;
580
+ };
581
+ export type OpenFlowWPath = OpenFlow & {
582
+ path: string;
583
+ tag?: string;
584
+ ws_error_handler_muted?: boolean;
585
+ priority?: number;
586
+ dedicated_worker?: boolean;
587
+ timeout?: number;
588
+ visible_to_runner_only?: boolean;
589
+ };
590
+ export type FlowPreview = {
591
+ value: FlowValue;
592
+ path?: string;
593
+ args: ScriptArgs;
594
+ tag?: string;
595
+ restarted_from?: RestartedFrom;
596
+ };
597
+ export type RestartedFrom = {
598
+ flow_job_id?: string;
599
+ step_id?: string;
600
+ branch_or_iteration_n?: number;
601
+ };
602
+ export type Policy = {
603
+ triggerables?: {
604
+ [key: string]: {
605
+ [key: string]: unknown;
606
+ };
607
+ };
608
+ triggerables_v2?: {
609
+ [key: string]: {
610
+ [key: string]: unknown;
611
+ };
612
+ };
613
+ execution_mode?: 'viewer' | 'publisher' | 'anonymous';
614
+ on_behalf_of?: string;
615
+ on_behalf_of_email?: string;
616
+ };
617
+ export type execution_mode = 'viewer' | 'publisher' | 'anonymous';
618
+ export type ListableApp = {
619
+ id: number;
620
+ workspace_id: string;
621
+ path: string;
622
+ summary: string;
623
+ version: number;
624
+ extra_perms: {
625
+ [key: string]: (boolean);
626
+ };
627
+ starred?: boolean;
628
+ edited_at: string;
629
+ execution_mode: 'viewer' | 'publisher' | 'anonymous';
630
+ };
631
+ export type ListableRawApp = {
632
+ workspace_id: string;
633
+ path: string;
634
+ summary: string;
635
+ extra_perms: {
636
+ [key: string]: (boolean);
637
+ };
638
+ starred?: boolean;
639
+ version: number;
640
+ edited_at: string;
641
+ };
642
+ export type AppWithLastVersion = {
643
+ id: number;
644
+ workspace_id: string;
645
+ path: string;
646
+ summary: string;
647
+ versions: Array<(number)>;
648
+ created_by: string;
649
+ created_at: string;
650
+ value: {
651
+ [key: string]: unknown;
652
+ };
653
+ policy: Policy;
654
+ execution_mode: 'viewer' | 'publisher' | 'anonymous';
655
+ extra_perms: {
656
+ [key: string]: (boolean);
657
+ };
658
+ };
659
+ export type AppWithLastVersionWDraft = AppWithLastVersion & {
660
+ draft_only?: boolean;
661
+ draft?: unknown;
662
+ };
663
+ export type AppHistory = {
664
+ version: number;
665
+ deployment_msg?: string;
666
+ };
667
+ export type FlowVersion = {
668
+ id: number;
669
+ created_at: string;
670
+ deployment_msg?: string;
671
+ };
672
+ export type SlackToken = {
673
+ access_token: string;
674
+ team_id: string;
675
+ team_name: string;
676
+ bot: {
677
+ bot_access_token?: string;
678
+ };
679
+ };
680
+ export type TokenResponse = {
681
+ access_token: string;
682
+ expires_in?: number;
683
+ refresh_token?: string;
684
+ scope?: Array<(string)>;
685
+ };
686
+ export type HubScriptKind = unknown;
687
+ export type PolarsClientKwargs = {
688
+ region_name: string;
689
+ };
690
+ export type LargeFileStorage = {
691
+ type?: 'S3Storage' | 'AzureBlobStorage' | 'AzureWorkloadIdentity' | 'S3AwsOidc';
692
+ s3_resource_path?: string;
693
+ azure_blob_resource_path?: string;
694
+ public_resource?: boolean;
695
+ secondary_storage?: {
696
+ [key: string]: {
697
+ type?: 'S3Storage' | 'AzureBlobStorage' | 'AzureWorkloadIdentity' | 'S3AwsOidc';
698
+ s3_resource_path?: string;
699
+ azure_blob_resource_path?: string;
700
+ public_resource?: boolean;
701
+ };
702
+ };
703
+ };
704
+ export type type3 = 'S3Storage' | 'AzureBlobStorage' | 'AzureWorkloadIdentity' | 'S3AwsOidc';
705
+ export type WindmillLargeFile = {
706
+ s3: string;
707
+ };
708
+ export type WindmillFileMetadata = {
709
+ mime_type?: string;
710
+ size_in_bytes?: number;
711
+ last_modified?: string;
712
+ expires?: string;
713
+ version_id?: string;
714
+ };
715
+ export type WindmillFilePreview = {
716
+ msg?: string;
717
+ content?: string;
718
+ content_type: 'RawText' | 'Csv' | 'Parquet' | 'Unknown';
719
+ };
720
+ export type content_type = 'RawText' | 'Csv' | 'Parquet' | 'Unknown';
721
+ export type S3Resource = {
722
+ bucket: string;
723
+ region: string;
724
+ endPoint: string;
725
+ useSSL: boolean;
726
+ accessKey?: string;
727
+ secretKey?: string;
728
+ pathStyle: boolean;
729
+ };
730
+ export type WorkspaceGitSyncSettings = {
731
+ include_path?: Array<(string)>;
732
+ include_type?: Array<('script' | 'flow' | 'app' | 'folder' | 'resource' | 'variable' | 'secret' | 'resourcetype' | 'schedule' | 'user' | 'group')>;
733
+ repositories?: Array<GitRepositorySettings>;
734
+ };
735
+ export type WorkspaceDeployUISettings = {
736
+ include_path?: Array<(string)>;
737
+ include_type?: Array<('script' | 'flow' | 'app' | 'resource' | 'variable' | 'secret')>;
738
+ };
739
+ export type WorkspaceDefaultScripts = {
740
+ order?: Array<(string)>;
741
+ hidden?: Array<(string)>;
742
+ default_script_content?: {
743
+ [key: string]: (string);
744
+ };
745
+ };
746
+ export type GitRepositorySettings = {
747
+ script_path: string;
748
+ git_repo_resource_path: string;
749
+ use_individual_branch?: boolean;
750
+ group_by_folder?: boolean;
751
+ exclude_types_override?: Array<('script' | 'flow' | 'app' | 'folder' | 'resource' | 'variable' | 'secret' | 'resourcetype' | 'schedule' | 'user' | 'group')>;
752
+ };
753
+ export type UploadFilePart = {
754
+ part_number: number;
755
+ tag: string;
756
+ };
757
+ export type MetricMetadata = {
758
+ id: string;
759
+ name?: string;
760
+ };
761
+ export type ScalarMetric = {
762
+ metric_id?: string;
763
+ value: number;
764
+ };
765
+ export type TimeseriesMetric = {
766
+ metric_id?: string;
767
+ values: Array<MetricDataPoint>;
768
+ };
769
+ export type MetricDataPoint = {
770
+ timestamp: string;
771
+ value: number;
772
+ };
773
+ export type RawScriptForDependencies = {
774
+ raw_code: string;
775
+ path: string;
776
+ language: 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible';
777
+ };
778
+ export type ConcurrencyGroup = {
779
+ concurrency_key: string;
780
+ total_running: number;
781
+ };
782
+ export type ExtendedJobs = {
783
+ jobs: Array<Job>;
784
+ obscured_jobs: Array<ObscuredJob>;
785
+ /**
786
+ * Obscured jobs omitted for security because of too specific filtering
787
+ */
788
+ omitted_obscured_jobs?: boolean;
789
+ };
790
+ export type ExportedUser = {
791
+ email: string;
792
+ password_hash?: string;
793
+ super_admin: boolean;
794
+ verified: boolean;
795
+ name?: string;
796
+ company?: string;
797
+ first_time_user: boolean;
798
+ username?: string;
799
+ };
800
+ export type GlobalSetting = {
801
+ name: string;
802
+ value: {
803
+ [key: string]: unknown;
804
+ };
805
+ };
806
+ export type Config = {
807
+ name: string;
808
+ config?: {
809
+ [key: string]: unknown;
810
+ };
811
+ };
812
+ export type ExportedInstanceGroup = {
813
+ name: string;
814
+ summary?: string;
815
+ emails?: Array<(string)>;
816
+ id?: string;
817
+ scim_display_name?: string;
818
+ external_id?: string;
819
+ };
820
+ export type JobSearchHit = {
821
+ dancer?: string;
822
+ };
823
+ export type OpenFlow = {
824
+ summary: string;
825
+ description?: string;
826
+ value: FlowValue;
827
+ schema?: {
828
+ [key: string]: unknown;
829
+ };
830
+ };
831
+ export type FlowValue = {
832
+ modules: Array<FlowModule>;
833
+ failure_module?: FlowModule;
834
+ same_worker?: boolean;
835
+ concurrent_limit?: number;
836
+ concurrency_key?: string;
837
+ concurrency_time_window_s?: number;
838
+ skip_expr?: string;
839
+ cache_ttl?: number;
840
+ priority?: number;
841
+ early_return?: string;
842
+ };
843
+ export type Retry = {
844
+ constant?: {
845
+ attempts?: number;
846
+ seconds?: number;
847
+ };
848
+ exponential?: {
849
+ attempts?: number;
850
+ multiplier?: number;
851
+ seconds?: number;
852
+ random_factor?: number;
853
+ };
854
+ };
855
+ export type FlowModule = {
856
+ id: string;
857
+ value: FlowModuleValue;
858
+ stop_after_if?: {
859
+ skip_if_stopped?: boolean;
860
+ expr: string;
861
+ };
862
+ stop_after_all_iters_if?: {
863
+ skip_if_stopped?: boolean;
864
+ expr: string;
865
+ };
866
+ sleep?: InputTransform;
867
+ cache_ttl?: number;
868
+ timeout?: number;
869
+ delete_after_use?: boolean;
870
+ summary?: string;
871
+ mock?: {
872
+ enabled?: boolean;
873
+ return_value?: unknown;
874
+ };
875
+ suspend?: {
876
+ required_events?: number;
877
+ timeout?: number;
878
+ resume_form?: {
879
+ schema?: {
880
+ [key: string]: unknown;
881
+ };
882
+ };
883
+ user_auth_required?: boolean;
884
+ user_groups_required?: InputTransform;
885
+ self_approval_disabled?: boolean;
886
+ hide_cancel?: boolean;
887
+ continue_on_disapprove_timeout?: boolean;
888
+ };
889
+ priority?: number;
890
+ continue_on_error?: boolean;
891
+ retry?: Retry;
892
+ };
893
+ export type InputTransform = StaticTransform | JavascriptTransform;
894
+ export type StaticTransform = {
895
+ value?: unknown;
896
+ type: 'static';
897
+ };
898
+ export type JavascriptTransform = {
899
+ expr: string;
900
+ type: 'javascript';
901
+ };
902
+ export type FlowModuleValue = RawScript | PathScript | PathFlow | ForloopFlow | WhileloopFlow | BranchOne | BranchAll | Identity;
903
+ export type RawScript = {
904
+ input_transforms: {
905
+ [key: string]: InputTransform;
906
+ };
907
+ content: string;
908
+ language: 'deno' | 'bun' | 'python3' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'php';
909
+ path?: string;
910
+ lock?: string;
911
+ type: 'rawscript';
912
+ tag?: string;
913
+ concurrent_limit?: number;
914
+ concurrency_time_window_s?: number;
915
+ custom_concurrency_key?: string;
916
+ };
917
+ export type language2 = 'deno' | 'bun' | 'python3' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'graphql' | 'nativets' | 'php';
918
+ export type PathScript = {
919
+ input_transforms: {
920
+ [key: string]: InputTransform;
921
+ };
922
+ path: string;
923
+ hash?: string;
924
+ type: 'script';
925
+ tag_override?: string;
926
+ };
927
+ export type PathFlow = {
928
+ input_transforms: {
929
+ [key: string]: InputTransform;
930
+ };
931
+ path: string;
932
+ type: 'flow';
933
+ };
934
+ export type ForloopFlow = {
935
+ modules: Array<FlowModule>;
936
+ iterator: InputTransform;
937
+ skip_failures: boolean;
938
+ type: 'forloopflow';
939
+ parallel?: boolean;
940
+ parallelism?: number;
941
+ };
942
+ export type WhileloopFlow = {
943
+ modules: Array<FlowModule>;
944
+ skip_failures: boolean;
945
+ type: 'whileloopflow';
946
+ parallel?: boolean;
947
+ parallelism?: number;
948
+ };
949
+ export type BranchOne = {
950
+ branches: Array<{
951
+ summary?: string;
952
+ expr: string;
953
+ modules: Array<FlowModule>;
954
+ }>;
955
+ default: Array<FlowModule>;
956
+ type: 'branchone';
957
+ };
958
+ export type BranchAll = {
959
+ branches: Array<{
960
+ summary?: string;
961
+ skip_failure?: boolean;
962
+ modules: Array<FlowModule>;
963
+ }>;
964
+ type: 'branchall';
965
+ parallel?: boolean;
966
+ };
967
+ export type Identity = {
968
+ type: 'identity';
969
+ flow?: boolean;
970
+ };
971
+ export type FlowStatus = {
972
+ step: number;
973
+ modules: Array<FlowStatusModule>;
974
+ user_states?: {
975
+ [key: string]: unknown;
976
+ };
977
+ failure_module: (FlowStatusModule & {
978
+ parent_module?: string;
979
+ });
980
+ retry?: {
981
+ fail_count?: number;
982
+ failed_jobs?: Array<(string)>;
983
+ };
984
+ };
985
+ export type FlowStatusModule = {
986
+ type: 'WaitingForPriorSteps' | 'WaitingForEvents' | 'WaitingForExecutor' | 'InProgress' | 'Success' | 'Failure';
987
+ id?: string;
988
+ job?: string;
989
+ count?: number;
990
+ progress?: number;
991
+ iterator?: {
992
+ index?: number;
993
+ itered?: Array<unknown>;
994
+ args?: unknown;
995
+ };
996
+ flow_jobs?: Array<(string)>;
997
+ flow_jobs_success?: Array<(boolean)>;
998
+ branch_chosen?: {
999
+ type: 'branch' | 'default';
1000
+ branch?: number;
1001
+ };
1002
+ branchall?: {
1003
+ branch: number;
1004
+ len: number;
1005
+ };
1006
+ approvers?: Array<{
1007
+ resume_id: number;
1008
+ approver: string;
1009
+ }>;
1010
+ failed_retries?: Array<(string)>;
1011
+ };
1012
+ export type type4 = 'WaitingForPriorSteps' | 'WaitingForEvents' | 'WaitingForExecutor' | 'InProgress' | 'Success' | 'Failure';
1013
+ export type ParameterKey = string;
1014
+ export type ParameterWorkspaceId = string;
1015
+ export type ParameterVersionId = number;
1016
+ export type ParameterToken = string;
1017
+ export type ParameterAccountId = number;
1018
+ export type ParameterClientName = string;
1019
+ export type ParameterScriptPath = string;
1020
+ export type ParameterScriptHash = string;
1021
+ export type ParameterJobId = string;
1022
+ export type ParameterPath = string;
1023
+ export type ParameterPathId = number;
1024
+ export type ParameterPathVersion = number;
1025
+ export type ParameterName = string;
1026
+ /**
1027
+ * which page to return (start at 1, default 1)
1028
+ */
1029
+ export type ParameterPage = number;
1030
+ /**
1031
+ * number of items to return for a given page (default 30, max 100)
1032
+ */
1033
+ export type ParameterPerPage = number;
1034
+ /**
1035
+ * order by desc order (default true)
1036
+ */
1037
+ export type ParameterOrderDesc = boolean;
1038
+ /**
1039
+ * mask to filter exact matching user creator
1040
+ */
1041
+ export type ParameterCreatedBy = string;
1042
+ /**
1043
+ * mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
1044
+ */
1045
+ export type ParameterLabel = string;
1046
+ /**
1047
+ * The parent job that is at the origin and responsible for the execution of this script if any
1048
+ */
1049
+ export type ParameterParentJob = string;
1050
+ /**
1051
+ * Override the tag to use
1052
+ */
1053
+ export type ParameterWorkerTag = string;
1054
+ /**
1055
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
1056
+ */
1057
+ export type ParameterCacheTtl = string;
1058
+ /**
1059
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
1060
+ */
1061
+ export type ParameterNewJobId = string;
1062
+ /**
1063
+ * List of headers's keys (separated with ',') whove value are added to the args
1064
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1065
+ *
1066
+ */
1067
+ export type ParameterIncludeHeader = string;
1068
+ /**
1069
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
1070
+ *
1071
+ */
1072
+ export type ParameterQueueLimit = string;
1073
+ /**
1074
+ * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
1075
+ * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
1076
+ *
1077
+ */
1078
+ export type ParameterPayload = string;
1079
+ /**
1080
+ * mask to filter matching starting path
1081
+ */
1082
+ export type ParameterScriptStartPath = string;
1083
+ /**
1084
+ * mask to filter by schedule path
1085
+ */
1086
+ export type ParameterSchedulePath = string;
1087
+ /**
1088
+ * mask to filter exact matching path
1089
+ */
1090
+ export type ParameterScriptExactPath = string;
1091
+ /**
1092
+ * mask to filter exact matching path
1093
+ */
1094
+ export type ParameterScriptExactHash = string;
1095
+ /**
1096
+ * filter on created before (inclusive) timestamp
1097
+ */
1098
+ export type ParameterCreatedBefore = string;
1099
+ /**
1100
+ * filter on created after (exclusive) timestamp
1101
+ */
1102
+ export type ParameterCreatedAfter = string;
1103
+ /**
1104
+ * filter on started before (inclusive) timestamp
1105
+ */
1106
+ export type ParameterStartedBefore = string;
1107
+ /**
1108
+ * filter on started after (exclusive) timestamp
1109
+ */
1110
+ export type ParameterStartedAfter = string;
1111
+ /**
1112
+ * filter on started before (inclusive) timestamp
1113
+ */
1114
+ export type ParameterBefore = string;
1115
+ /**
1116
+ * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
1117
+ */
1118
+ export type ParameterCreatedOrStartedAfter = string;
1119
+ /**
1120
+ * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp but only for the completed jobs
1121
+ */
1122
+ export type ParameterCreatedOrStartedAfterCompletedJob = string;
1123
+ /**
1124
+ * filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
1125
+ */
1126
+ export type ParameterCreatedOrStartedBefore = string;
1127
+ /**
1128
+ * filter on successful jobs
1129
+ */
1130
+ export type ParameterSuccess = boolean;
1131
+ /**
1132
+ * filter on jobs scheduled_for before now (hence waitinf for a worker)
1133
+ */
1134
+ export type ParameterScheduledForBeforeNow = boolean;
1135
+ /**
1136
+ * filter on suspended jobs
1137
+ */
1138
+ export type ParameterSuspended = boolean;
1139
+ /**
1140
+ * filter on running jobs
1141
+ */
1142
+ export type ParameterRunning = boolean;
1143
+ /**
1144
+ * filter on jobs containing those args as a json subset (@> in postgres)
1145
+ */
1146
+ export type ParameterArgsFilter = string;
1147
+ /**
1148
+ * filter on jobs with a given tag/worker group
1149
+ */
1150
+ export type ParameterTag = string;
1151
+ /**
1152
+ * filter on jobs containing those result as a json subset (@> in postgres)
1153
+ */
1154
+ export type ParameterResultFilter = string;
1155
+ /**
1156
+ * filter on created after (exclusive) timestamp
1157
+ */
1158
+ export type ParameterAfter = string;
1159
+ /**
1160
+ * filter on exact username of user
1161
+ */
1162
+ export type ParameterUsername = string;
1163
+ /**
1164
+ * filter on exact or prefix name of operation
1165
+ */
1166
+ export type ParameterOperation = string;
1167
+ /**
1168
+ * filter on exact or prefix name of resource
1169
+ */
1170
+ export type ParameterResourceName = string;
1171
+ /**
1172
+ * filter on type of operation
1173
+ */
1174
+ export type ParameterActionKind = 'Create' | 'Update' | 'Delete' | 'Execute';
1175
+ /**
1176
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
1177
+ */
1178
+ export type ParameterJobKinds = string;
1179
+ export type ParameterRunnableId = string;
1180
+ export type ParameterRunnableTypeQuery = RunnableType;
1181
+ export type ParameterInputId = string;
1182
+ export type ParameterGetStarted = boolean;
1183
+ export type ParameterConcurrencyId = string;
1184
+ export type BackendVersionResponse = (string);
1185
+ export type BackendUptodateResponse = (string);
1186
+ export type GetLicenseIdResponse = (string);
1187
+ export type GetOpenApiYamlResponse = (string);
1188
+ export type GetAuditLogData = {
1189
+ id: number;
1190
+ workspace: string;
1191
+ };
1192
+ export type GetAuditLogResponse = (AuditLog);
1193
+ export type ListAuditLogsData = {
1194
+ /**
1195
+ * filter on type of operation
1196
+ */
1197
+ actionKind?: 'Create' | 'Update' | 'Delete' | 'Execute';
1198
+ /**
1199
+ * filter on created after (exclusive) timestamp
1200
+ */
1201
+ after?: string;
1202
+ /**
1203
+ * filter on started before (inclusive) timestamp
1204
+ */
1205
+ before?: string;
1206
+ /**
1207
+ * comma separated list of operations to exclude
1208
+ */
1209
+ excludeOperations?: string;
1210
+ /**
1211
+ * filter on exact or prefix name of operation
1212
+ */
1213
+ operation?: string;
1214
+ /**
1215
+ * comma separated list of exact operations to include
1216
+ */
1217
+ operations?: string;
1218
+ /**
1219
+ * which page to return (start at 1, default 1)
1220
+ */
1221
+ page?: number;
1222
+ /**
1223
+ * number of items to return for a given page (default 30, max 100)
1224
+ */
1225
+ perPage?: number;
1226
+ /**
1227
+ * filter on exact or prefix name of resource
1228
+ */
1229
+ resource?: string;
1230
+ /**
1231
+ * filter on exact username of user
1232
+ */
1233
+ username?: string;
1234
+ workspace: string;
1235
+ };
1236
+ export type ListAuditLogsResponse = (Array<AuditLog>);
1237
+ export type LoginData = {
1238
+ /**
1239
+ * credentials
1240
+ */
1241
+ requestBody: Login;
1242
+ };
1243
+ export type LoginResponse = (string);
1244
+ export type LogoutResponse = (string);
1245
+ export type GetUserData = {
1246
+ username: string;
1247
+ workspace: string;
1248
+ };
1249
+ export type GetUserResponse = (User);
1250
+ export type UpdateUserData = {
1251
+ /**
1252
+ * new user
1253
+ */
1254
+ requestBody: EditWorkspaceUser;
1255
+ username: string;
1256
+ workspace: string;
1257
+ };
1258
+ export type UpdateUserResponse = (string);
1259
+ export type IsOwnerOfPathData = {
1260
+ path: string;
1261
+ workspace: string;
1262
+ };
1263
+ export type IsOwnerOfPathResponse = (boolean);
1264
+ export type SetPasswordData = {
1265
+ /**
1266
+ * set password
1267
+ */
1268
+ requestBody: {
1269
+ password: string;
1270
+ };
1271
+ };
1272
+ export type SetPasswordResponse = (string);
1273
+ export type CreateUserGloballyData = {
1274
+ /**
1275
+ * user info
1276
+ */
1277
+ requestBody: {
1278
+ email: string;
1279
+ password: string;
1280
+ super_admin: boolean;
1281
+ name?: string;
1282
+ company?: string;
1283
+ };
1284
+ };
1285
+ export type CreateUserGloballyResponse = (string);
1286
+ export type GlobalUserUpdateData = {
1287
+ email: string;
1288
+ /**
1289
+ * new user info
1290
+ */
1291
+ requestBody: {
1292
+ is_super_admin?: boolean;
1293
+ name?: string;
1294
+ };
1295
+ };
1296
+ export type GlobalUserUpdateResponse = (string);
1297
+ export type GlobalUsernameInfoData = {
1298
+ email: string;
1299
+ };
1300
+ export type GlobalUsernameInfoResponse = ({
1301
+ username: string;
1302
+ workspace_usernames: Array<{
1303
+ workspace_id: string;
1304
+ username: string;
1305
+ }>;
1306
+ });
1307
+ export type GlobalUserRenameData = {
1308
+ email: string;
1309
+ /**
1310
+ * new username
1311
+ */
1312
+ requestBody: {
1313
+ new_username: string;
1314
+ };
1315
+ };
1316
+ export type GlobalUserRenameResponse = (string);
1317
+ export type GlobalUserDeleteData = {
1318
+ email: string;
1319
+ };
1320
+ export type GlobalUserDeleteResponse = (string);
1321
+ export type GlobalUsersOverwriteData = {
1322
+ /**
1323
+ * List of users
1324
+ */
1325
+ requestBody: Array<ExportedUser>;
1326
+ };
1327
+ export type GlobalUsersOverwriteResponse = (string);
1328
+ export type GlobalUsersExportResponse = (Array<ExportedUser>);
1329
+ export type DeleteUserData = {
1330
+ username: string;
1331
+ workspace: string;
1332
+ };
1333
+ export type DeleteUserResponse = (string);
1334
+ export type ListWorkspacesResponse = (Array<Workspace>);
1335
+ export type IsDomainAllowedResponse = (boolean);
1336
+ export type ListUserWorkspacesResponse = (UserWorkspaceList);
1337
+ export type ListWorkspacesAsSuperAdminData = {
1338
+ /**
1339
+ * which page to return (start at 1, default 1)
1340
+ */
1341
+ page?: number;
1342
+ /**
1343
+ * number of items to return for a given page (default 30, max 100)
1344
+ */
1345
+ perPage?: number;
1346
+ };
1347
+ export type ListWorkspacesAsSuperAdminResponse = (Array<Workspace>);
1348
+ export type CreateWorkspaceData = {
1349
+ /**
1350
+ * new token
1351
+ */
1352
+ requestBody: CreateWorkspace;
1353
+ };
1354
+ export type CreateWorkspaceResponse = (string);
1355
+ export type ExistsWorkspaceData = {
1356
+ /**
1357
+ * id of workspace
1358
+ */
1359
+ requestBody: {
1360
+ id: string;
1361
+ };
1362
+ };
1363
+ export type ExistsWorkspaceResponse = (boolean);
1364
+ export type ExistsUsernameData = {
1365
+ requestBody: {
1366
+ id: string;
1367
+ username: string;
1368
+ };
1369
+ };
1370
+ export type ExistsUsernameResponse = (boolean);
1371
+ export type GetGlobalData = {
1372
+ key: string;
1373
+ };
1374
+ export type GetGlobalResponse = (unknown);
1375
+ export type SetGlobalData = {
1376
+ key: string;
1377
+ /**
1378
+ * value set
1379
+ */
1380
+ requestBody: {
1381
+ value?: unknown;
1382
+ };
1383
+ };
1384
+ export type SetGlobalResponse = (string);
1385
+ export type GetLocalResponse = (unknown);
1386
+ export type TestSmtpData = {
1387
+ /**
1388
+ * test smtp payload
1389
+ */
1390
+ requestBody: {
1391
+ to: string;
1392
+ smtp: {
1393
+ host: string;
1394
+ username: string;
1395
+ password: string;
1396
+ port: number;
1397
+ from: string;
1398
+ tls_implicit: boolean;
1399
+ };
1400
+ };
1401
+ };
1402
+ export type TestSmtpResponse = (string);
1403
+ export type TestLicenseKeyData = {
1404
+ /**
1405
+ * test license key
1406
+ */
1407
+ requestBody: {
1408
+ license_key: string;
1409
+ };
1410
+ };
1411
+ export type TestLicenseKeyResponse = (string);
1412
+ export type TestObjectStorageConfigData = {
1413
+ /**
1414
+ * test object storage config
1415
+ */
1416
+ requestBody: {
1417
+ [key: string]: unknown;
1418
+ };
1419
+ };
1420
+ export type TestObjectStorageConfigResponse = (string);
1421
+ export type SendStatsResponse = (string);
1422
+ export type GetLatestKeyRenewalAttemptResponse = ({
1423
+ result: string;
1424
+ attempted_at: string;
1425
+ } | null);
1426
+ export type RenewLicenseKeyData = {
1427
+ licenseKey?: string;
1428
+ };
1429
+ export type RenewLicenseKeyResponse = (string);
1430
+ export type CreateCustomerPortalSessionData = {
1431
+ licenseKey?: string;
1432
+ };
1433
+ export type CreateCustomerPortalSessionResponse = (string);
1434
+ export type TestMetadataData = {
1435
+ /**
1436
+ * test metadata
1437
+ */
1438
+ requestBody: string;
1439
+ };
1440
+ export type TestMetadataResponse = (string);
1441
+ export type ListGlobalSettingsResponse = (Array<GlobalSetting>);
1442
+ export type GetCurrentEmailResponse = (string);
1443
+ export type RefreshUserTokenResponse = (string);
1444
+ export type GetTutorialProgressResponse = ({
1445
+ progress?: number;
1446
+ });
1447
+ export type UpdateTutorialProgressData = {
1448
+ /**
1449
+ * progress update
1450
+ */
1451
+ requestBody: {
1452
+ progress?: number;
1453
+ };
1454
+ };
1455
+ export type UpdateTutorialProgressResponse = (string);
1456
+ export type LeaveInstanceResponse = (string);
1457
+ export type GetUsageResponse = (number);
1458
+ export type GetRunnableResponse = ({
1459
+ workspace: string;
1460
+ endpoint_async: string;
1461
+ endpoint_sync: string;
1462
+ endpoint_openai_sync: string;
1463
+ summary: string;
1464
+ description?: string;
1465
+ kind: string;
1466
+ });
1467
+ export type GlobalWhoamiResponse = (GlobalUserInfo);
1468
+ export type ListWorkspaceInvitesResponse = (Array<WorkspaceInvite>);
1469
+ export type WhoamiData = {
1470
+ workspace: string;
1471
+ };
1472
+ export type WhoamiResponse = (User);
1473
+ export type AcceptInviteData = {
1474
+ /**
1475
+ * accept invite
1476
+ */
1477
+ requestBody: {
1478
+ workspace_id: string;
1479
+ username?: string;
1480
+ };
1481
+ };
1482
+ export type AcceptInviteResponse = (string);
1483
+ export type DeclineInviteData = {
1484
+ /**
1485
+ * decline invite
1486
+ */
1487
+ requestBody: {
1488
+ workspace_id: string;
1489
+ };
1490
+ };
1491
+ export type DeclineInviteResponse = (string);
1492
+ export type InviteUserData = {
1493
+ /**
1494
+ * WorkspaceInvite
1495
+ */
1496
+ requestBody: {
1497
+ email: string;
1498
+ is_admin: boolean;
1499
+ operator: boolean;
1500
+ };
1501
+ workspace: string;
1502
+ };
1503
+ export type InviteUserResponse = (string);
1504
+ export type AddUserData = {
1505
+ /**
1506
+ * WorkspaceInvite
1507
+ */
1508
+ requestBody: {
1509
+ email: string;
1510
+ is_admin: boolean;
1511
+ username?: string;
1512
+ operator: boolean;
1513
+ };
1514
+ workspace: string;
1515
+ };
1516
+ export type AddUserResponse = (string);
1517
+ export type DeleteInviteData = {
1518
+ /**
1519
+ * WorkspaceInvite
1520
+ */
1521
+ requestBody: {
1522
+ email: string;
1523
+ is_admin: boolean;
1524
+ operator: boolean;
1525
+ };
1526
+ workspace: string;
1527
+ };
1528
+ export type DeleteInviteResponse = (string);
1529
+ export type ArchiveWorkspaceData = {
1530
+ workspace: string;
1531
+ };
1532
+ export type ArchiveWorkspaceResponse = (string);
1533
+ export type UnarchiveWorkspaceData = {
1534
+ workspace: string;
1535
+ };
1536
+ export type UnarchiveWorkspaceResponse = (string);
1537
+ export type DeleteWorkspaceData = {
1538
+ workspace: string;
1539
+ };
1540
+ export type DeleteWorkspaceResponse = (string);
1541
+ export type LeaveWorkspaceData = {
1542
+ workspace: string;
1543
+ };
1544
+ export type LeaveWorkspaceResponse = (string);
1545
+ export type GetWorkspaceNameData = {
1546
+ workspace: string;
1547
+ };
1548
+ export type GetWorkspaceNameResponse = (string);
1549
+ export type ChangeWorkspaceNameData = {
1550
+ requestBody?: {
1551
+ new_name?: string;
1552
+ };
1553
+ workspace: string;
1554
+ };
1555
+ export type ChangeWorkspaceNameResponse = (string);
1556
+ export type ChangeWorkspaceIdData = {
1557
+ requestBody?: {
1558
+ new_id?: string;
1559
+ new_name?: string;
1560
+ };
1561
+ workspace: string;
1562
+ };
1563
+ export type ChangeWorkspaceIdResponse = (string);
1564
+ export type WhoisData = {
1565
+ username: string;
1566
+ workspace: string;
1567
+ };
1568
+ export type WhoisResponse = (User);
1569
+ export type ExistsEmailData = {
1570
+ email: string;
1571
+ };
1572
+ export type ExistsEmailResponse = (boolean);
1573
+ export type ListUsersAsSuperAdminData = {
1574
+ /**
1575
+ * which page to return (start at 1, default 1)
1576
+ */
1577
+ page?: number;
1578
+ /**
1579
+ * number of items to return for a given page (default 30, max 100)
1580
+ */
1581
+ perPage?: number;
1582
+ };
1583
+ export type ListUsersAsSuperAdminResponse = (Array<GlobalUserInfo>);
1584
+ export type ListPendingInvitesData = {
1585
+ workspace: string;
1586
+ };
1587
+ export type ListPendingInvitesResponse = (Array<WorkspaceInvite>);
1588
+ export type GetSettingsData = {
1589
+ workspace: string;
1590
+ };
1591
+ export type GetSettingsResponse = ({
1592
+ workspace_id?: string;
1593
+ slack_name?: string;
1594
+ slack_team_id?: string;
1595
+ slack_command_script?: string;
1596
+ auto_invite_domain?: string;
1597
+ auto_invite_operator?: boolean;
1598
+ auto_add?: boolean;
1599
+ plan?: string;
1600
+ automatic_billing: boolean;
1601
+ customer_id?: string;
1602
+ webhook?: string;
1603
+ deploy_to?: string;
1604
+ openai_resource_path?: string;
1605
+ code_completion_enabled: boolean;
1606
+ error_handler?: string;
1607
+ error_handler_extra_args?: ScriptArgs;
1608
+ error_handler_muted_on_cancel: boolean;
1609
+ large_file_storage?: LargeFileStorage;
1610
+ git_sync?: WorkspaceGitSyncSettings;
1611
+ deploy_ui?: WorkspaceDeployUISettings;
1612
+ default_app?: string;
1613
+ default_scripts?: WorkspaceDefaultScripts;
1614
+ });
1615
+ export type GetDeployToData = {
1616
+ workspace: string;
1617
+ };
1618
+ export type GetDeployToResponse = ({
1619
+ deploy_to?: string;
1620
+ });
1621
+ export type GetIsPremiumData = {
1622
+ workspace: string;
1623
+ };
1624
+ export type GetIsPremiumResponse = (boolean);
1625
+ export type GetPremiumInfoData = {
1626
+ workspace: string;
1627
+ };
1628
+ export type GetPremiumInfoResponse = ({
1629
+ premium: boolean;
1630
+ usage?: number;
1631
+ seats?: number;
1632
+ automatic_billing: boolean;
1633
+ });
1634
+ export type SetAutomaticBillingData = {
1635
+ /**
1636
+ * automatic billing
1637
+ */
1638
+ requestBody: {
1639
+ automatic_billing: boolean;
1640
+ seats?: number;
1641
+ };
1642
+ workspace: string;
1643
+ };
1644
+ export type SetAutomaticBillingResponse = (string);
1645
+ export type EditSlackCommandData = {
1646
+ /**
1647
+ * WorkspaceInvite
1648
+ */
1649
+ requestBody: {
1650
+ slack_command_script?: string;
1651
+ };
1652
+ workspace: string;
1653
+ };
1654
+ export type EditSlackCommandResponse = (string);
1655
+ export type RunSlackMessageTestJobData = {
1656
+ /**
1657
+ * path to hub script to run and its corresponding args
1658
+ */
1659
+ requestBody: {
1660
+ hub_script_path?: string;
1661
+ channel?: string;
1662
+ test_msg?: string;
1663
+ };
1664
+ workspace: string;
1665
+ };
1666
+ export type RunSlackMessageTestJobResponse = ({
1667
+ job_uuid?: string;
1668
+ });
1669
+ export type EditDeployToData = {
1670
+ requestBody: {
1671
+ deploy_to?: string;
1672
+ };
1673
+ workspace: string;
1674
+ };
1675
+ export type EditDeployToResponse = (string);
1676
+ export type EditAutoInviteData = {
1677
+ /**
1678
+ * WorkspaceInvite
1679
+ */
1680
+ requestBody: {
1681
+ operator?: boolean;
1682
+ invite_all?: boolean;
1683
+ auto_add?: boolean;
1684
+ };
1685
+ workspace: string;
1686
+ };
1687
+ export type EditAutoInviteResponse = (string);
1688
+ export type EditWebhookData = {
1689
+ /**
1690
+ * WorkspaceWebhook
1691
+ */
1692
+ requestBody: {
1693
+ webhook?: string;
1694
+ };
1695
+ workspace: string;
1696
+ };
1697
+ export type EditWebhookResponse = (string);
1698
+ export type EditCopilotConfigData = {
1699
+ /**
1700
+ * WorkspaceCopilotConfig
1701
+ */
1702
+ requestBody: {
1703
+ openai_resource_path?: string;
1704
+ code_completion_enabled: boolean;
1705
+ };
1706
+ workspace: string;
1707
+ };
1708
+ export type EditCopilotConfigResponse = (string);
1709
+ export type GetCopilotInfoData = {
1710
+ workspace: string;
1711
+ };
1712
+ export type GetCopilotInfoResponse = ({
1713
+ exists_openai_resource_path: boolean;
1714
+ code_completion_enabled: boolean;
1715
+ });
1716
+ export type EditErrorHandlerData = {
1717
+ /**
1718
+ * WorkspaceErrorHandler
1719
+ */
1720
+ requestBody: {
1721
+ error_handler?: string;
1722
+ error_handler_extra_args?: ScriptArgs;
1723
+ error_handler_muted_on_cancel?: boolean;
1724
+ };
1725
+ workspace: string;
1726
+ };
1727
+ export type EditErrorHandlerResponse = (string);
1728
+ export type EditLargeFileStorageConfigData = {
1729
+ /**
1730
+ * LargeFileStorage info
1731
+ */
1732
+ requestBody: {
1733
+ large_file_storage?: LargeFileStorage;
1734
+ };
1735
+ workspace: string;
1736
+ };
1737
+ export type EditLargeFileStorageConfigResponse = (unknown);
1738
+ export type EditWorkspaceGitSyncConfigData = {
1739
+ /**
1740
+ * Workspace Git sync settings
1741
+ */
1742
+ requestBody: {
1743
+ git_sync_settings?: WorkspaceGitSyncSettings;
1744
+ };
1745
+ workspace: string;
1746
+ };
1747
+ export type EditWorkspaceGitSyncConfigResponse = (unknown);
1748
+ export type EditWorkspaceDeployUiSettingsData = {
1749
+ /**
1750
+ * Workspace deploy UI settings
1751
+ */
1752
+ requestBody: {
1753
+ deploy_ui_settings?: WorkspaceDeployUISettings;
1754
+ };
1755
+ workspace: string;
1756
+ };
1757
+ export type EditWorkspaceDeployUiSettingsResponse = (unknown);
1758
+ export type EditWorkspaceDefaultAppData = {
1759
+ /**
1760
+ * Workspace default app
1761
+ */
1762
+ requestBody: {
1763
+ default_app_path?: string;
1764
+ };
1765
+ workspace: string;
1766
+ };
1767
+ export type EditWorkspaceDefaultAppResponse = (string);
1768
+ export type EditDefaultScriptsData = {
1769
+ /**
1770
+ * Workspace default app
1771
+ */
1772
+ requestBody?: WorkspaceDefaultScripts;
1773
+ workspace: string;
1774
+ };
1775
+ export type EditDefaultScriptsResponse = (string);
1776
+ export type GetDefaultScriptsData = {
1777
+ workspace: string;
1778
+ };
1779
+ export type GetDefaultScriptsResponse = (WorkspaceDefaultScripts);
1780
+ export type SetEnvironmentVariableData = {
1781
+ /**
1782
+ * Workspace default app
1783
+ */
1784
+ requestBody: {
1785
+ name: string;
1786
+ value?: string;
1787
+ };
1788
+ workspace: string;
1789
+ };
1790
+ export type SetEnvironmentVariableResponse = (string);
1791
+ export type GetWorkspaceEncryptionKeyData = {
1792
+ workspace: string;
1793
+ };
1794
+ export type GetWorkspaceEncryptionKeyResponse = ({
1795
+ key: string;
1796
+ });
1797
+ export type SetWorkspaceEncryptionKeyData = {
1798
+ /**
1799
+ * New encryption key
1800
+ */
1801
+ requestBody: {
1802
+ new_key: string;
1803
+ skip_reencrypt?: boolean;
1804
+ };
1805
+ workspace: string;
1806
+ };
1807
+ export type SetWorkspaceEncryptionKeyResponse = (string);
1808
+ export type GetWorkspaceDefaultAppData = {
1809
+ workspace: string;
1810
+ };
1811
+ export type GetWorkspaceDefaultAppResponse = ({
1812
+ default_app_path?: string;
1813
+ });
1814
+ export type GetLargeFileStorageConfigData = {
1815
+ workspace: string;
1816
+ };
1817
+ export type GetLargeFileStorageConfigResponse = (LargeFileStorage);
1818
+ export type GetWorkspaceUsageData = {
1819
+ workspace: string;
1820
+ };
1821
+ export type GetWorkspaceUsageResponse = (number);
1822
+ export type ListUsersData = {
1823
+ workspace: string;
1824
+ };
1825
+ export type ListUsersResponse = (Array<User>);
1826
+ export type ListUsersUsageData = {
1827
+ workspace: string;
1828
+ };
1829
+ export type ListUsersUsageResponse = (Array<UserUsage>);
1830
+ export type ListUsernamesData = {
1831
+ workspace: string;
1832
+ };
1833
+ export type ListUsernamesResponse = (Array<(string)>);
1834
+ export type UsernameToEmailData = {
1835
+ username: string;
1836
+ workspace: string;
1837
+ };
1838
+ export type UsernameToEmailResponse = (string);
1839
+ export type CreateTokenData = {
1840
+ /**
1841
+ * new token
1842
+ */
1843
+ requestBody: NewToken;
1844
+ };
1845
+ export type CreateTokenResponse = (string);
1846
+ export type CreateTokenImpersonateData = {
1847
+ /**
1848
+ * new token
1849
+ */
1850
+ requestBody: NewTokenImpersonate;
1851
+ };
1852
+ export type CreateTokenImpersonateResponse = (string);
1853
+ export type DeleteTokenData = {
1854
+ tokenPrefix: string;
1855
+ };
1856
+ export type DeleteTokenResponse = (string);
1857
+ export type ListTokensData = {
1858
+ excludeEphemeral?: boolean;
1859
+ /**
1860
+ * which page to return (start at 1, default 1)
1861
+ */
1862
+ page?: number;
1863
+ /**
1864
+ * number of items to return for a given page (default 30, max 100)
1865
+ */
1866
+ perPage?: number;
1867
+ };
1868
+ export type ListTokensResponse = (Array<TruncatedToken>);
1869
+ export type GetOidcTokenData = {
1870
+ audience: string;
1871
+ workspace: string;
1872
+ };
1873
+ export type GetOidcTokenResponse = (string);
1874
+ export type CreateVariableData = {
1875
+ alreadyEncrypted?: boolean;
1876
+ /**
1877
+ * new variable
1878
+ */
1879
+ requestBody: CreateVariable;
1880
+ workspace: string;
1881
+ };
1882
+ export type CreateVariableResponse = (string);
1883
+ export type EncryptValueData = {
1884
+ /**
1885
+ * new variable
1886
+ */
1887
+ requestBody: string;
1888
+ workspace: string;
1889
+ };
1890
+ export type EncryptValueResponse = (string);
1891
+ export type DeleteVariableData = {
1892
+ path: string;
1893
+ workspace: string;
1894
+ };
1895
+ export type DeleteVariableResponse = (string);
1896
+ export type UpdateVariableData = {
1897
+ alreadyEncrypted?: boolean;
1898
+ path: string;
1899
+ /**
1900
+ * updated variable
1901
+ */
1902
+ requestBody: EditVariable;
1903
+ workspace: string;
1904
+ };
1905
+ export type UpdateVariableResponse = (string);
1906
+ export type GetVariableData = {
1907
+ /**
1908
+ * ask to decrypt secret if this variable is secret
1909
+ * (if not secret no effect, default: true)
1910
+ *
1911
+ */
1912
+ decryptSecret?: boolean;
1913
+ /**
1914
+ * ask to include the encrypted value if secret and decrypt secret is not true (default: false)
1915
+ *
1916
+ */
1917
+ includeEncrypted?: boolean;
1918
+ path: string;
1919
+ workspace: string;
1920
+ };
1921
+ export type GetVariableResponse = (ListableVariable);
1922
+ export type GetVariableValueData = {
1923
+ path: string;
1924
+ workspace: string;
1925
+ };
1926
+ export type GetVariableValueResponse = (string);
1927
+ export type ExistsVariableData = {
1928
+ path: string;
1929
+ workspace: string;
1930
+ };
1931
+ export type ExistsVariableResponse = (boolean);
1932
+ export type ListVariableData = {
1933
+ /**
1934
+ * which page to return (start at 1, default 1)
1935
+ */
1936
+ page?: number;
1937
+ pathStart?: string;
1938
+ /**
1939
+ * number of items to return for a given page (default 30, max 100)
1940
+ */
1941
+ perPage?: number;
1942
+ workspace: string;
1943
+ };
1944
+ export type ListVariableResponse = (Array<ListableVariable>);
1945
+ export type ListContextualVariablesData = {
1946
+ workspace: string;
1947
+ };
1948
+ export type ListContextualVariablesResponse = (Array<ContextualVariable>);
1949
+ export type LoginWithOauthData = {
1950
+ clientName: string;
1951
+ /**
1952
+ * Partially filled script
1953
+ */
1954
+ requestBody: {
1955
+ code?: string;
1956
+ state?: string;
1957
+ };
1958
+ };
1959
+ export type LoginWithOauthResponse = (string);
1960
+ export type ConnectSlackCallbackData = {
1961
+ /**
1962
+ * code endpoint
1963
+ */
1964
+ requestBody: {
1965
+ code: string;
1966
+ state: string;
1967
+ };
1968
+ workspace: string;
1969
+ };
1970
+ export type ConnectSlackCallbackResponse = (string);
1971
+ export type ConnectSlackCallbackInstanceData = {
1972
+ /**
1973
+ * code endpoint
1974
+ */
1975
+ requestBody: {
1976
+ code: string;
1977
+ state: string;
1978
+ };
1979
+ };
1980
+ export type ConnectSlackCallbackInstanceResponse = (string);
1981
+ export type ConnectCallbackData = {
1982
+ clientName: string;
1983
+ /**
1984
+ * code endpoint
1985
+ */
1986
+ requestBody: {
1987
+ code: string;
1988
+ state: string;
1989
+ };
1990
+ };
1991
+ export type ConnectCallbackResponse = (TokenResponse);
1992
+ export type CreateAccountData = {
1993
+ /**
1994
+ * code endpoint
1995
+ */
1996
+ requestBody: {
1997
+ refresh_token?: string;
1998
+ expires_in: number;
1999
+ client: string;
2000
+ };
2001
+ workspace: string;
2002
+ };
2003
+ export type CreateAccountResponse = (string);
2004
+ export type RefreshTokenData = {
2005
+ id: number;
2006
+ /**
2007
+ * variable path
2008
+ */
2009
+ requestBody: {
2010
+ path: string;
2011
+ };
2012
+ workspace: string;
2013
+ };
2014
+ export type RefreshTokenResponse = (string);
2015
+ export type DisconnectAccountData = {
2016
+ id: number;
2017
+ workspace: string;
2018
+ };
2019
+ export type DisconnectAccountResponse = (string);
2020
+ export type DisconnectSlackData = {
2021
+ workspace: string;
2022
+ };
2023
+ export type DisconnectSlackResponse = (string);
2024
+ export type ListOauthLoginsResponse = ({
2025
+ oauth: Array<(string)>;
2026
+ saml?: string;
2027
+ });
2028
+ export type ListOauthConnectsResponse = (Array<(string)>);
2029
+ export type GetOauthConnectData = {
2030
+ /**
2031
+ * client name
2032
+ */
2033
+ client: string;
2034
+ };
2035
+ export type GetOauthConnectResponse = ({
2036
+ extra_params?: {
2037
+ [key: string]: unknown;
2038
+ };
2039
+ scopes?: Array<(string)>;
2040
+ });
2041
+ export type CreateResourceData = {
2042
+ /**
2043
+ * new resource
2044
+ */
2045
+ requestBody: CreateResource;
2046
+ updateIfExists?: boolean;
2047
+ workspace: string;
2048
+ };
2049
+ export type CreateResourceResponse = (string);
2050
+ export type DeleteResourceData = {
2051
+ path: string;
2052
+ workspace: string;
2053
+ };
2054
+ export type DeleteResourceResponse = (string);
2055
+ export type UpdateResourceData = {
2056
+ path: string;
2057
+ /**
2058
+ * updated resource
2059
+ */
2060
+ requestBody: EditResource;
2061
+ workspace: string;
2062
+ };
2063
+ export type UpdateResourceResponse = (string);
2064
+ export type UpdateResourceValueData = {
2065
+ path: string;
2066
+ /**
2067
+ * updated resource
2068
+ */
2069
+ requestBody: {
2070
+ value?: unknown;
2071
+ };
2072
+ workspace: string;
2073
+ };
2074
+ export type UpdateResourceValueResponse = (string);
2075
+ export type GetResourceData = {
2076
+ path: string;
2077
+ workspace: string;
2078
+ };
2079
+ export type GetResourceResponse = (Resource);
2080
+ export type GetResourceValueInterpolatedData = {
2081
+ /**
2082
+ * job id
2083
+ */
2084
+ jobId?: string;
2085
+ path: string;
2086
+ workspace: string;
2087
+ };
2088
+ export type GetResourceValueInterpolatedResponse = (unknown);
2089
+ export type GetResourceValueData = {
2090
+ path: string;
2091
+ workspace: string;
2092
+ };
2093
+ export type GetResourceValueResponse = (unknown);
2094
+ export type ExistsResourceData = {
2095
+ path: string;
2096
+ workspace: string;
2097
+ };
2098
+ export type ExistsResourceResponse = (boolean);
2099
+ export type ListResourceData = {
2100
+ /**
2101
+ * which page to return (start at 1, default 1)
2102
+ */
2103
+ page?: number;
2104
+ pathStart?: string;
2105
+ /**
2106
+ * number of items to return for a given page (default 30, max 100)
2107
+ */
2108
+ perPage?: number;
2109
+ /**
2110
+ * resource_types to list from, separated by ',',
2111
+ */
2112
+ resourceType?: string;
2113
+ /**
2114
+ * resource_types to not list from, separated by ',',
2115
+ */
2116
+ resourceTypeExclude?: string;
2117
+ workspace: string;
2118
+ };
2119
+ export type ListResourceResponse = (Array<ListableResource>);
2120
+ export type ListSearchResourceData = {
2121
+ workspace: string;
2122
+ };
2123
+ export type ListSearchResourceResponse = (Array<{
2124
+ path: string;
2125
+ value: unknown;
2126
+ }>);
2127
+ export type ListResourceNamesData = {
2128
+ name: string;
2129
+ workspace: string;
2130
+ };
2131
+ export type ListResourceNamesResponse = (Array<{
2132
+ name: string;
2133
+ path: string;
2134
+ }>);
2135
+ export type CreateResourceTypeData = {
2136
+ /**
2137
+ * new resource_type
2138
+ */
2139
+ requestBody: ResourceType;
2140
+ workspace: string;
2141
+ };
2142
+ export type CreateResourceTypeResponse = (string);
2143
+ export type FileResourceTypeToFileExtMapData = {
2144
+ workspace: string;
2145
+ };
2146
+ export type FileResourceTypeToFileExtMapResponse = (unknown);
2147
+ export type DeleteResourceTypeData = {
2148
+ path: string;
2149
+ workspace: string;
2150
+ };
2151
+ export type DeleteResourceTypeResponse = (string);
2152
+ export type UpdateResourceTypeData = {
2153
+ path: string;
2154
+ /**
2155
+ * updated resource_type
2156
+ */
2157
+ requestBody: EditResourceType;
2158
+ workspace: string;
2159
+ };
2160
+ export type UpdateResourceTypeResponse = (string);
2161
+ export type GetResourceTypeData = {
2162
+ path: string;
2163
+ workspace: string;
2164
+ };
2165
+ export type GetResourceTypeResponse = (ResourceType);
2166
+ export type ExistsResourceTypeData = {
2167
+ path: string;
2168
+ workspace: string;
2169
+ };
2170
+ export type ExistsResourceTypeResponse = (boolean);
2171
+ export type ListResourceTypeData = {
2172
+ workspace: string;
2173
+ };
2174
+ export type ListResourceTypeResponse = (Array<ResourceType>);
2175
+ export type ListResourceTypeNamesData = {
2176
+ workspace: string;
2177
+ };
2178
+ export type ListResourceTypeNamesResponse = (Array<(string)>);
2179
+ export type QueryResourceTypesData = {
2180
+ /**
2181
+ * query limit
2182
+ */
2183
+ limit?: number;
2184
+ /**
2185
+ * query text
2186
+ */
2187
+ text: string;
2188
+ workspace: string;
2189
+ };
2190
+ export type QueryResourceTypesResponse = (Array<{
2191
+ name: string;
2192
+ score: number;
2193
+ schema?: unknown;
2194
+ }>);
2195
+ export type ListHubIntegrationsData = {
2196
+ /**
2197
+ * query integrations kind
2198
+ */
2199
+ kind?: string;
2200
+ };
2201
+ export type ListHubIntegrationsResponse = (Array<{
2202
+ name: string;
2203
+ }>);
2204
+ export type ListHubFlowsResponse = ({
2205
+ flows?: Array<{
2206
+ id: number;
2207
+ flow_id: number;
2208
+ summary: string;
2209
+ apps: Array<(string)>;
2210
+ approved: boolean;
2211
+ votes: number;
2212
+ }>;
2213
+ });
2214
+ export type GetHubFlowByIdData = {
2215
+ id: number;
2216
+ };
2217
+ export type GetHubFlowByIdResponse = ({
2218
+ flow?: OpenFlow;
2219
+ });
2220
+ export type ListHubAppsResponse = ({
2221
+ apps?: Array<{
2222
+ id: number;
2223
+ app_id: number;
2224
+ summary: string;
2225
+ apps: Array<(string)>;
2226
+ approved: boolean;
2227
+ votes: number;
2228
+ }>;
2229
+ });
2230
+ export type GetHubAppByIdData = {
2231
+ id: number;
2232
+ };
2233
+ export type GetHubAppByIdResponse = ({
2234
+ app: {
2235
+ summary: string;
2236
+ value: unknown;
2237
+ };
2238
+ });
2239
+ export type GetHubScriptContentByPathData = {
2240
+ path: string;
2241
+ };
2242
+ export type GetHubScriptContentByPathResponse = (string);
2243
+ export type GetHubScriptByPathData = {
2244
+ path: string;
2245
+ };
2246
+ export type GetHubScriptByPathResponse = ({
2247
+ content: string;
2248
+ lockfile?: string;
2249
+ schema?: unknown;
2250
+ language: string;
2251
+ summary?: string;
2252
+ });
2253
+ export type GetTopHubScriptsData = {
2254
+ /**
2255
+ * query scripts app
2256
+ */
2257
+ app?: string;
2258
+ /**
2259
+ * query scripts kind
2260
+ */
2261
+ kind?: string;
2262
+ /**
2263
+ * query limit
2264
+ */
2265
+ limit?: number;
2266
+ };
2267
+ export type GetTopHubScriptsResponse = ({
2268
+ asks?: Array<{
2269
+ id: number;
2270
+ ask_id: number;
2271
+ summary: string;
2272
+ app: string;
2273
+ version_id: number;
2274
+ kind: HubScriptKind;
2275
+ votes: number;
2276
+ views: number;
2277
+ }>;
2278
+ });
2279
+ export type QueryHubScriptsData = {
2280
+ /**
2281
+ * query scripts app
2282
+ */
2283
+ app?: string;
2284
+ /**
2285
+ * query scripts kind
2286
+ */
2287
+ kind?: string;
2288
+ /**
2289
+ * query limit
2290
+ */
2291
+ limit?: number;
2292
+ /**
2293
+ * query text
2294
+ */
2295
+ text: string;
2296
+ };
2297
+ export type QueryHubScriptsResponse = (Array<{
2298
+ ask_id: number;
2299
+ id: number;
2300
+ version_id: number;
2301
+ summary: string;
2302
+ app: string;
2303
+ kind: HubScriptKind;
2304
+ score: number;
2305
+ }>);
2306
+ export type ListSearchScriptData = {
2307
+ workspace: string;
2308
+ };
2309
+ export type ListSearchScriptResponse = (Array<{
2310
+ path: string;
2311
+ content: string;
2312
+ }>);
2313
+ export type ListScriptsData = {
2314
+ /**
2315
+ * mask to filter exact matching user creator
2316
+ */
2317
+ createdBy?: string;
2318
+ /**
2319
+ * mask to filter scripts whom first direct parent has exact hash
2320
+ */
2321
+ firstParentHash?: string;
2322
+ /**
2323
+ * (default false)
2324
+ * include scripts that have no deployed version
2325
+ *
2326
+ */
2327
+ includeDraftOnly?: boolean;
2328
+ /**
2329
+ * (default false)
2330
+ * include scripts without an exported main function
2331
+ *
2332
+ */
2333
+ includeWithoutMain?: boolean;
2334
+ /**
2335
+ * (default regardless)
2336
+ * if true show only the templates
2337
+ * if false show only the non templates
2338
+ * if not defined, show all regardless of if the script is a template
2339
+ *
2340
+ */
2341
+ isTemplate?: boolean;
2342
+ /**
2343
+ * (default regardless)
2344
+ * script kinds to filter, split by comma
2345
+ *
2346
+ */
2347
+ kinds?: string;
2348
+ /**
2349
+ * mask to filter scripts whom last parent in the chain has exact hash.
2350
+ * Beware that each script stores only a limited number of parents. Hence
2351
+ * the last parent hash for a script is not necessarily its top-most parent.
2352
+ * To find the top-most parent you will have to jump from last to last hash
2353
+ * until finding the parent
2354
+ *
2355
+ */
2356
+ lastParentHash?: string;
2357
+ /**
2358
+ * order by desc order (default true)
2359
+ */
2360
+ orderDesc?: boolean;
2361
+ /**
2362
+ * which page to return (start at 1, default 1)
2363
+ */
2364
+ page?: number;
2365
+ /**
2366
+ * is the hash present in the array of stored parent hashes for this script.
2367
+ * The same warning applies than for last_parent_hash. A script only store a
2368
+ * limited number of direct parent
2369
+ *
2370
+ */
2371
+ parentHash?: string;
2372
+ /**
2373
+ * mask to filter exact matching path
2374
+ */
2375
+ pathExact?: string;
2376
+ /**
2377
+ * mask to filter matching starting path
2378
+ */
2379
+ pathStart?: string;
2380
+ /**
2381
+ * number of items to return for a given page (default 30, max 100)
2382
+ */
2383
+ perPage?: number;
2384
+ /**
2385
+ * (default false)
2386
+ * show only the archived files.
2387
+ * when multiple archived hash share the same path, only the ones with the latest create_at
2388
+ * are
2389
+ * ed.
2390
+ *
2391
+ */
2392
+ showArchived?: boolean;
2393
+ /**
2394
+ * (default false)
2395
+ * show only the starred items
2396
+ *
2397
+ */
2398
+ starredOnly?: boolean;
2399
+ /**
2400
+ * (default false)
2401
+ * include deployment message
2402
+ *
2403
+ */
2404
+ withDeploymentMsg?: boolean;
2405
+ workspace: string;
2406
+ };
2407
+ export type ListScriptsResponse = (Array<Script>);
2408
+ export type ListScriptPathsData = {
2409
+ workspace: string;
2410
+ };
2411
+ export type ListScriptPathsResponse = (Array<(string)>);
2412
+ export type CreateDraftData = {
2413
+ requestBody: {
2414
+ path: string;
2415
+ typ: 'flow' | 'script' | 'app';
2416
+ value?: unknown;
2417
+ };
2418
+ workspace: string;
2419
+ };
2420
+ export type CreateDraftResponse = (string);
2421
+ export type DeleteDraftData = {
2422
+ kind: 'script' | 'flow' | 'app';
2423
+ path: string;
2424
+ workspace: string;
2425
+ };
2426
+ export type DeleteDraftResponse = (string);
2427
+ export type CreateScriptData = {
2428
+ /**
2429
+ * Partially filled script
2430
+ */
2431
+ requestBody: NewScript;
2432
+ workspace: string;
2433
+ };
2434
+ export type CreateScriptResponse = (string);
2435
+ export type ToggleWorkspaceErrorHandlerForScriptData = {
2436
+ path: string;
2437
+ /**
2438
+ * Workspace error handler enabled
2439
+ */
2440
+ requestBody: {
2441
+ muted?: boolean;
2442
+ };
2443
+ workspace: string;
2444
+ };
2445
+ export type ToggleWorkspaceErrorHandlerForScriptResponse = (string);
2446
+ export type GetCustomTagsResponse = (Array<(string)>);
2447
+ export type GeDefaultTagsResponse = (Array<(string)>);
2448
+ export type IsDefaultTagsPerWorkspaceResponse = (boolean);
2449
+ export type ArchiveScriptByPathData = {
2450
+ path: string;
2451
+ workspace: string;
2452
+ };
2453
+ export type ArchiveScriptByPathResponse = (string);
2454
+ export type ArchiveScriptByHashData = {
2455
+ hash: string;
2456
+ workspace: string;
2457
+ };
2458
+ export type ArchiveScriptByHashResponse = (Script);
2459
+ export type DeleteScriptByHashData = {
2460
+ hash: string;
2461
+ workspace: string;
2462
+ };
2463
+ export type DeleteScriptByHashResponse = (Script);
2464
+ export type DeleteScriptByPathData = {
2465
+ path: string;
2466
+ workspace: string;
2467
+ };
2468
+ export type DeleteScriptByPathResponse = (string);
2469
+ export type GetScriptByPathData = {
2470
+ path: string;
2471
+ withStarredInfo?: boolean;
2472
+ workspace: string;
2473
+ };
2474
+ export type GetScriptByPathResponse = (Script);
2475
+ export type GetScriptByPathWithDraftData = {
2476
+ path: string;
2477
+ workspace: string;
2478
+ };
2479
+ export type GetScriptByPathWithDraftResponse = (NewScriptWithDraft);
2480
+ export type GetScriptHistoryByPathData = {
2481
+ path: string;
2482
+ workspace: string;
2483
+ };
2484
+ export type GetScriptHistoryByPathResponse = (Array<ScriptHistory>);
2485
+ export type UpdateScriptHistoryData = {
2486
+ hash: string;
2487
+ path: string;
2488
+ /**
2489
+ * Script deployment message
2490
+ */
2491
+ requestBody: {
2492
+ deployment_msg?: string;
2493
+ };
2494
+ workspace: string;
2495
+ };
2496
+ export type UpdateScriptHistoryResponse = (string);
2497
+ export type RawScriptByPathData = {
2498
+ path: string;
2499
+ workspace: string;
2500
+ };
2501
+ export type RawScriptByPathResponse = (string);
2502
+ export type RawScriptByPathTokenedData = {
2503
+ path: string;
2504
+ token: string;
2505
+ workspace: string;
2506
+ };
2507
+ export type RawScriptByPathTokenedResponse = (string);
2508
+ export type ExistsScriptByPathData = {
2509
+ path: string;
2510
+ workspace: string;
2511
+ };
2512
+ export type ExistsScriptByPathResponse = (boolean);
2513
+ export type GetScriptByHashData = {
2514
+ hash: string;
2515
+ withStarredInfo?: boolean;
2516
+ workspace: string;
2517
+ };
2518
+ export type GetScriptByHashResponse = (Script);
2519
+ export type RawScriptByHashData = {
2520
+ path: string;
2521
+ workspace: string;
2522
+ };
2523
+ export type RawScriptByHashResponse = (string);
2524
+ export type GetScriptDeploymentStatusData = {
2525
+ hash: string;
2526
+ workspace: string;
2527
+ };
2528
+ export type GetScriptDeploymentStatusResponse = ({
2529
+ lock?: string;
2530
+ lock_error_logs?: string;
2531
+ });
2532
+ export type RunScriptByPathData = {
2533
+ /**
2534
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
2535
+ */
2536
+ cacheTtl?: string;
2537
+ /**
2538
+ * make the run invisible to the the script owner (default false)
2539
+ */
2540
+ invisibleToOwner?: boolean;
2541
+ /**
2542
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
2543
+ */
2544
+ jobId?: string;
2545
+ /**
2546
+ * The parent job that is at the origin and responsible for the execution of this script if any
2547
+ */
2548
+ parentJob?: string;
2549
+ path: string;
2550
+ /**
2551
+ * script args
2552
+ */
2553
+ requestBody: ScriptArgs;
2554
+ /**
2555
+ * when to schedule this job (leave empty for immediate run)
2556
+ */
2557
+ scheduledFor?: string;
2558
+ /**
2559
+ * schedule the script to execute in the number of seconds starting now
2560
+ */
2561
+ scheduledInSecs?: number;
2562
+ /**
2563
+ * Override the tag to use
2564
+ */
2565
+ tag?: string;
2566
+ workspace: string;
2567
+ };
2568
+ export type RunScriptByPathResponse = (string);
2569
+ export type OpenaiSyncScriptByPathData = {
2570
+ /**
2571
+ * List of headers's keys (separated with ',') whove value are added to the args
2572
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2573
+ *
2574
+ */
2575
+ includeHeader?: string;
2576
+ /**
2577
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
2578
+ */
2579
+ jobId?: string;
2580
+ /**
2581
+ * The parent job that is at the origin and responsible for the execution of this script if any
2582
+ */
2583
+ parentJob?: string;
2584
+ path: string;
2585
+ /**
2586
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2587
+ *
2588
+ */
2589
+ queueLimit?: string;
2590
+ /**
2591
+ * script args
2592
+ */
2593
+ requestBody: ScriptArgs;
2594
+ workspace: string;
2595
+ };
2596
+ export type OpenaiSyncScriptByPathResponse = (unknown);
2597
+ export type RunWaitResultScriptByPathData = {
2598
+ /**
2599
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
2600
+ */
2601
+ cacheTtl?: string;
2602
+ /**
2603
+ * List of headers's keys (separated with ',') whove value are added to the args
2604
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2605
+ *
2606
+ */
2607
+ includeHeader?: string;
2608
+ /**
2609
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
2610
+ */
2611
+ jobId?: string;
2612
+ /**
2613
+ * The parent job that is at the origin and responsible for the execution of this script if any
2614
+ */
2615
+ parentJob?: string;
2616
+ path: string;
2617
+ /**
2618
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2619
+ *
2620
+ */
2621
+ queueLimit?: string;
2622
+ /**
2623
+ * script args
2624
+ */
2625
+ requestBody: ScriptArgs;
2626
+ /**
2627
+ * Override the tag to use
2628
+ */
2629
+ tag?: string;
2630
+ workspace: string;
2631
+ };
2632
+ export type RunWaitResultScriptByPathResponse = (unknown);
2633
+ export type RunWaitResultScriptByPathGetData = {
2634
+ /**
2635
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
2636
+ */
2637
+ cacheTtl?: string;
2638
+ /**
2639
+ * List of headers's keys (separated with ',') whove value are added to the args
2640
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2641
+ *
2642
+ */
2643
+ includeHeader?: string;
2644
+ /**
2645
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
2646
+ */
2647
+ jobId?: string;
2648
+ /**
2649
+ * The parent job that is at the origin and responsible for the execution of this script if any
2650
+ */
2651
+ parentJob?: string;
2652
+ path: string;
2653
+ /**
2654
+ * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
2655
+ * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
2656
+ *
2657
+ */
2658
+ payload?: string;
2659
+ /**
2660
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2661
+ *
2662
+ */
2663
+ queueLimit?: string;
2664
+ /**
2665
+ * Override the tag to use
2666
+ */
2667
+ tag?: string;
2668
+ workspace: string;
2669
+ };
2670
+ export type RunWaitResultScriptByPathGetResponse = (unknown);
2671
+ export type OpenaiSyncFlowByPathData = {
2672
+ /**
2673
+ * List of headers's keys (separated with ',') whove value are added to the args
2674
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2675
+ *
2676
+ */
2677
+ includeHeader?: string;
2678
+ /**
2679
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
2680
+ */
2681
+ jobId?: string;
2682
+ path: string;
2683
+ /**
2684
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2685
+ *
2686
+ */
2687
+ queueLimit?: string;
2688
+ /**
2689
+ * script args
2690
+ */
2691
+ requestBody: ScriptArgs;
2692
+ workspace: string;
2693
+ };
2694
+ export type OpenaiSyncFlowByPathResponse = (unknown);
2695
+ export type RunWaitResultFlowByPathData = {
2696
+ /**
2697
+ * List of headers's keys (separated with ',') whove value are added to the args
2698
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2699
+ *
2700
+ */
2701
+ includeHeader?: string;
2702
+ /**
2703
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
2704
+ */
2705
+ jobId?: string;
2706
+ path: string;
2707
+ /**
2708
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2709
+ *
2710
+ */
2711
+ queueLimit?: string;
2712
+ /**
2713
+ * script args
2714
+ */
2715
+ requestBody: ScriptArgs;
2716
+ workspace: string;
2717
+ };
2718
+ export type RunWaitResultFlowByPathResponse = (unknown);
2719
+ export type ResultByIdData = {
2720
+ flowJobId: string;
2721
+ nodeId: string;
2722
+ workspace: string;
2723
+ };
2724
+ export type ResultByIdResponse = (unknown);
2725
+ export type ListFlowPathsData = {
2726
+ workspace: string;
2727
+ };
2728
+ export type ListFlowPathsResponse = (Array<(string)>);
2729
+ export type ListSearchFlowData = {
2730
+ workspace: string;
2731
+ };
2732
+ export type ListSearchFlowResponse = (Array<{
2733
+ path: string;
2734
+ value: unknown;
2735
+ }>);
2736
+ export type ListFlowsData = {
2737
+ /**
2738
+ * mask to filter exact matching user creator
2739
+ */
2740
+ createdBy?: string;
2741
+ /**
2742
+ * (default false)
2743
+ * include items that have no deployed version
2744
+ *
2745
+ */
2746
+ includeDraftOnly?: boolean;
2747
+ /**
2748
+ * order by desc order (default true)
2749
+ */
2750
+ orderDesc?: boolean;
2751
+ /**
2752
+ * which page to return (start at 1, default 1)
2753
+ */
2754
+ page?: number;
2755
+ /**
2756
+ * mask to filter exact matching path
2757
+ */
2758
+ pathExact?: string;
2759
+ /**
2760
+ * mask to filter matching starting path
2761
+ */
2762
+ pathStart?: string;
2763
+ /**
2764
+ * number of items to return for a given page (default 30, max 100)
2765
+ */
2766
+ perPage?: number;
2767
+ /**
2768
+ * (default false)
2769
+ * show only the archived files.
2770
+ * when multiple archived hash share the same path, only the ones with the latest create_at
2771
+ * are displayed.
2772
+ *
2773
+ */
2774
+ showArchived?: boolean;
2775
+ /**
2776
+ * (default false)
2777
+ * show only the starred items
2778
+ *
2779
+ */
2780
+ starredOnly?: boolean;
2781
+ /**
2782
+ * (default false)
2783
+ * include deployment message
2784
+ *
2785
+ */
2786
+ withDeploymentMsg?: boolean;
2787
+ workspace: string;
2788
+ };
2789
+ export type ListFlowsResponse = (Array<(Flow & {
2790
+ has_draft?: boolean;
2791
+ draft_only?: boolean;
2792
+ })>);
2793
+ export type GetFlowHistoryData = {
2794
+ path: string;
2795
+ workspace: string;
2796
+ };
2797
+ export type GetFlowHistoryResponse = (Array<FlowVersion>);
2798
+ export type GetFlowVersionData = {
2799
+ path: string;
2800
+ version: number;
2801
+ workspace: string;
2802
+ };
2803
+ export type GetFlowVersionResponse = (Flow);
2804
+ export type UpdateFlowHistoryData = {
2805
+ path: string;
2806
+ /**
2807
+ * Flow deployment message
2808
+ */
2809
+ requestBody: {
2810
+ deployment_msg: string;
2811
+ };
2812
+ version: number;
2813
+ workspace: string;
2814
+ };
2815
+ export type UpdateFlowHistoryResponse = (string);
2816
+ export type GetFlowByPathData = {
2817
+ path: string;
2818
+ withStarredInfo?: boolean;
2819
+ workspace: string;
2820
+ };
2821
+ export type GetFlowByPathResponse = (Flow);
2822
+ export type ToggleWorkspaceErrorHandlerForFlowData = {
2823
+ path: string;
2824
+ /**
2825
+ * Workspace error handler enabled
2826
+ */
2827
+ requestBody: {
2828
+ muted?: boolean;
2829
+ };
2830
+ workspace: string;
2831
+ };
2832
+ export type ToggleWorkspaceErrorHandlerForFlowResponse = (string);
2833
+ export type GetFlowByPathWithDraftData = {
2834
+ path: string;
2835
+ workspace: string;
2836
+ };
2837
+ export type GetFlowByPathWithDraftResponse = ((Flow & {
2838
+ draft?: Flow;
2839
+ }));
2840
+ export type ExistsFlowByPathData = {
2841
+ path: string;
2842
+ workspace: string;
2843
+ };
2844
+ export type ExistsFlowByPathResponse = (boolean);
2845
+ export type CreateFlowData = {
2846
+ /**
2847
+ * Partially filled flow
2848
+ */
2849
+ requestBody: (OpenFlowWPath & {
2850
+ draft_only?: boolean;
2851
+ deployment_message?: string;
2852
+ });
2853
+ workspace: string;
2854
+ };
2855
+ export type CreateFlowResponse = (string);
2856
+ export type UpdateFlowData = {
2857
+ path: string;
2858
+ /**
2859
+ * Partially filled flow
2860
+ */
2861
+ requestBody: (OpenFlowWPath & {
2862
+ deployment_message?: string;
2863
+ });
2864
+ workspace: string;
2865
+ };
2866
+ export type UpdateFlowResponse = (string);
2867
+ export type ArchiveFlowByPathData = {
2868
+ path: string;
2869
+ /**
2870
+ * archiveFlow
2871
+ */
2872
+ requestBody: {
2873
+ archived?: boolean;
2874
+ };
2875
+ workspace: string;
2876
+ };
2877
+ export type ArchiveFlowByPathResponse = (string);
2878
+ export type DeleteFlowByPathData = {
2879
+ path: string;
2880
+ workspace: string;
2881
+ };
2882
+ export type DeleteFlowByPathResponse = (string);
2883
+ export type ListRawAppsData = {
2884
+ /**
2885
+ * mask to filter exact matching user creator
2886
+ */
2887
+ createdBy?: string;
2888
+ /**
2889
+ * order by desc order (default true)
2890
+ */
2891
+ orderDesc?: boolean;
2892
+ /**
2893
+ * which page to return (start at 1, default 1)
2894
+ */
2895
+ page?: number;
2896
+ /**
2897
+ * mask to filter exact matching path
2898
+ */
2899
+ pathExact?: string;
2900
+ /**
2901
+ * mask to filter matching starting path
2902
+ */
2903
+ pathStart?: string;
2904
+ /**
2905
+ * number of items to return for a given page (default 30, max 100)
2906
+ */
2907
+ perPage?: number;
2908
+ /**
2909
+ * (default false)
2910
+ * show only the starred items
2911
+ *
2912
+ */
2913
+ starredOnly?: boolean;
2914
+ workspace: string;
2915
+ };
2916
+ export type ListRawAppsResponse = (Array<ListableRawApp>);
2917
+ export type ExistsRawAppData = {
2918
+ path: string;
2919
+ workspace: string;
2920
+ };
2921
+ export type ExistsRawAppResponse = (boolean);
2922
+ export type GetRawAppDataData = {
2923
+ path: string;
2924
+ version: number;
2925
+ workspace: string;
2926
+ };
2927
+ export type GetRawAppDataResponse = (string);
2928
+ export type ListSearchAppData = {
2929
+ workspace: string;
2930
+ };
2931
+ export type ListSearchAppResponse = (Array<{
2932
+ path: string;
2933
+ value: unknown;
2934
+ }>);
2935
+ export type ListAppsData = {
2936
+ /**
2937
+ * mask to filter exact matching user creator
2938
+ */
2939
+ createdBy?: string;
2940
+ /**
2941
+ * (default false)
2942
+ * include items that have no deployed version
2943
+ *
2944
+ */
2945
+ includeDraftOnly?: boolean;
2946
+ /**
2947
+ * order by desc order (default true)
2948
+ */
2949
+ orderDesc?: boolean;
2950
+ /**
2951
+ * which page to return (start at 1, default 1)
2952
+ */
2953
+ page?: number;
2954
+ /**
2955
+ * mask to filter exact matching path
2956
+ */
2957
+ pathExact?: string;
2958
+ /**
2959
+ * mask to filter matching starting path
2960
+ */
2961
+ pathStart?: string;
2962
+ /**
2963
+ * number of items to return for a given page (default 30, max 100)
2964
+ */
2965
+ perPage?: number;
2966
+ /**
2967
+ * (default false)
2968
+ * show only the starred items
2969
+ *
2970
+ */
2971
+ starredOnly?: boolean;
2972
+ /**
2973
+ * (default false)
2974
+ * include deployment message
2975
+ *
2976
+ */
2977
+ withDeploymentMsg?: boolean;
2978
+ workspace: string;
2979
+ };
2980
+ export type ListAppsResponse = (Array<ListableApp>);
2981
+ export type CreateAppData = {
2982
+ /**
2983
+ * new app
2984
+ */
2985
+ requestBody: {
2986
+ path: string;
2987
+ value: unknown;
2988
+ summary: string;
2989
+ policy: Policy;
2990
+ draft_only?: boolean;
2991
+ deployment_message?: string;
2992
+ };
2993
+ workspace: string;
2994
+ };
2995
+ export type CreateAppResponse = (string);
2996
+ export type ExistsAppData = {
2997
+ path: string;
2998
+ workspace: string;
2999
+ };
3000
+ export type ExistsAppResponse = (boolean);
3001
+ export type GetAppByPathData = {
3002
+ path: string;
3003
+ withStarredInfo?: boolean;
3004
+ workspace: string;
3005
+ };
3006
+ export type GetAppByPathResponse = (AppWithLastVersion);
3007
+ export type GetAppByPathWithDraftData = {
3008
+ path: string;
3009
+ workspace: string;
3010
+ };
3011
+ export type GetAppByPathWithDraftResponse = (AppWithLastVersionWDraft);
3012
+ export type GetAppHistoryByPathData = {
3013
+ path: string;
3014
+ workspace: string;
3015
+ };
3016
+ export type GetAppHistoryByPathResponse = (Array<AppHistory>);
3017
+ export type UpdateAppHistoryData = {
3018
+ id: number;
3019
+ /**
3020
+ * App deployment message
3021
+ */
3022
+ requestBody: {
3023
+ deployment_msg?: string;
3024
+ };
3025
+ version: number;
3026
+ workspace: string;
3027
+ };
3028
+ export type UpdateAppHistoryResponse = (string);
3029
+ export type GetPublicAppBySecretData = {
3030
+ path: string;
3031
+ workspace: string;
3032
+ };
3033
+ export type GetPublicAppBySecretResponse = (AppWithLastVersion);
3034
+ export type GetPublicResourceData = {
3035
+ path: string;
3036
+ workspace: string;
3037
+ };
3038
+ export type GetPublicResourceResponse = (unknown);
3039
+ export type GetPublicSecretOfAppData = {
3040
+ path: string;
3041
+ workspace: string;
3042
+ };
3043
+ export type GetPublicSecretOfAppResponse = (string);
3044
+ export type GetAppByVersionData = {
3045
+ id: number;
3046
+ workspace: string;
3047
+ };
3048
+ export type GetAppByVersionResponse = (AppWithLastVersion);
3049
+ export type CreateRawAppData = {
3050
+ /**
3051
+ * new raw app
3052
+ */
3053
+ requestBody: {
3054
+ path: string;
3055
+ value: string;
3056
+ summary: string;
3057
+ };
3058
+ workspace: string;
3059
+ };
3060
+ export type CreateRawAppResponse = (string);
3061
+ export type UpdateRawAppData = {
3062
+ path: string;
3063
+ /**
3064
+ * updateraw app
3065
+ */
3066
+ requestBody: {
3067
+ path?: string;
3068
+ summary?: string;
3069
+ value?: string;
3070
+ };
3071
+ workspace: string;
3072
+ };
3073
+ export type UpdateRawAppResponse = (string);
3074
+ export type DeleteRawAppData = {
3075
+ path: string;
3076
+ workspace: string;
3077
+ };
3078
+ export type DeleteRawAppResponse = (string);
3079
+ export type DeleteAppData = {
3080
+ path: string;
3081
+ workspace: string;
3082
+ };
3083
+ export type DeleteAppResponse = (string);
3084
+ export type UpdateAppData = {
3085
+ path: string;
3086
+ /**
3087
+ * update app
3088
+ */
3089
+ requestBody: {
3090
+ path?: string;
3091
+ summary?: string;
3092
+ value?: unknown;
3093
+ policy?: Policy;
3094
+ deployment_message?: string;
3095
+ };
3096
+ workspace: string;
3097
+ };
3098
+ export type UpdateAppResponse = (string);
3099
+ export type ExecuteComponentData = {
3100
+ path: string;
3101
+ /**
3102
+ * update app
3103
+ */
3104
+ requestBody: {
3105
+ component: string;
3106
+ path?: string;
3107
+ args: unknown;
3108
+ raw_code?: {
3109
+ content: string;
3110
+ language: string;
3111
+ path?: string;
3112
+ lock?: string;
3113
+ cache_ttl?: number;
3114
+ };
3115
+ force_viewer_static_fields?: {
3116
+ [key: string]: unknown;
3117
+ };
3118
+ force_viewer_one_of_fields?: {
3119
+ [key: string]: unknown;
3120
+ };
3121
+ force_viewer_allow_user_resources?: Array<(string)>;
3122
+ };
3123
+ workspace: string;
3124
+ };
3125
+ export type ExecuteComponentResponse = (string);
3126
+ export type RunFlowByPathData = {
3127
+ /**
3128
+ * List of headers's keys (separated with ',') whove value are added to the args
3129
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
3130
+ *
3131
+ */
3132
+ includeHeader?: string;
3133
+ /**
3134
+ * make the run invisible to the the flow owner (default false)
3135
+ */
3136
+ invisibleToOwner?: boolean;
3137
+ /**
3138
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
3139
+ */
3140
+ jobId?: string;
3141
+ /**
3142
+ * The parent job that is at the origin and responsible for the execution of this script if any
3143
+ */
3144
+ parentJob?: string;
3145
+ path: string;
3146
+ /**
3147
+ * flow args
3148
+ */
3149
+ requestBody: ScriptArgs;
3150
+ /**
3151
+ * when to schedule this job (leave empty for immediate run)
3152
+ */
3153
+ scheduledFor?: string;
3154
+ /**
3155
+ * schedule the script to execute in the number of seconds starting now
3156
+ */
3157
+ scheduledInSecs?: number;
3158
+ /**
3159
+ * Override the tag to use
3160
+ */
3161
+ tag?: string;
3162
+ workspace: string;
3163
+ };
3164
+ export type RunFlowByPathResponse = (string);
3165
+ export type RestartFlowAtStepData = {
3166
+ /**
3167
+ * for branchall or loop, the iteration at which the flow should restart
3168
+ */
3169
+ branchOrIterationN: number;
3170
+ id: string;
3171
+ /**
3172
+ * List of headers's keys (separated with ',') whove value are added to the args
3173
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
3174
+ *
3175
+ */
3176
+ includeHeader?: string;
3177
+ /**
3178
+ * make the run invisible to the the flow owner (default false)
3179
+ */
3180
+ invisibleToOwner?: boolean;
3181
+ /**
3182
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
3183
+ */
3184
+ jobId?: string;
3185
+ /**
3186
+ * The parent job that is at the origin and responsible for the execution of this script if any
3187
+ */
3188
+ parentJob?: string;
3189
+ /**
3190
+ * flow args
3191
+ */
3192
+ requestBody: ScriptArgs;
3193
+ /**
3194
+ * when to schedule this job (leave empty for immediate run)
3195
+ */
3196
+ scheduledFor?: string;
3197
+ /**
3198
+ * schedule the script to execute in the number of seconds starting now
3199
+ */
3200
+ scheduledInSecs?: number;
3201
+ /**
3202
+ * step id to restart the flow from
3203
+ */
3204
+ stepId: string;
3205
+ /**
3206
+ * Override the tag to use
3207
+ */
3208
+ tag?: string;
3209
+ workspace: string;
3210
+ };
3211
+ export type RestartFlowAtStepResponse = (string);
3212
+ export type RunScriptByHashData = {
3213
+ /**
3214
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
3215
+ */
3216
+ cacheTtl?: string;
3217
+ hash: string;
3218
+ /**
3219
+ * List of headers's keys (separated with ',') whove value are added to the args
3220
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
3221
+ *
3222
+ */
3223
+ includeHeader?: string;
3224
+ /**
3225
+ * make the run invisible to the the script owner (default false)
3226
+ */
3227
+ invisibleToOwner?: boolean;
3228
+ /**
3229
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
3230
+ */
3231
+ jobId?: string;
3232
+ /**
3233
+ * The parent job that is at the origin and responsible for the execution of this script if any
3234
+ */
3235
+ parentJob?: string;
3236
+ /**
3237
+ * Partially filled args
3238
+ */
3239
+ requestBody: {
3240
+ [key: string]: unknown;
3241
+ };
3242
+ /**
3243
+ * when to schedule this job (leave empty for immediate run)
3244
+ */
3245
+ scheduledFor?: string;
3246
+ /**
3247
+ * schedule the script to execute in the number of seconds starting now
3248
+ */
3249
+ scheduledInSecs?: number;
3250
+ /**
3251
+ * Override the tag to use
3252
+ */
3253
+ tag?: string;
3254
+ workspace: string;
3255
+ };
3256
+ export type RunScriptByHashResponse = (string);
3257
+ export type RunScriptPreviewData = {
3258
+ /**
3259
+ * List of headers's keys (separated with ',') whove value are added to the args
3260
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
3261
+ *
3262
+ */
3263
+ includeHeader?: string;
3264
+ /**
3265
+ * make the run invisible to the the script owner (default false)
3266
+ */
3267
+ invisibleToOwner?: boolean;
3268
+ /**
3269
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
3270
+ */
3271
+ jobId?: string;
3272
+ /**
3273
+ * preview
3274
+ */
3275
+ requestBody: Preview;
3276
+ workspace: string;
3277
+ };
3278
+ export type RunScriptPreviewResponse = (string);
3279
+ export type RunCodeWorkflowTaskData = {
3280
+ entrypoint: string;
3281
+ jobId: string;
3282
+ /**
3283
+ * preview
3284
+ */
3285
+ requestBody: WorkflowTask;
3286
+ workspace: string;
3287
+ };
3288
+ export type RunCodeWorkflowTaskResponse = (string);
3289
+ export type RunRawScriptDependenciesData = {
3290
+ /**
3291
+ * raw script content
3292
+ */
3293
+ requestBody: {
3294
+ raw_scripts: Array<RawScriptForDependencies>;
3295
+ entrypoint: string;
3296
+ };
3297
+ workspace: string;
3298
+ };
3299
+ export type RunRawScriptDependenciesResponse = ({
3300
+ lock: string;
3301
+ });
3302
+ export type RunFlowPreviewData = {
3303
+ /**
3304
+ * List of headers's keys (separated with ',') whove value are added to the args
3305
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
3306
+ *
3307
+ */
3308
+ includeHeader?: string;
3309
+ /**
3310
+ * make the run invisible to the the script owner (default false)
3311
+ */
3312
+ invisibleToOwner?: boolean;
3313
+ /**
3314
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
3315
+ */
3316
+ jobId?: string;
3317
+ /**
3318
+ * preview
3319
+ */
3320
+ requestBody: FlowPreview;
3321
+ workspace: string;
3322
+ };
3323
+ export type RunFlowPreviewResponse = (string);
3324
+ export type ListQueueData = {
3325
+ /**
3326
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
3327
+ */
3328
+ allWorkspaces?: boolean;
3329
+ /**
3330
+ * filter on jobs containing those args as a json subset (@> in postgres)
3331
+ */
3332
+ args?: string;
3333
+ /**
3334
+ * mask to filter exact matching user creator
3335
+ */
3336
+ createdBy?: string;
3337
+ /**
3338
+ * is not a scheduled job
3339
+ */
3340
+ isNotSchedule?: boolean;
3341
+ /**
3342
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
3343
+ */
3344
+ jobKinds?: string;
3345
+ /**
3346
+ * order by desc order (default true)
3347
+ */
3348
+ orderDesc?: boolean;
3349
+ /**
3350
+ * which page to return (start at 1, default 1)
3351
+ */
3352
+ page?: number;
3353
+ /**
3354
+ * The parent job that is at the origin and responsible for the execution of this script if any
3355
+ */
3356
+ parentJob?: string;
3357
+ /**
3358
+ * number of items to return for a given page (default 30, max 100)
3359
+ */
3360
+ perPage?: number;
3361
+ /**
3362
+ * filter on jobs containing those result as a json subset (@> in postgres)
3363
+ */
3364
+ result?: string;
3365
+ /**
3366
+ * filter on running jobs
3367
+ */
3368
+ running?: boolean;
3369
+ /**
3370
+ * filter on jobs scheduled_for before now (hence waitinf for a worker)
3371
+ */
3372
+ scheduledForBeforeNow?: boolean;
3373
+ /**
3374
+ * mask to filter by schedule path
3375
+ */
3376
+ schedulePath?: string;
3377
+ /**
3378
+ * mask to filter exact matching path
3379
+ */
3380
+ scriptHash?: string;
3381
+ /**
3382
+ * mask to filter exact matching path
3383
+ */
3384
+ scriptPathExact?: string;
3385
+ /**
3386
+ * mask to filter matching starting path
3387
+ */
3388
+ scriptPathStart?: string;
3389
+ /**
3390
+ * filter on started after (exclusive) timestamp
3391
+ */
3392
+ startedAfter?: string;
3393
+ /**
3394
+ * filter on started before (inclusive) timestamp
3395
+ */
3396
+ startedBefore?: string;
3397
+ /**
3398
+ * filter on successful jobs
3399
+ */
3400
+ success?: boolean;
3401
+ /**
3402
+ * filter on suspended jobs
3403
+ */
3404
+ suspended?: boolean;
3405
+ /**
3406
+ * filter on jobs with a given tag/worker group
3407
+ */
3408
+ tag?: string;
3409
+ workspace: string;
3410
+ };
3411
+ export type ListQueueResponse = (Array<QueuedJob>);
3412
+ export type GetQueueCountData = {
3413
+ /**
3414
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
3415
+ */
3416
+ allWorkspaces?: boolean;
3417
+ workspace: string;
3418
+ };
3419
+ export type GetQueueCountResponse = ({
3420
+ database_length: number;
3421
+ suspended?: number;
3422
+ });
3423
+ export type GetCompletedCountData = {
3424
+ workspace: string;
3425
+ };
3426
+ export type GetCompletedCountResponse = ({
3427
+ database_length: number;
3428
+ });
3429
+ export type ListFilteredUuidsData = {
3430
+ /**
3431
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
3432
+ */
3433
+ allWorkspaces?: boolean;
3434
+ /**
3435
+ * filter on jobs containing those args as a json subset (@> in postgres)
3436
+ */
3437
+ args?: string;
3438
+ concurrencyKey?: string;
3439
+ /**
3440
+ * mask to filter exact matching user creator
3441
+ */
3442
+ createdBy?: string;
3443
+ /**
3444
+ * is not a scheduled job
3445
+ */
3446
+ isNotSchedule?: boolean;
3447
+ /**
3448
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
3449
+ */
3450
+ jobKinds?: string;
3451
+ /**
3452
+ * order by desc order (default true)
3453
+ */
3454
+ orderDesc?: boolean;
3455
+ /**
3456
+ * which page to return (start at 1, default 1)
3457
+ */
3458
+ page?: number;
3459
+ /**
3460
+ * The parent job that is at the origin and responsible for the execution of this script if any
3461
+ */
3462
+ parentJob?: string;
3463
+ /**
3464
+ * number of items to return for a given page (default 30, max 100)
3465
+ */
3466
+ perPage?: number;
3467
+ /**
3468
+ * filter on jobs containing those result as a json subset (@> in postgres)
3469
+ */
3470
+ result?: string;
3471
+ /**
3472
+ * filter on running jobs
3473
+ */
3474
+ running?: boolean;
3475
+ /**
3476
+ * filter on jobs scheduled_for before now (hence waitinf for a worker)
3477
+ */
3478
+ scheduledForBeforeNow?: boolean;
3479
+ /**
3480
+ * mask to filter by schedule path
3481
+ */
3482
+ schedulePath?: string;
3483
+ /**
3484
+ * mask to filter exact matching path
3485
+ */
3486
+ scriptHash?: string;
3487
+ /**
3488
+ * mask to filter exact matching path
3489
+ */
3490
+ scriptPathExact?: string;
3491
+ /**
3492
+ * mask to filter matching starting path
3493
+ */
3494
+ scriptPathStart?: string;
3495
+ /**
3496
+ * filter on started after (exclusive) timestamp
3497
+ */
3498
+ startedAfter?: string;
3499
+ /**
3500
+ * filter on started before (inclusive) timestamp
3501
+ */
3502
+ startedBefore?: string;
3503
+ /**
3504
+ * filter on successful jobs
3505
+ */
3506
+ success?: boolean;
3507
+ /**
3508
+ * filter on suspended jobs
3509
+ */
3510
+ suspended?: boolean;
3511
+ /**
3512
+ * filter on jobs with a given tag/worker group
3513
+ */
3514
+ tag?: string;
3515
+ workspace: string;
3516
+ };
3517
+ export type ListFilteredUuidsResponse = (Array<(string)>);
3518
+ export type CancelSelectionData = {
3519
+ /**
3520
+ * uuids of the jobs to cancel
3521
+ */
3522
+ requestBody: Array<(string)>;
3523
+ workspace: string;
3524
+ };
3525
+ export type CancelSelectionResponse = (Array<(string)>);
3526
+ export type ListCompletedJobsData = {
3527
+ /**
3528
+ * filter on jobs containing those args as a json subset (@> in postgres)
3529
+ */
3530
+ args?: string;
3531
+ /**
3532
+ * mask to filter exact matching user creator
3533
+ */
3534
+ createdBy?: string;
3535
+ /**
3536
+ * has null parent
3537
+ */
3538
+ hasNullParent?: boolean;
3539
+ /**
3540
+ * is the job a flow step
3541
+ */
3542
+ isFlowStep?: boolean;
3543
+ /**
3544
+ * is not a scheduled job
3545
+ */
3546
+ isNotSchedule?: boolean;
3547
+ /**
3548
+ * is the job skipped
3549
+ */
3550
+ isSkipped?: boolean;
3551
+ /**
3552
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
3553
+ */
3554
+ jobKinds?: string;
3555
+ /**
3556
+ * mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
3557
+ */
3558
+ label?: string;
3559
+ /**
3560
+ * order by desc order (default true)
3561
+ */
3562
+ orderDesc?: boolean;
3563
+ /**
3564
+ * which page to return (start at 1, default 1)
3565
+ */
3566
+ page?: number;
3567
+ /**
3568
+ * The parent job that is at the origin and responsible for the execution of this script if any
3569
+ */
3570
+ parentJob?: string;
3571
+ /**
3572
+ * number of items to return for a given page (default 30, max 100)
3573
+ */
3574
+ perPage?: number;
3575
+ /**
3576
+ * filter on jobs containing those result as a json subset (@> in postgres)
3577
+ */
3578
+ result?: string;
3579
+ /**
3580
+ * mask to filter by schedule path
3581
+ */
3582
+ schedulePath?: string;
3583
+ /**
3584
+ * mask to filter exact matching path
3585
+ */
3586
+ scriptHash?: string;
3587
+ /**
3588
+ * mask to filter exact matching path
3589
+ */
3590
+ scriptPathExact?: string;
3591
+ /**
3592
+ * mask to filter matching starting path
3593
+ */
3594
+ scriptPathStart?: string;
3595
+ /**
3596
+ * filter on started after (exclusive) timestamp
3597
+ */
3598
+ startedAfter?: string;
3599
+ /**
3600
+ * filter on started before (inclusive) timestamp
3601
+ */
3602
+ startedBefore?: string;
3603
+ /**
3604
+ * filter on successful jobs
3605
+ */
3606
+ success?: boolean;
3607
+ /**
3608
+ * filter on jobs with a given tag/worker group
3609
+ */
3610
+ tag?: string;
3611
+ workspace: string;
3612
+ };
3613
+ export type ListCompletedJobsResponse = (Array<CompletedJob>);
3614
+ export type ListJobsData = {
3615
+ /**
3616
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
3617
+ */
3618
+ allWorkspaces?: boolean;
3619
+ /**
3620
+ * filter on jobs containing those args as a json subset (@> in postgres)
3621
+ */
3622
+ args?: string;
3623
+ /**
3624
+ * filter on created after (exclusive) timestamp
3625
+ */
3626
+ createdAfter?: string;
3627
+ /**
3628
+ * filter on created before (inclusive) timestamp
3629
+ */
3630
+ createdBefore?: string;
3631
+ /**
3632
+ * mask to filter exact matching user creator
3633
+ */
3634
+ createdBy?: string;
3635
+ /**
3636
+ * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
3637
+ */
3638
+ createdOrStartedAfter?: string;
3639
+ /**
3640
+ * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp but only for the completed jobs
3641
+ */
3642
+ createdOrStartedAfterCompletedJobs?: string;
3643
+ /**
3644
+ * filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
3645
+ */
3646
+ createdOrStartedBefore?: string;
3647
+ /**
3648
+ * has null parent
3649
+ */
3650
+ hasNullParent?: boolean;
3651
+ /**
3652
+ * is the job a flow step
3653
+ */
3654
+ isFlowStep?: boolean;
3655
+ /**
3656
+ * is not a scheduled job
3657
+ */
3658
+ isNotSchedule?: boolean;
3659
+ /**
3660
+ * is the job skipped
3661
+ */
3662
+ isSkipped?: boolean;
3663
+ /**
3664
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
3665
+ */
3666
+ jobKinds?: string;
3667
+ /**
3668
+ * mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
3669
+ */
3670
+ label?: string;
3671
+ /**
3672
+ * which page to return (start at 1, default 1)
3673
+ */
3674
+ page?: number;
3675
+ /**
3676
+ * The parent job that is at the origin and responsible for the execution of this script if any
3677
+ */
3678
+ parentJob?: string;
3679
+ /**
3680
+ * number of items to return for a given page (default 30, max 100)
3681
+ */
3682
+ perPage?: number;
3683
+ /**
3684
+ * filter on jobs containing those result as a json subset (@> in postgres)
3685
+ */
3686
+ result?: string;
3687
+ /**
3688
+ * filter on running jobs
3689
+ */
3690
+ running?: boolean;
3691
+ /**
3692
+ * filter on jobs scheduled_for before now (hence waitinf for a worker)
3693
+ */
3694
+ scheduledForBeforeNow?: boolean;
3695
+ /**
3696
+ * mask to filter by schedule path
3697
+ */
3698
+ schedulePath?: string;
3699
+ /**
3700
+ * mask to filter exact matching path
3701
+ */
3702
+ scriptHash?: string;
3703
+ /**
3704
+ * mask to filter exact matching path
3705
+ */
3706
+ scriptPathExact?: string;
3707
+ /**
3708
+ * mask to filter matching starting path
3709
+ */
3710
+ scriptPathStart?: string;
3711
+ /**
3712
+ * filter on started after (exclusive) timestamp
3713
+ */
3714
+ startedAfter?: string;
3715
+ /**
3716
+ * filter on started before (inclusive) timestamp
3717
+ */
3718
+ startedBefore?: string;
3719
+ /**
3720
+ * filter on successful jobs
3721
+ */
3722
+ success?: boolean;
3723
+ /**
3724
+ * filter on suspended jobs
3725
+ */
3726
+ suspended?: boolean;
3727
+ /**
3728
+ * filter on jobs with a given tag/worker group
3729
+ */
3730
+ tag?: string;
3731
+ workspace: string;
3732
+ };
3733
+ export type ListJobsResponse = (Array<Job>);
3734
+ export type GetDbClockResponse = (number);
3735
+ export type GetJobData = {
3736
+ id: string;
3737
+ noLogs?: boolean;
3738
+ workspace: string;
3739
+ };
3740
+ export type GetJobResponse = (Job);
3741
+ export type GetRootJobIdData = {
3742
+ id: string;
3743
+ workspace: string;
3744
+ };
3745
+ export type GetRootJobIdResponse = (string);
3746
+ export type GetJobLogsData = {
3747
+ id: string;
3748
+ workspace: string;
3749
+ };
3750
+ export type GetJobLogsResponse = (string);
3751
+ export type GetJobArgsData = {
3752
+ id: string;
3753
+ workspace: string;
3754
+ };
3755
+ export type GetJobArgsResponse = (unknown);
3756
+ export type GetJobUpdatesData = {
3757
+ getProgress?: boolean;
3758
+ id: string;
3759
+ logOffset?: number;
3760
+ running?: boolean;
3761
+ workspace: string;
3762
+ };
3763
+ export type GetJobUpdatesResponse = ({
3764
+ running?: boolean;
3765
+ completed?: boolean;
3766
+ new_logs?: string;
3767
+ log_offset?: number;
3768
+ mem_peak?: number;
3769
+ progress?: number;
3770
+ flow_status?: WorkflowStatusRecord;
3771
+ });
3772
+ export type GetLogFileFromStoreData = {
3773
+ path: string;
3774
+ workspace: string;
3775
+ };
3776
+ export type GetLogFileFromStoreResponse = (unknown);
3777
+ export type GetFlowDebugInfoData = {
3778
+ id: string;
3779
+ workspace: string;
3780
+ };
3781
+ export type GetFlowDebugInfoResponse = (unknown);
3782
+ export type GetCompletedJobData = {
3783
+ id: string;
3784
+ workspace: string;
3785
+ };
3786
+ export type GetCompletedJobResponse = (CompletedJob);
3787
+ export type GetCompletedJobResultData = {
3788
+ approver?: string;
3789
+ id: string;
3790
+ resumeId?: number;
3791
+ secret?: string;
3792
+ suspendedJob?: string;
3793
+ workspace: string;
3794
+ };
3795
+ export type GetCompletedJobResultResponse = (unknown);
3796
+ export type GetCompletedJobResultMaybeData = {
3797
+ getStarted?: boolean;
3798
+ id: string;
3799
+ workspace: string;
3800
+ };
3801
+ export type GetCompletedJobResultMaybeResponse = ({
3802
+ completed: boolean;
3803
+ result: unknown;
3804
+ success?: boolean;
3805
+ started?: boolean;
3806
+ });
3807
+ export type DeleteCompletedJobData = {
3808
+ id: string;
3809
+ workspace: string;
3810
+ };
3811
+ export type DeleteCompletedJobResponse = (CompletedJob);
3812
+ export type CancelQueuedJobData = {
3813
+ id: string;
3814
+ /**
3815
+ * reason
3816
+ */
3817
+ requestBody: {
3818
+ reason?: string;
3819
+ };
3820
+ workspace: string;
3821
+ };
3822
+ export type CancelQueuedJobResponse = (string);
3823
+ export type CancelPersistentQueuedJobsData = {
3824
+ path: string;
3825
+ /**
3826
+ * reason
3827
+ */
3828
+ requestBody: {
3829
+ reason?: string;
3830
+ };
3831
+ workspace: string;
3832
+ };
3833
+ export type CancelPersistentQueuedJobsResponse = (string);
3834
+ export type ForceCancelQueuedJobData = {
3835
+ id: string;
3836
+ /**
3837
+ * reason
3838
+ */
3839
+ requestBody: {
3840
+ reason?: string;
3841
+ };
3842
+ workspace: string;
3843
+ };
3844
+ export type ForceCancelQueuedJobResponse = (string);
3845
+ export type CreateJobSignatureData = {
3846
+ approver?: string;
3847
+ id: string;
3848
+ resumeId: number;
3849
+ workspace: string;
3850
+ };
3851
+ export type CreateJobSignatureResponse = (string);
3852
+ export type GetResumeUrlsData = {
3853
+ approver?: string;
3854
+ id: string;
3855
+ resumeId: number;
3856
+ workspace: string;
3857
+ };
3858
+ export type GetResumeUrlsResponse = ({
3859
+ approvalPage: string;
3860
+ resume: string;
3861
+ cancel: string;
3862
+ });
3863
+ export type ResumeSuspendedJobGetData = {
3864
+ approver?: string;
3865
+ id: string;
3866
+ /**
3867
+ * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
3868
+ * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
3869
+ *
3870
+ */
3871
+ payload?: string;
3872
+ resumeId: number;
3873
+ signature: string;
3874
+ workspace: string;
3875
+ };
3876
+ export type ResumeSuspendedJobGetResponse = (string);
3877
+ export type ResumeSuspendedJobPostData = {
3878
+ approver?: string;
3879
+ id: string;
3880
+ requestBody: {
3881
+ [key: string]: unknown;
3882
+ };
3883
+ resumeId: number;
3884
+ signature: string;
3885
+ workspace: string;
3886
+ };
3887
+ export type ResumeSuspendedJobPostResponse = (string);
3888
+ export type SetFlowUserStateData = {
3889
+ id: string;
3890
+ key: string;
3891
+ /**
3892
+ * new value
3893
+ */
3894
+ requestBody: unknown;
3895
+ workspace: string;
3896
+ };
3897
+ export type SetFlowUserStateResponse = (string);
3898
+ export type GetFlowUserStateData = {
3899
+ id: string;
3900
+ key: string;
3901
+ workspace: string;
3902
+ };
3903
+ export type GetFlowUserStateResponse = (unknown);
3904
+ export type ResumeSuspendedFlowAsOwnerData = {
3905
+ id: string;
3906
+ requestBody: {
3907
+ [key: string]: unknown;
3908
+ };
3909
+ workspace: string;
3910
+ };
3911
+ export type ResumeSuspendedFlowAsOwnerResponse = (string);
3912
+ export type CancelSuspendedJobGetData = {
3913
+ approver?: string;
3914
+ id: string;
3915
+ resumeId: number;
3916
+ signature: string;
3917
+ workspace: string;
3918
+ };
3919
+ export type CancelSuspendedJobGetResponse = (string);
3920
+ export type CancelSuspendedJobPostData = {
3921
+ approver?: string;
3922
+ id: string;
3923
+ requestBody: {
3924
+ [key: string]: unknown;
3925
+ };
3926
+ resumeId: number;
3927
+ signature: string;
3928
+ workspace: string;
3929
+ };
3930
+ export type CancelSuspendedJobPostResponse = (string);
3931
+ export type GetSuspendedJobFlowData = {
3932
+ approver?: string;
3933
+ id: string;
3934
+ resumeId: number;
3935
+ signature: string;
3936
+ workspace: string;
3937
+ };
3938
+ export type GetSuspendedJobFlowResponse = ({
3939
+ job: Job;
3940
+ approvers: Array<{
3941
+ resume_id: number;
3942
+ approver: string;
3943
+ }>;
3944
+ });
3945
+ export type PreviewScheduleData = {
3946
+ /**
3947
+ * schedule
3948
+ */
3949
+ requestBody: {
3950
+ schedule: string;
3951
+ timezone: string;
3952
+ };
3953
+ };
3954
+ export type PreviewScheduleResponse = (Array<(string)>);
3955
+ export type CreateScheduleData = {
3956
+ /**
3957
+ * new schedule
3958
+ */
3959
+ requestBody: NewSchedule;
3960
+ workspace: string;
3961
+ };
3962
+ export type CreateScheduleResponse = (string);
3963
+ export type UpdateScheduleData = {
3964
+ path: string;
3965
+ /**
3966
+ * updated schedule
3967
+ */
3968
+ requestBody: EditSchedule;
3969
+ workspace: string;
3970
+ };
3971
+ export type UpdateScheduleResponse = (string);
3972
+ export type SetScheduleEnabledData = {
3973
+ path: string;
3974
+ /**
3975
+ * updated schedule enable
3976
+ */
3977
+ requestBody: {
3978
+ enabled: boolean;
3979
+ };
3980
+ workspace: string;
3981
+ };
3982
+ export type SetScheduleEnabledResponse = (string);
3983
+ export type DeleteScheduleData = {
3984
+ path: string;
3985
+ workspace: string;
3986
+ };
3987
+ export type DeleteScheduleResponse = (string);
3988
+ export type GetScheduleData = {
3989
+ path: string;
3990
+ workspace: string;
3991
+ };
3992
+ export type GetScheduleResponse = (Schedule);
3993
+ export type ExistsScheduleData = {
3994
+ path: string;
3995
+ workspace: string;
3996
+ };
3997
+ export type ExistsScheduleResponse = (boolean);
3998
+ export type ListSchedulesData = {
3999
+ /**
4000
+ * filter on jobs containing those args as a json subset (@> in postgres)
4001
+ */
4002
+ args?: string;
4003
+ isFlow?: boolean;
4004
+ /**
4005
+ * which page to return (start at 1, default 1)
4006
+ */
4007
+ page?: number;
4008
+ /**
4009
+ * filter by path
4010
+ */
4011
+ path?: string;
4012
+ pathStart?: string;
4013
+ /**
4014
+ * number of items to return for a given page (default 30, max 100)
4015
+ */
4016
+ perPage?: number;
4017
+ workspace: string;
4018
+ };
4019
+ export type ListSchedulesResponse = (Array<Schedule>);
4020
+ export type ListSchedulesWithJobsData = {
4021
+ /**
4022
+ * which page to return (start at 1, default 1)
4023
+ */
4024
+ page?: number;
4025
+ /**
4026
+ * number of items to return for a given page (default 30, max 100)
4027
+ */
4028
+ perPage?: number;
4029
+ workspace: string;
4030
+ };
4031
+ export type ListSchedulesWithJobsResponse = (Array<ScheduleWJobs>);
4032
+ export type SetDefaultErrorOrRecoveryHandlerData = {
4033
+ /**
4034
+ * Handler description
4035
+ */
4036
+ requestBody: {
4037
+ handler_type: 'error' | 'recovery' | 'success';
4038
+ override_existing: boolean;
4039
+ path?: string;
4040
+ extra_args?: {
4041
+ [key: string]: unknown;
4042
+ };
4043
+ number_of_occurence?: number;
4044
+ number_of_occurence_exact?: boolean;
4045
+ workspace_handler_muted?: boolean;
4046
+ };
4047
+ workspace: string;
4048
+ };
4049
+ export type SetDefaultErrorOrRecoveryHandlerResponse = (unknown);
4050
+ export type ListInstanceGroupsResponse = (Array<InstanceGroup>);
4051
+ export type GetInstanceGroupData = {
4052
+ name: string;
4053
+ };
4054
+ export type GetInstanceGroupResponse = (InstanceGroup);
4055
+ export type CreateInstanceGroupData = {
4056
+ /**
4057
+ * create instance group
4058
+ */
4059
+ requestBody: {
4060
+ name: string;
4061
+ summary?: string;
4062
+ };
4063
+ };
4064
+ export type CreateInstanceGroupResponse = (string);
4065
+ export type UpdateInstanceGroupData = {
4066
+ name: string;
4067
+ /**
4068
+ * update instance group
4069
+ */
4070
+ requestBody: {
4071
+ new_summary: string;
4072
+ };
4073
+ };
4074
+ export type UpdateInstanceGroupResponse = (string);
4075
+ export type DeleteInstanceGroupData = {
4076
+ name: string;
4077
+ };
4078
+ export type DeleteInstanceGroupResponse = (string);
4079
+ export type AddUserToInstanceGroupData = {
4080
+ name: string;
4081
+ /**
4082
+ * user to add to instance group
4083
+ */
4084
+ requestBody: {
4085
+ email: string;
4086
+ };
4087
+ };
4088
+ export type AddUserToInstanceGroupResponse = (string);
4089
+ export type RemoveUserFromInstanceGroupData = {
4090
+ name: string;
4091
+ /**
4092
+ * user to remove from instance group
4093
+ */
4094
+ requestBody: {
4095
+ email: string;
4096
+ };
4097
+ };
4098
+ export type RemoveUserFromInstanceGroupResponse = (string);
4099
+ export type ExportInstanceGroupsResponse = (Array<ExportedInstanceGroup>);
4100
+ export type OverwriteInstanceGroupsData = {
4101
+ /**
4102
+ * overwrite instance groups
4103
+ */
4104
+ requestBody: Array<ExportedInstanceGroup>;
4105
+ };
4106
+ export type OverwriteInstanceGroupsResponse = (string);
4107
+ export type ListGroupsData = {
4108
+ /**
4109
+ * which page to return (start at 1, default 1)
4110
+ */
4111
+ page?: number;
4112
+ /**
4113
+ * number of items to return for a given page (default 30, max 100)
4114
+ */
4115
+ perPage?: number;
4116
+ workspace: string;
4117
+ };
4118
+ export type ListGroupsResponse = (Array<Group>);
4119
+ export type ListGroupNamesData = {
4120
+ /**
4121
+ * only list the groups the user is member of (default false)
4122
+ */
4123
+ onlyMemberOf?: boolean;
4124
+ workspace: string;
4125
+ };
4126
+ export type ListGroupNamesResponse = (Array<(string)>);
4127
+ export type CreateGroupData = {
4128
+ /**
4129
+ * create group
4130
+ */
4131
+ requestBody: {
4132
+ name: string;
4133
+ summary?: string;
4134
+ };
4135
+ workspace: string;
4136
+ };
4137
+ export type CreateGroupResponse = (string);
4138
+ export type UpdateGroupData = {
4139
+ name: string;
4140
+ /**
4141
+ * updated group
4142
+ */
4143
+ requestBody: {
4144
+ summary?: string;
4145
+ };
4146
+ workspace: string;
4147
+ };
4148
+ export type UpdateGroupResponse = (string);
4149
+ export type DeleteGroupData = {
4150
+ name: string;
4151
+ workspace: string;
4152
+ };
4153
+ export type DeleteGroupResponse = (string);
4154
+ export type GetGroupData = {
4155
+ name: string;
4156
+ workspace: string;
4157
+ };
4158
+ export type GetGroupResponse = (Group);
4159
+ export type AddUserToGroupData = {
4160
+ name: string;
4161
+ /**
4162
+ * added user to group
4163
+ */
4164
+ requestBody: {
4165
+ username?: string;
4166
+ };
4167
+ workspace: string;
4168
+ };
4169
+ export type AddUserToGroupResponse = (string);
4170
+ export type RemoveUserToGroupData = {
4171
+ name: string;
4172
+ /**
4173
+ * added user to group
4174
+ */
4175
+ requestBody: {
4176
+ username?: string;
4177
+ };
4178
+ workspace: string;
4179
+ };
4180
+ export type RemoveUserToGroupResponse = (string);
4181
+ export type ListFoldersData = {
4182
+ /**
4183
+ * which page to return (start at 1, default 1)
4184
+ */
4185
+ page?: number;
4186
+ /**
4187
+ * number of items to return for a given page (default 30, max 100)
4188
+ */
4189
+ perPage?: number;
4190
+ workspace: string;
4191
+ };
4192
+ export type ListFoldersResponse = (Array<Folder>);
4193
+ export type ListFolderNamesData = {
4194
+ /**
4195
+ * only list the folders the user is member of (default false)
4196
+ */
4197
+ onlyMemberOf?: boolean;
4198
+ workspace: string;
4199
+ };
4200
+ export type ListFolderNamesResponse = (Array<(string)>);
4201
+ export type CreateFolderData = {
4202
+ /**
4203
+ * create folder
4204
+ */
4205
+ requestBody: {
4206
+ name: string;
4207
+ summary?: string;
4208
+ owners?: Array<(string)>;
4209
+ extra_perms?: {
4210
+ [key: string]: (boolean);
4211
+ };
4212
+ };
4213
+ workspace: string;
4214
+ };
4215
+ export type CreateFolderResponse = (string);
4216
+ export type UpdateFolderData = {
4217
+ name: string;
4218
+ /**
4219
+ * update folder
4220
+ */
4221
+ requestBody: {
4222
+ summary?: string;
4223
+ owners?: Array<(string)>;
4224
+ extra_perms?: {
4225
+ [key: string]: (boolean);
4226
+ };
4227
+ };
4228
+ workspace: string;
4229
+ };
4230
+ export type UpdateFolderResponse = (string);
4231
+ export type DeleteFolderData = {
4232
+ name: string;
4233
+ workspace: string;
4234
+ };
4235
+ export type DeleteFolderResponse = (string);
4236
+ export type GetFolderData = {
4237
+ name: string;
4238
+ workspace: string;
4239
+ };
4240
+ export type GetFolderResponse = (Folder);
4241
+ export type GetFolderUsageData = {
4242
+ name: string;
4243
+ workspace: string;
4244
+ };
4245
+ export type GetFolderUsageResponse = ({
4246
+ scripts: number;
4247
+ flows: number;
4248
+ apps: number;
4249
+ resources: number;
4250
+ variables: number;
4251
+ schedules: number;
4252
+ });
4253
+ export type AddOwnerToFolderData = {
4254
+ name: string;
4255
+ /**
4256
+ * owner user to folder
4257
+ */
4258
+ requestBody: {
4259
+ owner: string;
4260
+ };
4261
+ workspace: string;
4262
+ };
4263
+ export type AddOwnerToFolderResponse = (string);
4264
+ export type RemoveOwnerToFolderData = {
4265
+ name: string;
4266
+ /**
4267
+ * added owner to folder
4268
+ */
4269
+ requestBody: {
4270
+ owner: string;
4271
+ write?: boolean;
4272
+ };
4273
+ workspace: string;
4274
+ };
4275
+ export type RemoveOwnerToFolderResponse = (string);
4276
+ export type ListWorkersData = {
4277
+ /**
4278
+ * which page to return (start at 1, default 1)
4279
+ */
4280
+ page?: number;
4281
+ /**
4282
+ * number of items to return for a given page (default 30, max 100)
4283
+ */
4284
+ perPage?: number;
4285
+ /**
4286
+ * number of seconds the worker must have had a last ping more recent of (default to 300)
4287
+ */
4288
+ pingSince?: number;
4289
+ };
4290
+ export type ListWorkersResponse = (Array<WorkerPing>);
4291
+ export type ExistsWorkerWithTagData = {
4292
+ tag: string;
4293
+ };
4294
+ export type ExistsWorkerWithTagResponse = (boolean);
4295
+ export type GetQueueMetricsResponse = (Array<{
4296
+ id: string;
4297
+ values: Array<{
4298
+ created_at: string;
4299
+ value: number;
4300
+ }>;
4301
+ }>);
4302
+ export type ListWorkerGroupsResponse = (Array<{
4303
+ name: string;
4304
+ config: unknown;
4305
+ }>);
4306
+ export type GetConfigData = {
4307
+ name: string;
4308
+ };
4309
+ export type GetConfigResponse = (unknown);
4310
+ export type UpdateConfigData = {
4311
+ name: string;
4312
+ /**
4313
+ * worker group
4314
+ */
4315
+ requestBody: unknown;
4316
+ };
4317
+ export type UpdateConfigResponse = (string);
4318
+ export type DeleteConfigData = {
4319
+ name: string;
4320
+ };
4321
+ export type DeleteConfigResponse = (string);
4322
+ export type ListConfigsResponse = (Array<Config>);
4323
+ export type GetGranularAclsData = {
4324
+ kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
4325
+ path: string;
4326
+ workspace: string;
4327
+ };
4328
+ export type GetGranularAclsResponse = ({
4329
+ [key: string]: (boolean);
4330
+ });
4331
+ export type AddGranularAclsData = {
4332
+ kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
4333
+ path: string;
4334
+ /**
4335
+ * acl to add
4336
+ */
4337
+ requestBody: {
4338
+ owner: string;
4339
+ write?: boolean;
4340
+ };
4341
+ workspace: string;
4342
+ };
4343
+ export type AddGranularAclsResponse = (string);
4344
+ export type RemoveGranularAclsData = {
4345
+ kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
4346
+ path: string;
4347
+ /**
4348
+ * acl to add
4349
+ */
4350
+ requestBody: {
4351
+ owner: string;
4352
+ };
4353
+ workspace: string;
4354
+ };
4355
+ export type RemoveGranularAclsResponse = (string);
4356
+ export type UpdateCaptureData = {
4357
+ path: string;
4358
+ workspace: string;
4359
+ };
4360
+ export type UpdateCaptureResponse = (void);
4361
+ export type CreateCaptureData = {
4362
+ path: string;
4363
+ workspace: string;
4364
+ };
4365
+ export type CreateCaptureResponse = (unknown);
4366
+ export type GetCaptureData = {
4367
+ path: string;
4368
+ workspace: string;
4369
+ };
4370
+ export type GetCaptureResponse = (unknown);
4371
+ export type StarData = {
4372
+ requestBody?: {
4373
+ path?: string;
4374
+ favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
4375
+ };
4376
+ workspace: string;
4377
+ };
4378
+ export type StarResponse = (unknown);
4379
+ export type UnstarData = {
4380
+ requestBody?: {
4381
+ path?: string;
4382
+ favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
4383
+ };
4384
+ workspace: string;
4385
+ };
4386
+ export type UnstarResponse = (unknown);
4387
+ export type GetInputHistoryData = {
4388
+ /**
4389
+ * which page to return (start at 1, default 1)
4390
+ */
4391
+ page?: number;
4392
+ /**
4393
+ * number of items to return for a given page (default 30, max 100)
4394
+ */
4395
+ perPage?: number;
4396
+ runnableId?: string;
4397
+ runnableType?: RunnableType;
4398
+ workspace: string;
4399
+ };
4400
+ export type GetInputHistoryResponse = (Array<Input>);
4401
+ export type GetArgsFromHistoryOrSavedInputData = {
4402
+ allowLarge?: boolean;
4403
+ input?: boolean;
4404
+ jobOrInputId: string;
4405
+ workspace: string;
4406
+ };
4407
+ export type GetArgsFromHistoryOrSavedInputResponse = (unknown);
4408
+ export type ListInputsData = {
4409
+ /**
4410
+ * which page to return (start at 1, default 1)
4411
+ */
4412
+ page?: number;
4413
+ /**
4414
+ * number of items to return for a given page (default 30, max 100)
4415
+ */
4416
+ perPage?: number;
4417
+ runnableId?: string;
4418
+ runnableType?: RunnableType;
4419
+ workspace: string;
4420
+ };
4421
+ export type ListInputsResponse = (Array<Input>);
4422
+ export type CreateInputData = {
4423
+ /**
4424
+ * Input
4425
+ */
4426
+ requestBody: CreateInput;
4427
+ runnableId?: string;
4428
+ runnableType?: RunnableType;
4429
+ workspace: string;
4430
+ };
4431
+ export type CreateInputResponse = (string);
4432
+ export type UpdateInputData = {
4433
+ /**
4434
+ * UpdateInput
4435
+ */
4436
+ requestBody: UpdateInput;
4437
+ workspace: string;
4438
+ };
4439
+ export type UpdateInputResponse = (string);
4440
+ export type DeleteInputData = {
4441
+ input: string;
4442
+ workspace: string;
4443
+ };
4444
+ export type DeleteInputResponse = (string);
4445
+ export type DuckdbConnectionSettingsData = {
4446
+ /**
4447
+ * S3 resource to connect to
4448
+ */
4449
+ requestBody: {
4450
+ s3_resource?: S3Resource;
4451
+ };
4452
+ workspace: string;
4453
+ };
4454
+ export type DuckdbConnectionSettingsResponse = ({
4455
+ connection_settings_str?: string;
4456
+ });
4457
+ export type DuckdbConnectionSettingsV2Data = {
4458
+ /**
4459
+ * S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
4460
+ */
4461
+ requestBody: {
4462
+ s3_resource_path?: string;
4463
+ };
4464
+ workspace: string;
4465
+ };
4466
+ export type DuckdbConnectionSettingsV2Response = ({
4467
+ connection_settings_str: string;
4468
+ });
4469
+ export type PolarsConnectionSettingsData = {
4470
+ /**
4471
+ * S3 resource to connect to
4472
+ */
4473
+ requestBody: {
4474
+ s3_resource?: S3Resource;
4475
+ };
4476
+ workspace: string;
4477
+ };
4478
+ export type PolarsConnectionSettingsResponse = ({
4479
+ endpoint_url: string;
4480
+ key?: string;
4481
+ secret?: string;
4482
+ use_ssl: boolean;
4483
+ cache_regions: boolean;
4484
+ client_kwargs: PolarsClientKwargs;
4485
+ });
4486
+ export type PolarsConnectionSettingsV2Data = {
4487
+ /**
4488
+ * S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
4489
+ */
4490
+ requestBody: {
4491
+ s3_resource_path?: string;
4492
+ };
4493
+ workspace: string;
4494
+ };
4495
+ export type PolarsConnectionSettingsV2Response = ({
4496
+ s3fs_args: {
4497
+ endpoint_url: string;
4498
+ key?: string;
4499
+ secret?: string;
4500
+ use_ssl: boolean;
4501
+ cache_regions: boolean;
4502
+ client_kwargs: PolarsClientKwargs;
4503
+ };
4504
+ storage_options: {
4505
+ aws_endpoint_url: string;
4506
+ aws_access_key_id?: string;
4507
+ aws_secret_access_key?: string;
4508
+ aws_region: string;
4509
+ aws_allow_http: string;
4510
+ };
4511
+ });
4512
+ export type S3ResourceInfoData = {
4513
+ /**
4514
+ * S3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used
4515
+ */
4516
+ requestBody: {
4517
+ s3_resource_path?: string;
4518
+ };
4519
+ workspace: string;
4520
+ };
4521
+ export type S3ResourceInfoResponse = (S3Resource);
4522
+ export type DatasetStorageTestConnectionData = {
4523
+ storage?: string;
4524
+ workspace: string;
4525
+ };
4526
+ export type DatasetStorageTestConnectionResponse = (unknown);
4527
+ export type ListStoredFilesData = {
4528
+ marker?: string;
4529
+ maxKeys: number;
4530
+ prefix?: string;
4531
+ storage?: string;
4532
+ workspace: string;
4533
+ };
4534
+ export type ListStoredFilesResponse = ({
4535
+ next_marker?: string;
4536
+ windmill_large_files: Array<WindmillLargeFile>;
4537
+ restricted_access?: boolean;
4538
+ });
4539
+ export type LoadFileMetadataData = {
4540
+ fileKey: string;
4541
+ storage?: string;
4542
+ workspace: string;
4543
+ };
4544
+ export type LoadFileMetadataResponse = (WindmillFileMetadata);
4545
+ export type LoadFilePreviewData = {
4546
+ csvHasHeader?: boolean;
4547
+ csvSeparator?: string;
4548
+ fileKey: string;
4549
+ fileMimeType?: string;
4550
+ fileSizeInBytes?: number;
4551
+ readBytesFrom?: number;
4552
+ readBytesLength?: number;
4553
+ storage?: string;
4554
+ workspace: string;
4555
+ };
4556
+ export type LoadFilePreviewResponse = (WindmillFilePreview);
4557
+ export type LoadParquetPreviewData = {
4558
+ limit?: number;
4559
+ offset?: number;
4560
+ path: string;
4561
+ searchCol?: string;
4562
+ searchTerm?: string;
4563
+ sortCol?: string;
4564
+ sortDesc?: boolean;
4565
+ storage?: string;
4566
+ workspace: string;
4567
+ };
4568
+ export type LoadParquetPreviewResponse = (unknown);
4569
+ export type LoadTableRowCountData = {
4570
+ path: string;
4571
+ searchCol?: string;
4572
+ searchTerm?: string;
4573
+ storage?: string;
4574
+ workspace: string;
4575
+ };
4576
+ export type LoadTableRowCountResponse = ({
4577
+ count?: number;
4578
+ });
4579
+ export type LoadCsvPreviewData = {
4580
+ csvSeparator?: string;
4581
+ limit?: number;
4582
+ offset?: number;
4583
+ path: string;
4584
+ searchCol?: string;
4585
+ searchTerm?: string;
4586
+ sortCol?: string;
4587
+ sortDesc?: boolean;
4588
+ storage?: string;
4589
+ workspace: string;
4590
+ };
4591
+ export type LoadCsvPreviewResponse = (unknown);
4592
+ export type DeleteS3FileData = {
4593
+ fileKey: string;
4594
+ storage?: string;
4595
+ workspace: string;
4596
+ };
4597
+ export type DeleteS3FileResponse = (unknown);
4598
+ export type MoveS3FileData = {
4599
+ destFileKey: string;
4600
+ srcFileKey: string;
4601
+ storage?: string;
4602
+ workspace: string;
4603
+ };
4604
+ export type MoveS3FileResponse = (unknown);
4605
+ export type FileUploadData = {
4606
+ fileExtension?: string;
4607
+ fileKey?: string;
4608
+ /**
4609
+ * File content
4610
+ */
4611
+ requestBody: (Blob | File);
4612
+ resourceType?: string;
4613
+ s3ResourcePath?: string;
4614
+ storage?: string;
4615
+ workspace: string;
4616
+ };
4617
+ export type FileUploadResponse = ({
4618
+ file_key: string;
4619
+ });
4620
+ export type FileDownloadData = {
4621
+ fileKey: string;
4622
+ resourceType?: string;
4623
+ s3ResourcePath?: string;
4624
+ storage?: string;
4625
+ workspace: string;
4626
+ };
4627
+ export type FileDownloadResponse = ((Blob | File));
4628
+ export type FileDownloadParquetAsCsvData = {
4629
+ fileKey: string;
4630
+ resourceType?: string;
4631
+ s3ResourcePath?: string;
4632
+ workspace: string;
4633
+ };
4634
+ export type FileDownloadParquetAsCsvResponse = (string);
4635
+ export type GetJobMetricsData = {
4636
+ id: string;
4637
+ /**
4638
+ * parameters for statistics retrieval
4639
+ */
4640
+ requestBody: {
4641
+ timeseries_max_datapoints?: number;
4642
+ from_timestamp?: string;
4643
+ to_timestamp?: string;
4644
+ };
4645
+ workspace: string;
4646
+ };
4647
+ export type GetJobMetricsResponse = ({
4648
+ metrics_metadata?: Array<MetricMetadata>;
4649
+ scalar_metrics?: Array<ScalarMetric>;
4650
+ timeseries_metrics?: Array<TimeseriesMetric>;
4651
+ });
4652
+ export type SetJobProgressData = {
4653
+ id: string;
4654
+ /**
4655
+ * parameters for statistics retrieval
4656
+ */
4657
+ requestBody: {
4658
+ percent?: number;
4659
+ flow_job_id?: string;
4660
+ };
4661
+ workspace: string;
4662
+ };
4663
+ export type SetJobProgressResponse = (unknown);
4664
+ export type GetJobProgressData = {
4665
+ id: string;
4666
+ workspace: string;
4667
+ };
4668
+ export type GetJobProgressResponse = (number);
4669
+ export type ListLogFilesData = {
4670
+ /**
4671
+ * filter on created after (exclusive) timestamp
4672
+ */
4673
+ after?: string;
4674
+ /**
4675
+ * filter on started before (inclusive) timestamp
4676
+ */
4677
+ before?: string;
4678
+ withError?: boolean;
4679
+ };
4680
+ export type ListLogFilesResponse = (Array<{
4681
+ hostname: string;
4682
+ mode: string;
4683
+ worker_group?: string;
4684
+ log_ts: string;
4685
+ file_path: string;
4686
+ ok_lines?: number;
4687
+ err_lines?: number;
4688
+ json_fmt: boolean;
4689
+ }>);
4690
+ export type GetLogFileData = {
4691
+ path: string;
4692
+ };
4693
+ export type GetLogFileResponse = (string);
4694
+ export type ListConcurrencyGroupsResponse = (Array<ConcurrencyGroup>);
4695
+ export type DeleteConcurrencyGroupData = {
4696
+ concurrencyId: string;
4697
+ };
4698
+ export type DeleteConcurrencyGroupResponse = ({
4699
+ [key: string]: unknown;
4700
+ });
4701
+ export type GetConcurrencyKeyData = {
4702
+ id: string;
4703
+ };
4704
+ export type GetConcurrencyKeyResponse = (string);
4705
+ export type ListExtendedJobsData = {
4706
+ /**
4707
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
4708
+ */
4709
+ allWorkspaces?: boolean;
4710
+ /**
4711
+ * filter on jobs containing those args as a json subset (@> in postgres)
4712
+ */
4713
+ args?: string;
4714
+ concurrencyKey?: string;
4715
+ /**
4716
+ * mask to filter exact matching user creator
4717
+ */
4718
+ createdBy?: string;
4719
+ /**
4720
+ * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
4721
+ */
4722
+ createdOrStartedAfter?: string;
4723
+ /**
4724
+ * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp but only for the completed jobs
4725
+ */
4726
+ createdOrStartedAfterCompletedJobs?: string;
4727
+ /**
4728
+ * filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
4729
+ */
4730
+ createdOrStartedBefore?: string;
4731
+ /**
4732
+ * has null parent
4733
+ */
4734
+ hasNullParent?: boolean;
4735
+ /**
4736
+ * is the job a flow step
4737
+ */
4738
+ isFlowStep?: boolean;
4739
+ /**
4740
+ * is not a scheduled job
4741
+ */
4742
+ isNotSchedule?: boolean;
4743
+ /**
4744
+ * is the job skipped
4745
+ */
4746
+ isSkipped?: boolean;
4747
+ /**
4748
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
4749
+ */
4750
+ jobKinds?: string;
4751
+ /**
4752
+ * mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
4753
+ */
4754
+ label?: string;
4755
+ /**
4756
+ * which page to return (start at 1, default 1)
4757
+ */
4758
+ page?: number;
4759
+ /**
4760
+ * The parent job that is at the origin and responsible for the execution of this script if any
4761
+ */
4762
+ parentJob?: string;
4763
+ /**
4764
+ * number of items to return for a given page (default 30, max 100)
4765
+ */
4766
+ perPage?: number;
4767
+ /**
4768
+ * filter on jobs containing those result as a json subset (@> in postgres)
4769
+ */
4770
+ result?: string;
4771
+ rowLimit?: number;
4772
+ /**
4773
+ * filter on running jobs
4774
+ */
4775
+ running?: boolean;
4776
+ /**
4777
+ * filter on jobs scheduled_for before now (hence waitinf for a worker)
4778
+ */
4779
+ scheduledForBeforeNow?: boolean;
4780
+ /**
4781
+ * mask to filter by schedule path
4782
+ */
4783
+ schedulePath?: string;
4784
+ /**
4785
+ * mask to filter exact matching path
4786
+ */
4787
+ scriptHash?: string;
4788
+ /**
4789
+ * mask to filter exact matching path
4790
+ */
4791
+ scriptPathExact?: string;
4792
+ /**
4793
+ * mask to filter matching starting path
4794
+ */
4795
+ scriptPathStart?: string;
4796
+ /**
4797
+ * filter on started after (exclusive) timestamp
4798
+ */
4799
+ startedAfter?: string;
4800
+ /**
4801
+ * filter on started before (inclusive) timestamp
4802
+ */
4803
+ startedBefore?: string;
4804
+ /**
4805
+ * filter on successful jobs
4806
+ */
4807
+ success?: boolean;
4808
+ /**
4809
+ * filter on jobs with a given tag/worker group
4810
+ */
4811
+ tag?: string;
4812
+ workspace: string;
4813
+ };
4814
+ export type ListExtendedJobsResponse = (ExtendedJobs);
4815
+ export type SearchJobsIndexData = {
4816
+ searchQuery: string;
4817
+ workspace: string;
4818
+ };
4819
+ export type SearchJobsIndexResponse = ({
4820
+ /**
4821
+ * a list of the terms that couldn't be parsed (and thus ignored)
4822
+ */
4823
+ query_parse_errors?: Array<{
4824
+ dancer?: string;
4825
+ }>;
4826
+ /**
4827
+ * the jobs that matched the query
4828
+ */
4829
+ hits?: Array<JobSearchHit>;
4830
+ });
4831
+ //# sourceMappingURL=types.gen.d.ts.map