@botpress/client 0.11.9 → 0.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundle.cjs +9 -9
- package/dist/bundle.cjs.map +3 -3
- package/dist/gen/api.d.ts +1468 -592
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +10 -6
- package/dist/gen/common.d.ts +1 -1
- package/dist/gen/configuration.d.ts +1 -1
- package/dist/gen/index.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +3 -3
- package/dist/index.d.ts +4 -1
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
package/dist/gen/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Botpress API
|
|
3
3
|
* API for Botpress Cloud
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.19.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -186,10 +186,10 @@ export interface Bot {
|
|
|
186
186
|
'conversation': BotConversation;
|
|
187
187
|
/**
|
|
188
188
|
*
|
|
189
|
-
* @type {
|
|
189
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueMessage}
|
|
190
190
|
* @memberof Bot
|
|
191
191
|
*/
|
|
192
|
-
'message':
|
|
192
|
+
'message': GetPublicIntegrationByIdResponseIntegrationChannelsValueMessage;
|
|
193
193
|
/**
|
|
194
194
|
* A mapping of states to their definition
|
|
195
195
|
* @type {{ [key: string]: CreateBotBodyStatesValue; }}
|
|
@@ -206,11 +206,11 @@ export interface Bot {
|
|
|
206
206
|
'configuration': BotConfiguration;
|
|
207
207
|
/**
|
|
208
208
|
* Events definition
|
|
209
|
-
* @type {{ [key: string]:
|
|
209
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
210
210
|
* @memberof Bot
|
|
211
211
|
*/
|
|
212
212
|
'events': {
|
|
213
|
-
[key: string]:
|
|
213
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
214
214
|
};
|
|
215
215
|
/**
|
|
216
216
|
* Recurring events
|
|
@@ -228,11 +228,11 @@ export interface Bot {
|
|
|
228
228
|
'subscriptions': CreateBotBodySubscriptions;
|
|
229
229
|
/**
|
|
230
230
|
* Actions definition
|
|
231
|
-
* @type {{ [key: string]:
|
|
231
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
232
232
|
* @memberof Bot
|
|
233
233
|
*/
|
|
234
234
|
'actions': {
|
|
235
|
-
[key: string]:
|
|
235
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
236
236
|
};
|
|
237
237
|
/**
|
|
238
238
|
* Name of the [Bot](#schema_bot)
|
|
@@ -313,11 +313,11 @@ export interface BotConfiguration {
|
|
|
313
313
|
export interface BotConversation {
|
|
314
314
|
/**
|
|
315
315
|
*
|
|
316
|
-
* @type {{ [key: string]:
|
|
316
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
317
317
|
* @memberof BotConversation
|
|
318
318
|
*/
|
|
319
319
|
'tags': {
|
|
320
|
-
[key: string]:
|
|
320
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
321
321
|
};
|
|
322
322
|
}
|
|
323
323
|
/**
|
|
@@ -447,21 +447,6 @@ export interface BotMediasInner {
|
|
|
447
447
|
*/
|
|
448
448
|
'name': string;
|
|
449
449
|
}
|
|
450
|
-
/**
|
|
451
|
-
* Message object configuration
|
|
452
|
-
* @export
|
|
453
|
-
* @interface BotMessage
|
|
454
|
-
*/
|
|
455
|
-
export interface BotMessage {
|
|
456
|
-
/**
|
|
457
|
-
*
|
|
458
|
-
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
459
|
-
* @memberof BotMessage
|
|
460
|
-
*/
|
|
461
|
-
'tags': {
|
|
462
|
-
[key: string]: CreateBotBodyUserTagsValue;
|
|
463
|
-
};
|
|
464
|
-
}
|
|
465
450
|
/**
|
|
466
451
|
*
|
|
467
452
|
* @export
|
|
@@ -522,11 +507,11 @@ export interface BotRecurringEventsValueSchedule {
|
|
|
522
507
|
export interface BotUser {
|
|
523
508
|
/**
|
|
524
509
|
*
|
|
525
|
-
* @type {{ [key: string]:
|
|
510
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
526
511
|
* @memberof BotUser
|
|
527
512
|
*/
|
|
528
513
|
'tags': {
|
|
529
|
-
[key: string]:
|
|
514
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
530
515
|
};
|
|
531
516
|
}
|
|
532
517
|
/**
|
|
@@ -1012,11 +997,11 @@ export interface CreateBotBody {
|
|
|
1012
997
|
};
|
|
1013
998
|
/**
|
|
1014
999
|
* Events definition
|
|
1015
|
-
* @type {{ [key: string]:
|
|
1000
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
1016
1001
|
* @memberof CreateBotBody
|
|
1017
1002
|
*/
|
|
1018
1003
|
'events'?: {
|
|
1019
|
-
[key: string]:
|
|
1004
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
1020
1005
|
};
|
|
1021
1006
|
/**
|
|
1022
1007
|
*
|
|
@@ -1034,11 +1019,11 @@ export interface CreateBotBody {
|
|
|
1034
1019
|
'subscriptions'?: CreateBotBodySubscriptions;
|
|
1035
1020
|
/**
|
|
1036
1021
|
* Actions definition
|
|
1037
|
-
* @type {{ [key: string]:
|
|
1022
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
1038
1023
|
* @memberof CreateBotBody
|
|
1039
1024
|
*/
|
|
1040
1025
|
'actions'?: {
|
|
1041
|
-
[key: string]:
|
|
1026
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
1042
1027
|
};
|
|
1043
1028
|
/**
|
|
1044
1029
|
*
|
|
@@ -1095,52 +1080,6 @@ export interface CreateBotBody {
|
|
|
1095
1080
|
*/
|
|
1096
1081
|
'dev'?: boolean;
|
|
1097
1082
|
}
|
|
1098
|
-
/**
|
|
1099
|
-
* Action definition
|
|
1100
|
-
* @export
|
|
1101
|
-
* @interface CreateBotBodyActionsValue
|
|
1102
|
-
*/
|
|
1103
|
-
export interface CreateBotBodyActionsValue {
|
|
1104
|
-
/**
|
|
1105
|
-
* Title of the action
|
|
1106
|
-
* @type {string}
|
|
1107
|
-
* @memberof CreateBotBodyActionsValue
|
|
1108
|
-
*/
|
|
1109
|
-
'title'?: string;
|
|
1110
|
-
/**
|
|
1111
|
-
* Description of the action
|
|
1112
|
-
* @type {string}
|
|
1113
|
-
* @memberof CreateBotBodyActionsValue
|
|
1114
|
-
*/
|
|
1115
|
-
'description'?: string;
|
|
1116
|
-
/**
|
|
1117
|
-
*
|
|
1118
|
-
* @type {CreateBotBodyActionsValueInput}
|
|
1119
|
-
* @memberof CreateBotBodyActionsValue
|
|
1120
|
-
*/
|
|
1121
|
-
'input': CreateBotBodyActionsValueInput;
|
|
1122
|
-
/**
|
|
1123
|
-
*
|
|
1124
|
-
* @type {CreateBotBodyActionsValueInput}
|
|
1125
|
-
* @memberof CreateBotBodyActionsValue
|
|
1126
|
-
*/
|
|
1127
|
-
'output': CreateBotBodyActionsValueInput;
|
|
1128
|
-
}
|
|
1129
|
-
/**
|
|
1130
|
-
*
|
|
1131
|
-
* @export
|
|
1132
|
-
* @interface CreateBotBodyActionsValueInput
|
|
1133
|
-
*/
|
|
1134
|
-
export interface CreateBotBodyActionsValueInput {
|
|
1135
|
-
/**
|
|
1136
|
-
*
|
|
1137
|
-
* @type {{ [key: string]: any; }}
|
|
1138
|
-
* @memberof CreateBotBodyActionsValueInput
|
|
1139
|
-
*/
|
|
1140
|
-
'schema': {
|
|
1141
|
-
[key: string]: any;
|
|
1142
|
-
};
|
|
1143
|
-
}
|
|
1144
1083
|
/**
|
|
1145
1084
|
*
|
|
1146
1085
|
* @export
|
|
@@ -1164,33 +1103,6 @@ export interface CreateBotBodyConfiguration {
|
|
|
1164
1103
|
[key: string]: any;
|
|
1165
1104
|
};
|
|
1166
1105
|
}
|
|
1167
|
-
/**
|
|
1168
|
-
* Event Definition
|
|
1169
|
-
* @export
|
|
1170
|
-
* @interface CreateBotBodyEventsValue
|
|
1171
|
-
*/
|
|
1172
|
-
export interface CreateBotBodyEventsValue {
|
|
1173
|
-
/**
|
|
1174
|
-
* Title of the event
|
|
1175
|
-
* @type {string}
|
|
1176
|
-
* @memberof CreateBotBodyEventsValue
|
|
1177
|
-
*/
|
|
1178
|
-
'title'?: string;
|
|
1179
|
-
/**
|
|
1180
|
-
* Description of the event
|
|
1181
|
-
* @type {string}
|
|
1182
|
-
* @memberof CreateBotBodyEventsValue
|
|
1183
|
-
*/
|
|
1184
|
-
'description'?: string;
|
|
1185
|
-
/**
|
|
1186
|
-
*
|
|
1187
|
-
* @type {{ [key: string]: any; }}
|
|
1188
|
-
* @memberof CreateBotBodyEventsValue
|
|
1189
|
-
*/
|
|
1190
|
-
'schema': {
|
|
1191
|
-
[key: string]: any;
|
|
1192
|
-
};
|
|
1193
|
-
}
|
|
1194
1106
|
/**
|
|
1195
1107
|
*
|
|
1196
1108
|
* @export
|
|
@@ -1309,32 +1221,13 @@ export interface CreateBotBodySubscriptions {
|
|
|
1309
1221
|
export interface CreateBotBodyUser {
|
|
1310
1222
|
/**
|
|
1311
1223
|
*
|
|
1312
|
-
* @type {{ [key: string]:
|
|
1224
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
1313
1225
|
* @memberof CreateBotBodyUser
|
|
1314
1226
|
*/
|
|
1315
1227
|
'tags'?: {
|
|
1316
|
-
[key: string]:
|
|
1228
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
1317
1229
|
};
|
|
1318
1230
|
}
|
|
1319
|
-
/**
|
|
1320
|
-
* Definition of a tag that can be provided on the object
|
|
1321
|
-
* @export
|
|
1322
|
-
* @interface CreateBotBodyUserTagsValue
|
|
1323
|
-
*/
|
|
1324
|
-
export interface CreateBotBodyUserTagsValue {
|
|
1325
|
-
/**
|
|
1326
|
-
* Title of the tag
|
|
1327
|
-
* @type {string}
|
|
1328
|
-
* @memberof CreateBotBodyUserTagsValue
|
|
1329
|
-
*/
|
|
1330
|
-
'title'?: string;
|
|
1331
|
-
/**
|
|
1332
|
-
* Description of the tag
|
|
1333
|
-
* @type {string}
|
|
1334
|
-
* @memberof CreateBotBodyUserTagsValue
|
|
1335
|
-
*/
|
|
1336
|
-
'description'?: string;
|
|
1337
|
-
}
|
|
1338
1231
|
/**
|
|
1339
1232
|
*
|
|
1340
1233
|
* @export
|
|
@@ -1473,48 +1366,101 @@ export interface CreateEventResponse {
|
|
|
1473
1366
|
*/
|
|
1474
1367
|
export interface CreateFileBody {
|
|
1475
1368
|
/**
|
|
1476
|
-
*
|
|
1477
|
-
* @type {
|
|
1369
|
+
*
|
|
1370
|
+
* @type {any}
|
|
1478
1371
|
* @memberof CreateFileBody
|
|
1479
1372
|
*/
|
|
1373
|
+
'data'?: any | null;
|
|
1374
|
+
}
|
|
1375
|
+
/**
|
|
1376
|
+
*
|
|
1377
|
+
* @export
|
|
1378
|
+
* @interface CreateFileResponse
|
|
1379
|
+
*/
|
|
1380
|
+
export interface CreateFileResponse {
|
|
1381
|
+
/**
|
|
1382
|
+
*
|
|
1383
|
+
* @type {CreateFileResponseFile}
|
|
1384
|
+
* @memberof CreateFileResponse
|
|
1385
|
+
*/
|
|
1386
|
+
'file': CreateFileResponseFile;
|
|
1387
|
+
}
|
|
1388
|
+
/**
|
|
1389
|
+
*
|
|
1390
|
+
* @export
|
|
1391
|
+
* @interface CreateFileResponseFile
|
|
1392
|
+
*/
|
|
1393
|
+
export interface CreateFileResponseFile {
|
|
1394
|
+
/**
|
|
1395
|
+
*
|
|
1396
|
+
* @type {string}
|
|
1397
|
+
* @memberof CreateFileResponseFile
|
|
1398
|
+
*/
|
|
1399
|
+
'id': string;
|
|
1400
|
+
/**
|
|
1401
|
+
*
|
|
1402
|
+
* @type {string}
|
|
1403
|
+
* @memberof CreateFileResponseFile
|
|
1404
|
+
*/
|
|
1480
1405
|
'botId': string;
|
|
1481
1406
|
/**
|
|
1482
|
-
*
|
|
1407
|
+
*
|
|
1483
1408
|
* @type {string}
|
|
1484
|
-
* @memberof
|
|
1409
|
+
* @memberof CreateFileResponseFile
|
|
1410
|
+
*/
|
|
1411
|
+
'filename': string;
|
|
1412
|
+
/**
|
|
1413
|
+
*
|
|
1414
|
+
* @type {number}
|
|
1415
|
+
* @memberof CreateFileResponseFile
|
|
1416
|
+
*/
|
|
1417
|
+
'bytes': number | null;
|
|
1418
|
+
/**
|
|
1419
|
+
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
1420
|
+
* @type {{ [key: string]: string; }}
|
|
1421
|
+
* @memberof CreateFileResponseFile
|
|
1485
1422
|
*/
|
|
1486
|
-
'
|
|
1423
|
+
'tags': {
|
|
1424
|
+
[key: string]: string;
|
|
1425
|
+
};
|
|
1487
1426
|
/**
|
|
1488
|
-
*
|
|
1427
|
+
*
|
|
1489
1428
|
* @type {string}
|
|
1490
|
-
* @memberof
|
|
1429
|
+
* @memberof CreateFileResponseFile
|
|
1491
1430
|
*/
|
|
1492
|
-
'
|
|
1431
|
+
'createdAt': string;
|
|
1493
1432
|
/**
|
|
1494
|
-
*
|
|
1433
|
+
*
|
|
1495
1434
|
* @type {string}
|
|
1496
|
-
* @memberof
|
|
1435
|
+
* @memberof CreateFileResponseFile
|
|
1497
1436
|
*/
|
|
1498
|
-
'
|
|
1499
|
-
}
|
|
1500
|
-
export declare const CreateFileBodyAccessTypeEnum: {
|
|
1501
|
-
readonly Private: "private";
|
|
1502
|
-
readonly Public: "public";
|
|
1503
|
-
};
|
|
1504
|
-
export type CreateFileBodyAccessTypeEnum = typeof CreateFileBodyAccessTypeEnum[keyof typeof CreateFileBodyAccessTypeEnum];
|
|
1505
|
-
/**
|
|
1506
|
-
*
|
|
1507
|
-
* @export
|
|
1508
|
-
* @interface CreateFileResponse
|
|
1509
|
-
*/
|
|
1510
|
-
export interface CreateFileResponse {
|
|
1437
|
+
'updatedAt': string;
|
|
1511
1438
|
/**
|
|
1512
1439
|
*
|
|
1513
|
-
* @type {
|
|
1514
|
-
* @memberof
|
|
1440
|
+
* @type {Array<string>}
|
|
1441
|
+
* @memberof CreateFileResponseFile
|
|
1442
|
+
*/
|
|
1443
|
+
'accessPolicies': Array<string>;
|
|
1444
|
+
/**
|
|
1445
|
+
*
|
|
1446
|
+
* @type {string}
|
|
1447
|
+
* @memberof CreateFileResponseFile
|
|
1448
|
+
*/
|
|
1449
|
+
'indexingStatus'?: CreateFileResponseFileIndexingStatusEnum;
|
|
1450
|
+
/**
|
|
1451
|
+
*
|
|
1452
|
+
* @type {string}
|
|
1453
|
+
* @memberof CreateFileResponseFile
|
|
1515
1454
|
*/
|
|
1516
|
-
'
|
|
1455
|
+
'indexingFailureReason'?: string;
|
|
1517
1456
|
}
|
|
1457
|
+
export declare const CreateFileResponseFileIndexingStatusEnum: {
|
|
1458
|
+
readonly Pending: "PENDING";
|
|
1459
|
+
readonly InProgress: "IN_PROGRESS";
|
|
1460
|
+
readonly Complete: "COMPLETE";
|
|
1461
|
+
readonly Failed: "FAILED";
|
|
1462
|
+
};
|
|
1463
|
+
export type CreateFileResponseFileIndexingStatusEnum = typeof CreateFileResponseFileIndexingStatusEnum[keyof typeof CreateFileResponseFileIndexingStatusEnum];
|
|
1518
1464
|
/**
|
|
1519
1465
|
*
|
|
1520
1466
|
* @export
|
|
@@ -1541,35 +1487,35 @@ export interface CreateIntegrationBody {
|
|
|
1541
1487
|
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
1542
1488
|
/**
|
|
1543
1489
|
*
|
|
1544
|
-
* @type {{ [key: string]:
|
|
1490
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue; }}
|
|
1545
1491
|
* @memberof CreateIntegrationBody
|
|
1546
1492
|
*/
|
|
1547
1493
|
'states'?: {
|
|
1548
|
-
[key: string]:
|
|
1494
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue;
|
|
1549
1495
|
};
|
|
1550
1496
|
/**
|
|
1551
1497
|
*
|
|
1552
|
-
* @type {{ [key: string]:
|
|
1498
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
1553
1499
|
* @memberof CreateIntegrationBody
|
|
1554
1500
|
*/
|
|
1555
1501
|
'events'?: {
|
|
1556
|
-
[key: string]:
|
|
1502
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
1557
1503
|
};
|
|
1558
1504
|
/**
|
|
1559
1505
|
*
|
|
1560
|
-
* @type {{ [key: string]:
|
|
1506
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
1561
1507
|
* @memberof CreateIntegrationBody
|
|
1562
1508
|
*/
|
|
1563
1509
|
'actions'?: {
|
|
1564
|
-
[key: string]:
|
|
1510
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
1565
1511
|
};
|
|
1566
1512
|
/**
|
|
1567
1513
|
*
|
|
1568
|
-
* @type {{ [key: string]:
|
|
1514
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue; }}
|
|
1569
1515
|
* @memberof CreateIntegrationBody
|
|
1570
1516
|
*/
|
|
1571
1517
|
'entities'?: {
|
|
1572
|
-
[key: string]:
|
|
1518
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue;
|
|
1573
1519
|
};
|
|
1574
1520
|
/**
|
|
1575
1521
|
*
|
|
@@ -1662,11 +1608,11 @@ export interface CreateIntegrationBodyChannelsValue {
|
|
|
1662
1608
|
'description'?: string;
|
|
1663
1609
|
/**
|
|
1664
1610
|
*
|
|
1665
|
-
* @type {{ [key: string]:
|
|
1611
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue; }}
|
|
1666
1612
|
* @memberof CreateIntegrationBodyChannelsValue
|
|
1667
1613
|
*/
|
|
1668
1614
|
'messages': {
|
|
1669
|
-
[key: string]:
|
|
1615
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue;
|
|
1670
1616
|
};
|
|
1671
1617
|
/**
|
|
1672
1618
|
*
|
|
@@ -1689,51 +1635,17 @@ export interface CreateIntegrationBodyChannelsValue {
|
|
|
1689
1635
|
export interface CreateIntegrationBodyChannelsValueConversation {
|
|
1690
1636
|
/**
|
|
1691
1637
|
*
|
|
1692
|
-
* @type {
|
|
1638
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation}
|
|
1693
1639
|
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
1694
1640
|
*/
|
|
1695
|
-
'creation'?:
|
|
1641
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation;
|
|
1696
1642
|
/**
|
|
1697
1643
|
*
|
|
1698
|
-
* @type {{ [key: string]:
|
|
1644
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
1699
1645
|
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
1700
1646
|
*/
|
|
1701
1647
|
'tags'?: {
|
|
1702
|
-
[key: string]:
|
|
1703
|
-
};
|
|
1704
|
-
}
|
|
1705
|
-
/**
|
|
1706
|
-
* The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
|
|
1707
|
-
* @export
|
|
1708
|
-
* @interface CreateIntegrationBodyChannelsValueConversationCreation
|
|
1709
|
-
*/
|
|
1710
|
-
export interface CreateIntegrationBodyChannelsValueConversationCreation {
|
|
1711
|
-
/**
|
|
1712
|
-
* Enable conversation creation
|
|
1713
|
-
* @type {boolean}
|
|
1714
|
-
* @memberof CreateIntegrationBodyChannelsValueConversationCreation
|
|
1715
|
-
*/
|
|
1716
|
-
'enabled': boolean;
|
|
1717
|
-
/**
|
|
1718
|
-
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
1719
|
-
* @type {Array<string>}
|
|
1720
|
-
* @memberof CreateIntegrationBodyChannelsValueConversationCreation
|
|
1721
|
-
*/
|
|
1722
|
-
'requiredTags': Array<string>;
|
|
1723
|
-
}
|
|
1724
|
-
/**
|
|
1725
|
-
* Message definition
|
|
1726
|
-
* @export
|
|
1727
|
-
* @interface CreateIntegrationBodyChannelsValueMessagesValue
|
|
1728
|
-
*/
|
|
1729
|
-
export interface CreateIntegrationBodyChannelsValueMessagesValue {
|
|
1730
|
-
/**
|
|
1731
|
-
*
|
|
1732
|
-
* @type {{ [key: string]: any; }}
|
|
1733
|
-
* @memberof CreateIntegrationBodyChannelsValueMessagesValue
|
|
1734
|
-
*/
|
|
1735
|
-
'schema': {
|
|
1736
|
-
[key: string]: any;
|
|
1648
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
1737
1649
|
};
|
|
1738
1650
|
}
|
|
1739
1651
|
/**
|
|
@@ -1776,33 +1688,6 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1776
1688
|
*/
|
|
1777
1689
|
'linkTemplateScript'?: string;
|
|
1778
1690
|
}
|
|
1779
|
-
/**
|
|
1780
|
-
* Entity definition
|
|
1781
|
-
* @export
|
|
1782
|
-
* @interface CreateIntegrationBodyEntitiesValue
|
|
1783
|
-
*/
|
|
1784
|
-
export interface CreateIntegrationBodyEntitiesValue {
|
|
1785
|
-
/**
|
|
1786
|
-
* Title of the entity
|
|
1787
|
-
* @type {string}
|
|
1788
|
-
* @memberof CreateIntegrationBodyEntitiesValue
|
|
1789
|
-
*/
|
|
1790
|
-
'title'?: string;
|
|
1791
|
-
/**
|
|
1792
|
-
* Description of the entity
|
|
1793
|
-
* @type {string}
|
|
1794
|
-
* @memberof CreateIntegrationBodyEntitiesValue
|
|
1795
|
-
*/
|
|
1796
|
-
'description'?: string;
|
|
1797
|
-
/**
|
|
1798
|
-
*
|
|
1799
|
-
* @type {{ [key: string]: any; }}
|
|
1800
|
-
* @memberof CreateIntegrationBodyEntitiesValue
|
|
1801
|
-
*/
|
|
1802
|
-
'schema': {
|
|
1803
|
-
[key: string]: any;
|
|
1804
|
-
};
|
|
1805
|
-
}
|
|
1806
1691
|
/**
|
|
1807
1692
|
*
|
|
1808
1693
|
* @export
|
|
@@ -1822,33 +1707,6 @@ export interface CreateIntegrationBodyIdentifier {
|
|
|
1822
1707
|
*/
|
|
1823
1708
|
'extractScript'?: string;
|
|
1824
1709
|
}
|
|
1825
|
-
/**
|
|
1826
|
-
* State definition
|
|
1827
|
-
* @export
|
|
1828
|
-
* @interface CreateIntegrationBodyStatesValue
|
|
1829
|
-
*/
|
|
1830
|
-
export interface CreateIntegrationBodyStatesValue {
|
|
1831
|
-
/**
|
|
1832
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
1833
|
-
* @type {string}
|
|
1834
|
-
* @memberof CreateIntegrationBodyStatesValue
|
|
1835
|
-
*/
|
|
1836
|
-
'type': CreateIntegrationBodyStatesValueTypeEnum;
|
|
1837
|
-
/**
|
|
1838
|
-
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
1839
|
-
* @type {{ [key: string]: any; }}
|
|
1840
|
-
* @memberof CreateIntegrationBodyStatesValue
|
|
1841
|
-
*/
|
|
1842
|
-
'schema': {
|
|
1843
|
-
[key: string]: any;
|
|
1844
|
-
};
|
|
1845
|
-
}
|
|
1846
|
-
export declare const CreateIntegrationBodyStatesValueTypeEnum: {
|
|
1847
|
-
readonly Conversation: "conversation";
|
|
1848
|
-
readonly User: "user";
|
|
1849
|
-
readonly Integration: "integration";
|
|
1850
|
-
};
|
|
1851
|
-
export type CreateIntegrationBodyStatesValueTypeEnum = typeof CreateIntegrationBodyStatesValueTypeEnum[keyof typeof CreateIntegrationBodyStatesValueTypeEnum];
|
|
1852
1710
|
/**
|
|
1853
1711
|
*
|
|
1854
1712
|
* @export
|
|
@@ -1857,38 +1715,19 @@ export type CreateIntegrationBodyStatesValueTypeEnum = typeof CreateIntegrationB
|
|
|
1857
1715
|
export interface CreateIntegrationBodyUser {
|
|
1858
1716
|
/**
|
|
1859
1717
|
*
|
|
1860
|
-
* @type {
|
|
1718
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUserCreation}
|
|
1861
1719
|
* @memberof CreateIntegrationBodyUser
|
|
1862
1720
|
*/
|
|
1863
|
-
'creation'?:
|
|
1721
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationUserCreation;
|
|
1864
1722
|
/**
|
|
1865
1723
|
*
|
|
1866
|
-
* @type {{ [key: string]:
|
|
1724
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
1867
1725
|
* @memberof CreateIntegrationBodyUser
|
|
1868
1726
|
*/
|
|
1869
1727
|
'tags'?: {
|
|
1870
|
-
[key: string]:
|
|
1728
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
1871
1729
|
};
|
|
1872
1730
|
}
|
|
1873
|
-
/**
|
|
1874
|
-
* The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
|
|
1875
|
-
* @export
|
|
1876
|
-
* @interface CreateIntegrationBodyUserCreation
|
|
1877
|
-
*/
|
|
1878
|
-
export interface CreateIntegrationBodyUserCreation {
|
|
1879
|
-
/**
|
|
1880
|
-
* Enable user creation
|
|
1881
|
-
* @type {boolean}
|
|
1882
|
-
* @memberof CreateIntegrationBodyUserCreation
|
|
1883
|
-
*/
|
|
1884
|
-
'enabled': boolean;
|
|
1885
|
-
/**
|
|
1886
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
1887
|
-
* @type {Array<string>}
|
|
1888
|
-
* @memberof CreateIntegrationBodyUserCreation
|
|
1889
|
-
*/
|
|
1890
|
-
'requiredTags': Array<string>;
|
|
1891
|
-
}
|
|
1892
1731
|
/**
|
|
1893
1732
|
*
|
|
1894
1733
|
* @export
|
|
@@ -3044,15 +2883,28 @@ export interface GetEventResponse {
|
|
|
3044
2883
|
/**
|
|
3045
2884
|
*
|
|
3046
2885
|
* @export
|
|
3047
|
-
* @interface
|
|
2886
|
+
* @interface GetFileContentResponse
|
|
2887
|
+
*/
|
|
2888
|
+
export interface GetFileContentResponse {
|
|
2889
|
+
/**
|
|
2890
|
+
* Temporary pre-signed URL to download the file, should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
|
|
2891
|
+
* @type {string}
|
|
2892
|
+
* @memberof GetFileContentResponse
|
|
2893
|
+
*/
|
|
2894
|
+
'url': string;
|
|
2895
|
+
}
|
|
2896
|
+
/**
|
|
2897
|
+
*
|
|
2898
|
+
* @export
|
|
2899
|
+
* @interface GetFileMetadataResponse
|
|
3048
2900
|
*/
|
|
3049
|
-
export interface
|
|
2901
|
+
export interface GetFileMetadataResponse {
|
|
3050
2902
|
/**
|
|
3051
2903
|
*
|
|
3052
|
-
* @type {
|
|
3053
|
-
* @memberof
|
|
2904
|
+
* @type {CreateFileResponseFile}
|
|
2905
|
+
* @memberof GetFileMetadataResponse
|
|
3054
2906
|
*/
|
|
3055
|
-
'file':
|
|
2907
|
+
'file': CreateFileResponseFile;
|
|
3056
2908
|
}
|
|
3057
2909
|
/**
|
|
3058
2910
|
*
|
|
@@ -3315,28 +3167,544 @@ export interface GetParticipantResponse {
|
|
|
3315
3167
|
export interface GetPublicIntegrationByIdResponse {
|
|
3316
3168
|
/**
|
|
3317
3169
|
*
|
|
3318
|
-
* @type {
|
|
3170
|
+
* @type {GetPublicIntegrationByIdResponseIntegration}
|
|
3319
3171
|
* @memberof GetPublicIntegrationByIdResponse
|
|
3320
3172
|
*/
|
|
3321
|
-
'integration':
|
|
3173
|
+
'integration': GetPublicIntegrationByIdResponseIntegration;
|
|
3322
3174
|
}
|
|
3323
3175
|
/**
|
|
3324
3176
|
*
|
|
3325
3177
|
* @export
|
|
3326
|
-
* @interface
|
|
3178
|
+
* @interface GetPublicIntegrationByIdResponseIntegration
|
|
3327
3179
|
*/
|
|
3328
|
-
export interface
|
|
3180
|
+
export interface GetPublicIntegrationByIdResponseIntegration {
|
|
3329
3181
|
/**
|
|
3330
|
-
*
|
|
3331
|
-
* @type {
|
|
3332
|
-
* @memberof
|
|
3182
|
+
* User id
|
|
3183
|
+
* @type {string}
|
|
3184
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3333
3185
|
*/
|
|
3334
|
-
'
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
|
|
3186
|
+
'id': string;
|
|
3187
|
+
/**
|
|
3188
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
3189
|
+
* @type {string}
|
|
3190
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3191
|
+
*/
|
|
3192
|
+
'createdAt': string;
|
|
3193
|
+
/**
|
|
3194
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
3195
|
+
* @type {string}
|
|
3196
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3197
|
+
*/
|
|
3198
|
+
'updatedAt': string;
|
|
3199
|
+
/**
|
|
3200
|
+
*
|
|
3201
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationIdentifier}
|
|
3202
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3203
|
+
*/
|
|
3204
|
+
'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
|
|
3205
|
+
/**
|
|
3206
|
+
* Unique identifier of the integration that was installed on the bot
|
|
3207
|
+
* @type {string}
|
|
3208
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3209
|
+
*/
|
|
3210
|
+
'name': string;
|
|
3211
|
+
/**
|
|
3212
|
+
* Unique identifier of the integration that was installed on the bot
|
|
3213
|
+
* @type {string}
|
|
3214
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3215
|
+
*/
|
|
3216
|
+
'version': string;
|
|
3217
|
+
/**
|
|
3218
|
+
*
|
|
3219
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationConfiguration}
|
|
3220
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3221
|
+
*/
|
|
3222
|
+
'configuration': GetPublicIntegrationByIdResponseIntegrationConfiguration;
|
|
3223
|
+
/**
|
|
3224
|
+
*
|
|
3225
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue; }}
|
|
3226
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3227
|
+
*/
|
|
3228
|
+
'channels': {
|
|
3229
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue;
|
|
3230
|
+
};
|
|
3231
|
+
/**
|
|
3232
|
+
*
|
|
3233
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue; }}
|
|
3234
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3235
|
+
*/
|
|
3236
|
+
'states': {
|
|
3237
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue;
|
|
3238
|
+
};
|
|
3239
|
+
/**
|
|
3240
|
+
*
|
|
3241
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
3242
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3243
|
+
*/
|
|
3244
|
+
'events': {
|
|
3245
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
3246
|
+
};
|
|
3247
|
+
/**
|
|
3248
|
+
*
|
|
3249
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
3250
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3251
|
+
*/
|
|
3252
|
+
'actions': {
|
|
3253
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
3254
|
+
};
|
|
3255
|
+
/**
|
|
3256
|
+
*
|
|
3257
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUser}
|
|
3258
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3259
|
+
*/
|
|
3260
|
+
'user': GetPublicIntegrationByIdResponseIntegrationUser;
|
|
3261
|
+
/**
|
|
3262
|
+
*
|
|
3263
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue; }}
|
|
3264
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3265
|
+
*/
|
|
3266
|
+
'entities': {
|
|
3267
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue;
|
|
3268
|
+
};
|
|
3269
|
+
/**
|
|
3270
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
3271
|
+
* @type {boolean}
|
|
3272
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3273
|
+
*/
|
|
3274
|
+
'dev': boolean;
|
|
3275
|
+
/**
|
|
3276
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
3277
|
+
* @type {string}
|
|
3278
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3279
|
+
*/
|
|
3280
|
+
'title': string;
|
|
3281
|
+
/**
|
|
3282
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
3283
|
+
* @type {string}
|
|
3284
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3285
|
+
*/
|
|
3286
|
+
'description': string;
|
|
3287
|
+
/**
|
|
3288
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
3289
|
+
* @type {string}
|
|
3290
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3291
|
+
*/
|
|
3292
|
+
'iconUrl': string;
|
|
3293
|
+
/**
|
|
3294
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
3295
|
+
* @type {string}
|
|
3296
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3297
|
+
*/
|
|
3298
|
+
'readmeUrl': string;
|
|
3299
|
+
/**
|
|
3300
|
+
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
3301
|
+
* @type {Array<string>}
|
|
3302
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3303
|
+
*/
|
|
3304
|
+
'secrets': Array<string>;
|
|
3305
|
+
/**
|
|
3306
|
+
*
|
|
3307
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationOwnerWorkspace}
|
|
3308
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3309
|
+
*/
|
|
3310
|
+
'ownerWorkspace': GetPublicIntegrationByIdResponseIntegrationOwnerWorkspace;
|
|
3311
|
+
}
|
|
3312
|
+
/**
|
|
3313
|
+
* Action definition
|
|
3314
|
+
* @export
|
|
3315
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationActionsValue
|
|
3316
|
+
*/
|
|
3317
|
+
export interface GetPublicIntegrationByIdResponseIntegrationActionsValue {
|
|
3318
|
+
/**
|
|
3319
|
+
* Title of the action
|
|
3320
|
+
* @type {string}
|
|
3321
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationActionsValue
|
|
3322
|
+
*/
|
|
3323
|
+
'title'?: string;
|
|
3324
|
+
/**
|
|
3325
|
+
* Description of the action
|
|
3326
|
+
* @type {string}
|
|
3327
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationActionsValue
|
|
3328
|
+
*/
|
|
3329
|
+
'description'?: string;
|
|
3330
|
+
/**
|
|
3331
|
+
*
|
|
3332
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationActionsValueInput}
|
|
3333
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationActionsValue
|
|
3334
|
+
*/
|
|
3335
|
+
'input': GetPublicIntegrationByIdResponseIntegrationActionsValueInput;
|
|
3336
|
+
/**
|
|
3337
|
+
*
|
|
3338
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationActionsValueInput}
|
|
3339
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationActionsValue
|
|
3340
|
+
*/
|
|
3341
|
+
'output': GetPublicIntegrationByIdResponseIntegrationActionsValueInput;
|
|
3342
|
+
}
|
|
3343
|
+
/**
|
|
3344
|
+
*
|
|
3345
|
+
* @export
|
|
3346
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationActionsValueInput
|
|
3347
|
+
*/
|
|
3348
|
+
export interface GetPublicIntegrationByIdResponseIntegrationActionsValueInput {
|
|
3349
|
+
/**
|
|
3350
|
+
*
|
|
3351
|
+
* @type {{ [key: string]: any; }}
|
|
3352
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationActionsValueInput
|
|
3353
|
+
*/
|
|
3354
|
+
'schema': {
|
|
3355
|
+
[key: string]: any;
|
|
3356
|
+
};
|
|
3357
|
+
}
|
|
3358
|
+
/**
|
|
3359
|
+
* Channel definition
|
|
3360
|
+
* @export
|
|
3361
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationChannelsValue
|
|
3362
|
+
*/
|
|
3363
|
+
export interface GetPublicIntegrationByIdResponseIntegrationChannelsValue {
|
|
3364
|
+
/**
|
|
3365
|
+
* Title of the channel
|
|
3366
|
+
* @type {string}
|
|
3367
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValue
|
|
3368
|
+
*/
|
|
3369
|
+
'title'?: string;
|
|
3370
|
+
/**
|
|
3371
|
+
* Description of the channel
|
|
3372
|
+
* @type {string}
|
|
3373
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValue
|
|
3374
|
+
*/
|
|
3375
|
+
'description'?: string;
|
|
3376
|
+
/**
|
|
3377
|
+
*
|
|
3378
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue; }}
|
|
3379
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValue
|
|
3380
|
+
*/
|
|
3381
|
+
'messages': {
|
|
3382
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue;
|
|
3383
|
+
};
|
|
3384
|
+
/**
|
|
3385
|
+
*
|
|
3386
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueConversation}
|
|
3387
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValue
|
|
3388
|
+
*/
|
|
3389
|
+
'conversation': GetPublicIntegrationByIdResponseIntegrationChannelsValueConversation;
|
|
3390
|
+
/**
|
|
3391
|
+
*
|
|
3392
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueMessage}
|
|
3393
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValue
|
|
3394
|
+
*/
|
|
3395
|
+
'message': GetPublicIntegrationByIdResponseIntegrationChannelsValueMessage;
|
|
3396
|
+
}
|
|
3397
|
+
/**
|
|
3398
|
+
* Conversation object configuration
|
|
3399
|
+
* @export
|
|
3400
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationChannelsValueConversation
|
|
3401
|
+
*/
|
|
3402
|
+
export interface GetPublicIntegrationByIdResponseIntegrationChannelsValueConversation {
|
|
3403
|
+
/**
|
|
3404
|
+
*
|
|
3405
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
3406
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueConversation
|
|
3407
|
+
*/
|
|
3408
|
+
'tags': {
|
|
3409
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
3410
|
+
};
|
|
3411
|
+
/**
|
|
3412
|
+
*
|
|
3413
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation}
|
|
3414
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueConversation
|
|
3415
|
+
*/
|
|
3416
|
+
'creation': GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation;
|
|
3417
|
+
}
|
|
3418
|
+
/**
|
|
3419
|
+
* The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
|
|
3420
|
+
* @export
|
|
3421
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation
|
|
3422
|
+
*/
|
|
3423
|
+
export interface GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation {
|
|
3424
|
+
/**
|
|
3425
|
+
* Enable conversation creation
|
|
3426
|
+
* @type {boolean}
|
|
3427
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation
|
|
3428
|
+
*/
|
|
3429
|
+
'enabled': boolean;
|
|
3430
|
+
/**
|
|
3431
|
+
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
3432
|
+
* @type {Array<string>}
|
|
3433
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation
|
|
3434
|
+
*/
|
|
3435
|
+
'requiredTags': Array<string>;
|
|
3436
|
+
}
|
|
3437
|
+
/**
|
|
3438
|
+
* Definition of a tag that can be provided on the object
|
|
3439
|
+
* @export
|
|
3440
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue
|
|
3441
|
+
*/
|
|
3442
|
+
export interface GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue {
|
|
3443
|
+
/**
|
|
3444
|
+
* Title of the tag
|
|
3445
|
+
* @type {string}
|
|
3446
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue
|
|
3447
|
+
*/
|
|
3448
|
+
'title'?: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* Description of the tag
|
|
3451
|
+
* @type {string}
|
|
3452
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue
|
|
3453
|
+
*/
|
|
3454
|
+
'description'?: string;
|
|
3455
|
+
}
|
|
3456
|
+
/**
|
|
3457
|
+
* Message object configuration
|
|
3458
|
+
* @export
|
|
3459
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationChannelsValueMessage
|
|
3460
|
+
*/
|
|
3461
|
+
export interface GetPublicIntegrationByIdResponseIntegrationChannelsValueMessage {
|
|
3462
|
+
/**
|
|
3463
|
+
*
|
|
3464
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
3465
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueMessage
|
|
3466
|
+
*/
|
|
3467
|
+
'tags': {
|
|
3468
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
3469
|
+
};
|
|
3470
|
+
}
|
|
3471
|
+
/**
|
|
3472
|
+
* Message definition
|
|
3473
|
+
* @export
|
|
3474
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue
|
|
3475
|
+
*/
|
|
3476
|
+
export interface GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue {
|
|
3477
|
+
/**
|
|
3478
|
+
*
|
|
3479
|
+
* @type {{ [key: string]: any; }}
|
|
3480
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue
|
|
3481
|
+
*/
|
|
3482
|
+
'schema': {
|
|
3483
|
+
[key: string]: any;
|
|
3484
|
+
};
|
|
3485
|
+
}
|
|
3486
|
+
/**
|
|
3487
|
+
* Configuration definition
|
|
3488
|
+
* @export
|
|
3489
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationConfiguration
|
|
3490
|
+
*/
|
|
3491
|
+
export interface GetPublicIntegrationByIdResponseIntegrationConfiguration {
|
|
3492
|
+
/**
|
|
3493
|
+
*
|
|
3494
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier}
|
|
3495
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationConfiguration
|
|
3496
|
+
*/
|
|
3497
|
+
'identifier': GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier;
|
|
3498
|
+
/**
|
|
3499
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
3500
|
+
* @type {{ [key: string]: any; }}
|
|
3501
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationConfiguration
|
|
3502
|
+
*/
|
|
3503
|
+
'schema'?: {
|
|
3504
|
+
[key: string]: any;
|
|
3505
|
+
};
|
|
3506
|
+
}
|
|
3507
|
+
/**
|
|
3508
|
+
* Identifier configuration of the [Integration](#schema_integration)
|
|
3509
|
+
* @export
|
|
3510
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier
|
|
3511
|
+
*/
|
|
3512
|
+
export interface GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier {
|
|
3513
|
+
/**
|
|
3514
|
+
* Title describing the task
|
|
3515
|
+
* @type {string}
|
|
3516
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier
|
|
3517
|
+
*/
|
|
3518
|
+
'linkTemplateScript'?: string;
|
|
3519
|
+
/**
|
|
3520
|
+
*
|
|
3521
|
+
* @type {boolean}
|
|
3522
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier
|
|
3523
|
+
*/
|
|
3524
|
+
'required': boolean;
|
|
3525
|
+
}
|
|
3526
|
+
/**
|
|
3527
|
+
* Entity definition
|
|
3528
|
+
* @export
|
|
3529
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationEntitiesValue
|
|
3530
|
+
*/
|
|
3531
|
+
export interface GetPublicIntegrationByIdResponseIntegrationEntitiesValue {
|
|
3532
|
+
/**
|
|
3533
|
+
* Title of the entity
|
|
3534
|
+
* @type {string}
|
|
3535
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationEntitiesValue
|
|
3536
|
+
*/
|
|
3537
|
+
'title'?: string;
|
|
3538
|
+
/**
|
|
3539
|
+
* Description of the entity
|
|
3540
|
+
* @type {string}
|
|
3541
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationEntitiesValue
|
|
3542
|
+
*/
|
|
3543
|
+
'description'?: string;
|
|
3544
|
+
/**
|
|
3545
|
+
*
|
|
3546
|
+
* @type {{ [key: string]: any; }}
|
|
3547
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationEntitiesValue
|
|
3548
|
+
*/
|
|
3549
|
+
'schema': {
|
|
3550
|
+
[key: string]: any;
|
|
3551
|
+
};
|
|
3552
|
+
}
|
|
3553
|
+
/**
|
|
3554
|
+
* Event Definition
|
|
3555
|
+
* @export
|
|
3556
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationEventsValue
|
|
3557
|
+
*/
|
|
3558
|
+
export interface GetPublicIntegrationByIdResponseIntegrationEventsValue {
|
|
3559
|
+
/**
|
|
3560
|
+
* Title of the event
|
|
3561
|
+
* @type {string}
|
|
3562
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationEventsValue
|
|
3563
|
+
*/
|
|
3564
|
+
'title'?: string;
|
|
3565
|
+
/**
|
|
3566
|
+
* Description of the event
|
|
3567
|
+
* @type {string}
|
|
3568
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationEventsValue
|
|
3569
|
+
*/
|
|
3570
|
+
'description'?: string;
|
|
3571
|
+
/**
|
|
3572
|
+
*
|
|
3573
|
+
* @type {{ [key: string]: any; }}
|
|
3574
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationEventsValue
|
|
3575
|
+
*/
|
|
3576
|
+
'schema': {
|
|
3577
|
+
[key: string]: any;
|
|
3578
|
+
};
|
|
3579
|
+
}
|
|
3580
|
+
/**
|
|
3581
|
+
* Global identifier configuration of the [Integration](#schema_integration)
|
|
3582
|
+
* @export
|
|
3583
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationIdentifier
|
|
3584
|
+
*/
|
|
3585
|
+
export interface GetPublicIntegrationByIdResponseIntegrationIdentifier {
|
|
3586
|
+
/**
|
|
3587
|
+
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn\'t have an identifier
|
|
3588
|
+
* @type {string}
|
|
3589
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationIdentifier
|
|
3590
|
+
*/
|
|
3591
|
+
'fallbackHandlerScript'?: string;
|
|
3592
|
+
/**
|
|
3593
|
+
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
3594
|
+
* @type {string}
|
|
3595
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationIdentifier
|
|
3596
|
+
*/
|
|
3597
|
+
'extractScript'?: string;
|
|
3598
|
+
}
|
|
3599
|
+
/**
|
|
3600
|
+
*
|
|
3601
|
+
* @export
|
|
3602
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationOwnerWorkspace
|
|
3603
|
+
*/
|
|
3604
|
+
export interface GetPublicIntegrationByIdResponseIntegrationOwnerWorkspace {
|
|
3605
|
+
/**
|
|
3606
|
+
*
|
|
3607
|
+
* @type {string}
|
|
3608
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationOwnerWorkspace
|
|
3609
|
+
*/
|
|
3610
|
+
'id': string;
|
|
3611
|
+
/**
|
|
3612
|
+
*
|
|
3613
|
+
* @type {string}
|
|
3614
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationOwnerWorkspace
|
|
3615
|
+
*/
|
|
3616
|
+
'handle': string | null;
|
|
3617
|
+
/**
|
|
3618
|
+
*
|
|
3619
|
+
* @type {string}
|
|
3620
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationOwnerWorkspace
|
|
3621
|
+
*/
|
|
3622
|
+
'name': string;
|
|
3623
|
+
}
|
|
3624
|
+
/**
|
|
3625
|
+
* State definition
|
|
3626
|
+
* @export
|
|
3627
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationStatesValue
|
|
3628
|
+
*/
|
|
3629
|
+
export interface GetPublicIntegrationByIdResponseIntegrationStatesValue {
|
|
3630
|
+
/**
|
|
3631
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
3632
|
+
* @type {string}
|
|
3633
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationStatesValue
|
|
3634
|
+
*/
|
|
3635
|
+
'type': GetPublicIntegrationByIdResponseIntegrationStatesValueTypeEnum;
|
|
3636
|
+
/**
|
|
3637
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
3638
|
+
* @type {{ [key: string]: any; }}
|
|
3639
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationStatesValue
|
|
3640
|
+
*/
|
|
3641
|
+
'schema': {
|
|
3642
|
+
[key: string]: any;
|
|
3643
|
+
};
|
|
3644
|
+
}
|
|
3645
|
+
export declare const GetPublicIntegrationByIdResponseIntegrationStatesValueTypeEnum: {
|
|
3646
|
+
readonly Conversation: "conversation";
|
|
3647
|
+
readonly User: "user";
|
|
3648
|
+
readonly Integration: "integration";
|
|
3649
|
+
};
|
|
3650
|
+
export type GetPublicIntegrationByIdResponseIntegrationStatesValueTypeEnum = typeof GetPublicIntegrationByIdResponseIntegrationStatesValueTypeEnum[keyof typeof GetPublicIntegrationByIdResponseIntegrationStatesValueTypeEnum];
|
|
3651
|
+
/**
|
|
3652
|
+
* User object configuration
|
|
3653
|
+
* @export
|
|
3654
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationUser
|
|
3655
|
+
*/
|
|
3656
|
+
export interface GetPublicIntegrationByIdResponseIntegrationUser {
|
|
3657
|
+
/**
|
|
3658
|
+
*
|
|
3659
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
3660
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationUser
|
|
3661
|
+
*/
|
|
3662
|
+
'tags': {
|
|
3663
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
3664
|
+
};
|
|
3665
|
+
/**
|
|
3666
|
+
*
|
|
3667
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUserCreation}
|
|
3668
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationUser
|
|
3669
|
+
*/
|
|
3670
|
+
'creation': GetPublicIntegrationByIdResponseIntegrationUserCreation;
|
|
3671
|
+
}
|
|
3672
|
+
/**
|
|
3673
|
+
* The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
|
|
3674
|
+
* @export
|
|
3675
|
+
* @interface GetPublicIntegrationByIdResponseIntegrationUserCreation
|
|
3676
|
+
*/
|
|
3677
|
+
export interface GetPublicIntegrationByIdResponseIntegrationUserCreation {
|
|
3678
|
+
/**
|
|
3679
|
+
* Enable user creation
|
|
3680
|
+
* @type {boolean}
|
|
3681
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationUserCreation
|
|
3682
|
+
*/
|
|
3683
|
+
'enabled': boolean;
|
|
3684
|
+
/**
|
|
3685
|
+
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
3686
|
+
* @type {Array<string>}
|
|
3687
|
+
* @memberof GetPublicIntegrationByIdResponseIntegrationUserCreation
|
|
3688
|
+
*/
|
|
3689
|
+
'requiredTags': Array<string>;
|
|
3690
|
+
}
|
|
3691
|
+
/**
|
|
3692
|
+
*
|
|
3693
|
+
* @export
|
|
3694
|
+
* @interface GetPublicIntegrationResponse
|
|
3695
|
+
*/
|
|
3696
|
+
export interface GetPublicIntegrationResponse {
|
|
3697
|
+
/**
|
|
3698
|
+
*
|
|
3699
|
+
* @type {GetPublicIntegrationByIdResponseIntegration}
|
|
3700
|
+
* @memberof GetPublicIntegrationResponse
|
|
3701
|
+
*/
|
|
3702
|
+
'integration': GetPublicIntegrationByIdResponseIntegration;
|
|
3703
|
+
}
|
|
3704
|
+
/**
|
|
3705
|
+
*
|
|
3706
|
+
* @export
|
|
3707
|
+
* @interface GetPublicWorkspaceResponse
|
|
3340
3708
|
*/
|
|
3341
3709
|
export interface GetPublicWorkspaceResponse {
|
|
3342
3710
|
/**
|
|
@@ -3839,10 +4207,10 @@ export interface Integration {
|
|
|
3839
4207
|
'updatedAt': string;
|
|
3840
4208
|
/**
|
|
3841
4209
|
*
|
|
3842
|
-
* @type {
|
|
4210
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationIdentifier}
|
|
3843
4211
|
* @memberof Integration
|
|
3844
4212
|
*/
|
|
3845
|
-
'identifier':
|
|
4213
|
+
'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
|
|
3846
4214
|
/**
|
|
3847
4215
|
* Type of the task
|
|
3848
4216
|
* @type {string}
|
|
@@ -3857,232 +4225,92 @@ export interface Integration {
|
|
|
3857
4225
|
'version': string;
|
|
3858
4226
|
/**
|
|
3859
4227
|
*
|
|
3860
|
-
* @type {
|
|
4228
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationConfiguration}
|
|
3861
4229
|
* @memberof Integration
|
|
3862
4230
|
*/
|
|
3863
|
-
'configuration':
|
|
4231
|
+
'configuration': GetPublicIntegrationByIdResponseIntegrationConfiguration;
|
|
3864
4232
|
/**
|
|
3865
4233
|
*
|
|
3866
|
-
* @type {{ [key: string]:
|
|
4234
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue; }}
|
|
3867
4235
|
* @memberof Integration
|
|
3868
4236
|
*/
|
|
3869
4237
|
'channels': {
|
|
3870
|
-
[key: string]:
|
|
4238
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue;
|
|
3871
4239
|
};
|
|
3872
4240
|
/**
|
|
3873
4241
|
*
|
|
3874
|
-
* @type {{ [key: string]:
|
|
4242
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue; }}
|
|
3875
4243
|
* @memberof Integration
|
|
3876
4244
|
*/
|
|
3877
4245
|
'states': {
|
|
3878
|
-
[key: string]:
|
|
4246
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue;
|
|
3879
4247
|
};
|
|
3880
4248
|
/**
|
|
3881
4249
|
*
|
|
3882
|
-
* @type {{ [key: string]:
|
|
4250
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
3883
4251
|
* @memberof Integration
|
|
3884
4252
|
*/
|
|
3885
4253
|
'events': {
|
|
3886
|
-
[key: string]:
|
|
4254
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
3887
4255
|
};
|
|
3888
4256
|
/**
|
|
3889
4257
|
*
|
|
3890
|
-
* @type {{ [key: string]:
|
|
3891
|
-
* @memberof Integration
|
|
3892
|
-
*/
|
|
3893
|
-
'actions': {
|
|
3894
|
-
[key: string]: CreateBotBodyActionsValue;
|
|
3895
|
-
};
|
|
3896
|
-
/**
|
|
3897
|
-
*
|
|
3898
|
-
* @type {IntegrationUser}
|
|
3899
|
-
* @memberof Integration
|
|
3900
|
-
*/
|
|
3901
|
-
'user': IntegrationUser;
|
|
3902
|
-
/**
|
|
3903
|
-
*
|
|
3904
|
-
* @type {{ [key: string]: CreateIntegrationBodyEntitiesValue; }}
|
|
3905
|
-
* @memberof Integration
|
|
3906
|
-
*/
|
|
3907
|
-
'entities': {
|
|
3908
|
-
[key: string]: CreateIntegrationBodyEntitiesValue;
|
|
3909
|
-
};
|
|
3910
|
-
/**
|
|
3911
|
-
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
3912
|
-
* @type {boolean}
|
|
3913
|
-
* @memberof Integration
|
|
3914
|
-
*/
|
|
3915
|
-
'dev': boolean;
|
|
3916
|
-
/**
|
|
3917
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
3918
|
-
* @type {string}
|
|
3919
|
-
* @memberof Integration
|
|
3920
|
-
*/
|
|
3921
|
-
'title': string;
|
|
3922
|
-
/**
|
|
3923
|
-
* Description of the integration. This is the description that will be displayed in the UI
|
|
3924
|
-
* @type {string}
|
|
3925
|
-
* @memberof Integration
|
|
3926
|
-
*/
|
|
3927
|
-
'description': string;
|
|
3928
|
-
/**
|
|
3929
|
-
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
3930
|
-
* @type {string}
|
|
3931
|
-
* @memberof Integration
|
|
3932
|
-
*/
|
|
3933
|
-
'iconUrl': string;
|
|
3934
|
-
/**
|
|
3935
|
-
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
3936
|
-
* @type {string}
|
|
3937
|
-
* @memberof Integration
|
|
3938
|
-
*/
|
|
3939
|
-
'readmeUrl': string;
|
|
3940
|
-
/**
|
|
3941
|
-
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
3942
|
-
* @type {Array<string>}
|
|
4258
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
3943
4259
|
* @memberof Integration
|
|
3944
4260
|
*/
|
|
3945
|
-
'
|
|
3946
|
-
|
|
3947
|
-
|
|
3948
|
-
* Channel definition
|
|
3949
|
-
* @export
|
|
3950
|
-
* @interface IntegrationChannelsValue
|
|
3951
|
-
*/
|
|
3952
|
-
export interface IntegrationChannelsValue {
|
|
3953
|
-
/**
|
|
3954
|
-
* Title of the channel
|
|
3955
|
-
* @type {string}
|
|
3956
|
-
* @memberof IntegrationChannelsValue
|
|
3957
|
-
*/
|
|
3958
|
-
'title'?: string;
|
|
3959
|
-
/**
|
|
3960
|
-
* Description of the channel
|
|
3961
|
-
* @type {string}
|
|
3962
|
-
* @memberof IntegrationChannelsValue
|
|
3963
|
-
*/
|
|
3964
|
-
'description'?: string;
|
|
3965
|
-
/**
|
|
3966
|
-
*
|
|
3967
|
-
* @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
|
|
3968
|
-
* @memberof IntegrationChannelsValue
|
|
3969
|
-
*/
|
|
3970
|
-
'messages': {
|
|
3971
|
-
[key: string]: CreateIntegrationBodyChannelsValueMessagesValue;
|
|
3972
|
-
};
|
|
3973
|
-
/**
|
|
3974
|
-
*
|
|
3975
|
-
* @type {IntegrationChannelsValueConversation}
|
|
3976
|
-
* @memberof IntegrationChannelsValue
|
|
3977
|
-
*/
|
|
3978
|
-
'conversation': IntegrationChannelsValueConversation;
|
|
3979
|
-
/**
|
|
3980
|
-
*
|
|
3981
|
-
* @type {BotMessage}
|
|
3982
|
-
* @memberof IntegrationChannelsValue
|
|
3983
|
-
*/
|
|
3984
|
-
'message': BotMessage;
|
|
3985
|
-
}
|
|
3986
|
-
/**
|
|
3987
|
-
* Conversation object configuration
|
|
3988
|
-
* @export
|
|
3989
|
-
* @interface IntegrationChannelsValueConversation
|
|
3990
|
-
*/
|
|
3991
|
-
export interface IntegrationChannelsValueConversation {
|
|
3992
|
-
/**
|
|
3993
|
-
*
|
|
3994
|
-
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
3995
|
-
* @memberof IntegrationChannelsValueConversation
|
|
3996
|
-
*/
|
|
3997
|
-
'tags': {
|
|
3998
|
-
[key: string]: CreateBotBodyUserTagsValue;
|
|
3999
|
-
};
|
|
4000
|
-
/**
|
|
4001
|
-
*
|
|
4002
|
-
* @type {CreateIntegrationBodyChannelsValueConversationCreation}
|
|
4003
|
-
* @memberof IntegrationChannelsValueConversation
|
|
4004
|
-
*/
|
|
4005
|
-
'creation': CreateIntegrationBodyChannelsValueConversationCreation;
|
|
4006
|
-
}
|
|
4007
|
-
/**
|
|
4008
|
-
* Configuration definition
|
|
4009
|
-
* @export
|
|
4010
|
-
* @interface IntegrationConfiguration
|
|
4011
|
-
*/
|
|
4012
|
-
export interface IntegrationConfiguration {
|
|
4013
|
-
/**
|
|
4014
|
-
*
|
|
4015
|
-
* @type {IntegrationConfigurationIdentifier}
|
|
4016
|
-
* @memberof IntegrationConfiguration
|
|
4017
|
-
*/
|
|
4018
|
-
'identifier': IntegrationConfigurationIdentifier;
|
|
4019
|
-
/**
|
|
4020
|
-
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
4021
|
-
* @type {{ [key: string]: any; }}
|
|
4022
|
-
* @memberof IntegrationConfiguration
|
|
4023
|
-
*/
|
|
4024
|
-
'schema'?: {
|
|
4025
|
-
[key: string]: any;
|
|
4026
|
-
};
|
|
4027
|
-
}
|
|
4028
|
-
/**
|
|
4029
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
4030
|
-
* @export
|
|
4031
|
-
* @interface IntegrationConfigurationIdentifier
|
|
4032
|
-
*/
|
|
4033
|
-
export interface IntegrationConfigurationIdentifier {
|
|
4261
|
+
'actions': {
|
|
4262
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
4263
|
+
};
|
|
4034
4264
|
/**
|
|
4035
|
-
*
|
|
4036
|
-
* @type {
|
|
4037
|
-
* @memberof
|
|
4265
|
+
*
|
|
4266
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUser}
|
|
4267
|
+
* @memberof Integration
|
|
4038
4268
|
*/
|
|
4039
|
-
'
|
|
4269
|
+
'user': GetPublicIntegrationByIdResponseIntegrationUser;
|
|
4040
4270
|
/**
|
|
4041
4271
|
*
|
|
4272
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue; }}
|
|
4273
|
+
* @memberof Integration
|
|
4274
|
+
*/
|
|
4275
|
+
'entities': {
|
|
4276
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue;
|
|
4277
|
+
};
|
|
4278
|
+
/**
|
|
4279
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
4042
4280
|
* @type {boolean}
|
|
4043
|
-
* @memberof
|
|
4281
|
+
* @memberof Integration
|
|
4044
4282
|
*/
|
|
4045
|
-
'
|
|
4046
|
-
}
|
|
4047
|
-
/**
|
|
4048
|
-
* Global identifier configuration of the [Integration](#schema_integration)
|
|
4049
|
-
* @export
|
|
4050
|
-
* @interface IntegrationIdentifier
|
|
4051
|
-
*/
|
|
4052
|
-
export interface IntegrationIdentifier {
|
|
4283
|
+
'dev': boolean;
|
|
4053
4284
|
/**
|
|
4054
|
-
*
|
|
4285
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
4055
4286
|
* @type {string}
|
|
4056
|
-
* @memberof
|
|
4287
|
+
* @memberof Integration
|
|
4057
4288
|
*/
|
|
4058
|
-
'
|
|
4289
|
+
'title': string;
|
|
4059
4290
|
/**
|
|
4060
|
-
*
|
|
4291
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
4061
4292
|
* @type {string}
|
|
4062
|
-
* @memberof
|
|
4293
|
+
* @memberof Integration
|
|
4063
4294
|
*/
|
|
4064
|
-
'
|
|
4065
|
-
}
|
|
4066
|
-
/**
|
|
4067
|
-
* User object configuration
|
|
4068
|
-
* @export
|
|
4069
|
-
* @interface IntegrationUser
|
|
4070
|
-
*/
|
|
4071
|
-
export interface IntegrationUser {
|
|
4295
|
+
'description': string;
|
|
4072
4296
|
/**
|
|
4073
|
-
*
|
|
4074
|
-
* @type {
|
|
4075
|
-
* @memberof
|
|
4297
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
4298
|
+
* @type {string}
|
|
4299
|
+
* @memberof Integration
|
|
4076
4300
|
*/
|
|
4077
|
-
'
|
|
4078
|
-
[key: string]: CreateBotBodyUserTagsValue;
|
|
4079
|
-
};
|
|
4301
|
+
'iconUrl': string;
|
|
4080
4302
|
/**
|
|
4081
|
-
*
|
|
4082
|
-
* @type {
|
|
4083
|
-
* @memberof
|
|
4303
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
4304
|
+
* @type {string}
|
|
4305
|
+
* @memberof Integration
|
|
4306
|
+
*/
|
|
4307
|
+
'readmeUrl': string;
|
|
4308
|
+
/**
|
|
4309
|
+
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
4310
|
+
* @type {Array<string>}
|
|
4311
|
+
* @memberof Integration
|
|
4084
4312
|
*/
|
|
4085
|
-
'
|
|
4313
|
+
'secrets': Array<string>;
|
|
4086
4314
|
}
|
|
4087
4315
|
/**
|
|
4088
4316
|
*
|
|
@@ -4532,10 +4760,10 @@ export interface ListEventsResponse {
|
|
|
4532
4760
|
export interface ListFilesResponse {
|
|
4533
4761
|
/**
|
|
4534
4762
|
*
|
|
4535
|
-
* @type {Array<
|
|
4763
|
+
* @type {Array<ListFilesResponseFilesInner>}
|
|
4536
4764
|
* @memberof ListFilesResponse
|
|
4537
4765
|
*/
|
|
4538
|
-
'files': Array<
|
|
4766
|
+
'files': Array<ListFilesResponseFilesInner>;
|
|
4539
4767
|
/**
|
|
4540
4768
|
*
|
|
4541
4769
|
* @type {ListConversationsResponseMeta}
|
|
@@ -4543,6 +4771,74 @@ export interface ListFilesResponse {
|
|
|
4543
4771
|
*/
|
|
4544
4772
|
'meta': ListConversationsResponseMeta;
|
|
4545
4773
|
}
|
|
4774
|
+
/**
|
|
4775
|
+
*
|
|
4776
|
+
* @export
|
|
4777
|
+
* @interface ListFilesResponseFilesInner
|
|
4778
|
+
*/
|
|
4779
|
+
export interface ListFilesResponseFilesInner {
|
|
4780
|
+
/**
|
|
4781
|
+
*
|
|
4782
|
+
* @type {string}
|
|
4783
|
+
* @memberof ListFilesResponseFilesInner
|
|
4784
|
+
*/
|
|
4785
|
+
'id': string;
|
|
4786
|
+
/**
|
|
4787
|
+
*
|
|
4788
|
+
* @type {string}
|
|
4789
|
+
* @memberof ListFilesResponseFilesInner
|
|
4790
|
+
*/
|
|
4791
|
+
'botId': string;
|
|
4792
|
+
/**
|
|
4793
|
+
*
|
|
4794
|
+
* @type {string}
|
|
4795
|
+
* @memberof ListFilesResponseFilesInner
|
|
4796
|
+
*/
|
|
4797
|
+
'filename': string;
|
|
4798
|
+
/**
|
|
4799
|
+
*
|
|
4800
|
+
* @type {number}
|
|
4801
|
+
* @memberof ListFilesResponseFilesInner
|
|
4802
|
+
*/
|
|
4803
|
+
'bytes': number | null;
|
|
4804
|
+
/**
|
|
4805
|
+
*
|
|
4806
|
+
* @type {string}
|
|
4807
|
+
* @memberof ListFilesResponseFilesInner
|
|
4808
|
+
*/
|
|
4809
|
+
'createdAt': string;
|
|
4810
|
+
/**
|
|
4811
|
+
*
|
|
4812
|
+
* @type {string}
|
|
4813
|
+
* @memberof ListFilesResponseFilesInner
|
|
4814
|
+
*/
|
|
4815
|
+
'updatedAt': string;
|
|
4816
|
+
/**
|
|
4817
|
+
*
|
|
4818
|
+
* @type {Array<string>}
|
|
4819
|
+
* @memberof ListFilesResponseFilesInner
|
|
4820
|
+
*/
|
|
4821
|
+
'accessPolicies': Array<string>;
|
|
4822
|
+
/**
|
|
4823
|
+
*
|
|
4824
|
+
* @type {string}
|
|
4825
|
+
* @memberof ListFilesResponseFilesInner
|
|
4826
|
+
*/
|
|
4827
|
+
'indexingStatus'?: ListFilesResponseFilesInnerIndexingStatusEnum;
|
|
4828
|
+
/**
|
|
4829
|
+
*
|
|
4830
|
+
* @type {string}
|
|
4831
|
+
* @memberof ListFilesResponseFilesInner
|
|
4832
|
+
*/
|
|
4833
|
+
'indexingFailureReason'?: string;
|
|
4834
|
+
}
|
|
4835
|
+
export declare const ListFilesResponseFilesInnerIndexingStatusEnum: {
|
|
4836
|
+
readonly Pending: "PENDING";
|
|
4837
|
+
readonly InProgress: "IN_PROGRESS";
|
|
4838
|
+
readonly Complete: "COMPLETE";
|
|
4839
|
+
readonly Failed: "FAILED";
|
|
4840
|
+
};
|
|
4841
|
+
export type ListFilesResponseFilesInnerIndexingStatusEnum = typeof ListFilesResponseFilesInnerIndexingStatusEnum[keyof typeof ListFilesResponseFilesInnerIndexingStatusEnum];
|
|
4546
4842
|
/**
|
|
4547
4843
|
*
|
|
4548
4844
|
* @export
|
|
@@ -4551,10 +4847,10 @@ export interface ListFilesResponse {
|
|
|
4551
4847
|
export interface ListIntegrationsResponse {
|
|
4552
4848
|
/**
|
|
4553
4849
|
*
|
|
4554
|
-
* @type {Array<
|
|
4850
|
+
* @type {Array<ListIntegrationsResponseIntegrationsInner>}
|
|
4555
4851
|
* @memberof ListIntegrationsResponse
|
|
4556
4852
|
*/
|
|
4557
|
-
'integrations': Array<
|
|
4853
|
+
'integrations': Array<ListIntegrationsResponseIntegrationsInner>;
|
|
4558
4854
|
/**
|
|
4559
4855
|
*
|
|
4560
4856
|
* @type {ListConversationsResponseMeta}
|
|
@@ -4562,6 +4858,61 @@ export interface ListIntegrationsResponse {
|
|
|
4562
4858
|
*/
|
|
4563
4859
|
'meta': ListConversationsResponseMeta;
|
|
4564
4860
|
}
|
|
4861
|
+
/**
|
|
4862
|
+
*
|
|
4863
|
+
* @export
|
|
4864
|
+
* @interface ListIntegrationsResponseIntegrationsInner
|
|
4865
|
+
*/
|
|
4866
|
+
export interface ListIntegrationsResponseIntegrationsInner {
|
|
4867
|
+
/**
|
|
4868
|
+
* User id
|
|
4869
|
+
* @type {string}
|
|
4870
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4871
|
+
*/
|
|
4872
|
+
'id': string;
|
|
4873
|
+
/**
|
|
4874
|
+
* Unique identifier of the integration that was installed on the bot
|
|
4875
|
+
* @type {string}
|
|
4876
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4877
|
+
*/
|
|
4878
|
+
'name': string;
|
|
4879
|
+
/**
|
|
4880
|
+
* Unique identifier of the integration that was installed on the bot
|
|
4881
|
+
* @type {string}
|
|
4882
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4883
|
+
*/
|
|
4884
|
+
'version': string;
|
|
4885
|
+
/**
|
|
4886
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
4887
|
+
* @type {string}
|
|
4888
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4889
|
+
*/
|
|
4890
|
+
'createdAt': string;
|
|
4891
|
+
/**
|
|
4892
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
4893
|
+
* @type {string}
|
|
4894
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4895
|
+
*/
|
|
4896
|
+
'updatedAt': string;
|
|
4897
|
+
/**
|
|
4898
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
4899
|
+
* @type {string}
|
|
4900
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4901
|
+
*/
|
|
4902
|
+
'title': string;
|
|
4903
|
+
/**
|
|
4904
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
4905
|
+
* @type {string}
|
|
4906
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4907
|
+
*/
|
|
4908
|
+
'description': string;
|
|
4909
|
+
/**
|
|
4910
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
4911
|
+
* @type {string}
|
|
4912
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4913
|
+
*/
|
|
4914
|
+
'iconUrl': string;
|
|
4915
|
+
}
|
|
4565
4916
|
/**
|
|
4566
4917
|
*
|
|
4567
4918
|
* @export
|
|
@@ -4711,6 +5062,37 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
|
4711
5062
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
4712
5063
|
*/
|
|
4713
5064
|
'iconUrl': string;
|
|
5065
|
+
/**
|
|
5066
|
+
*
|
|
5067
|
+
* @type {ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace}
|
|
5068
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
5069
|
+
*/
|
|
5070
|
+
'ownerWorkspace': ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace;
|
|
5071
|
+
}
|
|
5072
|
+
/**
|
|
5073
|
+
*
|
|
5074
|
+
* @export
|
|
5075
|
+
* @interface ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace
|
|
5076
|
+
*/
|
|
5077
|
+
export interface ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace {
|
|
5078
|
+
/**
|
|
5079
|
+
*
|
|
5080
|
+
* @type {string}
|
|
5081
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace
|
|
5082
|
+
*/
|
|
5083
|
+
'id': string;
|
|
5084
|
+
/**
|
|
5085
|
+
*
|
|
5086
|
+
* @type {string}
|
|
5087
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace
|
|
5088
|
+
*/
|
|
5089
|
+
'handle': string | null;
|
|
5090
|
+
/**
|
|
5091
|
+
*
|
|
5092
|
+
* @type {string}
|
|
5093
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace
|
|
5094
|
+
*/
|
|
5095
|
+
'name': string;
|
|
4714
5096
|
}
|
|
4715
5097
|
/**
|
|
4716
5098
|
*
|
|
@@ -5096,53 +5478,75 @@ export type MessageDirectionEnum = typeof MessageDirectionEnum[keyof typeof Mess
|
|
|
5096
5478
|
*/
|
|
5097
5479
|
export interface ModelFile {
|
|
5098
5480
|
/**
|
|
5099
|
-
*
|
|
5481
|
+
*
|
|
5100
5482
|
* @type {string}
|
|
5101
5483
|
* @memberof ModelFile
|
|
5102
5484
|
*/
|
|
5103
|
-
'
|
|
5485
|
+
'id': string;
|
|
5104
5486
|
/**
|
|
5105
|
-
*
|
|
5487
|
+
*
|
|
5106
5488
|
* @type {string}
|
|
5107
5489
|
* @memberof ModelFile
|
|
5108
5490
|
*/
|
|
5109
|
-
'
|
|
5491
|
+
'botId': string;
|
|
5110
5492
|
/**
|
|
5111
|
-
*
|
|
5493
|
+
*
|
|
5112
5494
|
* @type {string}
|
|
5113
5495
|
* @memberof ModelFile
|
|
5114
5496
|
*/
|
|
5115
|
-
'
|
|
5497
|
+
'filename': string;
|
|
5116
5498
|
/**
|
|
5117
|
-
*
|
|
5118
|
-
* @type {
|
|
5499
|
+
*
|
|
5500
|
+
* @type {number}
|
|
5119
5501
|
* @memberof ModelFile
|
|
5120
5502
|
*/
|
|
5121
|
-
'
|
|
5503
|
+
'bytes': number | null;
|
|
5504
|
+
/**
|
|
5505
|
+
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
5506
|
+
* @type {{ [key: string]: string; }}
|
|
5507
|
+
* @memberof ModelFile
|
|
5508
|
+
*/
|
|
5509
|
+
'tags': {
|
|
5510
|
+
[key: string]: string;
|
|
5511
|
+
};
|
|
5122
5512
|
/**
|
|
5123
|
-
*
|
|
5513
|
+
*
|
|
5124
5514
|
* @type {string}
|
|
5125
5515
|
* @memberof ModelFile
|
|
5126
5516
|
*/
|
|
5127
5517
|
'createdAt': string;
|
|
5128
5518
|
/**
|
|
5129
|
-
*
|
|
5130
|
-
* @type {
|
|
5519
|
+
*
|
|
5520
|
+
* @type {string}
|
|
5131
5521
|
* @memberof ModelFile
|
|
5132
5522
|
*/
|
|
5133
|
-
'
|
|
5523
|
+
'updatedAt': string;
|
|
5524
|
+
/**
|
|
5525
|
+
*
|
|
5526
|
+
* @type {Array<string>}
|
|
5527
|
+
* @memberof ModelFile
|
|
5528
|
+
*/
|
|
5529
|
+
'accessPolicies': Array<string>;
|
|
5530
|
+
/**
|
|
5531
|
+
*
|
|
5532
|
+
* @type {string}
|
|
5533
|
+
* @memberof ModelFile
|
|
5534
|
+
*/
|
|
5535
|
+
'indexingStatus'?: ModelFileIndexingStatusEnum;
|
|
5134
5536
|
/**
|
|
5135
|
-
*
|
|
5537
|
+
*
|
|
5136
5538
|
* @type {string}
|
|
5137
5539
|
* @memberof ModelFile
|
|
5138
5540
|
*/
|
|
5139
|
-
'
|
|
5541
|
+
'indexingFailureReason'?: string;
|
|
5140
5542
|
}
|
|
5141
|
-
export declare const
|
|
5142
|
-
readonly
|
|
5143
|
-
readonly
|
|
5543
|
+
export declare const ModelFileIndexingStatusEnum: {
|
|
5544
|
+
readonly Pending: "PENDING";
|
|
5545
|
+
readonly InProgress: "IN_PROGRESS";
|
|
5546
|
+
readonly Complete: "COMPLETE";
|
|
5547
|
+
readonly Failed: "FAILED";
|
|
5144
5548
|
};
|
|
5145
|
-
export type
|
|
5549
|
+
export type ModelFileIndexingStatusEnum = typeof ModelFileIndexingStatusEnum[keyof typeof ModelFileIndexingStatusEnum];
|
|
5146
5550
|
/**
|
|
5147
5551
|
*
|
|
5148
5552
|
* @export
|
|
@@ -5277,6 +5681,52 @@ export interface RunVrlResponse {
|
|
|
5277
5681
|
*/
|
|
5278
5682
|
'result'?: any | null;
|
|
5279
5683
|
}
|
|
5684
|
+
/**
|
|
5685
|
+
*
|
|
5686
|
+
* @export
|
|
5687
|
+
* @interface SearchFilesResponse
|
|
5688
|
+
*/
|
|
5689
|
+
export interface SearchFilesResponse {
|
|
5690
|
+
/**
|
|
5691
|
+
*
|
|
5692
|
+
* @type {Array<SearchFilesResponsePassagesInner>}
|
|
5693
|
+
* @memberof SearchFilesResponse
|
|
5694
|
+
*/
|
|
5695
|
+
'passages': Array<SearchFilesResponsePassagesInner>;
|
|
5696
|
+
}
|
|
5697
|
+
/**
|
|
5698
|
+
*
|
|
5699
|
+
* @export
|
|
5700
|
+
* @interface SearchFilesResponsePassagesInner
|
|
5701
|
+
*/
|
|
5702
|
+
export interface SearchFilesResponsePassagesInner {
|
|
5703
|
+
/**
|
|
5704
|
+
*
|
|
5705
|
+
* @type {string}
|
|
5706
|
+
* @memberof SearchFilesResponsePassagesInner
|
|
5707
|
+
*/
|
|
5708
|
+
'fileId': string;
|
|
5709
|
+
/**
|
|
5710
|
+
*
|
|
5711
|
+
* @type {number}
|
|
5712
|
+
* @memberof SearchFilesResponsePassagesInner
|
|
5713
|
+
*/
|
|
5714
|
+
'score': number;
|
|
5715
|
+
/**
|
|
5716
|
+
*
|
|
5717
|
+
* @type {string}
|
|
5718
|
+
* @memberof SearchFilesResponsePassagesInner
|
|
5719
|
+
*/
|
|
5720
|
+
'content': string;
|
|
5721
|
+
/**
|
|
5722
|
+
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
5723
|
+
* @type {{ [key: string]: string; }}
|
|
5724
|
+
* @memberof SearchFilesResponsePassagesInner
|
|
5725
|
+
*/
|
|
5726
|
+
'tags': {
|
|
5727
|
+
[key: string]: string;
|
|
5728
|
+
};
|
|
5729
|
+
}
|
|
5280
5730
|
/**
|
|
5281
5731
|
*
|
|
5282
5732
|
* @export
|
|
@@ -5288,7 +5738,7 @@ export interface SetAccountPreferenceBody {
|
|
|
5288
5738
|
* @type {any}
|
|
5289
5739
|
* @memberof SetAccountPreferenceBody
|
|
5290
5740
|
*/
|
|
5291
|
-
'value'?: any
|
|
5741
|
+
'value'?: any;
|
|
5292
5742
|
}
|
|
5293
5743
|
/**
|
|
5294
5744
|
*
|
|
@@ -5929,16 +6379,16 @@ export interface UpdateBotBodyActionsValue {
|
|
|
5929
6379
|
'description'?: string;
|
|
5930
6380
|
/**
|
|
5931
6381
|
*
|
|
5932
|
-
* @type {
|
|
6382
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationActionsValueInput}
|
|
5933
6383
|
* @memberof UpdateBotBodyActionsValue
|
|
5934
6384
|
*/
|
|
5935
|
-
'input':
|
|
6385
|
+
'input': GetPublicIntegrationByIdResponseIntegrationActionsValueInput;
|
|
5936
6386
|
/**
|
|
5937
6387
|
*
|
|
5938
|
-
* @type {
|
|
6388
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationActionsValueInput}
|
|
5939
6389
|
* @memberof UpdateBotBodyActionsValue
|
|
5940
6390
|
*/
|
|
5941
|
-
'output':
|
|
6391
|
+
'output': GetPublicIntegrationByIdResponseIntegrationActionsValueInput;
|
|
5942
6392
|
}
|
|
5943
6393
|
/**
|
|
5944
6394
|
* Event Definition
|
|
@@ -6147,6 +6597,36 @@ export interface UpdateConversationResponse {
|
|
|
6147
6597
|
*/
|
|
6148
6598
|
'conversation': Conversation;
|
|
6149
6599
|
}
|
|
6600
|
+
/**
|
|
6601
|
+
*
|
|
6602
|
+
* @export
|
|
6603
|
+
* @interface UpdateFileMetadataBody
|
|
6604
|
+
*/
|
|
6605
|
+
export interface UpdateFileMetadataBody {
|
|
6606
|
+
/**
|
|
6607
|
+
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
6608
|
+
* @type {{ [key: string]: string; }}
|
|
6609
|
+
* @memberof UpdateFileMetadataBody
|
|
6610
|
+
*/
|
|
6611
|
+
'tags': {
|
|
6612
|
+
[key: string]: string;
|
|
6613
|
+
};
|
|
6614
|
+
}
|
|
6615
|
+
/**
|
|
6616
|
+
*
|
|
6617
|
+
* @export
|
|
6618
|
+
* @interface UpdateFileMetadataResponse
|
|
6619
|
+
*/
|
|
6620
|
+
export interface UpdateFileMetadataResponse {
|
|
6621
|
+
/**
|
|
6622
|
+
* The tags to update as an object of key/value pairs. A tag key can be set to a null value to delete it.
|
|
6623
|
+
* @type {{ [key: string]: string; }}
|
|
6624
|
+
* @memberof UpdateFileMetadataResponse
|
|
6625
|
+
*/
|
|
6626
|
+
'tags': {
|
|
6627
|
+
[key: string]: string;
|
|
6628
|
+
};
|
|
6629
|
+
}
|
|
6150
6630
|
/**
|
|
6151
6631
|
*
|
|
6152
6632
|
* @export
|
|
@@ -6303,10 +6783,10 @@ export interface UpdateIntegrationBodyChannelsValue {
|
|
|
6303
6783
|
export interface UpdateIntegrationBodyChannelsValueConversation {
|
|
6304
6784
|
/**
|
|
6305
6785
|
*
|
|
6306
|
-
* @type {
|
|
6786
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation}
|
|
6307
6787
|
* @memberof UpdateIntegrationBodyChannelsValueConversation
|
|
6308
6788
|
*/
|
|
6309
|
-
'creation'?:
|
|
6789
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation;
|
|
6310
6790
|
/**
|
|
6311
6791
|
*
|
|
6312
6792
|
* @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
|
|
@@ -6452,10 +6932,10 @@ export type UpdateIntegrationBodyStatesValueTypeEnum = typeof UpdateIntegrationB
|
|
|
6452
6932
|
export interface UpdateIntegrationBodyUser {
|
|
6453
6933
|
/**
|
|
6454
6934
|
*
|
|
6455
|
-
* @type {
|
|
6935
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUserCreation}
|
|
6456
6936
|
* @memberof UpdateIntegrationBodyUser
|
|
6457
6937
|
*/
|
|
6458
|
-
'creation'?:
|
|
6938
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationUserCreation;
|
|
6459
6939
|
/**
|
|
6460
6940
|
*
|
|
6461
6941
|
* @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
|
|
@@ -7529,12 +8009,22 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7529
8009
|
*/
|
|
7530
8010
|
createEvent: (createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7531
8011
|
/**
|
|
7532
|
-
*
|
|
7533
|
-
* @param {
|
|
8012
|
+
* Creates a file.
|
|
8013
|
+
* @param {string} xFilename File name
|
|
8014
|
+
* @param {string} xBotId Bot id
|
|
8015
|
+
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
8016
|
+
* @param {string} [xAccessPolicies] File access policies
|
|
8017
|
+
* @param {string} [xIndex] Set to a value of \"true\" to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
|
|
8018
|
+
* @param {string} [contentType] File content type
|
|
8019
|
+
* @param {string} [contentLength] File content length
|
|
8020
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8021
|
+
* @param {string} [xUserId] User id
|
|
8022
|
+
* @param {string} [xUserRole] User role
|
|
8023
|
+
* @param {CreateFileBody} [createFileBody] The file to upload.
|
|
7534
8024
|
* @param {*} [options] Override http request option.
|
|
7535
8025
|
* @throws {RequiredError}
|
|
7536
8026
|
*/
|
|
7537
|
-
createFile: (createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8027
|
+
createFile: (xFilename: string, xBotId: string, xTags?: string, xAccessPolicies?: string, xIndex?: string, contentType?: string, contentLength?: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7538
8028
|
/**
|
|
7539
8029
|
* Create integration
|
|
7540
8030
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -7622,12 +8112,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7622
8112
|
*/
|
|
7623
8113
|
deleteConversation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7624
8114
|
/**
|
|
7625
|
-
*
|
|
8115
|
+
* Deletes a file.
|
|
7626
8116
|
* @param {string} id File ID
|
|
8117
|
+
* @param {string} xBotId Bot id
|
|
8118
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8119
|
+
* @param {string} [xUserId] User id
|
|
8120
|
+
* @param {string} [xUserRole] User role
|
|
7627
8121
|
* @param {*} [options] Override http request option.
|
|
7628
8122
|
* @throws {RequiredError}
|
|
7629
8123
|
*/
|
|
7630
|
-
deleteFile: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8124
|
+
deleteFile: (id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7631
8125
|
/**
|
|
7632
8126
|
* Delete integration
|
|
7633
8127
|
* @param {string} id Integration ID
|
|
@@ -7692,13 +8186,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7692
8186
|
* @throws {RequiredError}
|
|
7693
8187
|
*/
|
|
7694
8188
|
deleteWorkspaceMember: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7695
|
-
/**
|
|
7696
|
-
* Download File
|
|
7697
|
-
* @param {string} id File ID
|
|
7698
|
-
* @param {*} [options] Override http request option.
|
|
7699
|
-
* @throws {RequiredError}
|
|
7700
|
-
*/
|
|
7701
|
-
downloadFile: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7702
8189
|
/**
|
|
7703
8190
|
* Enables the search and filtering of rows within a table based on specific criteria. This operation supports complex queries for advanced data manipulation and retrieval.
|
|
7704
8191
|
* @param {string} table The table\'s name or unique identifier for targeting specific table operations.
|
|
@@ -7783,12 +8270,27 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7783
8270
|
*/
|
|
7784
8271
|
getEvent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7785
8272
|
/**
|
|
7786
|
-
*
|
|
8273
|
+
* Returns a presigned URL to download the file content.
|
|
8274
|
+
* @param {string} id File ID
|
|
8275
|
+
* @param {string} xBotId Bot id
|
|
8276
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8277
|
+
* @param {string} [xUserId] User id
|
|
8278
|
+
* @param {string} [xUserRole] User role
|
|
8279
|
+
* @param {*} [options] Override http request option.
|
|
8280
|
+
* @throws {RequiredError}
|
|
8281
|
+
*/
|
|
8282
|
+
getFileContent: (id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8283
|
+
/**
|
|
8284
|
+
* Get file metadata
|
|
7787
8285
|
* @param {string} id File ID
|
|
8286
|
+
* @param {string} xBotId Bot id
|
|
8287
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8288
|
+
* @param {string} [xUserId] User id
|
|
8289
|
+
* @param {string} [xUserRole] User role
|
|
7788
8290
|
* @param {*} [options] Override http request option.
|
|
7789
8291
|
* @throws {RequiredError}
|
|
7790
8292
|
*/
|
|
7791
|
-
|
|
8293
|
+
getFileMetadata: (id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7792
8294
|
/**
|
|
7793
8295
|
* Get integration
|
|
7794
8296
|
* @param {string} id Integration ID
|
|
@@ -8022,13 +8524,18 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8022
8524
|
*/
|
|
8023
8525
|
listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8024
8526
|
/**
|
|
8025
|
-
* List
|
|
8527
|
+
* List files for bot
|
|
8528
|
+
* @param {string} xBotId Bot id
|
|
8026
8529
|
* @param {string} botId Bot ID
|
|
8027
8530
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
8531
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8532
|
+
* @param {string} [xUserId] User id
|
|
8533
|
+
* @param {string} [xUserRole] User role
|
|
8534
|
+
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
8028
8535
|
* @param {*} [options] Override http request option.
|
|
8029
8536
|
* @throws {RequiredError}
|
|
8030
8537
|
*/
|
|
8031
|
-
listFiles: (botId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8538
|
+
listFiles: (xBotId: string, botId: string, nextToken?: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, tags?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8032
8539
|
/**
|
|
8033
8540
|
* List integrations
|
|
8034
8541
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -8187,6 +8694,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8187
8694
|
* @throws {RequiredError}
|
|
8188
8695
|
*/
|
|
8189
8696
|
runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8697
|
+
/**
|
|
8698
|
+
* Search files
|
|
8699
|
+
* @param {string} xBotId Bot id
|
|
8700
|
+
* @param {string} botId Bot ID
|
|
8701
|
+
* @param {string} query Query expressed in natural language to retrieve matching text passages within all files using semantical search.
|
|
8702
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8703
|
+
* @param {string} [xUserId] User id
|
|
8704
|
+
* @param {string} [xUserRole] User role
|
|
8705
|
+
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
8706
|
+
* @param {string} [limit] The maximum number of passages to return.
|
|
8707
|
+
* @param {*} [options] Override http request option.
|
|
8708
|
+
* @throws {RequiredError}
|
|
8709
|
+
*/
|
|
8710
|
+
searchFiles: (xBotId: string, botId: string, query: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, tags?: string, limit?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8190
8711
|
/**
|
|
8191
8712
|
* Set a preference for the account
|
|
8192
8713
|
* @param {string} key Preference key
|
|
@@ -8244,6 +8765,18 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8244
8765
|
* @throws {RequiredError}
|
|
8245
8766
|
*/
|
|
8246
8767
|
updateConversation: (id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8768
|
+
/**
|
|
8769
|
+
* Update file metadata
|
|
8770
|
+
* @param {string} id File ID
|
|
8771
|
+
* @param {string} xBotId Bot id
|
|
8772
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8773
|
+
* @param {string} [xUserId] User id
|
|
8774
|
+
* @param {string} [xUserRole] User role
|
|
8775
|
+
* @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
|
|
8776
|
+
* @param {*} [options] Override http request option.
|
|
8777
|
+
* @throws {RequiredError}
|
|
8778
|
+
*/
|
|
8779
|
+
updateFileMetadata: (id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8247
8780
|
/**
|
|
8248
8781
|
* Update integration
|
|
8249
8782
|
* @param {string} id Integration ID
|
|
@@ -8405,12 +8938,22 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8405
8938
|
*/
|
|
8406
8939
|
createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
|
|
8407
8940
|
/**
|
|
8408
|
-
*
|
|
8409
|
-
* @param {
|
|
8941
|
+
* Creates a file.
|
|
8942
|
+
* @param {string} xFilename File name
|
|
8943
|
+
* @param {string} xBotId Bot id
|
|
8944
|
+
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
8945
|
+
* @param {string} [xAccessPolicies] File access policies
|
|
8946
|
+
* @param {string} [xIndex] Set to a value of \"true\" to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
|
|
8947
|
+
* @param {string} [contentType] File content type
|
|
8948
|
+
* @param {string} [contentLength] File content length
|
|
8949
|
+
* @param {string} [xIntegrationId] Integration id
|
|
8950
|
+
* @param {string} [xUserId] User id
|
|
8951
|
+
* @param {string} [xUserRole] User role
|
|
8952
|
+
* @param {CreateFileBody} [createFileBody] The file to upload.
|
|
8410
8953
|
* @param {*} [options] Override http request option.
|
|
8411
8954
|
* @throws {RequiredError}
|
|
8412
8955
|
*/
|
|
8413
|
-
createFile(createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
|
|
8956
|
+
createFile(xFilename: string, xBotId: string, xTags?: string, xAccessPolicies?: string, xIndex?: string, contentType?: string, contentLength?: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
|
|
8414
8957
|
/**
|
|
8415
8958
|
* Create integration
|
|
8416
8959
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -8498,12 +9041,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8498
9041
|
*/
|
|
8499
9042
|
deleteConversation(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
8500
9043
|
/**
|
|
8501
|
-
*
|
|
9044
|
+
* Deletes a file.
|
|
8502
9045
|
* @param {string} id File ID
|
|
9046
|
+
* @param {string} xBotId Bot id
|
|
9047
|
+
* @param {string} [xIntegrationId] Integration id
|
|
9048
|
+
* @param {string} [xUserId] User id
|
|
9049
|
+
* @param {string} [xUserRole] User role
|
|
8503
9050
|
* @param {*} [options] Override http request option.
|
|
8504
9051
|
* @throws {RequiredError}
|
|
8505
9052
|
*/
|
|
8506
|
-
deleteFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
9053
|
+
deleteFile(id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
8507
9054
|
/**
|
|
8508
9055
|
* Delete integration
|
|
8509
9056
|
* @param {string} id Integration ID
|
|
@@ -8568,13 +9115,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8568
9115
|
* @throws {RequiredError}
|
|
8569
9116
|
*/
|
|
8570
9117
|
deleteWorkspaceMember(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
8571
|
-
/**
|
|
8572
|
-
* Download File
|
|
8573
|
-
* @param {string} id File ID
|
|
8574
|
-
* @param {*} [options] Override http request option.
|
|
8575
|
-
* @throws {RequiredError}
|
|
8576
|
-
*/
|
|
8577
|
-
downloadFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
8578
9118
|
/**
|
|
8579
9119
|
* Enables the search and filtering of rows within a table based on specific criteria. This operation supports complex queries for advanced data manipulation and retrieval.
|
|
8580
9120
|
* @param {string} table The table\'s name or unique identifier for targeting specific table operations.
|
|
@@ -8661,12 +9201,27 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8661
9201
|
*/
|
|
8662
9202
|
getEvent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
|
|
8663
9203
|
/**
|
|
8664
|
-
*
|
|
9204
|
+
* Returns a presigned URL to download the file content.
|
|
9205
|
+
* @param {string} id File ID
|
|
9206
|
+
* @param {string} xBotId Bot id
|
|
9207
|
+
* @param {string} [xIntegrationId] Integration id
|
|
9208
|
+
* @param {string} [xUserId] User id
|
|
9209
|
+
* @param {string} [xUserRole] User role
|
|
9210
|
+
* @param {*} [options] Override http request option.
|
|
9211
|
+
* @throws {RequiredError}
|
|
9212
|
+
*/
|
|
9213
|
+
getFileContent(id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileContentResponse>>;
|
|
9214
|
+
/**
|
|
9215
|
+
* Get file metadata
|
|
8665
9216
|
* @param {string} id File ID
|
|
9217
|
+
* @param {string} xBotId Bot id
|
|
9218
|
+
* @param {string} [xIntegrationId] Integration id
|
|
9219
|
+
* @param {string} [xUserId] User id
|
|
9220
|
+
* @param {string} [xUserRole] User role
|
|
8666
9221
|
* @param {*} [options] Override http request option.
|
|
8667
9222
|
* @throws {RequiredError}
|
|
8668
9223
|
*/
|
|
8669
|
-
|
|
9224
|
+
getFileMetadata(id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileMetadataResponse>>;
|
|
8670
9225
|
/**
|
|
8671
9226
|
* Get integration
|
|
8672
9227
|
* @param {string} id Integration ID
|
|
@@ -8900,13 +9455,18 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8900
9455
|
*/
|
|
8901
9456
|
listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
|
|
8902
9457
|
/**
|
|
8903
|
-
* List
|
|
9458
|
+
* List files for bot
|
|
9459
|
+
* @param {string} xBotId Bot id
|
|
8904
9460
|
* @param {string} botId Bot ID
|
|
8905
9461
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9462
|
+
* @param {string} [xIntegrationId] Integration id
|
|
9463
|
+
* @param {string} [xUserId] User id
|
|
9464
|
+
* @param {string} [xUserRole] User role
|
|
9465
|
+
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
8906
9466
|
* @param {*} [options] Override http request option.
|
|
8907
9467
|
* @throws {RequiredError}
|
|
8908
9468
|
*/
|
|
8909
|
-
listFiles(botId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
|
|
9469
|
+
listFiles(xBotId: string, botId: string, nextToken?: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, tags?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
|
|
8910
9470
|
/**
|
|
8911
9471
|
* List integrations
|
|
8912
9472
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -9065,6 +9625,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9065
9625
|
* @throws {RequiredError}
|
|
9066
9626
|
*/
|
|
9067
9627
|
runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
|
|
9628
|
+
/**
|
|
9629
|
+
* Search files
|
|
9630
|
+
* @param {string} xBotId Bot id
|
|
9631
|
+
* @param {string} botId Bot ID
|
|
9632
|
+
* @param {string} query Query expressed in natural language to retrieve matching text passages within all files using semantical search.
|
|
9633
|
+
* @param {string} [xIntegrationId] Integration id
|
|
9634
|
+
* @param {string} [xUserId] User id
|
|
9635
|
+
* @param {string} [xUserRole] User role
|
|
9636
|
+
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
9637
|
+
* @param {string} [limit] The maximum number of passages to return.
|
|
9638
|
+
* @param {*} [options] Override http request option.
|
|
9639
|
+
* @throws {RequiredError}
|
|
9640
|
+
*/
|
|
9641
|
+
searchFiles(xBotId: string, botId: string, query: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, tags?: string, limit?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
|
|
9068
9642
|
/**
|
|
9069
9643
|
* Set a preference for the account
|
|
9070
9644
|
* @param {string} key Preference key
|
|
@@ -9122,6 +9696,18 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9122
9696
|
* @throws {RequiredError}
|
|
9123
9697
|
*/
|
|
9124
9698
|
updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateConversationResponse>>;
|
|
9699
|
+
/**
|
|
9700
|
+
* Update file metadata
|
|
9701
|
+
* @param {string} id File ID
|
|
9702
|
+
* @param {string} xBotId Bot id
|
|
9703
|
+
* @param {string} [xIntegrationId] Integration id
|
|
9704
|
+
* @param {string} [xUserId] User id
|
|
9705
|
+
* @param {string} [xUserRole] User role
|
|
9706
|
+
* @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
|
|
9707
|
+
* @param {*} [options] Override http request option.
|
|
9708
|
+
* @throws {RequiredError}
|
|
9709
|
+
*/
|
|
9710
|
+
updateFileMetadata(id: string, xBotId: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFileMetadataResponse>>;
|
|
9125
9711
|
/**
|
|
9126
9712
|
* Update integration
|
|
9127
9713
|
* @param {string} id Integration ID
|
|
@@ -9278,12 +9864,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9278
9864
|
*/
|
|
9279
9865
|
createEvent(requestParameters?: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
|
|
9280
9866
|
/**
|
|
9281
|
-
*
|
|
9867
|
+
* Creates a file.
|
|
9282
9868
|
* @param {DefaultApiCreateFileRequest} requestParameters Request parameters.
|
|
9283
9869
|
* @param {*} [options] Override http request option.
|
|
9284
9870
|
* @throws {RequiredError}
|
|
9285
9871
|
*/
|
|
9286
|
-
createFile(requestParameters
|
|
9872
|
+
createFile(requestParameters: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
|
|
9287
9873
|
/**
|
|
9288
9874
|
* Create integration
|
|
9289
9875
|
* @param {DefaultApiCreateIntegrationRequest} requestParameters Request parameters.
|
|
@@ -9369,7 +9955,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9369
9955
|
*/
|
|
9370
9956
|
deleteConversation(requestParameters: DefaultApiDeleteConversationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
9371
9957
|
/**
|
|
9372
|
-
*
|
|
9958
|
+
* Deletes a file.
|
|
9373
9959
|
* @param {DefaultApiDeleteFileRequest} requestParameters Request parameters.
|
|
9374
9960
|
* @param {*} [options] Override http request option.
|
|
9375
9961
|
* @throws {RequiredError}
|
|
@@ -9438,13 +10024,6 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9438
10024
|
* @throws {RequiredError}
|
|
9439
10025
|
*/
|
|
9440
10026
|
deleteWorkspaceMember(requestParameters: DefaultApiDeleteWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
9441
|
-
/**
|
|
9442
|
-
* Download File
|
|
9443
|
-
* @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
|
|
9444
|
-
* @param {*} [options] Override http request option.
|
|
9445
|
-
* @throws {RequiredError}
|
|
9446
|
-
*/
|
|
9447
|
-
downloadFile(requestParameters: DefaultApiDownloadFileRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
|
|
9448
10027
|
/**
|
|
9449
10028
|
* Enables the search and filtering of rows within a table based on specific criteria. This operation supports complex queries for advanced data manipulation and retrieval.
|
|
9450
10029
|
* @param {DefaultApiFindTableRowsRequest} requestParameters Request parameters.
|
|
@@ -9523,12 +10102,19 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9523
10102
|
*/
|
|
9524
10103
|
getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
|
|
9525
10104
|
/**
|
|
9526
|
-
*
|
|
9527
|
-
* @param {
|
|
10105
|
+
* Returns a presigned URL to download the file content.
|
|
10106
|
+
* @param {DefaultApiGetFileContentRequest} requestParameters Request parameters.
|
|
10107
|
+
* @param {*} [options] Override http request option.
|
|
10108
|
+
* @throws {RequiredError}
|
|
10109
|
+
*/
|
|
10110
|
+
getFileContent(requestParameters: DefaultApiGetFileContentRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileContentResponse>;
|
|
10111
|
+
/**
|
|
10112
|
+
* Get file metadata
|
|
10113
|
+
* @param {DefaultApiGetFileMetadataRequest} requestParameters Request parameters.
|
|
9528
10114
|
* @param {*} [options] Override http request option.
|
|
9529
10115
|
* @throws {RequiredError}
|
|
9530
10116
|
*/
|
|
9531
|
-
|
|
10117
|
+
getFileMetadata(requestParameters: DefaultApiGetFileMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileMetadataResponse>;
|
|
9532
10118
|
/**
|
|
9533
10119
|
* Get integration
|
|
9534
10120
|
* @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
|
|
@@ -9733,7 +10319,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9733
10319
|
*/
|
|
9734
10320
|
listEvents(requestParameters?: DefaultApiListEventsRequest, options?: AxiosRequestConfig): AxiosPromise<ListEventsResponse>;
|
|
9735
10321
|
/**
|
|
9736
|
-
* List
|
|
10322
|
+
* List files for bot
|
|
9737
10323
|
* @param {DefaultApiListFilesRequest} requestParameters Request parameters.
|
|
9738
10324
|
* @param {*} [options] Override http request option.
|
|
9739
10325
|
* @throws {RequiredError}
|
|
@@ -9864,6 +10450,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9864
10450
|
* @throws {RequiredError}
|
|
9865
10451
|
*/
|
|
9866
10452
|
runVrl(requestParameters?: DefaultApiRunVrlRequest, options?: AxiosRequestConfig): AxiosPromise<RunVrlResponse>;
|
|
10453
|
+
/**
|
|
10454
|
+
* Search files
|
|
10455
|
+
* @param {DefaultApiSearchFilesRequest} requestParameters Request parameters.
|
|
10456
|
+
* @param {*} [options] Override http request option.
|
|
10457
|
+
* @throws {RequiredError}
|
|
10458
|
+
*/
|
|
10459
|
+
searchFiles(requestParameters: DefaultApiSearchFilesRequest, options?: AxiosRequestConfig): AxiosPromise<SearchFilesResponse>;
|
|
9867
10460
|
/**
|
|
9868
10461
|
* Set a preference for the account
|
|
9869
10462
|
* @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
|
|
@@ -9913,6 +10506,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9913
10506
|
* @throws {RequiredError}
|
|
9914
10507
|
*/
|
|
9915
10508
|
updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateConversationResponse>;
|
|
10509
|
+
/**
|
|
10510
|
+
* Update file metadata
|
|
10511
|
+
* @param {DefaultApiUpdateFileMetadataRequest} requestParameters Request parameters.
|
|
10512
|
+
* @param {*} [options] Override http request option.
|
|
10513
|
+
* @throws {RequiredError}
|
|
10514
|
+
*/
|
|
10515
|
+
updateFileMetadata(requestParameters: DefaultApiUpdateFileMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateFileMetadataResponse>;
|
|
9916
10516
|
/**
|
|
9917
10517
|
* Update integration
|
|
9918
10518
|
* @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.
|
|
@@ -10157,7 +10757,67 @@ export interface DefaultApiCreateEventRequest {
|
|
|
10157
10757
|
*/
|
|
10158
10758
|
export interface DefaultApiCreateFileRequest {
|
|
10159
10759
|
/**
|
|
10160
|
-
*
|
|
10760
|
+
* File name
|
|
10761
|
+
* @type {string}
|
|
10762
|
+
* @memberof DefaultApiCreateFile
|
|
10763
|
+
*/
|
|
10764
|
+
readonly xFilename: string;
|
|
10765
|
+
/**
|
|
10766
|
+
* Bot id
|
|
10767
|
+
* @type {string}
|
|
10768
|
+
* @memberof DefaultApiCreateFile
|
|
10769
|
+
*/
|
|
10770
|
+
readonly xBotId: string;
|
|
10771
|
+
/**
|
|
10772
|
+
* File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
10773
|
+
* @type {string}
|
|
10774
|
+
* @memberof DefaultApiCreateFile
|
|
10775
|
+
*/
|
|
10776
|
+
readonly xTags?: string;
|
|
10777
|
+
/**
|
|
10778
|
+
* File access policies
|
|
10779
|
+
* @type {string}
|
|
10780
|
+
* @memberof DefaultApiCreateFile
|
|
10781
|
+
*/
|
|
10782
|
+
readonly xAccessPolicies?: string;
|
|
10783
|
+
/**
|
|
10784
|
+
* Set to a value of \"true\" to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
|
|
10785
|
+
* @type {string}
|
|
10786
|
+
* @memberof DefaultApiCreateFile
|
|
10787
|
+
*/
|
|
10788
|
+
readonly xIndex?: string;
|
|
10789
|
+
/**
|
|
10790
|
+
* File content type
|
|
10791
|
+
* @type {string}
|
|
10792
|
+
* @memberof DefaultApiCreateFile
|
|
10793
|
+
*/
|
|
10794
|
+
readonly contentType?: string;
|
|
10795
|
+
/**
|
|
10796
|
+
* File content length
|
|
10797
|
+
* @type {string}
|
|
10798
|
+
* @memberof DefaultApiCreateFile
|
|
10799
|
+
*/
|
|
10800
|
+
readonly contentLength?: string;
|
|
10801
|
+
/**
|
|
10802
|
+
* Integration id
|
|
10803
|
+
* @type {string}
|
|
10804
|
+
* @memberof DefaultApiCreateFile
|
|
10805
|
+
*/
|
|
10806
|
+
readonly xIntegrationId?: string;
|
|
10807
|
+
/**
|
|
10808
|
+
* User id
|
|
10809
|
+
* @type {string}
|
|
10810
|
+
* @memberof DefaultApiCreateFile
|
|
10811
|
+
*/
|
|
10812
|
+
readonly xUserId?: string;
|
|
10813
|
+
/**
|
|
10814
|
+
* User role
|
|
10815
|
+
* @type {string}
|
|
10816
|
+
* @memberof DefaultApiCreateFile
|
|
10817
|
+
*/
|
|
10818
|
+
readonly xUserRole?: string;
|
|
10819
|
+
/**
|
|
10820
|
+
* The file to upload.
|
|
10161
10821
|
* @type {CreateFileBody}
|
|
10162
10822
|
* @memberof DefaultApiCreateFile
|
|
10163
10823
|
*/
|
|
@@ -10343,6 +11003,30 @@ export interface DefaultApiDeleteFileRequest {
|
|
|
10343
11003
|
* @memberof DefaultApiDeleteFile
|
|
10344
11004
|
*/
|
|
10345
11005
|
readonly id: string;
|
|
11006
|
+
/**
|
|
11007
|
+
* Bot id
|
|
11008
|
+
* @type {string}
|
|
11009
|
+
* @memberof DefaultApiDeleteFile
|
|
11010
|
+
*/
|
|
11011
|
+
readonly xBotId: string;
|
|
11012
|
+
/**
|
|
11013
|
+
* Integration id
|
|
11014
|
+
* @type {string}
|
|
11015
|
+
* @memberof DefaultApiDeleteFile
|
|
11016
|
+
*/
|
|
11017
|
+
readonly xIntegrationId?: string;
|
|
11018
|
+
/**
|
|
11019
|
+
* User id
|
|
11020
|
+
* @type {string}
|
|
11021
|
+
* @memberof DefaultApiDeleteFile
|
|
11022
|
+
*/
|
|
11023
|
+
readonly xUserId?: string;
|
|
11024
|
+
/**
|
|
11025
|
+
* User role
|
|
11026
|
+
* @type {string}
|
|
11027
|
+
* @memberof DefaultApiDeleteFile
|
|
11028
|
+
*/
|
|
11029
|
+
readonly xUserRole?: string;
|
|
10346
11030
|
}
|
|
10347
11031
|
/**
|
|
10348
11032
|
* Request parameters for deleteIntegration operation in DefaultApi.
|
|
@@ -10467,19 +11151,6 @@ export interface DefaultApiDeleteWorkspaceMemberRequest {
|
|
|
10467
11151
|
*/
|
|
10468
11152
|
readonly id: string;
|
|
10469
11153
|
}
|
|
10470
|
-
/**
|
|
10471
|
-
* Request parameters for downloadFile operation in DefaultApi.
|
|
10472
|
-
* @export
|
|
10473
|
-
* @interface DefaultApiDownloadFileRequest
|
|
10474
|
-
*/
|
|
10475
|
-
export interface DefaultApiDownloadFileRequest {
|
|
10476
|
-
/**
|
|
10477
|
-
* File ID
|
|
10478
|
-
* @type {string}
|
|
10479
|
-
* @memberof DefaultApiDownloadFile
|
|
10480
|
-
*/
|
|
10481
|
-
readonly id: string;
|
|
10482
|
-
}
|
|
10483
11154
|
/**
|
|
10484
11155
|
* Request parameters for findTableRows operation in DefaultApi.
|
|
10485
11156
|
* @export
|
|
@@ -10646,17 +11317,78 @@ export interface DefaultApiGetEventRequest {
|
|
|
10646
11317
|
readonly id: string;
|
|
10647
11318
|
}
|
|
10648
11319
|
/**
|
|
10649
|
-
* Request parameters for
|
|
11320
|
+
* Request parameters for getFileContent operation in DefaultApi.
|
|
11321
|
+
* @export
|
|
11322
|
+
* @interface DefaultApiGetFileContentRequest
|
|
11323
|
+
*/
|
|
11324
|
+
export interface DefaultApiGetFileContentRequest {
|
|
11325
|
+
/**
|
|
11326
|
+
* File ID
|
|
11327
|
+
* @type {string}
|
|
11328
|
+
* @memberof DefaultApiGetFileContent
|
|
11329
|
+
*/
|
|
11330
|
+
readonly id: string;
|
|
11331
|
+
/**
|
|
11332
|
+
* Bot id
|
|
11333
|
+
* @type {string}
|
|
11334
|
+
* @memberof DefaultApiGetFileContent
|
|
11335
|
+
*/
|
|
11336
|
+
readonly xBotId: string;
|
|
11337
|
+
/**
|
|
11338
|
+
* Integration id
|
|
11339
|
+
* @type {string}
|
|
11340
|
+
* @memberof DefaultApiGetFileContent
|
|
11341
|
+
*/
|
|
11342
|
+
readonly xIntegrationId?: string;
|
|
11343
|
+
/**
|
|
11344
|
+
* User id
|
|
11345
|
+
* @type {string}
|
|
11346
|
+
* @memberof DefaultApiGetFileContent
|
|
11347
|
+
*/
|
|
11348
|
+
readonly xUserId?: string;
|
|
11349
|
+
/**
|
|
11350
|
+
* User role
|
|
11351
|
+
* @type {string}
|
|
11352
|
+
* @memberof DefaultApiGetFileContent
|
|
11353
|
+
*/
|
|
11354
|
+
readonly xUserRole?: string;
|
|
11355
|
+
}
|
|
11356
|
+
/**
|
|
11357
|
+
* Request parameters for getFileMetadata operation in DefaultApi.
|
|
10650
11358
|
* @export
|
|
10651
|
-
* @interface
|
|
11359
|
+
* @interface DefaultApiGetFileMetadataRequest
|
|
10652
11360
|
*/
|
|
10653
|
-
export interface
|
|
11361
|
+
export interface DefaultApiGetFileMetadataRequest {
|
|
10654
11362
|
/**
|
|
10655
11363
|
* File ID
|
|
10656
11364
|
* @type {string}
|
|
10657
|
-
* @memberof
|
|
11365
|
+
* @memberof DefaultApiGetFileMetadata
|
|
10658
11366
|
*/
|
|
10659
11367
|
readonly id: string;
|
|
11368
|
+
/**
|
|
11369
|
+
* Bot id
|
|
11370
|
+
* @type {string}
|
|
11371
|
+
* @memberof DefaultApiGetFileMetadata
|
|
11372
|
+
*/
|
|
11373
|
+
readonly xBotId: string;
|
|
11374
|
+
/**
|
|
11375
|
+
* Integration id
|
|
11376
|
+
* @type {string}
|
|
11377
|
+
* @memberof DefaultApiGetFileMetadata
|
|
11378
|
+
*/
|
|
11379
|
+
readonly xIntegrationId?: string;
|
|
11380
|
+
/**
|
|
11381
|
+
* User id
|
|
11382
|
+
* @type {string}
|
|
11383
|
+
* @memberof DefaultApiGetFileMetadata
|
|
11384
|
+
*/
|
|
11385
|
+
readonly xUserId?: string;
|
|
11386
|
+
/**
|
|
11387
|
+
* User role
|
|
11388
|
+
* @type {string}
|
|
11389
|
+
* @memberof DefaultApiGetFileMetadata
|
|
11390
|
+
*/
|
|
11391
|
+
readonly xUserRole?: string;
|
|
10660
11392
|
}
|
|
10661
11393
|
/**
|
|
10662
11394
|
* Request parameters for getIntegration operation in DefaultApi.
|
|
@@ -11205,6 +11937,12 @@ export interface DefaultApiListEventsRequest {
|
|
|
11205
11937
|
* @interface DefaultApiListFilesRequest
|
|
11206
11938
|
*/
|
|
11207
11939
|
export interface DefaultApiListFilesRequest {
|
|
11940
|
+
/**
|
|
11941
|
+
* Bot id
|
|
11942
|
+
* @type {string}
|
|
11943
|
+
* @memberof DefaultApiListFiles
|
|
11944
|
+
*/
|
|
11945
|
+
readonly xBotId: string;
|
|
11208
11946
|
/**
|
|
11209
11947
|
* Bot ID
|
|
11210
11948
|
* @type {string}
|
|
@@ -11217,6 +11955,30 @@ export interface DefaultApiListFilesRequest {
|
|
|
11217
11955
|
* @memberof DefaultApiListFiles
|
|
11218
11956
|
*/
|
|
11219
11957
|
readonly nextToken?: string;
|
|
11958
|
+
/**
|
|
11959
|
+
* Integration id
|
|
11960
|
+
* @type {string}
|
|
11961
|
+
* @memberof DefaultApiListFiles
|
|
11962
|
+
*/
|
|
11963
|
+
readonly xIntegrationId?: string;
|
|
11964
|
+
/**
|
|
11965
|
+
* User id
|
|
11966
|
+
* @type {string}
|
|
11967
|
+
* @memberof DefaultApiListFiles
|
|
11968
|
+
*/
|
|
11969
|
+
readonly xUserId?: string;
|
|
11970
|
+
/**
|
|
11971
|
+
* User role
|
|
11972
|
+
* @type {string}
|
|
11973
|
+
* @memberof DefaultApiListFiles
|
|
11974
|
+
*/
|
|
11975
|
+
readonly xUserRole?: string;
|
|
11976
|
+
/**
|
|
11977
|
+
* Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
11978
|
+
* @type {string}
|
|
11979
|
+
* @memberof DefaultApiListFiles
|
|
11980
|
+
*/
|
|
11981
|
+
readonly tags?: string;
|
|
11220
11982
|
}
|
|
11221
11983
|
/**
|
|
11222
11984
|
* Request parameters for listIntegrations operation in DefaultApi.
|
|
@@ -11597,6 +12359,61 @@ export interface DefaultApiRunVrlRequest {
|
|
|
11597
12359
|
*/
|
|
11598
12360
|
readonly runVrlBody?: RunVrlBody;
|
|
11599
12361
|
}
|
|
12362
|
+
/**
|
|
12363
|
+
* Request parameters for searchFiles operation in DefaultApi.
|
|
12364
|
+
* @export
|
|
12365
|
+
* @interface DefaultApiSearchFilesRequest
|
|
12366
|
+
*/
|
|
12367
|
+
export interface DefaultApiSearchFilesRequest {
|
|
12368
|
+
/**
|
|
12369
|
+
* Bot id
|
|
12370
|
+
* @type {string}
|
|
12371
|
+
* @memberof DefaultApiSearchFiles
|
|
12372
|
+
*/
|
|
12373
|
+
readonly xBotId: string;
|
|
12374
|
+
/**
|
|
12375
|
+
* Bot ID
|
|
12376
|
+
* @type {string}
|
|
12377
|
+
* @memberof DefaultApiSearchFiles
|
|
12378
|
+
*/
|
|
12379
|
+
readonly botId: string;
|
|
12380
|
+
/**
|
|
12381
|
+
* Query expressed in natural language to retrieve matching text passages within all files using semantical search.
|
|
12382
|
+
* @type {string}
|
|
12383
|
+
* @memberof DefaultApiSearchFiles
|
|
12384
|
+
*/
|
|
12385
|
+
readonly query: string;
|
|
12386
|
+
/**
|
|
12387
|
+
* Integration id
|
|
12388
|
+
* @type {string}
|
|
12389
|
+
* @memberof DefaultApiSearchFiles
|
|
12390
|
+
*/
|
|
12391
|
+
readonly xIntegrationId?: string;
|
|
12392
|
+
/**
|
|
12393
|
+
* User id
|
|
12394
|
+
* @type {string}
|
|
12395
|
+
* @memberof DefaultApiSearchFiles
|
|
12396
|
+
*/
|
|
12397
|
+
readonly xUserId?: string;
|
|
12398
|
+
/**
|
|
12399
|
+
* User role
|
|
12400
|
+
* @type {string}
|
|
12401
|
+
* @memberof DefaultApiSearchFiles
|
|
12402
|
+
*/
|
|
12403
|
+
readonly xUserRole?: string;
|
|
12404
|
+
/**
|
|
12405
|
+
* Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
12406
|
+
* @type {string}
|
|
12407
|
+
* @memberof DefaultApiSearchFiles
|
|
12408
|
+
*/
|
|
12409
|
+
readonly tags?: string;
|
|
12410
|
+
/**
|
|
12411
|
+
* The maximum number of passages to return.
|
|
12412
|
+
* @type {string}
|
|
12413
|
+
* @memberof DefaultApiSearchFiles
|
|
12414
|
+
*/
|
|
12415
|
+
readonly limit?: string;
|
|
12416
|
+
}
|
|
11600
12417
|
/**
|
|
11601
12418
|
* Request parameters for setAccountPreference operation in DefaultApi.
|
|
11602
12419
|
* @export
|
|
@@ -11736,6 +12553,49 @@ export interface DefaultApiUpdateConversationRequest {
|
|
|
11736
12553
|
*/
|
|
11737
12554
|
readonly updateConversationBody?: UpdateConversationBody;
|
|
11738
12555
|
}
|
|
12556
|
+
/**
|
|
12557
|
+
* Request parameters for updateFileMetadata operation in DefaultApi.
|
|
12558
|
+
* @export
|
|
12559
|
+
* @interface DefaultApiUpdateFileMetadataRequest
|
|
12560
|
+
*/
|
|
12561
|
+
export interface DefaultApiUpdateFileMetadataRequest {
|
|
12562
|
+
/**
|
|
12563
|
+
* File ID
|
|
12564
|
+
* @type {string}
|
|
12565
|
+
* @memberof DefaultApiUpdateFileMetadata
|
|
12566
|
+
*/
|
|
12567
|
+
readonly id: string;
|
|
12568
|
+
/**
|
|
12569
|
+
* Bot id
|
|
12570
|
+
* @type {string}
|
|
12571
|
+
* @memberof DefaultApiUpdateFileMetadata
|
|
12572
|
+
*/
|
|
12573
|
+
readonly xBotId: string;
|
|
12574
|
+
/**
|
|
12575
|
+
* Integration id
|
|
12576
|
+
* @type {string}
|
|
12577
|
+
* @memberof DefaultApiUpdateFileMetadata
|
|
12578
|
+
*/
|
|
12579
|
+
readonly xIntegrationId?: string;
|
|
12580
|
+
/**
|
|
12581
|
+
* User id
|
|
12582
|
+
* @type {string}
|
|
12583
|
+
* @memberof DefaultApiUpdateFileMetadata
|
|
12584
|
+
*/
|
|
12585
|
+
readonly xUserId?: string;
|
|
12586
|
+
/**
|
|
12587
|
+
* User role
|
|
12588
|
+
* @type {string}
|
|
12589
|
+
* @memberof DefaultApiUpdateFileMetadata
|
|
12590
|
+
*/
|
|
12591
|
+
readonly xUserRole?: string;
|
|
12592
|
+
/**
|
|
12593
|
+
* File metadata to update.
|
|
12594
|
+
* @type {UpdateFileMetadataBody}
|
|
12595
|
+
* @memberof DefaultApiUpdateFileMetadata
|
|
12596
|
+
*/
|
|
12597
|
+
readonly updateFileMetadataBody?: UpdateFileMetadataBody;
|
|
12598
|
+
}
|
|
11739
12599
|
/**
|
|
11740
12600
|
* Request parameters for updateIntegration operation in DefaultApi.
|
|
11741
12601
|
* @export
|
|
@@ -12003,13 +12863,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12003
12863
|
*/
|
|
12004
12864
|
createEvent(requestParameters?: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventResponse, any>>;
|
|
12005
12865
|
/**
|
|
12006
|
-
*
|
|
12866
|
+
* Creates a file.
|
|
12007
12867
|
* @param {DefaultApiCreateFileRequest} requestParameters Request parameters.
|
|
12008
12868
|
* @param {*} [options] Override http request option.
|
|
12009
12869
|
* @throws {RequiredError}
|
|
12010
12870
|
* @memberof DefaultApi
|
|
12011
12871
|
*/
|
|
12012
|
-
createFile(requestParameters
|
|
12872
|
+
createFile(requestParameters: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFileResponse, any>>;
|
|
12013
12873
|
/**
|
|
12014
12874
|
* Create integration
|
|
12015
12875
|
* @param {DefaultApiCreateIntegrationRequest} requestParameters Request parameters.
|
|
@@ -12107,7 +12967,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12107
12967
|
*/
|
|
12108
12968
|
deleteConversation(requestParameters: DefaultApiDeleteConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
12109
12969
|
/**
|
|
12110
|
-
*
|
|
12970
|
+
* Deletes a file.
|
|
12111
12971
|
* @param {DefaultApiDeleteFileRequest} requestParameters Request parameters.
|
|
12112
12972
|
* @param {*} [options] Override http request option.
|
|
12113
12973
|
* @throws {RequiredError}
|
|
@@ -12186,14 +13046,6 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12186
13046
|
* @memberof DefaultApi
|
|
12187
13047
|
*/
|
|
12188
13048
|
deleteWorkspaceMember(requestParameters: DefaultApiDeleteWorkspaceMemberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
12189
|
-
/**
|
|
12190
|
-
* Download File
|
|
12191
|
-
* @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
|
|
12192
|
-
* @param {*} [options] Override http request option.
|
|
12193
|
-
* @throws {RequiredError}
|
|
12194
|
-
* @memberof DefaultApi
|
|
12195
|
-
*/
|
|
12196
|
-
downloadFile(requestParameters: DefaultApiDownloadFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
12197
13049
|
/**
|
|
12198
13050
|
* Enables the search and filtering of rows within a table based on specific criteria. This operation supports complex queries for advanced data manipulation and retrieval.
|
|
12199
13051
|
* @param {DefaultApiFindTableRowsRequest} requestParameters Request parameters.
|
|
@@ -12283,13 +13135,21 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12283
13135
|
*/
|
|
12284
13136
|
getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any>>;
|
|
12285
13137
|
/**
|
|
12286
|
-
*
|
|
12287
|
-
* @param {
|
|
13138
|
+
* Returns a presigned URL to download the file content.
|
|
13139
|
+
* @param {DefaultApiGetFileContentRequest} requestParameters Request parameters.
|
|
13140
|
+
* @param {*} [options] Override http request option.
|
|
13141
|
+
* @throws {RequiredError}
|
|
13142
|
+
* @memberof DefaultApi
|
|
13143
|
+
*/
|
|
13144
|
+
getFileContent(requestParameters: DefaultApiGetFileContentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFileContentResponse, any>>;
|
|
13145
|
+
/**
|
|
13146
|
+
* Get file metadata
|
|
13147
|
+
* @param {DefaultApiGetFileMetadataRequest} requestParameters Request parameters.
|
|
12288
13148
|
* @param {*} [options] Override http request option.
|
|
12289
13149
|
* @throws {RequiredError}
|
|
12290
13150
|
* @memberof DefaultApi
|
|
12291
13151
|
*/
|
|
12292
|
-
|
|
13152
|
+
getFileMetadata(requestParameters: DefaultApiGetFileMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFileMetadataResponse, any>>;
|
|
12293
13153
|
/**
|
|
12294
13154
|
* Get integration
|
|
12295
13155
|
* @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
|
|
@@ -12523,7 +13383,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12523
13383
|
*/
|
|
12524
13384
|
listEvents(requestParameters?: DefaultApiListEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEventsResponse, any>>;
|
|
12525
13385
|
/**
|
|
12526
|
-
* List
|
|
13386
|
+
* List files for bot
|
|
12527
13387
|
* @param {DefaultApiListFilesRequest} requestParameters Request parameters.
|
|
12528
13388
|
* @param {*} [options] Override http request option.
|
|
12529
13389
|
* @throws {RequiredError}
|
|
@@ -12673,6 +13533,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12673
13533
|
* @memberof DefaultApi
|
|
12674
13534
|
*/
|
|
12675
13535
|
runVrl(requestParameters?: DefaultApiRunVrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RunVrlResponse, any>>;
|
|
13536
|
+
/**
|
|
13537
|
+
* Search files
|
|
13538
|
+
* @param {DefaultApiSearchFilesRequest} requestParameters Request parameters.
|
|
13539
|
+
* @param {*} [options] Override http request option.
|
|
13540
|
+
* @throws {RequiredError}
|
|
13541
|
+
* @memberof DefaultApi
|
|
13542
|
+
*/
|
|
13543
|
+
searchFiles(requestParameters: DefaultApiSearchFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchFilesResponse, any>>;
|
|
12676
13544
|
/**
|
|
12677
13545
|
* Set a preference for the account
|
|
12678
13546
|
* @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
|
|
@@ -12729,6 +13597,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12729
13597
|
* @memberof DefaultApi
|
|
12730
13598
|
*/
|
|
12731
13599
|
updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateConversationResponse, any>>;
|
|
13600
|
+
/**
|
|
13601
|
+
* Update file metadata
|
|
13602
|
+
* @param {DefaultApiUpdateFileMetadataRequest} requestParameters Request parameters.
|
|
13603
|
+
* @param {*} [options] Override http request option.
|
|
13604
|
+
* @throws {RequiredError}
|
|
13605
|
+
* @memberof DefaultApi
|
|
13606
|
+
*/
|
|
13607
|
+
updateFileMetadata(requestParameters: DefaultApiUpdateFileMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFileMetadataResponse, any>>;
|
|
12732
13608
|
/**
|
|
12733
13609
|
* Update integration
|
|
12734
13610
|
* @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.
|