@botpress/client 0.12.0 → 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 +7 -7
- package/dist/bundle.cjs.map +3 -3
- package/dist/gen/api.d.ts +962 -505
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +4 -2
- 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.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.19.
|
|
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
|
|
@@ -1548,7 +1441,26 @@ export interface CreateFileResponseFile {
|
|
|
1548
1441
|
* @memberof CreateFileResponseFile
|
|
1549
1442
|
*/
|
|
1550
1443
|
'accessPolicies': Array<string>;
|
|
1444
|
+
/**
|
|
1445
|
+
*
|
|
1446
|
+
* @type {string}
|
|
1447
|
+
* @memberof CreateFileResponseFile
|
|
1448
|
+
*/
|
|
1449
|
+
'indexingStatus'?: CreateFileResponseFileIndexingStatusEnum;
|
|
1450
|
+
/**
|
|
1451
|
+
*
|
|
1452
|
+
* @type {string}
|
|
1453
|
+
* @memberof CreateFileResponseFile
|
|
1454
|
+
*/
|
|
1455
|
+
'indexingFailureReason'?: string;
|
|
1551
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];
|
|
1552
1464
|
/**
|
|
1553
1465
|
*
|
|
1554
1466
|
* @export
|
|
@@ -1575,35 +1487,35 @@ export interface CreateIntegrationBody {
|
|
|
1575
1487
|
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
1576
1488
|
/**
|
|
1577
1489
|
*
|
|
1578
|
-
* @type {{ [key: string]:
|
|
1490
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue; }}
|
|
1579
1491
|
* @memberof CreateIntegrationBody
|
|
1580
1492
|
*/
|
|
1581
1493
|
'states'?: {
|
|
1582
|
-
[key: string]:
|
|
1494
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue;
|
|
1583
1495
|
};
|
|
1584
1496
|
/**
|
|
1585
1497
|
*
|
|
1586
|
-
* @type {{ [key: string]:
|
|
1498
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
1587
1499
|
* @memberof CreateIntegrationBody
|
|
1588
1500
|
*/
|
|
1589
1501
|
'events'?: {
|
|
1590
|
-
[key: string]:
|
|
1502
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
1591
1503
|
};
|
|
1592
1504
|
/**
|
|
1593
1505
|
*
|
|
1594
|
-
* @type {{ [key: string]:
|
|
1506
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
1595
1507
|
* @memberof CreateIntegrationBody
|
|
1596
1508
|
*/
|
|
1597
1509
|
'actions'?: {
|
|
1598
|
-
[key: string]:
|
|
1510
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
1599
1511
|
};
|
|
1600
1512
|
/**
|
|
1601
1513
|
*
|
|
1602
|
-
* @type {{ [key: string]:
|
|
1514
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue; }}
|
|
1603
1515
|
* @memberof CreateIntegrationBody
|
|
1604
1516
|
*/
|
|
1605
1517
|
'entities'?: {
|
|
1606
|
-
[key: string]:
|
|
1518
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue;
|
|
1607
1519
|
};
|
|
1608
1520
|
/**
|
|
1609
1521
|
*
|
|
@@ -1696,11 +1608,11 @@ export interface CreateIntegrationBodyChannelsValue {
|
|
|
1696
1608
|
'description'?: string;
|
|
1697
1609
|
/**
|
|
1698
1610
|
*
|
|
1699
|
-
* @type {{ [key: string]:
|
|
1611
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue; }}
|
|
1700
1612
|
* @memberof CreateIntegrationBodyChannelsValue
|
|
1701
1613
|
*/
|
|
1702
1614
|
'messages': {
|
|
1703
|
-
[key: string]:
|
|
1615
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueMessagesValue;
|
|
1704
1616
|
};
|
|
1705
1617
|
/**
|
|
1706
1618
|
*
|
|
@@ -1723,51 +1635,17 @@ export interface CreateIntegrationBodyChannelsValue {
|
|
|
1723
1635
|
export interface CreateIntegrationBodyChannelsValueConversation {
|
|
1724
1636
|
/**
|
|
1725
1637
|
*
|
|
1726
|
-
* @type {
|
|
1638
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation}
|
|
1727
1639
|
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
1728
1640
|
*/
|
|
1729
|
-
'creation'?:
|
|
1641
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation;
|
|
1730
1642
|
/**
|
|
1731
1643
|
*
|
|
1732
|
-
* @type {{ [key: string]:
|
|
1644
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
1733
1645
|
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
1734
1646
|
*/
|
|
1735
1647
|
'tags'?: {
|
|
1736
|
-
[key: string]:
|
|
1737
|
-
};
|
|
1738
|
-
}
|
|
1739
|
-
/**
|
|
1740
|
-
* 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.
|
|
1741
|
-
* @export
|
|
1742
|
-
* @interface CreateIntegrationBodyChannelsValueConversationCreation
|
|
1743
|
-
*/
|
|
1744
|
-
export interface CreateIntegrationBodyChannelsValueConversationCreation {
|
|
1745
|
-
/**
|
|
1746
|
-
* Enable conversation creation
|
|
1747
|
-
* @type {boolean}
|
|
1748
|
-
* @memberof CreateIntegrationBodyChannelsValueConversationCreation
|
|
1749
|
-
*/
|
|
1750
|
-
'enabled': boolean;
|
|
1751
|
-
/**
|
|
1752
|
-
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
1753
|
-
* @type {Array<string>}
|
|
1754
|
-
* @memberof CreateIntegrationBodyChannelsValueConversationCreation
|
|
1755
|
-
*/
|
|
1756
|
-
'requiredTags': Array<string>;
|
|
1757
|
-
}
|
|
1758
|
-
/**
|
|
1759
|
-
* Message definition
|
|
1760
|
-
* @export
|
|
1761
|
-
* @interface CreateIntegrationBodyChannelsValueMessagesValue
|
|
1762
|
-
*/
|
|
1763
|
-
export interface CreateIntegrationBodyChannelsValueMessagesValue {
|
|
1764
|
-
/**
|
|
1765
|
-
*
|
|
1766
|
-
* @type {{ [key: string]: any; }}
|
|
1767
|
-
* @memberof CreateIntegrationBodyChannelsValueMessagesValue
|
|
1768
|
-
*/
|
|
1769
|
-
'schema': {
|
|
1770
|
-
[key: string]: any;
|
|
1648
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
1771
1649
|
};
|
|
1772
1650
|
}
|
|
1773
1651
|
/**
|
|
@@ -1810,33 +1688,6 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1810
1688
|
*/
|
|
1811
1689
|
'linkTemplateScript'?: string;
|
|
1812
1690
|
}
|
|
1813
|
-
/**
|
|
1814
|
-
* Entity definition
|
|
1815
|
-
* @export
|
|
1816
|
-
* @interface CreateIntegrationBodyEntitiesValue
|
|
1817
|
-
*/
|
|
1818
|
-
export interface CreateIntegrationBodyEntitiesValue {
|
|
1819
|
-
/**
|
|
1820
|
-
* Title of the entity
|
|
1821
|
-
* @type {string}
|
|
1822
|
-
* @memberof CreateIntegrationBodyEntitiesValue
|
|
1823
|
-
*/
|
|
1824
|
-
'title'?: string;
|
|
1825
|
-
/**
|
|
1826
|
-
* Description of the entity
|
|
1827
|
-
* @type {string}
|
|
1828
|
-
* @memberof CreateIntegrationBodyEntitiesValue
|
|
1829
|
-
*/
|
|
1830
|
-
'description'?: string;
|
|
1831
|
-
/**
|
|
1832
|
-
*
|
|
1833
|
-
* @type {{ [key: string]: any; }}
|
|
1834
|
-
* @memberof CreateIntegrationBodyEntitiesValue
|
|
1835
|
-
*/
|
|
1836
|
-
'schema': {
|
|
1837
|
-
[key: string]: any;
|
|
1838
|
-
};
|
|
1839
|
-
}
|
|
1840
1691
|
/**
|
|
1841
1692
|
*
|
|
1842
1693
|
* @export
|
|
@@ -1856,33 +1707,6 @@ export interface CreateIntegrationBodyIdentifier {
|
|
|
1856
1707
|
*/
|
|
1857
1708
|
'extractScript'?: string;
|
|
1858
1709
|
}
|
|
1859
|
-
/**
|
|
1860
|
-
* State definition
|
|
1861
|
-
* @export
|
|
1862
|
-
* @interface CreateIntegrationBodyStatesValue
|
|
1863
|
-
*/
|
|
1864
|
-
export interface CreateIntegrationBodyStatesValue {
|
|
1865
|
-
/**
|
|
1866
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
1867
|
-
* @type {string}
|
|
1868
|
-
* @memberof CreateIntegrationBodyStatesValue
|
|
1869
|
-
*/
|
|
1870
|
-
'type': CreateIntegrationBodyStatesValueTypeEnum;
|
|
1871
|
-
/**
|
|
1872
|
-
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
1873
|
-
* @type {{ [key: string]: any; }}
|
|
1874
|
-
* @memberof CreateIntegrationBodyStatesValue
|
|
1875
|
-
*/
|
|
1876
|
-
'schema': {
|
|
1877
|
-
[key: string]: any;
|
|
1878
|
-
};
|
|
1879
|
-
}
|
|
1880
|
-
export declare const CreateIntegrationBodyStatesValueTypeEnum: {
|
|
1881
|
-
readonly Conversation: "conversation";
|
|
1882
|
-
readonly User: "user";
|
|
1883
|
-
readonly Integration: "integration";
|
|
1884
|
-
};
|
|
1885
|
-
export type CreateIntegrationBodyStatesValueTypeEnum = typeof CreateIntegrationBodyStatesValueTypeEnum[keyof typeof CreateIntegrationBodyStatesValueTypeEnum];
|
|
1886
1710
|
/**
|
|
1887
1711
|
*
|
|
1888
1712
|
* @export
|
|
@@ -1891,38 +1715,19 @@ export type CreateIntegrationBodyStatesValueTypeEnum = typeof CreateIntegrationB
|
|
|
1891
1715
|
export interface CreateIntegrationBodyUser {
|
|
1892
1716
|
/**
|
|
1893
1717
|
*
|
|
1894
|
-
* @type {
|
|
1718
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUserCreation}
|
|
1895
1719
|
* @memberof CreateIntegrationBodyUser
|
|
1896
1720
|
*/
|
|
1897
|
-
'creation'?:
|
|
1721
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationUserCreation;
|
|
1898
1722
|
/**
|
|
1899
1723
|
*
|
|
1900
|
-
* @type {{ [key: string]:
|
|
1724
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue; }}
|
|
1901
1725
|
* @memberof CreateIntegrationBodyUser
|
|
1902
1726
|
*/
|
|
1903
1727
|
'tags'?: {
|
|
1904
|
-
[key: string]:
|
|
1728
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationTagsValue;
|
|
1905
1729
|
};
|
|
1906
1730
|
}
|
|
1907
|
-
/**
|
|
1908
|
-
* 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.
|
|
1909
|
-
* @export
|
|
1910
|
-
* @interface CreateIntegrationBodyUserCreation
|
|
1911
|
-
*/
|
|
1912
|
-
export interface CreateIntegrationBodyUserCreation {
|
|
1913
|
-
/**
|
|
1914
|
-
* Enable user creation
|
|
1915
|
-
* @type {boolean}
|
|
1916
|
-
* @memberof CreateIntegrationBodyUserCreation
|
|
1917
|
-
*/
|
|
1918
|
-
'enabled': boolean;
|
|
1919
|
-
/**
|
|
1920
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
1921
|
-
* @type {Array<string>}
|
|
1922
|
-
* @memberof CreateIntegrationBodyUserCreation
|
|
1923
|
-
*/
|
|
1924
|
-
'requiredTags': Array<string>;
|
|
1925
|
-
}
|
|
1926
1731
|
/**
|
|
1927
1732
|
*
|
|
1928
1733
|
* @export
|
|
@@ -3362,110 +3167,626 @@ export interface GetParticipantResponse {
|
|
|
3362
3167
|
export interface GetPublicIntegrationByIdResponse {
|
|
3363
3168
|
/**
|
|
3364
3169
|
*
|
|
3365
|
-
* @type {
|
|
3170
|
+
* @type {GetPublicIntegrationByIdResponseIntegration}
|
|
3366
3171
|
* @memberof GetPublicIntegrationByIdResponse
|
|
3367
3172
|
*/
|
|
3368
|
-
'integration':
|
|
3369
|
-
}
|
|
3370
|
-
/**
|
|
3371
|
-
*
|
|
3372
|
-
* @export
|
|
3373
|
-
* @interface GetPublicIntegrationResponse
|
|
3374
|
-
*/
|
|
3375
|
-
export interface GetPublicIntegrationResponse {
|
|
3376
|
-
/**
|
|
3377
|
-
*
|
|
3378
|
-
* @type {Integration}
|
|
3379
|
-
* @memberof GetPublicIntegrationResponse
|
|
3380
|
-
*/
|
|
3381
|
-
'integration': Integration;
|
|
3173
|
+
'integration': GetPublicIntegrationByIdResponseIntegration;
|
|
3382
3174
|
}
|
|
3383
3175
|
/**
|
|
3384
3176
|
*
|
|
3385
3177
|
* @export
|
|
3386
|
-
* @interface
|
|
3178
|
+
* @interface GetPublicIntegrationByIdResponseIntegration
|
|
3387
3179
|
*/
|
|
3388
|
-
export interface
|
|
3180
|
+
export interface GetPublicIntegrationByIdResponseIntegration {
|
|
3389
3181
|
/**
|
|
3390
|
-
*
|
|
3182
|
+
* User id
|
|
3391
3183
|
* @type {string}
|
|
3392
|
-
* @memberof
|
|
3184
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3393
3185
|
*/
|
|
3394
3186
|
'id': string;
|
|
3395
3187
|
/**
|
|
3396
|
-
*
|
|
3188
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
3397
3189
|
* @type {string}
|
|
3398
|
-
* @memberof
|
|
3190
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3399
3191
|
*/
|
|
3400
|
-
'
|
|
3192
|
+
'createdAt': string;
|
|
3401
3193
|
/**
|
|
3402
|
-
*
|
|
3194
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
3403
3195
|
* @type {string}
|
|
3404
|
-
* @memberof
|
|
3196
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3405
3197
|
*/
|
|
3406
|
-
'
|
|
3198
|
+
'updatedAt': string;
|
|
3407
3199
|
/**
|
|
3408
3200
|
*
|
|
3201
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationIdentifier}
|
|
3202
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3203
|
+
*/
|
|
3204
|
+
'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
|
|
3205
|
+
/**
|
|
3206
|
+
* Unique identifier of the integration that was installed on the bot
|
|
3409
3207
|
* @type {string}
|
|
3410
|
-
* @memberof
|
|
3208
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3411
3209
|
*/
|
|
3412
|
-
'
|
|
3210
|
+
'name': string;
|
|
3413
3211
|
/**
|
|
3414
|
-
*
|
|
3212
|
+
* Unique identifier of the integration that was installed on the bot
|
|
3415
3213
|
* @type {string}
|
|
3416
|
-
* @memberof
|
|
3214
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3417
3215
|
*/
|
|
3418
|
-
'
|
|
3216
|
+
'version': string;
|
|
3419
3217
|
/**
|
|
3420
3218
|
*
|
|
3421
|
-
* @type {
|
|
3422
|
-
* @memberof
|
|
3219
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationConfiguration}
|
|
3220
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3423
3221
|
*/
|
|
3424
|
-
'
|
|
3222
|
+
'configuration': GetPublicIntegrationByIdResponseIntegrationConfiguration;
|
|
3425
3223
|
/**
|
|
3426
3224
|
*
|
|
3427
|
-
* @type {string}
|
|
3428
|
-
* @memberof
|
|
3225
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue; }}
|
|
3226
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3429
3227
|
*/
|
|
3430
|
-
'
|
|
3228
|
+
'channels': {
|
|
3229
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue;
|
|
3230
|
+
};
|
|
3431
3231
|
/**
|
|
3432
3232
|
*
|
|
3433
|
-
* @type {string}
|
|
3434
|
-
* @memberof
|
|
3233
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue; }}
|
|
3234
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3435
3235
|
*/
|
|
3436
|
-
'
|
|
3236
|
+
'states': {
|
|
3237
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue;
|
|
3238
|
+
};
|
|
3437
3239
|
/**
|
|
3438
3240
|
*
|
|
3439
|
-
* @type {
|
|
3440
|
-
* @memberof
|
|
3241
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
3242
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3441
3243
|
*/
|
|
3442
|
-
'
|
|
3244
|
+
'events': {
|
|
3245
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
3246
|
+
};
|
|
3443
3247
|
/**
|
|
3444
3248
|
*
|
|
3445
|
-
* @type {string}
|
|
3446
|
-
* @memberof
|
|
3249
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
3250
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3447
3251
|
*/
|
|
3448
|
-
'
|
|
3449
|
-
|
|
3450
|
-
|
|
3451
|
-
*
|
|
3452
|
-
* @export
|
|
3453
|
-
* @interface GetStateResponse
|
|
3454
|
-
*/
|
|
3455
|
-
export interface GetStateResponse {
|
|
3252
|
+
'actions': {
|
|
3253
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
3254
|
+
};
|
|
3456
3255
|
/**
|
|
3457
3256
|
*
|
|
3458
|
-
* @type {
|
|
3459
|
-
* @memberof
|
|
3257
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUser}
|
|
3258
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3460
3259
|
*/
|
|
3461
|
-
'
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
|
-
|
|
3465
|
-
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
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
|
|
3708
|
+
*/
|
|
3709
|
+
export interface GetPublicWorkspaceResponse {
|
|
3710
|
+
/**
|
|
3711
|
+
*
|
|
3712
|
+
* @type {string}
|
|
3713
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3714
|
+
*/
|
|
3715
|
+
'id': string;
|
|
3716
|
+
/**
|
|
3717
|
+
*
|
|
3718
|
+
* @type {string}
|
|
3719
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3720
|
+
*/
|
|
3721
|
+
'name': string;
|
|
3722
|
+
/**
|
|
3723
|
+
*
|
|
3724
|
+
* @type {string}
|
|
3725
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3726
|
+
*/
|
|
3727
|
+
'createdAt': string;
|
|
3728
|
+
/**
|
|
3729
|
+
*
|
|
3730
|
+
* @type {string}
|
|
3731
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3732
|
+
*/
|
|
3733
|
+
'updatedAt': string;
|
|
3734
|
+
/**
|
|
3735
|
+
*
|
|
3736
|
+
* @type {string}
|
|
3737
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3738
|
+
*/
|
|
3739
|
+
'about'?: string;
|
|
3740
|
+
/**
|
|
3741
|
+
*
|
|
3742
|
+
* @type {string}
|
|
3743
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3744
|
+
*/
|
|
3745
|
+
'profilePicture'?: string;
|
|
3746
|
+
/**
|
|
3747
|
+
*
|
|
3748
|
+
* @type {string}
|
|
3749
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3750
|
+
*/
|
|
3751
|
+
'contactEmail'?: string;
|
|
3752
|
+
/**
|
|
3753
|
+
*
|
|
3754
|
+
* @type {string}
|
|
3755
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3756
|
+
*/
|
|
3757
|
+
'website'?: string;
|
|
3758
|
+
/**
|
|
3759
|
+
*
|
|
3760
|
+
* @type {Array<string>}
|
|
3761
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3762
|
+
*/
|
|
3763
|
+
'socialAccounts'?: Array<string>;
|
|
3764
|
+
/**
|
|
3765
|
+
*
|
|
3766
|
+
* @type {string}
|
|
3767
|
+
* @memberof GetPublicWorkspaceResponse
|
|
3768
|
+
*/
|
|
3769
|
+
'handle'?: string;
|
|
3770
|
+
}
|
|
3771
|
+
/**
|
|
3772
|
+
*
|
|
3773
|
+
* @export
|
|
3774
|
+
* @interface GetStateResponse
|
|
3775
|
+
*/
|
|
3776
|
+
export interface GetStateResponse {
|
|
3777
|
+
/**
|
|
3778
|
+
*
|
|
3779
|
+
* @type {State}
|
|
3780
|
+
* @memberof GetStateResponse
|
|
3781
|
+
*/
|
|
3782
|
+
'state': State;
|
|
3783
|
+
}
|
|
3784
|
+
/**
|
|
3785
|
+
*
|
|
3786
|
+
* @export
|
|
3787
|
+
* @interface GetTableResponse
|
|
3788
|
+
*/
|
|
3789
|
+
export interface GetTableResponse {
|
|
3469
3790
|
/**
|
|
3470
3791
|
*
|
|
3471
3792
|
* @type {Table}
|
|
@@ -3886,10 +4207,10 @@ export interface Integration {
|
|
|
3886
4207
|
'updatedAt': string;
|
|
3887
4208
|
/**
|
|
3888
4209
|
*
|
|
3889
|
-
* @type {
|
|
4210
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationIdentifier}
|
|
3890
4211
|
* @memberof Integration
|
|
3891
4212
|
*/
|
|
3892
|
-
'identifier':
|
|
4213
|
+
'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
|
|
3893
4214
|
/**
|
|
3894
4215
|
* Type of the task
|
|
3895
4216
|
* @type {string}
|
|
@@ -3904,232 +4225,92 @@ export interface Integration {
|
|
|
3904
4225
|
'version': string;
|
|
3905
4226
|
/**
|
|
3906
4227
|
*
|
|
3907
|
-
* @type {
|
|
4228
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationConfiguration}
|
|
3908
4229
|
* @memberof Integration
|
|
3909
4230
|
*/
|
|
3910
|
-
'configuration':
|
|
4231
|
+
'configuration': GetPublicIntegrationByIdResponseIntegrationConfiguration;
|
|
3911
4232
|
/**
|
|
3912
4233
|
*
|
|
3913
|
-
* @type {{ [key: string]:
|
|
4234
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue; }}
|
|
3914
4235
|
* @memberof Integration
|
|
3915
4236
|
*/
|
|
3916
4237
|
'channels': {
|
|
3917
|
-
[key: string]:
|
|
4238
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationChannelsValue;
|
|
3918
4239
|
};
|
|
3919
4240
|
/**
|
|
3920
4241
|
*
|
|
3921
|
-
* @type {{ [key: string]:
|
|
4242
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue; }}
|
|
3922
4243
|
* @memberof Integration
|
|
3923
4244
|
*/
|
|
3924
4245
|
'states': {
|
|
3925
|
-
[key: string]:
|
|
4246
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationStatesValue;
|
|
3926
4247
|
};
|
|
3927
4248
|
/**
|
|
3928
4249
|
*
|
|
3929
|
-
* @type {{ [key: string]:
|
|
4250
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue; }}
|
|
3930
4251
|
* @memberof Integration
|
|
3931
4252
|
*/
|
|
3932
4253
|
'events': {
|
|
3933
|
-
[key: string]:
|
|
4254
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEventsValue;
|
|
3934
4255
|
};
|
|
3935
4256
|
/**
|
|
3936
4257
|
*
|
|
3937
|
-
* @type {{ [key: string]:
|
|
4258
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue; }}
|
|
3938
4259
|
* @memberof Integration
|
|
3939
4260
|
*/
|
|
3940
4261
|
'actions': {
|
|
3941
|
-
[key: string]:
|
|
4262
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationActionsValue;
|
|
3942
4263
|
};
|
|
3943
4264
|
/**
|
|
3944
4265
|
*
|
|
3945
|
-
* @type {
|
|
3946
|
-
* @memberof Integration
|
|
3947
|
-
*/
|
|
3948
|
-
'user': IntegrationUser;
|
|
3949
|
-
/**
|
|
3950
|
-
*
|
|
3951
|
-
* @type {{ [key: string]: CreateIntegrationBodyEntitiesValue; }}
|
|
3952
|
-
* @memberof Integration
|
|
3953
|
-
*/
|
|
3954
|
-
'entities': {
|
|
3955
|
-
[key: string]: CreateIntegrationBodyEntitiesValue;
|
|
3956
|
-
};
|
|
3957
|
-
/**
|
|
3958
|
-
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
3959
|
-
* @type {boolean}
|
|
3960
|
-
* @memberof Integration
|
|
3961
|
-
*/
|
|
3962
|
-
'dev': boolean;
|
|
3963
|
-
/**
|
|
3964
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
3965
|
-
* @type {string}
|
|
3966
|
-
* @memberof Integration
|
|
3967
|
-
*/
|
|
3968
|
-
'title': string;
|
|
3969
|
-
/**
|
|
3970
|
-
* Description of the integration. This is the description that will be displayed in the UI
|
|
3971
|
-
* @type {string}
|
|
3972
|
-
* @memberof Integration
|
|
3973
|
-
*/
|
|
3974
|
-
'description': string;
|
|
3975
|
-
/**
|
|
3976
|
-
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
3977
|
-
* @type {string}
|
|
3978
|
-
* @memberof Integration
|
|
3979
|
-
*/
|
|
3980
|
-
'iconUrl': string;
|
|
3981
|
-
/**
|
|
3982
|
-
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
3983
|
-
* @type {string}
|
|
3984
|
-
* @memberof Integration
|
|
3985
|
-
*/
|
|
3986
|
-
'readmeUrl': string;
|
|
3987
|
-
/**
|
|
3988
|
-
* 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.
|
|
3989
|
-
* @type {Array<string>}
|
|
4266
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUser}
|
|
3990
4267
|
* @memberof Integration
|
|
3991
4268
|
*/
|
|
3992
|
-
'
|
|
3993
|
-
}
|
|
3994
|
-
/**
|
|
3995
|
-
* Channel definition
|
|
3996
|
-
* @export
|
|
3997
|
-
* @interface IntegrationChannelsValue
|
|
3998
|
-
*/
|
|
3999
|
-
export interface IntegrationChannelsValue {
|
|
4000
|
-
/**
|
|
4001
|
-
* Title of the channel
|
|
4002
|
-
* @type {string}
|
|
4003
|
-
* @memberof IntegrationChannelsValue
|
|
4004
|
-
*/
|
|
4005
|
-
'title'?: string;
|
|
4006
|
-
/**
|
|
4007
|
-
* Description of the channel
|
|
4008
|
-
* @type {string}
|
|
4009
|
-
* @memberof IntegrationChannelsValue
|
|
4010
|
-
*/
|
|
4011
|
-
'description'?: string;
|
|
4012
|
-
/**
|
|
4013
|
-
*
|
|
4014
|
-
* @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
|
|
4015
|
-
* @memberof IntegrationChannelsValue
|
|
4016
|
-
*/
|
|
4017
|
-
'messages': {
|
|
4018
|
-
[key: string]: CreateIntegrationBodyChannelsValueMessagesValue;
|
|
4019
|
-
};
|
|
4020
|
-
/**
|
|
4021
|
-
*
|
|
4022
|
-
* @type {IntegrationChannelsValueConversation}
|
|
4023
|
-
* @memberof IntegrationChannelsValue
|
|
4024
|
-
*/
|
|
4025
|
-
'conversation': IntegrationChannelsValueConversation;
|
|
4026
|
-
/**
|
|
4027
|
-
*
|
|
4028
|
-
* @type {BotMessage}
|
|
4029
|
-
* @memberof IntegrationChannelsValue
|
|
4030
|
-
*/
|
|
4031
|
-
'message': BotMessage;
|
|
4032
|
-
}
|
|
4033
|
-
/**
|
|
4034
|
-
* Conversation object configuration
|
|
4035
|
-
* @export
|
|
4036
|
-
* @interface IntegrationChannelsValueConversation
|
|
4037
|
-
*/
|
|
4038
|
-
export interface IntegrationChannelsValueConversation {
|
|
4039
|
-
/**
|
|
4040
|
-
*
|
|
4041
|
-
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
4042
|
-
* @memberof IntegrationChannelsValueConversation
|
|
4043
|
-
*/
|
|
4044
|
-
'tags': {
|
|
4045
|
-
[key: string]: CreateBotBodyUserTagsValue;
|
|
4046
|
-
};
|
|
4047
|
-
/**
|
|
4048
|
-
*
|
|
4049
|
-
* @type {CreateIntegrationBodyChannelsValueConversationCreation}
|
|
4050
|
-
* @memberof IntegrationChannelsValueConversation
|
|
4051
|
-
*/
|
|
4052
|
-
'creation': CreateIntegrationBodyChannelsValueConversationCreation;
|
|
4053
|
-
}
|
|
4054
|
-
/**
|
|
4055
|
-
* Configuration definition
|
|
4056
|
-
* @export
|
|
4057
|
-
* @interface IntegrationConfiguration
|
|
4058
|
-
*/
|
|
4059
|
-
export interface IntegrationConfiguration {
|
|
4060
|
-
/**
|
|
4061
|
-
*
|
|
4062
|
-
* @type {IntegrationConfigurationIdentifier}
|
|
4063
|
-
* @memberof IntegrationConfiguration
|
|
4064
|
-
*/
|
|
4065
|
-
'identifier': IntegrationConfigurationIdentifier;
|
|
4269
|
+
'user': GetPublicIntegrationByIdResponseIntegrationUser;
|
|
4066
4270
|
/**
|
|
4067
|
-
*
|
|
4068
|
-
* @type {{ [key: string]:
|
|
4069
|
-
* @memberof
|
|
4271
|
+
*
|
|
4272
|
+
* @type {{ [key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue; }}
|
|
4273
|
+
* @memberof Integration
|
|
4070
4274
|
*/
|
|
4071
|
-
'
|
|
4072
|
-
[key: string]:
|
|
4275
|
+
'entities': {
|
|
4276
|
+
[key: string]: GetPublicIntegrationByIdResponseIntegrationEntitiesValue;
|
|
4073
4277
|
};
|
|
4074
|
-
}
|
|
4075
|
-
/**
|
|
4076
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
4077
|
-
* @export
|
|
4078
|
-
* @interface IntegrationConfigurationIdentifier
|
|
4079
|
-
*/
|
|
4080
|
-
export interface IntegrationConfigurationIdentifier {
|
|
4081
4278
|
/**
|
|
4082
|
-
*
|
|
4083
|
-
* @type {
|
|
4084
|
-
* @memberof
|
|
4279
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
4280
|
+
* @type {boolean}
|
|
4281
|
+
* @memberof Integration
|
|
4085
4282
|
*/
|
|
4086
|
-
'
|
|
4283
|
+
'dev': boolean;
|
|
4087
4284
|
/**
|
|
4088
|
-
*
|
|
4089
|
-
* @type {
|
|
4090
|
-
* @memberof
|
|
4285
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
4286
|
+
* @type {string}
|
|
4287
|
+
* @memberof Integration
|
|
4091
4288
|
*/
|
|
4092
|
-
'
|
|
4093
|
-
}
|
|
4094
|
-
/**
|
|
4095
|
-
* Global identifier configuration of the [Integration](#schema_integration)
|
|
4096
|
-
* @export
|
|
4097
|
-
* @interface IntegrationIdentifier
|
|
4098
|
-
*/
|
|
4099
|
-
export interface IntegrationIdentifier {
|
|
4289
|
+
'title': string;
|
|
4100
4290
|
/**
|
|
4101
|
-
*
|
|
4291
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
4102
4292
|
* @type {string}
|
|
4103
|
-
* @memberof
|
|
4293
|
+
* @memberof Integration
|
|
4104
4294
|
*/
|
|
4105
|
-
'
|
|
4295
|
+
'description': string;
|
|
4106
4296
|
/**
|
|
4107
|
-
*
|
|
4297
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
4108
4298
|
* @type {string}
|
|
4109
|
-
* @memberof
|
|
4299
|
+
* @memberof Integration
|
|
4110
4300
|
*/
|
|
4111
|
-
'
|
|
4112
|
-
}
|
|
4113
|
-
/**
|
|
4114
|
-
* User object configuration
|
|
4115
|
-
* @export
|
|
4116
|
-
* @interface IntegrationUser
|
|
4117
|
-
*/
|
|
4118
|
-
export interface IntegrationUser {
|
|
4301
|
+
'iconUrl': string;
|
|
4119
4302
|
/**
|
|
4120
|
-
*
|
|
4121
|
-
* @type {
|
|
4122
|
-
* @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
|
|
4123
4306
|
*/
|
|
4124
|
-
'
|
|
4125
|
-
[key: string]: CreateBotBodyUserTagsValue;
|
|
4126
|
-
};
|
|
4307
|
+
'readmeUrl': string;
|
|
4127
4308
|
/**
|
|
4128
|
-
*
|
|
4129
|
-
* @type {
|
|
4130
|
-
* @memberof
|
|
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
|
|
4131
4312
|
*/
|
|
4132
|
-
'
|
|
4313
|
+
'secrets': Array<string>;
|
|
4133
4314
|
}
|
|
4134
4315
|
/**
|
|
4135
4316
|
*
|
|
@@ -4638,7 +4819,26 @@ export interface ListFilesResponseFilesInner {
|
|
|
4638
4819
|
* @memberof ListFilesResponseFilesInner
|
|
4639
4820
|
*/
|
|
4640
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;
|
|
4641
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];
|
|
4642
4842
|
/**
|
|
4643
4843
|
*
|
|
4644
4844
|
* @export
|
|
@@ -4647,10 +4847,10 @@ export interface ListFilesResponseFilesInner {
|
|
|
4647
4847
|
export interface ListIntegrationsResponse {
|
|
4648
4848
|
/**
|
|
4649
4849
|
*
|
|
4650
|
-
* @type {Array<
|
|
4850
|
+
* @type {Array<ListIntegrationsResponseIntegrationsInner>}
|
|
4651
4851
|
* @memberof ListIntegrationsResponse
|
|
4652
4852
|
*/
|
|
4653
|
-
'integrations': Array<
|
|
4853
|
+
'integrations': Array<ListIntegrationsResponseIntegrationsInner>;
|
|
4654
4854
|
/**
|
|
4655
4855
|
*
|
|
4656
4856
|
* @type {ListConversationsResponseMeta}
|
|
@@ -4658,6 +4858,61 @@ export interface ListIntegrationsResponse {
|
|
|
4658
4858
|
*/
|
|
4659
4859
|
'meta': ListConversationsResponseMeta;
|
|
4660
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
|
+
}
|
|
4661
4916
|
/**
|
|
4662
4917
|
*
|
|
4663
4918
|
* @export
|
|
@@ -4807,6 +5062,37 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
|
4807
5062
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
4808
5063
|
*/
|
|
4809
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;
|
|
4810
5096
|
}
|
|
4811
5097
|
/**
|
|
4812
5098
|
*
|
|
@@ -5241,7 +5527,26 @@ export interface ModelFile {
|
|
|
5241
5527
|
* @memberof ModelFile
|
|
5242
5528
|
*/
|
|
5243
5529
|
'accessPolicies': Array<string>;
|
|
5530
|
+
/**
|
|
5531
|
+
*
|
|
5532
|
+
* @type {string}
|
|
5533
|
+
* @memberof ModelFile
|
|
5534
|
+
*/
|
|
5535
|
+
'indexingStatus'?: ModelFileIndexingStatusEnum;
|
|
5536
|
+
/**
|
|
5537
|
+
*
|
|
5538
|
+
* @type {string}
|
|
5539
|
+
* @memberof ModelFile
|
|
5540
|
+
*/
|
|
5541
|
+
'indexingFailureReason'?: string;
|
|
5244
5542
|
}
|
|
5543
|
+
export declare const ModelFileIndexingStatusEnum: {
|
|
5544
|
+
readonly Pending: "PENDING";
|
|
5545
|
+
readonly InProgress: "IN_PROGRESS";
|
|
5546
|
+
readonly Complete: "COMPLETE";
|
|
5547
|
+
readonly Failed: "FAILED";
|
|
5548
|
+
};
|
|
5549
|
+
export type ModelFileIndexingStatusEnum = typeof ModelFileIndexingStatusEnum[keyof typeof ModelFileIndexingStatusEnum];
|
|
5245
5550
|
/**
|
|
5246
5551
|
*
|
|
5247
5552
|
* @export
|
|
@@ -5376,6 +5681,52 @@ export interface RunVrlResponse {
|
|
|
5376
5681
|
*/
|
|
5377
5682
|
'result'?: any | null;
|
|
5378
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
|
+
}
|
|
5379
5730
|
/**
|
|
5380
5731
|
*
|
|
5381
5732
|
* @export
|
|
@@ -5387,7 +5738,7 @@ export interface SetAccountPreferenceBody {
|
|
|
5387
5738
|
* @type {any}
|
|
5388
5739
|
* @memberof SetAccountPreferenceBody
|
|
5389
5740
|
*/
|
|
5390
|
-
'value'?: any
|
|
5741
|
+
'value'?: any;
|
|
5391
5742
|
}
|
|
5392
5743
|
/**
|
|
5393
5744
|
*
|
|
@@ -6028,16 +6379,16 @@ export interface UpdateBotBodyActionsValue {
|
|
|
6028
6379
|
'description'?: string;
|
|
6029
6380
|
/**
|
|
6030
6381
|
*
|
|
6031
|
-
* @type {
|
|
6382
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationActionsValueInput}
|
|
6032
6383
|
* @memberof UpdateBotBodyActionsValue
|
|
6033
6384
|
*/
|
|
6034
|
-
'input':
|
|
6385
|
+
'input': GetPublicIntegrationByIdResponseIntegrationActionsValueInput;
|
|
6035
6386
|
/**
|
|
6036
6387
|
*
|
|
6037
|
-
* @type {
|
|
6388
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationActionsValueInput}
|
|
6038
6389
|
* @memberof UpdateBotBodyActionsValue
|
|
6039
6390
|
*/
|
|
6040
|
-
'output':
|
|
6391
|
+
'output': GetPublicIntegrationByIdResponseIntegrationActionsValueInput;
|
|
6041
6392
|
}
|
|
6042
6393
|
/**
|
|
6043
6394
|
* Event Definition
|
|
@@ -6432,10 +6783,10 @@ export interface UpdateIntegrationBodyChannelsValue {
|
|
|
6432
6783
|
export interface UpdateIntegrationBodyChannelsValueConversation {
|
|
6433
6784
|
/**
|
|
6434
6785
|
*
|
|
6435
|
-
* @type {
|
|
6786
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation}
|
|
6436
6787
|
* @memberof UpdateIntegrationBodyChannelsValueConversation
|
|
6437
6788
|
*/
|
|
6438
|
-
'creation'?:
|
|
6789
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationChannelsValueConversationCreation;
|
|
6439
6790
|
/**
|
|
6440
6791
|
*
|
|
6441
6792
|
* @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
|
|
@@ -6581,10 +6932,10 @@ export type UpdateIntegrationBodyStatesValueTypeEnum = typeof UpdateIntegrationB
|
|
|
6581
6932
|
export interface UpdateIntegrationBodyUser {
|
|
6582
6933
|
/**
|
|
6583
6934
|
*
|
|
6584
|
-
* @type {
|
|
6935
|
+
* @type {GetPublicIntegrationByIdResponseIntegrationUserCreation}
|
|
6585
6936
|
* @memberof UpdateIntegrationBodyUser
|
|
6586
6937
|
*/
|
|
6587
|
-
'creation'?:
|
|
6938
|
+
'creation'?: GetPublicIntegrationByIdResponseIntegrationUserCreation;
|
|
6588
6939
|
/**
|
|
6589
6940
|
*
|
|
6590
6941
|
* @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
|
|
@@ -7663,6 +8014,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7663
8014
|
* @param {string} xBotId Bot id
|
|
7664
8015
|
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
7665
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.
|
|
7666
8018
|
* @param {string} [contentType] File content type
|
|
7667
8019
|
* @param {string} [contentLength] File content length
|
|
7668
8020
|
* @param {string} [xIntegrationId] Integration id
|
|
@@ -7672,7 +8024,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7672
8024
|
* @param {*} [options] Override http request option.
|
|
7673
8025
|
* @throws {RequiredError}
|
|
7674
8026
|
*/
|
|
7675
|
-
createFile: (xFilename: string, xBotId: string, xTags?: string, xAccessPolicies?: string, contentType?: string, contentLength?: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, 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>;
|
|
7676
8028
|
/**
|
|
7677
8029
|
* Create integration
|
|
7678
8030
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -8342,6 +8694,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8342
8694
|
* @throws {RequiredError}
|
|
8343
8695
|
*/
|
|
8344
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>;
|
|
8345
8711
|
/**
|
|
8346
8712
|
* Set a preference for the account
|
|
8347
8713
|
* @param {string} key Preference key
|
|
@@ -8577,6 +8943,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8577
8943
|
* @param {string} xBotId Bot id
|
|
8578
8944
|
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
8579
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.
|
|
8580
8947
|
* @param {string} [contentType] File content type
|
|
8581
8948
|
* @param {string} [contentLength] File content length
|
|
8582
8949
|
* @param {string} [xIntegrationId] Integration id
|
|
@@ -8586,7 +8953,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8586
8953
|
* @param {*} [options] Override http request option.
|
|
8587
8954
|
* @throws {RequiredError}
|
|
8588
8955
|
*/
|
|
8589
|
-
createFile(xFilename: string, xBotId: string, xTags?: string, xAccessPolicies?: string, contentType?: string, contentLength?: string, xIntegrationId?: string, xUserId?: string, xUserRole?: string, 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>>;
|
|
8590
8957
|
/**
|
|
8591
8958
|
* Create integration
|
|
8592
8959
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -9258,6 +9625,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9258
9625
|
* @throws {RequiredError}
|
|
9259
9626
|
*/
|
|
9260
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>>;
|
|
9261
9642
|
/**
|
|
9262
9643
|
* Set a preference for the account
|
|
9263
9644
|
* @param {string} key Preference key
|
|
@@ -10069,6 +10450,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10069
10450
|
* @throws {RequiredError}
|
|
10070
10451
|
*/
|
|
10071
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>;
|
|
10072
10460
|
/**
|
|
10073
10461
|
* Set a preference for the account
|
|
10074
10462
|
* @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
|
|
@@ -10392,6 +10780,12 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10392
10780
|
* @memberof DefaultApiCreateFile
|
|
10393
10781
|
*/
|
|
10394
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;
|
|
10395
10789
|
/**
|
|
10396
10790
|
* File content type
|
|
10397
10791
|
* @type {string}
|
|
@@ -11965,6 +12359,61 @@ export interface DefaultApiRunVrlRequest {
|
|
|
11965
12359
|
*/
|
|
11966
12360
|
readonly runVrlBody?: RunVrlBody;
|
|
11967
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
|
+
}
|
|
11968
12417
|
/**
|
|
11969
12418
|
* Request parameters for setAccountPreference operation in DefaultApi.
|
|
11970
12419
|
* @export
|
|
@@ -13084,6 +13533,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13084
13533
|
* @memberof DefaultApi
|
|
13085
13534
|
*/
|
|
13086
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>>;
|
|
13087
13544
|
/**
|
|
13088
13545
|
* Set a preference for the account
|
|
13089
13546
|
* @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
|