windmill-client 1.311.0 → 1.313.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,1927 +2,3059 @@ import type { CancelablePromise } from './core/CancelablePromise';
2
2
  import type { $OpenApiTs } from './types.gen';
3
3
  export declare class SettingsService {
4
4
  /**
5
- * get backend version
6
- * @returns string git version of backend
7
- * @throws ApiError
8
- */
5
+ * get backend version
6
+ * @returns string git version of backend
7
+ * @throws ApiError
8
+ */
9
9
  static backendVersion(): CancelablePromise<$OpenApiTs['/version']['get']['res'][200]>;
10
10
  /**
11
- * is backend up to date
12
- * @returns string is backend up to date
13
- * @throws ApiError
14
- */
11
+ * is backend up to date
12
+ * @returns string is backend up to date
13
+ * @throws ApiError
14
+ */
15
15
  static backendUptodate(): CancelablePromise<$OpenApiTs['/uptodate']['get']['res'][200]>;
16
16
  /**
17
- * get license id
18
- * @returns string get license id (empty if not ee)
19
- * @throws ApiError
20
- */
17
+ * get license id
18
+ * @returns string get license id (empty if not ee)
19
+ * @throws ApiError
20
+ */
21
21
  static getLicenseId(): CancelablePromise<$OpenApiTs['/ee_license']['get']['res'][200]>;
22
22
  /**
23
- * get openapi yaml spec
24
- * @returns string openapi yaml file content
25
- * @throws ApiError
26
- */
23
+ * get openapi yaml spec
24
+ * @returns string openapi yaml file content
25
+ * @throws ApiError
26
+ */
27
27
  static getOpenApiYaml(): CancelablePromise<$OpenApiTs['/openapi.yaml']['get']['res'][200]>;
28
28
  }
