@botpress/client 0.16.0 → 0.16.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/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.7
5
+ * The version of the OpenAPI document: 0.27.10
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -141,7 +141,7 @@ export interface AddParticipantResponse {
141
141
  */
142
142
  export interface Bot {
143
143
  /**
144
- * ID of the [Conversation](#schema_conversation)
144
+ * Id of the [Bot](#schema_bot)
145
145
  * @type {string}
146
146
  * @memberof Bot
147
147
  */
@@ -159,7 +159,7 @@ export interface Bot {
159
159
  */
160
160
  'updatedAt': string;
161
161
  /**
162
- * Title describing the task
162
+ * Signing secret of the [Bot](#schema_bot)
163
163
  * @type {string}
164
164
  * @memberof Bot
165
165
  */
@@ -333,31 +333,31 @@ export interface BotIntegrationsValue {
333
333
  */
334
334
  'enabled': boolean;
335
335
  /**
336
- * Type of the task
336
+ * Name of the [Integration](#schema_integration)
337
337
  * @type {string}
338
338
  * @memberof BotIntegrationsValue
339
339
  */
340
340
  'name': string;
341
341
  /**
342
- * Type of the task
342
+ * Version of the [Integration](#schema_integration)
343
343
  * @type {string}
344
344
  * @memberof BotIntegrationsValue
345
345
  */
346
346
  'version': string;
347
347
  /**
348
- * Title describing the task
348
+ *
349
349
  * @type {string}
350
350
  * @memberof BotIntegrationsValue
351
351
  */
352
352
  'webhookUrl': string;
353
353
  /**
354
- * Type of the task
354
+ *
355
355
  * @type {string}
356
356
  * @memberof BotIntegrationsValue
357
357
  */
358
358
  'webhookId': string;
359
359
  /**
360
- * Title describing the task
360
+ *
361
361
  * @type {string}
362
362
  * @memberof BotIntegrationsValue
363
363
  */
@@ -377,13 +377,13 @@ export interface BotIntegrationsValue {
377
377
  */
378
378
  'status': BotIntegrationsValueStatusEnum;
379
379
  /**
380
- * Title describing the task
380
+ *
381
381
  * @type {string}
382
382
  * @memberof BotIntegrationsValue
383
383
  */
384
384
  'statusReason': string | null;
385
385
  /**
386
- * ID of the [Conversation](#schema_conversation)
386
+ * ID of the [Integration](#schema_integration)
387
387
  * @type {string}
388
388
  * @memberof BotIntegrationsValue
389
389
  */
@@ -461,12 +461,12 @@ export interface BotMediasInner {
461
461
  export interface BotRecurringEventsValue {
462
462
  /**
463
463
  *
464
- * @type {BotRecurringEventsValueSchedule}
464
+ * @type {CreateBotBodyRecurringEventsValueSchedule}
465
465
  * @memberof BotRecurringEventsValue
466
466
  */
467
- 'schedule': BotRecurringEventsValueSchedule;
467
+ 'schedule': CreateBotBodyRecurringEventsValueSchedule;
468
468
  /**
469
- * Type of the task
469
+ *
470
470
  * @type {string}
471
471
  * @memberof BotRecurringEventsValue
472
472
  */
@@ -492,19 +492,6 @@ export interface BotRecurringEventsValue {
492
492
  */
493
493
  'lastFailureReason': string | null;
494
494
  }
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
495
  /**
509
496
  * User object configuration
510
497
  * @export
@@ -559,7 +546,7 @@ export interface BreakDownWorkspaceUsageByBotResponseDataInner {
559
546
  */
560
547
  export interface CallActionBody {
561
548
  /**
562
- * Unique identifier of the integration that was installed on the bot
549
+ * Type of the action
563
550
  * @type {string}
564
551
  * @memberof CallActionBody
565
552
  */
@@ -794,7 +781,7 @@ export interface ConfigureIntegrationBody {
794
781
  */
795
782
  export interface Conversation {
796
783
  /**
797
- * ID of the [Conversation](#schema_conversation)
784
+ * Id of the [Conversation](#schema_conversation)
798
785
  * @type {string}
799
786
  * @memberof Conversation
800
787
  */
@@ -992,7 +979,7 @@ export interface CreateBotBodyRecurringEventsValue {
992
979
  */
993
980
  'schedule': CreateBotBodyRecurringEventsValueSchedule;
994
981
  /**
995
- * Unique identifier of the integration that was installed on the bot
982
+ *
996
983
  * @type {string}
997
984
  * @memberof CreateBotBodyRecurringEventsValue
998
985
  */
@@ -1013,7 +1000,7 @@ export interface CreateBotBodyRecurringEventsValue {
1013
1000
  */
1014
1001
  export interface CreateBotBodyRecurringEventsValueSchedule {
1015
1002
  /**
1016
- * Unique identifier of the integration that was installed on the bot
1003
+ *
1017
1004
  * @type {string}
1018
1005
  * @memberof CreateBotBodyRecurringEventsValueSchedule
1019
1006
  */
@@ -1103,7 +1090,7 @@ export interface CreateBotResponse {
1103
1090
  */
1104
1091
  export interface CreateConversationBody {
1105
1092
  /**
1106
- * Unique identifier of the integration that was installed on the bot
1093
+ * Channel name
1107
1094
  * @type {string}
1108
1095
  * @memberof CreateConversationBody
1109
1096
  */
@@ -1144,7 +1131,7 @@ export interface CreateConversationResponse {
1144
1131
  */
1145
1132
  export interface CreateEventBody {
1146
1133
  /**
1147
- * Unique identifier of the integration that was installed on the bot
1134
+ * Type of the [Event](#schema_event).
1148
1135
  * @type {string}
1149
1136
  * @memberof CreateEventBody
1150
1137
  */
@@ -1435,13 +1422,13 @@ export interface CreateIntegrationApiKeyResponse {
1435
1422
  */
1436
1423
  export interface CreateIntegrationBody {
1437
1424
  /**
1438
- * Unique identifier of the integration that was installed on the bot
1425
+ * Name of the [Integration](#schema_integration)
1439
1426
  * @type {string}
1440
1427
  * @memberof CreateIntegrationBody
1441
1428
  */
1442
1429
  'name': string;
1443
1430
  /**
1444
- * Unique identifier of the integration that was installed on the bot
1431
+ * Version of the [Integration](#schema_integration)
1445
1432
  * @type {string}
1446
1433
  * @memberof CreateIntegrationBody
1447
1434
  */
@@ -1655,7 +1642,7 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
1655
1642
  */
1656
1643
  'required'?: boolean;
1657
1644
  /**
1658
- * Title describing the task
1645
+ *
1659
1646
  * @type {string}
1660
1647
  * @memberof CreateIntegrationBodyConfigurationIdentifier
1661
1648
  */
@@ -1668,13 +1655,13 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
1668
1655
  */
1669
1656
  export interface CreateIntegrationBodyIdentifier {
1670
1657
  /**
1671
- * Title describing the task
1658
+ *
1672
1659
  * @type {string}
1673
1660
  * @memberof CreateIntegrationBodyIdentifier
1674
1661
  */
1675
1662
  'fallbackHandlerScript'?: string;
1676
1663
  /**
1677
- * Title describing the task
1664
+ *
1678
1665
  * @type {string}
1679
1666
  * @memberof CreateIntegrationBodyIdentifier
1680
1667
  */
@@ -1729,25 +1716,25 @@ export interface CreateMessageBody {
1729
1716
  [key: string]: any;
1730
1717
  };
1731
1718
  /**
1732
- * User id
1719
+ * ID of the [User](#schema_user)
1733
1720
  * @type {string}
1734
1721
  * @memberof CreateMessageBody
1735
1722
  */
1736
1723
  'userId': string;
1737
1724
  /**
1738
- * User id
1725
+ * ID of the [Conversation](#schema_conversation)
1739
1726
  * @type {string}
1740
1727
  * @memberof CreateMessageBody
1741
1728
  */
1742
1729
  'conversationId': string;
1743
1730
  /**
1744
- * Unique identifier of the integration that was installed on the bot
1731
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
1745
1732
  * @type {string}
1746
1733
  * @memberof CreateMessageBody
1747
1734
  */
1748
1735
  'type': string;
1749
1736
  /**
1750
- * Set of [Tags](#tags) that you can attach to a [Message](#schema_message). The set of [Tags](#tags) available on a [Message](#schema_message) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
1737
+ * 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
1738
  * @type {{ [key: string]: string; }}
1752
1739
  * @memberof CreateMessageBody
1753
1740
  */
@@ -1768,7 +1755,7 @@ export interface CreateMessageBody {
1768
1755
  */
1769
1756
  export interface CreateMessageBodySchedule {
1770
1757
  /**
1771
- * When the [Event](#schema_event) will be sent, in the ISO 8601 format
1758
+ * When the [Message](#schema_message) will be sent, in the ISO 8601 format
1772
1759
  * @type {string}
1773
1760
  * @memberof CreateMessageBodySchedule
1774
1761
  */
@@ -1963,7 +1950,7 @@ export interface CreateTaskBody {
1963
1950
  */
1964
1951
  'description'?: string;
1965
1952
  /**
1966
- * Unique identifier of the integration that was installed on the bot
1953
+ * Type of the task
1967
1954
  * @type {string}
1968
1955
  * @memberof CreateTaskBody
1969
1956
  */
@@ -2037,7 +2024,7 @@ export interface CreateUserBody {
2037
2024
  [key: string]: string;
2038
2025
  };
2039
2026
  /**
2040
- * [DEPRECATED] To create a user from within a bot, call an action of the integration instead.
2027
+ * [DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.
2041
2028
  * @type {string}
2042
2029
  * @memberof CreateUserBody
2043
2030
  * @deprecated
@@ -2378,7 +2365,7 @@ export interface DuplicateTableResponse {
2378
2365
  */
2379
2366
  export interface Event {
2380
2367
  /**
2381
- * ID of the [Conversation](#schema_conversation)
2368
+ * Id of the [Event](#schema_event)
2382
2369
  * @type {string}
2383
2370
  * @memberof Event
2384
2371
  */
@@ -2390,7 +2377,7 @@ export interface Event {
2390
2377
  */
2391
2378
  'createdAt': string;
2392
2379
  /**
2393
- * Type of the task
2380
+ * Type of the [Event](#schema_event).
2394
2381
  * @type {string}
2395
2382
  * @memberof Event
2396
2383
  */
@@ -3094,7 +3081,7 @@ export interface GetMessageResponse {
3094
3081
  */
3095
3082
  export interface GetOrCreateConversationBody {
3096
3083
  /**
3097
- * Unique identifier of the integration that was installed on the bot
3084
+ * Channel name
3098
3085
  * @type {string}
3099
3086
  * @memberof GetOrCreateConversationBody
3100
3087
  */
@@ -3143,25 +3130,25 @@ export interface GetOrCreateMessageBody {
3143
3130
  [key: string]: any;
3144
3131
  };
3145
3132
  /**
3146
- * User id
3133
+ * ID of the [User](#schema_user)
3147
3134
  * @type {string}
3148
3135
  * @memberof GetOrCreateMessageBody
3149
3136
  */
3150
3137
  'userId': string;
3151
3138
  /**
3152
- * User id
3139
+ * ID of the [Conversation](#schema_conversation)
3153
3140
  * @type {string}
3154
3141
  * @memberof GetOrCreateMessageBody
3155
3142
  */
3156
3143
  'conversationId': string;
3157
3144
  /**
3158
- * Unique identifier of the integration that was installed on the bot
3145
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
3159
3146
  * @type {string}
3160
3147
  * @memberof GetOrCreateMessageBody
3161
3148
  */
3162
3149
  'type': string;
3163
3150
  /**
3164
- * Set of [Tags](#tags) that you can attach to a [Message](#schema_message). The set of [Tags](#tags) available on a [Message](#schema_message) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
3151
+ * 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
3152
  * @type {{ [key: string]: string; }}
3166
3153
  * @memberof GetOrCreateMessageBody
3167
3154
  */
@@ -3269,7 +3256,7 @@ export interface GetOrCreateUserBody {
3269
3256
  [key: string]: string;
3270
3257
  };
3271
3258
  /**
3272
- * [DEPRECATED] To create a user from within a bot, call an action of the integration instead.
3259
+ * [DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.
3273
3260
  * @type {string}
3274
3261
  * @memberof GetOrCreateUserBody
3275
3262
  * @deprecated
@@ -3368,7 +3355,7 @@ export interface GetPublicIntegrationByIdResponse {
3368
3355
  */
3369
3356
  export interface GetPublicIntegrationByIdResponseIntegration {
3370
3357
  /**
3371
- * User id
3358
+ * ID of the [Integration](#schema_integration)
3372
3359
  * @type {string}
3373
3360
  * @memberof GetPublicIntegrationByIdResponseIntegration
3374
3361
  */
@@ -3392,19 +3379,19 @@ export interface GetPublicIntegrationByIdResponseIntegration {
3392
3379
  */
3393
3380
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
3394
3381
  /**
3395
- * Title describing the task
3382
+ * URL of the [Integration](#schema_integration)
3396
3383
  * @type {string}
3397
3384
  * @memberof GetPublicIntegrationByIdResponseIntegration
3398
3385
  */
3399
3386
  'url': string;
3400
3387
  /**
3401
- * Unique identifier of the integration that was installed on the bot
3388
+ * Name of the [Integration](#schema_integration)
3402
3389
  * @type {string}
3403
3390
  * @memberof GetPublicIntegrationByIdResponseIntegration
3404
3391
  */
3405
3392
  'name': string;
3406
3393
  /**
3407
- * Unique identifier of the integration that was installed on the bot
3394
+ * Version of the [Integration](#schema_integration)
3408
3395
  * @type {string}
3409
3396
  * @memberof GetPublicIntegrationByIdResponseIntegration
3410
3397
  */
@@ -3712,7 +3699,7 @@ export interface GetPublicIntegrationByIdResponseIntegrationConfiguration {
3712
3699
  */
3713
3700
  export interface GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier {
3714
3701
  /**
3715
- * Title describing the task
3702
+ *
3716
3703
  * @type {string}
3717
3704
  * @memberof GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier
3718
3705
  */
@@ -4270,7 +4257,7 @@ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[k
4270
4257
  */
4271
4258
  export interface Integration {
4272
4259
  /**
4273
- * ID of the [Conversation](#schema_conversation)
4260
+ * ID of the [Integration](#schema_integration)
4274
4261
  * @type {string}
4275
4262
  * @memberof Integration
4276
4263
  */
@@ -4294,19 +4281,19 @@ export interface Integration {
4294
4281
  */
4295
4282
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
4296
4283
  /**
4297
- * Title describing the task
4284
+ * URL of the [Integration](#schema_integration)
4298
4285
  * @type {string}
4299
4286
  * @memberof Integration
4300
4287
  */
4301
4288
  'url': string;
4302
4289
  /**
4303
- * Type of the task
4290
+ * Name of the [Integration](#schema_integration)
4304
4291
  * @type {string}
4305
4292
  * @memberof Integration
4306
4293
  */
4307
4294
  'name': string;
4308
4295
  /**
4309
- * Type of the task
4296
+ * Version of the [Integration](#schema_integration)
4310
4297
  * @type {string}
4311
4298
  * @memberof Integration
4312
4299
  */
@@ -4765,7 +4752,7 @@ export interface ListBotsResponse {
4765
4752
  */
4766
4753
  export interface ListBotsResponseBotsInner {
4767
4754
  /**
4768
- * User id
4755
+ * Id of the [Bot](#schema_bot)
4769
4756
  * @type {string}
4770
4757
  * @memberof ListBotsResponseBotsInner
4771
4758
  */
@@ -5005,19 +4992,19 @@ export interface ListIntegrationsResponse {
5005
4992
  */
5006
4993
  export interface ListIntegrationsResponseIntegrationsInner {
5007
4994
  /**
5008
- * User id
4995
+ * ID of the [Integration](#schema_integration)
5009
4996
  * @type {string}
5010
4997
  * @memberof ListIntegrationsResponseIntegrationsInner
5011
4998
  */
5012
4999
  'id': string;
5013
5000
  /**
5014
- * Unique identifier of the integration that was installed on the bot
5001
+ * Name of the [Integration](#schema_integration)
5015
5002
  * @type {string}
5016
5003
  * @memberof ListIntegrationsResponseIntegrationsInner
5017
5004
  */
5018
5005
  'name': string;
5019
5006
  /**
5020
- * Unique identifier of the integration that was installed on the bot
5007
+ * Version of the [Integration](#schema_integration)
5021
5008
  * @type {string}
5022
5009
  * @memberof ListIntegrationsResponseIntegrationsInner
5023
5010
  */
@@ -5161,19 +5148,19 @@ export interface ListPublicIntegrationsResponse {
5161
5148
  */
5162
5149
  export interface ListPublicIntegrationsResponseIntegrationsInner {
5163
5150
  /**
5164
- * User id
5151
+ * ID of the [Integration](#schema_integration)
5165
5152
  * @type {string}
5166
5153
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
5167
5154
  */
5168
5155
  'id': string;
5169
5156
  /**
5170
- * Unique identifier of the integration that was installed on the bot
5157
+ * Name of the [Integration](#schema_integration)
5171
5158
  * @type {string}
5172
5159
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
5173
5160
  */
5174
5161
  'name': string;
5175
5162
  /**
5176
- * Unique identifier of the integration that was installed on the bot
5163
+ * Version of the [Integration](#schema_integration)
5177
5164
  * @type {string}
5178
5165
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
5179
5166
  */
@@ -5566,7 +5553,7 @@ export interface ListWorkspacesResponse {
5566
5553
  */
5567
5554
  export interface Message {
5568
5555
  /**
5569
- * ID of the [Conversation](#schema_conversation)
5556
+ * Id of the [Message](#schema_message)
5570
5557
  * @type {string}
5571
5558
  * @memberof Message
5572
5559
  */
@@ -5578,7 +5565,7 @@ export interface Message {
5578
5565
  */
5579
5566
  'createdAt': string;
5580
5567
  /**
5581
- * Type of the task
5568
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
5582
5569
  * @type {string}
5583
5570
  * @memberof Message
5584
5571
  */
@@ -5598,7 +5585,7 @@ export interface Message {
5598
5585
  */
5599
5586
  'direction': MessageDirectionEnum;
5600
5587
  /**
5601
- * ID of the [Conversation](#schema_conversation)
5588
+ * ID of the [User](#schema_user)
5602
5589
  * @type {string}
5603
5590
  * @memberof Message
5604
5591
  */
@@ -6074,7 +6061,7 @@ export interface SetWorkspacePaymentMethodResponsePaymentMethod {
6074
6061
  */
6075
6062
  export interface State {
6076
6063
  /**
6077
- * ID of the [Conversation](#schema_conversation)
6064
+ * Id of the [State](#schema_state)
6078
6065
  * @type {string}
6079
6066
  * @memberof State
6080
6067
  */
@@ -6092,7 +6079,7 @@ export interface State {
6092
6079
  */
6093
6080
  'updatedAt': string;
6094
6081
  /**
6095
- * ID of the [Conversation](#schema_conversation)
6082
+ * Id of the [Bot](#schema_bot)
6096
6083
  * @type {string}
6097
6084
  * @memberof State
6098
6085
  */
@@ -6110,7 +6097,7 @@ export interface State {
6110
6097
  */
6111
6098
  'userId'?: string;
6112
6099
  /**
6113
- * Type of the task
6100
+ * Name of the [State](#schema_state) which is declared inside the bot definition
6114
6101
  * @type {string}
6115
6102
  * @memberof State
6116
6103
  */
@@ -6325,7 +6312,7 @@ export interface TableSchemaPropertiesValueXZui {
6325
6312
  */
6326
6313
  export interface Task {
6327
6314
  /**
6328
- * ID of the [Conversation](#schema_conversation)
6315
+ * Id of the [Task](#schema_task)
6329
6316
  * @type {string}
6330
6317
  * @memberof Task
6331
6318
  */
@@ -6703,7 +6690,7 @@ export interface UpdateBotBodyRecurringEventsValue {
6703
6690
  */
6704
6691
  'schedule': CreateBotBodyRecurringEventsValueSchedule;
6705
6692
  /**
6706
- * Unique identifier of the integration that was installed on the bot
6693
+ *
6707
6694
  * @type {string}
6708
6695
  * @memberof UpdateBotBodyRecurringEventsValue
6709
6696
  */
@@ -7104,7 +7091,7 @@ export interface UpdateIntegrationBodyConfiguration {
7104
7091
  */
7105
7092
  export interface UpdateIntegrationBodyConfigurationIdentifier {
7106
7093
  /**
7107
- * Title describing the task
7094
+ *
7108
7095
  * @type {string}
7109
7096
  * @memberof UpdateIntegrationBodyConfigurationIdentifier
7110
7097
  */
@@ -7150,13 +7137,13 @@ export interface UpdateIntegrationBodyEntitiesValue {
7150
7137
  */
7151
7138
  export interface UpdateIntegrationBodyIdentifier {
7152
7139
  /**
7153
- * Title describing the task
7140
+ *
7154
7141
  * @type {string}
7155
7142
  * @memberof UpdateIntegrationBodyIdentifier
7156
7143
  */
7157
7144
  'extractScript'?: string | null;
7158
7145
  /**
7159
- * Title describing the task
7146
+ *
7160
7147
  * @type {string}
7161
7148
  * @memberof UpdateIntegrationBodyIdentifier
7162
7149
  */
@@ -7230,7 +7217,7 @@ export interface UpdateIntegrationResponse {
7230
7217
  */
7231
7218
  export interface UpdateMessageBody {
7232
7219
  /**
7233
- * Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
7220
+ * 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
7221
  * @type {{ [key: string]: string; }}
7235
7222
  * @memberof UpdateMessageBody
7236
7223
  */
@@ -7977,7 +7964,7 @@ export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
7977
7964
  */
7978
7965
  export interface User {
7979
7966
  /**
7980
- * ID of the [Conversation](#schema_conversation)
7967
+ * Id of the [User](#schema_user)
7981
7968
  * @type {string}
7982
7969
  * @memberof User
7983
7970
  */
@@ -8784,13 +8771,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8784
8771
  listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, status?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8785
8772
  /**
8786
8773
  * List files for bot
8787
- * @param {string} botId Bot ID
8788
8774
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8789
8775
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8790
8776
  * @param {*} [options] Override http request option.
8791
8777
  * @throws {RequiredError}
8792
8778
  */
8793
- listFiles: (botId: string, nextToken?: string, tags?: {
8779
+ listFiles: (nextToken?: string, tags?: {
8794
8780
  [key: string]: string;
8795
8781
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8796
8782
  /**
@@ -8811,7 +8797,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8811
8797
  */
8812
8798
  listIntegrations: (nextToken?: string, name?: string, version?: string, dev?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8813
8799
  /**
8814
- * Retrieves a list of [Messages](#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](#tags).
8800
+ * 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
8801
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8816
8802
  * @param {string} [conversationId] Conversation id
8817
8803
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -8854,7 +8840,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8854
8840
  [key: string]: string;
8855
8841
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8856
8842
  /**
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](#tags).
8843
+ * 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
8844
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8859
8845
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8860
8846
  * @param {string} [conversationId] Conversation id
@@ -8877,7 +8863,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8877
8863
  */
8878
8864
  listUsageHistory: (type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8879
8865
  /**
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](#tags).
8866
+ * 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
8867
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8882
8868
  * @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
8883
8869
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -8960,7 +8946,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8960
8946
  runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8961
8947
  /**
8962
8948
  * Search files
8963
- * @param {string} botId Bot ID
8964
8949
  * @param {string} query Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
8965
8950
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8966
8951
  * @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 +8953,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8968
8953
  * @param {*} [options] Override http request option.
8969
8954
  * @throws {RequiredError}
8970
8955
  */
8971
- searchFiles: (botId: string, query: string, tags?: {
8956
+ searchFiles: (query: string, tags?: {
8972
8957
  [key: string]: string;
8973
8958
  } | undefined, contextDepth?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8974
8959
  /**
@@ -9710,13 +9695,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9710
9695
  listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, status?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
9711
9696
  /**
9712
9697
  * List files for bot
9713
- * @param {string} botId Bot ID
9714
9698
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9715
9699
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9716
9700
  * @param {*} [options] Override http request option.
9717
9701
  * @throws {RequiredError}
9718
9702
  */
9719
- listFiles(botId: string, nextToken?: string, tags?: {
9703
+ listFiles(nextToken?: string, tags?: {
9720
9704
  [key: string]: string;
9721
9705
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
9722
9706
  /**
@@ -9737,7 +9721,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9737
9721
  */
9738
9722
  listIntegrations(nextToken?: string, name?: string, version?: string, dev?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationsResponse>>;
9739
9723
  /**
9740
- * Retrieves a list of [Messages](#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](#tags).
9724
+ * 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
9725
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9742
9726
  * @param {string} [conversationId] Conversation id
9743
9727
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -9780,7 +9764,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9780
9764
  [key: string]: string;
9781
9765
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTablesResponse>>;
9782
9766
  /**
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](#tags).
9767
+ * 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
9768
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9785
9769
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9786
9770
  * @param {string} [conversationId] Conversation id
@@ -9803,7 +9787,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9803
9787
  */
9804
9788
  listUsageHistory(type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsageHistoryResponse>>;
9805
9789
  /**
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](#tags).
9790
+ * 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
9791
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9808
9792
  * @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
9809
9793
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -9886,7 +9870,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9886
9870
  runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
9887
9871
  /**
9888
9872
  * Search files
9889
- * @param {string} botId Bot ID
9890
9873
  * @param {string} query Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
9891
9874
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9892
9875
  * @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 +9877,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9894
9877
  * @param {*} [options] Override http request option.
9895
9878
  * @throws {RequiredError}
9896
9879
  */
9897
- searchFiles(botId: string, query: string, tags?: {
9880
+ searchFiles(query: string, tags?: {
9898
9881
  [key: string]: string;
9899
9882
  } | undefined, contextDepth?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
9900
9883
  /**
@@ -10592,7 +10575,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10592
10575
  * @param {*} [options] Override http request option.
10593
10576
  * @throws {RequiredError}
10594
10577
  */
10595
- listFiles(requestParameters: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
10578
+ listFiles(requestParameters?: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
10596
10579
  /**
10597
10580
  * List IAKs (Integration Api Keys) of an integration
10598
10581
  * @param {DefaultApiListIntegrationApiKeysRequest} requestParameters Request parameters.
@@ -10608,7 +10591,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10608
10591
  */
10609
10592
  listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListIntegrationsResponse>;
10610
10593
  /**
10611
- * Retrieves a list of [Messages](#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](#tags).
10594
+ * 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
10595
  * @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
10613
10596
  * @param {*} [options] Override http request option.
10614
10597
  * @throws {RequiredError}
@@ -10642,7 +10625,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10642
10625
  */
10643
10626
  listTables(requestParameters?: DefaultApiListTablesRequest, options?: AxiosRequestConfig): AxiosPromise<ListTablesResponse>;
10644
10627
  /**
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](#tags).
10628
+ * 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
10629
  * @param {DefaultApiListTasksRequest} requestParameters Request parameters.
10647
10630
  * @param {*} [options] Override http request option.
10648
10631
  * @throws {RequiredError}
@@ -10656,7 +10639,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10656
10639
  */
10657
10640
  listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsageHistoryResponse>;
10658
10641
  /**
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](#tags).
10642
+ * 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
10643
  * @param {DefaultApiListUsersRequest} requestParameters Request parameters.
10661
10644
  * @param {*} [options] Override http request option.
10662
10645
  * @throws {RequiredError}
@@ -12118,12 +12101,6 @@ export interface DefaultApiListEventsRequest {
12118
12101
  * @interface DefaultApiListFilesRequest
12119
12102
  */
12120
12103
  export interface DefaultApiListFilesRequest {
12121
- /**
12122
- * Bot ID
12123
- * @type {string}
12124
- * @memberof DefaultApiListFiles
12125
- */
12126
- readonly botId: string;
12127
12104
  /**
12128
12105
  * Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
12129
12106
  * @type {string}
@@ -12537,12 +12514,6 @@ export interface DefaultApiRunVrlRequest {
12537
12514
  * @interface DefaultApiSearchFilesRequest
12538
12515
  */
12539
12516
  export interface DefaultApiSearchFilesRequest {
12540
- /**
12541
- * Bot ID
12542
- * @type {string}
12543
- * @memberof DefaultApiSearchFiles
12544
- */
12545
- readonly botId: string;
12546
12517
  /**
12547
12518
  * Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
12548
12519
  * @type {string}
@@ -13542,7 +13513,7 @@ export declare class DefaultApi extends BaseAPI {
13542
13513
  * @throws {RequiredError}
13543
13514
  * @memberof DefaultApi
13544
13515
  */
13545
- listFiles(requestParameters: DefaultApiListFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
13516
+ listFiles(requestParameters?: DefaultApiListFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
13546
13517
  /**
13547
13518
  * List IAKs (Integration Api Keys) of an integration
13548
13519
  * @param {DefaultApiListIntegrationApiKeysRequest} requestParameters Request parameters.
@@ -13560,7 +13531,7 @@ export declare class DefaultApi extends BaseAPI {
13560
13531
  */
13561
13532
  listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIntegrationsResponse, any>>;
13562
13533
  /**
13563
- * Retrieves a list of [Messages](#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](#tags).
13534
+ * 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
13535
  * @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
13565
13536
  * @param {*} [options] Override http request option.
13566
13537
  * @throws {RequiredError}
@@ -13599,7 +13570,7 @@ export declare class DefaultApi extends BaseAPI {
13599
13570
  */
13600
13571
  listTables(requestParameters?: DefaultApiListTablesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTablesResponse, any>>;
13601
13572
  /**
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](#tags).
13573
+ * 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
13574
  * @param {DefaultApiListTasksRequest} requestParameters Request parameters.
13604
13575
  * @param {*} [options] Override http request option.
13605
13576
  * @throws {RequiredError}
@@ -13615,7 +13586,7 @@ export declare class DefaultApi extends BaseAPI {
13615
13586
  */
13616
13587
  listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsageHistoryResponse, any>>;
13617
13588
  /**
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](#tags).
13589
+ * 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
13590
  * @param {DefaultApiListUsersRequest} requestParameters Request parameters.
13620
13591
  * @param {*} [options] Override http request option.
13621
13592
  * @throws {RequiredError}