@engini/client 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +32 -0
- package/dist/index.cjs +12 -12
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +517 -776
- package/dist/index.d.ts +517 -776
- package/dist/index.js +12 -12
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -320,7 +320,7 @@ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
|
320
320
|
type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
321
321
|
|
|
322
322
|
type ClientOptions = {
|
|
323
|
-
baseUrl: 'https://
|
|
323
|
+
baseUrl: 'https://api.staging.engini.io' | (string & {});
|
|
324
324
|
};
|
|
325
325
|
/**
|
|
326
326
|
* Identity of the principal a Developer API request is authenticated as, returned by
|
|
@@ -1073,77 +1073,25 @@ type UninstallSolutionRequest = {
|
|
|
1073
1073
|
*/
|
|
1074
1074
|
deleteTables: boolean;
|
|
1075
1075
|
};
|
|
1076
|
-
/**
|
|
1077
|
-
* Offset-based paginated wrapper for a list of items.
|
|
1078
|
-
*/
|
|
1079
1076
|
type PaginatedResponseOfApplicationDto = {
|
|
1080
|
-
/**
|
|
1081
|
-
* The items in the current page.
|
|
1082
|
-
*/
|
|
1083
1077
|
items: Array<ApplicationDto>;
|
|
1084
|
-
/**
|
|
1085
|
-
* Total number of items available across all pages.
|
|
1086
|
-
*/
|
|
1087
1078
|
totalCount: number;
|
|
1088
|
-
/**
|
|
1089
|
-
* Number of items skipped before this page (the requested offset).
|
|
1090
|
-
*/
|
|
1091
1079
|
offset: number;
|
|
1092
|
-
/**
|
|
1093
|
-
* Maximum number of items requested for this page.
|
|
1094
|
-
*/
|
|
1095
1080
|
top: number;
|
|
1096
1081
|
};
|
|
1097
|
-
/**
|
|
1098
|
-
* Public Developer API v1 representation of an Application.
|
|
1099
|
-
* Returned by GET /api/DeveloperAPI/v1/applications.
|
|
1100
|
-
*/
|
|
1101
1082
|
type ApplicationDto = {
|
|
1102
|
-
/**
|
|
1103
|
-
* Stable public slug identifying the application.
|
|
1104
|
-
*/
|
|
1105
1083
|
slug: string;
|
|
1106
|
-
/**
|
|
1107
|
-
* Human-readable display name of the application.
|
|
1108
|
-
*/
|
|
1109
1084
|
applicationName?: string | null;
|
|
1110
|
-
/**
|
|
1111
|
-
* Description of what the application does.
|
|
1112
|
-
*/
|
|
1113
1085
|
description: string;
|
|
1114
|
-
/**
|
|
1115
|
-
* URL of the application's logo image.
|
|
1116
|
-
*/
|
|
1117
1086
|
applicationLogo?: string | null;
|
|
1118
|
-
/**
|
|
1119
|
-
* Whether and how a connection is required to use this application.
|
|
1120
|
-
*/
|
|
1121
1087
|
connectionRequirement: string;
|
|
1122
|
-
/**
|
|
1123
|
-
* Categories the application belongs to.
|
|
1124
|
-
*/
|
|
1125
1088
|
categories: Array<string>;
|
|
1126
|
-
/**
|
|
1127
|
-
* Number of tools (activities) the application exposes.
|
|
1128
|
-
*/
|
|
1129
1089
|
toolsCount: number;
|
|
1130
|
-
/**
|
|
1131
|
-
* Number of triggers the application exposes.
|
|
1132
|
-
*/
|
|
1133
1090
|
triggersCount: number;
|
|
1134
1091
|
};
|
|
1135
1092
|
type ApplicationDetailDto = ApplicationDto & {
|
|
1136
|
-
/**
|
|
1137
|
-
* Whether the application supports selecting specific objects for a connection.
|
|
1138
|
-
*/
|
|
1139
1093
|
supportsObjectSelection?: boolean;
|
|
1140
|
-
/**
|
|
1141
|
-
* URL of help/documentation for the application.
|
|
1142
|
-
*/
|
|
1143
1094
|
helpUrl?: string | null;
|
|
1144
|
-
/**
|
|
1145
|
-
* Authentication methods supported by the application.
|
|
1146
|
-
*/
|
|
1147
1095
|
authenticationMethods?: Array<ApplicationAuthMethod>;
|
|
1148
1096
|
};
|
|
1149
1097
|
type ApplicationAuthMethod = {
|
|
@@ -1154,6 +1102,7 @@ type ApplicationAuthMethod = {
|
|
|
1154
1102
|
connectionFields: Array<ApplicationConnectionField>;
|
|
1155
1103
|
requiresOAuthSignIn: boolean;
|
|
1156
1104
|
oAuthProvider?: string | null;
|
|
1105
|
+
isDefault: boolean;
|
|
1157
1106
|
};
|
|
1158
1107
|
type ApplicationConnectionField = {
|
|
1159
1108
|
fieldName: string;
|
|
@@ -1167,300 +1116,97 @@ type ApplicationConnectionField = {
|
|
|
1167
1116
|
tooltip?: string | null;
|
|
1168
1117
|
placeholder?: string | null;
|
|
1169
1118
|
listValues?: string | null;
|
|
1170
|
-
/**
|
|
1171
|
-
* When true, callers can supply this field's value per-execution via the
|
|
1172
|
-
* `customConnectionData` array on POST /tools/{toolSlug}/execute. Mirrors
|
|
1173
|
-
* AppConnectionField.AllowOverride.
|
|
1174
|
-
*/
|
|
1175
1119
|
allowOverride: boolean;
|
|
1176
1120
|
};
|
|
1177
1121
|
type AppConnectionFieldInputType = 0 | 1 | 2 | 3;
|
|
1178
|
-
/**
|
|
1179
|
-
* Offset-based paginated wrapper for a list of items.
|
|
1180
|
-
*/
|
|
1181
1122
|
type PaginatedResponseOfConnectionPublicListItem = {
|
|
1182
|
-
/**
|
|
1183
|
-
* The items in the current page.
|
|
1184
|
-
*/
|
|
1185
1123
|
items: Array<ConnectionPublicListItem>;
|
|
1186
|
-
/**
|
|
1187
|
-
* Total number of items available across all pages.
|
|
1188
|
-
*/
|
|
1189
1124
|
totalCount: number;
|
|
1190
|
-
/**
|
|
1191
|
-
* Number of items skipped before this page (the requested offset).
|
|
1192
|
-
*/
|
|
1193
1125
|
offset: number;
|
|
1194
|
-
/**
|
|
1195
|
-
* Maximum number of items requested for this page.
|
|
1196
|
-
*/
|
|
1197
1126
|
top: number;
|
|
1198
1127
|
};
|
|
1199
|
-
/**
|
|
1200
|
-
* Public-shape list item for /api/DeveloperAPI/v1/Connections.
|
|
1201
|
-
* Applications are identified by slug only (no ApplicationId in the wire response).
|
|
1202
|
-
* Internal queries continue to use ConnectionList which carries both.
|
|
1203
|
-
*/
|
|
1204
1128
|
type ConnectionPublicListItem = {
|
|
1205
|
-
/**
|
|
1206
|
-
* Identifier of the connection.
|
|
1207
|
-
*/
|
|
1208
1129
|
connectionId: number;
|
|
1209
|
-
/**
|
|
1210
|
-
* Display name of the connection.
|
|
1211
|
-
*/
|
|
1212
1130
|
connectionName: string;
|
|
1213
|
-
/**
|
|
1214
|
-
* Description of the connection.
|
|
1215
|
-
*/
|
|
1216
1131
|
description?: string | null;
|
|
1217
|
-
/**
|
|
1218
|
-
* Slug of the connection's application.
|
|
1219
|
-
*/
|
|
1220
1132
|
applicationSlug: string;
|
|
1221
|
-
/**
|
|
1222
|
-
* Display name of the connection's application.
|
|
1223
|
-
*/
|
|
1224
1133
|
applicationName?: string | null;
|
|
1225
|
-
/**
|
|
1226
|
-
* URL of the application's logo image.
|
|
1227
|
-
*/
|
|
1228
1134
|
applicationLogo?: string | null;
|
|
1229
|
-
/**
|
|
1230
|
-
* Whether the connection is shared/public.
|
|
1231
|
-
*/
|
|
1232
1135
|
isPublic: boolean;
|
|
1233
|
-
/**
|
|
1234
|
-
* Identifier of the user who created the connection.
|
|
1235
|
-
*/
|
|
1236
1136
|
createdBy: string;
|
|
1237
|
-
/**
|
|
1238
|
-
* When the connection was created.
|
|
1239
|
-
*/
|
|
1240
1137
|
createdDate: string;
|
|
1241
|
-
/**
|
|
1242
|
-
* Identifier of the user who last updated the connection; null if never updated.
|
|
1243
|
-
*/
|
|
1244
1138
|
updatedBy?: string | null;
|
|
1245
|
-
/**
|
|
1246
|
-
* When the connection was last updated; null if never updated.
|
|
1247
|
-
*/
|
|
1248
1139
|
updatedDate?: string | null;
|
|
1249
1140
|
};
|
|
1250
1141
|
type ConnectionPublicDetail = ConnectionPublicListItem & {
|
|
1251
|
-
/**
|
|
1252
|
-
* Identifier of the authentication method used by the connection.
|
|
1253
|
-
*/
|
|
1254
1142
|
authenticationId?: number;
|
|
1255
|
-
/**
|
|
1256
|
-
* Name of the authentication type used by the connection.
|
|
1257
|
-
*/
|
|
1258
1143
|
authenticationType?: string;
|
|
1259
|
-
/**
|
|
1260
|
-
* Connection field values, keyed by field name (sensitive values may be masked).
|
|
1261
|
-
*/
|
|
1262
1144
|
fields?: {
|
|
1263
1145
|
[key: string]: string | null;
|
|
1264
1146
|
};
|
|
1265
|
-
/**
|
|
1266
|
-
* Whether the connection uses selected database objects.
|
|
1267
|
-
*/
|
|
1268
1147
|
useSelectDBObjects?: boolean;
|
|
1269
|
-
/**
|
|
1270
|
-
* Last connection error message, if any.
|
|
1271
|
-
*/
|
|
1272
1148
|
connectionError?: string | null;
|
|
1273
|
-
/**
|
|
1274
|
-
* Whether the connection is currently healthy/reachable.
|
|
1275
|
-
*/
|
|
1276
1149
|
isAlive?: boolean;
|
|
1277
|
-
/**
|
|
1278
|
-
* Additional connection metadata, keyed by name.
|
|
1279
|
-
*/
|
|
1280
1150
|
metadata?: {
|
|
1281
1151
|
[key: string]: string;
|
|
1282
1152
|
} | null;
|
|
1283
1153
|
};
|
|
1284
|
-
/**
|
|
1285
|
-
* Request body for creating a connection.
|
|
1286
|
-
*/
|
|
1287
1154
|
type CreateConnectionRequest = {
|
|
1288
|
-
/**
|
|
1289
|
-
* Slug of the application to connect to.
|
|
1290
|
-
*/
|
|
1291
1155
|
applicationSlug: string;
|
|
1292
|
-
/**
|
|
1293
|
-
* Display name for the new connection.
|
|
1294
|
-
*/
|
|
1295
1156
|
connectionName: string;
|
|
1296
|
-
/**
|
|
1297
|
-
* Optional description of the connection.
|
|
1298
|
-
*/
|
|
1299
1157
|
description?: string | null;
|
|
1300
|
-
|
|
1301
|
-
* Identifier of the authentication method to use.
|
|
1302
|
-
*/
|
|
1303
|
-
authenticationId: number;
|
|
1304
|
-
/**
|
|
1305
|
-
* Connection field values, keyed by field name.
|
|
1306
|
-
*/
|
|
1158
|
+
authenticationId?: number | null;
|
|
1307
1159
|
fields: {
|
|
1308
1160
|
[key: string]: string;
|
|
1309
1161
|
};
|
|
1310
|
-
/**
|
|
1311
|
-
* Optional additional connection metadata, keyed by name.
|
|
1312
|
-
*/
|
|
1313
1162
|
metadata?: {
|
|
1314
1163
|
[key: string]: string;
|
|
1315
1164
|
} | null;
|
|
1316
1165
|
};
|
|
1317
|
-
/**
|
|
1318
|
-
* Request body for updating a connection; null members are left unchanged.
|
|
1319
|
-
*/
|
|
1320
1166
|
type UpdateConnectionRequest = {
|
|
1321
|
-
/**
|
|
1322
|
-
* New display name; null leaves it unchanged.
|
|
1323
|
-
*/
|
|
1324
1167
|
connectionName?: string | null;
|
|
1325
|
-
/**
|
|
1326
|
-
* New description; null leaves it unchanged.
|
|
1327
|
-
*/
|
|
1328
1168
|
description?: string | null;
|
|
1329
|
-
/**
|
|
1330
|
-
* Connection field values to update, keyed by field name; null leaves them unchanged.
|
|
1331
|
-
*/
|
|
1332
1169
|
fields?: {
|
|
1333
1170
|
[key: string]: string;
|
|
1334
1171
|
} | null;
|
|
1335
|
-
/**
|
|
1336
|
-
* Metadata to update, keyed by name; null leaves it unchanged.
|
|
1337
|
-
*/
|
|
1338
1172
|
metadata?: {
|
|
1339
1173
|
[key: string]: string;
|
|
1340
1174
|
} | null;
|
|
1341
1175
|
};
|
|
1342
|
-
/**
|
|
1343
|
-
* Response listing the caller's default connection per application.
|
|
1344
|
-
*/
|
|
1345
1176
|
type DefaultConnectionsResponse = {
|
|
1346
|
-
/**
|
|
1347
|
-
* The default-connection entries, one per application.
|
|
1348
|
-
*/
|
|
1349
1177
|
items: Array<DefaultConnectionDto>;
|
|
1350
1178
|
};
|
|
1351
|
-
/**
|
|
1352
|
-
* Per-(account-user, application) default-connection responses for the
|
|
1353
|
-
* /connections/defaults endpoints. See toolsets-and-connections-spec.md.
|
|
1354
|
-
*/
|
|
1355
1179
|
type DefaultConnectionDto = {
|
|
1356
|
-
/**
|
|
1357
|
-
* Slug of the application this default applies to.
|
|
1358
|
-
*/
|
|
1359
1180
|
applicationSlug: string;
|
|
1360
|
-
/**
|
|
1361
|
-
* Display name of the application.
|
|
1362
|
-
*/
|
|
1363
1181
|
applicationName?: string | null;
|
|
1364
|
-
/**
|
|
1365
|
-
* Identifier of the default connection (Connector ID).
|
|
1366
|
-
*/
|
|
1367
1182
|
connectionId: number;
|
|
1368
|
-
/**
|
|
1369
|
-
* Display name of the default connection.
|
|
1370
|
-
*/
|
|
1371
1183
|
connectionName?: string | null;
|
|
1372
1184
|
};
|
|
1373
|
-
/**
|
|
1374
|
-
* Response confirming a connection was set as the default for an application.
|
|
1375
|
-
*/
|
|
1376
1185
|
type SetDefaultConnectionResponse = {
|
|
1377
|
-
/**
|
|
1378
|
-
* Slug of the application the default was set for.
|
|
1379
|
-
*/
|
|
1380
1186
|
applicationSlug: string;
|
|
1381
|
-
/**
|
|
1382
|
-
* Identifier of the connection set as default.
|
|
1383
|
-
*/
|
|
1384
1187
|
connectionId: number;
|
|
1385
|
-
/**
|
|
1386
|
-
* Whether the connection is now the default (always true).
|
|
1387
|
-
*/
|
|
1388
1188
|
isDefault: boolean;
|
|
1389
1189
|
};
|
|
1390
|
-
/**
|
|
1391
|
-
* Request body for replacing a connection used by a workflow.
|
|
1392
|
-
*/
|
|
1393
1190
|
type ReplaceConnectionRequest = {
|
|
1394
|
-
/**
|
|
1395
|
-
* Identifier of the workflow whose connection is being replaced.
|
|
1396
|
-
*/
|
|
1397
1191
|
workflowId: number;
|
|
1398
|
-
/**
|
|
1399
|
-
* Identifier of the connection currently used by the workflow.
|
|
1400
|
-
*/
|
|
1401
1192
|
originalConnectionId: number;
|
|
1402
|
-
/**
|
|
1403
|
-
* Identifier of the connection to use instead.
|
|
1404
|
-
*/
|
|
1405
1193
|
newConnectionId: number;
|
|
1406
1194
|
};
|
|
1407
|
-
/**
|
|
1408
|
-
* Status of a connection's most recent metadata/object refresh.
|
|
1409
|
-
*/
|
|
1410
1195
|
type RefreshStatusResponse = {
|
|
1411
|
-
/**
|
|
1412
|
-
* Current refresh status.
|
|
1413
|
-
*/
|
|
1414
1196
|
status: RefreshStatus;
|
|
1415
|
-
/**
|
|
1416
|
-
* Human-readable description of the current status.
|
|
1417
|
-
*/
|
|
1418
1197
|
statusDescription?: string | null;
|
|
1419
|
-
/**
|
|
1420
|
-
* Error message from the last failed refresh, if any.
|
|
1421
|
-
*/
|
|
1422
1198
|
error?: string | null;
|
|
1423
|
-
/**
|
|
1424
|
-
* When the last error occurred, if any.
|
|
1425
|
-
*/
|
|
1426
1199
|
errorDate?: string | null;
|
|
1427
|
-
/**
|
|
1428
|
-
* When the connection was last refreshed successfully.
|
|
1429
|
-
*/
|
|
1430
1200
|
lastRefreshDate?: string | null;
|
|
1431
1201
|
};
|
|
1432
|
-
/**
|
|
1433
|
-
* Possible states of a connection refresh.
|
|
1434
|
-
*/
|
|
1435
1202
|
type RefreshStatus = 0 | 1 | 2;
|
|
1436
|
-
/**
|
|
1437
|
-
* Request body for selecting which objects a connection exposes.
|
|
1438
|
-
*/
|
|
1439
1203
|
type SelectObjectsRequest = {
|
|
1440
|
-
/**
|
|
1441
|
-
* Identifiers of the objects to select for the connection.
|
|
1442
|
-
*/
|
|
1443
1204
|
objectIds: Array<number>;
|
|
1444
1205
|
};
|
|
1445
|
-
/**
|
|
1446
|
-
* Offset-based paginated wrapper for a list of items.
|
|
1447
|
-
*/
|
|
1448
1206
|
type PaginatedResponseOfConnectionObject = {
|
|
1449
|
-
/**
|
|
1450
|
-
* The items in the current page.
|
|
1451
|
-
*/
|
|
1452
1207
|
items: Array<ConnectionObject>;
|
|
1453
|
-
/**
|
|
1454
|
-
* Total number of items available across all pages.
|
|
1455
|
-
*/
|
|
1456
1208
|
totalCount: number;
|
|
1457
|
-
/**
|
|
1458
|
-
* Number of items skipped before this page (the requested offset).
|
|
1459
|
-
*/
|
|
1460
1209
|
offset: number;
|
|
1461
|
-
/**
|
|
1462
|
-
* Maximum number of items requested for this page.
|
|
1463
|
-
*/
|
|
1464
1210
|
top: number;
|
|
1465
1211
|
};
|
|
1466
1212
|
type ConnectionObject = {
|
|
@@ -1469,38 +1215,14 @@ type ConnectionObject = {
|
|
|
1469
1215
|
type: string;
|
|
1470
1216
|
isSelected: boolean;
|
|
1471
1217
|
};
|
|
1472
|
-
/**
|
|
1473
|
-
* Response containing a generated OAuth sign-in URL.
|
|
1474
|
-
*/
|
|
1475
1218
|
type SignInUrlResponse = {
|
|
1476
|
-
/**
|
|
1477
|
-
* The URL the user should visit to authenticate.
|
|
1478
|
-
*/
|
|
1479
1219
|
signInUrl: string;
|
|
1480
|
-
/**
|
|
1481
|
-
* Opaque state value tying the sign-in flow back to the request.
|
|
1482
|
-
*/
|
|
1483
1220
|
state: string;
|
|
1484
1221
|
};
|
|
1485
|
-
/**
|
|
1486
|
-
* Request body for generating an OAuth sign-in URL.
|
|
1487
|
-
*/
|
|
1488
1222
|
type SignInUrlRequest = {
|
|
1489
|
-
/**
|
|
1490
|
-
* Slug of the application to authenticate against.
|
|
1491
|
-
*/
|
|
1492
1223
|
applicationSlug: string;
|
|
1493
|
-
/**
|
|
1494
|
-
* Identifier of the authentication method to use.
|
|
1495
|
-
*/
|
|
1496
1224
|
authenticationId: number;
|
|
1497
|
-
/**
|
|
1498
|
-
* Optional environment to target for sign-in.
|
|
1499
|
-
*/
|
|
1500
1225
|
environment?: string | null;
|
|
1501
|
-
/**
|
|
1502
|
-
* Optional field values required to build the sign-in URL, keyed by field name.
|
|
1503
|
-
*/
|
|
1504
1226
|
fields?: {
|
|
1505
1227
|
[key: string]: string;
|
|
1506
1228
|
} | null;
|
|
@@ -1515,192 +1237,58 @@ type AccessTokenResponse = {
|
|
|
1515
1237
|
[key: string]: unknown;
|
|
1516
1238
|
};
|
|
1517
1239
|
};
|
|
1518
|
-
/**
|
|
1519
|
-
* Offset-based paginated wrapper for a list of items.
|
|
1520
|
-
*/
|
|
1521
1240
|
type PaginatedResponseOfToolDto = {
|
|
1522
|
-
/**
|
|
1523
|
-
* The items in the current page.
|
|
1524
|
-
*/
|
|
1525
1241
|
items: Array<ToolDto>;
|
|
1526
|
-
/**
|
|
1527
|
-
* Total number of items available across all pages.
|
|
1528
|
-
*/
|
|
1529
1242
|
totalCount: number;
|
|
1530
|
-
/**
|
|
1531
|
-
* Number of items skipped before this page (the requested offset).
|
|
1532
|
-
*/
|
|
1533
1243
|
offset: number;
|
|
1534
|
-
/**
|
|
1535
|
-
* Maximum number of items requested for this page.
|
|
1536
|
-
*/
|
|
1537
1244
|
top: number;
|
|
1538
1245
|
};
|
|
1539
|
-
/**
|
|
1540
|
-
* Public Developer API v1 representation of a tool (Activity).
|
|
1541
|
-
* Returned by GET /api/DeveloperAPI/v1/tools.
|
|
1542
|
-
*/
|
|
1543
1246
|
type ToolDto = {
|
|
1544
|
-
/**
|
|
1545
|
-
* Public identifier, sourced from Activity.McpToolName.
|
|
1546
|
-
*/
|
|
1547
1247
|
toolSlug: string;
|
|
1548
|
-
/**
|
|
1549
|
-
* Human-readable display name of the tool.
|
|
1550
|
-
*/
|
|
1551
1248
|
toolName?: string | null;
|
|
1552
|
-
/**
|
|
1553
|
-
* Description of what the tool does.
|
|
1554
|
-
*/
|
|
1555
1249
|
description?: string | null;
|
|
1556
|
-
/**
|
|
1557
|
-
* Category the tool belongs to.
|
|
1558
|
-
*/
|
|
1559
1250
|
category: string;
|
|
1560
|
-
/**
|
|
1561
|
-
* Slug of the application this tool belongs to.
|
|
1562
|
-
*/
|
|
1563
1251
|
applicationSlug: string;
|
|
1564
|
-
/**
|
|
1565
|
-
* Display name of the application this tool belongs to.
|
|
1566
|
-
*/
|
|
1567
1252
|
applicationName?: string | null;
|
|
1568
|
-
/**
|
|
1569
|
-
* Version of the tool.
|
|
1570
|
-
*/
|
|
1571
1253
|
version?: string | null;
|
|
1572
|
-
/**
|
|
1573
|
-
* Whether the tool is deprecated.
|
|
1574
|
-
*/
|
|
1575
1254
|
isDeprecated: boolean;
|
|
1576
1255
|
};
|
|
1577
1256
|
type ToolDetailDto = ToolDto & {
|
|
1578
|
-
/**
|
|
1579
|
-
* JSON Schema describing the tool's input fields.
|
|
1580
|
-
*/
|
|
1581
1257
|
inputSchema?: unknown;
|
|
1582
|
-
/**
|
|
1583
|
-
* JSON Schema describing the tool's output shape.
|
|
1584
|
-
*/
|
|
1585
1258
|
outputSchema?: unknown;
|
|
1586
|
-
/**
|
|
1587
|
-
* Whether the tool supports filter conditions on execution.
|
|
1588
|
-
*/
|
|
1589
1259
|
supportsFilters?: boolean;
|
|
1590
|
-
/**
|
|
1591
|
-
* Whether the tool supports sort ordering on execution.
|
|
1592
|
-
*/
|
|
1593
1260
|
supportsSort?: boolean;
|
|
1594
|
-
/**
|
|
1595
|
-
* Whether the tool supports top/offset pagination on execution.
|
|
1596
|
-
*/
|
|
1597
1261
|
supportsTopOffset?: boolean;
|
|
1598
|
-
/**
|
|
1599
|
-
* Maximum number of filter conditions allowed per execution.
|
|
1600
|
-
*/
|
|
1601
1262
|
maxFilters?: number;
|
|
1602
|
-
/**
|
|
1603
|
-
* Maximum number of sort clauses allowed per execution.
|
|
1604
|
-
*/
|
|
1605
1263
|
maxSorts?: number;
|
|
1606
1264
|
};
|
|
1607
|
-
/**
|
|
1608
|
-
* 200 response shape for POST /api/DeveloperAPI/v1/tools/{toolSlug}/execute.
|
|
1609
|
-
* Tool-runtime failures (downstream API errors) return 200 + IsSuccess=false
|
|
1610
|
-
* + ErrorMessage — not the standard error envelope. All non-200 responses use
|
|
1611
|
-
* the standard ErrorResponse envelope, not this type.
|
|
1612
|
-
* See applications-tools-spec.md §"Response 200".
|
|
1613
|
-
*/
|
|
1614
1265
|
type ToolExecuteResponse = {
|
|
1615
|
-
/**
|
|
1616
|
-
* Whether the tool executed successfully. When false, see ErrorMessage.
|
|
1617
|
-
*/
|
|
1618
1266
|
isSuccess: boolean;
|
|
1619
|
-
/**
|
|
1620
|
-
* Human-readable failure reason when IsSuccess is false; otherwise null.
|
|
1621
|
-
*/
|
|
1622
1267
|
errorMessage?: string | null;
|
|
1623
|
-
/**
|
|
1624
|
-
* Metadata about the execution (HTTP status, headers, timing, payload size).
|
|
1625
|
-
*/
|
|
1626
1268
|
executionInfo?: ExecutionInfo | null;
|
|
1627
|
-
/**
|
|
1628
|
-
* The tool's result payload. Intentionally free-form (any JSON): its shape is defined by the
|
|
1629
|
-
* individual tool's output schema, not by this envelope (api-spec-feedback.md C3).
|
|
1630
|
-
*/
|
|
1631
1269
|
output?: unknown;
|
|
1632
|
-
/**
|
|
1633
|
-
* Identifier of the workflow-history record for this execution, when one was created.
|
|
1634
|
-
*/
|
|
1635
1270
|
historyId?: number | null;
|
|
1636
1271
|
};
|
|
1637
|
-
/**
|
|
1638
|
-
* Metadata about a tool execution (downstream HTTP status, headers, timing, payload size).
|
|
1639
|
-
*/
|
|
1640
1272
|
type ExecutionInfo = {
|
|
1641
|
-
/**
|
|
1642
|
-
* HTTP status code returned by the downstream call.
|
|
1643
|
-
*/
|
|
1644
1273
|
statusCode?: number | null;
|
|
1645
|
-
/**
|
|
1646
|
-
* Response headers from the downstream call, keyed by header name.
|
|
1647
|
-
*/
|
|
1648
1274
|
headers?: {
|
|
1649
1275
|
[key: string]: string;
|
|
1650
1276
|
} | null;
|
|
1651
|
-
/**
|
|
1652
|
-
* Execution time in milliseconds.
|
|
1653
|
-
*/
|
|
1654
1277
|
executionTime?: number | null;
|
|
1655
|
-
/**
|
|
1656
|
-
* Size of the response payload in bytes.
|
|
1657
|
-
*/
|
|
1658
1278
|
dataSize?: number | null;
|
|
1659
1279
|
};
|
|
1660
|
-
/**
|
|
1661
|
-
* Body shape for POST /api/DeveloperAPI/v1/tools/{toolSlug}/execute.
|
|
1662
|
-
* activityName is intentionally absent — the activity is resolved from the
|
|
1663
|
-
* path slug (+ optional ?applicationSlug=). Connection is resolved implicitly
|
|
1664
|
-
* from the caller's account-user, the tool's parent application, and the
|
|
1665
|
-
* optional ?toolsetId= query param. See applications-tools-spec.md §"POST
|
|
1666
|
-
* /api/DeveloperAPI/v1/tools/{toolSlug}/execute".
|
|
1667
|
-
*/
|
|
1668
1280
|
type ToolExecuteRequest = {
|
|
1669
|
-
/**
|
|
1670
|
-
* Input field values for the tool, keyed by field name.
|
|
1671
|
-
*/
|
|
1672
1281
|
fields?: {
|
|
1673
1282
|
[key: string]: unknown;
|
|
1674
1283
|
} | null;
|
|
1675
|
-
/**
|
|
1676
|
-
* Optional context value passed to the tool.
|
|
1677
|
-
*/
|
|
1678
1284
|
contextValue?: string | null;
|
|
1679
|
-
/**
|
|
1680
|
-
* Filter conditions to apply to the tool's results.
|
|
1681
|
-
*/
|
|
1682
1285
|
filters?: Array<ActivityCondition> | null;
|
|
1683
|
-
/**
|
|
1684
|
-
* Sort clauses to apply to the tool's results.
|
|
1685
|
-
*/
|
|
1686
1286
|
sort?: Array<ActivitySort> | null;
|
|
1687
|
-
/**
|
|
1688
|
-
* Number of leading results to skip (pagination offset).
|
|
1689
|
-
*/
|
|
1690
1287
|
offset?: number | null;
|
|
1691
|
-
/**
|
|
1692
|
-
* Maximum number of results to return.
|
|
1693
|
-
*/
|
|
1694
1288
|
top?: number | null;
|
|
1695
|
-
/**
|
|
1696
|
-
* Sub-item input values for the tool, keyed by name.
|
|
1697
|
-
*/
|
|
1698
1289
|
subItems?: {
|
|
1699
1290
|
[key: string]: unknown;
|
|
1700
1291
|
} | null;
|
|
1701
|
-
/**
|
|
1702
|
-
* Per-call overrides for the resolved connection's fields; only fields marked overridable are accepted.
|
|
1703
|
-
*/
|
|
1704
1292
|
customConnectionData?: Array<CustomConnectionDataItem> | null;
|
|
1705
1293
|
};
|
|
1706
1294
|
type ActivityCondition = {
|
|
@@ -1713,155 +1301,45 @@ type ActivitySort = {
|
|
|
1713
1301
|
orderDirection: OrderDirection;
|
|
1714
1302
|
};
|
|
1715
1303
|
type OrderDirection = 1 | -1;
|
|
1716
|
-
/**
|
|
1717
|
-
* A single per-call override of a connection field value.
|
|
1718
|
-
*/
|
|
1719
1304
|
type CustomConnectionDataItem = {
|
|
1720
|
-
/**
|
|
1721
|
-
* Name of the connection field to override.
|
|
1722
|
-
*/
|
|
1723
1305
|
fieldName: string;
|
|
1724
|
-
/**
|
|
1725
|
-
* Override value for the field.
|
|
1726
|
-
*/
|
|
1727
1306
|
value: string;
|
|
1728
1307
|
};
|
|
1729
|
-
/**
|
|
1730
|
-
* Offset-based paginated wrapper for a list of items.
|
|
1731
|
-
*/
|
|
1732
1308
|
type PaginatedResponseOfToolsetDto = {
|
|
1733
|
-
/**
|
|
1734
|
-
* The items in the current page.
|
|
1735
|
-
*/
|
|
1736
1309
|
items: Array<ToolsetDto>;
|
|
1737
|
-
/**
|
|
1738
|
-
* Total number of items available across all pages.
|
|
1739
|
-
*/
|
|
1740
1310
|
totalCount: number;
|
|
1741
|
-
/**
|
|
1742
|
-
* Number of items skipped before this page (the requested offset).
|
|
1743
|
-
*/
|
|
1744
1311
|
offset: number;
|
|
1745
|
-
/**
|
|
1746
|
-
* Maximum number of items requested for this page.
|
|
1747
|
-
*/
|
|
1748
1312
|
top: number;
|
|
1749
1313
|
};
|
|
1750
|
-
/**
|
|
1751
|
-
* Public-shape DTO for a toolset (per-account-user, named scope bundling specific
|
|
1752
|
-
* connections + an allowed tool set). See toolsets-and-connections-spec.md.
|
|
1753
|
-
*/
|
|
1754
1314
|
type ToolsetDto = {
|
|
1755
|
-
/**
|
|
1756
|
-
* Unique identifier of the toolset (the MCPServer token GUID).
|
|
1757
|
-
*/
|
|
1758
1315
|
toolsetId: string;
|
|
1759
|
-
/**
|
|
1760
|
-
* Display name of the toolset.
|
|
1761
|
-
*/
|
|
1762
1316
|
name: string;
|
|
1763
|
-
/**
|
|
1764
|
-
* Connections included in this toolset and their permitted tools.
|
|
1765
|
-
*/
|
|
1766
1317
|
connections: Array<ToolsetConnectionDto>;
|
|
1767
|
-
/**
|
|
1768
|
-
* Workflow token GUIDs included in this toolset.
|
|
1769
|
-
*/
|
|
1770
1318
|
workflows: Array<string>;
|
|
1771
|
-
/**
|
|
1772
|
-
* When the toolset was created.
|
|
1773
|
-
*/
|
|
1774
1319
|
createdDate: string;
|
|
1775
|
-
/**
|
|
1776
|
-
* When the toolset was last updated; null if never updated.
|
|
1777
|
-
*/
|
|
1778
1320
|
updatedDate?: string | null;
|
|
1779
|
-
/**
|
|
1780
|
-
* Account-user ID that created the toolset.
|
|
1781
|
-
*/
|
|
1782
1321
|
createdByAccountUserId?: number | null;
|
|
1783
|
-
/**
|
|
1784
|
-
* Account-user ID that last updated the toolset; null/0 until first updated.
|
|
1785
|
-
*/
|
|
1786
1322
|
updatedByAccountUserId?: number | null;
|
|
1787
1323
|
};
|
|
1788
|
-
/**
|
|
1789
|
-
* A connection within a toolset, scoped to a set of permitted tools.
|
|
1790
|
-
*/
|
|
1791
1324
|
type ToolsetConnectionDto = {
|
|
1792
|
-
/**
|
|
1793
|
-
* Identifier of the connection (Connector ID).
|
|
1794
|
-
*/
|
|
1795
1325
|
connectionId: number;
|
|
1796
|
-
/**
|
|
1797
|
-
* Slug of the connection's application.
|
|
1798
|
-
*/
|
|
1799
1326
|
applicationSlug: string;
|
|
1800
|
-
/**
|
|
1801
|
-
* Display name of the connection's application.
|
|
1802
|
-
*/
|
|
1803
1327
|
applicationName?: string | null;
|
|
1804
|
-
/**
|
|
1805
|
-
* Tool slugs permitted for this connection; empty means all tools of the app are permitted.
|
|
1806
|
-
*/
|
|
1807
1328
|
toolSlugs: Array<string>;
|
|
1808
1329
|
};
|
|
1809
|
-
/**
|
|
1810
|
-
* Request body for creating a toolset.
|
|
1811
|
-
*/
|
|
1812
1330
|
type CreateToolsetRequest = {
|
|
1813
|
-
/**
|
|
1814
|
-
* Display name for the new toolset.
|
|
1815
|
-
*/
|
|
1816
1331
|
name: string;
|
|
1817
|
-
/**
|
|
1818
|
-
* Connections to include in the toolset and their permitted tools.
|
|
1819
|
-
*/
|
|
1820
1332
|
connections: Array<ToolsetConnectionRequest>;
|
|
1821
|
-
/**
|
|
1822
|
-
* Workflow token GUIDs to include in the toolset.
|
|
1823
|
-
*/
|
|
1824
1333
|
workflows?: Array<string> | null;
|
|
1825
1334
|
};
|
|
1826
|
-
/**
|
|
1827
|
-
* A connection entry in a create/update toolset request.
|
|
1828
|
-
*/
|
|
1829
1335
|
type ToolsetConnectionRequest = {
|
|
1830
|
-
/**
|
|
1831
|
-
* Optional connection identifier (Connector ID). Omit it to let the backend pick the
|
|
1832
|
-
* caller's default connection for the application of the listed tools (resolved and
|
|
1833
|
-
* stored as a concrete id at save time); when omitted, ToolSlugs must list
|
|
1834
|
-
* at least one tool so the application can be determined.
|
|
1835
|
-
*/
|
|
1836
1336
|
connectionId?: number | null;
|
|
1837
|
-
/**
|
|
1838
|
-
* Optional application slug. When ConnectionId is omitted, supply this to
|
|
1839
|
-
* scope the entry to a whole application (all its tools) using the caller's default
|
|
1840
|
-
* connection for that app — resolved and stored as a concrete connectionId at save time.
|
|
1841
|
-
* An alternative to listing tool slugs; if both are supplied, applicationSlug is
|
|
1842
|
-
* authoritative for the application.
|
|
1843
|
-
*/
|
|
1844
1337
|
applicationSlug?: string | null;
|
|
1845
|
-
/**
|
|
1846
|
-
* Tool slugs to permit for this connection; omit/empty to permit all tools of the app. When ConnectionId is omitted, supply either applicationSlug or at least one tool slug.
|
|
1847
|
-
*/
|
|
1848
1338
|
toolSlugs?: Array<string> | null;
|
|
1849
1339
|
};
|
|
1850
|
-
/**
|
|
1851
|
-
* Request body for updating a toolset; null members are left unchanged.
|
|
1852
|
-
*/
|
|
1853
1340
|
type UpdateToolsetRequest = {
|
|
1854
|
-
/**
|
|
1855
|
-
* New display name; null leaves it unchanged.
|
|
1856
|
-
*/
|
|
1857
1341
|
name?: string | null;
|
|
1858
|
-
/**
|
|
1859
|
-
* Replacement connection set; null leaves it unchanged.
|
|
1860
|
-
*/
|
|
1861
1342
|
connections?: Array<ToolsetConnectionRequest> | null;
|
|
1862
|
-
/**
|
|
1863
|
-
* Replacement workflow set; null leaves it unchanged.
|
|
1864
|
-
*/
|
|
1865
1343
|
workflows?: Array<string> | null;
|
|
1866
1344
|
};
|
|
1867
1345
|
type AuthWhoAmIData = {
|
|
@@ -1878,24 +1356,27 @@ type AuthWhoAmIData = {
|
|
|
1878
1356
|
};
|
|
1879
1357
|
type AuthWhoAmIErrors = {
|
|
1880
1358
|
/**
|
|
1881
|
-
* Bad request
|
|
1359
|
+
* Bad request - malformed body or invalid parameters.
|
|
1882
1360
|
*/
|
|
1883
1361
|
400: ErrorResponse;
|
|
1362
|
+
/**
|
|
1363
|
+
* Unauthorized - missing or invalid bearer token.
|
|
1364
|
+
*/
|
|
1884
1365
|
401: ErrorResponse;
|
|
1885
1366
|
/**
|
|
1886
|
-
* Forbidden
|
|
1367
|
+
* Forbidden - the caller lacks access to the resource.
|
|
1887
1368
|
*/
|
|
1888
1369
|
403: ErrorResponse;
|
|
1889
1370
|
/**
|
|
1890
|
-
* Not found
|
|
1371
|
+
* Not found - the resource does not exist.
|
|
1891
1372
|
*/
|
|
1892
1373
|
404: ErrorResponse;
|
|
1893
1374
|
/**
|
|
1894
|
-
* Too many requests
|
|
1375
|
+
* Too many requests - rate limit exceeded.
|
|
1895
1376
|
*/
|
|
1896
1377
|
429: ErrorResponse;
|
|
1897
1378
|
/**
|
|
1898
|
-
* Internal server error
|
|
1379
|
+
* Internal server error - an unexpected error occurred.
|
|
1899
1380
|
*/
|
|
1900
1381
|
500: ErrorResponse;
|
|
1901
1382
|
};
|
|
@@ -1914,7 +1395,7 @@ type SolutionsCreateSolutionData = {
|
|
|
1914
1395
|
body: CreateSolutionRequest;
|
|
1915
1396
|
headers?: {
|
|
1916
1397
|
/**
|
|
1917
|
-
*
|
|
1398
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
1918
1399
|
*/
|
|
1919
1400
|
companytoken?: string;
|
|
1920
1401
|
};
|
|
@@ -1923,22 +1404,28 @@ type SolutionsCreateSolutionData = {
|
|
|
1923
1404
|
url: '/v1/solutions/admin';
|
|
1924
1405
|
};
|
|
1925
1406
|
type SolutionsCreateSolutionErrors = {
|
|
1407
|
+
/**
|
|
1408
|
+
* Bad request - malformed body or invalid parameters.
|
|
1409
|
+
*/
|
|
1926
1410
|
400: ErrorResponse;
|
|
1927
1411
|
/**
|
|
1928
|
-
* Unauthorized
|
|
1412
|
+
* Unauthorized - missing or invalid bearer token.
|
|
1929
1413
|
*/
|
|
1930
1414
|
401: ErrorResponse;
|
|
1415
|
+
/**
|
|
1416
|
+
* Forbidden - the caller lacks access to the resource.
|
|
1417
|
+
*/
|
|
1931
1418
|
403: ErrorResponse;
|
|
1932
1419
|
/**
|
|
1933
|
-
* Not found
|
|
1420
|
+
* Not found - the resource does not exist.
|
|
1934
1421
|
*/
|
|
1935
1422
|
404: ErrorResponse;
|
|
1936
1423
|
/**
|
|
1937
|
-
* Too many requests
|
|
1424
|
+
* Too many requests - rate limit exceeded.
|
|
1938
1425
|
*/
|
|
1939
1426
|
429: ErrorResponse;
|
|
1940
1427
|
/**
|
|
1941
|
-
* Internal server error
|
|
1428
|
+
* Internal server error - an unexpected error occurred.
|
|
1942
1429
|
*/
|
|
1943
1430
|
500: ErrorResponse;
|
|
1944
1431
|
};
|
|
@@ -1969,21 +1456,27 @@ type SolutionsArchiveSolutionData = {
|
|
|
1969
1456
|
};
|
|
1970
1457
|
type SolutionsArchiveSolutionErrors = {
|
|
1971
1458
|
/**
|
|
1972
|
-
* Bad request
|
|
1459
|
+
* Bad request - malformed body or invalid parameters.
|
|
1973
1460
|
*/
|
|
1974
1461
|
400: ErrorResponse;
|
|
1975
1462
|
/**
|
|
1976
|
-
* Unauthorized
|
|
1463
|
+
* Unauthorized - missing or invalid bearer token.
|
|
1977
1464
|
*/
|
|
1978
1465
|
401: ErrorResponse;
|
|
1466
|
+
/**
|
|
1467
|
+
* Forbidden - the caller lacks access to the resource.
|
|
1468
|
+
*/
|
|
1979
1469
|
403: ErrorResponse;
|
|
1470
|
+
/**
|
|
1471
|
+
* Not found - the resource does not exist.
|
|
1472
|
+
*/
|
|
1980
1473
|
404: ErrorResponse;
|
|
1981
1474
|
/**
|
|
1982
|
-
* Too many requests
|
|
1475
|
+
* Too many requests - rate limit exceeded.
|
|
1983
1476
|
*/
|
|
1984
1477
|
429: ErrorResponse;
|
|
1985
1478
|
/**
|
|
1986
|
-
* Internal server error
|
|
1479
|
+
* Internal server error - an unexpected error occurred.
|
|
1987
1480
|
*/
|
|
1988
1481
|
500: ErrorResponse;
|
|
1989
1482
|
};
|
|
@@ -2002,7 +1495,7 @@ type SolutionsUpdateSolutionData = {
|
|
|
2002
1495
|
body: UpdateSolutionRequest;
|
|
2003
1496
|
headers?: {
|
|
2004
1497
|
/**
|
|
2005
|
-
*
|
|
1498
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2006
1499
|
*/
|
|
2007
1500
|
companytoken?: string;
|
|
2008
1501
|
};
|
|
@@ -2016,19 +1509,28 @@ type SolutionsUpdateSolutionData = {
|
|
|
2016
1509
|
url: '/v1/solutions/admin/{slug}';
|
|
2017
1510
|
};
|
|
2018
1511
|
type SolutionsUpdateSolutionErrors = {
|
|
1512
|
+
/**
|
|
1513
|
+
* Bad request - malformed body or invalid parameters.
|
|
1514
|
+
*/
|
|
2019
1515
|
400: ErrorResponse;
|
|
2020
1516
|
/**
|
|
2021
|
-
* Unauthorized
|
|
1517
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2022
1518
|
*/
|
|
2023
1519
|
401: ErrorResponse;
|
|
1520
|
+
/**
|
|
1521
|
+
* Forbidden - the caller lacks access to the resource.
|
|
1522
|
+
*/
|
|
2024
1523
|
403: ErrorResponse;
|
|
1524
|
+
/**
|
|
1525
|
+
* Not found - the resource does not exist.
|
|
1526
|
+
*/
|
|
2025
1527
|
404: ErrorResponse;
|
|
2026
1528
|
/**
|
|
2027
|
-
* Too many requests
|
|
1529
|
+
* Too many requests - rate limit exceeded.
|
|
2028
1530
|
*/
|
|
2029
1531
|
429: ErrorResponse;
|
|
2030
1532
|
/**
|
|
2031
|
-
* Internal server error
|
|
1533
|
+
* Internal server error - an unexpected error occurred.
|
|
2032
1534
|
*/
|
|
2033
1535
|
500: ErrorResponse;
|
|
2034
1536
|
};
|
|
@@ -2058,19 +1560,28 @@ type SolutionsPublishSolutionData = {
|
|
|
2058
1560
|
url: '/v1/solutions/admin/{slug}/publish';
|
|
2059
1561
|
};
|
|
2060
1562
|
type SolutionsPublishSolutionErrors = {
|
|
1563
|
+
/**
|
|
1564
|
+
* Bad request - malformed body or invalid parameters.
|
|
1565
|
+
*/
|
|
2061
1566
|
400: ErrorResponse;
|
|
2062
1567
|
/**
|
|
2063
|
-
* Unauthorized
|
|
1568
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2064
1569
|
*/
|
|
2065
1570
|
401: ErrorResponse;
|
|
1571
|
+
/**
|
|
1572
|
+
* Forbidden - the caller lacks access to the resource.
|
|
1573
|
+
*/
|
|
2066
1574
|
403: ErrorResponse;
|
|
1575
|
+
/**
|
|
1576
|
+
* Not found - the resource does not exist.
|
|
1577
|
+
*/
|
|
2067
1578
|
404: ErrorResponse;
|
|
2068
1579
|
/**
|
|
2069
|
-
* Too many requests
|
|
1580
|
+
* Too many requests - rate limit exceeded.
|
|
2070
1581
|
*/
|
|
2071
1582
|
429: ErrorResponse;
|
|
2072
1583
|
/**
|
|
2073
|
-
* Internal server error
|
|
1584
|
+
* Internal server error - an unexpected error occurred.
|
|
2074
1585
|
*/
|
|
2075
1586
|
500: ErrorResponse;
|
|
2076
1587
|
};
|
|
@@ -2089,7 +1600,7 @@ type SolutionsBuildManifestData = {
|
|
|
2089
1600
|
body: BuildManifestRequest;
|
|
2090
1601
|
headers?: {
|
|
2091
1602
|
/**
|
|
2092
|
-
*
|
|
1603
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2093
1604
|
*/
|
|
2094
1605
|
companytoken?: string;
|
|
2095
1606
|
};
|
|
@@ -2098,19 +1609,28 @@ type SolutionsBuildManifestData = {
|
|
|
2098
1609
|
url: '/v1/solutions/admin/build-manifest';
|
|
2099
1610
|
};
|
|
2100
1611
|
type SolutionsBuildManifestErrors = {
|
|
1612
|
+
/**
|
|
1613
|
+
* Bad request - malformed body or invalid parameters.
|
|
1614
|
+
*/
|
|
2101
1615
|
400: ErrorResponse;
|
|
2102
1616
|
/**
|
|
2103
|
-
* Unauthorized
|
|
1617
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2104
1618
|
*/
|
|
2105
1619
|
401: ErrorResponse;
|
|
1620
|
+
/**
|
|
1621
|
+
* Forbidden - the caller lacks access to the resource.
|
|
1622
|
+
*/
|
|
2106
1623
|
403: ErrorResponse;
|
|
1624
|
+
/**
|
|
1625
|
+
* Not found - the resource does not exist.
|
|
1626
|
+
*/
|
|
2107
1627
|
404: ErrorResponse;
|
|
2108
1628
|
/**
|
|
2109
|
-
* Too many requests
|
|
1629
|
+
* Too many requests - rate limit exceeded.
|
|
2110
1630
|
*/
|
|
2111
1631
|
429: ErrorResponse;
|
|
2112
1632
|
/**
|
|
2113
|
-
* Internal server error
|
|
1633
|
+
* Internal server error - an unexpected error occurred.
|
|
2114
1634
|
*/
|
|
2115
1635
|
500: ErrorResponse;
|
|
2116
1636
|
};
|
|
@@ -2149,27 +1669,27 @@ type SolutionsGetPublishedSolutionsData = {
|
|
|
2149
1669
|
};
|
|
2150
1670
|
type SolutionsGetPublishedSolutionsErrors = {
|
|
2151
1671
|
/**
|
|
2152
|
-
* Bad request
|
|
1672
|
+
* Bad request - malformed body or invalid parameters.
|
|
2153
1673
|
*/
|
|
2154
1674
|
400: ErrorResponse;
|
|
2155
1675
|
/**
|
|
2156
|
-
* Unauthorized
|
|
1676
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2157
1677
|
*/
|
|
2158
1678
|
401: ErrorResponse;
|
|
2159
1679
|
/**
|
|
2160
|
-
* Forbidden
|
|
1680
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2161
1681
|
*/
|
|
2162
1682
|
403: ErrorResponse;
|
|
2163
1683
|
/**
|
|
2164
|
-
* Not found
|
|
1684
|
+
* Not found - the resource does not exist.
|
|
2165
1685
|
*/
|
|
2166
1686
|
404: ErrorResponse;
|
|
2167
1687
|
/**
|
|
2168
|
-
* Too many requests
|
|
1688
|
+
* Too many requests - rate limit exceeded.
|
|
2169
1689
|
*/
|
|
2170
1690
|
429: ErrorResponse;
|
|
2171
1691
|
/**
|
|
2172
|
-
* Internal server error
|
|
1692
|
+
* Internal server error - an unexpected error occurred.
|
|
2173
1693
|
*/
|
|
2174
1694
|
500: ErrorResponse;
|
|
2175
1695
|
};
|
|
@@ -2200,24 +1720,27 @@ type SolutionsGetSolutionBySlugData = {
|
|
|
2200
1720
|
};
|
|
2201
1721
|
type SolutionsGetSolutionBySlugErrors = {
|
|
2202
1722
|
/**
|
|
2203
|
-
* Bad request
|
|
1723
|
+
* Bad request - malformed body or invalid parameters.
|
|
2204
1724
|
*/
|
|
2205
1725
|
400: ErrorResponse;
|
|
2206
1726
|
/**
|
|
2207
|
-
* Unauthorized
|
|
1727
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2208
1728
|
*/
|
|
2209
1729
|
401: ErrorResponse;
|
|
2210
1730
|
/**
|
|
2211
|
-
* Forbidden
|
|
1731
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2212
1732
|
*/
|
|
2213
1733
|
403: ErrorResponse;
|
|
1734
|
+
/**
|
|
1735
|
+
* Not found - the resource does not exist.
|
|
1736
|
+
*/
|
|
2214
1737
|
404: ErrorResponse;
|
|
2215
1738
|
/**
|
|
2216
|
-
* Too many requests
|
|
1739
|
+
* Too many requests - rate limit exceeded.
|
|
2217
1740
|
*/
|
|
2218
1741
|
429: ErrorResponse;
|
|
2219
1742
|
/**
|
|
2220
|
-
* Internal server error
|
|
1743
|
+
* Internal server error - an unexpected error occurred.
|
|
2221
1744
|
*/
|
|
2222
1745
|
500: ErrorResponse;
|
|
2223
1746
|
};
|
|
@@ -2233,7 +1756,7 @@ type SolutionsGetInstallationsData = {
|
|
|
2233
1756
|
body?: never;
|
|
2234
1757
|
headers?: {
|
|
2235
1758
|
/**
|
|
2236
|
-
*
|
|
1759
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2237
1760
|
*/
|
|
2238
1761
|
companytoken?: string;
|
|
2239
1762
|
};
|
|
@@ -2251,25 +1774,28 @@ type SolutionsGetInstallationsData = {
|
|
|
2251
1774
|
url: '/v1/solutions/installations';
|
|
2252
1775
|
};
|
|
2253
1776
|
type SolutionsGetInstallationsErrors = {
|
|
1777
|
+
/**
|
|
1778
|
+
* Bad request - malformed body or invalid parameters.
|
|
1779
|
+
*/
|
|
2254
1780
|
400: ErrorResponse;
|
|
2255
1781
|
/**
|
|
2256
|
-
* Unauthorized
|
|
1782
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2257
1783
|
*/
|
|
2258
1784
|
401: ErrorResponse;
|
|
2259
1785
|
/**
|
|
2260
|
-
* Forbidden
|
|
1786
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2261
1787
|
*/
|
|
2262
1788
|
403: ErrorResponse;
|
|
2263
1789
|
/**
|
|
2264
|
-
* Not found
|
|
1790
|
+
* Not found - the resource does not exist.
|
|
2265
1791
|
*/
|
|
2266
1792
|
404: ErrorResponse;
|
|
2267
1793
|
/**
|
|
2268
|
-
* Too many requests
|
|
1794
|
+
* Too many requests - rate limit exceeded.
|
|
2269
1795
|
*/
|
|
2270
1796
|
429: ErrorResponse;
|
|
2271
1797
|
/**
|
|
2272
|
-
* Internal server error
|
|
1798
|
+
* Internal server error - an unexpected error occurred.
|
|
2273
1799
|
*/
|
|
2274
1800
|
500: ErrorResponse;
|
|
2275
1801
|
};
|
|
@@ -2285,7 +1811,7 @@ type SolutionsGetInstallationDetailData = {
|
|
|
2285
1811
|
body?: never;
|
|
2286
1812
|
headers?: {
|
|
2287
1813
|
/**
|
|
2288
|
-
*
|
|
1814
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2289
1815
|
*/
|
|
2290
1816
|
companytoken?: string;
|
|
2291
1817
|
};
|
|
@@ -2299,22 +1825,28 @@ type SolutionsGetInstallationDetailData = {
|
|
|
2299
1825
|
url: '/v1/solutions/installations/{id}';
|
|
2300
1826
|
};
|
|
2301
1827
|
type SolutionsGetInstallationDetailErrors = {
|
|
1828
|
+
/**
|
|
1829
|
+
* Bad request - malformed body or invalid parameters.
|
|
1830
|
+
*/
|
|
2302
1831
|
400: ErrorResponse;
|
|
2303
1832
|
/**
|
|
2304
|
-
* Unauthorized
|
|
1833
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2305
1834
|
*/
|
|
2306
1835
|
401: ErrorResponse;
|
|
2307
1836
|
/**
|
|
2308
|
-
* Forbidden
|
|
1837
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2309
1838
|
*/
|
|
2310
1839
|
403: ErrorResponse;
|
|
1840
|
+
/**
|
|
1841
|
+
* Not found - the resource does not exist.
|
|
1842
|
+
*/
|
|
2311
1843
|
404: ErrorResponse;
|
|
2312
1844
|
/**
|
|
2313
|
-
* Too many requests
|
|
1845
|
+
* Too many requests - rate limit exceeded.
|
|
2314
1846
|
*/
|
|
2315
1847
|
429: ErrorResponse;
|
|
2316
1848
|
/**
|
|
2317
|
-
* Internal server error
|
|
1849
|
+
* Internal server error - an unexpected error occurred.
|
|
2318
1850
|
*/
|
|
2319
1851
|
500: ErrorResponse;
|
|
2320
1852
|
};
|
|
@@ -2330,7 +1862,7 @@ type SolutionsGetInstallationResourcesData = {
|
|
|
2330
1862
|
body?: never;
|
|
2331
1863
|
headers?: {
|
|
2332
1864
|
/**
|
|
2333
|
-
*
|
|
1865
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2334
1866
|
*/
|
|
2335
1867
|
companytoken?: string;
|
|
2336
1868
|
};
|
|
@@ -2353,22 +1885,28 @@ type SolutionsGetInstallationResourcesData = {
|
|
|
2353
1885
|
url: '/v1/solutions/installations/{id}/resources';
|
|
2354
1886
|
};
|
|
2355
1887
|
type SolutionsGetInstallationResourcesErrors = {
|
|
1888
|
+
/**
|
|
1889
|
+
* Bad request - malformed body or invalid parameters.
|
|
1890
|
+
*/
|
|
2356
1891
|
400: ErrorResponse;
|
|
2357
1892
|
/**
|
|
2358
|
-
* Unauthorized
|
|
1893
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2359
1894
|
*/
|
|
2360
1895
|
401: ErrorResponse;
|
|
2361
1896
|
/**
|
|
2362
|
-
* Forbidden
|
|
1897
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2363
1898
|
*/
|
|
2364
1899
|
403: ErrorResponse;
|
|
1900
|
+
/**
|
|
1901
|
+
* Not found - the resource does not exist.
|
|
1902
|
+
*/
|
|
2365
1903
|
404: ErrorResponse;
|
|
2366
1904
|
/**
|
|
2367
|
-
* Too many requests
|
|
1905
|
+
* Too many requests - rate limit exceeded.
|
|
2368
1906
|
*/
|
|
2369
1907
|
429: ErrorResponse;
|
|
2370
1908
|
/**
|
|
2371
|
-
* Internal server error
|
|
1909
|
+
* Internal server error - an unexpected error occurred.
|
|
2372
1910
|
*/
|
|
2373
1911
|
500: ErrorResponse;
|
|
2374
1912
|
};
|
|
@@ -2387,7 +1925,7 @@ type SolutionsInstallSolutionData = {
|
|
|
2387
1925
|
body: InstallSolutionRequest;
|
|
2388
1926
|
headers?: {
|
|
2389
1927
|
/**
|
|
2390
|
-
*
|
|
1928
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2391
1929
|
*/
|
|
2392
1930
|
companytoken?: string;
|
|
2393
1931
|
};
|
|
@@ -2401,20 +1939,32 @@ type SolutionsInstallSolutionData = {
|
|
|
2401
1939
|
url: '/v1/solutions/{slug}/install';
|
|
2402
1940
|
};
|
|
2403
1941
|
type SolutionsInstallSolutionErrors = {
|
|
1942
|
+
/**
|
|
1943
|
+
* Bad request - malformed body or invalid parameters.
|
|
1944
|
+
*/
|
|
2404
1945
|
400: ErrorResponse;
|
|
1946
|
+
/**
|
|
1947
|
+
* Unauthorized - missing or invalid bearer token.
|
|
1948
|
+
*/
|
|
2405
1949
|
401: ErrorResponse;
|
|
2406
1950
|
/**
|
|
2407
|
-
* Forbidden
|
|
1951
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2408
1952
|
*/
|
|
2409
1953
|
403: ErrorResponse;
|
|
1954
|
+
/**
|
|
1955
|
+
* Not found - the resource does not exist.
|
|
1956
|
+
*/
|
|
2410
1957
|
404: ErrorResponse;
|
|
1958
|
+
/**
|
|
1959
|
+
* Conflict - the solution is already installed in this workspace.
|
|
1960
|
+
*/
|
|
2411
1961
|
409: ErrorResponse;
|
|
2412
1962
|
/**
|
|
2413
|
-
* Too many requests
|
|
1963
|
+
* Too many requests - rate limit exceeded.
|
|
2414
1964
|
*/
|
|
2415
1965
|
429: ErrorResponse;
|
|
2416
1966
|
/**
|
|
2417
|
-
* Internal server error
|
|
1967
|
+
* Internal server error - an unexpected error occurred.
|
|
2418
1968
|
*/
|
|
2419
1969
|
500: ErrorResponse;
|
|
2420
1970
|
};
|
|
@@ -2433,7 +1983,7 @@ type SolutionsUpdateInstallationData = {
|
|
|
2433
1983
|
body?: UpdateInstallationRequest;
|
|
2434
1984
|
headers?: {
|
|
2435
1985
|
/**
|
|
2436
|
-
*
|
|
1986
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2437
1987
|
*/
|
|
2438
1988
|
companytoken?: string;
|
|
2439
1989
|
};
|
|
@@ -2447,23 +1997,32 @@ type SolutionsUpdateInstallationData = {
|
|
|
2447
1997
|
url: '/v1/solutions/installations/{id}/update';
|
|
2448
1998
|
};
|
|
2449
1999
|
type SolutionsUpdateInstallationErrors = {
|
|
2000
|
+
/**
|
|
2001
|
+
* Bad request - malformed body or invalid parameters.
|
|
2002
|
+
*/
|
|
2450
2003
|
400: ErrorResponse;
|
|
2451
2004
|
/**
|
|
2452
|
-
* Unauthorized
|
|
2005
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2453
2006
|
*/
|
|
2454
2007
|
401: ErrorResponse;
|
|
2455
2008
|
/**
|
|
2456
|
-
* Forbidden
|
|
2009
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2457
2010
|
*/
|
|
2458
2011
|
403: ErrorResponse;
|
|
2012
|
+
/**
|
|
2013
|
+
* Not found - the resource does not exist.
|
|
2014
|
+
*/
|
|
2459
2015
|
404: ErrorResponse;
|
|
2016
|
+
/**
|
|
2017
|
+
* Conflict - the update is blocked by one or more conditions, returned in the response body; retry with forceModify=true to proceed anyway.
|
|
2018
|
+
*/
|
|
2460
2019
|
409: UpdateBlockedResponse;
|
|
2461
2020
|
/**
|
|
2462
|
-
* Too many requests
|
|
2021
|
+
* Too many requests - rate limit exceeded.
|
|
2463
2022
|
*/
|
|
2464
2023
|
429: ErrorResponse;
|
|
2465
2024
|
/**
|
|
2466
|
-
* Internal server error
|
|
2025
|
+
* Internal server error - an unexpected error occurred.
|
|
2467
2026
|
*/
|
|
2468
2027
|
500: ErrorResponse;
|
|
2469
2028
|
};
|
|
@@ -2482,7 +2041,7 @@ type SolutionsUninstallSolutionData = {
|
|
|
2482
2041
|
body: UninstallSolutionRequest;
|
|
2483
2042
|
headers?: {
|
|
2484
2043
|
/**
|
|
2485
|
-
*
|
|
2044
|
+
* Optional account-scoping header. Alternative to a claim carried on the Bearer JWT.
|
|
2486
2045
|
*/
|
|
2487
2046
|
companytoken?: string;
|
|
2488
2047
|
};
|
|
@@ -2496,22 +2055,28 @@ type SolutionsUninstallSolutionData = {
|
|
|
2496
2055
|
url: '/v1/solutions/{slug}/uninstall';
|
|
2497
2056
|
};
|
|
2498
2057
|
type SolutionsUninstallSolutionErrors = {
|
|
2058
|
+
/**
|
|
2059
|
+
* Bad request - malformed body or invalid parameters.
|
|
2060
|
+
*/
|
|
2499
2061
|
400: ErrorResponse;
|
|
2500
2062
|
/**
|
|
2501
|
-
* Unauthorized
|
|
2063
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2502
2064
|
*/
|
|
2503
2065
|
401: ErrorResponse;
|
|
2504
2066
|
/**
|
|
2505
|
-
* Forbidden
|
|
2067
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2506
2068
|
*/
|
|
2507
2069
|
403: ErrorResponse;
|
|
2070
|
+
/**
|
|
2071
|
+
* Not found - the resource does not exist.
|
|
2072
|
+
*/
|
|
2508
2073
|
404: ErrorResponse;
|
|
2509
2074
|
/**
|
|
2510
|
-
* Too many requests
|
|
2075
|
+
* Too many requests - rate limit exceeded.
|
|
2511
2076
|
*/
|
|
2512
2077
|
429: ErrorResponse;
|
|
2513
2078
|
/**
|
|
2514
|
-
* Internal server error
|
|
2079
|
+
* Internal server error - an unexpected error occurred.
|
|
2515
2080
|
*/
|
|
2516
2081
|
500: ErrorResponse;
|
|
2517
2082
|
};
|
|
@@ -2565,22 +2130,28 @@ type ApplicationsListApplicationsData = {
|
|
|
2565
2130
|
url: '/v1/applications';
|
|
2566
2131
|
};
|
|
2567
2132
|
type ApplicationsListApplicationsErrors = {
|
|
2133
|
+
/**
|
|
2134
|
+
* Bad request - malformed body or invalid parameters.
|
|
2135
|
+
*/
|
|
2568
2136
|
400: ErrorResponse;
|
|
2137
|
+
/**
|
|
2138
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2139
|
+
*/
|
|
2569
2140
|
401: ErrorResponse;
|
|
2570
2141
|
/**
|
|
2571
|
-
* Forbidden
|
|
2142
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2572
2143
|
*/
|
|
2573
2144
|
403: ErrorResponse;
|
|
2574
2145
|
/**
|
|
2575
|
-
* Not found
|
|
2146
|
+
* Not found - the resource does not exist.
|
|
2576
2147
|
*/
|
|
2577
2148
|
404: ErrorResponse;
|
|
2578
2149
|
/**
|
|
2579
|
-
* Too many requests
|
|
2150
|
+
* Too many requests - rate limit exceeded.
|
|
2580
2151
|
*/
|
|
2581
2152
|
429: ErrorResponse;
|
|
2582
2153
|
/**
|
|
2583
|
-
* Internal server error
|
|
2154
|
+
* Internal server error - an unexpected error occurred.
|
|
2584
2155
|
*/
|
|
2585
2156
|
500: ErrorResponse;
|
|
2586
2157
|
};
|
|
@@ -2611,21 +2182,27 @@ type ApplicationsGetApplicationData = {
|
|
|
2611
2182
|
};
|
|
2612
2183
|
type ApplicationsGetApplicationErrors = {
|
|
2613
2184
|
/**
|
|
2614
|
-
* Bad request
|
|
2185
|
+
* Bad request - malformed body or invalid parameters.
|
|
2615
2186
|
*/
|
|
2616
2187
|
400: ErrorResponse;
|
|
2188
|
+
/**
|
|
2189
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2190
|
+
*/
|
|
2617
2191
|
401: ErrorResponse;
|
|
2618
2192
|
/**
|
|
2619
|
-
* Forbidden
|
|
2193
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2620
2194
|
*/
|
|
2621
2195
|
403: ErrorResponse;
|
|
2196
|
+
/**
|
|
2197
|
+
* Not found - the resource does not exist.
|
|
2198
|
+
*/
|
|
2622
2199
|
404: ErrorResponse;
|
|
2623
2200
|
/**
|
|
2624
|
-
* Too many requests
|
|
2201
|
+
* Too many requests - rate limit exceeded.
|
|
2625
2202
|
*/
|
|
2626
2203
|
429: ErrorResponse;
|
|
2627
2204
|
/**
|
|
2628
|
-
* Internal server error
|
|
2205
|
+
* Internal server error - an unexpected error occurred.
|
|
2629
2206
|
*/
|
|
2630
2207
|
500: ErrorResponse;
|
|
2631
2208
|
};
|
|
@@ -2674,27 +2251,27 @@ type ConnectionsGetConnectionsData = {
|
|
|
2674
2251
|
};
|
|
2675
2252
|
type ConnectionsGetConnectionsErrors = {
|
|
2676
2253
|
/**
|
|
2677
|
-
* Bad request
|
|
2254
|
+
* Bad request - malformed body or invalid parameters.
|
|
2678
2255
|
*/
|
|
2679
2256
|
400: ErrorResponse;
|
|
2680
2257
|
/**
|
|
2681
|
-
* Unauthorized
|
|
2258
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2682
2259
|
*/
|
|
2683
2260
|
401: ErrorResponse;
|
|
2684
2261
|
/**
|
|
2685
|
-
* Forbidden
|
|
2262
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2686
2263
|
*/
|
|
2687
2264
|
403: ErrorResponse;
|
|
2688
2265
|
/**
|
|
2689
|
-
* Not found
|
|
2266
|
+
* Not found - the resource does not exist.
|
|
2690
2267
|
*/
|
|
2691
2268
|
404: ErrorResponse;
|
|
2692
2269
|
/**
|
|
2693
|
-
* Too many requests
|
|
2270
|
+
* Too many requests - rate limit exceeded.
|
|
2694
2271
|
*/
|
|
2695
2272
|
429: ErrorResponse;
|
|
2696
2273
|
/**
|
|
2697
|
-
* Internal server error
|
|
2274
|
+
* Internal server error - an unexpected error occurred.
|
|
2698
2275
|
*/
|
|
2699
2276
|
500: ErrorResponse;
|
|
2700
2277
|
};
|
|
@@ -2723,27 +2300,27 @@ type ConnectionsCreateConnectionData = {
|
|
|
2723
2300
|
};
|
|
2724
2301
|
type ConnectionsCreateConnectionErrors = {
|
|
2725
2302
|
/**
|
|
2726
|
-
* Bad request
|
|
2303
|
+
* Bad request - malformed body or invalid parameters.
|
|
2727
2304
|
*/
|
|
2728
2305
|
400: ErrorResponse;
|
|
2729
2306
|
/**
|
|
2730
|
-
* Unauthorized
|
|
2307
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2731
2308
|
*/
|
|
2732
2309
|
401: ErrorResponse;
|
|
2733
2310
|
/**
|
|
2734
|
-
* Forbidden
|
|
2311
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2735
2312
|
*/
|
|
2736
2313
|
403: ErrorResponse;
|
|
2737
2314
|
/**
|
|
2738
|
-
* Not found
|
|
2315
|
+
* Not found - the resource does not exist.
|
|
2739
2316
|
*/
|
|
2740
2317
|
404: ErrorResponse;
|
|
2741
2318
|
/**
|
|
2742
|
-
* Too many requests
|
|
2319
|
+
* Too many requests - rate limit exceeded.
|
|
2743
2320
|
*/
|
|
2744
2321
|
429: ErrorResponse;
|
|
2745
2322
|
/**
|
|
2746
|
-
* Internal server error
|
|
2323
|
+
* Internal server error - an unexpected error occurred.
|
|
2747
2324
|
*/
|
|
2748
2325
|
500: ErrorResponse;
|
|
2749
2326
|
};
|
|
@@ -2774,27 +2351,27 @@ type ConnectionsDeleteConnectionData = {
|
|
|
2774
2351
|
};
|
|
2775
2352
|
type ConnectionsDeleteConnectionErrors = {
|
|
2776
2353
|
/**
|
|
2777
|
-
* Bad request
|
|
2354
|
+
* Bad request - malformed body or invalid parameters.
|
|
2778
2355
|
*/
|
|
2779
2356
|
400: ErrorResponse;
|
|
2780
2357
|
/**
|
|
2781
|
-
* Unauthorized
|
|
2358
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2782
2359
|
*/
|
|
2783
2360
|
401: ErrorResponse;
|
|
2784
2361
|
/**
|
|
2785
|
-
* Forbidden
|
|
2362
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2786
2363
|
*/
|
|
2787
2364
|
403: ErrorResponse;
|
|
2788
2365
|
/**
|
|
2789
|
-
* Not found
|
|
2366
|
+
* Not found - the resource does not exist.
|
|
2790
2367
|
*/
|
|
2791
2368
|
404: ErrorResponse;
|
|
2792
2369
|
/**
|
|
2793
|
-
* Too many requests
|
|
2370
|
+
* Too many requests - rate limit exceeded.
|
|
2794
2371
|
*/
|
|
2795
2372
|
429: ErrorResponse;
|
|
2796
2373
|
/**
|
|
2797
|
-
* Internal server error
|
|
2374
|
+
* Internal server error - an unexpected error occurred.
|
|
2798
2375
|
*/
|
|
2799
2376
|
500: ErrorResponse;
|
|
2800
2377
|
};
|
|
@@ -2825,27 +2402,27 @@ type ConnectionsGetConnectionData = {
|
|
|
2825
2402
|
};
|
|
2826
2403
|
type ConnectionsGetConnectionErrors = {
|
|
2827
2404
|
/**
|
|
2828
|
-
* Bad request
|
|
2405
|
+
* Bad request - malformed body or invalid parameters.
|
|
2829
2406
|
*/
|
|
2830
2407
|
400: ErrorResponse;
|
|
2831
2408
|
/**
|
|
2832
|
-
* Unauthorized
|
|
2409
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2833
2410
|
*/
|
|
2834
2411
|
401: ErrorResponse;
|
|
2835
2412
|
/**
|
|
2836
|
-
* Forbidden
|
|
2413
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2837
2414
|
*/
|
|
2838
2415
|
403: ErrorResponse;
|
|
2839
2416
|
/**
|
|
2840
|
-
* Not found
|
|
2417
|
+
* Not found - the resource does not exist.
|
|
2841
2418
|
*/
|
|
2842
2419
|
404: ErrorResponse;
|
|
2843
2420
|
/**
|
|
2844
|
-
* Too many requests
|
|
2421
|
+
* Too many requests - rate limit exceeded.
|
|
2845
2422
|
*/
|
|
2846
2423
|
429: ErrorResponse;
|
|
2847
2424
|
/**
|
|
2848
|
-
* Internal server error
|
|
2425
|
+
* Internal server error - an unexpected error occurred.
|
|
2849
2426
|
*/
|
|
2850
2427
|
500: ErrorResponse;
|
|
2851
2428
|
};
|
|
@@ -2879,27 +2456,27 @@ type ConnectionsUpdateConnectionData = {
|
|
|
2879
2456
|
};
|
|
2880
2457
|
type ConnectionsUpdateConnectionErrors = {
|
|
2881
2458
|
/**
|
|
2882
|
-
* Bad request
|
|
2459
|
+
* Bad request - malformed body or invalid parameters.
|
|
2883
2460
|
*/
|
|
2884
2461
|
400: ErrorResponse;
|
|
2885
2462
|
/**
|
|
2886
|
-
* Unauthorized
|
|
2463
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2887
2464
|
*/
|
|
2888
2465
|
401: ErrorResponse;
|
|
2889
2466
|
/**
|
|
2890
|
-
* Forbidden
|
|
2467
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2891
2468
|
*/
|
|
2892
2469
|
403: ErrorResponse;
|
|
2893
2470
|
/**
|
|
2894
|
-
* Not found
|
|
2471
|
+
* Not found - the resource does not exist.
|
|
2895
2472
|
*/
|
|
2896
2473
|
404: ErrorResponse;
|
|
2897
2474
|
/**
|
|
2898
|
-
* Too many requests
|
|
2475
|
+
* Too many requests - rate limit exceeded.
|
|
2899
2476
|
*/
|
|
2900
2477
|
429: ErrorResponse;
|
|
2901
2478
|
/**
|
|
2902
|
-
* Internal server error
|
|
2479
|
+
* Internal server error - an unexpected error occurred.
|
|
2903
2480
|
*/
|
|
2904
2481
|
500: ErrorResponse;
|
|
2905
2482
|
};
|
|
@@ -2921,31 +2498,31 @@ type ConnectionsGetDefaultConnectionsData = {
|
|
|
2921
2498
|
};
|
|
2922
2499
|
path?: never;
|
|
2923
2500
|
query?: never;
|
|
2924
|
-
url: '/v1/connections/
|
|
2501
|
+
url: '/v1/connections/defaults';
|
|
2925
2502
|
};
|
|
2926
2503
|
type ConnectionsGetDefaultConnectionsErrors = {
|
|
2927
2504
|
/**
|
|
2928
|
-
* Bad request
|
|
2505
|
+
* Bad request - malformed body or invalid parameters.
|
|
2929
2506
|
*/
|
|
2930
2507
|
400: ErrorResponse;
|
|
2931
2508
|
/**
|
|
2932
|
-
* Unauthorized
|
|
2509
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2933
2510
|
*/
|
|
2934
2511
|
401: ErrorResponse;
|
|
2935
2512
|
/**
|
|
2936
|
-
* Forbidden
|
|
2513
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2937
2514
|
*/
|
|
2938
2515
|
403: ErrorResponse;
|
|
2939
2516
|
/**
|
|
2940
|
-
* Not found
|
|
2517
|
+
* Not found - the resource does not exist.
|
|
2941
2518
|
*/
|
|
2942
2519
|
404: ErrorResponse;
|
|
2943
2520
|
/**
|
|
2944
|
-
* Too many requests
|
|
2521
|
+
* Too many requests - rate limit exceeded.
|
|
2945
2522
|
*/
|
|
2946
2523
|
429: ErrorResponse;
|
|
2947
2524
|
/**
|
|
2948
|
-
* Internal server error
|
|
2525
|
+
* Internal server error - an unexpected error occurred.
|
|
2949
2526
|
*/
|
|
2950
2527
|
500: ErrorResponse;
|
|
2951
2528
|
};
|
|
@@ -2972,31 +2549,31 @@ type ConnectionsClearDefaultConnectionData = {
|
|
|
2972
2549
|
connectionId: number;
|
|
2973
2550
|
};
|
|
2974
2551
|
query?: never;
|
|
2975
|
-
url: '/v1/connections/{connectionId}/
|
|
2552
|
+
url: '/v1/connections/{connectionId}/default';
|
|
2976
2553
|
};
|
|
2977
2554
|
type ConnectionsClearDefaultConnectionErrors = {
|
|
2978
2555
|
/**
|
|
2979
|
-
* Bad request
|
|
2556
|
+
* Bad request - malformed body or invalid parameters.
|
|
2980
2557
|
*/
|
|
2981
2558
|
400: ErrorResponse;
|
|
2982
2559
|
/**
|
|
2983
|
-
* Unauthorized
|
|
2560
|
+
* Unauthorized - missing or invalid bearer token.
|
|
2984
2561
|
*/
|
|
2985
2562
|
401: ErrorResponse;
|
|
2986
2563
|
/**
|
|
2987
|
-
* Forbidden
|
|
2564
|
+
* Forbidden - the caller lacks access to the resource.
|
|
2988
2565
|
*/
|
|
2989
2566
|
403: ErrorResponse;
|
|
2990
2567
|
/**
|
|
2991
|
-
* Not found
|
|
2568
|
+
* Not found - the resource does not exist.
|
|
2992
2569
|
*/
|
|
2993
2570
|
404: ErrorResponse;
|
|
2994
2571
|
/**
|
|
2995
|
-
* Too many requests
|
|
2572
|
+
* Too many requests - rate limit exceeded.
|
|
2996
2573
|
*/
|
|
2997
2574
|
429: ErrorResponse;
|
|
2998
2575
|
/**
|
|
2999
|
-
* Internal server error
|
|
2576
|
+
* Internal server error - an unexpected error occurred.
|
|
3000
2577
|
*/
|
|
3001
2578
|
500: ErrorResponse;
|
|
3002
2579
|
};
|
|
@@ -3023,31 +2600,31 @@ type ConnectionsSetDefaultConnectionData = {
|
|
|
3023
2600
|
connectionId: number;
|
|
3024
2601
|
};
|
|
3025
2602
|
query?: never;
|
|
3026
|
-
url: '/v1/connections/{connectionId}/
|
|
2603
|
+
url: '/v1/connections/{connectionId}/default';
|
|
3027
2604
|
};
|
|
3028
2605
|
type ConnectionsSetDefaultConnectionErrors = {
|
|
3029
2606
|
/**
|
|
3030
|
-
* Bad request
|
|
2607
|
+
* Bad request - malformed body or invalid parameters.
|
|
3031
2608
|
*/
|
|
3032
2609
|
400: ErrorResponse;
|
|
3033
2610
|
/**
|
|
3034
|
-
* Unauthorized
|
|
2611
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3035
2612
|
*/
|
|
3036
2613
|
401: ErrorResponse;
|
|
3037
2614
|
/**
|
|
3038
|
-
* Forbidden
|
|
2615
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3039
2616
|
*/
|
|
3040
2617
|
403: ErrorResponse;
|
|
3041
2618
|
/**
|
|
3042
|
-
* Not found
|
|
2619
|
+
* Not found - the resource does not exist.
|
|
3043
2620
|
*/
|
|
3044
2621
|
404: ErrorResponse;
|
|
3045
2622
|
/**
|
|
3046
|
-
* Too many requests
|
|
2623
|
+
* Too many requests - rate limit exceeded.
|
|
3047
2624
|
*/
|
|
3048
2625
|
429: ErrorResponse;
|
|
3049
2626
|
/**
|
|
3050
|
-
* Internal server error
|
|
2627
|
+
* Internal server error - an unexpected error occurred.
|
|
3051
2628
|
*/
|
|
3052
2629
|
500: ErrorResponse;
|
|
3053
2630
|
};
|
|
@@ -3072,31 +2649,31 @@ type ConnectionsReplaceConnectionData = {
|
|
|
3072
2649
|
};
|
|
3073
2650
|
path?: never;
|
|
3074
2651
|
query?: never;
|
|
3075
|
-
url: '/v1/connections/
|
|
2652
|
+
url: '/v1/connections/replace';
|
|
3076
2653
|
};
|
|
3077
2654
|
type ConnectionsReplaceConnectionErrors = {
|
|
3078
2655
|
/**
|
|
3079
|
-
* Bad request
|
|
2656
|
+
* Bad request - malformed body or invalid parameters.
|
|
3080
2657
|
*/
|
|
3081
2658
|
400: ErrorResponse;
|
|
3082
2659
|
/**
|
|
3083
|
-
* Unauthorized
|
|
2660
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3084
2661
|
*/
|
|
3085
2662
|
401: ErrorResponse;
|
|
3086
2663
|
/**
|
|
3087
|
-
* Forbidden
|
|
2664
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3088
2665
|
*/
|
|
3089
2666
|
403: ErrorResponse;
|
|
3090
2667
|
/**
|
|
3091
|
-
* Not found
|
|
2668
|
+
* Not found - the resource does not exist.
|
|
3092
2669
|
*/
|
|
3093
2670
|
404: ErrorResponse;
|
|
3094
2671
|
/**
|
|
3095
|
-
* Too many requests
|
|
2672
|
+
* Too many requests - rate limit exceeded.
|
|
3096
2673
|
*/
|
|
3097
2674
|
429: ErrorResponse;
|
|
3098
2675
|
/**
|
|
3099
|
-
* Internal server error
|
|
2676
|
+
* Internal server error - an unexpected error occurred.
|
|
3100
2677
|
*/
|
|
3101
2678
|
500: ErrorResponse;
|
|
3102
2679
|
};
|
|
@@ -3123,31 +2700,31 @@ type ConnectionsRefreshObjectsData = {
|
|
|
3123
2700
|
connectionId: number;
|
|
3124
2701
|
};
|
|
3125
2702
|
query?: never;
|
|
3126
|
-
url: '/v1/connections/{connectionId}/
|
|
2703
|
+
url: '/v1/connections/{connectionId}/refresh-objects';
|
|
3127
2704
|
};
|
|
3128
2705
|
type ConnectionsRefreshObjectsErrors = {
|
|
3129
2706
|
/**
|
|
3130
|
-
* Bad request
|
|
2707
|
+
* Bad request - malformed body or invalid parameters.
|
|
3131
2708
|
*/
|
|
3132
2709
|
400: ErrorResponse;
|
|
3133
2710
|
/**
|
|
3134
|
-
* Unauthorized
|
|
2711
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3135
2712
|
*/
|
|
3136
2713
|
401: ErrorResponse;
|
|
3137
2714
|
/**
|
|
3138
|
-
* Forbidden
|
|
2715
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3139
2716
|
*/
|
|
3140
2717
|
403: ErrorResponse;
|
|
3141
2718
|
/**
|
|
3142
|
-
* Not found
|
|
2719
|
+
* Not found - the resource does not exist.
|
|
3143
2720
|
*/
|
|
3144
2721
|
404: ErrorResponse;
|
|
3145
2722
|
/**
|
|
3146
|
-
* Too many requests
|
|
2723
|
+
* Too many requests - rate limit exceeded.
|
|
3147
2724
|
*/
|
|
3148
2725
|
429: ErrorResponse;
|
|
3149
2726
|
/**
|
|
3150
|
-
* Internal server error
|
|
2727
|
+
* Internal server error - an unexpected error occurred.
|
|
3151
2728
|
*/
|
|
3152
2729
|
500: ErrorResponse;
|
|
3153
2730
|
};
|
|
@@ -3174,31 +2751,31 @@ type ConnectionsGetRefreshStatusData = {
|
|
|
3174
2751
|
connectionId: number;
|
|
3175
2752
|
};
|
|
3176
2753
|
query?: never;
|
|
3177
|
-
url: '/v1/connections/{connectionId}/
|
|
2754
|
+
url: '/v1/connections/{connectionId}/refresh-status';
|
|
3178
2755
|
};
|
|
3179
2756
|
type ConnectionsGetRefreshStatusErrors = {
|
|
3180
2757
|
/**
|
|
3181
|
-
* Bad request
|
|
2758
|
+
* Bad request - malformed body or invalid parameters.
|
|
3182
2759
|
*/
|
|
3183
2760
|
400: ErrorResponse;
|
|
3184
2761
|
/**
|
|
3185
|
-
* Unauthorized
|
|
2762
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3186
2763
|
*/
|
|
3187
2764
|
401: ErrorResponse;
|
|
3188
2765
|
/**
|
|
3189
|
-
* Forbidden
|
|
2766
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3190
2767
|
*/
|
|
3191
2768
|
403: ErrorResponse;
|
|
3192
2769
|
/**
|
|
3193
|
-
* Not found
|
|
2770
|
+
* Not found - the resource does not exist.
|
|
3194
2771
|
*/
|
|
3195
2772
|
404: ErrorResponse;
|
|
3196
2773
|
/**
|
|
3197
|
-
* Too many requests
|
|
2774
|
+
* Too many requests - rate limit exceeded.
|
|
3198
2775
|
*/
|
|
3199
2776
|
429: ErrorResponse;
|
|
3200
2777
|
/**
|
|
3201
|
-
* Internal server error
|
|
2778
|
+
* Internal server error - an unexpected error occurred.
|
|
3202
2779
|
*/
|
|
3203
2780
|
500: ErrorResponse;
|
|
3204
2781
|
};
|
|
@@ -3228,31 +2805,31 @@ type ConnectionsSelectObjectsData = {
|
|
|
3228
2805
|
connectionId: number;
|
|
3229
2806
|
};
|
|
3230
2807
|
query?: never;
|
|
3231
|
-
url: '/v1/connections/{connectionId}/
|
|
2808
|
+
url: '/v1/connections/{connectionId}/select-objects';
|
|
3232
2809
|
};
|
|
3233
2810
|
type ConnectionsSelectObjectsErrors = {
|
|
3234
2811
|
/**
|
|
3235
|
-
* Bad request
|
|
2812
|
+
* Bad request - malformed body or invalid parameters.
|
|
3236
2813
|
*/
|
|
3237
2814
|
400: ErrorResponse;
|
|
3238
2815
|
/**
|
|
3239
|
-
* Unauthorized
|
|
2816
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3240
2817
|
*/
|
|
3241
2818
|
401: ErrorResponse;
|
|
3242
2819
|
/**
|
|
3243
|
-
* Forbidden
|
|
2820
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3244
2821
|
*/
|
|
3245
2822
|
403: ErrorResponse;
|
|
3246
2823
|
/**
|
|
3247
|
-
* Not found
|
|
2824
|
+
* Not found - the resource does not exist.
|
|
3248
2825
|
*/
|
|
3249
2826
|
404: ErrorResponse;
|
|
3250
2827
|
/**
|
|
3251
|
-
* Too many requests
|
|
2828
|
+
* Too many requests - rate limit exceeded.
|
|
3252
2829
|
*/
|
|
3253
2830
|
429: ErrorResponse;
|
|
3254
2831
|
/**
|
|
3255
|
-
* Internal server error
|
|
2832
|
+
* Internal server error - an unexpected error occurred.
|
|
3256
2833
|
*/
|
|
3257
2834
|
500: ErrorResponse;
|
|
3258
2835
|
};
|
|
@@ -3296,31 +2873,31 @@ type ConnectionsGetConnectionObjectsData = {
|
|
|
3296
2873
|
*/
|
|
3297
2874
|
top?: number;
|
|
3298
2875
|
};
|
|
3299
|
-
url: '/v1/connections/{connectionId}/
|
|
2876
|
+
url: '/v1/connections/{connectionId}/objects';
|
|
3300
2877
|
};
|
|
3301
2878
|
type ConnectionsGetConnectionObjectsErrors = {
|
|
3302
2879
|
/**
|
|
3303
|
-
* Bad request
|
|
2880
|
+
* Bad request - malformed body or invalid parameters.
|
|
3304
2881
|
*/
|
|
3305
2882
|
400: ErrorResponse;
|
|
3306
2883
|
/**
|
|
3307
|
-
* Unauthorized
|
|
2884
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3308
2885
|
*/
|
|
3309
2886
|
401: ErrorResponse;
|
|
3310
2887
|
/**
|
|
3311
|
-
* Forbidden
|
|
2888
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3312
2889
|
*/
|
|
3313
2890
|
403: ErrorResponse;
|
|
3314
2891
|
/**
|
|
3315
|
-
* Not found
|
|
2892
|
+
* Not found - the resource does not exist.
|
|
3316
2893
|
*/
|
|
3317
2894
|
404: ErrorResponse;
|
|
3318
2895
|
/**
|
|
3319
|
-
* Too many requests
|
|
2896
|
+
* Too many requests - rate limit exceeded.
|
|
3320
2897
|
*/
|
|
3321
2898
|
429: ErrorResponse;
|
|
3322
2899
|
/**
|
|
3323
|
-
* Internal server error
|
|
2900
|
+
* Internal server error - an unexpected error occurred.
|
|
3324
2901
|
*/
|
|
3325
2902
|
500: ErrorResponse;
|
|
3326
2903
|
};
|
|
@@ -3347,31 +2924,31 @@ type ConnectionsCheckConnectionData = {
|
|
|
3347
2924
|
connectionId: number;
|
|
3348
2925
|
};
|
|
3349
2926
|
query?: never;
|
|
3350
|
-
url: '/v1/connections/{connectionId}/
|
|
2927
|
+
url: '/v1/connections/{connectionId}/check';
|
|
3351
2928
|
};
|
|
3352
2929
|
type ConnectionsCheckConnectionErrors = {
|
|
3353
2930
|
/**
|
|
3354
|
-
* Bad request
|
|
2931
|
+
* Bad request - malformed body or invalid parameters.
|
|
3355
2932
|
*/
|
|
3356
2933
|
400: ErrorResponse;
|
|
3357
2934
|
/**
|
|
3358
|
-
* Unauthorized
|
|
2935
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3359
2936
|
*/
|
|
3360
2937
|
401: ErrorResponse;
|
|
3361
2938
|
/**
|
|
3362
|
-
* Forbidden
|
|
2939
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3363
2940
|
*/
|
|
3364
2941
|
403: ErrorResponse;
|
|
3365
2942
|
/**
|
|
3366
|
-
* Not found
|
|
2943
|
+
* Not found - the resource does not exist.
|
|
3367
2944
|
*/
|
|
3368
2945
|
404: ErrorResponse;
|
|
3369
2946
|
/**
|
|
3370
|
-
* Too many requests
|
|
2947
|
+
* Too many requests - rate limit exceeded.
|
|
3371
2948
|
*/
|
|
3372
2949
|
429: ErrorResponse;
|
|
3373
2950
|
/**
|
|
3374
|
-
* Internal server error
|
|
2951
|
+
* Internal server error - an unexpected error occurred.
|
|
3375
2952
|
*/
|
|
3376
2953
|
500: ErrorResponse;
|
|
3377
2954
|
};
|
|
@@ -3396,31 +2973,31 @@ type ConnectionsGetSignInUrlData = {
|
|
|
3396
2973
|
};
|
|
3397
2974
|
path?: never;
|
|
3398
2975
|
query?: never;
|
|
3399
|
-
url: '/v1/connections/
|
|
2976
|
+
url: '/v1/connections/get-sign-in-url';
|
|
3400
2977
|
};
|
|
3401
2978
|
type ConnectionsGetSignInUrlErrors = {
|
|
3402
2979
|
/**
|
|
3403
|
-
* Bad request
|
|
2980
|
+
* Bad request - malformed body or invalid parameters.
|
|
3404
2981
|
*/
|
|
3405
2982
|
400: ErrorResponse;
|
|
3406
2983
|
/**
|
|
3407
|
-
* Unauthorized
|
|
2984
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3408
2985
|
*/
|
|
3409
2986
|
401: ErrorResponse;
|
|
3410
2987
|
/**
|
|
3411
|
-
* Forbidden
|
|
2988
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3412
2989
|
*/
|
|
3413
2990
|
403: ErrorResponse;
|
|
3414
2991
|
/**
|
|
3415
|
-
* Not found
|
|
2992
|
+
* Not found - the resource does not exist.
|
|
3416
2993
|
*/
|
|
3417
2994
|
404: ErrorResponse;
|
|
3418
2995
|
/**
|
|
3419
|
-
* Too many requests
|
|
2996
|
+
* Too many requests - rate limit exceeded.
|
|
3420
2997
|
*/
|
|
3421
2998
|
429: ErrorResponse;
|
|
3422
2999
|
/**
|
|
3423
|
-
* Internal server error
|
|
3000
|
+
* Internal server error - an unexpected error occurred.
|
|
3424
3001
|
*/
|
|
3425
3002
|
500: ErrorResponse;
|
|
3426
3003
|
};
|
|
@@ -3447,31 +3024,31 @@ type ConnectionsGetAccessTokenData = {
|
|
|
3447
3024
|
state: string;
|
|
3448
3025
|
};
|
|
3449
3026
|
query?: never;
|
|
3450
|
-
url: '/v1/connections/
|
|
3027
|
+
url: '/v1/connections/access-token/{state}';
|
|
3451
3028
|
};
|
|
3452
3029
|
type ConnectionsGetAccessTokenErrors = {
|
|
3453
3030
|
/**
|
|
3454
|
-
* Bad request
|
|
3031
|
+
* Bad request - malformed body or invalid parameters.
|
|
3455
3032
|
*/
|
|
3456
3033
|
400: ErrorResponse;
|
|
3457
3034
|
/**
|
|
3458
|
-
* Unauthorized
|
|
3035
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3459
3036
|
*/
|
|
3460
3037
|
401: ErrorResponse;
|
|
3461
3038
|
/**
|
|
3462
|
-
* Forbidden
|
|
3039
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3463
3040
|
*/
|
|
3464
3041
|
403: ErrorResponse;
|
|
3465
3042
|
/**
|
|
3466
|
-
* Not found
|
|
3043
|
+
* Not found - the resource does not exist.
|
|
3467
3044
|
*/
|
|
3468
3045
|
404: ErrorResponse;
|
|
3469
3046
|
/**
|
|
3470
|
-
* Too many requests
|
|
3047
|
+
* Too many requests - rate limit exceeded.
|
|
3471
3048
|
*/
|
|
3472
3049
|
429: ErrorResponse;
|
|
3473
3050
|
/**
|
|
3474
|
-
* Internal server error
|
|
3051
|
+
* Internal server error - an unexpected error occurred.
|
|
3475
3052
|
*/
|
|
3476
3053
|
500: ErrorResponse;
|
|
3477
3054
|
};
|
|
@@ -3533,22 +3110,28 @@ type ToolsListToolsData = {
|
|
|
3533
3110
|
url: '/v1/tools';
|
|
3534
3111
|
};
|
|
3535
3112
|
type ToolsListToolsErrors = {
|
|
3113
|
+
/**
|
|
3114
|
+
* Bad request - malformed body or invalid parameters.
|
|
3115
|
+
*/
|
|
3536
3116
|
400: ErrorResponse;
|
|
3117
|
+
/**
|
|
3118
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3119
|
+
*/
|
|
3537
3120
|
401: ErrorResponse;
|
|
3538
3121
|
/**
|
|
3539
|
-
* Forbidden
|
|
3122
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3540
3123
|
*/
|
|
3541
3124
|
403: ErrorResponse;
|
|
3542
3125
|
/**
|
|
3543
|
-
* Not found
|
|
3126
|
+
* Not found - the resource does not exist.
|
|
3544
3127
|
*/
|
|
3545
3128
|
404: ErrorResponse;
|
|
3546
3129
|
/**
|
|
3547
|
-
* Too many requests
|
|
3130
|
+
* Too many requests - rate limit exceeded.
|
|
3548
3131
|
*/
|
|
3549
3132
|
429: ErrorResponse;
|
|
3550
3133
|
/**
|
|
3551
|
-
* Internal server error
|
|
3134
|
+
* Internal server error - an unexpected error occurred.
|
|
3552
3135
|
*/
|
|
3553
3136
|
500: ErrorResponse;
|
|
3554
3137
|
};
|
|
@@ -3587,19 +3170,28 @@ type ToolsGetToolData = {
|
|
|
3587
3170
|
url: '/v1/tools/{toolSlug}';
|
|
3588
3171
|
};
|
|
3589
3172
|
type ToolsGetToolErrors = {
|
|
3173
|
+
/**
|
|
3174
|
+
* Bad request - malformed body or invalid parameters.
|
|
3175
|
+
*/
|
|
3590
3176
|
400: ErrorResponse;
|
|
3177
|
+
/**
|
|
3178
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3179
|
+
*/
|
|
3591
3180
|
401: ErrorResponse;
|
|
3592
3181
|
/**
|
|
3593
|
-
* Forbidden
|
|
3182
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3594
3183
|
*/
|
|
3595
3184
|
403: ErrorResponse;
|
|
3185
|
+
/**
|
|
3186
|
+
* Not found - the resource does not exist.
|
|
3187
|
+
*/
|
|
3596
3188
|
404: ErrorResponse;
|
|
3597
3189
|
/**
|
|
3598
|
-
* Too many requests
|
|
3190
|
+
* Too many requests - rate limit exceeded.
|
|
3599
3191
|
*/
|
|
3600
3192
|
429: ErrorResponse;
|
|
3601
3193
|
/**
|
|
3602
|
-
* Internal server error
|
|
3194
|
+
* Internal server error - an unexpected error occurred.
|
|
3603
3195
|
*/
|
|
3604
3196
|
500: ErrorResponse;
|
|
3605
3197
|
};
|
|
@@ -3641,17 +3233,32 @@ type ToolsExecuteToolData = {
|
|
|
3641
3233
|
url: '/v1/tools/{toolSlug}/execute';
|
|
3642
3234
|
};
|
|
3643
3235
|
type ToolsExecuteToolErrors = {
|
|
3236
|
+
/**
|
|
3237
|
+
* Bad request - malformed body or invalid parameters.
|
|
3238
|
+
*/
|
|
3644
3239
|
400: ErrorResponse;
|
|
3240
|
+
/**
|
|
3241
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3242
|
+
*/
|
|
3645
3243
|
401: ErrorResponse;
|
|
3244
|
+
/**
|
|
3245
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3246
|
+
*/
|
|
3646
3247
|
403: ErrorResponse;
|
|
3248
|
+
/**
|
|
3249
|
+
* Not found - the resource does not exist.
|
|
3250
|
+
*/
|
|
3647
3251
|
404: ErrorResponse;
|
|
3252
|
+
/**
|
|
3253
|
+
* Conflict - the tool has no resolvable connection: either the supplied toolset has no connection for the tool's application (NO_TOOLSET_CONNECTION), or the caller has no default connection configured and none can be resolved (NO_DEFAULT_CONNECTION).
|
|
3254
|
+
*/
|
|
3648
3255
|
409: ErrorResponse;
|
|
3649
3256
|
/**
|
|
3650
|
-
* Too many requests
|
|
3257
|
+
* Too many requests - rate limit exceeded.
|
|
3651
3258
|
*/
|
|
3652
3259
|
429: ErrorResponse;
|
|
3653
3260
|
/**
|
|
3654
|
-
* Internal server error
|
|
3261
|
+
* Internal server error - an unexpected error occurred.
|
|
3655
3262
|
*/
|
|
3656
3263
|
500: ErrorResponse;
|
|
3657
3264
|
};
|
|
@@ -3686,27 +3293,27 @@ type ToolsetsListToolsetsData = {
|
|
|
3686
3293
|
};
|
|
3687
3294
|
type ToolsetsListToolsetsErrors = {
|
|
3688
3295
|
/**
|
|
3689
|
-
* Bad request
|
|
3296
|
+
* Bad request - malformed body or invalid parameters.
|
|
3690
3297
|
*/
|
|
3691
3298
|
400: ErrorResponse;
|
|
3692
3299
|
/**
|
|
3693
|
-
* Unauthorized
|
|
3300
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3694
3301
|
*/
|
|
3695
3302
|
401: ErrorResponse;
|
|
3696
3303
|
/**
|
|
3697
|
-
* Forbidden
|
|
3304
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3698
3305
|
*/
|
|
3699
3306
|
403: ErrorResponse;
|
|
3700
3307
|
/**
|
|
3701
|
-
* Not found
|
|
3308
|
+
* Not found - the resource does not exist.
|
|
3702
3309
|
*/
|
|
3703
3310
|
404: ErrorResponse;
|
|
3704
3311
|
/**
|
|
3705
|
-
* Too many requests
|
|
3312
|
+
* Too many requests - rate limit exceeded.
|
|
3706
3313
|
*/
|
|
3707
3314
|
429: ErrorResponse;
|
|
3708
3315
|
/**
|
|
3709
|
-
* Internal server error
|
|
3316
|
+
* Internal server error - an unexpected error occurred.
|
|
3710
3317
|
*/
|
|
3711
3318
|
500: ErrorResponse;
|
|
3712
3319
|
};
|
|
@@ -3735,27 +3342,27 @@ type ToolsetsCreateToolsetData = {
|
|
|
3735
3342
|
};
|
|
3736
3343
|
type ToolsetsCreateToolsetErrors = {
|
|
3737
3344
|
/**
|
|
3738
|
-
* Bad request
|
|
3345
|
+
* Bad request - malformed body or invalid parameters.
|
|
3739
3346
|
*/
|
|
3740
3347
|
400: ErrorResponse;
|
|
3741
3348
|
/**
|
|
3742
|
-
* Unauthorized
|
|
3349
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3743
3350
|
*/
|
|
3744
3351
|
401: ErrorResponse;
|
|
3745
3352
|
/**
|
|
3746
|
-
* Forbidden
|
|
3353
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3747
3354
|
*/
|
|
3748
3355
|
403: ErrorResponse;
|
|
3749
3356
|
/**
|
|
3750
|
-
* Not found
|
|
3357
|
+
* Not found - the resource does not exist.
|
|
3751
3358
|
*/
|
|
3752
3359
|
404: ErrorResponse;
|
|
3753
3360
|
/**
|
|
3754
|
-
* Too many requests
|
|
3361
|
+
* Too many requests - rate limit exceeded.
|
|
3755
3362
|
*/
|
|
3756
3363
|
429: ErrorResponse;
|
|
3757
3364
|
/**
|
|
3758
|
-
* Internal server error
|
|
3365
|
+
* Internal server error - an unexpected error occurred.
|
|
3759
3366
|
*/
|
|
3760
3367
|
500: ErrorResponse;
|
|
3761
3368
|
};
|
|
@@ -3786,27 +3393,27 @@ type ToolsetsDeleteToolsetData = {
|
|
|
3786
3393
|
};
|
|
3787
3394
|
type ToolsetsDeleteToolsetErrors = {
|
|
3788
3395
|
/**
|
|
3789
|
-
* Bad request
|
|
3396
|
+
* Bad request - malformed body or invalid parameters.
|
|
3790
3397
|
*/
|
|
3791
3398
|
400: ErrorResponse;
|
|
3792
3399
|
/**
|
|
3793
|
-
* Unauthorized
|
|
3400
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3794
3401
|
*/
|
|
3795
3402
|
401: ErrorResponse;
|
|
3796
3403
|
/**
|
|
3797
|
-
* Forbidden
|
|
3404
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3798
3405
|
*/
|
|
3799
3406
|
403: ErrorResponse;
|
|
3800
3407
|
/**
|
|
3801
|
-
* Not found
|
|
3408
|
+
* Not found - the resource does not exist.
|
|
3802
3409
|
*/
|
|
3803
3410
|
404: ErrorResponse;
|
|
3804
3411
|
/**
|
|
3805
|
-
* Too many requests
|
|
3412
|
+
* Too many requests - rate limit exceeded.
|
|
3806
3413
|
*/
|
|
3807
3414
|
429: ErrorResponse;
|
|
3808
3415
|
/**
|
|
3809
|
-
* Internal server error
|
|
3416
|
+
* Internal server error - an unexpected error occurred.
|
|
3810
3417
|
*/
|
|
3811
3418
|
500: ErrorResponse;
|
|
3812
3419
|
};
|
|
@@ -3837,27 +3444,27 @@ type ToolsetsGetToolsetData = {
|
|
|
3837
3444
|
};
|
|
3838
3445
|
type ToolsetsGetToolsetErrors = {
|
|
3839
3446
|
/**
|
|
3840
|
-
* Bad request
|
|
3447
|
+
* Bad request - malformed body or invalid parameters.
|
|
3841
3448
|
*/
|
|
3842
3449
|
400: ErrorResponse;
|
|
3843
3450
|
/**
|
|
3844
|
-
* Unauthorized
|
|
3451
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3845
3452
|
*/
|
|
3846
3453
|
401: ErrorResponse;
|
|
3847
3454
|
/**
|
|
3848
|
-
* Forbidden
|
|
3455
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3849
3456
|
*/
|
|
3850
3457
|
403: ErrorResponse;
|
|
3851
3458
|
/**
|
|
3852
|
-
* Not found
|
|
3459
|
+
* Not found - the resource does not exist.
|
|
3853
3460
|
*/
|
|
3854
3461
|
404: ErrorResponse;
|
|
3855
3462
|
/**
|
|
3856
|
-
* Too many requests
|
|
3463
|
+
* Too many requests - rate limit exceeded.
|
|
3857
3464
|
*/
|
|
3858
3465
|
429: ErrorResponse;
|
|
3859
3466
|
/**
|
|
3860
|
-
* Internal server error
|
|
3467
|
+
* Internal server error - an unexpected error occurred.
|
|
3861
3468
|
*/
|
|
3862
3469
|
500: ErrorResponse;
|
|
3863
3470
|
};
|
|
@@ -3891,27 +3498,27 @@ type ToolsetsUpdateToolsetData = {
|
|
|
3891
3498
|
};
|
|
3892
3499
|
type ToolsetsUpdateToolsetErrors = {
|
|
3893
3500
|
/**
|
|
3894
|
-
* Bad request
|
|
3501
|
+
* Bad request - malformed body or invalid parameters.
|
|
3895
3502
|
*/
|
|
3896
3503
|
400: ErrorResponse;
|
|
3897
3504
|
/**
|
|
3898
|
-
* Unauthorized
|
|
3505
|
+
* Unauthorized - missing or invalid bearer token.
|
|
3899
3506
|
*/
|
|
3900
3507
|
401: ErrorResponse;
|
|
3901
3508
|
/**
|
|
3902
|
-
* Forbidden
|
|
3509
|
+
* Forbidden - the caller lacks access to the resource.
|
|
3903
3510
|
*/
|
|
3904
3511
|
403: ErrorResponse;
|
|
3905
3512
|
/**
|
|
3906
|
-
* Not found
|
|
3513
|
+
* Not found - the resource does not exist.
|
|
3907
3514
|
*/
|
|
3908
3515
|
404: ErrorResponse;
|
|
3909
3516
|
/**
|
|
3910
|
-
* Too many requests
|
|
3517
|
+
* Too many requests - rate limit exceeded.
|
|
3911
3518
|
*/
|
|
3912
3519
|
429: ErrorResponse;
|
|
3913
3520
|
/**
|
|
3914
|
-
* Internal server error
|
|
3521
|
+
* Internal server error - an unexpected error occurred.
|
|
3915
3522
|
*/
|
|
3916
3523
|
500: ErrorResponse;
|
|
3917
3524
|
};
|
|
@@ -3938,9 +3545,15 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
|
|
|
3938
3545
|
meta?: Record<string, unknown>;
|
|
3939
3546
|
};
|
|
3940
3547
|
/**
|
|
3548
|
+
* Get the caller's identity.
|
|
3549
|
+
*
|
|
3941
3550
|
* Returns the identity of the principal the request is authenticated as: full name, email,
|
|
3942
|
-
* current company, role, and caller type. For x-api-key
|
|
3943
|
-
*
|
|
3551
|
+
* current company, role, and caller type (userType). For an x-api-key request
|
|
3552
|
+
* the identity returned is the key's owner (the key acts as the owner) and userType is
|
|
3553
|
+
* reported as apiuser; a hard-deleted (anonymized) profile is reported as
|
|
3554
|
+
* anonymous; every other caller is user. Fields resolved from the current
|
|
3555
|
+
* company/role (currentCompany, role) are null when no company context could
|
|
3556
|
+
* be resolved for the caller.
|
|
3944
3557
|
*/
|
|
3945
3558
|
declare const authWhoAmI: <ThrowOnError extends boolean = false>(options?: Options<AuthWhoAmIData, ThrowOnError>) => RequestResult<AuthWhoAmIResponses, AuthWhoAmIErrors, ThrowOnError>;
|
|
3946
3559
|
/**
|
|
@@ -4006,110 +3619,238 @@ declare const solutionsUpdateInstallation: <ThrowOnError extends boolean = false
|
|
|
4006
3619
|
*/
|
|
4007
3620
|
declare const solutionsUninstallSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsUninstallSolutionData, ThrowOnError>) => RequestResult<SolutionsUninstallSolutionResponses, SolutionsUninstallSolutionErrors, ThrowOnError>;
|
|
4008
3621
|
/**
|
|
4009
|
-
* List
|
|
3622
|
+
* List applications.
|
|
3623
|
+
*
|
|
3624
|
+
* Returns the applications the caller's account can browse, honoring the optional filters
|
|
3625
|
+
* and pagination. Set available=true to restrict results to applications the caller
|
|
3626
|
+
* can currently use - i.e. their connection requirement is already satisfied - otherwise the
|
|
3627
|
+
* full catalog is returned regardless of connection state. Account context is resolved from
|
|
3628
|
+
* the caller's authenticated account / API key.
|
|
4010
3629
|
*/
|
|
4011
3630
|
declare const applicationsListApplications: <ThrowOnError extends boolean = false>(options?: Options<ApplicationsListApplicationsData, ThrowOnError>) => RequestResult<ApplicationsListApplicationsResponses, ApplicationsListApplicationsErrors, ThrowOnError>;
|
|
4012
3631
|
/**
|
|
4013
|
-
* Get
|
|
3632
|
+
* Get an application.
|
|
3633
|
+
*
|
|
3634
|
+
* Fetches the full detail record for a single application by slug, including its connection
|
|
3635
|
+
* requirement and the authentication methods it supports. Returns 404 if no application
|
|
3636
|
+
* exists with the given slug for the caller's account.
|
|
4014
3637
|
*/
|
|
4015
3638
|
declare const applicationsGetApplication: <ThrowOnError extends boolean = false>(options: Options<ApplicationsGetApplicationData, ThrowOnError>) => RequestResult<ApplicationsGetApplicationResponses, ApplicationsGetApplicationErrors, ThrowOnError>;
|
|
4016
3639
|
/**
|
|
4017
|
-
* List
|
|
3640
|
+
* List connections.
|
|
3641
|
+
*
|
|
3642
|
+
* Returns the connections owned by the caller's account, honoring the optional filters
|
|
3643
|
+
* and pagination. top is silently clamped to the range 1-100 (default 25) and a
|
|
3644
|
+
* negative offset is treated as 0. The optional metadata filter matches on
|
|
3645
|
+
* the connection's stored metadata key/value pairs.
|
|
4018
3646
|
*/
|
|
4019
3647
|
declare const connectionsGetConnections: <ThrowOnError extends boolean = false>(options?: Options<ConnectionsGetConnectionsData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionsResponses, ConnectionsGetConnectionsErrors, ThrowOnError>;
|
|
4020
3648
|
/**
|
|
4021
|
-
* Create a
|
|
3649
|
+
* Create a connection.
|
|
3650
|
+
*
|
|
3651
|
+
* Creates a new connection for the caller's account using the given field values (e.g.
|
|
3652
|
+
* API key, credentials) for the target application. authenticationId selects which
|
|
3653
|
+
* of the application's authentication methods to use; omit it to use the application's
|
|
3654
|
+
* default. To connect via OAuth instead of directly supplying credentials, use
|
|
3655
|
+
* POST /connections/get-sign-in-url followed by
|
|
3656
|
+
* GET /connections/access-token/{state}.
|
|
4022
3657
|
*/
|
|
4023
3658
|
declare const connectionsCreateConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsCreateConnectionData, ThrowOnError>) => RequestResult<ConnectionsCreateConnectionResponses, ConnectionsCreateConnectionErrors, ThrowOnError>;
|
|
4024
3659
|
/**
|
|
4025
|
-
* Delete a connection
|
|
3660
|
+
* Delete a connection.
|
|
3661
|
+
*
|
|
3662
|
+
* Permanently deletes a connection owned by the caller's account. A public (shared)
|
|
3663
|
+
* connection cannot be deleted via this endpoint. Any toolsets referencing this
|
|
3664
|
+
* connection are updated as part of the deletion.
|
|
4026
3665
|
*/
|
|
4027
3666
|
declare const connectionsDeleteConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsDeleteConnectionData, ThrowOnError>) => RequestResult<ConnectionsDeleteConnectionResponses, ConnectionsDeleteConnectionErrors, ThrowOnError>;
|
|
4028
3667
|
/**
|
|
4029
|
-
* Get
|
|
3668
|
+
* Get a connection.
|
|
3669
|
+
*
|
|
3670
|
+
* Fetches the full detail record for a single connection owned by the caller's account,
|
|
3671
|
+
* including its field values and metadata.
|
|
4030
3672
|
*/
|
|
4031
3673
|
declare const connectionsGetConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetConnectionData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionResponses, ConnectionsGetConnectionErrors, ThrowOnError>;
|
|
4032
3674
|
/**
|
|
4033
|
-
* Update
|
|
3675
|
+
* Update a connection.
|
|
3676
|
+
*
|
|
3677
|
+
* Updates a connection owned by the caller's account. Only the fields present in the
|
|
3678
|
+
* request body are changed; connectionName, description, fields, and
|
|
3679
|
+
* metadata are each left unchanged when omitted (null). Supplying fields or
|
|
3680
|
+
* metadata replaces the entire map, it does not merge with the existing one.
|
|
4034
3681
|
*/
|
|
4035
3682
|
declare const connectionsUpdateConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsUpdateConnectionData, ThrowOnError>) => RequestResult<ConnectionsUpdateConnectionResponses, ConnectionsUpdateConnectionErrors, ThrowOnError>;
|
|
4036
3683
|
/**
|
|
4037
|
-
* List
|
|
3684
|
+
* List default connections.
|
|
3685
|
+
*
|
|
3686
|
+
* Returns the caller's default connections, one per application where a default is set.
|
|
3687
|
+
* Defaults drive implicit connection resolution everywhere a connection isn't explicitly
|
|
3688
|
+
* specified - e.g. POST /tools/{toolSlug}/execute without a connectionId or
|
|
3689
|
+
* toolsetId.
|
|
4038
3690
|
*/
|
|
4039
3691
|
declare const connectionsGetDefaultConnections: <ThrowOnError extends boolean = false>(options?: Options<ConnectionsGetDefaultConnectionsData, ThrowOnError>) => RequestResult<ConnectionsGetDefaultConnectionsResponses, ConnectionsGetDefaultConnectionsErrors, ThrowOnError>;
|
|
4040
3692
|
/**
|
|
4041
|
-
* Clear
|
|
3693
|
+
* Clear a default connection.
|
|
3694
|
+
*
|
|
3695
|
+
* Clears the default designation for the given connection. After this, implicit
|
|
3696
|
+
* connection resolution for that application falls back to the single-connection rule
|
|
3697
|
+
* (used automatically when exactly one connection exists) or otherwise requires an
|
|
3698
|
+
* explicit connectionId/toolsetId.
|
|
4042
3699
|
*/
|
|
4043
3700
|
declare const connectionsClearDefaultConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsClearDefaultConnectionData, ThrowOnError>) => RequestResult<ConnectionsClearDefaultConnectionResponses, ConnectionsClearDefaultConnectionErrors, ThrowOnError>;
|
|
4044
3701
|
/**
|
|
4045
|
-
* Set
|
|
3702
|
+
* Set a default connection.
|
|
3703
|
+
*
|
|
3704
|
+
* Marks the given connection as the caller's default for its application, replacing any
|
|
3705
|
+
* previous default for that application. Subsequent calls that omit an explicit
|
|
3706
|
+
* connectionId/toolsetId resolve to this connection.
|
|
4046
3707
|
*/
|
|
4047
3708
|
declare const connectionsSetDefaultConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsSetDefaultConnectionData, ThrowOnError>) => RequestResult<ConnectionsSetDefaultConnectionResponses, ConnectionsSetDefaultConnectionErrors, ThrowOnError>;
|
|
4048
3709
|
/**
|
|
4049
|
-
* Replace
|
|
3710
|
+
* Replace a connection.
|
|
3711
|
+
*
|
|
3712
|
+
* Repoints a specific workflow's usage from originalConnectionId to
|
|
3713
|
+
* newConnectionId. Both connections must belong to the caller's account; the
|
|
3714
|
+
* original connection itself is left intact and is not deleted by this call.
|
|
4050
3715
|
*/
|
|
4051
3716
|
declare const connectionsReplaceConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsReplaceConnectionData, ThrowOnError>) => RequestResult<ConnectionsReplaceConnectionResponses, ConnectionsReplaceConnectionErrors, ThrowOnError>;
|
|
4052
3717
|
/**
|
|
4053
|
-
*
|
|
3718
|
+
* Refresh connection objects.
|
|
3719
|
+
*
|
|
3720
|
+
* Triggers an asynchronous refresh of the objects (e.g. tables, lists) the given
|
|
3721
|
+
* connection exposes. This returns immediately once the refresh is initiated; poll
|
|
3722
|
+
* GET /connections/{connectionId}/refresh-status to observe completion. A new
|
|
3723
|
+
* refresh cannot be started within 15 minutes of the previous one.
|
|
4054
3724
|
*/
|
|
4055
3725
|
declare const connectionsRefreshObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsRefreshObjectsData, ThrowOnError>) => RequestResult<ConnectionsRefreshObjectsResponses, ConnectionsRefreshObjectsErrors, ThrowOnError>;
|
|
4056
3726
|
/**
|
|
4057
|
-
* Get the
|
|
3727
|
+
* Get the refresh status.
|
|
3728
|
+
*
|
|
3729
|
+
* Returns the status of the most recent object refresh triggered by
|
|
3730
|
+
* POST /connections/{connectionId}/refresh-objects for the given connection,
|
|
3731
|
+
* including whether it is still running, when it last completed, and any error.
|
|
4058
3732
|
*/
|
|
4059
3733
|
declare const connectionsGetRefreshStatus: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetRefreshStatusData, ThrowOnError>) => RequestResult<ConnectionsGetRefreshStatusResponses, ConnectionsGetRefreshStatusErrors, ThrowOnError>;
|
|
4060
3734
|
/**
|
|
4061
|
-
* Select
|
|
3735
|
+
* Select connection objects.
|
|
3736
|
+
*
|
|
3737
|
+
* Saves which objects (e.g. tables, lists) discovered on the given connection are active
|
|
3738
|
+
* - used where an application exposes more objects than are relevant, so the caller can
|
|
3739
|
+
* scope the connection down to the ones it needs. Replaces the entire selection; it does
|
|
3740
|
+
* not merge with the previous one.
|
|
4062
3741
|
*/
|
|
4063
3742
|
declare const connectionsSelectObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsSelectObjectsData, ThrowOnError>) => RequestResult<ConnectionsSelectObjectsResponses, ConnectionsSelectObjectsErrors, ThrowOnError>;
|
|
4064
3743
|
/**
|
|
4065
|
-
* List
|
|
3744
|
+
* List connection objects.
|
|
3745
|
+
*
|
|
3746
|
+
* Returns the objects (e.g. tables, lists) discovered on the given connection, honoring
|
|
3747
|
+
* the optional name filter, sort expression, and pagination. top is silently
|
|
3748
|
+
* clamped to the range 1-1000 (default 100) and a negative offset is treated as 0.
|
|
3749
|
+
* Run POST /connections/{connectionId}/refresh-objects first if the connection's
|
|
3750
|
+
* objects have changed upstream.
|
|
4066
3751
|
*/
|
|
4067
3752
|
declare const connectionsGetConnectionObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetConnectionObjectsData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionObjectsResponses, ConnectionsGetConnectionObjectsErrors, ThrowOnError>;
|
|
4068
3753
|
/**
|
|
4069
|
-
*
|
|
3754
|
+
* Check a connection.
|
|
3755
|
+
*
|
|
3756
|
+
* Verifies that the given connection is valid and currently usable - e.g. its stored
|
|
3757
|
+
* credentials still authenticate against the target application. Returns a non-2xx error
|
|
3758
|
+
* if the connection is no longer healthy.
|
|
4070
3759
|
*/
|
|
4071
3760
|
declare const connectionsCheckConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsCheckConnectionData, ThrowOnError>) => RequestResult<ConnectionsCheckConnectionResponses, ConnectionsCheckConnectionErrors, ThrowOnError>;
|
|
4072
3761
|
/**
|
|
4073
|
-
*
|
|
3762
|
+
* Get an OAuth sign-in URL.
|
|
3763
|
+
*
|
|
3764
|
+
* First half of the OAuth pairing with GET /connections/access-token/{state}.
|
|
3765
|
+
* Builds a sign-in URL for the given application and authentication method, along with a
|
|
3766
|
+
* freshly generated opaque state value. Redirect the end user to signInUrl to
|
|
3767
|
+
* authorize; once they complete the provider's consent screen, poll the access-token
|
|
3768
|
+
* endpoint with the same state to retrieve the resulting token data.
|
|
4074
3769
|
*/
|
|
4075
3770
|
declare const connectionsGetSignInUrl: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetSignInUrlData, ThrowOnError>) => RequestResult<ConnectionsGetSignInUrlResponses, ConnectionsGetSignInUrlErrors, ThrowOnError>;
|
|
4076
3771
|
/**
|
|
4077
|
-
*
|
|
3772
|
+
* Get the access token for a sign-in.
|
|
3773
|
+
*
|
|
3774
|
+
* Second half of the OAuth pairing with POST /connections/get-sign-in-url. Retrieves
|
|
3775
|
+
* the token data captured once the end user completes the sign-in flow for the given
|
|
3776
|
+
* state. Returns a null body if the flow hasn't completed yet - poll until a
|
|
3777
|
+
* non-null response is returned, then use tokenData/connectionData to
|
|
3778
|
+
* complete the connection.
|
|
4078
3779
|
*/
|
|
4079
3780
|
declare const connectionsGetAccessToken: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetAccessTokenData, ThrowOnError>) => RequestResult<ConnectionsGetAccessTokenResponses, ConnectionsGetAccessTokenErrors, ThrowOnError>;
|
|
4080
3781
|
/**
|
|
4081
|
-
* List
|
|
3782
|
+
* List tools.
|
|
3783
|
+
*
|
|
3784
|
+
* Returns the tools available to the caller across all applications, honoring the optional
|
|
3785
|
+
* filters and pagination. Set available=true to restrict results to tools the caller
|
|
3786
|
+
* can currently execute. Supplying toolsetId additionally includes the caller's
|
|
3787
|
+
* workflow-backed tools scoped to that toolset, alongside the standard activity tools.
|
|
3788
|
+
* Deprecated tools are excluded unless includeDeprecated=true.
|
|
4082
3789
|
*/
|
|
4083
3790
|
declare const toolsListTools: <ThrowOnError extends boolean = false>(options?: Options<ToolsListToolsData, ThrowOnError>) => RequestResult<ToolsListToolsResponses, ToolsListToolsErrors, ThrowOnError>;
|
|
4084
3791
|
/**
|
|
4085
|
-
* Get
|
|
3792
|
+
* Get a tool.
|
|
3793
|
+
*
|
|
3794
|
+
* Fetches the full detail for a single tool, identified by its slug, including its
|
|
3795
|
+
* input/output JSON schemas and execution capability flags (filters, sort, pagination).
|
|
3796
|
+
* Supply applicationSlug to disambiguate when the same tool slug exists under more
|
|
3797
|
+
* than one application. Supplying toolsetId additionally allows a workflow-backed tool
|
|
3798
|
+
* within that toolset to resolve by slug.
|
|
4086
3799
|
*/
|
|
4087
3800
|
declare const toolsGetTool: <ThrowOnError extends boolean = false>(options: Options<ToolsGetToolData, ThrowOnError>) => RequestResult<ToolsGetToolResponses, ToolsGetToolErrors, ThrowOnError>;
|
|
4088
3801
|
/**
|
|
4089
|
-
* Execute a tool.
|
|
4090
|
-
*
|
|
4091
|
-
*
|
|
4092
|
-
*
|
|
3802
|
+
* Execute a tool.
|
|
3803
|
+
*
|
|
3804
|
+
* Executes the named tool with the given input fields. The connection to use is resolved
|
|
3805
|
+
* implicitly: an explicit connectionId takes precedence, then toolsetId scopes
|
|
3806
|
+
* resolution to that toolset's connection for the tool's application, and otherwise the
|
|
3807
|
+
* caller's default connection for the application is used. Tool-runtime failures - the
|
|
3808
|
+
* downstream call itself failing - are reported as a 200 response with
|
|
3809
|
+
* isSuccess=false and an errorMessage, not as a 4xx/5xx, so callers must check
|
|
3810
|
+
* isSuccess even on a successful HTTP response. A 409 is returned only when no
|
|
3811
|
+
* connection can be resolved at all (no toolset connection for the app, or no default
|
|
3812
|
+
* connection configured); every other failure uses the standard error envelope.
|
|
4093
3813
|
*/
|
|
4094
3814
|
declare const toolsExecuteTool: <ThrowOnError extends boolean = false>(options: Options<ToolsExecuteToolData, ThrowOnError>) => RequestResult<ToolsExecuteToolResponses, ToolsExecuteToolErrors, ThrowOnError>;
|
|
4095
3815
|
/**
|
|
4096
|
-
* List
|
|
3816
|
+
* List toolsets.
|
|
3817
|
+
*
|
|
3818
|
+
* Returns the toolsets owned by the caller, paginated. top is silently clamped to
|
|
3819
|
+
* the range 1-100 and a negative offset is treated as 0.
|
|
4097
3820
|
*/
|
|
4098
3821
|
declare const toolsetsListToolsets: <ThrowOnError extends boolean = false>(options?: Options<ToolsetsListToolsetsData, ThrowOnError>) => RequestResult<ToolsetsListToolsetsResponses, ToolsetsListToolsetsErrors, ThrowOnError>;
|
|
4099
3822
|
/**
|
|
4100
|
-
* Create a
|
|
3823
|
+
* Create a toolset.
|
|
3824
|
+
*
|
|
3825
|
+
* Creates a new toolset owned by the caller, with the given connections (and their
|
|
3826
|
+
* permitted tool slugs) and workflows. A connection entry may omit connectionId and
|
|
3827
|
+
* instead supply applicationSlug or at least one tool slug, letting the caller's
|
|
3828
|
+
* default connection for that application be resolved and stored at save time.
|
|
4101
3829
|
*/
|
|
4102
3830
|
declare const toolsetsCreateToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsCreateToolsetData, ThrowOnError>) => RequestResult<ToolsetsCreateToolsetResponses, ToolsetsCreateToolsetErrors, ThrowOnError>;
|
|
4103
3831
|
/**
|
|
4104
|
-
* Delete a toolset
|
|
3832
|
+
* Delete a toolset.
|
|
3833
|
+
*
|
|
3834
|
+
* Permanently deletes a toolset owned by the caller, including its connection and
|
|
3835
|
+
* workflow associations. This does not delete the underlying connections or workflows
|
|
3836
|
+
* themselves. Returns an error if the toolset does not exist.
|
|
4105
3837
|
*/
|
|
4106
3838
|
declare const toolsetsDeleteToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsDeleteToolsetData, ThrowOnError>) => RequestResult<ToolsetsDeleteToolsetResponses, ToolsetsDeleteToolsetErrors, ThrowOnError>;
|
|
4107
3839
|
/**
|
|
4108
|
-
* Get a
|
|
3840
|
+
* Get a toolset.
|
|
3841
|
+
*
|
|
3842
|
+
* Fetches a single toolset by id, including its member connections (with their permitted
|
|
3843
|
+
* tools) and any included workflows. Returns an error if the toolset does not exist or is
|
|
3844
|
+
* not owned by the caller.
|
|
4109
3845
|
*/
|
|
4110
3846
|
declare const toolsetsGetToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsGetToolsetData, ThrowOnError>) => RequestResult<ToolsetsGetToolsetResponses, ToolsetsGetToolsetErrors, ThrowOnError>;
|
|
4111
3847
|
/**
|
|
4112
|
-
* Update
|
|
3848
|
+
* Update a toolset.
|
|
3849
|
+
*
|
|
3850
|
+
* Updates a toolset owned by the caller. Only the fields present in the request body are
|
|
3851
|
+
* changed - name, connections, and workflows are each left unchanged
|
|
3852
|
+
* when omitted (null); supplying connections or workflows replaces the
|
|
3853
|
+
* entire set, it does not merge with the existing one.
|
|
4113
3854
|
*/
|
|
4114
3855
|
declare const toolsetsUpdateToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsUpdateToolsetData, ThrowOnError>) => RequestResult<ToolsetsUpdateToolsetResponses, ToolsetsUpdateToolsetErrors, ThrowOnError>;
|
|
4115
3856
|
|