windmill-client 1.323.5 → 1.324.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.
@@ -41,6 +41,7 @@ export type Script = {
41
41
  delete_after_use?: boolean;
42
42
  visible_to_runner_only?: boolean;
43
43
  no_main_func: boolean;
44
+ codebase?: string;
44
45
  };
45
46
  export type NewScript = {
46
47
  path: string;
@@ -71,6 +72,7 @@ export type NewScript = {
71
72
  concurrency_key?: string;
72
73
  visible_to_runner_only?: boolean;
73
74
  no_main_func?: boolean;
75
+ codebase?: string;
74
76
  };
75
77
  export type NewScriptWithDraft = NewScript & {
76
78
  draft?: NewScript;
@@ -886,161 +888,3310 @@ export type FlowStatusModule = {
886
888
  approver: string;
887
889
  }>;
888
890
  };
889
- export type Key = string;
890
- export type WorkspaceId = string;
891
- export type VersionId = number;
892
- export type Token = string;
893
- export type AccountId = number;
894
- export type ClientName = string;
895
- export type ScriptPath = string;
896
- export type ScriptHash = string;
897
- export type JobId = string;
898
- export type Path = string;
899
- export type PathId = number;
900
- export type PathVersion = number;
901
- export type Name = string;
891
+ export type ParameterKey = string;
892
+ export type ParameterWorkspaceId = string;
893
+ export type ParameterVersionId = number;
894
+ export type ParameterToken = string;
895
+ export type ParameterAccountId = number;
896
+ export type ParameterClientName = string;
897
+ export type ParameterScriptPath = string;
898
+ export type ParameterScriptHash = string;
899
+ export type ParameterJobId = string;
900
+ export type ParameterPath = string;
901
+ export type ParameterPathId = number;
902
+ export type ParameterPathVersion = number;
903
+ export type ParameterName = string;
902
904
  /**
903
905
  * which page to return (start at 1, default 1)
904
906
  */
905
- export type Page = number;
907
+ export type ParameterPage = number;
906
908
  /**
907
909
  * number of items to return for a given page (default 30, max 100)
908
910
  */
909
- export type PerPage = number;
911
+ export type ParameterPerPage = number;
910
912
  /**
911
913
  * order by desc order (default true)
912
914
  */
913
- export type OrderDesc = boolean;
915
+ export type ParameterOrderDesc = boolean;
914
916
  /**
915
917
  * mask to filter exact matching user creator
916
918
  */
917
- export type CreatedBy = string;
919
+ export type ParameterCreatedBy = string;
918
920
  /**
919
921
  * mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
920
922
  */
921
- export type Label = string;
923
+ export type ParameterLabel = string;
922
924
  /**
923
925
  * The parent job that is at the origin and responsible for the execution of this script if any
924
926
  */
925
- export type ParentJob = string;
927
+ export type ParameterParentJob = string;
926
928
  /**
927
929
  * Override the tag to use
928
930
  */
929
- export type WorkerTag = string;
931
+ export type ParameterWorkerTag = string;
930
932
  /**
931
933
  * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
932
934
  */
933
- export type CacheTtl = string;
935
+ export type ParameterCacheTtl = string;
934
936
  /**
935
937
  * 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)
936
938
  */
937
- export type NewJobId = string;
939
+ export type ParameterNewJobId = string;
938
940
  /**
939
941
  * List of headers's keys (separated with ',') whove value are added to the args
940
942
  * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
941
943
  *
942
944
  */
943
- export type IncludeHeader = string;
945
+ export type ParameterIncludeHeader = string;
944
946
  /**
945
947
  * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
946
948
  *
947
949
  */
948
- export type QueueLimit = string;
950
+ export type ParameterQueueLimit = string;
949
951
  /**
950
952
  * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
951
953
  * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
952
954
  *
953
955
  */
954
- export type Payload = string;
956
+ export type ParameterPayload = string;
955
957
  /**
956
958
  * mask to filter matching starting path
957
959
  */
958
- export type ScriptStartPath = string;
960
+ export type ParameterScriptStartPath = string;
959
961
  /**
960
962
  * mask to filter by schedule path
961
963
  */
962
- export type SchedulePath = string;
964
+ export type ParameterSchedulePath = string;
963
965
  /**
964
966
  * mask to filter exact matching path
965
967
  */
966
- export type ScriptExactPath = string;
968
+ export type ParameterScriptExactPath = string;
967
969
  /**
968
970
  * mask to filter exact matching path
969
971
  */
970
- export type ScriptExactHash = string;
972
+ export type ParameterScriptExactHash = string;
971
973
  /**
972
974
  * filter on started before (inclusive) timestamp
973
975
  */
974
- export type StartedBefore = string;
976
+ export type ParameterStartedBefore = string;
975
977
  /**
976
978
  * filter on started after (exclusive) timestamp
977
979
  */
978
- export type StartedAfter = string;
980
+ export type ParameterStartedAfter = string;
979
981
  /**
980
982
  * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
981
983
  */
982
- export type CreatedOrStartedAfter = string;
984
+ export type ParameterCreatedOrStartedAfter = string;
983
985
  /**
984
986
  * filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
985
987
  */
986
- export type CreatedOrStartedBefore = string;
988
+ export type ParameterCreatedOrStartedBefore = string;
987
989
  /**
988
990
  * filter on successful jobs
989
991
  */
990
- export type Success = boolean;
992
+ export type ParameterSuccess = boolean;
991
993
  /**
992
994
  * filter on jobs scheduled_for before now (hence waitinf for a worker)
993
995
  */
994
- export type ScheduledForBeforeNow = boolean;
996
+ export type ParameterScheduledForBeforeNow = boolean;
995
997
  /**
996
998
  * filter on suspended jobs
997
999
  */
998
- export type Suspended = boolean;
1000
+ export type ParameterSuspended = boolean;
999
1001
  /**
1000
1002
  * filter on running jobs
1001
1003
  */
1002
- export type Running = boolean;
1004
+ export type ParameterRunning = boolean;
1003
1005
  /**
1004
1006
  * filter on jobs containing those args as a json subset (@> in postgres)
1005
1007
  */
1006
- export type ArgsFilter = string;
1008
+ export type ParameterArgsFilter = string;
1007
1009
  /**
1008
1010
  * filter on jobs with a given tag/worker group
1009
1011
  */
1010
- export type Tag = string;
1012
+ export type ParameterTag = string;
1011
1013
  /**
1012
1014
  * filter on jobs containing those result as a json subset (@> in postgres)
1013
1015
  */
1014
- export type ResultFilter = string;
1016
+ export type ParameterResultFilter = string;
1015
1017
  /**
1016
1018
  * filter on created after (exclusive) timestamp
1017
1019
  */
1018
- export type After = string;
1020
+ export type ParameterAfter = string;
1019
1021
  /**
1020
1022
  * filter on created before (exclusive) timestamp
1021
1023
  */
1022
- export type Before = string;
1024
+ export type ParameterBefore = string;
1023
1025
  /**
1024
1026
  * filter on exact username of user
1025
1027
  */
1026
- export type Username = string;
1028
+ export type ParameterUsername = string;
1027
1029
  /**
1028
1030
  * filter on exact or prefix name of operation
1029
1031
  */
1030
- export type Operation = string;
1032
+ export type ParameterOperation = string;
1031
1033
  /**
1032
1034
  * filter on exact or prefix name of resource
1033
1035
  */
1034
- export type ResourceName = string;
1036
+ export type ParameterResourceName = string;
1037
+ /**
1038
+ * filter on type of operation
1039
+ */
1040
+ export type ParameterActionKind = 'Create' | 'Update' | 'Delete' | 'Execute';
1035
1041
  /**
1036
1042
  * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
1037
1043
  */
1038
- export type JobKinds = string;
1039
- export type RunnableId = string;
1040
- export type RunnableTypeQuery = RunnableType;
1041
- export type InputId = string;
1042
- export type GetStarted = boolean;
1043
- export type ConcurrencyId = string;
1044
+ export type ParameterJobKinds = string;
1045
+ export type ParameterRunnableId = string;
1046
+ export type ParameterRunnableTypeQuery = RunnableType;
1047
+ export type ParameterInputId = string;
1048
+ export type ParameterGetStarted = boolean;
1049
+ export type ParameterConcurrencyId = string;
1050
+ export type BackendVersionResponse = string;
1051
+ export type BackendUptodateResponse = string;
1052
+ export type GetLicenseIdResponse = string;
1053
+ export type GetOpenApiYamlResponse = string;
1054
+ export type GetAuditLogData = {
1055
+ id: number;
1056
+ workspace: string;
1057
+ };
1058
+ export type GetAuditLogResponse = AuditLog;
1059
+ export type ListAuditLogsData = {
1060
+ /**
1061
+ * filter on type of operation
1062
+ */
1063
+ actionKind?: 'Create' | 'Update' | 'Delete' | 'Execute';
1064
+ /**
1065
+ * filter on created after (exclusive) timestamp
1066
+ */
1067
+ after?: string;
1068
+ /**
1069
+ * filter on created before (exclusive) timestamp
1070
+ */
1071
+ before?: string;
1072
+ /**
1073
+ * filter on exact or prefix name of operation
1074
+ */
1075
+ operation?: string;
1076
+ /**
1077
+ * which page to return (start at 1, default 1)
1078
+ */
1079
+ page?: number;
1080
+ /**
1081
+ * number of items to return for a given page (default 30, max 100)
1082
+ */
1083
+ perPage?: number;
1084
+ /**
1085
+ * filter on exact or prefix name of resource
1086
+ */
1087
+ resource?: string;
1088
+ /**
1089
+ * filter on exact username of user
1090
+ */
1091
+ username?: string;
1092
+ workspace: string;
1093
+ };
1094
+ export type ListAuditLogsResponse = Array<AuditLog>;
1095
+ export type LoginData = {
1096
+ /**
1097
+ * credentials
1098
+ */
1099
+ requestBody: Login;
1100
+ };
1101
+ export type LoginResponse = string;
1102
+ export type LogoutResponse = string;
1103
+ export type GetUserData = {
1104
+ username: string;
1105
+ workspace: string;
1106
+ };
1107
+ export type GetUserResponse = User;
1108
+ export type UpdateUserData = {
1109
+ /**
1110
+ * new user
1111
+ */
1112
+ requestBody: EditWorkspaceUser;
1113
+ username: string;
1114
+ workspace: string;
1115
+ };
1116
+ export type UpdateUserResponse = string;
1117
+ export type IsOwnerOfPathData = {
1118
+ path: string;
1119
+ workspace: string;
1120
+ };
1121
+ export type IsOwnerOfPathResponse = boolean;
1122
+ export type SetPasswordData = {
1123
+ /**
1124
+ * set password
1125
+ */
1126
+ requestBody: {
1127
+ password: string;
1128
+ };
1129
+ };
1130
+ export type SetPasswordResponse = string;
1131
+ export type CreateUserGloballyData = {
1132
+ /**
1133
+ * user info
1134
+ */
1135
+ requestBody: {
1136
+ email: string;
1137
+ password: string;
1138
+ super_admin: boolean;
1139
+ name?: string;
1140
+ company?: string;
1141
+ };
1142
+ };
1143
+ export type CreateUserGloballyResponse = string;
1144
+ export type GlobalUserUpdateData = {
1145
+ email: string;
1146
+ /**
1147
+ * new user info
1148
+ */
1149
+ requestBody: {
1150
+ is_super_admin?: boolean;
1151
+ };
1152
+ };
1153
+ export type GlobalUserUpdateResponse = string;
1154
+ export type GlobalUsernameInfoData = {
1155
+ email: string;
1156
+ };
1157
+ export type GlobalUsernameInfoResponse = {
1158
+ username: string;
1159
+ workspace_usernames: Array<{
1160
+ workspace_id: string;
1161
+ username: string;
1162
+ }>;
1163
+ };
1164
+ export type GlobalUserRenameData = {
1165
+ email: string;
1166
+ /**
1167
+ * new username
1168
+ */
1169
+ requestBody: {
1170
+ new_username: string;
1171
+ };
1172
+ };
1173
+ export type GlobalUserRenameResponse = string;
1174
+ export type GlobalUserDeleteData = {
1175
+ email: string;
1176
+ };
1177
+ export type GlobalUserDeleteResponse = string;
1178
+ export type DeleteUserData = {
1179
+ username: string;
1180
+ workspace: string;
1181
+ };
1182
+ export type DeleteUserResponse = string;
1183
+ export type GetCurrentEmailResponse = string;
1184
+ export type RefreshUserTokenResponse = string;
1185
+ export type GetTutorialProgressResponse = {
1186
+ progress?: number;
1187
+ };
1188
+ export type UpdateTutorialProgressData = {
1189
+ /**
1190
+ * progress update
1191
+ */
1192
+ requestBody: {
1193
+ progress?: number;
1194
+ };
1195
+ };
1196
+ export type UpdateTutorialProgressResponse = string;
1197
+ export type LeaveInstanceResponse = string;
1198
+ export type GetUsageResponse = number;
1199
+ export type GetRunnableResponse = {
1200
+ workspace: string;
1201
+ endpoint_async: string;
1202
+ endpoint_sync: string;
1203
+ endpoint_openai_sync: string;
1204
+ summary: string;
1205
+ description?: string;
1206
+ kind: string;
1207
+ };
1208
+ export type GlobalWhoamiResponse = GlobalUserInfo;
1209
+ export type ListWorkspaceInvitesResponse = Array<WorkspaceInvite>;
1210
+ export type WhoamiData = {
1211
+ workspace: string;
1212
+ };
1213
+ export type WhoamiResponse = User;
1214
+ export type AcceptInviteData = {
1215
+ /**
1216
+ * accept invite
1217
+ */
1218
+ requestBody: {
1219
+ workspace_id: string;
1220
+ username?: string;
1221
+ };
1222
+ };
1223
+ export type AcceptInviteResponse = string;
1224
+ export type DeclineInviteData = {
1225
+ /**
1226
+ * decline invite
1227
+ */
1228
+ requestBody: {
1229
+ workspace_id: string;
1230
+ };
1231
+ };
1232
+ export type DeclineInviteResponse = string;
1233
+ export type WhoisData = {
1234
+ username: string;
1235
+ workspace: string;
1236
+ };
1237
+ export type WhoisResponse = User;
1238
+ export type ExistsEmailData = {
1239
+ email: string;
1240
+ };
1241
+ export type ExistsEmailResponse = boolean;
1242
+ export type ListUsersAsSuperAdminData = {
1243
+ /**
1244
+ * which page to return (start at 1, default 1)
1245
+ */
1246
+ page?: number;
1247
+ /**
1248
+ * number of items to return for a given page (default 30, max 100)
1249
+ */
1250
+ perPage?: number;
1251
+ };
1252
+ export type ListUsersAsSuperAdminResponse = Array<GlobalUserInfo>;
1253
+ export type ListUsersData = {
1254
+ workspace: string;
1255
+ };
1256
+ export type ListUsersResponse = Array<User>;
1257
+ export type ListUsersUsageData = {
1258
+ workspace: string;
1259
+ };
1260
+ export type ListUsersUsageResponse = Array<UserUsage>;
1261
+ export type ListUsernamesData = {
1262
+ workspace: string;
1263
+ };
1264
+ export type ListUsernamesResponse = Array<(string)>;
1265
+ export type CreateTokenData = {
1266
+ /**
1267
+ * new token
1268
+ */
1269
+ requestBody: NewToken;
1270
+ };
1271
+ export type CreateTokenResponse = string;
1272
+ export type CreateTokenImpersonateData = {
1273
+ /**
1274
+ * new token
1275
+ */
1276
+ requestBody: NewTokenImpersonate;
1277
+ };
1278
+ export type CreateTokenImpersonateResponse = string;
1279
+ export type DeleteTokenData = {
1280
+ tokenPrefix: string;
1281
+ };
1282
+ export type DeleteTokenResponse = string;
1283
+ export type ListTokensData = {
1284
+ excludeEphemeral?: boolean;
1285
+ };
1286
+ export type ListTokensResponse = Array<TruncatedToken>;
1287
+ export type LoginWithOauthData = {
1288
+ clientName: string;
1289
+ /**
1290
+ * Partially filled script
1291
+ */
1292
+ requestBody: {
1293
+ code?: string;
1294
+ state?: string;
1295
+ };
1296
+ };
1297
+ export type LoginWithOauthResponse = string;
1298
+ export type ListWorkspacesResponse = Array<Workspace>;
1299
+ export type IsDomainAllowedResponse = boolean;
1300
+ export type ListUserWorkspacesResponse = UserWorkspaceList;
1301
+ export type ListWorkspacesAsSuperAdminData = {
1302
+ /**
1303
+ * which page to return (start at 1, default 1)
1304
+ */
1305
+ page?: number;
1306
+ /**
1307
+ * number of items to return for a given page (default 30, max 100)
1308
+ */
1309
+ perPage?: number;
1310
+ };
1311
+ export type ListWorkspacesAsSuperAdminResponse = Array<Workspace>;
1312
+ export type CreateWorkspaceData = {
1313
+ /**
1314
+ * new token
1315
+ */
1316
+ requestBody: CreateWorkspace;
1317
+ };
1318
+ export type CreateWorkspaceResponse = string;
1319
+ export type ExistsWorkspaceData = {
1320
+ /**
1321
+ * id of workspace
1322
+ */
1323
+ requestBody: {
1324
+ id: string;
1325
+ };
1326
+ };
1327
+ export type ExistsWorkspaceResponse = boolean;
1328
+ export type ExistsUsernameData = {
1329
+ requestBody: {
1330
+ id: string;
1331
+ username: string;
1332
+ };
1333
+ };
1334
+ export type ExistsUsernameResponse = boolean;
1335
+ export type InviteUserData = {
1336
+ /**
1337
+ * WorkspaceInvite
1338
+ */
1339
+ requestBody: {
1340
+ email: string;
1341
+ is_admin: boolean;
1342
+ operator: boolean;
1343
+ };
1344
+ workspace: string;
1345
+ };
1346
+ export type InviteUserResponse = string;
1347
+ export type AddUserData = {
1348
+ /**
1349
+ * WorkspaceInvite
1350
+ */
1351
+ requestBody: {
1352
+ email: string;
1353
+ is_admin: boolean;
1354
+ username?: string;
1355
+ operator: boolean;
1356
+ };
1357
+ workspace: string;
1358
+ };
1359
+ export type AddUserResponse = string;
1360
+ export type DeleteInviteData = {
1361
+ /**
1362
+ * WorkspaceInvite
1363
+ */
1364
+ requestBody: {
1365
+ email: string;
1366
+ is_admin: boolean;
1367
+ operator: boolean;
1368
+ };
1369
+ workspace: string;
1370
+ };
1371
+ export type DeleteInviteResponse = string;
1372
+ export type ArchiveWorkspaceData = {
1373
+ workspace: string;
1374
+ };
1375
+ export type ArchiveWorkspaceResponse = string;
1376
+ export type UnarchiveWorkspaceData = {
1377
+ workspace: string;
1378
+ };
1379
+ export type UnarchiveWorkspaceResponse = string;
1380
+ export type DeleteWorkspaceData = {
1381
+ workspace: string;
1382
+ };
1383
+ export type DeleteWorkspaceResponse = string;
1384
+ export type LeaveWorkspaceData = {
1385
+ workspace: string;
1386
+ };
1387
+ export type LeaveWorkspaceResponse = string;
1388
+ export type GetWorkspaceNameData = {
1389
+ workspace: string;
1390
+ };
1391
+ export type GetWorkspaceNameResponse = string;
1392
+ export type ChangeWorkspaceNameData = {
1393
+ requestBody?: {
1394
+ new_name?: string;
1395
+ };
1396
+ workspace: string;
1397
+ };
1398
+ export type ChangeWorkspaceNameResponse = string;
1399
+ export type ChangeWorkspaceIdData = {
1400
+ requestBody?: {
1401
+ new_id?: string;
1402
+ new_name?: string;
1403
+ };
1404
+ workspace: string;
1405
+ };
1406
+ export type ChangeWorkspaceIdResponse = string;
1407
+ export type ListPendingInvitesData = {
1408
+ workspace: string;
1409
+ };
1410
+ export type ListPendingInvitesResponse = Array<WorkspaceInvite>;
1411
+ export type GetSettingsData = {
1412
+ workspace: string;
1413
+ };
1414
+ export type GetSettingsResponse = {
1415
+ workspace_id?: string;
1416
+ slack_name?: string;
1417
+ slack_team_id?: string;
1418
+ slack_command_script?: string;
1419
+ auto_invite_domain?: string;
1420
+ auto_invite_operator?: boolean;
1421
+ auto_add?: boolean;
1422
+ plan?: string;
1423
+ automatic_billing: boolean;
1424
+ customer_id?: string;
1425
+ webhook?: string;
1426
+ deploy_to?: string;
1427
+ openai_resource_path?: string;
1428
+ code_completion_enabled: boolean;
1429
+ error_handler?: string;
1430
+ error_handler_extra_args?: ScriptArgs;
1431
+ error_handler_muted_on_cancel: boolean;
1432
+ large_file_storage?: LargeFileStorage;
1433
+ git_sync?: WorkspaceGitSyncSettings;
1434
+ default_app?: string;
1435
+ default_scripts?: WorkspaceDefaultScripts;
1436
+ };
1437
+ export type GetDeployToData = {
1438
+ workspace: string;
1439
+ };
1440
+ export type GetDeployToResponse = {
1441
+ deploy_to?: string;
1442
+ };
1443
+ export type GetIsPremiumData = {
1444
+ workspace: string;
1445
+ };
1446
+ export type GetIsPremiumResponse = boolean;
1447
+ export type GetPremiumInfoData = {
1448
+ workspace: string;
1449
+ };
1450
+ export type GetPremiumInfoResponse = {
1451
+ premium: boolean;
1452
+ usage?: number;
1453
+ seats?: number;
1454
+ automatic_billing: boolean;
1455
+ };
1456
+ export type SetAutomaticBillingData = {
1457
+ /**
1458
+ * automatic billing
1459
+ */
1460
+ requestBody: {
1461
+ automatic_billing: boolean;
1462
+ seats?: number;
1463
+ };
1464
+ workspace: string;
1465
+ };
1466
+ export type SetAutomaticBillingResponse = string;
1467
+ export type EditSlackCommandData = {
1468
+ /**
1469
+ * WorkspaceInvite
1470
+ */
1471
+ requestBody: {
1472
+ slack_command_script?: string;
1473
+ };
1474
+ workspace: string;
1475
+ };
1476
+ export type EditSlackCommandResponse = string;
1477
+ export type RunSlackMessageTestJobData = {
1478
+ /**
1479
+ * path to hub script to run and its corresponding args
1480
+ */
1481
+ requestBody: {
1482
+ hub_script_path?: string;
1483
+ channel?: string;
1484
+ test_msg?: string;
1485
+ };
1486
+ workspace: string;
1487
+ };
1488
+ export type RunSlackMessageTestJobResponse = {
1489
+ job_uuid?: string;
1490
+ };
1491
+ export type EditDeployToData = {
1492
+ requestBody: {
1493
+ deploy_to?: string;
1494
+ };
1495
+ workspace: string;
1496
+ };
1497
+ export type EditDeployToResponse = string;
1498
+ export type EditAutoInviteData = {
1499
+ /**
1500
+ * WorkspaceInvite
1501
+ */
1502
+ requestBody: {
1503
+ operator?: boolean;
1504
+ invite_all?: boolean;
1505
+ auto_add?: boolean;
1506
+ };
1507
+ workspace: string;
1508
+ };
1509
+ export type EditAutoInviteResponse = string;
1510
+ export type EditWebhookData = {
1511
+ /**
1512
+ * WorkspaceWebhook
1513
+ */
1514
+ requestBody: {
1515
+ webhook?: string;
1516
+ };
1517
+ workspace: string;
1518
+ };
1519
+ export type EditWebhookResponse = string;
1520
+ export type EditCopilotConfigData = {
1521
+ /**
1522
+ * WorkspaceCopilotConfig
1523
+ */
1524
+ requestBody: {
1525
+ openai_resource_path?: string;
1526
+ code_completion_enabled: boolean;
1527
+ };
1528
+ workspace: string;
1529
+ };
1530
+ export type EditCopilotConfigResponse = string;
1531
+ export type GetCopilotInfoData = {
1532
+ workspace: string;
1533
+ };
1534
+ export type GetCopilotInfoResponse = {
1535
+ exists_openai_resource_path: boolean;
1536
+ code_completion_enabled: boolean;
1537
+ };
1538
+ export type EditErrorHandlerData = {
1539
+ /**
1540
+ * WorkspaceErrorHandler
1541
+ */
1542
+ requestBody: {
1543
+ error_handler?: string;
1544
+ error_handler_extra_args?: ScriptArgs;
1545
+ error_handler_muted_on_cancel?: boolean;
1546
+ };
1547
+ workspace: string;
1548
+ };
1549
+ export type EditErrorHandlerResponse = string;
1550
+ export type EditLargeFileStorageConfigData = {
1551
+ /**
1552
+ * LargeFileStorage info
1553
+ */
1554
+ requestBody: {
1555
+ large_file_storage?: LargeFileStorage;
1556
+ };
1557
+ workspace: string;
1558
+ };
1559
+ export type EditLargeFileStorageConfigResponse = unknown;
1560
+ export type EditWorkspaceGitSyncConfigData = {
1561
+ /**
1562
+ * Workspace Git sync settings
1563
+ */
1564
+ requestBody: {
1565
+ git_sync_settings?: WorkspaceGitSyncSettings;
1566
+ };
1567
+ workspace: string;
1568
+ };
1569
+ export type EditWorkspaceGitSyncConfigResponse = unknown;
1570
+ export type EditWorkspaceDefaultAppData = {
1571
+ /**
1572
+ * Workspace default app
1573
+ */
1574
+ requestBody: {
1575
+ default_app_path?: string;
1576
+ };
1577
+ workspace: string;
1578
+ };
1579
+ export type EditWorkspaceDefaultAppResponse = string;
1580
+ export type EditDefaultScriptsData = {
1581
+ /**
1582
+ * Workspace default app
1583
+ */
1584
+ requestBody?: WorkspaceDefaultScripts;
1585
+ workspace: string;
1586
+ };
1587
+ export type EditDefaultScriptsResponse = string;
1588
+ export type GetDefaultScriptsData = {
1589
+ workspace: string;
1590
+ };
1591
+ export type GetDefaultScriptsResponse = WorkspaceDefaultScripts;
1592
+ export type SetEnvironmentVariableData = {
1593
+ /**
1594
+ * Workspace default app
1595
+ */
1596
+ requestBody: {
1597
+ name: string;
1598
+ value?: string;
1599
+ };
1600
+ workspace: string;
1601
+ };
1602
+ export type SetEnvironmentVariableResponse = string;
1603
+ export type GetWorkspaceEncryptionKeyData = {
1604
+ workspace: string;
1605
+ };
1606
+ export type GetWorkspaceEncryptionKeyResponse = {
1607
+ key: string;
1608
+ };
1609
+ export type SetWorkspaceEncryptionKeyData = {
1610
+ /**
1611
+ * New encryption key
1612
+ */
1613
+ requestBody: {
1614
+ new_key: string;
1615
+ };
1616
+ workspace: string;
1617
+ };
1618
+ export type SetWorkspaceEncryptionKeyResponse = string;
1619
+ export type GetWorkspaceDefaultAppData = {
1620
+ workspace: string;
1621
+ };
1622
+ export type GetWorkspaceDefaultAppResponse = {
1623
+ default_app_path?: string;
1624
+ };
1625
+ export type GetLargeFileStorageConfigData = {
1626
+ workspace: string;
1627
+ };
1628
+ export type GetLargeFileStorageConfigResponse = LargeFileStorage;
1629
+ export type GetWorkspaceUsageData = {
1630
+ workspace: string;
1631
+ };
1632
+ export type GetWorkspaceUsageResponse = number;
1633
+ export type GetGlobalData = {
1634
+ key: string;
1635
+ };
1636
+ export type GetGlobalResponse = unknown;
1637
+ export type SetGlobalData = {
1638
+ key: string;
1639
+ /**
1640
+ * value set
1641
+ */
1642
+ requestBody: {
1643
+ value?: unknown;
1644
+ };
1645
+ };
1646
+ export type SetGlobalResponse = string;
1647
+ export type GetLocalResponse = unknown;
1648
+ export type TestSmtpData = {
1649
+ /**
1650
+ * test smtp payload
1651
+ */
1652
+ requestBody: {
1653
+ to: string;
1654
+ smtp: {
1655
+ host: string;
1656
+ username: string;
1657
+ password: string;
1658
+ port: number;
1659
+ from: string;
1660
+ tls_implicit: boolean;
1661
+ };
1662
+ };
1663
+ };
1664
+ export type TestSmtpResponse = string;
1665
+ export type TestLicenseKeyData = {
1666
+ /**
1667
+ * test license key
1668
+ */
1669
+ requestBody: {
1670
+ license_key: string;
1671
+ };
1672
+ };
1673
+ export type TestLicenseKeyResponse = string;
1674
+ export type TestObjectStorageConfigData = {
1675
+ /**
1676
+ * test object storage config
1677
+ */
1678
+ requestBody: {
1679
+ [key: string]: unknown;
1680
+ };
1681
+ };
1682
+ export type TestObjectStorageConfigResponse = string;
1683
+ export type SendStatsResponse = string;
1684
+ export type TestMetadataData = {
1685
+ /**
1686
+ * test metadata
1687
+ */
1688
+ requestBody: string;
1689
+ };
1690
+ export type TestMetadataResponse = string;
1691
+ export type GetOidcTokenData = {
1692
+ audience: string;
1693
+ workspace: string;
1694
+ };
1695
+ export type GetOidcTokenResponse = string;
1696
+ export type CreateVariableData = {
1697
+ alreadyEncrypted?: boolean;
1698
+ /**
1699
+ * new variable
1700
+ */
1701
+ requestBody: CreateVariable;
1702
+ workspace: string;
1703
+ };
1704
+ export type CreateVariableResponse = string;
1705
+ export type EncryptValueData = {
1706
+ /**
1707
+ * new variable
1708
+ */
1709
+ requestBody: string;
1710
+ workspace: string;
1711
+ };
1712
+ export type EncryptValueResponse = string;
1713
+ export type DeleteVariableData = {
1714
+ path: string;
1715
+ workspace: string;
1716
+ };
1717
+ export type DeleteVariableResponse = string;
1718
+ export type UpdateVariableData = {
1719
+ alreadyEncrypted?: boolean;
1720
+ path: string;
1721
+ /**
1722
+ * updated variable
1723
+ */
1724
+ requestBody: EditVariable;
1725
+ workspace: string;
1726
+ };
1727
+ export type UpdateVariableResponse = string;
1728
+ export type GetVariableData = {
1729
+ /**
1730
+ * ask to decrypt secret if this variable is secret
1731
+ * (if not secret no effect, default: true)
1732
+ *
1733
+ */
1734
+ decryptSecret?: boolean;
1735
+ /**
1736
+ * ask to include the encrypted value if secret and decrypt secret is not true (default: false)
1737
+ *
1738
+ */
1739
+ includeEncrypted?: boolean;
1740
+ path: string;
1741
+ workspace: string;
1742
+ };
1743
+ export type GetVariableResponse = ListableVariable;
1744
+ export type GetVariableValueData = {
1745
+ path: string;
1746
+ workspace: string;
1747
+ };
1748
+ export type GetVariableValueResponse = string;
1749
+ export type ExistsVariableData = {
1750
+ path: string;
1751
+ workspace: string;
1752
+ };
1753
+ export type ExistsVariableResponse = boolean;
1754
+ export type ListVariableData = {
1755
+ workspace: string;
1756
+ };
1757
+ export type ListVariableResponse = Array<ListableVariable>;
1758
+ export type ListContextualVariablesData = {
1759
+ workspace: string;
1760
+ };
1761
+ export type ListContextualVariablesResponse = Array<ContextualVariable>;
1762
+ export type ConnectSlackCallbackData = {
1763
+ /**
1764
+ * code endpoint
1765
+ */
1766
+ requestBody: {
1767
+ code: string;
1768
+ state: string;
1769
+ };
1770
+ workspace: string;
1771
+ };
1772
+ export type ConnectSlackCallbackResponse = string;
1773
+ export type ConnectCallbackData = {
1774
+ clientName: string;
1775
+ /**
1776
+ * code endpoint
1777
+ */
1778
+ requestBody: {
1779
+ code: string;
1780
+ state: string;
1781
+ };
1782
+ };
1783
+ export type ConnectCallbackResponse = TokenResponse;
1784
+ export type CreateAccountData = {
1785
+ /**
1786
+ * code endpoint
1787
+ */
1788
+ requestBody: {
1789
+ refresh_token?: string;
1790
+ expires_in: number;
1791
+ client: string;
1792
+ };
1793
+ workspace: string;
1794
+ };
1795
+ export type CreateAccountResponse = string;
1796
+ export type RefreshTokenData = {
1797
+ id: number;
1798
+ /**
1799
+ * variable path
1800
+ */
1801
+ requestBody: {
1802
+ path: string;
1803
+ };
1804
+ workspace: string;
1805
+ };
1806
+ export type RefreshTokenResponse = string;
1807
+ export type DisconnectAccountData = {
1808
+ id: number;
1809
+ workspace: string;
1810
+ };
1811
+ export type DisconnectAccountResponse = string;
1812
+ export type DisconnectSlackData = {
1813
+ workspace: string;
1814
+ };
1815
+ export type DisconnectSlackResponse = string;
1816
+ export type ListOauthLoginsResponse = {
1817
+ oauth: Array<(string)>;
1818
+ saml?: string;
1819
+ };
1820
+ export type ListOauthConnectsResponse = unknown;
1821
+ export type CreateResourceData = {
1822
+ /**
1823
+ * new resource
1824
+ */
1825
+ requestBody: CreateResource;
1826
+ updateIfExists?: boolean;
1827
+ workspace: string;
1828
+ };
1829
+ export type CreateResourceResponse = string;
1830
+ export type DeleteResourceData = {
1831
+ path: string;
1832
+ workspace: string;
1833
+ };
1834
+ export type DeleteResourceResponse = string;
1835
+ export type UpdateResourceData = {
1836
+ path: string;
1837
+ /**
1838
+ * updated resource
1839
+ */
1840
+ requestBody: EditResource;
1841
+ workspace: string;
1842
+ };
1843
+ export type UpdateResourceResponse = string;
1844
+ export type UpdateResourceValueData = {
1845
+ path: string;
1846
+ /**
1847
+ * updated resource
1848
+ */
1849
+ requestBody: {
1850
+ value?: unknown;
1851
+ };
1852
+ workspace: string;
1853
+ };
1854
+ export type UpdateResourceValueResponse = string;
1855
+ export type GetResourceData = {
1856
+ path: string;
1857
+ workspace: string;
1858
+ };
1859
+ export type GetResourceResponse = Resource;
1860
+ export type GetResourceValueInterpolatedData = {
1861
+ /**
1862
+ * job id
1863
+ */
1864
+ jobId?: string;
1865
+ path: string;
1866
+ workspace: string;
1867
+ };
1868
+ export type GetResourceValueInterpolatedResponse = unknown;
1869
+ export type GetResourceValueData = {
1870
+ path: string;
1871
+ workspace: string;
1872
+ };
1873
+ export type GetResourceValueResponse = unknown;
1874
+ export type ExistsResourceData = {
1875
+ path: string;
1876
+ workspace: string;
1877
+ };
1878
+ export type ExistsResourceResponse = boolean;
1879
+ export type ListResourceData = {
1880
+ /**
1881
+ * which page to return (start at 1, default 1)
1882
+ */
1883
+ page?: number;
1884
+ /**
1885
+ * number of items to return for a given page (default 30, max 100)
1886
+ */
1887
+ perPage?: number;
1888
+ /**
1889
+ * resource_types to list from, separated by ',',
1890
+ */
1891
+ resourceType?: string;
1892
+ /**
1893
+ * resource_types to not list from, separated by ',',
1894
+ */
1895
+ resourceTypeExclude?: string;
1896
+ workspace: string;
1897
+ };
1898
+ export type ListResourceResponse = Array<ListableResource>;
1899
+ export type ListSearchResourceData = {
1900
+ workspace: string;
1901
+ };
1902
+ export type ListSearchResourceResponse = Array<{
1903
+ path: string;
1904
+ value: unknown;
1905
+ }>;
1906
+ export type ListResourceNamesData = {
1907
+ name: string;
1908
+ workspace: string;
1909
+ };
1910
+ export type ListResourceNamesResponse = Array<{
1911
+ name: string;
1912
+ path: string;
1913
+ }>;
1914
+ export type CreateResourceTypeData = {
1915
+ /**
1916
+ * new resource_type
1917
+ */
1918
+ requestBody: ResourceType;
1919
+ workspace: string;
1920
+ };
1921
+ export type CreateResourceTypeResponse = string;
1922
+ export type DeleteResourceTypeData = {
1923
+ path: string;
1924
+ workspace: string;
1925
+ };
1926
+ export type DeleteResourceTypeResponse = string;
1927
+ export type UpdateResourceTypeData = {
1928
+ path: string;
1929
+ /**
1930
+ * updated resource_type
1931
+ */
1932
+ requestBody: EditResourceType;
1933
+ workspace: string;
1934
+ };
1935
+ export type UpdateResourceTypeResponse = string;
1936
+ export type GetResourceTypeData = {
1937
+ path: string;
1938
+ workspace: string;
1939
+ };
1940
+ export type GetResourceTypeResponse = ResourceType;
1941
+ export type ExistsResourceTypeData = {
1942
+ path: string;
1943
+ workspace: string;
1944
+ };
1945
+ export type ExistsResourceTypeResponse = boolean;
1946
+ export type ListResourceTypeData = {
1947
+ workspace: string;
1948
+ };
1949
+ export type ListResourceTypeResponse = Array<ResourceType>;
1950
+ export type ListResourceTypeNamesData = {
1951
+ workspace: string;
1952
+ };
1953
+ export type ListResourceTypeNamesResponse = Array<(string)>;
1954
+ export type QueryResourceTypesData = {
1955
+ /**
1956
+ * query limit
1957
+ */
1958
+ limit?: number;
1959
+ /**
1960
+ * query text
1961
+ */
1962
+ text: string;
1963
+ workspace: string;
1964
+ };
1965
+ export type QueryResourceTypesResponse = Array<{
1966
+ name: string;
1967
+ score: number;
1968
+ schema?: unknown;
1969
+ }>;
1970
+ export type ListHubIntegrationsData = {
1971
+ /**
1972
+ * query integrations kind
1973
+ */
1974
+ kind?: string;
1975
+ };
1976
+ export type ListHubIntegrationsResponse = Array<{
1977
+ name: string;
1978
+ }>;
1979
+ export type ListHubFlowsResponse = {
1980
+ flows?: Array<{
1981
+ id: number;
1982
+ flow_id: number;
1983
+ summary: string;
1984
+ apps: Array<(string)>;
1985
+ approved: boolean;
1986
+ votes: number;
1987
+ }>;
1988
+ };
1989
+ export type GetHubFlowByIdData = {
1990
+ id: number;
1991
+ };
1992
+ export type GetHubFlowByIdResponse = {
1993
+ flow?: OpenFlow;
1994
+ };
1995
+ export type ListFlowPathsData = {
1996
+ workspace: string;
1997
+ };
1998
+ export type ListFlowPathsResponse = Array<(string)>;
1999
+ export type ListSearchFlowData = {
2000
+ workspace: string;
2001
+ };
2002
+ export type ListSearchFlowResponse = Array<{
2003
+ path: string;
2004
+ value: unknown;
2005
+ }>;
2006
+ export type ListFlowsData = {
2007
+ /**
2008
+ * mask to filter exact matching user creator
2009
+ */
2010
+ createdBy?: string;
2011
+ /**
2012
+ * order by desc order (default true)
2013
+ */
2014
+ orderDesc?: boolean;
2015
+ /**
2016
+ * which page to return (start at 1, default 1)
2017
+ */
2018
+ page?: number;
2019
+ /**
2020
+ * mask to filter exact matching path
2021
+ */
2022
+ pathExact?: string;
2023
+ /**
2024
+ * mask to filter matching starting path
2025
+ */
2026
+ pathStart?: string;
2027
+ /**
2028
+ * number of items to return for a given page (default 30, max 100)
2029
+ */
2030
+ perPage?: number;
2031
+ /**
2032
+ * (default false)
2033
+ * show also the archived files.
2034
+ * when multiple archived hash share the same path, only the ones with the latest create_at
2035
+ * are displayed.
2036
+ *
2037
+ */
2038
+ showArchived?: boolean;
2039
+ /**
2040
+ * (default false)
2041
+ * show only the starred items
2042
+ *
2043
+ */
2044
+ starredOnly?: boolean;
2045
+ workspace: string;
2046
+ };
2047
+ export type ListFlowsResponse = Array<(Flow & {
2048
+ has_draft?: boolean;
2049
+ draft_only?: boolean;
2050
+ })>;
2051
+ export type GetFlowByPathData = {
2052
+ path: string;
2053
+ workspace: string;
2054
+ };
2055
+ export type GetFlowByPathResponse = Flow;
2056
+ export type ToggleWorkspaceErrorHandlerForFlowData = {
2057
+ path: string;
2058
+ /**
2059
+ * Workspace error handler enabled
2060
+ */
2061
+ requestBody: {
2062
+ muted?: boolean;
2063
+ };
2064
+ workspace: string;
2065
+ };
2066
+ export type ToggleWorkspaceErrorHandlerForFlowResponse = string;
2067
+ export type GetFlowByPathWithDraftData = {
2068
+ path: string;
2069
+ workspace: string;
2070
+ };
2071
+ export type GetFlowByPathWithDraftResponse = Flow & {
2072
+ draft?: Flow;
2073
+ };
2074
+ export type ExistsFlowByPathData = {
2075
+ path: string;
2076
+ workspace: string;
2077
+ };
2078
+ export type ExistsFlowByPathResponse = boolean;
2079
+ export type CreateFlowData = {
2080
+ /**
2081
+ * Partially filled flow
2082
+ */
2083
+ requestBody: OpenFlowWPath & {
2084
+ draft_only?: boolean;
2085
+ deployment_message?: string;
2086
+ };
2087
+ workspace: string;
2088
+ };
2089
+ export type CreateFlowResponse = string;
2090
+ export type UpdateFlowData = {
2091
+ path: string;
2092
+ /**
2093
+ * Partially filled flow
2094
+ */
2095
+ requestBody: OpenFlowWPath & {
2096
+ deployment_message?: string;
2097
+ };
2098
+ workspace: string;
2099
+ };
2100
+ export type UpdateFlowResponse = string;
2101
+ export type ArchiveFlowByPathData = {
2102
+ path: string;
2103
+ /**
2104
+ * archiveFlow
2105
+ */
2106
+ requestBody: {
2107
+ archived?: boolean;
2108
+ };
2109
+ workspace: string;
2110
+ };
2111
+ export type ArchiveFlowByPathResponse = string;
2112
+ export type DeleteFlowByPathData = {
2113
+ path: string;
2114
+ workspace: string;
2115
+ };
2116
+ export type DeleteFlowByPathResponse = string;
2117
+ export type GetFlowInputHistoryByPathData = {
2118
+ /**
2119
+ * which page to return (start at 1, default 1)
2120
+ */
2121
+ page?: number;
2122
+ path: string;
2123
+ /**
2124
+ * number of items to return for a given page (default 30, max 100)
2125
+ */
2126
+ perPage?: number;
2127
+ workspace: string;
2128
+ };
2129
+ export type GetFlowInputHistoryByPathResponse = Array<Input>;
2130
+ export type ListHubAppsResponse = {
2131
+ apps?: Array<{
2132
+ id: number;
2133
+ app_id: number;
2134
+ summary: string;
2135
+ apps: Array<(string)>;
2136
+ approved: boolean;
2137
+ votes: number;
2138
+ }>;
2139
+ };
2140
+ export type GetHubAppByIdData = {
2141
+ id: number;
2142
+ };
2143
+ export type GetHubAppByIdResponse = {
2144
+ app: {
2145
+ summary: string;
2146
+ value: unknown;
2147
+ };
2148
+ };
2149
+ export type ListSearchAppData = {
2150
+ workspace: string;
2151
+ };
2152
+ export type ListSearchAppResponse = Array<{
2153
+ path: string;
2154
+ value: unknown;
2155
+ }>;
2156
+ export type ListAppsData = {
2157
+ /**
2158
+ * mask to filter exact matching user creator
2159
+ */
2160
+ createdBy?: string;
2161
+ /**
2162
+ * order by desc order (default true)
2163
+ */
2164
+ orderDesc?: boolean;
2165
+ /**
2166
+ * which page to return (start at 1, default 1)
2167
+ */
2168
+ page?: number;
2169
+ /**
2170
+ * mask to filter exact matching path
2171
+ */
2172
+ pathExact?: string;
2173
+ /**
2174
+ * mask to filter matching starting path
2175
+ */
2176
+ pathStart?: string;
2177
+ /**
2178
+ * number of items to return for a given page (default 30, max 100)
2179
+ */
2180
+ perPage?: number;
2181
+ /**
2182
+ * (default false)
2183
+ * show only the starred items
2184
+ *
2185
+ */
2186
+ starredOnly?: boolean;
2187
+ workspace: string;
2188
+ };
2189
+ export type ListAppsResponse = Array<ListableApp>;
2190
+ export type CreateAppData = {
2191
+ /**
2192
+ * new app
2193
+ */
2194
+ requestBody: {
2195
+ path: string;
2196
+ value: unknown;
2197
+ summary: string;
2198
+ policy: Policy;
2199
+ draft_only?: boolean;
2200
+ deployment_message?: string;
2201
+ };
2202
+ workspace: string;
2203
+ };
2204
+ export type CreateAppResponse = string;
2205
+ export type ExistsAppData = {
2206
+ path: string;
2207
+ workspace: string;
2208
+ };
2209
+ export type ExistsAppResponse = boolean;
2210
+ export type GetAppByPathData = {
2211
+ path: string;
2212
+ workspace: string;
2213
+ };
2214
+ export type GetAppByPathResponse = AppWithLastVersion;
2215
+ export type GetAppByPathWithDraftData = {
2216
+ path: string;
2217
+ workspace: string;
2218
+ };
2219
+ export type GetAppByPathWithDraftResponse = AppWithLastVersionWDraft;
2220
+ export type GetAppHistoryByPathData = {
2221
+ path: string;
2222
+ workspace: string;
2223
+ };
2224
+ export type GetAppHistoryByPathResponse = Array<AppHistory>;
2225
+ export type UpdateAppHistoryData = {
2226
+ id: number;
2227
+ /**
2228
+ * App deployment message
2229
+ */
2230
+ requestBody: {
2231
+ deployment_msg?: string;
2232
+ };
2233
+ version: number;
2234
+ workspace: string;
2235
+ };
2236
+ export type UpdateAppHistoryResponse = string;
2237
+ export type GetPublicAppBySecretData = {
2238
+ path: string;
2239
+ workspace: string;
2240
+ };
2241
+ export type GetPublicAppBySecretResponse = AppWithLastVersion;
2242
+ export type GetPublicResourceData = {
2243
+ path: string;
2244
+ workspace: string;
2245
+ };
2246
+ export type GetPublicResourceResponse = unknown;
2247
+ export type GetPublicSecretOfAppData = {
2248
+ path: string;
2249
+ workspace: string;
2250
+ };
2251
+ export type GetPublicSecretOfAppResponse = string;
2252
+ export type GetAppByVersionData = {
2253
+ id: number;
2254
+ workspace: string;
2255
+ };
2256
+ export type GetAppByVersionResponse = AppWithLastVersion;
2257
+ export type DeleteAppData = {
2258
+ path: string;
2259
+ workspace: string;
2260
+ };
2261
+ export type DeleteAppResponse = string;
2262
+ export type UpdateAppData = {
2263
+ path: string;
2264
+ /**
2265
+ * update app
2266
+ */
2267
+ requestBody: {
2268
+ path?: string;
2269
+ summary?: string;
2270
+ value?: unknown;
2271
+ policy?: Policy;
2272
+ deployment_message?: string;
2273
+ };
2274
+ workspace: string;
2275
+ };
2276
+ export type UpdateAppResponse = string;
2277
+ export type ExecuteComponentData = {
2278
+ path: string;
2279
+ /**
2280
+ * update app
2281
+ */
2282
+ requestBody: {
2283
+ component: string;
2284
+ path?: string;
2285
+ args: unknown;
2286
+ raw_code?: {
2287
+ content: string;
2288
+ language: string;
2289
+ path?: string;
2290
+ cache_ttl?: number;
2291
+ };
2292
+ force_viewer_static_fields?: {
2293
+ [key: string]: unknown;
2294
+ };
2295
+ force_viewer_one_of_fields?: {
2296
+ [key: string]: unknown;
2297
+ };
2298
+ };
2299
+ workspace: string;
2300
+ };
2301
+ export type ExecuteComponentResponse = string;
2302
+ export type GetHubScriptContentByPathData = {
2303
+ path: string;
2304
+ };
2305
+ export type GetHubScriptContentByPathResponse = string;
2306
+ export type GetHubScriptByPathData = {
2307
+ path: string;
2308
+ };
2309
+ export type GetHubScriptByPathResponse = {
2310
+ content: string;
2311
+ lockfile?: string;
2312
+ schema?: unknown;
2313
+ language: string;
2314
+ summary?: string;
2315
+ };
2316
+ export type GetTopHubScriptsData = {
2317
+ /**
2318
+ * query scripts app
2319
+ */
2320
+ app?: string;
2321
+ /**
2322
+ * query scripts kind
2323
+ */
2324
+ kind?: string;
2325
+ /**
2326
+ * query limit
2327
+ */
2328
+ limit?: number;
2329
+ };
2330
+ export type GetTopHubScriptsResponse = {
2331
+ asks?: Array<{
2332
+ id: number;
2333
+ ask_id: number;
2334
+ summary: string;
2335
+ app: string;
2336
+ version_id: number;
2337
+ kind: HubScriptKind;
2338
+ votes: number;
2339
+ views: number;
2340
+ }>;
2341
+ };
2342
+ export type QueryHubScriptsData = {
2343
+ /**
2344
+ * query scripts app
2345
+ */
2346
+ app?: string;
2347
+ /**
2348
+ * query scripts kind
2349
+ */
2350
+ kind?: string;
2351
+ /**
2352
+ * query limit
2353
+ */
2354
+ limit?: number;
2355
+ /**
2356
+ * query text
2357
+ */
2358
+ text: string;
2359
+ };
2360
+ export type QueryHubScriptsResponse = Array<{
2361
+ ask_id: number;
2362
+ id: number;
2363
+ version_id: number;
2364
+ summary: string;
2365
+ app: string;
2366
+ kind: HubScriptKind;
2367
+ score: number;
2368
+ }>;
2369
+ export type ListSearchScriptData = {
2370
+ workspace: string;
2371
+ };
2372
+ export type ListSearchScriptResponse = Array<{
2373
+ path: string;
2374
+ content: string;
2375
+ }>;
2376
+ export type ListScriptsData = {
2377
+ /**
2378
+ * mask to filter exact matching user creator
2379
+ */
2380
+ createdBy?: string;
2381
+ /**
2382
+ * mask to filter scripts whom first direct parent has exact hash
2383
+ */
2384
+ firstParentHash?: string;
2385
+ /**
2386
+ * (default false)
2387
+ * hide the scripts without an exported main function
2388
+ *
2389
+ */
2390
+ hideWithoutMain?: boolean;
2391
+ /**
2392
+ * (default regardless)
2393
+ * if true show only the templates
2394
+ * if false show only the non templates
2395
+ * if not defined, show all regardless of if the script is a template
2396
+ *
2397
+ */
2398
+ isTemplate?: boolean;
2399
+ /**
2400
+ * (default regardless)
2401
+ * script kinds to filter, split by comma
2402
+ *
2403
+ */
2404
+ kinds?: string;
2405
+ /**
2406
+ * mask to filter scripts whom last parent in the chain has exact hash.
2407
+ * Beware that each script stores only a limited number of parents. Hence
2408
+ * the last parent hash for a script is not necessarily its top-most parent.
2409
+ * To find the top-most parent you will have to jump from last to last hash
2410
+ * until finding the parent
2411
+ *
2412
+ */
2413
+ lastParentHash?: string;
2414
+ /**
2415
+ * order by desc order (default true)
2416
+ */
2417
+ orderDesc?: boolean;
2418
+ /**
2419
+ * which page to return (start at 1, default 1)
2420
+ */
2421
+ page?: number;
2422
+ /**
2423
+ * is the hash present in the array of stored parent hashes for this script.
2424
+ * The same warning applies than for last_parent_hash. A script only store a
2425
+ * limited number of direct parent
2426
+ *
2427
+ */
2428
+ parentHash?: string;
2429
+ /**
2430
+ * mask to filter exact matching path
2431
+ */
2432
+ pathExact?: string;
2433
+ /**
2434
+ * mask to filter matching starting path
2435
+ */
2436
+ pathStart?: string;
2437
+ /**
2438
+ * number of items to return for a given page (default 30, max 100)
2439
+ */
2440
+ perPage?: number;
2441
+ /**
2442
+ * (default false)
2443
+ * show also the archived files.
2444
+ * when multiple archived hash share the same path, only the ones with the latest create_at
2445
+ * are
2446
+ * ed.
2447
+ *
2448
+ */
2449
+ showArchived?: boolean;
2450
+ /**
2451
+ * (default false)
2452
+ * show only the starred items
2453
+ *
2454
+ */
2455
+ starredOnly?: boolean;
2456
+ workspace: string;
2457
+ };
2458
+ export type ListScriptsResponse = Array<Script>;
2459
+ export type ListScriptPathsData = {
2460
+ workspace: string;
2461
+ };
2462
+ export type ListScriptPathsResponse = Array<(string)>;
2463
+ export type CreateScriptData = {
2464
+ /**
2465
+ * Partially filled script
2466
+ */
2467
+ requestBody: NewScript;
2468
+ workspace: string;
2469
+ };
2470
+ export type CreateScriptResponse = string;
2471
+ export type ToggleWorkspaceErrorHandlerForScriptData = {
2472
+ path: string;
2473
+ /**
2474
+ * Workspace error handler enabled
2475
+ */
2476
+ requestBody: {
2477
+ muted?: boolean;
2478
+ };
2479
+ workspace: string;
2480
+ };
2481
+ export type ToggleWorkspaceErrorHandlerForScriptResponse = string;
2482
+ export type ArchiveScriptByPathData = {
2483
+ path: string;
2484
+ workspace: string;
2485
+ };
2486
+ export type ArchiveScriptByPathResponse = string;
2487
+ export type ArchiveScriptByHashData = {
2488
+ hash: string;
2489
+ workspace: string;
2490
+ };
2491
+ export type ArchiveScriptByHashResponse = Script;
2492
+ export type DeleteScriptByHashData = {
2493
+ hash: string;
2494
+ workspace: string;
2495
+ };
2496
+ export type DeleteScriptByHashResponse = Script;
2497
+ export type DeleteScriptByPathData = {
2498
+ path: string;
2499
+ workspace: string;
2500
+ };
2501
+ export type DeleteScriptByPathResponse = string;
2502
+ export type GetScriptByPathData = {
2503
+ path: string;
2504
+ workspace: string;
2505
+ };
2506
+ export type GetScriptByPathResponse = Script;
2507
+ export type GetScriptByPathWithDraftData = {
2508
+ path: string;
2509
+ workspace: string;
2510
+ };
2511
+ export type GetScriptByPathWithDraftResponse = NewScriptWithDraft;
2512
+ export type GetScriptHistoryByPathData = {
2513
+ path: string;
2514
+ workspace: string;
2515
+ };
2516
+ export type GetScriptHistoryByPathResponse = Array<ScriptHistory>;
2517
+ export type UpdateScriptHistoryData = {
2518
+ hash: string;
2519
+ path: string;
2520
+ /**
2521
+ * Script deployment message
2522
+ */
2523
+ requestBody: {
2524
+ deployment_msg?: string;
2525
+ };
2526
+ workspace: string;
2527
+ };
2528
+ export type UpdateScriptHistoryResponse = string;
2529
+ export type RawScriptByPathData = {
2530
+ path: string;
2531
+ workspace: string;
2532
+ };
2533
+ export type RawScriptByPathResponse = string;
2534
+ export type RawScriptByPathTokenedData = {
2535
+ path: string;
2536
+ token: string;
2537
+ workspace: string;
2538
+ };
2539
+ export type RawScriptByPathTokenedResponse = string;
2540
+ export type ExistsScriptByPathData = {
2541
+ path: string;
2542
+ workspace: string;
2543
+ };
2544
+ export type ExistsScriptByPathResponse = boolean;
2545
+ export type GetScriptByHashData = {
2546
+ hash: string;
2547
+ workspace: string;
2548
+ };
2549
+ export type GetScriptByHashResponse = Script;
2550
+ export type RawScriptByHashData = {
2551
+ path: string;
2552
+ workspace: string;
2553
+ };
2554
+ export type RawScriptByHashResponse = string;
2555
+ export type GetScriptDeploymentStatusData = {
2556
+ hash: string;
2557
+ workspace: string;
2558
+ };
2559
+ export type GetScriptDeploymentStatusResponse = {
2560
+ lock?: string;
2561
+ lock_error_logs?: string;
2562
+ };
2563
+ export type CreateDraftData = {
2564
+ requestBody: {
2565
+ path: string;
2566
+ typ: 'flow' | 'script' | 'app';
2567
+ value?: unknown;
2568
+ };
2569
+ workspace: string;
2570
+ };
2571
+ export type CreateDraftResponse = string;
2572
+ export type DeleteDraftData = {
2573
+ kind: 'script' | 'flow' | 'app';
2574
+ path: string;
2575
+ workspace: string;
2576
+ };
2577
+ export type DeleteDraftResponse = string;
2578
+ export type GetCustomTagsResponse = Array<(string)>;
2579
+ export type GeDefaultTagsResponse = Array<(string)>;
2580
+ export type IsDefaultTagsPerWorkspaceResponse = boolean;
2581
+ export type ListWorkersData = {
2582
+ /**
2583
+ * which page to return (start at 1, default 1)
2584
+ */
2585
+ page?: number;
2586
+ /**
2587
+ * number of items to return for a given page (default 30, max 100)
2588
+ */
2589
+ perPage?: number;
2590
+ /**
2591
+ * number of seconds the worker must have had a last ping more recent of (default to 300)
2592
+ */
2593
+ pingSince?: number;
2594
+ };
2595
+ export type ListWorkersResponse = Array<WorkerPing>;
2596
+ export type ExistsWorkerWithTagData = {
2597
+ tag: string;
2598
+ };
2599
+ export type ExistsWorkerWithTagResponse = boolean;
2600
+ export type RunScriptByPathData = {
2601
+ /**
2602
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
2603
+ */
2604
+ cacheTtl?: string;
2605
+ /**
2606
+ * make the run invisible to the the script owner (default false)
2607
+ */
2608
+ invisibleToOwner?: boolean;
2609
+ /**
2610
+ * 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)
2611
+ */
2612
+ jobId?: string;
2613
+ /**
2614
+ * The parent job that is at the origin and responsible for the execution of this script if any
2615
+ */
2616
+ parentJob?: string;
2617
+ path: string;
2618
+ /**
2619
+ * script args
2620
+ */
2621
+ requestBody: ScriptArgs;
2622
+ /**
2623
+ * when to schedule this job (leave empty for immediate run)
2624
+ */
2625
+ scheduledFor?: string;
2626
+ /**
2627
+ * schedule the script to execute in the number of seconds starting now
2628
+ */
2629
+ scheduledInSecs?: number;
2630
+ /**
2631
+ * Override the tag to use
2632
+ */
2633
+ tag?: string;
2634
+ workspace: string;
2635
+ };
2636
+ export type RunScriptByPathResponse = string;
2637
+ export type OpenaiSyncScriptByPathData = {
2638
+ /**
2639
+ * List of headers's keys (separated with ',') whove value are added to the args
2640
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2641
+ *
2642
+ */
2643
+ includeHeader?: string;
2644
+ /**
2645
+ * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
2646
+ */
2647
+ jobId?: string;
2648
+ /**
2649
+ * The parent job that is at the origin and responsible for the execution of this script if any
2650
+ */
2651
+ parentJob?: string;
2652
+ path: string;
2653
+ /**
2654
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2655
+ *
2656
+ */
2657
+ queueLimit?: string;
2658
+ /**
2659
+ * script args
2660
+ */
2661
+ requestBody: ScriptArgs;
2662
+ workspace: string;
2663
+ };
2664
+ export type OpenaiSyncScriptByPathResponse = unknown;
2665
+ export type RunWaitResultScriptByPathData = {
2666
+ /**
2667
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
2668
+ */
2669
+ cacheTtl?: string;
2670
+ /**
2671
+ * List of headers's keys (separated with ',') whove value are added to the args
2672
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2673
+ *
2674
+ */
2675
+ includeHeader?: string;
2676
+ /**
2677
+ * 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)
2678
+ */
2679
+ jobId?: string;
2680
+ /**
2681
+ * The parent job that is at the origin and responsible for the execution of this script if any
2682
+ */
2683
+ parentJob?: string;
2684
+ path: string;
2685
+ /**
2686
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2687
+ *
2688
+ */
2689
+ queueLimit?: string;
2690
+ /**
2691
+ * script args
2692
+ */
2693
+ requestBody: ScriptArgs;
2694
+ /**
2695
+ * Override the tag to use
2696
+ */
2697
+ tag?: string;
2698
+ workspace: string;
2699
+ };
2700
+ export type RunWaitResultScriptByPathResponse = unknown;
2701
+ export type RunWaitResultScriptByPathGetData = {
2702
+ /**
2703
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
2704
+ */
2705
+ cacheTtl?: string;
2706
+ /**
2707
+ * List of headers's keys (separated with ',') whove value are added to the args
2708
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2709
+ *
2710
+ */
2711
+ includeHeader?: string;
2712
+ /**
2713
+ * 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)
2714
+ */
2715
+ jobId?: string;
2716
+ /**
2717
+ * The parent job that is at the origin and responsible for the execution of this script if any
2718
+ */
2719
+ parentJob?: string;
2720
+ path: string;
2721
+ /**
2722
+ * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
2723
+ * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
2724
+ *
2725
+ */
2726
+ payload?: string;
2727
+ /**
2728
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2729
+ *
2730
+ */
2731
+ queueLimit?: string;
2732
+ /**
2733
+ * Override the tag to use
2734
+ */
2735
+ tag?: string;
2736
+ workspace: string;
2737
+ };
2738
+ export type RunWaitResultScriptByPathGetResponse = unknown;
2739
+ export type OpenaiSyncFlowByPathData = {
2740
+ /**
2741
+ * List of headers's keys (separated with ',') whove value are added to the args
2742
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2743
+ *
2744
+ */
2745
+ includeHeader?: string;
2746
+ /**
2747
+ * 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)
2748
+ */
2749
+ jobId?: string;
2750
+ path: string;
2751
+ /**
2752
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2753
+ *
2754
+ */
2755
+ queueLimit?: string;
2756
+ /**
2757
+ * script args
2758
+ */
2759
+ requestBody: ScriptArgs;
2760
+ workspace: string;
2761
+ };
2762
+ export type OpenaiSyncFlowByPathResponse = unknown;
2763
+ export type RunWaitResultFlowByPathData = {
2764
+ /**
2765
+ * List of headers's keys (separated with ',') whove value are added to the args
2766
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2767
+ *
2768
+ */
2769
+ includeHeader?: string;
2770
+ /**
2771
+ * 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)
2772
+ */
2773
+ jobId?: string;
2774
+ path: string;
2775
+ /**
2776
+ * The maximum size of the queue for which the request would get rejected if that job would push it above that limit
2777
+ *
2778
+ */
2779
+ queueLimit?: string;
2780
+ /**
2781
+ * script args
2782
+ */
2783
+ requestBody: ScriptArgs;
2784
+ workspace: string;
2785
+ };
2786
+ export type RunWaitResultFlowByPathResponse = unknown;
2787
+ export type ResultByIdData = {
2788
+ flowJobId: string;
2789
+ nodeId: string;
2790
+ workspace: string;
2791
+ };
2792
+ export type ResultByIdResponse = unknown;
2793
+ export type RunFlowByPathData = {
2794
+ /**
2795
+ * List of headers's keys (separated with ',') whove value are added to the args
2796
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2797
+ *
2798
+ */
2799
+ includeHeader?: string;
2800
+ /**
2801
+ * make the run invisible to the the flow owner (default false)
2802
+ */
2803
+ invisibleToOwner?: boolean;
2804
+ /**
2805
+ * 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)
2806
+ */
2807
+ jobId?: string;
2808
+ /**
2809
+ * The parent job that is at the origin and responsible for the execution of this script if any
2810
+ */
2811
+ parentJob?: string;
2812
+ path: string;
2813
+ /**
2814
+ * flow args
2815
+ */
2816
+ requestBody: ScriptArgs;
2817
+ /**
2818
+ * when to schedule this job (leave empty for immediate run)
2819
+ */
2820
+ scheduledFor?: string;
2821
+ /**
2822
+ * schedule the script to execute in the number of seconds starting now
2823
+ */
2824
+ scheduledInSecs?: number;
2825
+ /**
2826
+ * Override the tag to use
2827
+ */
2828
+ tag?: string;
2829
+ workspace: string;
2830
+ };
2831
+ export type RunFlowByPathResponse = string;
2832
+ export type RestartFlowAtStepData = {
2833
+ /**
2834
+ * for branchall or loop, the iteration at which the flow should restart
2835
+ */
2836
+ branchOrIterationN: number;
2837
+ id: string;
2838
+ /**
2839
+ * List of headers's keys (separated with ',') whove value are added to the args
2840
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2841
+ *
2842
+ */
2843
+ includeHeader?: string;
2844
+ /**
2845
+ * make the run invisible to the the flow owner (default false)
2846
+ */
2847
+ invisibleToOwner?: boolean;
2848
+ /**
2849
+ * 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)
2850
+ */
2851
+ jobId?: string;
2852
+ /**
2853
+ * The parent job that is at the origin and responsible for the execution of this script if any
2854
+ */
2855
+ parentJob?: string;
2856
+ /**
2857
+ * flow args
2858
+ */
2859
+ requestBody: ScriptArgs;
2860
+ /**
2861
+ * when to schedule this job (leave empty for immediate run)
2862
+ */
2863
+ scheduledFor?: string;
2864
+ /**
2865
+ * schedule the script to execute in the number of seconds starting now
2866
+ */
2867
+ scheduledInSecs?: number;
2868
+ /**
2869
+ * step id to restart the flow from
2870
+ */
2871
+ stepId: string;
2872
+ /**
2873
+ * Override the tag to use
2874
+ */
2875
+ tag?: string;
2876
+ workspace: string;
2877
+ };
2878
+ export type RestartFlowAtStepResponse = string;
2879
+ export type RunScriptByHashData = {
2880
+ /**
2881
+ * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl
2882
+ */
2883
+ cacheTtl?: string;
2884
+ hash: string;
2885
+ /**
2886
+ * List of headers's keys (separated with ',') whove value are added to the args
2887
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2888
+ *
2889
+ */
2890
+ includeHeader?: string;
2891
+ /**
2892
+ * make the run invisible to the the script owner (default false)
2893
+ */
2894
+ invisibleToOwner?: boolean;
2895
+ /**
2896
+ * 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)
2897
+ */
2898
+ jobId?: string;
2899
+ /**
2900
+ * The parent job that is at the origin and responsible for the execution of this script if any
2901
+ */
2902
+ parentJob?: string;
2903
+ /**
2904
+ * Partially filled args
2905
+ */
2906
+ requestBody: {
2907
+ [key: string]: unknown;
2908
+ };
2909
+ /**
2910
+ * when to schedule this job (leave empty for immediate run)
2911
+ */
2912
+ scheduledFor?: string;
2913
+ /**
2914
+ * schedule the script to execute in the number of seconds starting now
2915
+ */
2916
+ scheduledInSecs?: number;
2917
+ /**
2918
+ * Override the tag to use
2919
+ */
2920
+ tag?: string;
2921
+ workspace: string;
2922
+ };
2923
+ export type RunScriptByHashResponse = string;
2924
+ export type RunScriptPreviewData = {
2925
+ /**
2926
+ * List of headers's keys (separated with ',') whove value are added to the args
2927
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2928
+ *
2929
+ */
2930
+ includeHeader?: string;
2931
+ /**
2932
+ * make the run invisible to the the script owner (default false)
2933
+ */
2934
+ invisibleToOwner?: boolean;
2935
+ /**
2936
+ * 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)
2937
+ */
2938
+ jobId?: string;
2939
+ /**
2940
+ * preview
2941
+ */
2942
+ requestBody: Preview;
2943
+ workspace: string;
2944
+ };
2945
+ export type RunScriptPreviewResponse = string;
2946
+ export type RunCodeWorkflowTaskData = {
2947
+ entrypoint: string;
2948
+ jobId: string;
2949
+ /**
2950
+ * preview
2951
+ */
2952
+ requestBody: WorkflowTask;
2953
+ workspace: string;
2954
+ };
2955
+ export type RunCodeWorkflowTaskResponse = string;
2956
+ export type RunRawScriptDependenciesData = {
2957
+ /**
2958
+ * raw script content
2959
+ */
2960
+ requestBody: {
2961
+ raw_scripts: Array<RawScriptForDependencies>;
2962
+ entrypoint: string;
2963
+ };
2964
+ workspace: string;
2965
+ };
2966
+ export type RunRawScriptDependenciesResponse = {
2967
+ lock: string;
2968
+ };
2969
+ export type RunFlowPreviewData = {
2970
+ /**
2971
+ * List of headers's keys (separated with ',') whove value are added to the args
2972
+ * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
2973
+ *
2974
+ */
2975
+ includeHeader?: string;
2976
+ /**
2977
+ * make the run invisible to the the script owner (default false)
2978
+ */
2979
+ invisibleToOwner?: boolean;
2980
+ /**
2981
+ * 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)
2982
+ */
2983
+ jobId?: string;
2984
+ /**
2985
+ * preview
2986
+ */
2987
+ requestBody: FlowPreview;
2988
+ workspace: string;
2989
+ };
2990
+ export type RunFlowPreviewResponse = string;
2991
+ export type ListQueueData = {
2992
+ /**
2993
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
2994
+ */
2995
+ allWorkspaces?: boolean;
2996
+ /**
2997
+ * filter on jobs containing those args as a json subset (@> in postgres)
2998
+ */
2999
+ args?: string;
3000
+ /**
3001
+ * mask to filter exact matching user creator
3002
+ */
3003
+ createdBy?: string;
3004
+ /**
3005
+ * is not a scheduled job
3006
+ */
3007
+ isNotSchedule?: boolean;
3008
+ /**
3009
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
3010
+ */
3011
+ jobKinds?: string;
3012
+ /**
3013
+ * order by desc order (default true)
3014
+ */
3015
+ orderDesc?: boolean;
3016
+ /**
3017
+ * which page to return (start at 1, default 1)
3018
+ */
3019
+ page?: number;
3020
+ /**
3021
+ * The parent job that is at the origin and responsible for the execution of this script if any
3022
+ */
3023
+ parentJob?: string;
3024
+ /**
3025
+ * number of items to return for a given page (default 30, max 100)
3026
+ */
3027
+ perPage?: number;
3028
+ /**
3029
+ * filter on jobs containing those result as a json subset (@> in postgres)
3030
+ */
3031
+ result?: string;
3032
+ /**
3033
+ * filter on running jobs
3034
+ */
3035
+ running?: boolean;
3036
+ /**
3037
+ * filter on jobs scheduled_for before now (hence waitinf for a worker)
3038
+ */
3039
+ scheduledForBeforeNow?: boolean;
3040
+ /**
3041
+ * mask to filter by schedule path
3042
+ */
3043
+ schedulePath?: string;
3044
+ /**
3045
+ * mask to filter exact matching path
3046
+ */
3047
+ scriptHash?: string;
3048
+ /**
3049
+ * mask to filter exact matching path
3050
+ */
3051
+ scriptPathExact?: string;
3052
+ /**
3053
+ * mask to filter matching starting path
3054
+ */
3055
+ scriptPathStart?: string;
3056
+ /**
3057
+ * filter on started after (exclusive) timestamp
3058
+ */
3059
+ startedAfter?: string;
3060
+ /**
3061
+ * filter on started before (inclusive) timestamp
3062
+ */
3063
+ startedBefore?: string;
3064
+ /**
3065
+ * filter on successful jobs
3066
+ */
3067
+ success?: boolean;
3068
+ /**
3069
+ * filter on suspended jobs
3070
+ */
3071
+ suspended?: boolean;
3072
+ /**
3073
+ * filter on jobs with a given tag/worker group
3074
+ */
3075
+ tag?: string;
3076
+ workspace: string;
3077
+ };
3078
+ export type ListQueueResponse = Array<QueuedJob>;
3079
+ export type GetQueueCountData = {
3080
+ /**
3081
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
3082
+ */
3083
+ allWorkspaces?: boolean;
3084
+ workspace: string;
3085
+ };
3086
+ export type GetQueueCountResponse = {
3087
+ database_length: number;
3088
+ };
3089
+ export type GetCompletedCountData = {
3090
+ workspace: string;
3091
+ };
3092
+ export type GetCompletedCountResponse = {
3093
+ database_length: number;
3094
+ };
3095
+ export type CancelAllData = {
3096
+ workspace: string;
3097
+ };
3098
+ export type CancelAllResponse = Array<(string)>;
3099
+ export type ListCompletedJobsData = {
3100
+ /**
3101
+ * filter on jobs containing those args as a json subset (@> in postgres)
3102
+ */
3103
+ args?: string;
3104
+ /**
3105
+ * mask to filter exact matching user creator
3106
+ */
3107
+ createdBy?: string;
3108
+ /**
3109
+ * has null parent
3110
+ */
3111
+ hasNullParent?: boolean;
3112
+ /**
3113
+ * is the job a flow step
3114
+ */
3115
+ isFlowStep?: boolean;
3116
+ /**
3117
+ * is not a scheduled job
3118
+ */
3119
+ isNotSchedule?: boolean;
3120
+ /**
3121
+ * is the job skipped
3122
+ */
3123
+ isSkipped?: boolean;
3124
+ /**
3125
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
3126
+ */
3127
+ jobKinds?: string;
3128
+ /**
3129
+ * mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
3130
+ */
3131
+ label?: string;
3132
+ /**
3133
+ * order by desc order (default true)
3134
+ */
3135
+ orderDesc?: boolean;
3136
+ /**
3137
+ * which page to return (start at 1, default 1)
3138
+ */
3139
+ page?: number;
3140
+ /**
3141
+ * The parent job that is at the origin and responsible for the execution of this script if any
3142
+ */
3143
+ parentJob?: string;
3144
+ /**
3145
+ * number of items to return for a given page (default 30, max 100)
3146
+ */
3147
+ perPage?: number;
3148
+ /**
3149
+ * filter on jobs containing those result as a json subset (@> in postgres)
3150
+ */
3151
+ result?: string;
3152
+ /**
3153
+ * mask to filter by schedule path
3154
+ */
3155
+ schedulePath?: string;
3156
+ /**
3157
+ * mask to filter exact matching path
3158
+ */
3159
+ scriptHash?: string;
3160
+ /**
3161
+ * mask to filter exact matching path
3162
+ */
3163
+ scriptPathExact?: string;
3164
+ /**
3165
+ * mask to filter matching starting path
3166
+ */
3167
+ scriptPathStart?: string;
3168
+ /**
3169
+ * filter on started after (exclusive) timestamp
3170
+ */
3171
+ startedAfter?: string;
3172
+ /**
3173
+ * filter on started before (inclusive) timestamp
3174
+ */
3175
+ startedBefore?: string;
3176
+ /**
3177
+ * filter on successful jobs
3178
+ */
3179
+ success?: boolean;
3180
+ /**
3181
+ * filter on jobs with a given tag/worker group
3182
+ */
3183
+ tag?: string;
3184
+ workspace: string;
3185
+ };
3186
+ export type ListCompletedJobsResponse = Array<CompletedJob>;
3187
+ export type ListJobsData = {
3188
+ /**
3189
+ * get jobs from all workspaces (only valid if request come from the `admins` workspace)
3190
+ */
3191
+ allWorkspaces?: boolean;
3192
+ /**
3193
+ * filter on jobs containing those args as a json subset (@> in postgres)
3194
+ */
3195
+ args?: string;
3196
+ /**
3197
+ * mask to filter exact matching user creator
3198
+ */
3199
+ createdBy?: string;
3200
+ /**
3201
+ * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp
3202
+ */
3203
+ createdOrStartedAfter?: string;
3204
+ /**
3205
+ * filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp
3206
+ */
3207
+ createdOrStartedBefore?: string;
3208
+ /**
3209
+ * has null parent
3210
+ */
3211
+ hasNullParent?: boolean;
3212
+ /**
3213
+ * is the job a flow step
3214
+ */
3215
+ isFlowStep?: boolean;
3216
+ /**
3217
+ * is not a scheduled job
3218
+ */
3219
+ isNotSchedule?: boolean;
3220
+ /**
3221
+ * is the job skipped
3222
+ */
3223
+ isSkipped?: boolean;
3224
+ /**
3225
+ * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,
3226
+ */
3227
+ jobKinds?: string;
3228
+ /**
3229
+ * mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')
3230
+ */
3231
+ label?: string;
3232
+ /**
3233
+ * which page to return (start at 1, default 1)
3234
+ */
3235
+ page?: number;
3236
+ /**
3237
+ * The parent job that is at the origin and responsible for the execution of this script if any
3238
+ */
3239
+ parentJob?: string;
3240
+ /**
3241
+ * number of items to return for a given page (default 30, max 100)
3242
+ */
3243
+ perPage?: number;
3244
+ /**
3245
+ * filter on jobs containing those result as a json subset (@> in postgres)
3246
+ */
3247
+ result?: string;
3248
+ /**
3249
+ * filter on running jobs
3250
+ */
3251
+ running?: boolean;
3252
+ /**
3253
+ * filter on jobs scheduled_for before now (hence waitinf for a worker)
3254
+ */
3255
+ scheduledForBeforeNow?: boolean;
3256
+ /**
3257
+ * mask to filter by schedule path
3258
+ */
3259
+ schedulePath?: string;
3260
+ /**
3261
+ * mask to filter exact matching path
3262
+ */
3263
+ scriptHash?: string;
3264
+ /**
3265
+ * mask to filter exact matching path
3266
+ */
3267
+ scriptPathExact?: string;
3268
+ /**
3269
+ * mask to filter matching starting path
3270
+ */
3271
+ scriptPathStart?: string;
3272
+ /**
3273
+ * filter on started after (exclusive) timestamp
3274
+ */
3275
+ startedAfter?: string;
3276
+ /**
3277
+ * filter on started before (inclusive) timestamp
3278
+ */
3279
+ startedBefore?: string;
3280
+ /**
3281
+ * filter on successful jobs
3282
+ */
3283
+ success?: boolean;
3284
+ /**
3285
+ * filter on jobs with a given tag/worker group
3286
+ */
3287
+ tag?: string;
3288
+ workspace: string;
3289
+ };
3290
+ export type ListJobsResponse = Array<Job>;
3291
+ export type GetDbClockResponse = number;
3292
+ export type GetJobData = {
3293
+ id: string;
3294
+ noLogs?: boolean;
3295
+ workspace: string;
3296
+ };
3297
+ export type GetJobResponse = Job;
3298
+ export type GetRootJobIdData = {
3299
+ id: string;
3300
+ workspace: string;
3301
+ };
3302
+ export type GetRootJobIdResponse = string;
3303
+ export type GetJobLogsData = {
3304
+ id: string;
3305
+ workspace: string;
3306
+ };
3307
+ export type GetJobLogsResponse = string;
3308
+ export type GetJobUpdatesData = {
3309
+ id: string;
3310
+ logOffset?: number;
3311
+ running?: boolean;
3312
+ workspace: string;
3313
+ };
3314
+ export type GetJobUpdatesResponse = {
3315
+ running?: boolean;
3316
+ completed?: boolean;
3317
+ new_logs?: string;
3318
+ log_offset?: number;
3319
+ mem_peak?: number;
3320
+ flow_status?: WorkflowStatusRecord;
3321
+ };
3322
+ export type GetLogFileFromStoreData = {
3323
+ path: string;
3324
+ workspace: string;
3325
+ };
3326
+ export type GetLogFileFromStoreResponse = unknown;
3327
+ export type GetFlowDebugInfoData = {
3328
+ id: string;
3329
+ workspace: string;
3330
+ };
3331
+ export type GetFlowDebugInfoResponse = unknown;
3332
+ export type GetCompletedJobData = {
3333
+ id: string;
3334
+ workspace: string;
3335
+ };
3336
+ export type GetCompletedJobResponse = CompletedJob;
3337
+ export type GetCompletedJobResultData = {
3338
+ id: string;
3339
+ workspace: string;
3340
+ };
3341
+ export type GetCompletedJobResultResponse = unknown;
3342
+ export type GetCompletedJobResultMaybeData = {
3343
+ getStarted?: boolean;
3344
+ id: string;
3345
+ workspace: string;
3346
+ };
3347
+ export type GetCompletedJobResultMaybeResponse = {
3348
+ completed: boolean;
3349
+ result: unknown;
3350
+ success?: boolean;
3351
+ started?: boolean;
3352
+ };
3353
+ export type DeleteCompletedJobData = {
3354
+ id: string;
3355
+ workspace: string;
3356
+ };
3357
+ export type DeleteCompletedJobResponse = CompletedJob;
3358
+ export type CancelQueuedJobData = {
3359
+ id: string;
3360
+ /**
3361
+ * reason
3362
+ */
3363
+ requestBody: {
3364
+ reason?: string;
3365
+ };
3366
+ workspace: string;
3367
+ };
3368
+ export type CancelQueuedJobResponse = string;
3369
+ export type CancelPersistentQueuedJobsData = {
3370
+ path: string;
3371
+ /**
3372
+ * reason
3373
+ */
3374
+ requestBody: {
3375
+ reason?: string;
3376
+ };
3377
+ workspace: string;
3378
+ };
3379
+ export type CancelPersistentQueuedJobsResponse = string;
3380
+ export type ForceCancelQueuedJobData = {
3381
+ id: string;
3382
+ /**
3383
+ * reason
3384
+ */
3385
+ requestBody: {
3386
+ reason?: string;
3387
+ };
3388
+ workspace: string;
3389
+ };
3390
+ export type ForceCancelQueuedJobResponse = string;
3391
+ export type CreateJobSignatureData = {
3392
+ approver?: string;
3393
+ id: string;
3394
+ resumeId: number;
3395
+ workspace: string;
3396
+ };
3397
+ export type CreateJobSignatureResponse = string;
3398
+ export type GetResumeUrlsData = {
3399
+ approver?: string;
3400
+ id: string;
3401
+ resumeId: number;
3402
+ workspace: string;
3403
+ };
3404
+ export type GetResumeUrlsResponse = {
3405
+ approvalPage: string;
3406
+ resume: string;
3407
+ cancel: string;
3408
+ };
3409
+ export type ResumeSuspendedJobGetData = {
3410
+ approver?: string;
3411
+ id: string;
3412
+ /**
3413
+ * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent
3414
+ * `encodeURIComponent(btoa(JSON.stringify({a: 2})))`
3415
+ *
3416
+ */
3417
+ payload?: string;
3418
+ resumeId: number;
3419
+ signature: string;
3420
+ workspace: string;
3421
+ };
3422
+ export type ResumeSuspendedJobGetResponse = string;
3423
+ export type ResumeSuspendedJobPostData = {
3424
+ approver?: string;
3425
+ id: string;
3426
+ requestBody: {
3427
+ [key: string]: unknown;
3428
+ };
3429
+ resumeId: number;
3430
+ signature: string;
3431
+ workspace: string;
3432
+ };
3433
+ export type ResumeSuspendedJobPostResponse = string;
3434
+ export type SetFlowUserStateData = {
3435
+ id: string;
3436
+ key: string;
3437
+ /**
3438
+ * new value
3439
+ */
3440
+ requestBody: unknown;
3441
+ workspace: string;
3442
+ };
3443
+ export type SetFlowUserStateResponse = string;
3444
+ export type GetFlowUserStateData = {
3445
+ id: string;
3446
+ key: string;
3447
+ workspace: string;
3448
+ };
3449
+ export type GetFlowUserStateResponse = unknown;
3450
+ export type ResumeSuspendedFlowAsOwnerData = {
3451
+ id: string;
3452
+ requestBody: {
3453
+ [key: string]: unknown;
3454
+ };
3455
+ workspace: string;
3456
+ };
3457
+ export type ResumeSuspendedFlowAsOwnerResponse = string;
3458
+ export type CancelSuspendedJobGetData = {
3459
+ approver?: string;
3460
+ id: string;
3461
+ resumeId: number;
3462
+ signature: string;
3463
+ workspace: string;
3464
+ };
3465
+ export type CancelSuspendedJobGetResponse = string;
3466
+ export type CancelSuspendedJobPostData = {
3467
+ approver?: string;
3468
+ id: string;
3469
+ requestBody: {
3470
+ [key: string]: unknown;
3471
+ };
3472
+ resumeId: number;
3473
+ signature: string;
3474
+ workspace: string;
3475
+ };
3476
+ export type CancelSuspendedJobPostResponse = string;
3477
+ export type GetSuspendedJobFlowData = {
3478
+ approver?: string;
3479
+ id: string;
3480
+ resumeId: number;
3481
+ signature: string;
3482
+ workspace: string;
3483
+ };
3484
+ export type GetSuspendedJobFlowResponse = {
3485
+ job: Job;
3486
+ approvers: Array<{
3487
+ resume_id: number;
3488
+ approver: string;
3489
+ }>;
3490
+ };
3491
+ export type ListRawAppsData = {
3492
+ /**
3493
+ * mask to filter exact matching user creator
3494
+ */
3495
+ createdBy?: string;
3496
+ /**
3497
+ * order by desc order (default true)
3498
+ */
3499
+ orderDesc?: boolean;
3500
+ /**
3501
+ * which page to return (start at 1, default 1)
3502
+ */
3503
+ page?: number;
3504
+ /**
3505
+ * mask to filter exact matching path
3506
+ */
3507
+ pathExact?: string;
3508
+ /**
3509
+ * mask to filter matching starting path
3510
+ */
3511
+ pathStart?: string;
3512
+ /**
3513
+ * number of items to return for a given page (default 30, max 100)
3514
+ */
3515
+ perPage?: number;
3516
+ /**
3517
+ * (default false)
3518
+ * show only the starred items
3519
+ *
3520
+ */
3521
+ starredOnly?: boolean;
3522
+ workspace: string;
3523
+ };
3524
+ export type ListRawAppsResponse = Array<ListableRawApp>;
3525
+ export type ExistsRawAppData = {
3526
+ path: string;
3527
+ workspace: string;
3528
+ };
3529
+ export type ExistsRawAppResponse = boolean;
3530
+ export type GetRawAppDataData = {
3531
+ path: string;
3532
+ version: number;
3533
+ workspace: string;
3534
+ };
3535
+ export type GetRawAppDataResponse = string;
3536
+ export type CreateRawAppData = {
3537
+ /**
3538
+ * new raw app
3539
+ */
3540
+ requestBody: {
3541
+ path: string;
3542
+ value: string;
3543
+ summary: string;
3544
+ };
3545
+ workspace: string;
3546
+ };
3547
+ export type CreateRawAppResponse = string;
3548
+ export type UpdateRawAppData = {
3549
+ path: string;
3550
+ /**
3551
+ * updateraw app
3552
+ */
3553
+ requestBody: {
3554
+ path?: string;
3555
+ summary?: string;
3556
+ value?: string;
3557
+ };
3558
+ workspace: string;
3559
+ };
3560
+ export type UpdateRawAppResponse = string;
3561
+ export type DeleteRawAppData = {
3562
+ path: string;
3563
+ workspace: string;
3564
+ };
3565
+ export type DeleteRawAppResponse = string;
3566
+ export type PreviewScheduleData = {
3567
+ /**
3568
+ * schedule
3569
+ */
3570
+ requestBody: {
3571
+ schedule: string;
3572
+ timezone: string;
3573
+ };
3574
+ };
3575
+ export type PreviewScheduleResponse = Array<(string)>;
3576
+ export type CreateScheduleData = {
3577
+ /**
3578
+ * new schedule
3579
+ */
3580
+ requestBody: NewSchedule;
3581
+ workspace: string;
3582
+ };
3583
+ export type CreateScheduleResponse = string;
3584
+ export type UpdateScheduleData = {
3585
+ path: string;
3586
+ /**
3587
+ * updated schedule
3588
+ */
3589
+ requestBody: EditSchedule;
3590
+ workspace: string;
3591
+ };
3592
+ export type UpdateScheduleResponse = string;
3593
+ export type SetScheduleEnabledData = {
3594
+ path: string;
3595
+ /**
3596
+ * updated schedule enable
3597
+ */
3598
+ requestBody: {
3599
+ enabled: boolean;
3600
+ };
3601
+ workspace: string;
3602
+ };
3603
+ export type SetScheduleEnabledResponse = string;
3604
+ export type DeleteScheduleData = {
3605
+ path: string;
3606
+ workspace: string;
3607
+ };
3608
+ export type DeleteScheduleResponse = string;
3609
+ export type GetScheduleData = {
3610
+ path: string;
3611
+ workspace: string;
3612
+ };
3613
+ export type GetScheduleResponse = Schedule;
3614
+ export type ExistsScheduleData = {
3615
+ path: string;
3616
+ workspace: string;
3617
+ };
3618
+ export type ExistsScheduleResponse = boolean;
3619
+ export type ListSchedulesData = {
3620
+ /**
3621
+ * filter on jobs containing those args as a json subset (@> in postgres)
3622
+ */
3623
+ args?: string;
3624
+ isFlow?: boolean;
3625
+ /**
3626
+ * which page to return (start at 1, default 1)
3627
+ */
3628
+ page?: number;
3629
+ /**
3630
+ * filter by path
3631
+ */
3632
+ path?: string;
3633
+ /**
3634
+ * number of items to return for a given page (default 30, max 100)
3635
+ */
3636
+ perPage?: number;
3637
+ workspace: string;
3638
+ };
3639
+ export type ListSchedulesResponse = Array<Schedule>;
3640
+ export type ListSchedulesWithJobsData = {
3641
+ /**
3642
+ * which page to return (start at 1, default 1)
3643
+ */
3644
+ page?: number;
3645
+ /**
3646
+ * number of items to return for a given page (default 30, max 100)
3647
+ */
3648
+ perPage?: number;
3649
+ workspace: string;
3650
+ };
3651
+ export type ListSchedulesWithJobsResponse = Array<ScheduleWJobs>;
3652
+ export type SetDefaultErrorOrRecoveryHandlerData = {
3653
+ /**
3654
+ * Handler description
3655
+ */
3656
+ requestBody: {
3657
+ handler_type: 'error' | 'recovery';
3658
+ override_existing: boolean;
3659
+ path?: string;
3660
+ extra_args?: {
3661
+ [key: string]: unknown;
3662
+ };
3663
+ number_of_occurence?: number;
3664
+ number_of_occurence_exact?: boolean;
3665
+ workspace_handler_muted?: boolean;
3666
+ };
3667
+ workspace: string;
3668
+ };
3669
+ export type SetDefaultErrorOrRecoveryHandlerResponse = unknown;
3670
+ export type ListInstanceGroupsResponse = Array<InstanceGroup>;
3671
+ export type GetInstanceGroupData = {
3672
+ name: string;
3673
+ };
3674
+ export type GetInstanceGroupResponse = InstanceGroup;
3675
+ export type CreateInstanceGroupData = {
3676
+ /**
3677
+ * create instance group
3678
+ */
3679
+ requestBody: {
3680
+ name: string;
3681
+ summary?: string;
3682
+ };
3683
+ };
3684
+ export type CreateInstanceGroupResponse = string;
3685
+ export type UpdateInstanceGroupData = {
3686
+ name: string;
3687
+ /**
3688
+ * update instance group
3689
+ */
3690
+ requestBody: {
3691
+ new_summary: string;
3692
+ };
3693
+ };
3694
+ export type UpdateInstanceGroupResponse = string;
3695
+ export type DeleteInstanceGroupData = {
3696
+ name: string;
3697
+ };
3698
+ export type DeleteInstanceGroupResponse = string;
3699
+ export type AddUserToInstanceGroupData = {
3700
+ name: string;
3701
+ /**
3702
+ * user to add to instance group
3703
+ */
3704
+ requestBody: {
3705
+ email: string;
3706
+ };
3707
+ };
3708
+ export type AddUserToInstanceGroupResponse = string;
3709
+ export type RemoveUserFromInstanceGroupData = {
3710
+ name: string;
3711
+ /**
3712
+ * user to remove from instance group
3713
+ */
3714
+ requestBody: {
3715
+ email: string;
3716
+ };
3717
+ };
3718
+ export type RemoveUserFromInstanceGroupResponse = string;
3719
+ export type ListGroupsData = {
3720
+ /**
3721
+ * which page to return (start at 1, default 1)
3722
+ */
3723
+ page?: number;
3724
+ /**
3725
+ * number of items to return for a given page (default 30, max 100)
3726
+ */
3727
+ perPage?: number;
3728
+ workspace: string;
3729
+ };
3730
+ export type ListGroupsResponse = Array<Group>;
3731
+ export type ListGroupNamesData = {
3732
+ /**
3733
+ * only list the groups the user is member of (default false)
3734
+ */
3735
+ onlyMemberOf?: boolean;
3736
+ workspace: string;
3737
+ };
3738
+ export type ListGroupNamesResponse = Array<(string)>;
3739
+ export type CreateGroupData = {
3740
+ /**
3741
+ * create group
3742
+ */
3743
+ requestBody: {
3744
+ name: string;
3745
+ summary?: string;
3746
+ };
3747
+ workspace: string;
3748
+ };
3749
+ export type CreateGroupResponse = string;
3750
+ export type UpdateGroupData = {
3751
+ name: string;
3752
+ /**
3753
+ * updated group
3754
+ */
3755
+ requestBody: {
3756
+ summary?: string;
3757
+ };
3758
+ workspace: string;
3759
+ };
3760
+ export type UpdateGroupResponse = string;
3761
+ export type DeleteGroupData = {
3762
+ name: string;
3763
+ workspace: string;
3764
+ };
3765
+ export type DeleteGroupResponse = string;
3766
+ export type GetGroupData = {
3767
+ name: string;
3768
+ workspace: string;
3769
+ };
3770
+ export type GetGroupResponse = Group;
3771
+ export type AddUserToGroupData = {
3772
+ name: string;
3773
+ /**
3774
+ * added user to group
3775
+ */
3776
+ requestBody: {
3777
+ username?: string;
3778
+ };
3779
+ workspace: string;
3780
+ };
3781
+ export type AddUserToGroupResponse = string;
3782
+ export type RemoveUserToGroupData = {
3783
+ name: string;
3784
+ /**
3785
+ * added user to group
3786
+ */
3787
+ requestBody: {
3788
+ username?: string;
3789
+ };
3790
+ workspace: string;
3791
+ };
3792
+ export type RemoveUserToGroupResponse = string;
3793
+ export type ListFoldersData = {
3794
+ /**
3795
+ * which page to return (start at 1, default 1)
3796
+ */
3797
+ page?: number;
3798
+ /**
3799
+ * number of items to return for a given page (default 30, max 100)
3800
+ */
3801
+ perPage?: number;
3802
+ workspace: string;
3803
+ };
3804
+ export type ListFoldersResponse = Array<Folder>;
3805
+ export type ListFolderNamesData = {
3806
+ /**
3807
+ * only list the folders the user is member of (default false)
3808
+ */
3809
+ onlyMemberOf?: boolean;
3810
+ workspace: string;
3811
+ };
3812
+ export type ListFolderNamesResponse = Array<(string)>;
3813
+ export type CreateFolderData = {
3814
+ /**
3815
+ * create folder
3816
+ */
3817
+ requestBody: {
3818
+ name: string;
3819
+ owners?: Array<(string)>;
3820
+ extra_perms?: unknown;
3821
+ };
3822
+ workspace: string;
3823
+ };
3824
+ export type CreateFolderResponse = string;
3825
+ export type UpdateFolderData = {
3826
+ name: string;
3827
+ /**
3828
+ * update folder
3829
+ */
3830
+ requestBody: {
3831
+ owners?: Array<(string)>;
3832
+ extra_perms?: unknown;
3833
+ };
3834
+ workspace: string;
3835
+ };
3836
+ export type UpdateFolderResponse = string;
3837
+ export type DeleteFolderData = {
3838
+ name: string;
3839
+ workspace: string;
3840
+ };
3841
+ export type DeleteFolderResponse = string;
3842
+ export type GetFolderData = {
3843
+ name: string;
3844
+ workspace: string;
3845
+ };
3846
+ export type GetFolderResponse = Folder;
3847
+ export type GetFolderUsageData = {
3848
+ name: string;
3849
+ workspace: string;
3850
+ };
3851
+ export type GetFolderUsageResponse = {
3852
+ scripts: number;
3853
+ flows: number;
3854
+ apps: number;
3855
+ resources: number;
3856
+ variables: number;
3857
+ schedules: number;
3858
+ };
3859
+ export type AddOwnerToFolderData = {
3860
+ name: string;
3861
+ /**
3862
+ * owner user to folder
3863
+ */
3864
+ requestBody: {
3865
+ owner: string;
3866
+ };
3867
+ workspace: string;
3868
+ };
3869
+ export type AddOwnerToFolderResponse = string;
3870
+ export type RemoveOwnerToFolderData = {
3871
+ name: string;
3872
+ /**
3873
+ * added owner to folder
3874
+ */
3875
+ requestBody: {
3876
+ owner: string;
3877
+ write?: boolean;
3878
+ };
3879
+ workspace: string;
3880
+ };
3881
+ export type RemoveOwnerToFolderResponse = string;
3882
+ export type ListWorkerGroupsResponse = Array<{
3883
+ name: string;
3884
+ config: unknown;
3885
+ }>;
3886
+ export type GetConfigData = {
3887
+ name: string;
3888
+ };
3889
+ export type GetConfigResponse = unknown;
3890
+ export type UpdateConfigData = {
3891
+ name: string;
3892
+ /**
3893
+ * worker group
3894
+ */
3895
+ requestBody: unknown;
3896
+ };
3897
+ export type UpdateConfigResponse = string;
3898
+ export type DeleteConfigData = {
3899
+ name: string;
3900
+ };
3901
+ export type DeleteConfigResponse = string;
3902
+ export type GetGranularAclsData = {
3903
+ kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
3904
+ path: string;
3905
+ workspace: string;
3906
+ };
3907
+ export type GetGranularAclsResponse = {
3908
+ [key: string]: (boolean);
3909
+ };
3910
+ export type AddGranularAclsData = {
3911
+ kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
3912
+ path: string;
3913
+ /**
3914
+ * acl to add
3915
+ */
3916
+ requestBody: {
3917
+ owner: string;
3918
+ write?: boolean;
3919
+ };
3920
+ workspace: string;
3921
+ };
3922
+ export type AddGranularAclsResponse = string;
3923
+ export type RemoveGranularAclsData = {
3924
+ kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app';
3925
+ path: string;
3926
+ /**
3927
+ * acl to add
3928
+ */
3929
+ requestBody: {
3930
+ owner: string;
3931
+ };
3932
+ workspace: string;
3933
+ };
3934
+ export type RemoveGranularAclsResponse = string;
3935
+ export type UpdateCaptureData = {
3936
+ path: string;
3937
+ workspace: string;
3938
+ };
3939
+ export type UpdateCaptureResponse = void;
3940
+ export type CreateCaptureData = {
3941
+ path: string;
3942
+ workspace: string;
3943
+ };
3944
+ export type CreateCaptureResponse = unknown;
3945
+ export type GetCaptureData = {
3946
+ path: string;
3947
+ workspace: string;
3948
+ };
3949
+ export type GetCaptureResponse = unknown;
3950
+ export type StarData = {
3951
+ requestBody?: {
3952
+ path?: string;
3953
+ favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
3954
+ };
3955
+ workspace: string;
3956
+ };
3957
+ export type StarResponse = unknown;
3958
+ export type UnstarData = {
3959
+ requestBody?: {
3960
+ path?: string;
3961
+ favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
3962
+ };
3963
+ workspace: string;
3964
+ };
3965
+ export type UnstarResponse = unknown;
3966
+ export type GetInputHistoryData = {
3967
+ /**
3968
+ * which page to return (start at 1, default 1)
3969
+ */
3970
+ page?: number;
3971
+ /**
3972
+ * number of items to return for a given page (default 30, max 100)
3973
+ */
3974
+ perPage?: number;
3975
+ runnableId?: string;
3976
+ runnableType?: RunnableType;
3977
+ workspace: string;
3978
+ };
3979
+ export type GetInputHistoryResponse = Array<Input>;
3980
+ export type GetArgsFromHistoryOrSavedInputData = {
3981
+ jobOrInputId: string;
3982
+ workspace: string;
3983
+ };
3984
+ export type GetArgsFromHistoryOrSavedInputResponse = unknown;
3985
+ export type ListInputsData = {
3986
+ /**
3987
+ * which page to return (start at 1, default 1)
3988
+ */
3989
+ page?: number;
3990
+ /**
3991
+ * number of items to return for a given page (default 30, max 100)
3992
+ */
3993
+ perPage?: number;
3994
+ runnableId?: string;
3995
+ runnableType?: RunnableType;
3996
+ workspace: string;
3997
+ };
3998
+ export type ListInputsResponse = Array<Input>;
3999
+ export type CreateInputData = {
4000
+ /**
4001
+ * Input
4002
+ */
4003
+ requestBody: CreateInput;
4004
+ runnableId?: string;
4005
+ runnableType?: RunnableType;
4006
+ workspace: string;
4007
+ };
4008
+ export type CreateInputResponse = string;
4009
+ export type UpdateInputData = {
4010
+ /**
4011
+ * UpdateInput
4012
+ */
4013
+ requestBody: UpdateInput;
4014
+ workspace: string;
4015
+ };
4016
+ export type UpdateInputResponse = string;
4017
+ export type DeleteInputData = {
4018
+ input: string;
4019
+ workspace: string;
4020
+ };
4021
+ export type DeleteInputResponse = string;
4022
+ export type DuckdbConnectionSettingsData = {
4023
+ /**
4024
+ * S3 resource to connect to
4025
+ */
4026
+ requestBody: {
4027
+ s3_resource?: S3Resource;
4028
+ };
4029
+ workspace: string;
4030
+ };
4031
+ export type DuckdbConnectionSettingsResponse = {
4032
+ connection_settings_str?: string;
4033
+ };
4034
+ export type DuckdbConnectionSettingsV2Data = {
4035
+ /**
4036
+ * S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
4037
+ */
4038
+ requestBody: {
4039
+ s3_resource_path?: string;
4040
+ };
4041
+ workspace: string;
4042
+ };
4043
+ export type DuckdbConnectionSettingsV2Response = {
4044
+ connection_settings_str: string;
4045
+ };
4046
+ export type PolarsConnectionSettingsData = {
4047
+ /**
4048
+ * S3 resource to connect to
4049
+ */
4050
+ requestBody: {
4051
+ s3_resource?: S3Resource;
4052
+ };
4053
+ workspace: string;
4054
+ };
4055
+ export type PolarsConnectionSettingsResponse = {
4056
+ endpoint_url: string;
4057
+ key?: string;
4058
+ secret?: string;
4059
+ use_ssl: boolean;
4060
+ cache_regions: boolean;
4061
+ client_kwargs: PolarsClientKwargs;
4062
+ };
4063
+ export type PolarsConnectionSettingsV2Data = {
4064
+ /**
4065
+ * S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
4066
+ */
4067
+ requestBody: {
4068
+ s3_resource_path?: string;
4069
+ };
4070
+ workspace: string;
4071
+ };
4072
+ export type PolarsConnectionSettingsV2Response = {
4073
+ s3fs_args: {
4074
+ endpoint_url: string;
4075
+ key?: string;
4076
+ secret?: string;
4077
+ use_ssl: boolean;
4078
+ cache_regions: boolean;
4079
+ client_kwargs: PolarsClientKwargs;
4080
+ };
4081
+ storage_options: {
4082
+ aws_endpoint_url: string;
4083
+ aws_access_key_id?: string;
4084
+ aws_secret_access_key?: string;
4085
+ aws_region: string;
4086
+ aws_allow_http: string;
4087
+ };
4088
+ };
4089
+ export type S3ResourceInfoData = {
4090
+ /**
4091
+ * S3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used
4092
+ */
4093
+ requestBody: {
4094
+ s3_resource_path?: string;
4095
+ };
4096
+ workspace: string;
4097
+ };
4098
+ export type S3ResourceInfoResponse = S3Resource;
4099
+ export type DatasetStorageTestConnectionData = {
4100
+ workspace: string;
4101
+ };
4102
+ export type DatasetStorageTestConnectionResponse = unknown;
4103
+ export type ListStoredFilesData = {
4104
+ marker?: string;
4105
+ maxKeys: number;
4106
+ prefix?: string;
4107
+ workspace: string;
4108
+ };
4109
+ export type ListStoredFilesResponse = {
4110
+ next_marker?: string;
4111
+ windmill_large_files: Array<WindmillLargeFile>;
4112
+ restricted_access?: boolean;
4113
+ };
4114
+ export type LoadFileMetadataData = {
4115
+ fileKey: string;
4116
+ workspace: string;
4117
+ };
4118
+ export type LoadFileMetadataResponse = WindmillFileMetadata;
4119
+ export type LoadFilePreviewData = {
4120
+ csvHasHeader?: boolean;
4121
+ csvSeparator?: string;
4122
+ fileKey: string;
4123
+ fileMimeType?: string;
4124
+ fileSizeInBytes?: number;
4125
+ readBytesFrom?: number;
4126
+ readBytesLength?: number;
4127
+ workspace: string;
4128
+ };
4129
+ export type LoadFilePreviewResponse = WindmillFilePreview;
4130
+ export type LoadParquetPreviewData = {
4131
+ limit?: number;
4132
+ offset?: number;
4133
+ path: string;
4134
+ searchCol?: string;
4135
+ searchTerm?: string;
4136
+ sortCol?: string;
4137
+ sortDesc?: boolean;
4138
+ workspace: string;
4139
+ };
4140
+ export type LoadParquetPreviewResponse = unknown;
4141
+ export type DeleteS3FileData = {
4142
+ fileKey: string;
4143
+ workspace: string;
4144
+ };
4145
+ export type DeleteS3FileResponse = unknown;
4146
+ export type MoveS3FileData = {
4147
+ destFileKey: string;
4148
+ srcFileKey: string;
4149
+ workspace: string;
4150
+ };
4151
+ export type MoveS3FileResponse = unknown;
4152
+ export type FileUploadData = {
4153
+ fileExtension?: string;
4154
+ fileKey?: string;
4155
+ /**
4156
+ * File content
4157
+ */
4158
+ requestBody: (Blob | File);
4159
+ resourceType?: string;
4160
+ s3ResourcePath?: string;
4161
+ workspace: string;
4162
+ };
4163
+ export type FileUploadResponse = {
4164
+ file_key: string;
4165
+ };
4166
+ export type FileDownloadData = {
4167
+ fileKey: string;
4168
+ resourceType?: string;
4169
+ s3ResourcePath?: string;
4170
+ workspace: string;
4171
+ };
4172
+ export type FileDownloadResponse = (Blob | File);
4173
+ export type GetJobMetricsData = {
4174
+ id: string;
4175
+ /**
4176
+ * parameters for statistics retrieval
4177
+ */
4178
+ requestBody: {
4179
+ timeseries_max_datapoints?: number;
4180
+ from_timestamp?: string;
4181
+ to_timestamp?: string;
4182
+ };
4183
+ workspace: string;
4184
+ };
4185
+ export type GetJobMetricsResponse = {
4186
+ metrics_metadata?: Array<MetricMetadata>;
4187
+ scalar_metrics?: Array<ScalarMetric>;
4188
+ timeseries_metrics?: Array<TimeseriesMetric>;
4189
+ };
4190
+ export type ListConcurrencyGroupsResponse = Array<ConcurrencyGroup>;
4191
+ export type DeleteConcurrencyGroupData = {
4192
+ concurrencyId: string;
4193
+ };
4194
+ export type DeleteConcurrencyGroupResponse = unknown;
1044
4195
  export type $OpenApiTs = {
1045
4196
  '/version': {
1046
4197
  get: {
@@ -6541,6 +9692,20 @@ export type $OpenApiTs = {
6541
9692
  };
6542
9693
  };
6543
9694
  };
9695
+ '/w/{workspace}/inputs/{jobOrInputId}/args': {
9696
+ get: {
9697
+ req: {
9698
+ jobOrInputId: string;
9699
+ workspace: string;
9700
+ };
9701
+ res: {
9702
+ /**
9703
+ * args
9704
+ */
9705
+ 200: unknown;
9706
+ };
9707
+ };
9708
+ };
6544
9709
  '/w/{workspace}/inputs/list': {
6545
9710
  get: {
6546
9711
  req: {