29
29
  export declare class AuditService {
30
30
  /**
31
- * get audit log (requires admin privilege)
32
- * @returns AuditLog an audit log
33
- * @throws ApiError
34
- */
31
+ * get audit log (requires admin privilege)
32
+ * @param data The data for the request.
33
+ * @param data.workspace
34
+ * @param data.id
35
+ * @returns AuditLog an audit log
36
+ * @throws ApiError
37
+ */
35
38
  static getAuditLog(data: $OpenApiTs['/w/{workspace}/audit/get/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/audit/get/{id}']['get']['res'][200]>;
36
39
  /**
37
- * list audit logs (requires admin privilege)
38
- * @returns AuditLog a list of audit logs
39
- * @throws ApiError
40
- */
40
+ * list audit logs (requires admin privilege)
41
+ * @param data The data for the request.
42
+ * @param data.workspace
43
+ * @param data.page which page to return (start at 1, default 1)
44
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
45
+ * @param data.before filter on created before (exclusive) timestamp
46
+ * @param data.after filter on created after (exclusive) timestamp
47
+ * @param data.username filter on exact username of user
48
+ * @param data.operation filter on exact or prefix name of operation
49
+ * @param data.resource filter on exact or prefix name of resource
50
+ * @param data.actionKind filter on type of operation
51
+ * @returns AuditLog a list of audit logs
52
+ * @throws ApiError
53
+ */
41
54
  static listAuditLogs(data: $OpenApiTs['/w/{workspace}/audit/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/audit/list']['get']['res'][200]>;
42
55
  }
43
56
  export declare class UserService {
44
57
  /**
45
- * login with password
46
- * @returns string Successfully authenticated. The session ID is returned in a cookie named `token` and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
47
- *
48
- * @throws ApiError
49
- */
58
+ * login with password
59
+ * @param data The data for the request.
60
+ * @param data.requestBody credentials
61
+ * @returns string Successfully authenticated. The session ID is returned in a cookie named `token` and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
62
+ *
63
+ * @throws ApiError
64
+ */
50
65
  static login(data: $OpenApiTs['/auth/login']['post']['req']): CancelablePromise<$OpenApiTs['/auth/login']['post']['res'][200]>;
51
66
  /**
52
- * logout
53
- * @returns string clear cookies and clear token (if applicable)
54
- * @throws ApiError
55
- */
67
+ * logout
68
+ * @returns string clear cookies and clear token (if applicable)
69
+ * @throws ApiError
70
+ */
56
71
  static logout(): CancelablePromise<$OpenApiTs['/auth/logout']['post']['res'][200]>;
57
72
  /**
58
- * get user (require admin privilege)
59
- * @returns User user created
60
- * @throws ApiError
61
- */
73
+ * get user (require admin privilege)
74
+ * @param data The data for the request.
75
+ * @param data.workspace
76
+ * @param data.username
77
+ * @returns User user created
78
+ * @throws ApiError
79
+ */
62
80
  static getUser(data: $OpenApiTs['/w/{workspace}/users/{username}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/{username}']['get']['res'][200]>;
63
81
  /**
64
- * update user (require admin privilege)
65
- * @returns string edited user
66
- * @throws ApiError
67
- */
82
+ * update user (require admin privilege)
83
+ * @param data The data for the request.
84
+ * @param data.workspace
85
+ * @param data.username
86
+ * @param data.requestBody new user
87
+ * @returns string edited user
88
+ * @throws ApiError
89
+ */
68
90
  static updateUser(data: $OpenApiTs['/w/{workspace}/users/update/{username}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/update/{username}']['post']['res'][200]>;
69
91
  /**
70
- * is owner of path
71
- * @returns boolean is owner
72
- * @throws ApiError
73
- */
92
+ * is owner of path
93
+ * @param data The data for the request.
94
+ * @param data.workspace
95
+ * @param data.path
96
+ * @returns boolean is owner
97
+ * @throws ApiError
98
+ */
74
99
  static isOwnerOfPath(data: $OpenApiTs['/w/{workspace}/users/is_owner/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/is_owner/{path}']['get']['res'][200]>;
75
100
  /**
76
- * set password
77
- * @returns string password set
78
- * @throws ApiError
79
- */
101
+ * set password
102
+ * @param data The data for the request.
103
+ * @param data.requestBody set password
104
+ * @returns string password set
105
+ * @throws ApiError
106
+ */
80
107
  static setPassword(data: $OpenApiTs['/users/setpassword']['post']['req']): CancelablePromise<$OpenApiTs['/users/setpassword']['post']['res'][200]>;
81
108
  /**
82
- * create user
83
- * @returns string user created
84
- * @throws ApiError
85
- */
109
+ * create user
110
+ * @param data The data for the request.
111
+ * @param data.requestBody user info
112
+ * @returns string user created
113
+ * @throws ApiError
114
+ */
86
115
  static createUserGlobally(data: $OpenApiTs['/users/create']['post']['req']): CancelablePromise<$OpenApiTs['/users/create']['post']['res'][201]>;
87
116
  /**
88
- * global update user (require super admin)
89
- * @returns string user updated
90
- * @throws ApiError
91
- */
117
+ * global update user (require super admin)
118
+ * @param data The data for the request.
119
+ * @param data.email
120
+ * @param data.requestBody new user info
121
+ * @returns string user updated
122
+ * @throws ApiError
123
+ */
92
124
  static globalUserUpdate(data: $OpenApiTs['/users/update/{email}']['post']['req']): CancelablePromise<$OpenApiTs['/users/update/{email}']['post']['res'][200]>;
93
125
  /**
94
- * global username info (require super admin)
95
- * @returns unknown user renamed
96
- * @throws ApiError
97
- */
126
+ * global username info (require super admin)
127
+ * @param data The data for the request.
128
+ * @param data.email
129
+ * @returns unknown user renamed
130
+ * @throws ApiError
131
+ */
98
132
  static globalUsernameInfo(data: $OpenApiTs['/users/username_info/{email}']['get']['req']): CancelablePromise<$OpenApiTs['/users/username_info/{email}']['get']['res'][200]>;
99
133
  /**
100
- * global rename user (require super admin)
101
- * @returns string user renamed
102
- * @throws ApiError
103
- */
134
+ * global rename user (require super admin)
135
+ * @param data The data for the request.
136
+ * @param data.email
137
+ * @param data.requestBody new username
138
+ * @returns string user renamed
139
+ * @throws ApiError
140
+ */
104
141
  static globalUserRename(data: $OpenApiTs['/users/rename/{email}']['post']['req']): CancelablePromise<$OpenApiTs['/users/rename/{email}']['post']['res'][200]>;
105
142
  /**
106
- * global delete user (require super admin)
107
- * @returns string user deleted
108
- * @throws ApiError
109
- */
143
+ * global delete user (require super admin)
144
+ * @param data The data for the request.
145
+ * @param data.email
146
+ * @returns string user deleted
147
+ * @throws ApiError
148
+ */
110
149
  static globalUserDelete(data: $OpenApiTs['/users/delete/{email}']['delete']['req']): CancelablePromise<$OpenApiTs['/users/delete/{email}']['delete']['res'][200]>;
111
150
  /**
112
- * delete user (require admin privilege)
113
- * @returns string delete user
114
- * @throws ApiError
115
- */
151
+ * delete user (require admin privilege)
152
+ * @param data The data for the request.
153
+ * @param data.workspace
154
+ * @param data.username
155
+ * @returns string delete user
156
+ * @throws ApiError
157
+ */
116
158
  static deleteUser(data: $OpenApiTs['/w/{workspace}/users/delete/{username}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/delete/{username}']['delete']['res'][200]>;
117
159
  /**
118
- * get current user email (if logged in)
119
- * @returns string user email
120
- * @throws ApiError
121
- */
160
+ * get current user email (if logged in)
161
+ * @returns string user email
162
+ * @throws ApiError
163
+ */
122
164
  static getCurrentEmail(): CancelablePromise<$OpenApiTs['/users/email']['get']['res'][200]>;
123
165
  /**
124
- * refresh the current token
125
- * @returns string free usage
126
- * @throws ApiError
127
- */
166
+ * refresh the current token
167
+ * @returns string free usage
168
+ * @throws ApiError
169
+ */
128
170
  static refreshUserToken(): CancelablePromise<$OpenApiTs['/users/refresh_token']['get']['res'][200]>;
129
171
  /**
130
- * get tutorial progress
131
- * @returns unknown tutorial progress
132
- * @throws ApiError
133
- */
172
+ * get tutorial progress
173
+ * @returns unknown tutorial progress
174
+ * @throws ApiError
175
+ */
134
176
  static getTutorialProgress(): CancelablePromise<$OpenApiTs['/users/tutorial_progress']['get']['res'][200]>;
135
177
  /**
136
- * update tutorial progress
137
- * @returns string tutorial progress
138
- * @throws ApiError
139
- */
178
+ * update tutorial progress
179
+ * @param data The data for the request.
180
+ * @param data.requestBody progress update
181
+ * @returns string tutorial progress
182
+ * @throws ApiError
183
+ */
140
184
  static updateTutorialProgress(data: $OpenApiTs['/users/tutorial_progress']['post']['req']): CancelablePromise<$OpenApiTs['/users/tutorial_progress']['post']['res'][200]>;
141
185
  /**
142
- * leave instance
143
- * @returns string status
144
- * @throws ApiError
145
- */
186
+ * leave instance
187
+ * @returns string status
188
+ * @throws ApiError
189
+ */
146
190
  static leaveInstance(): CancelablePromise<$OpenApiTs['/users/leave_instance']['post']['res'][200]>;
147
191
  /**
148
- * get current usage outside of premium workspaces
149
- * @returns number free usage
150
- * @throws ApiError
151
- */
192
+ * get current usage outside of premium workspaces
193
+ * @returns number free usage
194
+ * @throws ApiError
195
+ */
152
196
  static getUsage(): CancelablePromise<$OpenApiTs['/users/usage']['get']['res'][200]>;
153
197
  /**
154
- * get all runnables in every workspace
155
- * @returns unknown free all runnables
156
- * @throws ApiError
157
- */
198
+ * get all runnables in every workspace
199
+ * @returns unknown free all runnables
200
+ * @throws ApiError
201
+ */
158
202
  static getRunnable(): CancelablePromise<$OpenApiTs['/users/all_runnables']['get']['res'][200]>;
159
203
  /**
160
- * get current global whoami (if logged in)
161
- * @returns GlobalUserInfo user email
162
- * @throws ApiError
163
- */
204
+ * get current global whoami (if logged in)
205
+ * @returns GlobalUserInfo user email
206
+ * @throws ApiError
207
+ */
164
208
  static globalWhoami(): CancelablePromise<$OpenApiTs['/users/whoami']['get']['res'][200]>;
165
209
  /**
166
- * list all workspace invites
167
- * @returns WorkspaceInvite list all workspace invites
168
- * @throws ApiError
169
- */
210
+ * list all workspace invites
211
+ * @returns WorkspaceInvite list all workspace invites
212
+ * @throws ApiError
213
+ */
170
214
  static listWorkspaceInvites(): CancelablePromise<$OpenApiTs['/users/list_invites']['get']['res'][200]>;
171
215
  /**
172
- * whoami
173
- * @returns User user
174
- * @throws ApiError
175
- */
216
+ * whoami
217
+ * @param data The data for the request.
218
+ * @param data.workspace
219
+ * @returns User user
220
+ * @throws ApiError
221
+ */
176
222
  static whoami(data: $OpenApiTs['/w/{workspace}/users/whoami']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/whoami']['get']['res'][200]>;
177
223
  /**
178
- * accept invite to workspace
179
- * @returns string status
180
- * @throws ApiError
181
- */
224
+ * accept invite to workspace
225
+ * @param data The data for the request.
226
+ * @param data.requestBody accept invite
227
+ * @returns string status
228
+ * @throws ApiError
229
+ */
182
230
  static acceptInvite(data: $OpenApiTs['/users/accept_invite']['post']['req']): CancelablePromise<$OpenApiTs['/users/accept_invite']['post']['res'][200]>;
183
231
  /**
184
- * decline invite to workspace
185
- * @returns string status
186
- * @throws ApiError
187
- */
232
+ * decline invite to workspace
233
+ * @param data The data for the request.
234
+ * @param data.requestBody decline invite
235
+ * @returns string status
236
+ * @throws ApiError
237
+ */
188
238
  static declineInvite(data: $OpenApiTs['/users/decline_invite']['post']['req']): CancelablePromise<$OpenApiTs['/users/decline_invite']['post']['res'][200]>;
189
239
  /**
190
- * whois
191
- * @returns User user
192
- * @throws ApiError
193
- */
240
+ * whois
241
+ * @param data The data for the request.
242
+ * @param data.workspace
243
+ * @param data.username
244
+ * @returns User user
245
+ * @throws ApiError
246
+ */
194
247
  static whois(data: $OpenApiTs['/w/{workspace}/users/whois/{username}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/whois/{username}']['get']['res'][200]>;
195
248
  /**
196
- * exists email
197
- * @returns boolean user
198
- * @throws ApiError
199
- */
249
+ * exists email
250
+ * @param data The data for the request.
251
+ * @param data.email
252
+ * @returns boolean user
253
+ * @throws ApiError
254
+ */
200
255
  static existsEmail(data: $OpenApiTs['/users/exists/{email}']['get']['req']): CancelablePromise<$OpenApiTs['/users/exists/{email}']['get']['res'][200]>;
201
256
  /**
202
- * list all users as super admin (require to be super amdin)
203
- * @returns GlobalUserInfo user
204
- * @throws ApiError
205
- */
257
+ * list all users as super admin (require to be super amdin)
258
+ * @param data The data for the request.
259
+ * @param data.page which page to return (start at 1, default 1)
260
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
261
+ * @returns GlobalUserInfo user
262
+ * @throws ApiError
263
+ */
206
264
  static listUsersAsSuperAdmin(data?: $OpenApiTs['/users/list_as_super_admin']['get']['req']): CancelablePromise<$OpenApiTs['/users/list_as_super_admin']['get']['res'][200]>;
207
265
  /**
208
- * list users
209
- * @returns User user
210
- * @throws ApiError
211
- */
266
+ * list users
267
+ * @param data The data for the request.
268
+ * @param data.workspace
269
+ * @returns User user
270
+ * @throws ApiError
271
+ */
212
272
  static listUsers(data: $OpenApiTs['/w/{workspace}/users/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/list']['get']['res'][200]>;
213
273
  /**
214
- * list users usage
215
- * @returns UserUsage user
216
- * @throws ApiError
217
- */
274
+ * list users usage
275
+ * @param data The data for the request.
276
+ * @param data.workspace
277
+ * @returns UserUsage user
278
+ * @throws ApiError
279
+ */
218
280
  static listUsersUsage(data: $OpenApiTs['/w/{workspace}/users/list_usage']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/list_usage']['get']['res'][200]>;
219
281
  /**
220
- * list usernames
221
- * @returns string user
222
- * @throws ApiError
223
- */
282
+ * list usernames
283
+ * @param data The data for the request.
284
+ * @param data.workspace
285
+ * @returns string user
286
+ * @throws ApiError
287
+ */
224
288
  static listUsernames(data: $OpenApiTs['/w/{workspace}/users/list_usernames']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/list_usernames']['get']['res'][200]>;
225
289
  /**
226
- * create token
227
- * @returns string token created
228
- * @throws ApiError
229
- */
290
+ * create token
291
+ * @param data The data for the request.
292
+ * @param data.requestBody new token
293
+ * @returns string token created
294
+ * @throws ApiError
295
+ */
230
296
  static createToken(data: $OpenApiTs['/users/tokens/create']['post']['req']): CancelablePromise<$OpenApiTs['/users/tokens/create']['post']['res'][201]>;
231
297
  /**
232
- * create token to impersonate a user (require superadmin)
233
- * @returns string token created
234
- * @throws ApiError
235
- */
298
+ * create token to impersonate a user (require superadmin)
299
+ * @param data The data for the request.
300
+ * @param data.requestBody new token
301
+ * @returns string token created
302
+ * @throws ApiError
303
+ */
236
304
  static createTokenImpersonate(data: $OpenApiTs['/users/tokens/impersonate']['post']['req']): CancelablePromise<$OpenApiTs['/users/tokens/impersonate']['post']['res'][201]>;
237
305
  /**
238
- * delete token
239
- * @returns string delete token
240
- * @throws ApiError
241
- */
306
+ * delete token
307
+ * @param data The data for the request.
308
+ * @param data.tokenPrefix
309
+ * @returns string delete token
310
+ * @throws ApiError
311
+ */
242
312
  static deleteToken(data: $OpenApiTs['/users/tokens/delete/{token_prefix}']['delete']['req']): CancelablePromise<$OpenApiTs['/users/tokens/delete/{token_prefix}']['delete']['res'][200]>;
243
313
  /**
244
- * list token
245
- * @returns TruncatedToken truncated token
246
- * @throws ApiError
247
- */
314
+ * list token
315
+ * @param data The data for the request.
316
+ * @param data.excludeEphemeral
317
+ * @returns TruncatedToken truncated token
318
+ * @throws ApiError
319
+ */
248
320
  static listTokens(data?: $OpenApiTs['/users/tokens/list']['get']['req']): CancelablePromise<$OpenApiTs['/users/tokens/list']['get']['res'][200]>;
249
321
  /**
250
- * login with oauth authorization flow
251
- * @returns string Successfully authenticated. The session ID is returned in a cookie named `token` and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
252
- *
253
- * @throws ApiError
254
- */
322
+ * login with oauth authorization flow
323
+ * @param data The data for the request.
324
+ * @param data.clientName
325
+ * @param data.requestBody Partially filled script
326
+ * @returns string Successfully authenticated. The session ID is returned in a cookie named `token` and as plaintext response. Preferred method of authorization is through the bearer token. The cookie is only for browser convenience.
327
+ *
328
+ * @throws ApiError
329
+ */
255
330
  static loginWithOauth(data: $OpenApiTs['/oauth/login_callback/{client_name}']['post']['req']): CancelablePromise<$OpenApiTs['/oauth/login_callback/{client_name}']['post']['res'][200]>;
256
331
  }
257
332
  export declare class AdminService {
258
333
  /**
259
- * get user (require admin privilege)
260
- * @returns User user created
261
- * @throws ApiError
262
- */
334
+ * get user (require admin privilege)
335
+ * @param data The data for the request.
336
+ * @param data.workspace
337
+ * @param data.username
338
+ * @returns User user created
339
+ * @throws ApiError
340
+ */
263
341
  static getUser(data: $OpenApiTs['/w/{workspace}/users/{username}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/{username}']['get']['res'][200]>;
264
342
  /**
265
- * update user (require admin privilege)
266
- * @returns string edited user
267
- * @throws ApiError
268
- */
343
+ * update user (require admin privilege)
344
+ * @param data The data for the request.
345
+ * @param data.workspace
346
+ * @param data.username
347
+ * @param data.requestBody new user
348
+ * @returns string edited user
349
+ * @throws ApiError
350
+ */
269
351
  static updateUser(data: $OpenApiTs['/w/{workspace}/users/update/{username}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/update/{username}']['post']['res'][200]>;
270
352
  /**
271
- * delete user (require admin privilege)
272
- * @returns string delete user
273
- * @throws ApiError
274
- */
353
+ * delete user (require admin privilege)
354
+ * @param data The data for the request.
355
+ * @param data.workspace
356
+ * @param data.username
357
+ * @returns string delete user
358
+ * @throws ApiError
359
+ */
275
360
  static deleteUser(data: $OpenApiTs['/w/{workspace}/users/delete/{username}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/users/delete/{username}']['delete']['res'][200]>;
276
361
  }
277
362
  export declare class WorkspaceService {
278
363
  /**
279
- * list all workspaces visible to me
280
- * @returns Workspace all workspaces
281
- * @throws ApiError
282
- */
364
+ * list all workspaces visible to me
365
+ * @returns Workspace all workspaces
366
+ * @throws ApiError
367
+ */
283
368
  static listWorkspaces(): CancelablePromise<$OpenApiTs['/workspaces/list']['get']['res'][200]>;
284
369
  /**
285
- * is domain allowed for auto invi
286
- * @returns boolean domain allowed or not
287
- * @throws ApiError
288
- */
370
+ * is domain allowed for auto invi
371
+ * @returns boolean domain allowed or not
372
+ * @throws ApiError
373
+ */
289
374
  static isDomainAllowed(): CancelablePromise<$OpenApiTs['/workspaces/allowed_domain_auto_invite']['get']['res'][200]>;
290
375
  /**
291
- * list all workspaces visible to me with user info
292
- * @returns UserWorkspaceList workspace with associated username
293
- * @throws ApiError
294
- */
376
+ * list all workspaces visible to me with user info
377
+ * @returns UserWorkspaceList workspace with associated username
378
+ * @throws ApiError
379
+ */
295
380
  static listUserWorkspaces(): CancelablePromise<$OpenApiTs['/workspaces/users']['get']['res'][200]>;
296
381
  /**
297
- * list all workspaces as super admin (require to be super admin)
298
- * @returns Workspace workspaces
299
- * @throws ApiError
300
- */
382
+ * list all workspaces as super admin (require to be super admin)
383
+ * @param data The data for the request.
384
+ * @param data.page which page to return (start at 1, default 1)
385
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
386
+ * @returns Workspace workspaces
387
+ * @throws ApiError
388
+ */
301
389
  static listWorkspacesAsSuperAdmin(data?: $OpenApiTs['/workspaces/list_as_superadmin']['get']['req']): CancelablePromise<$OpenApiTs['/workspaces/list_as_superadmin']['get']['res'][200]>;
302
390
  /**
303
- * create workspace
304
- * @returns string token created
305
- * @throws ApiError
306
- */
391
+ * create workspace
392
+ * @param data The data for the request.
393
+ * @param data.requestBody new token
394
+ * @returns string token created
395
+ * @throws ApiError
396
+ */
307
397
  static createWorkspace(data: $OpenApiTs['/workspaces/create']['post']['req']): CancelablePromise<$OpenApiTs['/workspaces/create']['post']['res'][201]>;
308
398
  /**
309
- * exists workspace
310
- * @returns boolean status
311
- * @throws ApiError
312
- */
399
+ * exists workspace
400
+ * @param data The data for the request.
401
+ * @param data.requestBody id of workspace
402
+ * @returns boolean status
403
+ * @throws ApiError
404
+ */
313
405
  static existsWorkspace(data: $OpenApiTs['/workspaces/exists']['post']['req']): CancelablePromise<$OpenApiTs['/workspaces/exists']['post']['res'][200]>;
314
406
  /**
315
- * exists username
316
- * @returns boolean status
317
- * @throws ApiError
318
- */
407
+ * exists username
408
+ * @param data The data for the request.
409
+ * @param data.requestBody
410
+ * @returns boolean status
411
+ * @throws ApiError
412
+ */
319
413
  static existsUsername(data: $OpenApiTs['/workspaces/exists_username']['post']['req']): CancelablePromise<$OpenApiTs['/workspaces/exists_username']['post']['res'][200]>;
320
414
  /**
321
- * invite user to workspace
322
- * @returns string status
323
- * @throws ApiError
324
- */
415
+ * invite user to workspace
416
+ * @param data The data for the request.
417
+ * @param data.workspace
418
+ * @param data.requestBody WorkspaceInvite
419
+ * @returns string status
420
+ * @throws ApiError
421
+ */
325
422
  static inviteUser(data: $OpenApiTs['/w/{workspace}/workspaces/invite_user']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/invite_user']['post']['res'][200]>;
326
423
  /**
327
- * add user to workspace
328
- * @returns string status
329
- * @throws ApiError
330
- */
424
+ * add user to workspace
425
+ * @param data The data for the request.
426
+ * @param data.workspace
427
+ * @param data.requestBody WorkspaceInvite
428
+ * @returns string status
429
+ * @throws ApiError
430
+ */
331
431
  static addUser(data: $OpenApiTs['/w/{workspace}/workspaces/add_user']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/add_user']['post']['res'][200]>;
332
432
  /**
333
- * delete user invite
334
- * @returns string status
335
- * @throws ApiError
336
- */
433
+ * delete user invite
434
+ * @param data The data for the request.
435
+ * @param data.workspace
436
+ * @param data.requestBody WorkspaceInvite
437
+ * @returns string status
438
+ * @throws ApiError
439
+ */
337
440
  static deleteInvite(data: $OpenApiTs['/w/{workspace}/workspaces/delete_invite']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/delete_invite']['post']['res'][200]>;
338
441
  /**
339
- * archive workspace
340
- * @returns string status
341
- * @throws ApiError
342
- */
442
+ * archive workspace
443
+ * @param data The data for the request.
444
+ * @param data.workspace
445
+ * @returns string status
446
+ * @throws ApiError
447
+ */
343
448
  static archiveWorkspace(data: $OpenApiTs['/w/{workspace}/workspaces/archive']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/archive']['post']['res'][200]>;
344
449
  /**
345
- * unarchive workspace
346
- * @returns string status
347
- * @throws ApiError
348
- */
450
+ * unarchive workspace
451
+ * @param data The data for the request.
452
+ * @param data.workspace
453
+ * @returns string status
454
+ * @throws ApiError
455
+ */
349
456
  static unarchiveWorkspace(data: $OpenApiTs['/workspaces/unarchive/{workspace}']['post']['req']): CancelablePromise<$OpenApiTs['/workspaces/unarchive/{workspace}']['post']['res'][200]>;
350
457
  /**
351
- * delete workspace (require super admin)
352
- * @returns string status
353
- * @throws ApiError
354
- */
458
+ * delete workspace (require super admin)
459
+ * @param data The data for the request.
460
+ * @param data.workspace
461
+ * @returns string status
462
+ * @throws ApiError
463
+ */
355
464
  static deleteWorkspace(data: $OpenApiTs['/workspaces/delete/{workspace}']['delete']['req']): CancelablePromise<$OpenApiTs['/workspaces/delete/{workspace}']['delete']['res'][200]>;
356
465
  /**
357
- * leave workspace
358
- * @returns string status
359
- * @throws ApiError
360
- */
466
+ * leave workspace
467
+ * @param data The data for the request.
468
+ * @param data.workspace
469
+ * @returns string status
470
+ * @throws ApiError
471
+ */
361
472
  static leaveWorkspace(data: $OpenApiTs['/w/{workspace}/workspaces/leave']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/leave']['post']['res'][200]>;
362
473
  /**
363
- * get workspace name
364
- * @returns string status
365
- * @throws ApiError
366
- */
474
+ * get workspace name
475
+ * @param data The data for the request.
476
+ * @param data.workspace
477
+ * @returns string status
478
+ * @throws ApiError
479
+ */
367
480
  static getWorkspaceName(data: $OpenApiTs['/w/{workspace}/workspaces/get_workspace_name']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/get_workspace_name']['get']['res'][200]>;
368
481
  /**
369
- * change workspace name
370
- * @returns string status
371
- * @throws ApiError
372
- */
482
+ * change workspace name
483
+ * @param data The data for the request.
484
+ * @param data.workspace
485
+ * @param data.requestBody
486
+ * @returns string status
487
+ * @throws ApiError
488
+ */
373
489
  static changeWorkspaceName(data: $OpenApiTs['/w/{workspace}/workspaces/change_workspace_name']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/change_workspace_name']['post']['res'][200]>;
374
490
  /**
375
- * change workspace id
376
- * @returns string status
377
- * @throws ApiError
378
- */
491
+ * change workspace id
492
+ * @param data The data for the request.
493
+ * @param data.workspace
494
+ * @param data.requestBody
495
+ * @returns string status
496
+ * @throws ApiError
497
+ */
379
498
  static changeWorkspaceId(data: $OpenApiTs['/w/{workspace}/workspaces/change_workspace_id']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/change_workspace_id']['post']['res'][200]>;
380
499
  /**
381
- * list pending invites for a workspace
382
- * @returns WorkspaceInvite user
383
- * @throws ApiError
384
- */
500
+ * list pending invites for a workspace
501
+ * @param data The data for the request.
502
+ * @param data.workspace
503
+ * @returns WorkspaceInvite user
504
+ * @throws ApiError
505
+ */
385
506
  static listPendingInvites(data: $OpenApiTs['/w/{workspace}/workspaces/list_pending_invites']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/list_pending_invites']['get']['res'][200]>;
386
507
  /**
387
- * get settings
388
- * @returns unknown status
389
- * @throws ApiError
390
- */
508
+ * get settings
509
+ * @param data The data for the request.
510
+ * @param data.workspace
511
+ * @returns unknown status
512
+ * @throws ApiError
513
+ */
391
514
  static getSettings(data: $OpenApiTs['/w/{workspace}/workspaces/get_settings']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/get_settings']['get']['res'][200]>;
392
515
  /**
393
- * get deploy to
394
- * @returns unknown status
395
- * @throws ApiError
396
- */
516
+ * get deploy to
517
+ * @param data The data for the request.
518
+ * @param data.workspace
519
+ * @returns unknown status
520
+ * @throws ApiError
521
+ */
397
522
  static getDeployTo(data: $OpenApiTs['/w/{workspace}/workspaces/get_deploy_to']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/get_deploy_to']['get']['res'][200]>;
398
523
  /**
399
- * get if workspace is premium
400
- * @returns boolean status
401
- * @throws ApiError
402
- */
524
+ * get if workspace is premium
525
+ * @param data The data for the request.
526
+ * @param data.workspace
527
+ * @returns boolean status
528
+ * @throws ApiError
529
+ */
403
530
  static getIsPremium(data: $OpenApiTs['/w/{workspace}/workspaces/is_premium']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/is_premium']['get']['res'][200]>;
404
531
  /**
405
- * get premium info
406
- * @returns unknown status
407
- * @throws ApiError
408
- */
532
+ * get premium info
533
+ * @param data The data for the request.
534
+ * @param data.workspace
535
+ * @returns unknown status
536
+ * @throws ApiError
537
+ */
409
538
  static getPremiumInfo(data: $OpenApiTs['/w/{workspace}/workspaces/premium_info']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/premium_info']['get']['res'][200]>;
410
539
  /**
411
- * set automatic billing
412
- * @returns string status
413
- * @throws ApiError
414
- */
540
+ * set automatic billing
541
+ * @param data The data for the request.
542
+ * @param data.workspace
543
+ * @param data.requestBody automatic billing
544
+ * @returns string status
545
+ * @throws ApiError
546
+ */
415
547
  static setAutomaticBilling(data: $OpenApiTs['/w/{workspace}/workspaces/set_automatic_billing']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/set_automatic_billing']['post']['res'][200]>;
416
548
  /**
417
- * edit slack command
418
- * @returns string status
419
- * @throws ApiError
420
- */
549
+ * edit slack command
550
+ * @param data The data for the request.
551
+ * @param data.workspace
552
+ * @param data.requestBody WorkspaceInvite
553
+ * @returns string status
554
+ * @throws ApiError
555
+ */
421
556
  static editSlackCommand(data: $OpenApiTs['/w/{workspace}/workspaces/edit_slack_command']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_slack_command']['post']['res'][200]>;
422
557
  /**
423
- * run a job that sends a message to Slack
424
- * @returns unknown status
425
- * @throws ApiError
426
- */
558
+ * run a job that sends a message to Slack
559
+ * @param data The data for the request.
560
+ * @param data.workspace
561
+ * @param data.requestBody path to hub script to run and its corresponding args
562
+ * @returns unknown status
563
+ * @throws ApiError
564
+ */
427
565
  static runSlackMessageTestJob(data: $OpenApiTs['/w/{workspace}/workspaces/run_slack_message_test_job']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/run_slack_message_test_job']['post']['res'][200]>;
428
566
  /**
429
- * edit deploy to
430
- * @returns string status
431
- * @throws ApiError
432
- */
567
+ * edit deploy to
568
+ * @param data The data for the request.
569
+ * @param data.workspace
570
+ * @param data.requestBody
571
+ * @returns string status
572
+ * @throws ApiError
573
+ */
433
574
  static editDeployTo(data: $OpenApiTs['/w/{workspace}/workspaces/edit_deploy_to']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_deploy_to']['post']['res'][200]>;
434
575
  /**
435
- * edit auto invite
436
- * @returns string status
437
- * @throws ApiError
438
- */
576
+ * edit auto invite
577
+ * @param data The data for the request.
578
+ * @param data.workspace
579
+ * @param data.requestBody WorkspaceInvite
580
+ * @returns string status
581
+ * @throws ApiError
582
+ */
439
583
  static editAutoInvite(data: $OpenApiTs['/w/{workspace}/workspaces/edit_auto_invite']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_auto_invite']['post']['res'][200]>;
440
584
  /**
441
- * edit webhook
442
- * @returns string status
443
- * @throws ApiError
444
- */
585
+ * edit webhook
586
+ * @param data The data for the request.
587
+ * @param data.workspace
588
+ * @param data.requestBody WorkspaceWebhook
589
+ * @returns string status
590
+ * @throws ApiError
591
+ */
445
592
  static editWebhook(data: $OpenApiTs['/w/{workspace}/workspaces/edit_webhook']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_webhook']['post']['res'][200]>;
446
593
  /**
447
- * edit copilot config
448
- * @returns string status
449
- * @throws ApiError
450
- */
594
+ * edit copilot config
595
+ * @param data The data for the request.
596
+ * @param data.workspace
597
+ * @param data.requestBody WorkspaceCopilotConfig
598
+ * @returns string status
599
+ * @throws ApiError
600
+ */
451
601
  static editCopilotConfig(data: $OpenApiTs['/w/{workspace}/workspaces/edit_copilot_config']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_copilot_config']['post']['res'][200]>;
452
602
  /**
453
- * get copilot info
454
- * @returns unknown status
455
- * @throws ApiError
456
- */
603
+ * get copilot info
604
+ * @param data The data for the request.
605
+ * @param data.workspace
606
+ * @returns unknown status
607
+ * @throws ApiError
608
+ */
457
609
  static getCopilotInfo(data: $OpenApiTs['/w/{workspace}/workspaces/get_copilot_info']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/get_copilot_info']['get']['res'][200]>;
458
610
  /**
459
- * edit error handler
460
- * @returns string status
461
- * @throws ApiError
462
- */
611
+ * edit error handler
612
+ * @param data The data for the request.
613
+ * @param data.workspace
614
+ * @param data.requestBody WorkspaceErrorHandler
615
+ * @returns string status
616
+ * @throws ApiError
617
+ */
463
618
  static editErrorHandler(data: $OpenApiTs['/w/{workspace}/workspaces/edit_error_handler']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_error_handler']['post']['res'][200]>;
464
619
  /**
465
- * edit large file storage settings
466
- * @returns unknown status
467
- * @throws ApiError
468
- */
620
+ * edit large file storage settings
621
+ * @param data The data for the request.
622
+ * @param data.workspace
623
+ * @param data.requestBody LargeFileStorage info
624
+ * @returns unknown status
625
+ * @throws ApiError
626
+ */
469
627
  static editLargeFileStorageConfig(data: $OpenApiTs['/w/{workspace}/workspaces/edit_large_file_storage_config']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_large_file_storage_config']['post']['res'][200]>;
470
628
  /**
471
- * edit workspace git sync settings
472
- * @returns unknown status
473
- * @throws ApiError
474
- */
629
+ * edit workspace git sync settings
630
+ * @param data The data for the request.
631
+ * @param data.workspace
632
+ * @param data.requestBody Workspace Git sync settings
633
+ * @returns unknown status
634
+ * @throws ApiError
635
+ */
475
636
  static editWorkspaceGitSyncConfig(data: $OpenApiTs['/w/{workspace}/workspaces/edit_git_sync_config']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_git_sync_config']['post']['res'][200]>;
476
637
  /**
477
- * edit default app for workspace
478
- * @returns string status
479
- * @throws ApiError
480
- */
638
+ * edit default app for workspace
639
+ * @param data The data for the request.
640
+ * @param data.workspace
641
+ * @param data.requestBody Workspace default app
642
+ * @returns string status
643
+ * @throws ApiError
644
+ */
481
645
  static editWorkspaceDefaultApp(data: $OpenApiTs['/w/{workspace}/workspaces/edit_default_app']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/edit_default_app']['post']['res'][200]>;
482
646
  /**
483
- * edit default scripts for workspace
484
- * @returns string status
485
- * @throws ApiError
486
- */
647
+ * edit default scripts for workspace
648
+ * @param data The data for the request.
649
+ * @param data.workspace
650
+ * @param data.requestBody Workspace default app
651
+ * @returns string status
652
+ * @throws ApiError
653
+ */
487
654
  static editDefaultScripts(data: $OpenApiTs['/w/{workspace}/workspaces/default_scripts']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/default_scripts']['post']['res'][200]>;
488
655
  /**
489
- * get default scripts for workspace
490
- * @returns WorkspaceDefaultScripts status
491
- * @throws ApiError
492
- */
656
+ * get default scripts for workspace
657
+ * @param data The data for the request.
658
+ * @param data.workspace
659
+ * @returns WorkspaceDefaultScripts status
660
+ * @throws ApiError
661
+ */
493
662
  static getDefaultScripts(data: $OpenApiTs['/w/{workspace}/workspaces/default_scripts']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/default_scripts']['get']['res'][200]>;
494
663
  /**
495
- * set environment variable
496
- * @returns string status
497
- * @throws ApiError
498
- */
664
+ * set environment variable
665
+ * @param data The data for the request.
666
+ * @param data.workspace
667
+ * @param data.requestBody Workspace default app
668
+ * @returns string status
669
+ * @throws ApiError
670
+ */
499
671
  static setEnvironmentVariable(data: $OpenApiTs['/w/{workspace}/workspaces/set_environment_variable']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/set_environment_variable']['post']['res'][200]>;
500
672
  /**
501
- * retrieves the encryption key for this workspace
502
- * @returns unknown status
503
- * @throws ApiError
504
- */
673
+ * retrieves the encryption key for this workspace
674
+ * @param data The data for the request.
675
+ * @param data.workspace
676
+ * @returns unknown status
677
+ * @throws ApiError
678
+ */
505
679
  static getWorkspaceEncryptionKey(data: $OpenApiTs['/w/{workspace}/workspaces/encryption_key']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/encryption_key']['get']['res'][200]>;
506
680
  /**
507
- * update the encryption key for this workspace
508
- * @returns string status
509
- * @throws ApiError
510
- */
681
+ * update the encryption key for this workspace
682
+ * @param data The data for the request.
683
+ * @param data.workspace
684
+ * @param data.requestBody New encryption key
685
+ * @returns string status
686
+ * @throws ApiError
687
+ */
511
688
  static setWorkspaceEncryptionKey(data: $OpenApiTs['/w/{workspace}/workspaces/encryption_key']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/encryption_key']['post']['res'][200]>;
512
689
  /**
513
- * get default app for workspace
514
- * @returns unknown status
515
- * @throws ApiError
516
- */
690
+ * get default app for workspace
691
+ * @param data The data for the request.
692
+ * @param data.workspace
693
+ * @returns unknown status
694
+ * @throws ApiError
695
+ */
517
696
  static getWorkspaceDefaultApp(data: $OpenApiTs['/w/{workspace}/workspaces/default_app']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/default_app']['get']['res'][200]>;
518
697
  /**
519
- * get large file storage config
520
- * @returns LargeFileStorage status
521
- * @throws ApiError
522
- */
698
+ * get large file storage config
699
+ * @param data The data for the request.
700
+ * @param data.workspace
701
+ * @returns LargeFileStorage status
702
+ * @throws ApiError
703
+ */
523
704
  static getLargeFileStorageConfig(data: $OpenApiTs['/w/{workspace}/workspaces/get_large_file_storage_config']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/get_large_file_storage_config']['get']['res'][200]>;
524
705
  /**
525
- * get usage
526
- * @returns number usage
527
- * @throws ApiError
528
- */
706
+ * get usage
707
+ * @param data The data for the request.
708
+ * @param data.workspace
709
+ * @returns number usage
710
+ * @throws ApiError
711
+ */
529
712
  static getWorkspaceUsage(data: $OpenApiTs['/w/{workspace}/workspaces/usage']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/workspaces/usage']['get']['res'][200]>;
530
713
  }
531
714
  export declare class SettingService {
532
715
  /**
533
- * get global settings
534
- * @returns unknown status
535
- * @throws ApiError
536
- */
716
+ * get global settings
717
+ * @param data The data for the request.
718
+ * @param data.key
719
+ * @returns unknown status
720
+ * @throws ApiError
721
+ */
537
722
  static getGlobal(data: $OpenApiTs['/settings/global/{key}']['get']['req']): CancelablePromise<$OpenApiTs['/settings/global/{key}']['get']['res'][200]>;
538
723
  /**
539
- * post global settings
540
- * @returns string status
541
- * @throws ApiError
542
- */
724
+ * post global settings
725
+ * @param data The data for the request.
726
+ * @param data.key
727
+ * @param data.requestBody value set
728
+ * @returns string status
729
+ * @throws ApiError
730
+ */
543
731
  static setGlobal(data: $OpenApiTs['/settings/global/{key}']['post']['req']): CancelablePromise<$OpenApiTs['/settings/global/{key}']['post']['res'][200]>;
544
732
  /**
545
- * get local settings
546
- * @returns unknown status
547
- * @throws ApiError
548
- */
733
+ * get local settings
734
+ * @returns unknown status
735
+ * @throws ApiError
736
+ */
549
737
  static getLocal(): CancelablePromise<$OpenApiTs['/settings/local']['get']['res'][200]>;
550
738
  /**
551
- * test smtp
552
- * @returns string status
553
- * @throws ApiError
554
- */
739
+ * test smtp
740
+ * @param data The data for the request.
741
+ * @param data.requestBody test smtp payload
742
+ * @returns string status
743
+ * @throws ApiError
744
+ */
555
745
  static testSmtp(data: $OpenApiTs['/settings/test_smtp']['post']['req']): CancelablePromise<$OpenApiTs['/settings/test_smtp']['post']['res'][200]>;
556
746
  /**
557
- * test license key
558
- * @returns string status
559
- * @throws ApiError
560
- */
747
+ * test license key
748
+ * @param data The data for the request.
749
+ * @param data.requestBody test license key
750
+ * @returns string status
751
+ * @throws ApiError
752
+ */
561
753
  static testLicenseKey(data: $OpenApiTs['/settings/test_license_key']['post']['req']): CancelablePromise<$OpenApiTs['/settings/test_license_key']['post']['res'][200]>;
562
754
  /**
563
- * test object storage config
564
- * @returns string status
565
- * @throws ApiError
566
- */
755
+ * test object storage config
756
+ * @param data The data for the request.
757
+ * @param data.requestBody test object storage config
758
+ * @returns string status
759
+ * @throws ApiError
760
+ */
567
761
  static testObjectStorageConfig(data: $OpenApiTs['/settings/test_object_storage_config']['post']['req']): CancelablePromise<$OpenApiTs['/settings/test_object_storage_config']['post']['res'][200]>;
568
762
  /**
569
- * send stats
570
- * @returns string status
571
- * @throws ApiError
572
- */
763
+ * send stats
764
+ * @returns string status
765
+ * @throws ApiError
766
+ */
573
767
  static sendStats(): CancelablePromise<$OpenApiTs['/settings/send_stats']['post']['res'][200]>;
574
768
  /**
575
- * test metadata
576
- * @returns string status
577
- * @throws ApiError
578
- */
769
+ * test metadata
770
+ * @param data The data for the request.
771
+ * @param data.requestBody test metadata
772
+ * @returns string status
773
+ * @throws ApiError
774
+ */
579
775
  static testMetadata(data: $OpenApiTs['/saml/test_metadata']['post']['req']): CancelablePromise<$OpenApiTs['/saml/test_metadata']['post']['res'][200]>;
580
776
  }
581
777
  export declare class OidcService {
582
778
  /**
583
- * get OIDC token (ee only)
584
- * @returns string new oidc token
585
- * @throws ApiError
586
- */
779
+ * get OIDC token (ee only)
780
+ * @param data The data for the request.
781
+ * @param data.workspace
782
+ * @param data.audience
783
+ * @returns string new oidc token
784
+ * @throws ApiError
785
+ */
587
786
  static getOidcToken(data: $OpenApiTs['/w/{workspace}/oidc/token/{audience}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/oidc/token/{audience}']['post']['res'][200]>;
588
787
  }
589
788
  export declare class VariableService {
590
789
  /**
591
- * create variable
592
- * @returns string variable created
593
- * @throws ApiError
594
- */
790
+ * create variable
791
+ * @param data The data for the request.
792
+ * @param data.workspace
793
+ * @param data.requestBody new variable
794
+ * @param data.alreadyEncrypted
795
+ * @returns string variable created
796
+ * @throws ApiError
797
+ */
595
798
  static createVariable(data: $OpenApiTs['/w/{workspace}/variables/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/create']['post']['res'][201]>;
596
799
  /**
597
- * encrypt value
598
- * @returns string encrypted value
599
- * @throws ApiError
600
- */
800
+ * encrypt value
801
+ * @param data The data for the request.
802
+ * @param data.workspace
803
+ * @param data.requestBody new variable
804
+ * @returns string encrypted value
805
+ * @throws ApiError
806
+ */
601
807
  static encryptValue(data: $OpenApiTs['/w/{workspace}/variables/encrypt']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/encrypt']['post']['res'][200]>;
602
808
  /**
603
- * delete variable
604
- * @returns string variable deleted
605
- * @throws ApiError
606
- */
809
+ * delete variable
810
+ * @param data The data for the request.
811
+ * @param data.workspace
812
+ * @param data.path
813
+ * @returns string variable deleted
814
+ * @throws ApiError
815
+ */
607
816
  static deleteVariable(data: $OpenApiTs['/w/{workspace}/variables/delete/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/delete/{path}']['delete']['res'][200]>;
608
817
  /**
609
- * update variable
610
- * @returns string variable updated
611
- * @throws ApiError
612
- */
818
+ * update variable
819
+ * @param data The data for the request.
820
+ * @param data.workspace
821
+ * @param data.path
822
+ * @param data.requestBody updated variable
823
+ * @param data.alreadyEncrypted
824
+ * @returns string variable updated
825
+ * @throws ApiError
826
+ */
613
827
  static updateVariable(data: $OpenApiTs['/w/{workspace}/variables/update/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/update/{path}']['post']['res'][200]>;
614
828
  /**
615
- * get variable
616
- * @returns ListableVariable variable
617
- * @throws ApiError
618
- */
829
+ * get variable
830
+ * @param data The data for the request.
831
+ * @param data.workspace
832
+ * @param data.path
833
+ * @param data.decryptSecret ask to decrypt secret if this variable is secret
834
+ * (if not secret no effect, default: true)
835
+ *
836
+ * @param data.includeEncrypted ask to include the encrypted value if secret and decrypt secret is not true (default: false)
837
+ *
838
+ * @returns ListableVariable variable
839
+ * @throws ApiError
840
+ */
619
841
  static getVariable(data: $OpenApiTs['/w/{workspace}/variables/get/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/get/{path}']['get']['res'][200]>;
620
842
  /**
621
- * get variable value
622
- * @returns string variable
623
- * @throws ApiError
624
- */
843
+ * get variable value
844
+ * @param data The data for the request.
845
+ * @param data.workspace
846
+ * @param data.path
847
+ * @returns string variable
848
+ * @throws ApiError
849
+ */
625
850
  static getVariableValue(data: $OpenApiTs['/w/{workspace}/variables/get_value/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/get_value/{path}']['get']['res'][200]>;
626
851
  /**
627
- * does variable exists at path
628
- * @returns boolean variable
629
- * @throws ApiError
630
- */
852
+ * does variable exists at path
853
+ * @param data The data for the request.
854
+ * @param data.workspace
855
+ * @param data.path
856
+ * @returns boolean variable
857
+ * @throws ApiError
858
+ */
631
859
  static existsVariable(data: $OpenApiTs['/w/{workspace}/variables/exists/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/exists/{path}']['get']['res'][200]>;
632
860
  /**
633
- * list variables
634
- * @returns ListableVariable variable list
635
- * @throws ApiError
636
- */
861
+ * list variables
862
+ * @param data The data for the request.
863
+ * @param data.workspace
864
+ * @returns ListableVariable variable list
865
+ * @throws ApiError
866
+ */
637
867
  static listVariable(data: $OpenApiTs['/w/{workspace}/variables/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/list']['get']['res'][200]>;
638
868
  /**
639
- * list contextual variables
640
- * @returns ContextualVariable contextual variable list
641
- * @throws ApiError
642
- */
869
+ * list contextual variables
870
+ * @param data The data for the request.
871
+ * @param data.workspace
872
+ * @returns ContextualVariable contextual variable list
873
+ * @throws ApiError
874
+ */
643
875
  static listContextualVariables(data: $OpenApiTs['/w/{workspace}/variables/list_contextual']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/variables/list_contextual']['get']['res'][200]>;
644
876
  }
645
877
  export declare class OauthService {
646
878
  /**
647
- * connect slack callback
648
- * @returns string slack token
649
- * @throws ApiError
650
- */
879
+ * connect slack callback
880
+ * @param data The data for the request.
881
+ * @param data.workspace
882
+ * @param data.requestBody code endpoint
883
+ * @returns string slack token
884
+ * @throws ApiError
885
+ */
651
886
  static connectSlackCallback(data: $OpenApiTs['/w/{workspace}/oauth/connect_slack_callback']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/oauth/connect_slack_callback']['post']['res'][200]>;
652
887
  /**
653
- * connect callback
654
- * @returns TokenResponse oauth token
655
- * @throws ApiError
656
- */
888
+ * connect callback
889
+ * @param data The data for the request.
890
+ * @param data.clientName
891
+ * @param data.requestBody code endpoint
892
+ * @returns TokenResponse oauth token
893
+ * @throws ApiError
894
+ */
657
895
  static connectCallback(data: $OpenApiTs['/oauth/connect_callback/{client_name}']['post']['req']): CancelablePromise<$OpenApiTs['/oauth/connect_callback/{client_name}']['post']['res'][200]>;
658
896
  /**
659
- * create OAuth account
660
- * @returns string account set
661
- * @throws ApiError
662
- */
897
+ * create OAuth account
898
+ * @param data The data for the request.
899
+ * @param data.workspace
900
+ * @param data.requestBody code endpoint
901
+ * @returns string account set
902
+ * @throws ApiError
903
+ */
663
904
  static createAccount(data: $OpenApiTs['/w/{workspace}/oauth/create_account']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/oauth/create_account']['post']['res'][200]>;
664
905
  /**
665
- * refresh token
666
- * @returns string token refreshed
667
- * @throws ApiError
668
- */
906
+ * refresh token
907
+ * @param data The data for the request.
908
+ * @param data.workspace
909
+ * @param data.id
910
+ * @param data.requestBody variable path
911
+ * @returns string token refreshed
912
+ * @throws ApiError
913
+ */
669
914
  static refreshToken(data: $OpenApiTs['/w/{workspace}/oauth/refresh_token/{id}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/oauth/refresh_token/{id}']['post']['res'][200]>;
670
915
  /**
671
- * disconnect account
672
- * @returns string disconnected client
673
- * @throws ApiError
674
- */
916
+ * disconnect account
917
+ * @param data The data for the request.
918
+ * @param data.workspace
919
+ * @param data.id
920
+ * @returns string disconnected client
921
+ * @throws ApiError
922
+ */
675
923
  static disconnectAccount(data: $OpenApiTs['/w/{workspace}/oauth/disconnect/{id}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/oauth/disconnect/{id}']['post']['res'][200]>;
676
924
  /**
677
- * disconnect slack
678
- * @returns string disconnected slack
679
- * @throws ApiError
680
- */
925
+ * disconnect slack
926
+ * @param data The data for the request.
927
+ * @param data.workspace
928
+ * @returns string disconnected slack
929
+ * @throws ApiError
930
+ */
681
931
  static disconnectSlack(data: $OpenApiTs['/w/{workspace}/oauth/disconnect_slack']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/oauth/disconnect_slack']['post']['res'][200]>;
682
932
  /**
683
- * list oauth logins
684
- * @returns unknown list of oauth and saml login clients
685
- * @throws ApiError
686
- */
933
+ * list oauth logins
934
+ * @returns unknown list of oauth and saml login clients
935
+ * @throws ApiError
936
+ */
687
937
  static listOauthLogins(): CancelablePromise<$OpenApiTs['/oauth/list_logins']['get']['res'][200]>;
688
938
  /**
689
- * list oauth connects
690
- * @returns unknown list of oauth connects clients
691
- * @throws ApiError
692
- */
939
+ * list oauth connects
940
+ * @returns unknown list of oauth connects clients
941
+ * @throws ApiError
942
+ */
693
943
  static listOauthConnects(): CancelablePromise<$OpenApiTs['/oauth/list_connects']['get']['res'][200]>;
694
944
  }
695
945
  export declare class ResourceService {
696
946
  /**
697
- * create resource
698
- * @returns string resource created
699
- * @throws ApiError
700
- */
947
+ * create resource
948
+ * @param data The data for the request.
949
+ * @param data.workspace
950
+ * @param data.requestBody new resource
951
+ * @param data.updateIfExists
952
+ * @returns string resource created
953
+ * @throws ApiError
954
+ */
701
955
  static createResource(data: $OpenApiTs['/w/{workspace}/resources/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/create']['post']['res'][201]>;
702
956
  /**
703
- * delete resource
704
- * @returns string resource deleted
705
- * @throws ApiError
706
- */
957
+ * delete resource
958
+ * @param data The data for the request.
959
+ * @param data.workspace
960
+ * @param data.path
961
+ * @returns string resource deleted
962
+ * @throws ApiError
963
+ */
707
964
  static deleteResource(data: $OpenApiTs['/w/{workspace}/resources/delete/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/delete/{path}']['delete']['res'][200]>;
708
965
  /**
709
- * update resource
710
- * @returns string resource updated
711
- * @throws ApiError
712
- */
966
+ * update resource
967
+ * @param data The data for the request.
968
+ * @param data.workspace
969
+ * @param data.path
970
+ * @param data.requestBody updated resource
971
+ * @returns string resource updated
972
+ * @throws ApiError
973
+ */
713
974
  static updateResource(data: $OpenApiTs['/w/{workspace}/resources/update/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/update/{path}']['post']['res'][200]>;
714
975
  /**
715
- * update resource value
716
- * @returns string resource value updated
717
- * @throws ApiError
718
- */
976
+ * update resource value
977
+ * @param data The data for the request.
978
+ * @param data.workspace
979
+ * @param data.path
980
+ * @param data.requestBody updated resource
981
+ * @returns string resource value updated
982
+ * @throws ApiError
983
+ */
719
984
  static updateResourceValue(data: $OpenApiTs['/w/{workspace}/resources/update_value/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/update_value/{path}']['post']['res'][200]>;
720
985
  /**
721
- * get resource
722
- * @returns Resource resource
723
- * @throws ApiError
724
- */
986
+ * get resource
987
+ * @param data The data for the request.
988
+ * @param data.workspace
989
+ * @param data.path
990
+ * @returns Resource resource
991
+ * @throws ApiError
992
+ */
725
993
  static getResource(data: $OpenApiTs['/w/{workspace}/resources/get/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/get/{path}']['get']['res'][200]>;
726
994
  /**
727
- * get resource interpolated (variables and resources are fully unrolled)
728
- * @returns unknown resource value
729
- * @throws ApiError
730
- */
995
+ * get resource interpolated (variables and resources are fully unrolled)
996
+ * @param data The data for the request.
997
+ * @param data.workspace
998
+ * @param data.path
999
+ * @param data.jobId job id
1000
+ * @returns unknown resource value
1001
+ * @throws ApiError
1002
+ */
731
1003
  static getResourceValueInterpolated(data: $OpenApiTs['/w/{workspace}/resources/get_value_interpolated/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/get_value_interpolated/{path}']['get']['res'][200]>;
732
1004
  /**
733
- * get resource value
734
- * @returns unknown resource value
735
- * @throws ApiError
736
- */
1005
+ * get resource value
1006
+ * @param data The data for the request.
1007
+ * @param data.workspace
1008
+ * @param data.path
1009
+ * @returns unknown resource value
1010
+ * @throws ApiError
1011
+ */
737
1012
  static getResourceValue(data: $OpenApiTs['/w/{workspace}/resources/get_value/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/get_value/{path}']['get']['res'][200]>;
738
1013
  /**
739
- * does resource exists
740
- * @returns boolean does resource exists
741
- * @throws ApiError
742
- */
1014
+ * does resource exists
1015
+ * @param data The data for the request.
1016
+ * @param data.workspace
1017
+ * @param data.path
1018
+ * @returns boolean does resource exists
1019
+ * @throws ApiError
1020
+ */
743
1021
  static existsResource(data: $OpenApiTs['/w/{workspace}/resources/exists/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/exists/{path}']['get']['res'][200]>;
744
1022
  /**
745
- * list resources
746
- * @returns ListableResource resource list
747
- * @throws ApiError
748
- */
1023
+ * list resources
1024
+ * @param data The data for the request.
1025
+ * @param data.workspace
1026
+ * @param data.page which page to return (start at 1, default 1)
1027
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
1028
+ * @param data.resourceType resource_types to list from, separated by ',',
1029
+ * @param data.resourceTypeExclude resource_types to not list from, separated by ',',
1030
+ * @returns ListableResource resource list
1031
+ * @throws ApiError
1032
+ */
749
1033
  static listResource(data: $OpenApiTs['/w/{workspace}/resources/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/list']['get']['res'][200]>;
750
1034
  /**
751
- * list resources for search
752
- * @returns unknown resource list
753
- * @throws ApiError
754
- */
1035
+ * list resources for search
1036
+ * @param data The data for the request.
1037
+ * @param data.workspace
1038
+ * @returns unknown resource list
1039
+ * @throws ApiError
1040
+ */
755
1041
  static listSearchResource(data: $OpenApiTs['/w/{workspace}/resources/list_search']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/list_search']['get']['res'][200]>;
756
1042
  /**
757
- * list resource names
758
- * @returns unknown resource list names
759
- * @throws ApiError
760
- */
1043
+ * list resource names
1044
+ * @param data The data for the request.
1045
+ * @param data.workspace
1046
+ * @param data.name
1047
+ * @returns unknown resource list names
1048
+ * @throws ApiError
1049
+ */
761
1050
  static listResourceNames(data: $OpenApiTs['/w/{workspace}/resources/list_names/{name}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/list_names/{name}']['get']['res'][200]>;
762
1051
  /**
763
- * create resource_type
764
- * @returns string resource_type created
765
- * @throws ApiError
766
- */
1052
+ * create resource_type
1053
+ * @param data The data for the request.
1054
+ * @param data.workspace
1055
+ * @param data.requestBody new resource_type
1056
+ * @returns string resource_type created
1057
+ * @throws ApiError
1058
+ */
767
1059
  static createResourceType(data: $OpenApiTs['/w/{workspace}/resources/type/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/type/create']['post']['res'][201]>;
768
1060
  /**
769
- * delete resource_type
770
- * @returns string resource_type deleted
771
- * @throws ApiError
772
- */
1061
+ * delete resource_type
1062
+ * @param data The data for the request.
1063
+ * @param data.workspace
1064
+ * @param data.path
1065
+ * @returns string resource_type deleted
1066
+ * @throws ApiError
1067
+ */
773
1068
  static deleteResourceType(data: $OpenApiTs['/w/{workspace}/resources/type/delete/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/type/delete/{path}']['delete']['res'][200]>;
774
1069
  /**
775
- * update resource_type
776
- * @returns string resource_type updated
777
- * @throws ApiError
778
- */
1070
+ * update resource_type
1071
+ * @param data The data for the request.
1072
+ * @param data.workspace
1073
+ * @param data.path
1074
+ * @param data.requestBody updated resource_type
1075
+ * @returns string resource_type updated
1076
+ * @throws ApiError
1077
+ */
779
1078
  static updateResourceType(data: $OpenApiTs['/w/{workspace}/resources/type/update/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/type/update/{path}']['post']['res'][200]>;
780
1079
  /**
781
- * get resource_type
782
- * @returns ResourceType resource_type deleted
783
- * @throws ApiError
784
- */
1080
+ * get resource_type
1081
+ * @param data The data for the request.
1082
+ * @param data.workspace
1083
+ * @param data.path
1084
+ * @returns ResourceType resource_type deleted
1085
+ * @throws ApiError
1086
+ */
785
1087
  static getResourceType(data: $OpenApiTs['/w/{workspace}/resources/type/get/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/type/get/{path}']['get']['res'][200]>;
786
1088
  /**
787
- * does resource_type exists
788
- * @returns boolean does resource_type exist
789
- * @throws ApiError
790
- */
1089
+ * does resource_type exists
1090
+ * @param data The data for the request.
1091
+ * @param data.workspace
1092
+ * @param data.path
1093
+ * @returns boolean does resource_type exist
1094
+ * @throws ApiError
1095
+ */
791
1096
  static existsResourceType(data: $OpenApiTs['/w/{workspace}/resources/type/exists/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/type/exists/{path}']['get']['res'][200]>;
792
1097
  /**
793
- * list resource_types
794
- * @returns ResourceType resource_type list
795
- * @throws ApiError
796
- */
1098
+ * list resource_types
1099
+ * @param data The data for the request.
1100
+ * @param data.workspace
1101
+ * @returns ResourceType resource_type list
1102
+ * @throws ApiError
1103
+ */
797
1104
  static listResourceType(data: $OpenApiTs['/w/{workspace}/resources/type/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/type/list']['get']['res'][200]>;
798
1105
  /**
799
- * list resource_types names
800
- * @returns string resource_type list
801
- * @throws ApiError
802
- */
1106
+ * list resource_types names
1107
+ * @param data The data for the request.
1108
+ * @param data.workspace
1109
+ * @returns string resource_type list
1110
+ * @throws ApiError
1111
+ */
803
1112
  static listResourceTypeNames(data: $OpenApiTs['/w/{workspace}/resources/type/listnames']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/resources/type/listnames']['get']['res'][200]>;
804
1113
  /**
805
- * query resource types by similarity
806
- * @returns unknown resource type details
807
- * @throws ApiError
808
- */
1114
+ * query resource types by similarity
1115
+ * @param data The data for the request.
1116
+ * @param data.workspace
1117
+ * @param data.text query text
1118
+ * @param data.limit query limit
1119
+ * @returns unknown resource type details
1120
+ * @throws ApiError
1121
+ */
809
1122
  static queryResourceTypes(data: $OpenApiTs['/w/{workspace}/embeddings/query_resource_types']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/embeddings/query_resource_types']['get']['res'][200]>;
810
1123
  }
811
1124
  export declare class IntegrationService {
812
1125
  /**
813
- * list hub integrations
814
- * @returns unknown integrations details
815
- * @throws ApiError
816
- */
1126
+ * list hub integrations
1127
+ * @param data The data for the request.
1128
+ * @param data.kind query integrations kind
1129
+ * @returns unknown integrations details
1130
+ * @throws ApiError
1131
+ */
817
1132
  static listHubIntegrations(data?: $OpenApiTs['/integrations/hub/list']['get']['req']): CancelablePromise<$OpenApiTs['/integrations/hub/list']['get']['res'][200]>;
818
1133
  }
819
1134
  export declare class FlowService {
820
1135
  /**
821
- * list all hub flows
822
- * @returns unknown hub flows list
823
- * @throws ApiError
824
- */
1136
+ * list all hub flows
1137
+ * @returns unknown hub flows list
1138
+ * @throws ApiError
1139
+ */
825
1140
  static listHubFlows(): CancelablePromise<$OpenApiTs['/flows/hub/list']['get']['res'][200]>;
826
1141
  /**
827
- * get hub flow by id
828
- * @returns unknown flow
829
- * @throws ApiError
830
- */
1142
+ * get hub flow by id
1143
+ * @param data The data for the request.
1144
+ * @param data.id
1145
+ * @returns unknown flow
1146
+ * @throws ApiError
1147
+ */
831
1148
  static getHubFlowById(data: $OpenApiTs['/flows/hub/get/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/flows/hub/get/{id}']['get']['res'][200]>;
832
1149
  /**
833
- * list all flow paths
834
- * @returns string list of flow paths
835
- * @throws ApiError
836
- */
1150
+ * list all flow paths
1151
+ * @param data The data for the request.
1152
+ * @param data.workspace
1153
+ * @returns string list of flow paths
1154
+ * @throws ApiError
1155
+ */
837
1156
  static listFlowPaths(data: $OpenApiTs['/w/{workspace}/flows/list_paths']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/list_paths']['get']['res'][200]>;
838
1157
  /**
839
- * list flows for search
840
- * @returns unknown flow list
841
- * @throws ApiError
842
- */
1158
+ * list flows for search
1159
+ * @param data The data for the request.
1160
+ * @param data.workspace
1161
+ * @returns unknown flow list
1162
+ * @throws ApiError
1163
+ */
843
1164
  static listSearchFlow(data: $OpenApiTs['/w/{workspace}/flows/list_search']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/list_search']['get']['res'][200]>;
844
1165
  /**
845
- * list all flows
846
- * @returns unknown All flow
847
- * @throws ApiError
848
- */
1166
+ * list all flows
1167
+ * @param data The data for the request.
1168
+ * @param data.workspace
1169
+ * @param data.page which page to return (start at 1, default 1)
1170
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
1171
+ * @param data.orderDesc order by desc order (default true)
1172
+ * @param data.createdBy mask to filter exact matching user creator
1173
+ * @param data.pathStart mask to filter matching starting path
1174
+ * @param data.pathExact mask to filter exact matching path
1175
+ * @param data.showArchived (default false)
1176
+ * show also the archived files.
1177
+ * when multiple archived hash share the same path, only the ones with the latest create_at
1178
+ * are displayed.
1179
+ *
1180
+ * @param data.starredOnly (default false)
1181
+ * show only the starred items
1182
+ *
1183
+ * @returns unknown All flow
1184
+ * @throws ApiError
1185
+ */
849
1186
  static listFlows(data: $OpenApiTs['/w/{workspace}/flows/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/list']['get']['res'][200]>;
850
1187
  /**
851
- * get flow by path
852
- * @returns Flow flow details
853
- * @throws ApiError
854
- */
1188
+ * get flow by path
1189
+ * @param data The data for the request.
1190
+ * @param data.workspace
1191
+ * @param data.path
1192
+ * @returns Flow flow details
1193
+ * @throws ApiError
1194
+ */
855
1195
  static getFlowByPath(data: $OpenApiTs['/w/{workspace}/flows/get/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/get/{path}']['get']['res'][200]>;
856
1196
  /**
857
- * Toggle ON and OFF the workspace error handler for a given flow
858
- * @returns string error handler toggled
859
- * @throws ApiError
860
- */
1197
+ * Toggle ON and OFF the workspace error handler for a given flow
1198
+ * @param data The data for the request.
1199
+ * @param data.workspace
1200
+ * @param data.path
1201
+ * @param data.requestBody Workspace error handler enabled
1202
+ * @returns string error handler toggled
1203
+ * @throws ApiError
1204
+ */
861
1205
  static toggleWorkspaceErrorHandlerForFlow(data: $OpenApiTs['/w/{workspace}/flows/toggle_workspace_error_handler/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/toggle_workspace_error_handler/{path}']['post']['res'][200]>;
862
1206
  /**
863
- * get flow by path with draft
864
- * @returns unknown flow details with draft
865
- * @throws ApiError
866
- */
1207
+ * get flow by path with draft
1208
+ * @param data The data for the request.
1209
+ * @param data.workspace
1210
+ * @param data.path
1211
+ * @returns unknown flow details with draft
1212
+ * @throws ApiError
1213
+ */
867
1214
  static getFlowByPathWithDraft(data: $OpenApiTs['/w/{workspace}/flows/get/draft/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/get/draft/{path}']['get']['res'][200]>;
868
1215
  /**
869
- * exists flow by path
870
- * @returns boolean flow details
871
- * @throws ApiError
872
- */
1216
+ * exists flow by path
1217
+ * @param data The data for the request.
1218
+ * @param data.workspace
1219
+ * @param data.path
1220
+ * @returns boolean flow details
1221
+ * @throws ApiError
1222
+ */
873
1223
  static existsFlowByPath(data: $OpenApiTs['/w/{workspace}/flows/exists/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/exists/{path}']['get']['res'][200]>;
874
1224
  /**
875
- * create flow
876
- * @returns string flow created
877
- * @throws ApiError
878
- */
1225
+ * create flow
1226
+ * @param data The data for the request.
1227
+ * @param data.workspace
1228
+ * @param data.requestBody Partially filled flow
1229
+ * @returns string flow created
1230
+ * @throws ApiError
1231
+ */
879
1232
  static createFlow(data: $OpenApiTs['/w/{workspace}/flows/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/create']['post']['res'][201]>;
880
1233
  /**
881
- * update flow
882
- * @returns string flow updated
883
- * @throws ApiError
884
- */
1234
+ * update flow
1235
+ * @param data The data for the request.
1236
+ * @param data.workspace
1237
+ * @param data.path
1238
+ * @param data.requestBody Partially filled flow
1239
+ * @returns string flow updated
1240
+ * @throws ApiError
1241
+ */
885
1242
  static updateFlow(data: $OpenApiTs['/w/{workspace}/flows/update/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/update/{path}']['post']['res'][200]>;
886
1243
  /**
887
- * archive flow by path
888
- * @returns string flow archived
889
- * @throws ApiError
890
- */
1244
+ * archive flow by path
1245
+ * @param data The data for the request.
1246
+ * @param data.workspace
1247
+ * @param data.path
1248
+ * @param data.requestBody archiveFlow
1249
+ * @returns string flow archived
1250
+ * @throws ApiError
1251
+ */
891
1252
  static archiveFlowByPath(data: $OpenApiTs['/w/{workspace}/flows/archive/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/archive/{path}']['post']['res'][200]>;
892
1253
  /**
893
- * delete flow by path
894
- * @returns string flow delete
895
- * @throws ApiError
896
- */
1254
+ * delete flow by path
1255
+ * @param data The data for the request.
1256
+ * @param data.workspace
1257
+ * @param data.path
1258
+ * @returns string flow delete
1259
+ * @throws ApiError
1260
+ */
897
1261
  static deleteFlowByPath(data: $OpenApiTs['/w/{workspace}/flows/delete/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/delete/{path}']['delete']['res'][200]>;
898
1262
  /**
899
- * list inputs for previous completed flow jobs
900
- * @returns Input input history for completed jobs with this flow path
901
- * @throws ApiError
902
- */
1263
+ * list inputs for previous completed flow jobs
1264
+ * @param data The data for the request.
1265
+ * @param data.workspace
1266
+ * @param data.path
1267
+ * @param data.page which page to return (start at 1, default 1)
1268
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
1269
+ * @returns Input input history for completed jobs with this flow path
1270
+ * @throws ApiError
1271
+ */
903
1272
  static getFlowInputHistoryByPath(data: $OpenApiTs['/w/{workspace}/flows/input_history/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/flows/input_history/p/{path}']['get']['res'][200]>;
904
1273
  }
905
1274
  export declare class AppService {
906
1275
  /**
907
- * list all hub apps
908
- * @returns unknown hub apps list
909
- * @throws ApiError
910
- */
1276
+ * list all hub apps
1277
+ * @returns unknown hub apps list
1278
+ * @throws ApiError
1279
+ */
911
1280
  static listHubApps(): CancelablePromise<$OpenApiTs['/apps/hub/list']['get']['res'][200]>;
912
1281
  /**
913
- * get hub app by id
914
- * @returns unknown app
915
- * @throws ApiError
916
- */
1282
+ * get hub app by id
1283
+ * @param data The data for the request.
1284
+ * @param data.id
1285
+ * @returns unknown app
1286
+ * @throws ApiError
1287
+ */
917
1288
  static getHubAppById(data: $OpenApiTs['/apps/hub/get/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/apps/hub/get/{id}']['get']['res'][200]>;
918
1289
  /**
919
- * list apps for search
920
- * @returns unknown app list
921
- * @throws ApiError
922
- */
1290
+ * list apps for search
1291
+ * @param data The data for the request.
1292
+ * @param data.workspace
1293
+ * @returns unknown app list
1294
+ * @throws ApiError
1295
+ */
923
1296
  static listSearchApp(data: $OpenApiTs['/w/{workspace}/apps/list_search']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/list_search']['get']['res'][200]>;
924
1297
  /**
925
- * list all apps
926
- * @returns ListableApp All apps
927
- * @throws ApiError
928
- */
1298
+ * list all apps
1299
+ * @param data The data for the request.
1300
+ * @param data.workspace
1301
+ * @param data.page which page to return (start at 1, default 1)
1302
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
1303
+ * @param data.orderDesc order by desc order (default true)
1304
+ * @param data.createdBy mask to filter exact matching user creator
1305
+ * @param data.pathStart mask to filter matching starting path
1306
+ * @param data.pathExact mask to filter exact matching path
1307
+ * @param data.starredOnly (default false)
1308
+ * show only the starred items
1309
+ *
1310
+ * @returns ListableApp All apps
1311
+ * @throws ApiError
1312
+ */
929
1313
  static listApps(data: $OpenApiTs['/w/{workspace}/apps/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/list']['get']['res'][200]>;
930
1314
  /**
931
- * create app
932
- * @returns string app created
933
- * @throws ApiError
934
- */
1315
+ * create app
1316
+ * @param data The data for the request.
1317
+ * @param data.workspace
1318
+ * @param data.requestBody new app
1319
+ * @returns string app created
1320
+ * @throws ApiError
1321
+ */
935
1322
  static createApp(data: $OpenApiTs['/w/{workspace}/apps/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/create']['post']['res'][201]>;
936
1323
  /**
937
- * does an app exisst at path
938
- * @returns boolean app exists
939
- * @throws ApiError
940
- */
1324
+ * does an app exisst at path
1325
+ * @param data The data for the request.
1326
+ * @param data.workspace
1327
+ * @param data.path
1328
+ * @returns boolean app exists
1329
+ * @throws ApiError
1330
+ */
941
1331
  static existsApp(data: $OpenApiTs['/w/{workspace}/apps/exists/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/exists/{path}']['get']['res'][200]>;
942
1332
  /**
943
- * get app by path
944
- * @returns AppWithLastVersion app details
945
- * @throws ApiError
946
- */
1333
+ * get app by path
1334
+ * @param data The data for the request.
1335
+ * @param data.workspace
1336
+ * @param data.path
1337
+ * @returns AppWithLastVersion app details
1338
+ * @throws ApiError
1339
+ */
947
1340
  static getAppByPath(data: $OpenApiTs['/w/{workspace}/apps/get/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/get/p/{path}']['get']['res'][200]>;
948
1341
  /**
949
- * get app by path with draft
950
- * @returns AppWithLastVersionWDraft app details with draft
951
- * @throws ApiError
952
- */
1342
+ * get app by path with draft
1343
+ * @param data The data for the request.
1344
+ * @param data.workspace
1345
+ * @param data.path
1346
+ * @returns AppWithLastVersionWDraft app details with draft
1347
+ * @throws ApiError
1348
+ */
953
1349
  static getAppByPathWithDraft(data: $OpenApiTs['/w/{workspace}/apps/get/draft/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/get/draft/{path}']['get']['res'][200]>;
954
1350
  /**
955
- * get app history by path
956
- * @returns AppHistory app history
957
- * @throws ApiError
958
- */
1351
+ * get app history by path
1352
+ * @param data The data for the request.
1353
+ * @param data.workspace
1354
+ * @param data.path
1355
+ * @returns AppHistory app history
1356
+ * @throws ApiError
1357
+ */
959
1358
  static getAppHistoryByPath(data: $OpenApiTs['/w/{workspace}/apps/history/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/history/p/{path}']['get']['res'][200]>;
960
1359
  /**
961
- * update app history
962
- * @returns string success
963
- * @throws ApiError
964
- */
1360
+ * update app history
1361
+ * @param data The data for the request.
1362
+ * @param data.workspace
1363
+ * @param data.id
1364
+ * @param data.version
1365
+ * @param data.requestBody App deployment message
1366
+ * @returns string success
1367
+ * @throws ApiError
1368
+ */
965
1369
  static updateAppHistory(data: $OpenApiTs['/w/{workspace}/apps/history_update/a/{id}/v/{version}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/history_update/a/{id}/v/{version}']['post']['res'][200]>;
966
1370
  /**
967
- * get public app by secret
968
- * @returns AppWithLastVersion app details
969
- * @throws ApiError
970
- */
1371
+ * get public app by secret
1372
+ * @param data The data for the request.
1373
+ * @param data.workspace
1374
+ * @param data.path
1375
+ * @returns AppWithLastVersion app details
1376
+ * @throws ApiError
1377
+ */
971
1378
  static getPublicAppBySecret(data: $OpenApiTs['/w/{workspace}/apps_u/public_app/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps_u/public_app/{path}']['get']['res'][200]>;
972
1379
  /**
973
- * get public resource
974
- * @returns unknown resource value
975
- * @throws ApiError
976
- */
1380
+ * get public resource
1381
+ * @param data The data for the request.
1382
+ * @param data.workspace
1383
+ * @param data.path
1384
+ * @returns unknown resource value
1385
+ * @throws ApiError
1386
+ */
977
1387
  static getPublicResource(data: $OpenApiTs['/w/{workspace}/apps_u/public_resource/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps_u/public_resource/{path}']['get']['res'][200]>;
978
1388
  /**
979
- * get public secret of app
980
- * @returns string app secret
981
- * @throws ApiError
982
- */
1389
+ * get public secret of app
1390
+ * @param data The data for the request.
1391
+ * @param data.workspace
1392
+ * @param data.path
1393
+ * @returns string app secret
1394
+ * @throws ApiError
1395
+ */
983
1396
  static getPublicSecretOfApp(data: $OpenApiTs['/w/{workspace}/apps/secret_of/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/secret_of/{path}']['get']['res'][200]>;
984
1397
  /**
985
- * get app by version
986
- * @returns AppWithLastVersion app details
987
- * @throws ApiError
988
- */
1398
+ * get app by version
1399
+ * @param data The data for the request.
1400
+ * @param data.workspace
1401
+ * @param data.id
1402
+ * @returns AppWithLastVersion app details
1403
+ * @throws ApiError
1404
+ */
989
1405
  static getAppByVersion(data: $OpenApiTs['/w/{workspace}/apps/get/v/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/get/v/{id}']['get']['res'][200]>;
990
1406
  /**
991
- * delete app
992
- * @returns string app deleted
993
- * @throws ApiError
994
- */
1407
+ * delete app
1408
+ * @param data The data for the request.
1409
+ * @param data.workspace
1410
+ * @param data.path
1411
+ * @returns string app deleted
1412
+ * @throws ApiError
1413
+ */
995
1414
  static deleteApp(data: $OpenApiTs['/w/{workspace}/apps/delete/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/delete/{path}']['delete']['res'][200]>;
996
1415
  /**
997
- * update app
998
- * @returns string app updated
999
- * @throws ApiError
1000
- */
1416
+ * update app
1417
+ * @param data The data for the request.
1418
+ * @param data.workspace
1419
+ * @param data.path
1420
+ * @param data.requestBody update app
1421
+ * @returns string app updated
1422
+ * @throws ApiError
1423
+ */
1001
1424
  static updateApp(data: $OpenApiTs['/w/{workspace}/apps/update/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/update/{path}']['post']['res'][200]>;
1002
1425
  /**
1003
- * executeComponent
1004
- * @returns string job uuid
1005
- * @throws ApiError
1006
- */
1426
+ * executeComponent
1427
+ * @param data The data for the request.
1428
+ * @param data.workspace
1429
+ * @param data.path
1430
+ * @param data.requestBody update app
1431
+ * @returns string job uuid
1432
+ * @throws ApiError
1433
+ */
1007
1434
  static executeComponent(data: $OpenApiTs['/w/{workspace}/apps_u/execute_component/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps_u/execute_component/{path}']['post']['res'][200]>;
1008
1435
  }
1009
1436
  export declare class ScriptService {
1010
1437
  /**
1011
- * get hub script content by path
1012
- * @returns string script details
1013
- * @throws ApiError
1014
- */
1438
+ * get hub script content by path
1439
+ * @param data The data for the request.
1440
+ * @param data.path
1441
+ * @returns string script details
1442
+ * @throws ApiError
1443
+ */
1015
1444
  static getHubScriptContentByPath(data: $OpenApiTs['/scripts/hub/get/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/scripts/hub/get/{path}']['get']['res'][200]>;
1016
1445
  /**
1017
- * get full hub script by path
1018
- * @returns unknown script details
1019
- * @throws ApiError
1020
- */
1446
+ * get full hub script by path
1447
+ * @param data The data for the request.
1448
+ * @param data.path
1449
+ * @returns unknown script details
1450
+ * @throws ApiError
1451
+ */
1021
1452
  static getHubScriptByPath(data: $OpenApiTs['/scripts/hub/get_full/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/scripts/hub/get_full/{path}']['get']['res'][200]>;
1022
1453
  /**
1023
- * get top hub scripts
1024
- * @returns unknown hub scripts list
1025
- * @throws ApiError
1026
- */
1454
+ * get top hub scripts
1455
+ * @param data The data for the request.
1456
+ * @param data.limit query limit
1457
+ * @param data.app query scripts app
1458
+ * @param data.kind query scripts kind
1459
+ * @returns unknown hub scripts list
1460
+ * @throws ApiError
1461
+ */
1027
1462
  static getTopHubScripts(data?: $OpenApiTs['/scripts/hub/top']['get']['req']): CancelablePromise<$OpenApiTs['/scripts/hub/top']['get']['res'][200]>;
1028
1463
  /**
1029
- * query hub scripts by similarity
1030
- * @returns unknown script details
1031
- * @throws ApiError
1032
- */
1464
+ * query hub scripts by similarity
1465
+ * @param data The data for the request.
1466
+ * @param data.text query text
1467
+ * @param data.kind query scripts kind
1468
+ * @param data.limit query limit
1469
+ * @param data.app query scripts app
1470
+ * @returns unknown script details
1471
+ * @throws ApiError
1472
+ */
1033
1473
  static queryHubScripts(data: $OpenApiTs['/embeddings/query_hub_scripts']['get']['req']): CancelablePromise<$OpenApiTs['/embeddings/query_hub_scripts']['get']['res'][200]>;
1034
1474
  /**
1035
- * list scripts for search
1036
- * @returns unknown script list
1037
- * @throws ApiError
1038
- */
1475
+ * list scripts for search
1476
+ * @param data The data for the request.
1477
+ * @param data.workspace
1478
+ * @returns unknown script list
1479
+ * @throws ApiError
1480
+ */
1039
1481
  static listSearchScript(data: $OpenApiTs['/w/{workspace}/scripts/list_search']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/list_search']['get']['res'][200]>;
1040
1482
  /**
1041
- * list all scripts
1042
- * @returns Script All scripts
1043
- * @throws ApiError
1044
- */
1483
+ * list all scripts
1484
+ * @param data The data for the request.
1485
+ * @param data.workspace
1486
+ * @param data.page which page to return (start at 1, default 1)
1487
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
1488
+ * @param data.orderDesc order by desc order (default true)
1489
+ * @param data.createdBy mask to filter exact matching user creator
1490
+ * @param data.pathStart mask to filter matching starting path
1491
+ * @param data.pathExact mask to filter exact matching path
1492
+ * @param data.firstParentHash mask to filter scripts whom first direct parent has exact hash
1493
+ * @param data.lastParentHash mask to filter scripts whom last parent in the chain has exact hash.
1494
+ * Beware that each script stores only a limited number of parents. Hence
1495
+ * the last parent hash for a script is not necessarily its top-most parent.
1496
+ * To find the top-most parent you will have to jump from last to last hash
1497
+ * until finding the parent
1498
+ *
1499
+ * @param data.parentHash is the hash present in the array of stored parent hashes for this script.
1500
+ * The same warning applies than for last_parent_hash. A script only store a
1501
+ * limited number of direct parent
1502
+ *
1503
+ * @param data.showArchived (default false)
1504
+ * show also the archived files.
1505
+ * when multiple archived hash share the same path, only the ones with the latest create_at
1506
+ * are
1507
+ * ed.
1508
+ *
1509
+ * @param data.hideWithoutMain (default false)
1510
+ * hide the scripts without an exported main function
1511
+ *
1512
+ * @param data.isTemplate (default regardless)
1513
+ * if true show only the templates
1514
+ * if false show only the non templates
1515
+ * if not defined, show all regardless of if the script is a template
1516
+ *
1517
+ * @param data.kinds (default regardless)
1518
+ * script kinds to filter, split by comma
1519
+ *
1520
+ * @param data.starredOnly (default false)
1521
+ * show only the starred items
1522
+ *
1523
+ * @returns Script All scripts
1524
+ * @throws ApiError
1525
+ */
1045
1526
  static listScripts(data: $OpenApiTs['/w/{workspace}/scripts/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/list']['get']['res'][200]>;
1046
1527
  /**
1047
- * list all scripts paths
1048
- * @returns string list of script paths
1049
- * @throws ApiError
1050
- */
1528
+ * list all scripts paths
1529
+ * @param data The data for the request.
1530
+ * @param data.workspace
1531
+ * @returns string list of script paths
1532
+ * @throws ApiError
1533
+ */
1051
1534
  static listScriptPaths(data: $OpenApiTs['/w/{workspace}/scripts/list_paths']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/list_paths']['get']['res'][200]>;
1052
1535
  /**
1053
- * create script
1054
- * @returns string script created
1055
- * @throws ApiError
1056
- */
1536
+ * create script
1537
+ * @param data The data for the request.
1538
+ * @param data.workspace
1539
+ * @param data.requestBody Partially filled script
1540
+ * @returns string script created
1541
+ * @throws ApiError
1542
+ */
1057
1543
  static createScript(data: $OpenApiTs['/w/{workspace}/scripts/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/create']['post']['res'][201]>;
1058
1544
  /**
1059
- * Toggle ON and OFF the workspace error handler for a given script
1060
- * @returns string error handler toggled
1061
- * @throws ApiError
1062
- */
1545
+ * Toggle ON and OFF the workspace error handler for a given script
1546
+ * @param data The data for the request.
1547
+ * @param data.workspace
1548
+ * @param data.path
1549
+ * @param data.requestBody Workspace error handler enabled
1550
+ * @returns string error handler toggled
1551
+ * @throws ApiError
1552
+ */
1063
1553
  static toggleWorkspaceErrorHandlerForScript(data: $OpenApiTs['/w/{workspace}/scripts/toggle_workspace_error_handler/p/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/toggle_workspace_error_handler/p/{path}']['post']['res'][200]>;
1064
1554
  /**
1065
- * archive script by path
1066
- * @returns string script archived
1067
- * @throws ApiError
1068
- */
1555
+ * archive script by path
1556
+ * @param data The data for the request.
1557
+ * @param data.workspace
1558
+ * @param data.path
1559
+ * @returns string script archived
1560
+ * @throws ApiError
1561
+ */
1069
1562
  static archiveScriptByPath(data: $OpenApiTs['/w/{workspace}/scripts/archive/p/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/archive/p/{path}']['post']['res'][200]>;
1070
1563
  /**
1071
- * archive script by hash
1072
- * @returns Script script details
1073
- * @throws ApiError
1074
- */
1564
+ * archive script by hash
1565
+ * @param data The data for the request.
1566
+ * @param data.workspace
1567
+ * @param data.hash
1568
+ * @returns Script script details
1569
+ * @throws ApiError
1570
+ */
1075
1571
  static archiveScriptByHash(data: $OpenApiTs['/w/{workspace}/scripts/archive/h/{hash}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/archive/h/{hash}']['post']['res'][200]>;
1076
1572
  /**
1077
- * delete script by hash (erase content but keep hash, require admin)
1078
- * @returns Script script details
1079
- * @throws ApiError
1080
- */
1573
+ * delete script by hash (erase content but keep hash, require admin)
1574
+ * @param data The data for the request.
1575
+ * @param data.workspace
1576
+ * @param data.hash
1577
+ * @returns Script script details
1578
+ * @throws ApiError
1579
+ */
1081
1580
  static deleteScriptByHash(data: $OpenApiTs['/w/{workspace}/scripts/delete/h/{hash}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/delete/h/{hash}']['post']['res'][200]>;
1082
1581
  /**
1083
- * delete all scripts at a given path (require admin)
1084
- * @returns string script path
1085
- * @throws ApiError
1086
- */
1582
+ * delete all scripts at a given path (require admin)
1583
+ * @param data The data for the request.
1584
+ * @param data.workspace
1585
+ * @param data.path
1586
+ * @returns string script path
1587
+ * @throws ApiError
1588
+ */
1087
1589
  static deleteScriptByPath(data: $OpenApiTs['/w/{workspace}/scripts/delete/p/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/delete/p/{path}']['post']['res'][200]>;
1088
1590
  /**
1089
- * get script by path
1090
- * @returns Script script details
1091
- * @throws ApiError
1092
- */
1591
+ * get script by path
1592
+ * @param data The data for the request.
1593
+ * @param data.workspace
1594
+ * @param data.path
1595
+ * @returns Script script details
1596
+ * @throws ApiError
1597
+ */
1093
1598
  static getScriptByPath(data: $OpenApiTs['/w/{workspace}/scripts/get/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/get/p/{path}']['get']['res'][200]>;
1094
1599
  /**
1095
- * get script by path with draft
1096
- * @returns NewScriptWithDraft script details
1097
- * @throws ApiError
1098
- */
1600
+ * get script by path with draft
1601
+ * @param data The data for the request.
1602
+ * @param data.workspace
1603
+ * @param data.path
1604
+ * @returns NewScriptWithDraft script details
1605
+ * @throws ApiError
1606
+ */
1099
1607
  static getScriptByPathWithDraft(data: $OpenApiTs['/w/{workspace}/scripts/get/draft/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/get/draft/{path}']['get']['res'][200]>;
1100
1608
  /**
1101
- * get history of a script by path
1102
- * @returns ScriptHistory script history
1103
- * @throws ApiError
1104
- */
1609
+ * get history of a script by path
1610
+ * @param data The data for the request.
1611
+ * @param data.workspace
1612
+ * @param data.path
1613
+ * @returns ScriptHistory script history
1614
+ * @throws ApiError
1615
+ */
1105
1616
  static getScriptHistoryByPath(data: $OpenApiTs['/w/{workspace}/scripts/history/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/history/p/{path}']['get']['res'][200]>;
1106
1617
  /**
1107
- * update history of a script
1108
- * @returns string success
1109
- * @throws ApiError
1110
- */
1618
+ * update history of a script
1619
+ * @param data The data for the request.
1620
+ * @param data.workspace
1621
+ * @param data.hash
1622
+ * @param data.path
1623
+ * @param data.requestBody Script deployment message
1624
+ * @returns string success
1625
+ * @throws ApiError
1626
+ */
1111
1627
  static updateScriptHistory(data: $OpenApiTs['/w/{workspace}/scripts/history_update/h/{hash}/p/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/history_update/h/{hash}/p/{path}']['post']['res'][200]>;
1112
1628
  /**
1113
- * raw script by path
1114
- * @returns string script content
1115
- * @throws ApiError
1116
- */
1629
+ * raw script by path
1630
+ * @param data The data for the request.
1631
+ * @param data.workspace
1632
+ * @param data.path
1633
+ * @returns string script content
1634
+ * @throws ApiError
1635
+ */
1117
1636
  static rawScriptByPath(data: $OpenApiTs['/w/{workspace}/scripts/raw/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/raw/p/{path}']['get']['res'][200]>;
1118
1637
  /**
1119
- * raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
1120
- * @returns string script content
1121
- * @throws ApiError
1122
- */
1638
+ * raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
1639
+ * @param data The data for the request.
1640
+ * @param data.workspace
1641
+ * @param data.token
1642
+ * @param data.path
1643
+ * @returns string script content
1644
+ * @throws ApiError
1645
+ */
1123
1646
  static rawScriptByPathTokened(data: $OpenApiTs['/scripts_u/tokened_raw/{workspace}/{token}/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/scripts_u/tokened_raw/{workspace}/{token}/{path}']['get']['res'][200]>;
1124
1647
  /**
1125
- * exists script by path
1126
- * @returns boolean does it exists
1127
- * @throws ApiError
1128
- */
1648
+ * exists script by path
1649
+ * @param data The data for the request.
1650
+ * @param data.workspace
1651
+ * @param data.path
1652
+ * @returns boolean does it exists
1653
+ * @throws ApiError
1654
+ */
1129
1655
  static existsScriptByPath(data: $OpenApiTs['/w/{workspace}/scripts/exists/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/exists/p/{path}']['get']['res'][200]>;
1130
1656
  /**
1131
- * get script by hash
1132
- * @returns Script script details
1133
- * @throws ApiError
1134
- */
1657
+ * get script by hash
1658
+ * @param data The data for the request.
1659
+ * @param data.workspace
1660
+ * @param data.hash
1661
+ * @returns Script script details
1662
+ * @throws ApiError
1663
+ */
1135
1664
  static getScriptByHash(data: $OpenApiTs['/w/{workspace}/scripts/get/h/{hash}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/get/h/{hash}']['get']['res'][200]>;
1136
1665
  /**
1137
- * raw script by hash
1138
- * @returns string script content
1139
- * @throws ApiError
1140
- */
1666
+ * raw script by hash
1667
+ * @param data The data for the request.
1668
+ * @param data.workspace
1669
+ * @param data.path
1670
+ * @returns string script content
1671
+ * @throws ApiError
1672
+ */
1141
1673
  static rawScriptByHash(data: $OpenApiTs['/w/{workspace}/scripts/raw/h/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/raw/h/{path}']['get']['res'][200]>;
1142
1674
  /**
1143
- * get script deployment status
1144
- * @returns unknown script details
1145
- * @throws ApiError
1146
- */
1675
+ * get script deployment status
1676
+ * @param data The data for the request.
1677
+ * @param data.workspace
1678
+ * @param data.hash
1679
+ * @returns unknown script details
1680
+ * @throws ApiError
1681
+ */
1147
1682
  static getScriptDeploymentStatus(data: $OpenApiTs['/w/{workspace}/scripts/deployment_status/h/{hash}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/scripts/deployment_status/h/{hash}']['get']['res'][200]>;
1148
1683
  }
1149
1684
  export declare class DraftService {
1150
1685
  /**
1151
- * create draft
1152
- * @returns string draft created
1153
- * @throws ApiError
1154
- */
1686
+ * create draft
1687
+ * @param data The data for the request.
1688
+ * @param data.workspace
1689
+ * @param data.requestBody
1690
+ * @returns string draft created
1691
+ * @throws ApiError
1692
+ */
1155
1693
  static createDraft(data: $OpenApiTs['/w/{workspace}/drafts/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/drafts/create']['post']['res'][201]>;
1156
1694
  /**
1157
- * delete draft
1158
- * @returns string draft deleted
1159
- * @throws ApiError
1160
- */
1695
+ * delete draft
1696
+ * @param data The data for the request.
1697
+ * @param data.workspace
1698
+ * @param data.kind
1699
+ * @param data.path
1700
+ * @returns string draft deleted
1701
+ * @throws ApiError
1702
+ */
1161
1703
  static deleteDraft(data: $OpenApiTs['/w/{workspace}/drafts/delete/{kind}/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/drafts/delete/{kind}/{path}']['delete']['res'][200]>;
1162
1704
  }
1163
1705
  export declare class WorkerService {
1164
1706
  /**
1165
- * get all instance custom tags (tags are used to dispatch jobs to different worker groups)
1166
- * @returns string list of custom tags
1167
- * @throws ApiError
1168
- */
1707
+ * get all instance custom tags (tags are used to dispatch jobs to different worker groups)
1708
+ * @returns string list of custom tags
1709
+ * @throws ApiError
1710
+ */
1169
1711
  static getCustomTags(): CancelablePromise<$OpenApiTs['/workers/custom_tags']['get']['res'][200]>;
1170
1712
  /**
1171
- * get all instance default tags
1172
- * @returns string list of default tags
1173
- * @throws ApiError
1174
- */
1713
+ * get all instance default tags
1714
+ * @returns string list of default tags
1715
+ * @throws ApiError
1716
+ */
1175
1717
  static geDefaultTags(): CancelablePromise<$OpenApiTs['/workers/get_default_tags']['get']['res'][200]>;
1176
1718
  /**
1177
- * is default tags per workspace
1178
- * @returns boolean is the default tags per workspace
1179
- * @throws ApiError
1180
- */
1719
+ * is default tags per workspace
1720
+ * @returns boolean is the default tags per workspace
1721
+ * @throws ApiError
1722
+ */
1181
1723
  static isDefaultTagsPerWorkspace(): CancelablePromise<$OpenApiTs['/workers/is_default_tags_per_workspace']['get']['res'][200]>;
1182
1724
  /**
1183
- * list workers
1184
- * @returns WorkerPing a list of workers
1185
- * @throws ApiError
1186
- */
1725
+ * list workers
1726
+ * @param data The data for the request.
1727
+ * @param data.page which page to return (start at 1, default 1)
1728
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
1729
+ * @param data.pingSince number of seconds the worker must have had a last ping more recent of (default to 300)
1730
+ * @returns WorkerPing a list of workers
1731
+ * @throws ApiError
1732
+ */
1187
1733
  static listWorkers(data?: $OpenApiTs['/workers/list']['get']['req']): CancelablePromise<$OpenApiTs['/workers/list']['get']['res'][200]>;
1188
1734
  /**
1189
- * exists worker with tag
1190
- * @returns boolean whether a worker with the tag exists
1191
- * @throws ApiError
1192
- */
1735
+ * exists worker with tag
1736
+ * @param data The data for the request.
1737
+ * @param data.tag
1738
+ * @returns boolean whether a worker with the tag exists
1739
+ * @throws ApiError
1740
+ */
1193
1741
  static existsWorkerWithTag(data: $OpenApiTs['/workers/exists_worker_with_tag']['get']['req']): CancelablePromise<$OpenApiTs['/workers/exists_worker_with_tag']['get']['res'][200]>;
1194
1742
  }
1195
1743
  export declare class JobService {
1196
1744
  /**
1197
- * run script by path
1198
- * @returns string job created
1199
- * @throws ApiError
1200
- */
1745
+ * run script by path
1746
+ * @param data The data for the request.
1747
+ * @param data.workspace
1748
+ * @param data.path
1749
+ * @param data.requestBody script args
1750
+ * @param data.scheduledFor when to schedule this job (leave empty for immediate run)
1751
+ * @param data.scheduledInSecs schedule the script to execute in the number of seconds starting now
1752
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1753
+ * @param data.tag Override the tag to use
1754
+ * @param data.cacheTtl Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
1755
+ * @param data.jobId 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)
1756
+ * @param data.invisibleToOwner make the run invisible to the the script owner (default false)
1757
+ * @returns string job created
1758
+ * @throws ApiError
1759
+ */
1201
1760
  static runScriptByPath(data: $OpenApiTs['/w/{workspace}/jobs/run/p/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run/p/{path}']['post']['res'][201]>;
1202
1761
  /**
1203
- * run script by path in openai format
1204
- * @returns unknown job result
1205
- * @throws ApiError
1206
- */
1762
+ * run script by path in openai format
1763
+ * @param data The data for the request.
1764
+ * @param data.workspace
1765
+ * @param data.path
1766
+ * @param data.requestBody script args
1767
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1768
+ * @param data.jobId 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)
1769
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1770
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1771
+ *
1772
+ * @param data.queueLimit The maximum size of the queue for which the request would get rejected if that job would push it above that limit
1773
+ *
1774
+ * @returns unknown job result
1775
+ * @throws ApiError
1776
+ */
1207
1777
  static openaiSyncScriptByPath(data: $OpenApiTs['/w/{workspace}/jobs/openai_sync/p/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/openai_sync/p/{path}']['post']['res'][200]>;
1208
1778
  /**
1209
- * run script by path
1210
- * @returns unknown job result
1211
- * @throws ApiError
1212
- */
1779
+ * run script by path
1780
+ * @param data The data for the request.
1781
+ * @param data.workspace
1782
+ * @param data.path
1783
+ * @param data.requestBody script args
1784
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1785
+ * @param data.tag Override the tag to use
1786
+ * @param data.cacheTtl Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
1787
+ * @param data.jobId 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)
1788
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1789
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1790
+ *
1791
+ * @param data.queueLimit The maximum size of the queue for which the request would get rejected if that job would push it above that limit
1792
+ *
1793
+ * @returns unknown job result
1794
+ * @throws ApiError
1795
+ */
1213
1796
  static runWaitResultScriptByPath(data: $OpenApiTs['/w/{workspace}/jobs/run_wait_result/p/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run_wait_result/p/{path}']['post']['res'][200]>;
1214
1797
  /**
1215
- * run script by path with get
1216
- * @returns unknown job result
1217
- * @throws ApiError
1218
- */
1798
+ * run script by path with get
1799
+ * @param data The data for the request.
1800
+ * @param data.workspace
1801
+ * @param data.path
1802
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1803
+ * @param data.tag Override the tag to use
1804
+ * @param data.cacheTtl Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
1805
+ * @param data.jobId 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)
1806
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1807
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1808
+ *
1809
+ * @param data.queueLimit The maximum size of the queue for which the request would get rejected if that job would push it above that limit
1810
+ *
1811
+ * @param data.payload The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
1812
+ * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
1813
+ *
1814
+ * @returns unknown job result
1815
+ * @throws ApiError
1816
+ */
1219
1817
  static runWaitResultScriptByPathGet(data: $OpenApiTs['/w/{workspace}/jobs/run_wait_result/p/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run_wait_result/p/{path}']['get']['res'][200]>;
1220
1818
  /**
1221
- * run flow by path and wait until completion in openai format
1222
- * @returns unknown job result
1223
- * @throws ApiError
1224
- */
1819
+ * run flow by path and wait until completion in openai format
1820
+ * @param data The data for the request.
1821
+ * @param data.workspace
1822
+ * @param data.path
1823
+ * @param data.requestBody script args
1824
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1825
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1826
+ *
1827
+ * @param data.queueLimit The maximum size of the queue for which the request would get rejected if that job would push it above that limit
1828
+ *
1829
+ * @param data.jobId 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)
1830
+ * @returns unknown job result
1831
+ * @throws ApiError
1832
+ */
1225
1833
  static openaiSyncFlowByPath(data: $OpenApiTs['/w/{workspace}/jobs/openai_sync/f/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/openai_sync/f/{path}']['post']['res'][200]>;
1226
1834
  /**
1227
- * run flow by path and wait until completion
1228
- * @returns unknown job result
1229
- * @throws ApiError
1230
- */
1835
+ * run flow by path and wait until completion
1836
+ * @param data The data for the request.
1837
+ * @param data.workspace
1838
+ * @param data.path
1839
+ * @param data.requestBody script args
1840
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1841
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1842
+ *
1843
+ * @param data.queueLimit The maximum size of the queue for which the request would get rejected if that job would push it above that limit
1844
+ *
1845
+ * @param data.jobId 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)
1846
+ * @returns unknown job result
1847
+ * @throws ApiError
1848
+ */
1231
1849
  static runWaitResultFlowByPath(data: $OpenApiTs['/w/{workspace}/jobs/run_wait_result/f/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run_wait_result/f/{path}']['post']['res'][200]>;
1232
1850
  /**
1233
- * get job result by id
1234
- * @returns unknown job result
1235
- * @throws ApiError
1236
- */
1851
+ * get job result by id
1852
+ * @param data The data for the request.
1853
+ * @param data.workspace
1854
+ * @param data.flowJobId
1855
+ * @param data.nodeId
1856
+ * @returns unknown job result
1857
+ * @throws ApiError
1858
+ */
1237
1859
  static resultById(data: $OpenApiTs['/w/{workspace}/jobs/result_by_id/{flow_job_id}/{node_id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/result_by_id/{flow_job_id}/{node_id}']['get']['res'][200]>;
1238
1860
  /**
1239
- * run flow by path
1240
- * @returns string job created
1241
- * @throws ApiError
1242
- */
1861
+ * run flow by path
1862
+ * @param data The data for the request.
1863
+ * @param data.workspace
1864
+ * @param data.path
1865
+ * @param data.requestBody flow args
1866
+ * @param data.scheduledFor when to schedule this job (leave empty for immediate run)
1867
+ * @param data.scheduledInSecs schedule the script to execute in the number of seconds starting now
1868
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1869
+ * @param data.tag Override the tag to use
1870
+ * @param data.jobId 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)
1871
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1872
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1873
+ *
1874
+ * @param data.invisibleToOwner make the run invisible to the the flow owner (default false)
1875
+ * @returns string job created
1876
+ * @throws ApiError
1877
+ */
1243
1878
  static runFlowByPath(data: $OpenApiTs['/w/{workspace}/jobs/run/f/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run/f/{path}']['post']['res'][201]>;
1244
1879
  /**
1245
- * restart a completed flow at a given step
1246
- * @returns string job created
1247
- * @throws ApiError
1248
- */
1880
+ * restart a completed flow at a given step
1881
+ * @param data The data for the request.
1882
+ * @param data.workspace
1883
+ * @param data.id
1884
+ * @param data.stepId step id to restart the flow from
1885
+ * @param data.branchOrIterationN for branchall or loop, the iteration at which the flow should restart
1886
+ * @param data.requestBody flow args
1887
+ * @param data.scheduledFor when to schedule this job (leave empty for immediate run)
1888
+ * @param data.scheduledInSecs schedule the script to execute in the number of seconds starting now
1889
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1890
+ * @param data.tag Override the tag to use
1891
+ * @param data.jobId 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)
1892
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1893
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1894
+ *
1895
+ * @param data.invisibleToOwner make the run invisible to the the flow owner (default false)
1896
+ * @returns string job created
1897
+ * @throws ApiError
1898
+ */
1249
1899
  static restartFlowAtStep(data: $OpenApiTs['/w/{workspace}/jobs/restart/f/{id}/from/{step_id}/{branch_or_iteration_n}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/restart/f/{id}/from/{step_id}/{branch_or_iteration_n}']['post']['res'][201]>;
1250
1900
  /**
1251
- * run script by hash
1252
- * @returns string job created
1253
- * @throws ApiError
1254
- */
1901
+ * run script by hash
1902
+ * @param data The data for the request.
1903
+ * @param data.workspace
1904
+ * @param data.hash
1905
+ * @param data.requestBody Partially filled args
1906
+ * @param data.scheduledFor when to schedule this job (leave empty for immediate run)
1907
+ * @param data.scheduledInSecs schedule the script to execute in the number of seconds starting now
1908
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1909
+ * @param data.tag Override the tag to use
1910
+ * @param data.cacheTtl Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
1911
+ * @param data.jobId 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)
1912
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1913
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1914
+ *
1915
+ * @param data.invisibleToOwner make the run invisible to the the script owner (default false)
1916
+ * @returns string job created
1917
+ * @throws ApiError
1918
+ */
1255
1919
  static runScriptByHash(data: $OpenApiTs['/w/{workspace}/jobs/run/h/{hash}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run/h/{hash}']['post']['res'][201]>;
1256
1920
  /**
1257
- * run script preview
1258
- * @returns string job created
1259
- * @throws ApiError
1260
- */
1921
+ * run script preview
1922
+ * @param data The data for the request.
1923
+ * @param data.workspace
1924
+ * @param data.requestBody preview
1925
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1926
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1927
+ *
1928
+ * @param data.invisibleToOwner make the run invisible to the the script owner (default false)
1929
+ * @param data.jobId 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)
1930
+ * @returns string job created
1931
+ * @throws ApiError
1932
+ */
1261
1933
  static runScriptPreview(data: $OpenApiTs['/w/{workspace}/jobs/run/preview']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run/preview']['post']['res'][201]>;
1262
1934
  /**
1263
- * run code-workflow task
1264
- * @returns string job created
1265
- * @throws ApiError
1266
- */
1935
+ * run code-workflow task
1936
+ * @param data The data for the request.
1937
+ * @param data.workspace
1938
+ * @param data.jobId
1939
+ * @param data.entrypoint
1940
+ * @param data.requestBody preview
1941
+ * @returns string job created
1942
+ * @throws ApiError
1943
+ */
1267
1944
  static runCodeWorkflowTask(data: $OpenApiTs['/w/{workspace}/jobs/workflow_as_code/{job_id}/{entrypoint}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/workflow_as_code/{job_id}/{entrypoint}']['post']['res'][201]>;
1268
1945
  /**
1269
- * run a one-off dependencies job
1270
- * @returns unknown dependency job result
1271
- * @throws ApiError
1272
- */
1946
+ * run a one-off dependencies job
1947
+ * @param data The data for the request.
1948
+ * @param data.workspace
1949
+ * @param data.requestBody raw script content
1950
+ * @returns unknown dependency job result
1951
+ * @throws ApiError
1952
+ */
1273
1953
  static runRawScriptDependencies(data: $OpenApiTs['/w/{workspace}/jobs/run/dependencies']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run/dependencies']['post']['res'][201]>;
1274
1954
  /**
1275
- * run flow preview
1276
- * @returns string job created
1277
- * @throws ApiError
1278
- */
1955
+ * run flow preview
1956
+ * @param data The data for the request.
1957
+ * @param data.workspace
1958
+ * @param data.requestBody preview
1959
+ * @param data.includeHeader List of headers's keys (separated with ',') whove value are added to the args
1960
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
1961
+ *
1962
+ * @param data.invisibleToOwner make the run invisible to the the script owner (default false)
1963
+ * @param data.jobId 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)
1964
+ * @returns string job created
1965
+ * @throws ApiError
1966
+ */
1279
1967
  static runFlowPreview(data: $OpenApiTs['/w/{workspace}/jobs/run/preview_flow']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/run/preview_flow']['post']['res'][201]>;
1280
1968
  /**
1281
- * list all queued jobs
1282
- * @returns QueuedJob All queued jobs
1283
- * @throws ApiError
1284
- */
1969
+ * list all queued jobs
1970
+ * @param data The data for the request.
1971
+ * @param data.workspace
1972
+ * @param data.orderDesc order by desc order (default true)
1973
+ * @param data.createdBy mask to filter exact matching user creator
1974
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
1975
+ * @param data.scriptPathExact mask to filter exact matching path
1976
+ * @param data.scriptPathStart mask to filter matching starting path
1977
+ * @param data.schedulePath mask to filter by schedule path
1978
+ * @param data.scriptHash mask to filter exact matching path
1979
+ * @param data.startedBefore filter on started before (inclusive) timestamp
1980
+ * @param data.startedAfter filter on started after (exclusive) timestamp
1981
+ * @param data.success filter on successful jobs
1982
+ * @param data.scheduledForBeforeNow filter on jobs scheduled_for before now (hence waitinf for a worker)
1983
+ * @param data.jobKinds filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
1984
+ * @param data.suspended filter on suspended jobs
1985
+ * @param data.running filter on running jobs
1986
+ * @param data.args filter on jobs containing those args as a json subset (@> in postgres)
1987
+ * @param data.result filter on jobs containing those result as a json subset (@> in postgres)
1988
+ * @param data.tag filter on jobs with a given tag/worker group
1989
+ * @param data.page which page to return (start at 1, default 1)
1990
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
1991
+ * @param data.allWorkspaces get jobs from all workspaces (only valid if request come from the `admins` workspace)
1992
+ * @returns QueuedJob All queued jobs
1993
+ * @throws ApiError
1994
+ */
1285
1995
  static listQueue(data: $OpenApiTs['/w/{workspace}/jobs/queue/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/queue/list']['get']['res'][200]>;
1286
1996
  /**
1287
- * get queue count
1288
- * @returns unknown queue count
1289
- * @throws ApiError
1290
- */
1997
+ * get queue count
1998
+ * @param data The data for the request.
1999
+ * @param data.workspace
2000
+ * @param data.allWorkspaces get jobs from all workspaces (only valid if request come from the `admins` workspace)
2001
+ * @returns unknown queue count
2002
+ * @throws ApiError
2003
+ */
1291
2004
  static getQueueCount(data: $OpenApiTs['/w/{workspace}/jobs/queue/count']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/queue/count']['get']['res'][200]>;
1292
2005
  /**
1293
- * get completed count
1294
- * @returns unknown completed count
1295
- * @throws ApiError
1296
- */
2006
+ * get completed count
2007
+ * @param data The data for the request.
2008
+ * @param data.workspace
2009
+ * @returns unknown completed count
2010
+ * @throws ApiError
2011
+ */
1297
2012
  static getCompletedCount(data: $OpenApiTs['/w/{workspace}/jobs/completed/count']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/completed/count']['get']['res'][200]>;
1298
2013
  /**
1299
- * cancel all jobs
1300
- * @returns string uuids of canceled jobs
1301
- * @throws ApiError
1302
- */
2014
+ * cancel all jobs
2015
+ * @param data The data for the request.
2016
+ * @param data.workspace
2017
+ * @returns string uuids of canceled jobs
2018
+ * @throws ApiError
2019
+ */
1303
2020
  static cancelAll(data: $OpenApiTs['/w/{workspace}/jobs/queue/cancel_all']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/queue/cancel_all']['post']['res'][200]>;
1304
2021
  /**
1305
- * list all completed jobs
1306
- * @returns CompletedJob All completed jobs
1307
- * @throws ApiError
1308
- */
2022
+ * list all completed jobs
2023
+ * @param data The data for the request.
2024
+ * @param data.workspace
2025
+ * @param data.orderDesc order by desc order (default true)
2026
+ * @param data.createdBy mask to filter exact matching user creator
2027
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
2028
+ * @param data.scriptPathExact mask to filter exact matching path
2029
+ * @param data.scriptPathStart mask to filter matching starting path
2030
+ * @param data.schedulePath mask to filter by schedule path
2031
+ * @param data.scriptHash mask to filter exact matching path
2032
+ * @param data.startedBefore filter on started before (inclusive) timestamp
2033
+ * @param data.startedAfter filter on started after (exclusive) timestamp
2034
+ * @param data.success filter on successful jobs
2035
+ * @param data.jobKinds filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
2036
+ * @param data.args filter on jobs containing those args as a json subset (@> in postgres)
2037
+ * @param data.result filter on jobs containing those result as a json subset (@> in postgres)
2038
+ * @param data.tag filter on jobs with a given tag/worker group
2039
+ * @param data.page which page to return (start at 1, default 1)
2040
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2041
+ * @param data.isSkipped is the job skipped
2042
+ * @param data.isFlowStep is the job a flow step
2043
+ * @param data.hasNullParent has null parent
2044
+ * @returns CompletedJob All completed jobs
2045
+ * @throws ApiError
2046
+ */
1309
2047
  static listCompletedJobs(data: $OpenApiTs['/w/{workspace}/jobs/completed/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/completed/list']['get']['res'][200]>;
1310
2048
  /**
1311
- * list all jobs
1312
- * @returns Job All jobs
1313
- * @throws ApiError
1314
- */
2049
+ * list all jobs
2050
+ * @param data The data for the request.
2051
+ * @param data.workspace
2052
+ * @param data.createdBy mask to filter exact matching user creator
2053
+ * @param data.parentJob The parent job that is at the origin and responsible for the execution of this script if any
2054
+ * @param data.scriptPathExact mask to filter exact matching path
2055
+ * @param data.scriptPathStart mask to filter matching starting path
2056
+ * @param data.schedulePath mask to filter by schedule path
2057
+ * @param data.scriptHash mask to filter exact matching path
2058
+ * @param data.startedBefore filter on started before (inclusive) timestamp
2059
+ * @param data.startedAfter filter on started after (exclusive) timestamp
2060
+ * @param data.createdOrStartedBefore filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
2061
+ * @param data.running filter on running jobs
2062
+ * @param data.scheduledForBeforeNow filter on jobs scheduled_for before now (hence waitinf for a worker)
2063
+ * @param data.createdOrStartedAfter filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
2064
+ * @param data.jobKinds filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
2065
+ * @param data.args filter on jobs containing those args as a json subset (@> in postgres)
2066
+ * @param data.tag filter on jobs with a given tag/worker group
2067
+ * @param data.result filter on jobs containing those result as a json subset (@> in postgres)
2068
+ * @param data.page which page to return (start at 1, default 1)
2069
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2070
+ * @param data.isSkipped is the job skipped
2071
+ * @param data.isFlowStep is the job a flow step
2072
+ * @param data.hasNullParent has null parent
2073
+ * @param data.success filter on successful jobs
2074
+ * @param data.allWorkspaces get jobs from all workspaces (only valid if request come from the `admins` workspace)
2075
+ * @returns Job All jobs
2076
+ * @throws ApiError
2077
+ */
1315
2078
  static listJobs(data: $OpenApiTs['/w/{workspace}/jobs/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/list']['get']['res'][200]>;
1316
2079
  /**
1317
- * get db clock
1318
- * @returns number the timestamp of the db that can be used to compute the drift
1319
- * @throws ApiError
1320
- */
2080
+ * get db clock
2081
+ * @returns number the timestamp of the db that can be used to compute the drift
2082
+ * @throws ApiError
2083
+ */
1321
2084
  static getDbClock(): CancelablePromise<$OpenApiTs['/jobs/db_clock']['get']['res'][200]>;
1322
2085
  /**
1323
- * get job
1324
- * @returns Job job details
1325
- * @throws ApiError
1326
- */
2086
+ * get job
2087
+ * @param data The data for the request.
2088
+ * @param data.workspace
2089
+ * @param data.id
2090
+ * @param data.noLogs
2091
+ * @returns Job job details
2092
+ * @throws ApiError
2093
+ */
1327
2094
  static getJob(data: $OpenApiTs['/w/{workspace}/jobs_u/get/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/get/{id}']['get']['res'][200]>;
1328
2095
  /**
1329
- * get root job id
1330
- * @returns string get root job id
1331
- * @throws ApiError
1332
- */
2096
+ * get root job id
2097
+ * @param data The data for the request.
2098
+ * @param data.workspace
2099
+ * @param data.id
2100
+ * @returns string get root job id
2101
+ * @throws ApiError
2102
+ */
1333
2103
  static getRootJobId(data: $OpenApiTs['/w/{workspace}/jobs_u/get_root_job_id/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/get_root_job_id/{id}']['get']['res'][200]>;
1334
2104
  /**
1335
- * get job logs
1336
- * @returns string job details
1337
- * @throws ApiError
1338
- */
2105
+ * get job logs
2106
+ * @param data The data for the request.
2107
+ * @param data.workspace
2108
+ * @param data.id
2109
+ * @returns string job details
2110
+ * @throws ApiError
2111
+ */
1339
2112
  static getJobLogs(data: $OpenApiTs['/w/{workspace}/jobs_u/get_logs/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/get_logs/{id}']['get']['res'][200]>;
1340
2113
  /**
1341
- * get job updates
1342
- * @returns unknown job details
1343
- * @throws ApiError
1344
- */
2114
+ * get job updates
2115
+ * @param data The data for the request.
2116
+ * @param data.workspace
2117
+ * @param data.id
2118
+ * @param data.running
2119
+ * @param data.logOffset
2120
+ * @returns unknown job details
2121
+ * @throws ApiError
2122
+ */
1345
2123
  static getJobUpdates(data: $OpenApiTs['/w/{workspace}/jobs_u/getupdate/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/getupdate/{id}']['get']['res'][200]>;
1346
2124
  /**
1347
- * get log file from object store
1348
- * @returns unknown job log
1349
- * @throws ApiError
1350
- */
2125
+ * get log file from object store
2126
+ * @param data The data for the request.
2127
+ * @param data.workspace
2128
+ * @param data.path
2129
+ * @returns unknown job log
2130
+ * @throws ApiError
2131
+ */
1351
2132
  static getLogFileFromStore(data: $OpenApiTs['/w/{workspace}/jobs_u/get_log_file/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/get_log_file/{path}']['get']['res'][200]>;
1352
2133
  /**
1353
- * get flow debug info
1354
- * @returns unknown flow debug info details
1355
- * @throws ApiError
1356
- */
2134
+ * get flow debug info
2135
+ * @param data The data for the request.
2136
+ * @param data.workspace
2137
+ * @param data.id
2138
+ * @returns unknown flow debug info details
2139
+ * @throws ApiError
2140
+ */
1357
2141
  static getFlowDebugInfo(data: $OpenApiTs['/w/{workspace}/jobs_u/get_flow_debug_info/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/get_flow_debug_info/{id}']['get']['res'][200]>;
1358
2142
  /**
1359
- * get completed job
1360
- * @returns CompletedJob job details
1361
- * @throws ApiError
1362
- */
2143
+ * get completed job
2144
+ * @param data The data for the request.
2145
+ * @param data.workspace
2146
+ * @param data.id
2147
+ * @returns CompletedJob job details
2148
+ * @throws ApiError
2149
+ */
1363
2150
  static getCompletedJob(data: $OpenApiTs['/w/{workspace}/jobs_u/completed/get/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/completed/get/{id}']['get']['res'][200]>;
1364
2151
  /**
1365
- * get completed job result
1366
- * @returns unknown result
1367
- * @throws ApiError
1368
- */
2152
+ * get completed job result
2153
+ * @param data The data for the request.
2154
+ * @param data.workspace
2155
+ * @param data.id
2156
+ * @returns unknown result
2157
+ * @throws ApiError
2158
+ */
1369
2159
  static getCompletedJobResult(data: $OpenApiTs['/w/{workspace}/jobs_u/completed/get_result/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/completed/get_result/{id}']['get']['res'][200]>;
1370
2160
  /**
1371
- * get completed job result if job is completed
1372
- * @returns unknown result
1373
- * @throws ApiError
1374
- */
2161
+ * get completed job result if job is completed
2162
+ * @param data The data for the request.
2163
+ * @param data.workspace
2164
+ * @param data.id
2165
+ * @param data.getStarted
2166
+ * @returns unknown result
2167
+ * @throws ApiError
2168
+ */
1375
2169
  static getCompletedJobResultMaybe(data: $OpenApiTs['/w/{workspace}/jobs_u/completed/get_result_maybe/{id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/completed/get_result_maybe/{id}']['get']['res'][200]>;
1376
2170
  /**
1377
- * delete completed job (erase content but keep run id)
1378
- * @returns CompletedJob job details
1379
- * @throws ApiError
1380
- */
2171
+ * delete completed job (erase content but keep run id)
2172
+ * @param data The data for the request.
2173
+ * @param data.workspace
2174
+ * @param data.id
2175
+ * @returns CompletedJob job details
2176
+ * @throws ApiError
2177
+ */
1381
2178
  static deleteCompletedJob(data: $OpenApiTs['/w/{workspace}/jobs/completed/delete/{id}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/completed/delete/{id}']['post']['res'][200]>;
1382
2179
  /**
1383
- * cancel queued job
1384
- * @returns string job canceled
1385
- * @throws ApiError
1386
- */
2180
+ * cancel queued job
2181
+ * @param data The data for the request.
2182
+ * @param data.workspace
2183
+ * @param data.id
2184
+ * @param data.requestBody reason
2185
+ * @returns string job canceled
2186
+ * @throws ApiError
2187
+ */
1387
2188
  static cancelQueuedJob(data: $OpenApiTs['/w/{workspace}/jobs_u/queue/cancel/{id}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/queue/cancel/{id}']['post']['res'][200]>;
1388
2189
  /**
1389
- * cancel all queued jobs for persistent script
1390
- * @returns string persistent job scaled down to zero
1391
- * @throws ApiError
1392
- */
2190
+ * cancel all queued jobs for persistent script
2191
+ * @param data The data for the request.
2192
+ * @param data.workspace
2193
+ * @param data.path
2194
+ * @param data.requestBody reason
2195
+ * @returns string persistent job scaled down to zero
2196
+ * @throws ApiError
2197
+ */
1393
2198
  static cancelPersistentQueuedJobs(data: $OpenApiTs['/w/{workspace}/jobs_u/queue/cancel_persistent/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/queue/cancel_persistent/{path}']['post']['res'][200]>;
1394
2199
  /**
1395
- * force cancel queued job
1396
- * @returns string job canceled
1397
- * @throws ApiError
1398
- */
2200
+ * force cancel queued job
2201
+ * @param data The data for the request.
2202
+ * @param data.workspace
2203
+ * @param data.id
2204
+ * @param data.requestBody reason
2205
+ * @returns string job canceled
2206
+ * @throws ApiError
2207
+ */
1399
2208
  static forceCancelQueuedJob(data: $OpenApiTs['/w/{workspace}/jobs_u/queue/force_cancel/{id}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/queue/force_cancel/{id}']['post']['res'][200]>;
1400
2209
  /**
1401
- * create an HMac signature given a job id and a resume id
1402
- * @returns string job signature
1403
- * @throws ApiError
1404
- */
2210
+ * create an HMac signature given a job id and a resume id
2211
+ * @param data The data for the request.
2212
+ * @param data.workspace
2213
+ * @param data.id
2214
+ * @param data.resumeId
2215
+ * @param data.approver
2216
+ * @returns string job signature
2217
+ * @throws ApiError
2218
+ */
1405
2219
  static createJobSignature(data: $OpenApiTs['/w/{workspace}/jobs/job_signature/{id}/{resume_id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/job_signature/{id}/{resume_id}']['get']['res'][200]>;
1406
2220
  /**
1407
- * get resume urls given a job_id, resume_id and a nonce to resume a flow
1408
- * @returns unknown url endpoints
1409
- * @throws ApiError
1410
- */
2221
+ * get resume urls given a job_id, resume_id and a nonce to resume a flow
2222
+ * @param data The data for the request.
2223
+ * @param data.workspace
2224
+ * @param data.id
2225
+ * @param data.resumeId
2226
+ * @param data.approver
2227
+ * @returns unknown url endpoints
2228
+ * @throws ApiError
2229
+ */
1411
2230
  static getResumeUrls(data: $OpenApiTs['/w/{workspace}/jobs/resume_urls/{id}/{resume_id}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/resume_urls/{id}/{resume_id}']['get']['res'][200]>;
1412
2231
  /**
1413
- * resume a job for a suspended flow
1414
- * @returns string job resumed
1415
- * @throws ApiError
1416
- */
2232
+ * resume a job for a suspended flow
2233
+ * @param data The data for the request.
2234
+ * @param data.workspace
2235
+ * @param data.id
2236
+ * @param data.resumeId
2237
+ * @param data.signature
2238
+ * @param data.payload The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
2239
+ * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
2240
+ *
2241
+ * @param data.approver
2242
+ * @returns string job resumed
2243
+ * @throws ApiError
2244
+ */
1417
2245
  static resumeSuspendedJobGet(data: $OpenApiTs['/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}']['get']['res'][201]>;
1418
2246
  /**
1419
- * resume a job for a suspended flow
1420
- * @returns string job resumed
1421
- * @throws ApiError
1422
- */
2247
+ * resume a job for a suspended flow
2248
+ * @param data The data for the request.
2249
+ * @param data.workspace
2250
+ * @param data.id
2251
+ * @param data.resumeId
2252
+ * @param data.signature
2253
+ * @param data.requestBody
2254
+ * @param data.approver
2255
+ * @returns string job resumed
2256
+ * @throws ApiError
2257
+ */
1423
2258
  static resumeSuspendedJobPost(data: $OpenApiTs['/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}']['post']['res'][201]>;
1424
2259
  /**
1425
- * set flow user state at a given key
1426
- * @returns string flow user state updated
1427
- * @throws ApiError
1428
- */
2260
+ * set flow user state at a given key
2261
+ * @param data The data for the request.
2262
+ * @param data.workspace
2263
+ * @param data.id
2264
+ * @param data.key
2265
+ * @param data.requestBody new value
2266
+ * @returns string flow user state updated
2267
+ * @throws ApiError
2268
+ */
1429
2269
  static setFlowUserState(data: $OpenApiTs['/w/{workspace}/jobs/flow/user_states/{id}/{key}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/flow/user_states/{id}/{key}']['post']['res'][200]>;
1430
2270
  /**
1431
- * get flow user state at a given key
1432
- * @returns unknown flow user state updated
1433
- * @throws ApiError
1434
- */
2271
+ * get flow user state at a given key
2272
+ * @param data The data for the request.
2273
+ * @param data.workspace
2274
+ * @param data.id
2275
+ * @param data.key
2276
+ * @returns unknown flow user state updated
2277
+ * @throws ApiError
2278
+ */
1435
2279
  static getFlowUserState(data: $OpenApiTs['/w/{workspace}/jobs/flow/user_states/{id}/{key}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/flow/user_states/{id}/{key}']['get']['res'][200]>;
1436
2280
  /**
1437
- * resume a job for a suspended flow as an owner
1438
- * @returns string job resumed
1439
- * @throws ApiError
1440
- */
2281
+ * resume a job for a suspended flow as an owner
2282
+ * @param data The data for the request.
2283
+ * @param data.workspace
2284
+ * @param data.id
2285
+ * @param data.requestBody
2286
+ * @returns string job resumed
2287
+ * @throws ApiError
2288
+ */
1441
2289
  static resumeSuspendedFlowAsOwner(data: $OpenApiTs['/w/{workspace}/jobs/flow/resume/{id}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs/flow/resume/{id}']['post']['res'][201]>;
1442
2290
  /**
1443
- * cancel a job for a suspended flow
1444
- * @returns string job canceled
1445
- * @throws ApiError
1446
- */
2291
+ * cancel a job for a suspended flow
2292
+ * @param data The data for the request.
2293
+ * @param data.workspace
2294
+ * @param data.id
2295
+ * @param data.resumeId
2296
+ * @param data.signature
2297
+ * @param data.approver
2298
+ * @returns string job canceled
2299
+ * @throws ApiError
2300
+ */
1447
2301
  static cancelSuspendedJobGet(data: $OpenApiTs['/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}']['get']['res'][201]>;
1448
2302
  /**
1449
- * cancel a job for a suspended flow
1450
- * @returns string job canceled
1451
- * @throws ApiError
1452
- */
2303
+ * cancel a job for a suspended flow
2304
+ * @param data The data for the request.
2305
+ * @param data.workspace
2306
+ * @param data.id
2307
+ * @param data.resumeId
2308
+ * @param data.signature
2309
+ * @param data.requestBody
2310
+ * @param data.approver
2311
+ * @returns string job canceled
2312
+ * @throws ApiError
2313
+ */
1453
2314
  static cancelSuspendedJobPost(data: $OpenApiTs['/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}']['post']['res'][201]>;
1454
2315
  /**
1455
- * get parent flow job of suspended job
1456
- * @returns unknown parent flow details
1457
- * @throws ApiError
1458
- */
2316
+ * get parent flow job of suspended job
2317
+ * @param data The data for the request.
2318
+ * @param data.workspace
2319
+ * @param data.id
2320
+ * @param data.resumeId
2321
+ * @param data.signature
2322
+ * @param data.approver
2323
+ * @returns unknown parent flow details
2324
+ * @throws ApiError
2325
+ */
1459
2326
  static getSuspendedJobFlow(data: $OpenApiTs['/w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature}']['get']['res'][200]>;
1460
2327
  }
1461
2328
  export declare class RawAppService {
1462
2329
  /**
1463
- * list all raw apps
1464
- * @returns ListableRawApp All raw apps
1465
- * @throws ApiError
1466
- */
2330
+ * list all raw apps
2331
+ * @param data The data for the request.
2332
+ * @param data.workspace
2333
+ * @param data.page which page to return (start at 1, default 1)
2334
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2335
+ * @param data.orderDesc order by desc order (default true)
2336
+ * @param data.createdBy mask to filter exact matching user creator
2337
+ * @param data.pathStart mask to filter matching starting path
2338
+ * @param data.pathExact mask to filter exact matching path
2339
+ * @param data.starredOnly (default false)
2340
+ * show only the starred items
2341
+ *
2342
+ * @returns ListableRawApp All raw apps
2343
+ * @throws ApiError
2344
+ */
1467
2345
  static listRawApps(data: $OpenApiTs['/w/{workspace}/raw_apps/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/raw_apps/list']['get']['res'][200]>;
1468
2346
  /**
1469
- * does an app exisst at path
1470
- * @returns boolean app exists
1471
- * @throws ApiError
1472
- */
2347
+ * does an app exisst at path
2348
+ * @param data The data for the request.
2349
+ * @param data.workspace
2350
+ * @param data.path
2351
+ * @returns boolean app exists
2352
+ * @throws ApiError
2353
+ */
1473
2354
  static existsRawApp(data: $OpenApiTs['/w/{workspace}/raw_apps/exists/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/raw_apps/exists/{path}']['get']['res'][200]>;
1474
2355
  /**
1475
- * get app by path
1476
- * @returns string app details
1477
- * @throws ApiError
1478
- */
2356
+ * get app by path
2357
+ * @param data The data for the request.
2358
+ * @param data.workspace
2359
+ * @param data.version
2360
+ * @param data.path
2361
+ * @returns string app details
2362
+ * @throws ApiError
2363
+ */
1479
2364
  static getRawAppData(data: $OpenApiTs['/w/{workspace}/apps/get_data/{version}/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/apps/get_data/{version}/{path}']['get']['res'][200]>;
1480
2365
  /**
1481
- * create raw app
1482
- * @returns string raw app created
1483
- * @throws ApiError
1484
- */
2366
+ * create raw app
2367
+ * @param data The data for the request.
2368
+ * @param data.workspace
2369
+ * @param data.requestBody new raw app
2370
+ * @returns string raw app created
2371
+ * @throws ApiError
2372
+ */
1485
2373
  static createRawApp(data: $OpenApiTs['/w/{workspace}/raw_apps/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/raw_apps/create']['post']['res'][201]>;
1486
2374
  /**
1487
- * update app
1488
- * @returns string app updated
1489
- * @throws ApiError
1490
- */
2375
+ * update app
2376
+ * @param data The data for the request.
2377
+ * @param data.workspace
2378
+ * @param data.path
2379
+ * @param data.requestBody updateraw app
2380
+ * @returns string app updated
2381
+ * @throws ApiError
2382
+ */
1491
2383
  static updateRawApp(data: $OpenApiTs['/w/{workspace}/raw_apps/update/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/raw_apps/update/{path}']['post']['res'][200]>;
1492
2384
  /**
1493
- * delete raw app
1494
- * @returns string app deleted
1495
- * @throws ApiError
1496
- */
2385
+ * delete raw app
2386
+ * @param data The data for the request.
2387
+ * @param data.workspace
2388
+ * @param data.path
2389
+ * @returns string app deleted
2390
+ * @throws ApiError
2391
+ */
1497
2392
  static deleteRawApp(data: $OpenApiTs['/w/{workspace}/raw_apps/delete/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/raw_apps/delete/{path}']['delete']['res'][200]>;
1498
2393
  }
1499
2394
  export declare class ScheduleService {
1500
2395
  /**
1501
- * preview schedule
1502
- * @returns string List of 5 estimated upcoming execution events (in UTC)
1503
- * @throws ApiError
1504
- */
2396
+ * preview schedule
2397
+ * @param data The data for the request.
2398
+ * @param data.requestBody schedule
2399
+ * @returns string List of 5 estimated upcoming execution events (in UTC)
2400
+ * @throws ApiError
2401
+ */
1505
2402
  static previewSchedule(data: $OpenApiTs['/schedules/preview']['post']['req']): CancelablePromise<$OpenApiTs['/schedules/preview']['post']['res'][200]>;
1506
2403
  /**
1507
- * create schedule
1508
- * @returns string schedule created
1509
- * @throws ApiError
1510
- */
2404
+ * create schedule
2405
+ * @param data The data for the request.
2406
+ * @param data.workspace
2407
+ * @param data.requestBody new schedule
2408
+ * @returns string schedule created
2409
+ * @throws ApiError
2410
+ */
1511
2411
  static createSchedule(data: $OpenApiTs['/w/{workspace}/schedules/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/create']['post']['res'][201]>;
1512
2412
  /**
1513
- * update schedule
1514
- * @returns string schedule updated
1515
- * @throws ApiError
1516
- */
2413
+ * update schedule
2414
+ * @param data The data for the request.
2415
+ * @param data.workspace
2416
+ * @param data.path
2417
+ * @param data.requestBody updated schedule
2418
+ * @returns string schedule updated
2419
+ * @throws ApiError
2420
+ */
1517
2421
  static updateSchedule(data: $OpenApiTs['/w/{workspace}/schedules/update/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/update/{path}']['post']['res'][200]>;
1518
2422
  /**
1519
- * set enabled schedule
1520
- * @returns string schedule enabled set
1521
- * @throws ApiError
1522
- */
2423
+ * set enabled schedule
2424
+ * @param data The data for the request.
2425
+ * @param data.workspace
2426
+ * @param data.path
2427
+ * @param data.requestBody updated schedule enable
2428
+ * @returns string schedule enabled set
2429
+ * @throws ApiError
2430
+ */
1523
2431
  static setScheduleEnabled(data: $OpenApiTs['/w/{workspace}/schedules/setenabled/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/setenabled/{path}']['post']['res'][200]>;
1524
2432
  /**
1525
- * delete schedule
1526
- * @returns string schedule deleted
1527
- * @throws ApiError
1528
- */
2433
+ * delete schedule
2434
+ * @param data The data for the request.
2435
+ * @param data.workspace
2436
+ * @param data.path
2437
+ * @returns string schedule deleted
2438
+ * @throws ApiError
2439
+ */
1529
2440
  static deleteSchedule(data: $OpenApiTs['/w/{workspace}/schedules/delete/{path}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/delete/{path}']['delete']['res'][200]>;
1530
2441
  /**
1531
- * get schedule
1532
- * @returns Schedule schedule deleted
1533
- * @throws ApiError
1534
- */
2442
+ * get schedule
2443
+ * @param data The data for the request.
2444
+ * @param data.workspace
2445
+ * @param data.path
2446
+ * @returns Schedule schedule deleted
2447
+ * @throws ApiError
2448
+ */
1535
2449
  static getSchedule(data: $OpenApiTs['/w/{workspace}/schedules/get/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/get/{path}']['get']['res'][200]>;
1536
2450
  /**
1537
- * does schedule exists
1538
- * @returns boolean schedule exists
1539
- * @throws ApiError
1540
- */
2451
+ * does schedule exists
2452
+ * @param data The data for the request.
2453
+ * @param data.workspace
2454
+ * @param data.path
2455
+ * @returns boolean schedule exists
2456
+ * @throws ApiError
2457
+ */
1541
2458
  static existsSchedule(data: $OpenApiTs['/w/{workspace}/schedules/exists/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/exists/{path}']['get']['res'][200]>;
1542
2459
  /**
1543
- * list schedules
1544
- * @returns Schedule schedule list
1545
- * @throws ApiError
1546
- */
2460
+ * list schedules
2461
+ * @param data The data for the request.
2462
+ * @param data.workspace
2463
+ * @param data.page which page to return (start at 1, default 1)
2464
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2465
+ * @param data.args filter on jobs containing those args as a json subset (@> in postgres)
2466
+ * @param data.path filter by path
2467
+ * @param data.isFlow
2468
+ * @returns Schedule schedule list
2469
+ * @throws ApiError
2470
+ */
1547
2471
  static listSchedules(data: $OpenApiTs['/w/{workspace}/schedules/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/list']['get']['res'][200]>;
1548
2472
  /**
1549
- * list schedules with last 20 jobs
1550
- * @returns ScheduleWJobs schedule list
1551
- * @throws ApiError
1552
- */
2473
+ * list schedules with last 20 jobs
2474
+ * @param data The data for the request.
2475
+ * @param data.workspace
2476
+ * @param data.page which page to return (start at 1, default 1)
2477
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2478
+ * @returns ScheduleWJobs schedule list
2479
+ * @throws ApiError
2480
+ */
1553
2481
  static listSchedulesWithJobs(data: $OpenApiTs['/w/{workspace}/schedules/list_with_jobs']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/list_with_jobs']['get']['res'][200]>;
1554
2482
  /**
1555
- * Set default error or recoevery handler
1556
- * @returns unknown default error handler set
1557
- * @throws ApiError
1558
- */
2483
+ * Set default error or recoevery handler
2484
+ * @param data The data for the request.
2485
+ * @param data.workspace
2486
+ * @param data.requestBody Handler description
2487
+ * @returns unknown default error handler set
2488
+ * @throws ApiError
2489
+ */
1559
2490
  static setDefaultErrorOrRecoveryHandler(data: $OpenApiTs['/w/{workspace}/schedules/setdefaulthandler']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/schedules/setdefaulthandler']['post']['res'][201]>;
1560
2491
  }
1561
2492
  export declare class GroupService {
1562
2493
  /**
1563
- * list instance groups
1564
- * @returns InstanceGroup instance group list
1565
- * @throws ApiError
1566
- */
2494
+ * list instance groups
2495
+ * @returns InstanceGroup instance group list
2496
+ * @throws ApiError
2497
+ */
1567
2498
  static listInstanceGroups(): CancelablePromise<$OpenApiTs['/groups/list']['get']['res'][200]>;
1568
2499
  /**
1569
- * get instance group
1570
- * @returns InstanceGroup instance group
1571
- * @throws ApiError
1572
- */
2500
+ * get instance group
2501
+ * @param data The data for the request.
2502
+ * @param data.name
2503
+ * @returns InstanceGroup instance group
2504
+ * @throws ApiError
2505
+ */
1573
2506
  static getInstanceGroup(data: $OpenApiTs['/groups/get/{name}']['get']['req']): CancelablePromise<$OpenApiTs['/groups/get/{name}']['get']['res'][200]>;
1574
2507
  /**
1575
- * create instance group
1576
- * @returns string instance group created
1577
- * @throws ApiError
1578
- */
2508
+ * create instance group
2509
+ * @param data The data for the request.
2510
+ * @param data.requestBody create instance group
2511
+ * @returns string instance group created
2512
+ * @throws ApiError
2513
+ */
1579
2514
  static createInstanceGroup(data: $OpenApiTs['/groups/create']['post']['req']): CancelablePromise<$OpenApiTs['/groups/create']['post']['res'][200]>;
1580
2515
  /**
1581
- * update instance group
1582
- * @returns string instance group updated
1583
- * @throws ApiError
1584
- */
2516
+ * update instance group
2517
+ * @param data The data for the request.
2518
+ * @param data.name
2519
+ * @param data.requestBody update instance group
2520
+ * @returns string instance group updated
2521
+ * @throws ApiError
2522
+ */
1585
2523
  static updateInstanceGroup(data: $OpenApiTs['/groups/update/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/groups/update/{name}']['post']['res'][200]>;
1586
2524
  /**
1587
- * delete instance group
1588
- * @returns string instance group deleted
1589
- * @throws ApiError
1590
- */
2525
+ * delete instance group
2526
+ * @param data The data for the request.
2527
+ * @param data.name
2528
+ * @returns string instance group deleted
2529
+ * @throws ApiError
2530
+ */
1591
2531
  static deleteInstanceGroup(data: $OpenApiTs['/groups/delete/{name}']['delete']['req']): CancelablePromise<$OpenApiTs['/groups/delete/{name}']['delete']['res'][200]>;
1592
2532
  /**
1593
- * add user to instance group
1594
- * @returns string user added to instance group
1595
- * @throws ApiError
1596
- */
2533
+ * add user to instance group
2534
+ * @param data The data for the request.
2535
+ * @param data.name
2536
+ * @param data.requestBody user to add to instance group
2537
+ * @returns string user added to instance group
2538
+ * @throws ApiError
2539
+ */
1597
2540
  static addUserToInstanceGroup(data: $OpenApiTs['/groups/adduser/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/groups/adduser/{name}']['post']['res'][200]>;
1598
2541
  /**
1599
- * remove user from instance group
1600
- * @returns string user removed from instance group
1601
- * @throws ApiError
1602
- */
2542
+ * remove user from instance group
2543
+ * @param data The data for the request.
2544
+ * @param data.name
2545
+ * @param data.requestBody user to remove from instance group
2546
+ * @returns string user removed from instance group
2547
+ * @throws ApiError
2548
+ */
1603
2549
  static removeUserFromInstanceGroup(data: $OpenApiTs['/groups/removeuser/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/groups/removeuser/{name}']['post']['res'][200]>;
1604
2550
  /**
1605
- * list groups
1606
- * @returns Group group list
1607
- * @throws ApiError
1608
- */
2551
+ * list groups
2552
+ * @param data The data for the request.
2553
+ * @param data.workspace
2554
+ * @param data.page which page to return (start at 1, default 1)
2555
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2556
+ * @returns Group group list
2557
+ * @throws ApiError
2558
+ */
1609
2559
  static listGroups(data: $OpenApiTs['/w/{workspace}/groups/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/list']['get']['res'][200]>;
1610
2560
  /**
1611
- * list group names
1612
- * @returns string group list
1613
- * @throws ApiError
1614
- */
2561
+ * list group names
2562
+ * @param data The data for the request.
2563
+ * @param data.workspace
2564
+ * @param data.onlyMemberOf only list the groups the user is member of (default false)
2565
+ * @returns string group list
2566
+ * @throws ApiError
2567
+ */
1615
2568
  static listGroupNames(data: $OpenApiTs['/w/{workspace}/groups/listnames']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/listnames']['get']['res'][200]>;
1616
2569
  /**
1617
- * create group
1618
- * @returns string group created
1619
- * @throws ApiError
1620
- */
2570
+ * create group
2571
+ * @param data The data for the request.
2572
+ * @param data.workspace
2573
+ * @param data.requestBody create group
2574
+ * @returns string group created
2575
+ * @throws ApiError
2576
+ */
1621
2577
  static createGroup(data: $OpenApiTs['/w/{workspace}/groups/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/create']['post']['res'][200]>;
1622
2578
  /**
1623
- * update group
1624
- * @returns string group updated
1625
- * @throws ApiError
1626
- */
2579
+ * update group
2580
+ * @param data The data for the request.
2581
+ * @param data.workspace
2582
+ * @param data.name
2583
+ * @param data.requestBody updated group
2584
+ * @returns string group updated
2585
+ * @throws ApiError
2586
+ */
1627
2587
  static updateGroup(data: $OpenApiTs['/w/{workspace}/groups/update/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/update/{name}']['post']['res'][200]>;
1628
2588
  /**
1629
- * delete group
1630
- * @returns string group deleted
1631
- * @throws ApiError
1632
- */
2589
+ * delete group
2590
+ * @param data The data for the request.
2591
+ * @param data.workspace
2592
+ * @param data.name
2593
+ * @returns string group deleted
2594
+ * @throws ApiError
2595
+ */
1633
2596
  static deleteGroup(data: $OpenApiTs['/w/{workspace}/groups/delete/{name}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/delete/{name}']['delete']['res'][200]>;
1634
2597
  /**
1635
- * get group
1636
- * @returns Group group
1637
- * @throws ApiError
1638
- */
2598
+ * get group
2599
+ * @param data The data for the request.
2600
+ * @param data.workspace
2601
+ * @param data.name
2602
+ * @returns Group group
2603
+ * @throws ApiError
2604
+ */
1639
2605
  static getGroup(data: $OpenApiTs['/w/{workspace}/groups/get/{name}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/get/{name}']['get']['res'][200]>;
1640
2606
  /**
1641
- * add user to group
1642
- * @returns string user added to group
1643
- * @throws ApiError
1644
- */
2607
+ * add user to group
2608
+ * @param data The data for the request.
2609
+ * @param data.workspace
2610
+ * @param data.name
2611
+ * @param data.requestBody added user to group
2612
+ * @returns string user added to group
2613
+ * @throws ApiError
2614
+ */
1645
2615
  static addUserToGroup(data: $OpenApiTs['/w/{workspace}/groups/adduser/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/adduser/{name}']['post']['res'][200]>;
1646
2616
  /**
1647
- * remove user to group
1648
- * @returns string user removed from group
1649
- * @throws ApiError
1650
- */
2617
+ * remove user to group
2618
+ * @param data The data for the request.
2619
+ * @param data.workspace
2620
+ * @param data.name
2621
+ * @param data.requestBody added user to group
2622
+ * @returns string user removed from group
2623
+ * @throws ApiError
2624
+ */
1651
2625
  static removeUserToGroup(data: $OpenApiTs['/w/{workspace}/groups/removeuser/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/groups/removeuser/{name}']['post']['res'][200]>;
1652
2626
  }
1653
2627
  export declare class FolderService {
1654
2628
  /**
1655
- * list folders
1656
- * @returns Folder folder list
1657
- * @throws ApiError
1658
- */
2629
+ * list folders
2630
+ * @param data The data for the request.
2631
+ * @param data.workspace
2632
+ * @param data.page which page to return (start at 1, default 1)
2633
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2634
+ * @returns Folder folder list
2635
+ * @throws ApiError
2636
+ */
1659
2637
  static listFolders(data: $OpenApiTs['/w/{workspace}/folders/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/list']['get']['res'][200]>;
1660
2638
  /**
1661
- * list folder names
1662
- * @returns string folder list
1663
- * @throws ApiError
1664
- */
2639
+ * list folder names
2640
+ * @param data The data for the request.
2641
+ * @param data.workspace
2642
+ * @param data.onlyMemberOf only list the folders the user is member of (default false)
2643
+ * @returns string folder list
2644
+ * @throws ApiError
2645
+ */
1665
2646
  static listFolderNames(data: $OpenApiTs['/w/{workspace}/folders/listnames']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/listnames']['get']['res'][200]>;
1666
2647
  /**
1667
- * create folder
1668
- * @returns string folder created
1669
- * @throws ApiError
1670
- */
2648
+ * create folder
2649
+ * @param data The data for the request.
2650
+ * @param data.workspace
2651
+ * @param data.requestBody create folder
2652
+ * @returns string folder created
2653
+ * @throws ApiError
2654
+ */
1671
2655
  static createFolder(data: $OpenApiTs['/w/{workspace}/folders/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/create']['post']['res'][200]>;
1672
2656
  /**
1673
- * update folder
1674
- * @returns string folder updated
1675
- * @throws ApiError
1676
- */
2657
+ * update folder
2658
+ * @param data The data for the request.
2659
+ * @param data.workspace
2660
+ * @param data.name
2661
+ * @param data.requestBody update folder
2662
+ * @returns string folder updated
2663
+ * @throws ApiError
2664
+ */
1677
2665
  static updateFolder(data: $OpenApiTs['/w/{workspace}/folders/update/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/update/{name}']['post']['res'][200]>;
1678
2666
  /**
1679
- * delete folder
1680
- * @returns string folder deleted
1681
- * @throws ApiError
1682
- */
2667
+ * delete folder
2668
+ * @param data The data for the request.
2669
+ * @param data.workspace
2670
+ * @param data.name
2671
+ * @returns string folder deleted
2672
+ * @throws ApiError
2673
+ */
1683
2674
  static deleteFolder(data: $OpenApiTs['/w/{workspace}/folders/delete/{name}']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/delete/{name}']['delete']['res'][200]>;
1684
2675
  /**
1685
- * get folder
1686
- * @returns Folder folder
1687
- * @throws ApiError
1688
- */
2676
+ * get folder
2677
+ * @param data The data for the request.
2678
+ * @param data.workspace
2679
+ * @param data.name
2680
+ * @returns Folder folder
2681
+ * @throws ApiError
2682
+ */
1689
2683
  static getFolder(data: $OpenApiTs['/w/{workspace}/folders/get/{name}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/get/{name}']['get']['res'][200]>;
1690
2684
  /**
1691
- * get folder usage
1692
- * @returns unknown folder
1693
- * @throws ApiError
1694
- */
2685
+ * get folder usage
2686
+ * @param data The data for the request.
2687
+ * @param data.workspace
2688
+ * @param data.name
2689
+ * @returns unknown folder
2690
+ * @throws ApiError
2691
+ */
1695
2692
  static getFolderUsage(data: $OpenApiTs['/w/{workspace}/folders/getusage/{name}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/getusage/{name}']['get']['res'][200]>;
1696
2693
  /**
1697
- * add owner to folder
1698
- * @returns string owner added to folder
1699
- * @throws ApiError
1700
- */
2694
+ * add owner to folder
2695
+ * @param data The data for the request.
2696
+ * @param data.workspace
2697
+ * @param data.name
2698
+ * @param data.requestBody owner user to folder
2699
+ * @returns string owner added to folder
2700
+ * @throws ApiError
2701
+ */
1701
2702
  static addOwnerToFolder(data: $OpenApiTs['/w/{workspace}/folders/addowner/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/addowner/{name}']['post']['res'][200]>;
1702
2703
  /**
1703
- * remove owner to folder
1704
- * @returns string owner removed from folder
1705
- * @throws ApiError
1706
- */
2704
+ * remove owner to folder
2705
+ * @param data The data for the request.
2706
+ * @param data.workspace
2707
+ * @param data.name
2708
+ * @param data.requestBody added owner to folder
2709
+ * @returns string owner removed from folder
2710
+ * @throws ApiError
2711
+ */
1707
2712
  static removeOwnerToFolder(data: $OpenApiTs['/w/{workspace}/folders/removeowner/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/folders/removeowner/{name}']['post']['res'][200]>;
1708
2713
  }
1709
2714
  export declare class ConfigService {
1710
2715
  /**
1711
- * list worker groups
1712
- * @returns unknown a list of worker group configs
1713
- * @throws ApiError
1714
- */
2716
+ * list worker groups
2717
+ * @returns unknown a list of worker group configs
2718
+ * @throws ApiError
2719
+ */
1715
2720
  static listWorkerGroups(): CancelablePromise<$OpenApiTs['/configs/list_worker_groups']['get']['res'][200]>;
1716
2721
  /**
1717
- * get config
1718
- * @returns unknown a config
1719
- * @throws ApiError
1720
- */
2722
+ * get config
2723
+ * @param data The data for the request.
2724
+ * @param data.name
2725
+ * @returns unknown a config
2726
+ * @throws ApiError
2727
+ */
1721
2728
  static getConfig(data: $OpenApiTs['/configs/get/{name}']['get']['req']): CancelablePromise<$OpenApiTs['/configs/get/{name}']['get']['res'][200]>;
1722
2729
  /**
1723
- * Update config
1724
- * @returns string Update a worker group
1725
- * @throws ApiError
1726
- */
2730
+ * Update config
2731
+ * @param data The data for the request.
2732
+ * @param data.name
2733
+ * @param data.requestBody worker group
2734
+ * @returns string Update a worker group
2735
+ * @throws ApiError
2736
+ */
1727
2737
  static updateConfig(data: $OpenApiTs['/configs/update/{name}']['post']['req']): CancelablePromise<$OpenApiTs['/configs/update/{name}']['post']['res'][200]>;
1728
2738
  /**
1729
- * Delete Config
1730
- * @returns string Delete config
1731
- * @throws ApiError
1732
- */
2739
+ * Delete Config
2740
+ * @param data The data for the request.
2741
+ * @param data.name
2742
+ * @returns string Delete config
2743
+ * @throws ApiError
2744
+ */
1733
2745
  static deleteConfig(data: $OpenApiTs['/configs/update/{name}']['delete']['req']): CancelablePromise<$OpenApiTs['/configs/update/{name}']['delete']['res'][200]>;
1734
2746
  }
1735
2747
  export declare class GranularAclService {
1736
2748
  /**
1737
- * get granular acls
1738
- * @returns boolean acls
1739
- * @throws ApiError
1740
- */
2749
+ * get granular acls
2750
+ * @param data The data for the request.
2751
+ * @param data.workspace
2752
+ * @param data.path
2753
+ * @param data.kind
2754
+ * @returns boolean acls
2755
+ * @throws ApiError
2756
+ */
1741
2757
  static getGranularAcls(data: $OpenApiTs['/w/{workspace}/acls/get/{kind}/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/acls/get/{kind}/{path}']['get']['res'][200]>;
1742
2758
  /**
1743
- * add granular acls
1744
- * @returns string granular acl added
1745
- * @throws ApiError
1746
- */
2759
+ * add granular acls
2760
+ * @param data The data for the request.
2761
+ * @param data.workspace
2762
+ * @param data.path
2763
+ * @param data.kind
2764
+ * @param data.requestBody acl to add
2765
+ * @returns string granular acl added
2766
+ * @throws ApiError
2767
+ */
1747
2768
  static addGranularAcls(data: $OpenApiTs['/w/{workspace}/acls/add/{kind}/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/acls/add/{kind}/{path}']['post']['res'][200]>;
1748
2769
  /**
1749
- * remove granular acls
1750
- * @returns string granular acl removed
1751
- * @throws ApiError
1752
- */
2770
+ * remove granular acls
2771
+ * @param data The data for the request.
2772
+ * @param data.workspace
2773
+ * @param data.path
2774
+ * @param data.kind
2775
+ * @param data.requestBody acl to add
2776
+ * @returns string granular acl removed
2777
+ * @throws ApiError
2778
+ */
1753
2779
  static removeGranularAcls(data: $OpenApiTs['/w/{workspace}/acls/remove/{kind}/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/acls/remove/{kind}/{path}']['post']['res'][200]>;
1754
2780
  }
1755
2781
  export declare class CaptureService {
1756
2782
  /**
1757
- * update flow preview capture
1758
- * @returns void flow preview captured
1759
- * @throws ApiError
1760
- */
2783
+ * update flow preview capture
2784
+ * @param data The data for the request.
2785
+ * @param data.workspace
2786
+ * @param data.path
2787
+ * @returns void flow preview captured
2788
+ * @throws ApiError
2789
+ */
1761
2790
  static updateCapture(data: $OpenApiTs['/w/{workspace}/capture_u/{path}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/capture_u/{path}']['post']['res'][204]>;
1762
2791
  /**
1763
- * create flow preview capture
1764
- * @returns unknown flow preview capture created
1765
- * @throws ApiError
1766
- */
2792
+ * create flow preview capture
2793
+ * @param data The data for the request.
2794
+ * @param data.workspace
2795
+ * @param data.path
2796
+ * @returns unknown flow preview capture created
2797
+ * @throws ApiError
2798
+ */
1767
2799
  static createCapture(data: $OpenApiTs['/w/{workspace}/capture/{path}']['put']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/capture/{path}']['put']['res'][201]>;
1768
2800
  /**
1769
- * get flow preview capture
1770
- * @returns unknown captured flow preview
1771
- * @throws ApiError
1772
- */
2801
+ * get flow preview capture
2802
+ * @param data The data for the request.
2803
+ * @param data.workspace
2804
+ * @param data.path
2805
+ * @returns unknown captured flow preview
2806
+ * @throws ApiError
2807
+ */
1773
2808
  static getCapture(data: $OpenApiTs['/w/{workspace}/capture/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/capture/{path}']['get']['res'][200]>;
1774
2809
  }
1775
2810
  export declare class FavoriteService {
1776
2811
  /**
1777
- * star item
1778
- * @returns unknown star item
1779
- * @throws ApiError
1780
- */
2812
+ * star item
2813
+ * @param data The data for the request.
2814
+ * @param data.workspace
2815
+ * @param data.requestBody
2816
+ * @returns unknown star item
2817
+ * @throws ApiError
2818
+ */
1781
2819
  static star(data: $OpenApiTs['/w/{workspace}/favorites/star']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/favorites/star']['post']['res'][200]>;
1782
2820
  /**
1783
- * unstar item
1784
- * @returns unknown unstar item
1785
- * @throws ApiError
1786
- */
2821
+ * unstar item
2822
+ * @param data The data for the request.
2823
+ * @param data.workspace
2824
+ * @param data.requestBody
2825
+ * @returns unknown unstar item
2826
+ * @throws ApiError
2827
+ */
1787
2828
  static unstar(data: $OpenApiTs['/w/{workspace}/favorites/unstar']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/favorites/unstar']['post']['res'][200]>;
1788
2829
  }
1789
2830
  export declare class InputService {
1790
2831
  /**
1791
- * List Inputs used in previously completed jobs
1792
- * @returns Input Input history for completed jobs
1793
- * @throws ApiError
1794
- */
2832
+ * List Inputs used in previously completed jobs
2833
+ * @param data The data for the request.
2834
+ * @param data.workspace
2835
+ * @param data.runnableId
2836
+ * @param data.runnableType
2837
+ * @param data.page which page to return (start at 1, default 1)
2838
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2839
+ * @returns Input Input history for completed jobs
2840
+ * @throws ApiError
2841
+ */
1795
2842
  static getInputHistory(data: $OpenApiTs['/w/{workspace}/inputs/history']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/inputs/history']['get']['res'][200]>;
1796
2843
  /**
1797
- * List saved Inputs for a Runnable
1798
- * @returns Input Saved Inputs for a Runnable
1799
- * @throws ApiError
1800
- */
2844
+ * List saved Inputs for a Runnable
2845
+ * @param data The data for the request.
2846
+ * @param data.workspace
2847
+ * @param data.runnableId
2848
+ * @param data.runnableType
2849
+ * @param data.page which page to return (start at 1, default 1)
2850
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
2851
+ * @returns Input Saved Inputs for a Runnable
2852
+ * @throws ApiError
2853
+ */
1801
2854
  static listInputs(data: $OpenApiTs['/w/{workspace}/inputs/list']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/inputs/list']['get']['res'][200]>;
1802
2855
  /**
1803
- * Create an Input for future use in a script or flow
1804
- * @returns string Input created
1805
- * @throws ApiError
1806
- */
2856
+ * Create an Input for future use in a script or flow
2857
+ * @param data The data for the request.
2858
+ * @param data.workspace
2859
+ * @param data.requestBody Input
2860
+ * @param data.runnableId
2861
+ * @param data.runnableType
2862
+ * @returns string Input created
2863
+ * @throws ApiError
2864
+ */
1807
2865
  static createInput(data: $OpenApiTs['/w/{workspace}/inputs/create']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/inputs/create']['post']['res'][201]>;
1808
2866
  /**
1809
- * Update an Input
1810
- * @returns string Input updated
1811
- * @throws ApiError
1812
- */
2867
+ * Update an Input
2868
+ * @param data The data for the request.
2869
+ * @param data.workspace
2870
+ * @param data.requestBody UpdateInput
2871
+ * @returns string Input updated
2872
+ * @throws ApiError
2873
+ */
1813
2874
  static updateInput(data: $OpenApiTs['/w/{workspace}/inputs/update']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/inputs/update']['post']['res'][201]>;
1814
2875
  /**
1815
- * Delete a Saved Input
1816
- * @returns string Input deleted
1817
- * @throws ApiError
1818
- */
2876
+ * Delete a Saved Input
2877
+ * @param data The data for the request.
2878
+ * @param data.workspace
2879
+ * @param data.input
2880
+ * @returns string Input deleted
2881
+ * @throws ApiError
2882
+ */
1819
2883
  static deleteInput(data: $OpenApiTs['/w/{workspace}/inputs/delete/{input}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/inputs/delete/{input}']['post']['res'][200]>;
1820
2884
  }
1821
2885
  export declare class HelpersService {
1822
2886
  /**
1823
- * Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
1824
- * @returns unknown Connection settings
1825
- * @throws ApiError
1826
- */
2887
+ * Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
2888
+ * @param data The data for the request.
2889
+ * @param data.workspace
2890
+ * @param data.requestBody S3 resource to connect to
2891
+ * @returns unknown Connection settings
2892
+ * @throws ApiError
2893
+ */
1827
2894
  static duckdbConnectionSettings(data: $OpenApiTs['/w/{workspace}/job_helpers/duckdb_connection_settings']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/duckdb_connection_settings']['post']['res'][200]>;
1828
2895
  /**
1829
- * Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
1830
- * @returns unknown Connection settings
1831
- * @throws ApiError
1832
- */
2896
+ * Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
2897
+ * @param data The data for the request.
2898
+ * @param data.workspace
2899
+ * @param data.requestBody S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
2900
+ * @returns unknown Connection settings
2901
+ * @throws ApiError
2902
+ */
1833
2903
  static duckdbConnectionSettingsV2(data: $OpenApiTs['/w/{workspace}/job_helpers/v2/duckdb_connection_settings']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/v2/duckdb_connection_settings']['post']['res'][200]>;
1834
2904
  /**
1835
- * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
1836
- * @returns unknown Connection settings
1837
- * @throws ApiError
1838
- */
2905
+ * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
2906
+ * @param data The data for the request.
2907
+ * @param data.workspace
2908
+ * @param data.requestBody S3 resource to connect to
2909
+ * @returns unknown Connection settings
2910
+ * @throws ApiError
2911
+ */
1839
2912
  static polarsConnectionSettings(data: $OpenApiTs['/w/{workspace}/job_helpers/polars_connection_settings']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/polars_connection_settings']['post']['res'][200]>;
1840
2913
  /**
1841
- * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
1842
- * @returns unknown Connection settings
1843
- * @throws ApiError
1844
- */
2914
+ * Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
2915
+ * @param data The data for the request.
2916
+ * @param data.workspace
2917
+ * @param data.requestBody S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
2918
+ * @returns unknown Connection settings
2919
+ * @throws ApiError
2920
+ */
1845
2921
  static polarsConnectionSettingsV2(data: $OpenApiTs['/w/{workspace}/job_helpers/v2/polars_connection_settings']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/v2/polars_connection_settings']['post']['res'][200]>;
1846
2922
  /**
1847
- * Returns the s3 resource associated to the provided path, or the workspace default S3 resource
1848
- * @returns S3Resource Connection settings
1849
- * @throws ApiError
1850
- */
2923
+ * Returns the s3 resource associated to the provided path, or the workspace default S3 resource
2924
+ * @param data The data for the request.
2925
+ * @param data.workspace
2926
+ * @param data.requestBody S3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used
2927
+ * @returns S3Resource Connection settings
2928
+ * @throws ApiError
2929
+ */
1851
2930
  static s3ResourceInfo(data: $OpenApiTs['/w/{workspace}/job_helpers/v2/s3_resource_info']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/v2/s3_resource_info']['post']['res'][200]>;
1852
2931
  /**
1853
- * Test connection to the workspace datasets storage
1854
- * @returns unknown Connection settings
1855
- * @throws ApiError
1856
- */
2932
+ * Test connection to the workspace datasets storage
2933
+ * @param data The data for the request.
2934
+ * @param data.workspace
2935
+ * @returns unknown Connection settings
2936
+ * @throws ApiError
2937
+ */
1857
2938
  static datasetStorageTestConnection(data: $OpenApiTs['/w/{workspace}/job_helpers/test_connection']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/test_connection']['get']['res'][200]>;
1858
2939
  /**
1859
- * List the file keys available in the workspace files storage (S3)
1860
- * @returns unknown List of file keys
1861
- * @throws ApiError
1862
- */
2940
+ * List the file keys available in the workspace files storage (S3)
2941
+ * @param data The data for the request.
2942
+ * @param data.workspace
2943
+ * @param data.maxKeys
2944
+ * @param data.marker
2945
+ * @param data.prefix
2946
+ * @returns unknown List of file keys
2947
+ * @throws ApiError
2948
+ */
1863
2949
  static listStoredFiles(data: $OpenApiTs['/w/{workspace}/job_helpers/list_stored_files']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/list_stored_files']['get']['res'][200]>;
1864
2950
  /**
1865
- * Load metadata of the file
1866
- * @returns WindmillFileMetadata FileMetadata
1867
- * @throws ApiError
1868
- */
2951
+ * Load metadata of the file
2952
+ * @param data The data for the request.
2953
+ * @param data.workspace
2954
+ * @param data.fileKey
2955
+ * @returns WindmillFileMetadata FileMetadata
2956
+ * @throws ApiError
2957
+ */
1869
2958
  static loadFileMetadata(data: $OpenApiTs['/w/{workspace}/job_helpers/load_file_metadata']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/load_file_metadata']['get']['res'][200]>;
1870
2959
  /**
1871
- * Load a preview of the file
1872
- * @returns WindmillFilePreview FilePreview
1873
- * @throws ApiError
1874
- */
2960
+ * Load a preview of the file
2961
+ * @param data The data for the request.
2962
+ * @param data.workspace
2963
+ * @param data.fileKey
2964
+ * @param data.fileSizeInBytes
2965
+ * @param data.fileMimeType
2966
+ * @param data.csvSeparator
2967
+ * @param data.csvHasHeader
2968
+ * @param data.readBytesFrom
2969
+ * @param data.readBytesLength
2970
+ * @returns WindmillFilePreview FilePreview
2971
+ * @throws ApiError
2972
+ */
1875
2973
  static loadFilePreview(data: $OpenApiTs['/w/{workspace}/job_helpers/load_file_preview']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/load_file_preview']['get']['res'][200]>;
1876
2974
  /**
1877
- * Load a preview of a parquet file
1878
- * @returns unknown Parquet Preview
1879
- * @throws ApiError
1880
- */
2975
+ * Load a preview of a parquet file
2976
+ * @param data The data for the request.
2977
+ * @param data.workspace
2978
+ * @param data.path
2979
+ * @param data.offset
2980
+ * @param data.limit
2981
+ * @param data.sortCol
2982
+ * @param data.sortDesc
2983
+ * @param data.searchCol
2984
+ * @param data.searchTerm
2985
+ * @returns unknown Parquet Preview
2986
+ * @throws ApiError
2987
+ */
1881
2988
  static loadParquetPreview(data: $OpenApiTs['/w/{workspace}/job_helpers/load_parquet_preview/{path}']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/load_parquet_preview/{path}']['get']['res'][200]>;
1882
2989
  /**
1883
- * Permanently delete file from S3
1884
- * @returns unknown Confirmation
1885
- * @throws ApiError
1886
- */
2990
+ * Permanently delete file from S3
2991
+ * @param data The data for the request.
2992
+ * @param data.workspace
2993
+ * @param data.fileKey
2994
+ * @returns unknown Confirmation
2995
+ * @throws ApiError
2996
+ */
1887
2997
  static deleteS3File(data: $OpenApiTs['/w/{workspace}/job_helpers/delete_s3_file']['delete']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/delete_s3_file']['delete']['res'][200]>;
1888
2998
  /**
1889
- * Move a S3 file from one path to the other within the same bucket
1890
- * @returns unknown Confirmation
1891
- * @throws ApiError
1892
- */
2999
+ * Move a S3 file from one path to the other within the same bucket
3000
+ * @param data The data for the request.
3001
+ * @param data.workspace
3002
+ * @param data.srcFileKey
3003
+ * @param data.destFileKey
3004
+ * @returns unknown Confirmation
3005
+ * @throws ApiError
3006
+ */
1893
3007
  static moveS3File(data: $OpenApiTs['/w/{workspace}/job_helpers/move_s3_file']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/move_s3_file']['get']['res'][200]>;
1894
3008
  /**
1895
- * Upload file to S3 bucket
1896
- * @returns unknown File upload status
1897
- * @throws ApiError
1898
- */
3009
+ * Upload file to S3 bucket
3010
+ * @param data The data for the request.
3011
+ * @param data.workspace
3012
+ * @param data.requestBody File content
3013
+ * @param data.fileKey
3014
+ * @param data.fileExtension
3015
+ * @param data.s3ResourcePath
3016
+ * @param data.resourceType
3017
+ * @returns unknown File upload status
3018
+ * @throws ApiError
3019
+ */
1899
3020
  static fileUpload(data: $OpenApiTs['/w/{workspace}/job_helpers/upload_s3_file']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/upload_s3_file']['post']['res'][200]>;
1900
3021
  /**
1901
- * Download file to S3 bucket
1902
- * @returns binary Chunk of the downloaded file
1903
- * @throws ApiError
1904
- */
3022
+ * Download file to S3 bucket
3023
+ * @param data The data for the request.
3024
+ * @param data.workspace
3025
+ * @param data.fileKey
3026
+ * @param data.s3ResourcePath
3027
+ * @param data.resourceType
3028
+ * @returns binary Chunk of the downloaded file
3029
+ * @throws ApiError
3030
+ */
1905
3031
  static fileDownload(data: $OpenApiTs['/w/{workspace}/job_helpers/download_s3_file']['get']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_helpers/download_s3_file']['get']['res'][200]>;
1906
3032
  }
1907
3033
  export declare class MetricsService {
1908
3034
  /**
1909
- * get job metrics
1910
- * @returns unknown job details
1911
- * @throws ApiError
1912
- */
3035
+ * get job metrics
3036
+ * @param data The data for the request.
3037
+ * @param data.workspace
3038
+ * @param data.id
3039
+ * @param data.requestBody parameters for statistics retrieval
3040
+ * @returns unknown job details
3041
+ * @throws ApiError
3042
+ */
1913
3043
  static getJobMetrics(data: $OpenApiTs['/w/{workspace}/job_metrics/get/{id}']['post']['req']): CancelablePromise<$OpenApiTs['/w/{workspace}/job_metrics/get/{id}']['post']['res'][200]>;
1914
3044
  }
1915
3045
  export declare class ConcurrencyGroupsService {
1916
3046
  /**
1917
- * List all concurrency groups
1918
- * @returns ConcurrencyGroup all concurrency groups
1919
- * @throws ApiError
1920
- */
3047
+ * List all concurrency groups
3048
+ * @returns ConcurrencyGroup all concurrency groups
3049
+ * @throws ApiError
3050
+ */
1921
3051
  static listConcurrencyGroups(): CancelablePromise<$OpenApiTs['/concurrency_groups/list']['get']['res'][200]>;
1922
3052
  /**
1923
- * Delete concurrency group
1924
- * @returns unknown concurrency group removed
1925
- * @throws ApiError
1926
- */
3053
+ * Delete concurrency group
3054
+ * @param data The data for the request.
3055
+ * @param data.concurrencyId
3056
+ * @returns unknown concurrency group removed
3057
+ * @throws ApiError
3058
+ */
1927
3059
  static deleteConcurrencyGroup(data: $OpenApiTs['/concurrency_groups/{concurrency_id}']['delete']['req']): CancelablePromise<$OpenApiTs['/concurrency_groups/{concurrency_id}']['delete']['res'][200]>;
1928
3060
  }