@botpress/client 0.16.0 → 0.16.2
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 +6 -6
- package/dist/bundle.cjs.map +2 -2
- package/dist/gen/api.d.ts +175 -115
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +1 -0
- 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 +2 -2
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +2 -2
- 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.27.
|
|
5
|
+
* The version of the OpenAPI document: 0.27.13
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -37,6 +37,12 @@ export interface Account {
|
|
|
37
37
|
* @memberof Account
|
|
38
38
|
*/
|
|
39
39
|
'displayName'?: string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof Account
|
|
44
|
+
*/
|
|
45
|
+
'emailVerified': boolean;
|
|
40
46
|
/**
|
|
41
47
|
*
|
|
42
48
|
* @type {string}
|
|
@@ -141,7 +147,7 @@ export interface AddParticipantResponse {
|
|
|
141
147
|
*/
|
|
142
148
|
export interface Bot {
|
|
143
149
|
/**
|
|
144
|
-
*
|
|
150
|
+
* Id of the [Bot](#schema_bot)
|
|
145
151
|
* @type {string}
|
|
146
152
|
* @memberof Bot
|
|
147
153
|
*/
|
|
@@ -159,7 +165,7 @@ export interface Bot {
|
|
|
159
165
|
*/
|
|
160
166
|
'updatedAt': string;
|
|
161
167
|
/**
|
|
162
|
-
*
|
|
168
|
+
* Signing secret of the [Bot](#schema_bot)
|
|
163
169
|
* @type {string}
|
|
164
170
|
* @memberof Bot
|
|
165
171
|
*/
|
|
@@ -333,31 +339,31 @@ export interface BotIntegrationsValue {
|
|
|
333
339
|
*/
|
|
334
340
|
'enabled': boolean;
|
|
335
341
|
/**
|
|
336
|
-
*
|
|
342
|
+
* Name of the [Integration](#schema_integration)
|
|
337
343
|
* @type {string}
|
|
338
344
|
* @memberof BotIntegrationsValue
|
|
339
345
|
*/
|
|
340
346
|
'name': string;
|
|
341
347
|
/**
|
|
342
|
-
*
|
|
348
|
+
* Version of the [Integration](#schema_integration)
|
|
343
349
|
* @type {string}
|
|
344
350
|
* @memberof BotIntegrationsValue
|
|
345
351
|
*/
|
|
346
352
|
'version': string;
|
|
347
353
|
/**
|
|
348
|
-
*
|
|
354
|
+
*
|
|
349
355
|
* @type {string}
|
|
350
356
|
* @memberof BotIntegrationsValue
|
|
351
357
|
*/
|
|
352
358
|
'webhookUrl': string;
|
|
353
359
|
/**
|
|
354
|
-
*
|
|
360
|
+
*
|
|
355
361
|
* @type {string}
|
|
356
362
|
* @memberof BotIntegrationsValue
|
|
357
363
|
*/
|
|
358
364
|
'webhookId': string;
|
|
359
365
|
/**
|
|
360
|
-
*
|
|
366
|
+
*
|
|
361
367
|
* @type {string}
|
|
362
368
|
* @memberof BotIntegrationsValue
|
|
363
369
|
*/
|
|
@@ -377,13 +383,13 @@ export interface BotIntegrationsValue {
|
|
|
377
383
|
*/
|
|
378
384
|
'status': BotIntegrationsValueStatusEnum;
|
|
379
385
|
/**
|
|
380
|
-
*
|
|
386
|
+
*
|
|
381
387
|
* @type {string}
|
|
382
388
|
* @memberof BotIntegrationsValue
|
|
383
389
|
*/
|
|
384
390
|
'statusReason': string | null;
|
|
385
391
|
/**
|
|
386
|
-
* ID of the [
|
|
392
|
+
* ID of the [Integration](#schema_integration)
|
|
387
393
|
* @type {string}
|
|
388
394
|
* @memberof BotIntegrationsValue
|
|
389
395
|
*/
|
|
@@ -461,12 +467,12 @@ export interface BotMediasInner {
|
|
|
461
467
|
export interface BotRecurringEventsValue {
|
|
462
468
|
/**
|
|
463
469
|
*
|
|
464
|
-
* @type {
|
|
470
|
+
* @type {CreateBotBodyRecurringEventsValueSchedule}
|
|
465
471
|
* @memberof BotRecurringEventsValue
|
|
466
472
|
*/
|
|
467
|
-
'schedule':
|
|
473
|
+
'schedule': CreateBotBodyRecurringEventsValueSchedule;
|
|
468
474
|
/**
|
|
469
|
-
*
|
|
475
|
+
*
|
|
470
476
|
* @type {string}
|
|
471
477
|
* @memberof BotRecurringEventsValue
|
|
472
478
|
*/
|
|
@@ -492,19 +498,6 @@ export interface BotRecurringEventsValue {
|
|
|
492
498
|
*/
|
|
493
499
|
'lastFailureReason': string | null;
|
|
494
500
|
}
|
|
495
|
-
/**
|
|
496
|
-
*
|
|
497
|
-
* @export
|
|
498
|
-
* @interface BotRecurringEventsValueSchedule
|
|
499
|
-
*/
|
|
500
|
-
export interface BotRecurringEventsValueSchedule {
|
|
501
|
-
/**
|
|
502
|
-
* Type of the task
|
|
503
|
-
* @type {string}
|
|
504
|
-
* @memberof BotRecurringEventsValueSchedule
|
|
505
|
-
*/
|
|
506
|
-
'cron': string;
|
|
507
|
-
}
|
|
508
501
|
/**
|
|
509
502
|
* User object configuration
|
|
510
503
|
* @export
|
|
@@ -559,7 +552,7 @@ export interface BreakDownWorkspaceUsageByBotResponseDataInner {
|
|
|
559
552
|
*/
|
|
560
553
|
export interface CallActionBody {
|
|
561
554
|
/**
|
|
562
|
-
*
|
|
555
|
+
* Type of the action
|
|
563
556
|
* @type {string}
|
|
564
557
|
* @memberof CallActionBody
|
|
565
558
|
*/
|
|
@@ -794,7 +787,7 @@ export interface ConfigureIntegrationBody {
|
|
|
794
787
|
*/
|
|
795
788
|
export interface Conversation {
|
|
796
789
|
/**
|
|
797
|
-
*
|
|
790
|
+
* Id of the [Conversation](#schema_conversation)
|
|
798
791
|
* @type {string}
|
|
799
792
|
* @memberof Conversation
|
|
800
793
|
*/
|
|
@@ -992,7 +985,7 @@ export interface CreateBotBodyRecurringEventsValue {
|
|
|
992
985
|
*/
|
|
993
986
|
'schedule': CreateBotBodyRecurringEventsValueSchedule;
|
|
994
987
|
/**
|
|
995
|
-
*
|
|
988
|
+
*
|
|
996
989
|
* @type {string}
|
|
997
990
|
* @memberof CreateBotBodyRecurringEventsValue
|
|
998
991
|
*/
|
|
@@ -1013,7 +1006,7 @@ export interface CreateBotBodyRecurringEventsValue {
|
|
|
1013
1006
|
*/
|
|
1014
1007
|
export interface CreateBotBodyRecurringEventsValueSchedule {
|
|
1015
1008
|
/**
|
|
1016
|
-
*
|
|
1009
|
+
*
|
|
1017
1010
|
* @type {string}
|
|
1018
1011
|
* @memberof CreateBotBodyRecurringEventsValueSchedule
|
|
1019
1012
|
*/
|
|
@@ -1103,7 +1096,7 @@ export interface CreateBotResponse {
|
|
|
1103
1096
|
*/
|
|
1104
1097
|
export interface CreateConversationBody {
|
|
1105
1098
|
/**
|
|
1106
|
-
*
|
|
1099
|
+
* Channel name
|
|
1107
1100
|
* @type {string}
|
|
1108
1101
|
* @memberof CreateConversationBody
|
|
1109
1102
|
*/
|
|
@@ -1144,7 +1137,7 @@ export interface CreateConversationResponse {
|
|
|
1144
1137
|
*/
|
|
1145
1138
|
export interface CreateEventBody {
|
|
1146
1139
|
/**
|
|
1147
|
-
*
|
|
1140
|
+
* Type of the [Event](#schema_event).
|
|
1148
1141
|
* @type {string}
|
|
1149
1142
|
* @memberof CreateEventBody
|
|
1150
1143
|
*/
|
|
@@ -1435,13 +1428,13 @@ export interface CreateIntegrationApiKeyResponse {
|
|
|
1435
1428
|
*/
|
|
1436
1429
|
export interface CreateIntegrationBody {
|
|
1437
1430
|
/**
|
|
1438
|
-
*
|
|
1431
|
+
* Name of the [Integration](#schema_integration)
|
|
1439
1432
|
* @type {string}
|
|
1440
1433
|
* @memberof CreateIntegrationBody
|
|
1441
1434
|
*/
|
|
1442
1435
|
'name': string;
|
|
1443
1436
|
/**
|
|
1444
|
-
*
|
|
1437
|
+
* Version of the [Integration](#schema_integration)
|
|
1445
1438
|
* @type {string}
|
|
1446
1439
|
* @memberof CreateIntegrationBody
|
|
1447
1440
|
*/
|
|
@@ -1655,7 +1648,7 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1655
1648
|
*/
|
|
1656
1649
|
'required'?: boolean;
|
|
1657
1650
|
/**
|
|
1658
|
-
*
|
|
1651
|
+
*
|
|
1659
1652
|
* @type {string}
|
|
1660
1653
|
* @memberof CreateIntegrationBodyConfigurationIdentifier
|
|
1661
1654
|
*/
|
|
@@ -1668,13 +1661,13 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1668
1661
|
*/
|
|
1669
1662
|
export interface CreateIntegrationBodyIdentifier {
|
|
1670
1663
|
/**
|
|
1671
|
-
*
|
|
1664
|
+
*
|
|
1672
1665
|
* @type {string}
|
|
1673
1666
|
* @memberof CreateIntegrationBodyIdentifier
|
|
1674
1667
|
*/
|
|
1675
1668
|
'fallbackHandlerScript'?: string;
|
|
1676
1669
|
/**
|
|
1677
|
-
*
|
|
1670
|
+
*
|
|
1678
1671
|
* @type {string}
|
|
1679
1672
|
* @memberof CreateIntegrationBodyIdentifier
|
|
1680
1673
|
*/
|
|
@@ -1729,25 +1722,25 @@ export interface CreateMessageBody {
|
|
|
1729
1722
|
[key: string]: any;
|
|
1730
1723
|
};
|
|
1731
1724
|
/**
|
|
1732
|
-
* User
|
|
1725
|
+
* ID of the [User](#schema_user)
|
|
1733
1726
|
* @type {string}
|
|
1734
1727
|
* @memberof CreateMessageBody
|
|
1735
1728
|
*/
|
|
1736
1729
|
'userId': string;
|
|
1737
1730
|
/**
|
|
1738
|
-
*
|
|
1731
|
+
* ID of the [Conversation](#schema_conversation)
|
|
1739
1732
|
* @type {string}
|
|
1740
1733
|
* @memberof CreateMessageBody
|
|
1741
1734
|
*/
|
|
1742
1735
|
'conversationId': string;
|
|
1743
1736
|
/**
|
|
1744
|
-
*
|
|
1737
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
1745
1738
|
* @type {string}
|
|
1746
1739
|
* @memberof CreateMessageBody
|
|
1747
1740
|
*/
|
|
1748
1741
|
'type': string;
|
|
1749
1742
|
/**
|
|
1750
|
-
* Set of [Tags](
|
|
1743
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
1751
1744
|
* @type {{ [key: string]: string; }}
|
|
1752
1745
|
* @memberof CreateMessageBody
|
|
1753
1746
|
*/
|
|
@@ -1768,7 +1761,7 @@ export interface CreateMessageBody {
|
|
|
1768
1761
|
*/
|
|
1769
1762
|
export interface CreateMessageBodySchedule {
|
|
1770
1763
|
/**
|
|
1771
|
-
* When the [
|
|
1764
|
+
* When the [Message](#schema_message) will be sent, in the ISO 8601 format
|
|
1772
1765
|
* @type {string}
|
|
1773
1766
|
* @memberof CreateMessageBodySchedule
|
|
1774
1767
|
*/
|
|
@@ -1963,7 +1956,7 @@ export interface CreateTaskBody {
|
|
|
1963
1956
|
*/
|
|
1964
1957
|
'description'?: string;
|
|
1965
1958
|
/**
|
|
1966
|
-
*
|
|
1959
|
+
* Type of the task
|
|
1967
1960
|
* @type {string}
|
|
1968
1961
|
* @memberof CreateTaskBody
|
|
1969
1962
|
*/
|
|
@@ -2037,7 +2030,7 @@ export interface CreateUserBody {
|
|
|
2037
2030
|
[key: string]: string;
|
|
2038
2031
|
};
|
|
2039
2032
|
/**
|
|
2040
|
-
* [DEPRECATED] To create a
|
|
2033
|
+
* [DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.
|
|
2041
2034
|
* @type {string}
|
|
2042
2035
|
* @memberof CreateUserBody
|
|
2043
2036
|
* @deprecated
|
|
@@ -2378,7 +2371,7 @@ export interface DuplicateTableResponse {
|
|
|
2378
2371
|
*/
|
|
2379
2372
|
export interface Event {
|
|
2380
2373
|
/**
|
|
2381
|
-
*
|
|
2374
|
+
* Id of the [Event](#schema_event)
|
|
2382
2375
|
* @type {string}
|
|
2383
2376
|
* @memberof Event
|
|
2384
2377
|
*/
|
|
@@ -2390,7 +2383,7 @@ export interface Event {
|
|
|
2390
2383
|
*/
|
|
2391
2384
|
'createdAt': string;
|
|
2392
2385
|
/**
|
|
2393
|
-
* Type of the
|
|
2386
|
+
* Type of the [Event](#schema_event).
|
|
2394
2387
|
* @type {string}
|
|
2395
2388
|
* @memberof Event
|
|
2396
2389
|
*/
|
|
@@ -2586,6 +2579,12 @@ export interface GetAccountResponseAccount {
|
|
|
2586
2579
|
* @memberof GetAccountResponseAccount
|
|
2587
2580
|
*/
|
|
2588
2581
|
'displayName'?: string;
|
|
2582
|
+
/**
|
|
2583
|
+
*
|
|
2584
|
+
* @type {boolean}
|
|
2585
|
+
* @memberof GetAccountResponseAccount
|
|
2586
|
+
*/
|
|
2587
|
+
'emailVerified': boolean;
|
|
2589
2588
|
/**
|
|
2590
2589
|
*
|
|
2591
2590
|
* @type {string}
|
|
@@ -3094,7 +3093,7 @@ export interface GetMessageResponse {
|
|
|
3094
3093
|
*/
|
|
3095
3094
|
export interface GetOrCreateConversationBody {
|
|
3096
3095
|
/**
|
|
3097
|
-
*
|
|
3096
|
+
* Channel name
|
|
3098
3097
|
* @type {string}
|
|
3099
3098
|
* @memberof GetOrCreateConversationBody
|
|
3100
3099
|
*/
|
|
@@ -3143,25 +3142,25 @@ export interface GetOrCreateMessageBody {
|
|
|
3143
3142
|
[key: string]: any;
|
|
3144
3143
|
};
|
|
3145
3144
|
/**
|
|
3146
|
-
* User
|
|
3145
|
+
* ID of the [User](#schema_user)
|
|
3147
3146
|
* @type {string}
|
|
3148
3147
|
* @memberof GetOrCreateMessageBody
|
|
3149
3148
|
*/
|
|
3150
3149
|
'userId': string;
|
|
3151
3150
|
/**
|
|
3152
|
-
*
|
|
3151
|
+
* ID of the [Conversation](#schema_conversation)
|
|
3153
3152
|
* @type {string}
|
|
3154
3153
|
* @memberof GetOrCreateMessageBody
|
|
3155
3154
|
*/
|
|
3156
3155
|
'conversationId': string;
|
|
3157
3156
|
/**
|
|
3158
|
-
*
|
|
3157
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
3159
3158
|
* @type {string}
|
|
3160
3159
|
* @memberof GetOrCreateMessageBody
|
|
3161
3160
|
*/
|
|
3162
3161
|
'type': string;
|
|
3163
3162
|
/**
|
|
3164
|
-
* Set of [Tags](
|
|
3163
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
3165
3164
|
* @type {{ [key: string]: string; }}
|
|
3166
3165
|
* @memberof GetOrCreateMessageBody
|
|
3167
3166
|
*/
|
|
@@ -3269,7 +3268,7 @@ export interface GetOrCreateUserBody {
|
|
|
3269
3268
|
[key: string]: string;
|
|
3270
3269
|
};
|
|
3271
3270
|
/**
|
|
3272
|
-
* [DEPRECATED] To create a
|
|
3271
|
+
* [DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.
|
|
3273
3272
|
* @type {string}
|
|
3274
3273
|
* @memberof GetOrCreateUserBody
|
|
3275
3274
|
* @deprecated
|
|
@@ -3368,7 +3367,7 @@ export interface GetPublicIntegrationByIdResponse {
|
|
|
3368
3367
|
*/
|
|
3369
3368
|
export interface GetPublicIntegrationByIdResponseIntegration {
|
|
3370
3369
|
/**
|
|
3371
|
-
*
|
|
3370
|
+
* ID of the [Integration](#schema_integration)
|
|
3372
3371
|
* @type {string}
|
|
3373
3372
|
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3374
3373
|
*/
|
|
@@ -3392,19 +3391,19 @@ export interface GetPublicIntegrationByIdResponseIntegration {
|
|
|
3392
3391
|
*/
|
|
3393
3392
|
'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
|
|
3394
3393
|
/**
|
|
3395
|
-
*
|
|
3394
|
+
* URL of the [Integration](#schema_integration)
|
|
3396
3395
|
* @type {string}
|
|
3397
3396
|
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3398
3397
|
*/
|
|
3399
3398
|
'url': string;
|
|
3400
3399
|
/**
|
|
3401
|
-
*
|
|
3400
|
+
* Name of the [Integration](#schema_integration)
|
|
3402
3401
|
* @type {string}
|
|
3403
3402
|
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3404
3403
|
*/
|
|
3405
3404
|
'name': string;
|
|
3406
3405
|
/**
|
|
3407
|
-
*
|
|
3406
|
+
* Version of the [Integration](#schema_integration)
|
|
3408
3407
|
* @type {string}
|
|
3409
3408
|
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3410
3409
|
*/
|
|
@@ -3712,7 +3711,7 @@ export interface GetPublicIntegrationByIdResponseIntegrationConfiguration {
|
|
|
3712
3711
|
*/
|
|
3713
3712
|
export interface GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier {
|
|
3714
3713
|
/**
|
|
3715
|
-
*
|
|
3714
|
+
*
|
|
3716
3715
|
* @type {string}
|
|
3717
3716
|
* @memberof GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier
|
|
3718
3717
|
*/
|
|
@@ -4078,6 +4077,52 @@ export interface GetUserResponse {
|
|
|
4078
4077
|
*/
|
|
4079
4078
|
'user': User;
|
|
4080
4079
|
}
|
|
4080
|
+
/**
|
|
4081
|
+
*
|
|
4082
|
+
* @export
|
|
4083
|
+
* @interface GetWorkspaceMemberResponse
|
|
4084
|
+
*/
|
|
4085
|
+
export interface GetWorkspaceMemberResponse {
|
|
4086
|
+
/**
|
|
4087
|
+
*
|
|
4088
|
+
* @type {string}
|
|
4089
|
+
* @memberof GetWorkspaceMemberResponse
|
|
4090
|
+
*/
|
|
4091
|
+
'id': string;
|
|
4092
|
+
/**
|
|
4093
|
+
*
|
|
4094
|
+
* @type {string}
|
|
4095
|
+
* @memberof GetWorkspaceMemberResponse
|
|
4096
|
+
*/
|
|
4097
|
+
'userId'?: string;
|
|
4098
|
+
/**
|
|
4099
|
+
*
|
|
4100
|
+
* @type {string}
|
|
4101
|
+
* @memberof GetWorkspaceMemberResponse
|
|
4102
|
+
*/
|
|
4103
|
+
'email': string;
|
|
4104
|
+
/**
|
|
4105
|
+
*
|
|
4106
|
+
* @type {string}
|
|
4107
|
+
* @memberof GetWorkspaceMemberResponse
|
|
4108
|
+
*/
|
|
4109
|
+
'createdAt': string;
|
|
4110
|
+
/**
|
|
4111
|
+
*
|
|
4112
|
+
* @type {string}
|
|
4113
|
+
* @memberof GetWorkspaceMemberResponse
|
|
4114
|
+
*/
|
|
4115
|
+
'role': GetWorkspaceMemberResponseRoleEnum;
|
|
4116
|
+
}
|
|
4117
|
+
export declare const GetWorkspaceMemberResponseRoleEnum: {
|
|
4118
|
+
readonly Viewer: "viewer";
|
|
4119
|
+
readonly Billing: "billing";
|
|
4120
|
+
readonly Developer: "developer";
|
|
4121
|
+
readonly Manager: "manager";
|
|
4122
|
+
readonly Administrator: "administrator";
|
|
4123
|
+
readonly Owner: "owner";
|
|
4124
|
+
};
|
|
4125
|
+
export type GetWorkspaceMemberResponseRoleEnum = typeof GetWorkspaceMemberResponseRoleEnum[keyof typeof GetWorkspaceMemberResponseRoleEnum];
|
|
4081
4126
|
/**
|
|
4082
4127
|
*
|
|
4083
4128
|
* @export
|
|
@@ -4270,7 +4315,7 @@ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[k
|
|
|
4270
4315
|
*/
|
|
4271
4316
|
export interface Integration {
|
|
4272
4317
|
/**
|
|
4273
|
-
* ID of the [
|
|
4318
|
+
* ID of the [Integration](#schema_integration)
|
|
4274
4319
|
* @type {string}
|
|
4275
4320
|
* @memberof Integration
|
|
4276
4321
|
*/
|
|
@@ -4294,19 +4339,19 @@ export interface Integration {
|
|
|
4294
4339
|
*/
|
|
4295
4340
|
'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
|
|
4296
4341
|
/**
|
|
4297
|
-
*
|
|
4342
|
+
* URL of the [Integration](#schema_integration)
|
|
4298
4343
|
* @type {string}
|
|
4299
4344
|
* @memberof Integration
|
|
4300
4345
|
*/
|
|
4301
4346
|
'url': string;
|
|
4302
4347
|
/**
|
|
4303
|
-
*
|
|
4348
|
+
* Name of the [Integration](#schema_integration)
|
|
4304
4349
|
* @type {string}
|
|
4305
4350
|
* @memberof Integration
|
|
4306
4351
|
*/
|
|
4307
4352
|
'name': string;
|
|
4308
4353
|
/**
|
|
4309
|
-
*
|
|
4354
|
+
* Version of the [Integration](#schema_integration)
|
|
4310
4355
|
* @type {string}
|
|
4311
4356
|
* @memberof Integration
|
|
4312
4357
|
*/
|
|
@@ -4765,7 +4810,7 @@ export interface ListBotsResponse {
|
|
|
4765
4810
|
*/
|
|
4766
4811
|
export interface ListBotsResponseBotsInner {
|
|
4767
4812
|
/**
|
|
4768
|
-
*
|
|
4813
|
+
* Id of the [Bot](#schema_bot)
|
|
4769
4814
|
* @type {string}
|
|
4770
4815
|
* @memberof ListBotsResponseBotsInner
|
|
4771
4816
|
*/
|
|
@@ -5005,19 +5050,19 @@ export interface ListIntegrationsResponse {
|
|
|
5005
5050
|
*/
|
|
5006
5051
|
export interface ListIntegrationsResponseIntegrationsInner {
|
|
5007
5052
|
/**
|
|
5008
|
-
*
|
|
5053
|
+
* ID of the [Integration](#schema_integration)
|
|
5009
5054
|
* @type {string}
|
|
5010
5055
|
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
5011
5056
|
*/
|
|
5012
5057
|
'id': string;
|
|
5013
5058
|
/**
|
|
5014
|
-
*
|
|
5059
|
+
* Name of the [Integration](#schema_integration)
|
|
5015
5060
|
* @type {string}
|
|
5016
5061
|
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
5017
5062
|
*/
|
|
5018
5063
|
'name': string;
|
|
5019
5064
|
/**
|
|
5020
|
-
*
|
|
5065
|
+
* Version of the [Integration](#schema_integration)
|
|
5021
5066
|
* @type {string}
|
|
5022
5067
|
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
5023
5068
|
*/
|
|
@@ -5161,19 +5206,19 @@ export interface ListPublicIntegrationsResponse {
|
|
|
5161
5206
|
*/
|
|
5162
5207
|
export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
5163
5208
|
/**
|
|
5164
|
-
*
|
|
5209
|
+
* ID of the [Integration](#schema_integration)
|
|
5165
5210
|
* @type {string}
|
|
5166
5211
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
5167
5212
|
*/
|
|
5168
5213
|
'id': string;
|
|
5169
5214
|
/**
|
|
5170
|
-
*
|
|
5215
|
+
* Name of the [Integration](#schema_integration)
|
|
5171
5216
|
* @type {string}
|
|
5172
5217
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
5173
5218
|
*/
|
|
5174
5219
|
'name': string;
|
|
5175
5220
|
/**
|
|
5176
|
-
*
|
|
5221
|
+
* Version of the [Integration](#schema_integration)
|
|
5177
5222
|
* @type {string}
|
|
5178
5223
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
5179
5224
|
*/
|
|
@@ -5566,7 +5611,7 @@ export interface ListWorkspacesResponse {
|
|
|
5566
5611
|
*/
|
|
5567
5612
|
export interface Message {
|
|
5568
5613
|
/**
|
|
5569
|
-
*
|
|
5614
|
+
* Id of the [Message](#schema_message)
|
|
5570
5615
|
* @type {string}
|
|
5571
5616
|
* @memberof Message
|
|
5572
5617
|
*/
|
|
@@ -5578,7 +5623,7 @@ export interface Message {
|
|
|
5578
5623
|
*/
|
|
5579
5624
|
'createdAt': string;
|
|
5580
5625
|
/**
|
|
5581
|
-
* Type of the
|
|
5626
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
5582
5627
|
* @type {string}
|
|
5583
5628
|
* @memberof Message
|
|
5584
5629
|
*/
|
|
@@ -5598,7 +5643,7 @@ export interface Message {
|
|
|
5598
5643
|
*/
|
|
5599
5644
|
'direction': MessageDirectionEnum;
|
|
5600
5645
|
/**
|
|
5601
|
-
* ID of the [
|
|
5646
|
+
* ID of the [User](#schema_user)
|
|
5602
5647
|
* @type {string}
|
|
5603
5648
|
* @memberof Message
|
|
5604
5649
|
*/
|
|
@@ -6074,7 +6119,7 @@ export interface SetWorkspacePaymentMethodResponsePaymentMethod {
|
|
|
6074
6119
|
*/
|
|
6075
6120
|
export interface State {
|
|
6076
6121
|
/**
|
|
6077
|
-
*
|
|
6122
|
+
* Id of the [State](#schema_state)
|
|
6078
6123
|
* @type {string}
|
|
6079
6124
|
* @memberof State
|
|
6080
6125
|
*/
|
|
@@ -6092,7 +6137,7 @@ export interface State {
|
|
|
6092
6137
|
*/
|
|
6093
6138
|
'updatedAt': string;
|
|
6094
6139
|
/**
|
|
6095
|
-
*
|
|
6140
|
+
* Id of the [Bot](#schema_bot)
|
|
6096
6141
|
* @type {string}
|
|
6097
6142
|
* @memberof State
|
|
6098
6143
|
*/
|
|
@@ -6110,7 +6155,7 @@ export interface State {
|
|
|
6110
6155
|
*/
|
|
6111
6156
|
'userId'?: string;
|
|
6112
6157
|
/**
|
|
6113
|
-
*
|
|
6158
|
+
* Name of the [State](#schema_state) which is declared inside the bot definition
|
|
6114
6159
|
* @type {string}
|
|
6115
6160
|
* @memberof State
|
|
6116
6161
|
*/
|
|
@@ -6325,7 +6370,7 @@ export interface TableSchemaPropertiesValueXZui {
|
|
|
6325
6370
|
*/
|
|
6326
6371
|
export interface Task {
|
|
6327
6372
|
/**
|
|
6328
|
-
*
|
|
6373
|
+
* Id of the [Task](#schema_task)
|
|
6329
6374
|
* @type {string}
|
|
6330
6375
|
* @memberof Task
|
|
6331
6376
|
*/
|
|
@@ -6474,6 +6519,12 @@ export interface UpdateAccountBody {
|
|
|
6474
6519
|
* @memberof UpdateAccountBody
|
|
6475
6520
|
*/
|
|
6476
6521
|
'profilePicture'?: string;
|
|
6522
|
+
/**
|
|
6523
|
+
*
|
|
6524
|
+
* @type {boolean}
|
|
6525
|
+
* @memberof UpdateAccountBody
|
|
6526
|
+
*/
|
|
6527
|
+
'refresh'?: boolean;
|
|
6477
6528
|
}
|
|
6478
6529
|
/**
|
|
6479
6530
|
*
|
|
@@ -6703,7 +6754,7 @@ export interface UpdateBotBodyRecurringEventsValue {
|
|
|
6703
6754
|
*/
|
|
6704
6755
|
'schedule': CreateBotBodyRecurringEventsValueSchedule;
|
|
6705
6756
|
/**
|
|
6706
|
-
*
|
|
6757
|
+
*
|
|
6707
6758
|
* @type {string}
|
|
6708
6759
|
* @memberof UpdateBotBodyRecurringEventsValue
|
|
6709
6760
|
*/
|
|
@@ -7104,7 +7155,7 @@ export interface UpdateIntegrationBodyConfiguration {
|
|
|
7104
7155
|
*/
|
|
7105
7156
|
export interface UpdateIntegrationBodyConfigurationIdentifier {
|
|
7106
7157
|
/**
|
|
7107
|
-
*
|
|
7158
|
+
*
|
|
7108
7159
|
* @type {string}
|
|
7109
7160
|
* @memberof UpdateIntegrationBodyConfigurationIdentifier
|
|
7110
7161
|
*/
|
|
@@ -7150,13 +7201,13 @@ export interface UpdateIntegrationBodyEntitiesValue {
|
|
|
7150
7201
|
*/
|
|
7151
7202
|
export interface UpdateIntegrationBodyIdentifier {
|
|
7152
7203
|
/**
|
|
7153
|
-
*
|
|
7204
|
+
*
|
|
7154
7205
|
* @type {string}
|
|
7155
7206
|
* @memberof UpdateIntegrationBodyIdentifier
|
|
7156
7207
|
*/
|
|
7157
7208
|
'extractScript'?: string | null;
|
|
7158
7209
|
/**
|
|
7159
|
-
*
|
|
7210
|
+
*
|
|
7160
7211
|
* @type {string}
|
|
7161
7212
|
* @memberof UpdateIntegrationBodyIdentifier
|
|
7162
7213
|
*/
|
|
@@ -7230,7 +7281,7 @@ export interface UpdateIntegrationResponse {
|
|
|
7230
7281
|
*/
|
|
7231
7282
|
export interface UpdateMessageBody {
|
|
7232
7283
|
/**
|
|
7233
|
-
* Set of [Tags](
|
|
7284
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
7234
7285
|
* @type {{ [key: string]: string; }}
|
|
7235
7286
|
* @memberof UpdateMessageBody
|
|
7236
7287
|
*/
|
|
@@ -7977,7 +8028,7 @@ export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
|
|
|
7977
8028
|
*/
|
|
7978
8029
|
export interface User {
|
|
7979
8030
|
/**
|
|
7980
|
-
*
|
|
8031
|
+
* Id of the [User](#schema_user)
|
|
7981
8032
|
* @type {string}
|
|
7982
8033
|
* @memberof User
|
|
7983
8034
|
*/
|
|
@@ -8709,6 +8760,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8709
8760
|
* @throws {RequiredError}
|
|
8710
8761
|
*/
|
|
8711
8762
|
getWorkspace: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8763
|
+
/**
|
|
8764
|
+
* Get details of the account authenticating with this endpoint.
|
|
8765
|
+
* @param {*} [options] Override http request option.
|
|
8766
|
+
* @throws {RequiredError}
|
|
8767
|
+
*/
|
|
8768
|
+
getWorkspaceMember: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8712
8769
|
/**
|
|
8713
8770
|
* Get workspace quota
|
|
8714
8771
|
* @param {string} id Workspace ID
|
|
@@ -8784,13 +8841,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8784
8841
|
listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, status?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8785
8842
|
/**
|
|
8786
8843
|
* List files for bot
|
|
8787
|
-
* @param {string} botId Bot ID
|
|
8788
8844
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
8789
8845
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
8790
8846
|
* @param {*} [options] Override http request option.
|
|
8791
8847
|
* @throws {RequiredError}
|
|
8792
8848
|
*/
|
|
8793
|
-
listFiles: (
|
|
8849
|
+
listFiles: (nextToken?: string, tags?: {
|
|
8794
8850
|
[key: string]: string;
|
|
8795
8851
|
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8796
8852
|
/**
|
|
@@ -8811,7 +8867,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8811
8867
|
*/
|
|
8812
8868
|
listIntegrations: (nextToken?: string, name?: string, version?: string, dev?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8813
8869
|
/**
|
|
8814
|
-
* Retrieves a list of [
|
|
8870
|
+
* Retrieves a list of [Message](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
8815
8871
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
8816
8872
|
* @param {string} [conversationId] Conversation id
|
|
8817
8873
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
@@ -8854,7 +8910,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8854
8910
|
[key: string]: string;
|
|
8855
8911
|
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8856
8912
|
/**
|
|
8857
|
-
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
8913
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
8858
8914
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
8859
8915
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
8860
8916
|
* @param {string} [conversationId] Conversation id
|
|
@@ -8877,7 +8933,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8877
8933
|
*/
|
|
8878
8934
|
listUsageHistory: (type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8879
8935
|
/**
|
|
8880
|
-
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
8936
|
+
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
8881
8937
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
8882
8938
|
* @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
|
|
8883
8939
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
@@ -8960,7 +9016,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8960
9016
|
runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8961
9017
|
/**
|
|
8962
9018
|
* Search files
|
|
8963
|
-
* @param {string} botId Bot ID
|
|
8964
9019
|
* @param {string} query Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
|
|
8965
9020
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
8966
9021
|
* @param {number} [contextDepth] The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
|
|
@@ -8968,7 +9023,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8968
9023
|
* @param {*} [options] Override http request option.
|
|
8969
9024
|
* @throws {RequiredError}
|
|
8970
9025
|
*/
|
|
8971
|
-
searchFiles: (
|
|
9026
|
+
searchFiles: (query: string, tags?: {
|
|
8972
9027
|
[key: string]: string;
|
|
8973
9028
|
} | undefined, contextDepth?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8974
9029
|
/**
|
|
@@ -9635,6 +9690,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9635
9690
|
* @throws {RequiredError}
|
|
9636
9691
|
*/
|
|
9637
9692
|
getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
|
|
9693
|
+
/**
|
|
9694
|
+
* Get details of the account authenticating with this endpoint.
|
|
9695
|
+
* @param {*} [options] Override http request option.
|
|
9696
|
+
* @throws {RequiredError}
|
|
9697
|
+
*/
|
|
9698
|
+
getWorkspaceMember(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceMemberResponse>>;
|
|
9638
9699
|
/**
|
|
9639
9700
|
* Get workspace quota
|
|
9640
9701
|
* @param {string} id Workspace ID
|
|
@@ -9710,13 +9771,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9710
9771
|
listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, status?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
|
|
9711
9772
|
/**
|
|
9712
9773
|
* List files for bot
|
|
9713
|
-
* @param {string} botId Bot ID
|
|
9714
9774
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9715
9775
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
9716
9776
|
* @param {*} [options] Override http request option.
|
|
9717
9777
|
* @throws {RequiredError}
|
|
9718
9778
|
*/
|
|
9719
|
-
listFiles(
|
|
9779
|
+
listFiles(nextToken?: string, tags?: {
|
|
9720
9780
|
[key: string]: string;
|
|
9721
9781
|
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
|
|
9722
9782
|
/**
|
|
@@ -9737,7 +9797,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9737
9797
|
*/
|
|
9738
9798
|
listIntegrations(nextToken?: string, name?: string, version?: string, dev?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationsResponse>>;
|
|
9739
9799
|
/**
|
|
9740
|
-
* Retrieves a list of [
|
|
9800
|
+
* Retrieves a list of [Message](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
9741
9801
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9742
9802
|
* @param {string} [conversationId] Conversation id
|
|
9743
9803
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
@@ -9780,7 +9840,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9780
9840
|
[key: string]: string;
|
|
9781
9841
|
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTablesResponse>>;
|
|
9782
9842
|
/**
|
|
9783
|
-
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
9843
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
9784
9844
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9785
9845
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
9786
9846
|
* @param {string} [conversationId] Conversation id
|
|
@@ -9803,7 +9863,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9803
9863
|
*/
|
|
9804
9864
|
listUsageHistory(type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsageHistoryResponse>>;
|
|
9805
9865
|
/**
|
|
9806
|
-
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
9866
|
+
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
9807
9867
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9808
9868
|
* @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
|
|
9809
9869
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
@@ -9886,7 +9946,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9886
9946
|
runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
|
|
9887
9947
|
/**
|
|
9888
9948
|
* Search files
|
|
9889
|
-
* @param {string} botId Bot ID
|
|
9890
9949
|
* @param {string} query Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
|
|
9891
9950
|
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
9892
9951
|
* @param {number} [contextDepth] The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
|
|
@@ -9894,7 +9953,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9894
9953
|
* @param {*} [options] Override http request option.
|
|
9895
9954
|
* @throws {RequiredError}
|
|
9896
9955
|
*/
|
|
9897
|
-
searchFiles(
|
|
9956
|
+
searchFiles(query: string, tags?: {
|
|
9898
9957
|
[key: string]: string;
|
|
9899
9958
|
} | undefined, contextDepth?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
|
|
9900
9959
|
/**
|
|
@@ -10530,6 +10589,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10530
10589
|
* @throws {RequiredError}
|
|
10531
10590
|
*/
|
|
10532
10591
|
getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
|
|
10592
|
+
/**
|
|
10593
|
+
* Get details of the account authenticating with this endpoint.
|
|
10594
|
+
* @param {*} [options] Override http request option.
|
|
10595
|
+
* @throws {RequiredError}
|
|
10596
|
+
*/
|
|
10597
|
+
getWorkspaceMember(options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceMemberResponse>;
|
|
10533
10598
|
/**
|
|
10534
10599
|
* Get workspace quota
|
|
10535
10600
|
* @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
|
|
@@ -10592,7 +10657,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10592
10657
|
* @param {*} [options] Override http request option.
|
|
10593
10658
|
* @throws {RequiredError}
|
|
10594
10659
|
*/
|
|
10595
|
-
listFiles(requestParameters
|
|
10660
|
+
listFiles(requestParameters?: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
|
|
10596
10661
|
/**
|
|
10597
10662
|
* List IAKs (Integration Api Keys) of an integration
|
|
10598
10663
|
* @param {DefaultApiListIntegrationApiKeysRequest} requestParameters Request parameters.
|
|
@@ -10608,7 +10673,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10608
10673
|
*/
|
|
10609
10674
|
listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListIntegrationsResponse>;
|
|
10610
10675
|
/**
|
|
10611
|
-
* Retrieves a list of [
|
|
10676
|
+
* Retrieves a list of [Message](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
10612
10677
|
* @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
|
|
10613
10678
|
* @param {*} [options] Override http request option.
|
|
10614
10679
|
* @throws {RequiredError}
|
|
@@ -10642,7 +10707,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10642
10707
|
*/
|
|
10643
10708
|
listTables(requestParameters?: DefaultApiListTablesRequest, options?: AxiosRequestConfig): AxiosPromise<ListTablesResponse>;
|
|
10644
10709
|
/**
|
|
10645
|
-
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
10710
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
10646
10711
|
* @param {DefaultApiListTasksRequest} requestParameters Request parameters.
|
|
10647
10712
|
* @param {*} [options] Override http request option.
|
|
10648
10713
|
* @throws {RequiredError}
|
|
@@ -10656,7 +10721,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10656
10721
|
*/
|
|
10657
10722
|
listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsageHistoryResponse>;
|
|
10658
10723
|
/**
|
|
10659
|
-
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
10724
|
+
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
10660
10725
|
* @param {DefaultApiListUsersRequest} requestParameters Request parameters.
|
|
10661
10726
|
* @param {*} [options] Override http request option.
|
|
10662
10727
|
* @throws {RequiredError}
|
|
@@ -12118,12 +12183,6 @@ export interface DefaultApiListEventsRequest {
|
|
|
12118
12183
|
* @interface DefaultApiListFilesRequest
|
|
12119
12184
|
*/
|
|
12120
12185
|
export interface DefaultApiListFilesRequest {
|
|
12121
|
-
/**
|
|
12122
|
-
* Bot ID
|
|
12123
|
-
* @type {string}
|
|
12124
|
-
* @memberof DefaultApiListFiles
|
|
12125
|
-
*/
|
|
12126
|
-
readonly botId: string;
|
|
12127
12186
|
/**
|
|
12128
12187
|
* Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
12129
12188
|
* @type {string}
|
|
@@ -12537,12 +12596,6 @@ export interface DefaultApiRunVrlRequest {
|
|
|
12537
12596
|
* @interface DefaultApiSearchFilesRequest
|
|
12538
12597
|
*/
|
|
12539
12598
|
export interface DefaultApiSearchFilesRequest {
|
|
12540
|
-
/**
|
|
12541
|
-
* Bot ID
|
|
12542
|
-
* @type {string}
|
|
12543
|
-
* @memberof DefaultApiSearchFiles
|
|
12544
|
-
*/
|
|
12545
|
-
readonly botId: string;
|
|
12546
12599
|
/**
|
|
12547
12600
|
* Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
|
|
12548
12601
|
* @type {string}
|
|
@@ -13471,6 +13524,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13471
13524
|
* @memberof DefaultApi
|
|
13472
13525
|
*/
|
|
13473
13526
|
getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceResponse, any>>;
|
|
13527
|
+
/**
|
|
13528
|
+
* Get details of the account authenticating with this endpoint.
|
|
13529
|
+
* @param {*} [options] Override http request option.
|
|
13530
|
+
* @throws {RequiredError}
|
|
13531
|
+
* @memberof DefaultApi
|
|
13532
|
+
*/
|
|
13533
|
+
getWorkspaceMember(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceMemberResponse, any>>;
|
|
13474
13534
|
/**
|
|
13475
13535
|
* Get workspace quota
|
|
13476
13536
|
* @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
|
|
@@ -13542,7 +13602,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13542
13602
|
* @throws {RequiredError}
|
|
13543
13603
|
* @memberof DefaultApi
|
|
13544
13604
|
*/
|
|
13545
|
-
listFiles(requestParameters
|
|
13605
|
+
listFiles(requestParameters?: DefaultApiListFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
|
|
13546
13606
|
/**
|
|
13547
13607
|
* List IAKs (Integration Api Keys) of an integration
|
|
13548
13608
|
* @param {DefaultApiListIntegrationApiKeysRequest} requestParameters Request parameters.
|
|
@@ -13560,7 +13620,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13560
13620
|
*/
|
|
13561
13621
|
listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIntegrationsResponse, any>>;
|
|
13562
13622
|
/**
|
|
13563
|
-
* Retrieves a list of [
|
|
13623
|
+
* Retrieves a list of [Message](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
13564
13624
|
* @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
|
|
13565
13625
|
* @param {*} [options] Override http request option.
|
|
13566
13626
|
* @throws {RequiredError}
|
|
@@ -13599,7 +13659,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13599
13659
|
*/
|
|
13600
13660
|
listTables(requestParameters?: DefaultApiListTablesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTablesResponse, any>>;
|
|
13601
13661
|
/**
|
|
13602
|
-
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
13662
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
13603
13663
|
* @param {DefaultApiListTasksRequest} requestParameters Request parameters.
|
|
13604
13664
|
* @param {*} [options] Override http request option.
|
|
13605
13665
|
* @throws {RequiredError}
|
|
@@ -13615,7 +13675,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
13615
13675
|
*/
|
|
13616
13676
|
listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsageHistoryResponse, any>>;
|
|
13617
13677
|
/**
|
|
13618
|
-
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](
|
|
13678
|
+
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).
|
|
13619
13679
|
* @param {DefaultApiListUsersRequest} requestParameters Request parameters.
|
|
13620
13680
|
* @param {*} [options] Override http request option.
|
|
13621
13681
|
* @throws {RequiredError}
|