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