@botpress/client 0.15.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.26.2
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
  */
@@ -1061,13 +1048,11 @@ export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTy
1061
1048
  export interface CreateBotBodySubscriptions {
1062
1049
  /**
1063
1050
  * Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events.
1064
- * @type {{ [key: string]: { [key: string]: any; }; }}
1051
+ * @type {{ [key: string]: object; }}
1065
1052
  * @memberof CreateBotBodySubscriptions
1066
1053
  */
1067
1054
  'events': {
1068
- [key: string]: {
1069
- [key: string]: any;
1070
- };
1055
+ [key: string]: object;
1071
1056
  } | null;
1072
1057
  }
1073
1058
  /**
@@ -1105,7 +1090,7 @@ export interface CreateBotResponse {
1105
1090
  */
1106
1091
  export interface CreateConversationBody {
1107
1092
  /**
1108
- * Unique identifier of the integration that was installed on the bot
1093
+ * Channel name
1109
1094
  * @type {string}
1110
1095
  * @memberof CreateConversationBody
1111
1096
  */
@@ -1146,7 +1131,7 @@ export interface CreateConversationResponse {
1146
1131
  */
1147
1132
  export interface CreateEventBody {
1148
1133
  /**
1149
- * Unique identifier of the integration that was installed on the bot
1134
+ * Type of the [Event](#schema_event).
1150
1135
  * @type {string}
1151
1136
  * @memberof CreateEventBody
1152
1137
  */
@@ -1236,6 +1221,12 @@ export interface CreateFileBody {
1236
1221
  'tags'?: {
1237
1222
  [key: string]: string;
1238
1223
  };
1224
+ /**
1225
+ * File size in bytes. This will count against your file storage quota. If the `index` parameter is set to `true`, this will also count against your vector database storage quota.
1226
+ * @type {number}
1227
+ * @memberof CreateFileBody
1228
+ */
1229
+ 'size': number;
1239
1230
  /**
1240
1231
  * 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.
1241
1232
  * @type {boolean}
@@ -1334,51 +1325,46 @@ export interface CreateFileResponseFile {
1334
1325
  * @type {Array<string>}
1335
1326
  * @memberof CreateFileResponseFile
1336
1327
  */
1337
- 'accessPolicies': Array<string>;
1328
+ 'accessPolicies': Array<CreateFileResponseFileAccessPoliciesEnum>;
1338
1329
  /**
1339
- * Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created.
1340
- * @type {string}
1341
- * @memberof CreateFileResponseFile
1342
- */
1343
- 'indexingStatus'?: CreateFileResponseFileIndexingStatusEnum;
1344
- /**
1345
- * Last failure reason of the file indexing if the indexing status is \"FAILED\".
1346
- * @type {string}
1330
+ * Whether the file was requested to be indexed for search or not.
1331
+ * @type {boolean}
1347
1332
  * @memberof CreateFileResponseFile
1348
1333
  */
1349
- 'indexingFailureReason'?: string;
1334
+ 'index': boolean;
1350
1335
  /**
1351
- * Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. The status will be set to \"COMPLETE\" once the file content has been uploaded successfully. If the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details.
1336
+ * Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully. If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file. However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped). Once the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field.
1352
1337
  * @type {string}
1353
1338
  * @memberof CreateFileResponseFile
1354
1339
  */
1355
- 'uploadStatus': CreateFileResponseFileUploadStatusEnum;
1340
+ 'status': CreateFileResponseFileStatusEnum;
1356
1341
  /**
1357
- * Failure reason of the file upload if the upload status is \"FAILED\".
1342
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
1358
1343
  * @type {string}
1359
1344
  * @memberof CreateFileResponseFile
1360
1345
  */
1361
- 'uploadFailureReason'?: string;
1346
+ 'failedStatusReason'?: string;
1362
1347
  /**
1363
- * URL to upload the file content. File content needs to be sent to this URL via a POST request.
1348
+ * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
1364
1349
  * @type {string}
1365
1350
  * @memberof CreateFileResponseFile
1366
1351
  */
1367
1352
  'uploadUrl': string;
1368
1353
  }
1369
- export declare const CreateFileResponseFileIndexingStatusEnum: {
1370
- readonly Pending: "PENDING";
1371
- readonly InProgress: "IN_PROGRESS";
1372
- readonly Complete: "COMPLETE";
1373
- readonly Failed: "FAILED";
1354
+ export declare const CreateFileResponseFileAccessPoliciesEnum: {
1355
+ readonly Integrations: "integrations";
1356
+ readonly PublicContent: "public_content";
1374
1357
  };
1375
- export type CreateFileResponseFileIndexingStatusEnum = typeof CreateFileResponseFileIndexingStatusEnum[keyof typeof CreateFileResponseFileIndexingStatusEnum];
1376
- export declare const CreateFileResponseFileUploadStatusEnum: {
1377
- readonly Pending: "PENDING";
1378
- readonly Complete: "COMPLETE";
1379
- readonly Failed: "FAILED";
1358
+ export type CreateFileResponseFileAccessPoliciesEnum = typeof CreateFileResponseFileAccessPoliciesEnum[keyof typeof CreateFileResponseFileAccessPoliciesEnum];
1359
+ export declare const CreateFileResponseFileStatusEnum: {
1360
+ readonly UploadPending: "UPLOAD_PENDING";
1361
+ readonly UploadFailed: "UPLOAD_FAILED";
1362
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
1363
+ readonly IndexingPending: "INDEXING_PENDING";
1364
+ readonly IndexingFailed: "INDEXING_FAILED";
1365
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
1380
1366
  };
1381
- export type CreateFileResponseFileUploadStatusEnum = typeof CreateFileResponseFileUploadStatusEnum[keyof typeof CreateFileResponseFileUploadStatusEnum];
1367
+ export type CreateFileResponseFileStatusEnum = typeof CreateFileResponseFileStatusEnum[keyof typeof CreateFileResponseFileStatusEnum];
1382
1368
  /**
1383
1369
  *
1384
1370
  * @export
@@ -1436,13 +1422,13 @@ export interface CreateIntegrationApiKeyResponse {
1436
1422
  */
1437
1423
  export interface CreateIntegrationBody {
1438
1424
  /**
1439
- * Unique identifier of the integration that was installed on the bot
1425
+ * Name of the [Integration](#schema_integration)
1440
1426
  * @type {string}
1441
1427
  * @memberof CreateIntegrationBody
1442
1428
  */
1443
1429
  'name': string;
1444
1430
  /**
1445
- * Unique identifier of the integration that was installed on the bot
1431
+ * Version of the [Integration](#schema_integration)
1446
1432
  * @type {string}
1447
1433
  * @memberof CreateIntegrationBody
1448
1434
  */
@@ -1656,7 +1642,7 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
1656
1642
  */
1657
1643
  'required'?: boolean;
1658
1644
  /**
1659
- * Title describing the task
1645
+ *
1660
1646
  * @type {string}
1661
1647
  * @memberof CreateIntegrationBodyConfigurationIdentifier
1662
1648
  */
@@ -1669,13 +1655,13 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
1669
1655
  */
1670
1656
  export interface CreateIntegrationBodyIdentifier {
1671
1657
  /**
1672
- * Title describing the task
1658
+ *
1673
1659
  * @type {string}
1674
1660
  * @memberof CreateIntegrationBodyIdentifier
1675
1661
  */
1676
1662
  'fallbackHandlerScript'?: string;
1677
1663
  /**
1678
- * Title describing the task
1664
+ *
1679
1665
  * @type {string}
1680
1666
  * @memberof CreateIntegrationBodyIdentifier
1681
1667
  */
@@ -1730,25 +1716,25 @@ export interface CreateMessageBody {
1730
1716
  [key: string]: any;
1731
1717
  };
1732
1718
  /**
1733
- * User id
1719
+ * ID of the [User](#schema_user)
1734
1720
  * @type {string}
1735
1721
  * @memberof CreateMessageBody
1736
1722
  */
1737
1723
  'userId': string;
1738
1724
  /**
1739
- * User id
1725
+ * ID of the [Conversation](#schema_conversation)
1740
1726
  * @type {string}
1741
1727
  * @memberof CreateMessageBody
1742
1728
  */
1743
1729
  'conversationId': string;
1744
1730
  /**
1745
- * 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
1746
1732
  * @type {string}
1747
1733
  * @memberof CreateMessageBody
1748
1734
  */
1749
1735
  'type': string;
1750
1736
  /**
1751
- * 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.
1752
1738
  * @type {{ [key: string]: string; }}
1753
1739
  * @memberof CreateMessageBody
1754
1740
  */
@@ -1769,7 +1755,7 @@ export interface CreateMessageBody {
1769
1755
  */
1770
1756
  export interface CreateMessageBodySchedule {
1771
1757
  /**
1772
- * 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
1773
1759
  * @type {string}
1774
1760
  * @memberof CreateMessageBodySchedule
1775
1761
  */
@@ -1964,7 +1950,7 @@ export interface CreateTaskBody {
1964
1950
  */
1965
1951
  'description'?: string;
1966
1952
  /**
1967
- * Unique identifier of the integration that was installed on the bot
1953
+ * Type of the task
1968
1954
  * @type {string}
1969
1955
  * @memberof CreateTaskBody
1970
1956
  */
@@ -2038,7 +2024,7 @@ export interface CreateUserBody {
2038
2024
  [key: string]: string;
2039
2025
  };
2040
2026
  /**
2041
- * [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.
2042
2028
  * @type {string}
2043
2029
  * @memberof CreateUserBody
2044
2030
  * @deprecated
@@ -2379,7 +2365,7 @@ export interface DuplicateTableResponse {
2379
2365
  */
2380
2366
  export interface Event {
2381
2367
  /**
2382
- * ID of the [Conversation](#schema_conversation)
2368
+ * Id of the [Event](#schema_event)
2383
2369
  * @type {string}
2384
2370
  * @memberof Event
2385
2371
  */
@@ -2391,7 +2377,7 @@ export interface Event {
2391
2377
  */
2392
2378
  'createdAt': string;
2393
2379
  /**
2394
- * Type of the task
2380
+ * Type of the [Event](#schema_event).
2395
2381
  * @type {string}
2396
2382
  * @memberof Event
2397
2383
  */
@@ -2513,11 +2499,11 @@ export interface FindTableRowsResponse {
2513
2499
  */
2514
2500
  'rows': Array<Row>;
2515
2501
  /**
2516
- * The total number of rows matching the search criteria, regardless of pagination.
2517
- * @type {number}
2502
+ * Flag indicating if there are more rows to fetch.
2503
+ * @type {boolean}
2518
2504
  * @memberof FindTableRowsResponse
2519
2505
  */
2520
- 'count': number;
2506
+ 'hasMore': boolean;
2521
2507
  /**
2522
2508
  *
2523
2509
  * @type {number}
@@ -2530,6 +2516,12 @@ export interface FindTableRowsResponse {
2530
2516
  * @memberof FindTableRowsResponse
2531
2517
  */
2532
2518
  'limit': number;
2519
+ /**
2520
+ * Alerts for minor issues that don\'t block the operation but suggest possible improvements.
2521
+ * @type {Array<string>}
2522
+ * @memberof FindTableRowsResponse
2523
+ */
2524
+ 'warnings'?: Array<string>;
2533
2525
  }
2534
2526
  /**
2535
2527
  *
@@ -2913,69 +2905,62 @@ export interface GetEventResponse {
2913
2905
  /**
2914
2906
  *
2915
2907
  * @export
2916
- * @interface GetFileContentResponse
2908
+ * @interface GetFileResponse
2917
2909
  */
2918
- export interface GetFileContentResponse {
2919
- /**
2920
- * Temporary pre-signed URL to download the file, should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
2921
- * @type {string}
2922
- * @memberof GetFileContentResponse
2923
- */
2924
- 'url': string;
2925
- }
2926
- /**
2927
- *
2928
- * @export
2929
- * @interface GetFileMetadataResponse
2930
- */
2931
- export interface GetFileMetadataResponse {
2910
+ export interface GetFileResponse {
2932
2911
  /**
2933
2912
  *
2934
- * @type {GetFileMetadataResponseFile}
2935
- * @memberof GetFileMetadataResponse
2913
+ * @type {GetFileResponseFile}
2914
+ * @memberof GetFileResponse
2936
2915
  */
2937
- 'file': GetFileMetadataResponseFile;
2916
+ 'file': GetFileResponseFile;
2938
2917
  }
2939
2918
  /**
2940
2919
  *
2941
2920
  * @export
2942
- * @interface GetFileMetadataResponseFile
2921
+ * @interface GetFileResponseFile
2943
2922
  */
2944
- export interface GetFileMetadataResponseFile {
2923
+ export interface GetFileResponseFile {
2945
2924
  /**
2946
2925
  * File ID
2947
2926
  * @type {string}
2948
- * @memberof GetFileMetadataResponseFile
2927
+ * @memberof GetFileResponseFile
2949
2928
  */
2950
2929
  'id': string;
2951
2930
  /**
2952
2931
  * The ID of the bot the file belongs to
2953
2932
  * @type {string}
2954
- * @memberof GetFileMetadataResponseFile
2933
+ * @memberof GetFileResponseFile
2955
2934
  */
2956
2935
  'botId': string;
2957
2936
  /**
2958
2937
  * File name
2959
2938
  * @type {string}
2960
- * @memberof GetFileMetadataResponseFile
2939
+ * @memberof GetFileResponseFile
2961
2940
  */
2962
2941
  'name': string | null;
2942
+ /**
2943
+ * If the file is not uploaded yet, this will be set to a `null` value. If the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
2944
+ * @type {string}
2945
+ * @memberof GetFileResponseFile
2946
+ */
2947
+ 'url': string | null;
2963
2948
  /**
2964
2949
  * File size in bytes. Non-null if file upload status is \"COMPLETE\".
2965
2950
  * @type {number}
2966
- * @memberof GetFileMetadataResponseFile
2951
+ * @memberof GetFileResponseFile
2967
2952
  */
2968
2953
  'size': number | null;
2969
2954
  /**
2970
2955
  * MIME type of the file\'s content
2971
2956
  * @type {string}
2972
- * @memberof GetFileMetadataResponseFile
2957
+ * @memberof GetFileResponseFile
2973
2958
  */
2974
2959
  'contentType': string;
2975
2960
  /**
2976
2961
  * The tags of the file as an object of key/value pairs
2977
2962
  * @type {{ [key: string]: string; }}
2978
- * @memberof GetFileMetadataResponseFile
2963
+ * @memberof GetFileResponseFile
2979
2964
  */
2980
2965
  'tags': {
2981
2966
  [key: string]: string;
@@ -2983,59 +2968,54 @@ export interface GetFileMetadataResponseFile {
2983
2968
  /**
2984
2969
  * File creation timestamp in ISO 8601 format
2985
2970
  * @type {string}
2986
- * @memberof GetFileMetadataResponseFile
2971
+ * @memberof GetFileResponseFile
2987
2972
  */
2988
2973
  'createdAt': string;
2989
2974
  /**
2990
2975
  * File last update timestamp in ISO 8601 format
2991
2976
  * @type {string}
2992
- * @memberof GetFileMetadataResponseFile
2977
+ * @memberof GetFileResponseFile
2993
2978
  */
2994
2979
  'updatedAt': string;
2995
2980
  /**
2996
2981
  * Access policies configured for the file.
2997
2982
  * @type {Array<string>}
2998
- * @memberof GetFileMetadataResponseFile
2983
+ * @memberof GetFileResponseFile
2999
2984
  */
3000
- 'accessPolicies': Array<string>;
2985
+ 'accessPolicies': Array<GetFileResponseFileAccessPoliciesEnum>;
3001
2986
  /**
3002
- * Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created.
3003
- * @type {string}
3004
- * @memberof GetFileMetadataResponseFile
3005
- */
3006
- 'indexingStatus'?: GetFileMetadataResponseFileIndexingStatusEnum;
3007
- /**
3008
- * Last failure reason of the file indexing if the indexing status is \"FAILED\".
3009
- * @type {string}
3010
- * @memberof GetFileMetadataResponseFile
2987
+ * Whether the file was requested to be indexed for search or not.
2988
+ * @type {boolean}
2989
+ * @memberof GetFileResponseFile
3011
2990
  */
3012
- 'indexingFailureReason'?: string;
2991
+ 'index': boolean;
3013
2992
  /**
3014
- * Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. The status will be set to \"COMPLETE\" once the file content has been uploaded successfully. If the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details.
2993
+ * Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully. If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file. However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped). Once the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field.
3015
2994
  * @type {string}
3016
- * @memberof GetFileMetadataResponseFile
2995
+ * @memberof GetFileResponseFile
3017
2996
  */
3018
- 'uploadStatus': GetFileMetadataResponseFileUploadStatusEnum;
2997
+ 'status': GetFileResponseFileStatusEnum;
3019
2998
  /**
3020
- * Failure reason of the file upload if the upload status is \"FAILED\".
2999
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
3021
3000
  * @type {string}
3022
- * @memberof GetFileMetadataResponseFile
3001
+ * @memberof GetFileResponseFile
3023
3002
  */
3024
- 'uploadFailureReason'?: string;
3003
+ 'failedStatusReason'?: string;
3025
3004
  }
3026
- export declare const GetFileMetadataResponseFileIndexingStatusEnum: {
3027
- readonly Pending: "PENDING";
3028
- readonly InProgress: "IN_PROGRESS";
3029
- readonly Complete: "COMPLETE";
3030
- readonly Failed: "FAILED";
3005
+ export declare const GetFileResponseFileAccessPoliciesEnum: {
3006
+ readonly Integrations: "integrations";
3007
+ readonly PublicContent: "public_content";
3031
3008
  };
3032
- export type GetFileMetadataResponseFileIndexingStatusEnum = typeof GetFileMetadataResponseFileIndexingStatusEnum[keyof typeof GetFileMetadataResponseFileIndexingStatusEnum];
3033
- export declare const GetFileMetadataResponseFileUploadStatusEnum: {
3034
- readonly Pending: "PENDING";
3035
- readonly Complete: "COMPLETE";
3036
- readonly Failed: "FAILED";
3009
+ export type GetFileResponseFileAccessPoliciesEnum = typeof GetFileResponseFileAccessPoliciesEnum[keyof typeof GetFileResponseFileAccessPoliciesEnum];
3010
+ export declare const GetFileResponseFileStatusEnum: {
3011
+ readonly UploadPending: "UPLOAD_PENDING";
3012
+ readonly UploadFailed: "UPLOAD_FAILED";
3013
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
3014
+ readonly IndexingPending: "INDEXING_PENDING";
3015
+ readonly IndexingFailed: "INDEXING_FAILED";
3016
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
3037
3017
  };
3038
- export type GetFileMetadataResponseFileUploadStatusEnum = typeof GetFileMetadataResponseFileUploadStatusEnum[keyof typeof GetFileMetadataResponseFileUploadStatusEnum];
3018
+ export type GetFileResponseFileStatusEnum = typeof GetFileResponseFileStatusEnum[keyof typeof GetFileResponseFileStatusEnum];
3039
3019
  /**
3040
3020
  *
3041
3021
  * @export
@@ -3101,7 +3081,7 @@ export interface GetMessageResponse {
3101
3081
  */
3102
3082
  export interface GetOrCreateConversationBody {
3103
3083
  /**
3104
- * Unique identifier of the integration that was installed on the bot
3084
+ * Channel name
3105
3085
  * @type {string}
3106
3086
  * @memberof GetOrCreateConversationBody
3107
3087
  */
@@ -3150,25 +3130,25 @@ export interface GetOrCreateMessageBody {
3150
3130
  [key: string]: any;
3151
3131
  };
3152
3132
  /**
3153
- * User id
3133
+ * ID of the [User](#schema_user)
3154
3134
  * @type {string}
3155
3135
  * @memberof GetOrCreateMessageBody
3156
3136
  */
3157
3137
  'userId': string;
3158
3138
  /**
3159
- * User id
3139
+ * ID of the [Conversation](#schema_conversation)
3160
3140
  * @type {string}
3161
3141
  * @memberof GetOrCreateMessageBody
3162
3142
  */
3163
3143
  'conversationId': string;
3164
3144
  /**
3165
- * 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
3166
3146
  * @type {string}
3167
3147
  * @memberof GetOrCreateMessageBody
3168
3148
  */
3169
3149
  'type': string;
3170
3150
  /**
3171
- * 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.
3172
3152
  * @type {{ [key: string]: string; }}
3173
3153
  * @memberof GetOrCreateMessageBody
3174
3154
  */
@@ -3276,7 +3256,7 @@ export interface GetOrCreateUserBody {
3276
3256
  [key: string]: string;
3277
3257
  };
3278
3258
  /**
3279
- * [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.
3280
3260
  * @type {string}
3281
3261
  * @memberof GetOrCreateUserBody
3282
3262
  * @deprecated
@@ -3375,7 +3355,7 @@ export interface GetPublicIntegrationByIdResponse {
3375
3355
  */
3376
3356
  export interface GetPublicIntegrationByIdResponseIntegration {
3377
3357
  /**
3378
- * User id
3358
+ * ID of the [Integration](#schema_integration)
3379
3359
  * @type {string}
3380
3360
  * @memberof GetPublicIntegrationByIdResponseIntegration
3381
3361
  */
@@ -3399,19 +3379,19 @@ export interface GetPublicIntegrationByIdResponseIntegration {
3399
3379
  */
3400
3380
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
3401
3381
  /**
3402
- * Title describing the task
3382
+ * URL of the [Integration](#schema_integration)
3403
3383
  * @type {string}
3404
3384
  * @memberof GetPublicIntegrationByIdResponseIntegration
3405
3385
  */
3406
3386
  'url': string;
3407
3387
  /**
3408
- * Unique identifier of the integration that was installed on the bot
3388
+ * Name of the [Integration](#schema_integration)
3409
3389
  * @type {string}
3410
3390
  * @memberof GetPublicIntegrationByIdResponseIntegration
3411
3391
  */
3412
3392
  'name': string;
3413
3393
  /**
3414
- * Unique identifier of the integration that was installed on the bot
3394
+ * Version of the [Integration](#schema_integration)
3415
3395
  * @type {string}
3416
3396
  * @memberof GetPublicIntegrationByIdResponseIntegration
3417
3397
  */
@@ -3719,7 +3699,7 @@ export interface GetPublicIntegrationByIdResponseIntegrationConfiguration {
3719
3699
  */
3720
3700
  export interface GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier {
3721
3701
  /**
3722
- * Title describing the task
3702
+ *
3723
3703
  * @type {string}
3724
3704
  * @memberof GetPublicIntegrationByIdResponseIntegrationConfigurationIdentifier
3725
3705
  */
@@ -4277,7 +4257,7 @@ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[k
4277
4257
  */
4278
4258
  export interface Integration {
4279
4259
  /**
4280
- * ID of the [Conversation](#schema_conversation)
4260
+ * ID of the [Integration](#schema_integration)
4281
4261
  * @type {string}
4282
4262
  * @memberof Integration
4283
4263
  */
@@ -4301,19 +4281,19 @@ export interface Integration {
4301
4281
  */
4302
4282
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
4303
4283
  /**
4304
- * Title describing the task
4284
+ * URL of the [Integration](#schema_integration)
4305
4285
  * @type {string}
4306
4286
  * @memberof Integration
4307
4287
  */
4308
4288
  'url': string;
4309
4289
  /**
4310
- * Type of the task
4290
+ * Name of the [Integration](#schema_integration)
4311
4291
  * @type {string}
4312
4292
  * @memberof Integration
4313
4293
  */
4314
4294
  'name': string;
4315
4295
  /**
4316
- * Type of the task
4296
+ * Version of the [Integration](#schema_integration)
4317
4297
  * @type {string}
4318
4298
  * @memberof Integration
4319
4299
  */
@@ -4772,7 +4752,7 @@ export interface ListBotsResponse {
4772
4752
  */
4773
4753
  export interface ListBotsResponseBotsInner {
4774
4754
  /**
4775
- * User id
4755
+ * Id of the [Bot](#schema_bot)
4776
4756
  * @type {string}
4777
4757
  * @memberof ListBotsResponseBotsInner
4778
4758
  */
@@ -4896,6 +4876,12 @@ export interface ListFilesResponseFilesInner {
4896
4876
  * @memberof ListFilesResponseFilesInner
4897
4877
  */
4898
4878
  'name': string | null;
4879
+ /**
4880
+ * If the file is not uploaded yet, this will be set to a `null` value. If the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
4881
+ * @type {string}
4882
+ * @memberof ListFilesResponseFilesInner
4883
+ */
4884
+ 'url': string | null;
4899
4885
  /**
4900
4886
  * File size in bytes. Non-null if file upload status is \"COMPLETE\".
4901
4887
  * @type {number}
@@ -4933,45 +4919,40 @@ export interface ListFilesResponseFilesInner {
4933
4919
  * @type {Array<string>}
4934
4920
  * @memberof ListFilesResponseFilesInner
4935
4921
  */
4936
- 'accessPolicies': Array<string>;
4937
- /**
4938
- * Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created.
4939
- * @type {string}
4940
- * @memberof ListFilesResponseFilesInner
4941
- */
4942
- 'indexingStatus'?: ListFilesResponseFilesInnerIndexingStatusEnum;
4922
+ 'accessPolicies': Array<ListFilesResponseFilesInnerAccessPoliciesEnum>;
4943
4923
  /**
4944
- * Last failure reason of the file indexing if the indexing status is \"FAILED\".
4945
- * @type {string}
4924
+ * Whether the file was requested to be indexed for search or not.
4925
+ * @type {boolean}
4946
4926
  * @memberof ListFilesResponseFilesInner
4947
4927
  */
4948
- 'indexingFailureReason'?: string;
4928
+ 'index': boolean;
4949
4929
  /**
4950
- * Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. The status will be set to \"COMPLETE\" once the file content has been uploaded successfully. If the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details.
4930
+ * Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully. If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file. However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped). Once the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field.
4951
4931
  * @type {string}
4952
4932
  * @memberof ListFilesResponseFilesInner
4953
4933
  */
4954
- 'uploadStatus': ListFilesResponseFilesInnerUploadStatusEnum;
4934
+ 'status': ListFilesResponseFilesInnerStatusEnum;
4955
4935
  /**
4956
- * Failure reason of the file upload if the upload status is \"FAILED\".
4936
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
4957
4937
  * @type {string}
4958
4938
  * @memberof ListFilesResponseFilesInner
4959
4939
  */
4960
- 'uploadFailureReason'?: string;
4940
+ 'failedStatusReason'?: string;
4961
4941
  }
4962
- export declare const ListFilesResponseFilesInnerIndexingStatusEnum: {
4963
- readonly Pending: "PENDING";
4964
- readonly InProgress: "IN_PROGRESS";
4965
- readonly Complete: "COMPLETE";
4966
- readonly Failed: "FAILED";
4942
+ export declare const ListFilesResponseFilesInnerAccessPoliciesEnum: {
4943
+ readonly Integrations: "integrations";
4944
+ readonly PublicContent: "public_content";
4967
4945
  };
4968
- export type ListFilesResponseFilesInnerIndexingStatusEnum = typeof ListFilesResponseFilesInnerIndexingStatusEnum[keyof typeof ListFilesResponseFilesInnerIndexingStatusEnum];
4969
- export declare const ListFilesResponseFilesInnerUploadStatusEnum: {
4970
- readonly Pending: "PENDING";
4971
- readonly Complete: "COMPLETE";
4972
- readonly Failed: "FAILED";
4946
+ export type ListFilesResponseFilesInnerAccessPoliciesEnum = typeof ListFilesResponseFilesInnerAccessPoliciesEnum[keyof typeof ListFilesResponseFilesInnerAccessPoliciesEnum];
4947
+ export declare const ListFilesResponseFilesInnerStatusEnum: {
4948
+ readonly UploadPending: "UPLOAD_PENDING";
4949
+ readonly UploadFailed: "UPLOAD_FAILED";
4950
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
4951
+ readonly IndexingPending: "INDEXING_PENDING";
4952
+ readonly IndexingFailed: "INDEXING_FAILED";
4953
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
4973
4954
  };
4974
- export type ListFilesResponseFilesInnerUploadStatusEnum = typeof ListFilesResponseFilesInnerUploadStatusEnum[keyof typeof ListFilesResponseFilesInnerUploadStatusEnum];
4955
+ export type ListFilesResponseFilesInnerStatusEnum = typeof ListFilesResponseFilesInnerStatusEnum[keyof typeof ListFilesResponseFilesInnerStatusEnum];
4975
4956
  /**
4976
4957
  *
4977
4958
  * @export
@@ -5011,19 +4992,19 @@ export interface ListIntegrationsResponse {
5011
4992
  */
5012
4993
  export interface ListIntegrationsResponseIntegrationsInner {
5013
4994
  /**
5014
- * User id
4995
+ * ID of the [Integration](#schema_integration)
5015
4996
  * @type {string}
5016
4997
  * @memberof ListIntegrationsResponseIntegrationsInner
5017
4998
  */
5018
4999
  'id': string;
5019
5000
  /**
5020
- * Unique identifier of the integration that was installed on the bot
5001
+ * Name of the [Integration](#schema_integration)
5021
5002
  * @type {string}
5022
5003
  * @memberof ListIntegrationsResponseIntegrationsInner
5023
5004
  */
5024
5005
  'name': string;
5025
5006
  /**
5026
- * Unique identifier of the integration that was installed on the bot
5007
+ * Version of the [Integration](#schema_integration)
5027
5008
  * @type {string}
5028
5009
  * @memberof ListIntegrationsResponseIntegrationsInner
5029
5010
  */
@@ -5167,19 +5148,19 @@ export interface ListPublicIntegrationsResponse {
5167
5148
  */
5168
5149
  export interface ListPublicIntegrationsResponseIntegrationsInner {
5169
5150
  /**
5170
- * User id
5151
+ * ID of the [Integration](#schema_integration)
5171
5152
  * @type {string}
5172
5153
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
5173
5154
  */
5174
5155
  'id': string;
5175
5156
  /**
5176
- * Unique identifier of the integration that was installed on the bot
5157
+ * Name of the [Integration](#schema_integration)
5177
5158
  * @type {string}
5178
5159
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
5179
5160
  */
5180
5161
  'name': string;
5181
5162
  /**
5182
- * Unique identifier of the integration that was installed on the bot
5163
+ * Version of the [Integration](#schema_integration)
5183
5164
  * @type {string}
5184
5165
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
5185
5166
  */
@@ -5572,7 +5553,7 @@ export interface ListWorkspacesResponse {
5572
5553
  */
5573
5554
  export interface Message {
5574
5555
  /**
5575
- * ID of the [Conversation](#schema_conversation)
5556
+ * Id of the [Message](#schema_message)
5576
5557
  * @type {string}
5577
5558
  * @memberof Message
5578
5559
  */
@@ -5584,7 +5565,7 @@ export interface Message {
5584
5565
  */
5585
5566
  'createdAt': string;
5586
5567
  /**
5587
- * Type of the task
5568
+ * Type of the [Message](#schema_message) represents the resource type that the message is related to
5588
5569
  * @type {string}
5589
5570
  * @memberof Message
5590
5571
  */
@@ -5604,7 +5585,7 @@ export interface Message {
5604
5585
  */
5605
5586
  'direction': MessageDirectionEnum;
5606
5587
  /**
5607
- * ID of the [Conversation](#schema_conversation)
5588
+ * ID of the [User](#schema_user)
5608
5589
  * @type {string}
5609
5590
  * @memberof Message
5610
5591
  */
@@ -5653,6 +5634,12 @@ export interface ModelFile {
5653
5634
  * @memberof ModelFile
5654
5635
  */
5655
5636
  'name': string | null;
5637
+ /**
5638
+ * If the file is not uploaded yet, this will be set to a `null` value. If the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
5639
+ * @type {string}
5640
+ * @memberof ModelFile
5641
+ */
5642
+ 'url': string | null;
5656
5643
  /**
5657
5644
  * File size in bytes. Non-null if file upload status is \"COMPLETE\".
5658
5645
  * @type {number}
@@ -5690,45 +5677,40 @@ export interface ModelFile {
5690
5677
  * @type {Array<string>}
5691
5678
  * @memberof ModelFile
5692
5679
  */
5693
- 'accessPolicies': Array<string>;
5680
+ 'accessPolicies': Array<ModelFileAccessPoliciesEnum>;
5694
5681
  /**
5695
- * Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created.
5696
- * @type {string}
5697
- * @memberof ModelFile
5698
- */
5699
- 'indexingStatus'?: ModelFileIndexingStatusEnum;
5700
- /**
5701
- * Last failure reason of the file indexing if the indexing status is \"FAILED\".
5702
- * @type {string}
5682
+ * Whether the file was requested to be indexed for search or not.
5683
+ * @type {boolean}
5703
5684
  * @memberof ModelFile
5704
5685
  */
5705
- 'indexingFailureReason'?: string;
5686
+ 'index': boolean;
5706
5687
  /**
5707
- * Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. The status will be set to \"COMPLETE\" once the file content has been uploaded successfully. If the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details.
5688
+ * Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully. If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file. However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped). Once the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field.
5708
5689
  * @type {string}
5709
5690
  * @memberof ModelFile
5710
5691
  */
5711
- 'uploadStatus': ModelFileUploadStatusEnum;
5692
+ 'status': ModelFileStatusEnum;
5712
5693
  /**
5713
- * Failure reason of the file upload if the upload status is \"FAILED\".
5694
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
5714
5695
  * @type {string}
5715
5696
  * @memberof ModelFile
5716
5697
  */
5717
- 'uploadFailureReason'?: string;
5698
+ 'failedStatusReason'?: string;
5718
5699
  }
5719
- export declare const ModelFileIndexingStatusEnum: {
5720
- readonly Pending: "PENDING";
5721
- readonly InProgress: "IN_PROGRESS";
5722
- readonly Complete: "COMPLETE";
5723
- readonly Failed: "FAILED";
5700
+ export declare const ModelFileAccessPoliciesEnum: {
5701
+ readonly Integrations: "integrations";
5702
+ readonly PublicContent: "public_content";
5724
5703
  };
5725
- export type ModelFileIndexingStatusEnum = typeof ModelFileIndexingStatusEnum[keyof typeof ModelFileIndexingStatusEnum];
5726
- export declare const ModelFileUploadStatusEnum: {
5727
- readonly Pending: "PENDING";
5728
- readonly Complete: "COMPLETE";
5729
- readonly Failed: "FAILED";
5704
+ export type ModelFileAccessPoliciesEnum = typeof ModelFileAccessPoliciesEnum[keyof typeof ModelFileAccessPoliciesEnum];
5705
+ export declare const ModelFileStatusEnum: {
5706
+ readonly UploadPending: "UPLOAD_PENDING";
5707
+ readonly UploadFailed: "UPLOAD_FAILED";
5708
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
5709
+ readonly IndexingPending: "INDEXING_PENDING";
5710
+ readonly IndexingFailed: "INDEXING_FAILED";
5711
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
5730
5712
  };
5731
- export type ModelFileUploadStatusEnum = typeof ModelFileUploadStatusEnum[keyof typeof ModelFileUploadStatusEnum];
5713
+ export type ModelFileStatusEnum = typeof ModelFileStatusEnum[keyof typeof ModelFileStatusEnum];
5732
5714
  /**
5733
5715
  *
5734
5716
  * @export
@@ -6079,7 +6061,7 @@ export interface SetWorkspacePaymentMethodResponsePaymentMethod {
6079
6061
  */
6080
6062
  export interface State {
6081
6063
  /**
6082
- * ID of the [Conversation](#schema_conversation)
6064
+ * Id of the [State](#schema_state)
6083
6065
  * @type {string}
6084
6066
  * @memberof State
6085
6067
  */
@@ -6097,7 +6079,7 @@ export interface State {
6097
6079
  */
6098
6080
  'updatedAt': string;
6099
6081
  /**
6100
- * ID of the [Conversation](#schema_conversation)
6082
+ * Id of the [Bot](#schema_bot)
6101
6083
  * @type {string}
6102
6084
  * @memberof State
6103
6085
  */
@@ -6115,7 +6097,7 @@ export interface State {
6115
6097
  */
6116
6098
  'userId'?: string;
6117
6099
  /**
6118
- * Type of the task
6100
+ * Name of the [State](#schema_state) which is declared inside the bot definition
6119
6101
  * @type {string}
6120
6102
  * @memberof State
6121
6103
  */
@@ -6330,7 +6312,7 @@ export interface TableSchemaPropertiesValueXZui {
6330
6312
  */
6331
6313
  export interface Task {
6332
6314
  /**
6333
- * ID of the [Conversation](#schema_conversation)
6315
+ * Id of the [Task](#schema_task)
6334
6316
  * @type {string}
6335
6317
  * @memberof Task
6336
6318
  */
@@ -6708,7 +6690,7 @@ export interface UpdateBotBodyRecurringEventsValue {
6708
6690
  */
6709
6691
  'schedule': CreateBotBodyRecurringEventsValueSchedule;
6710
6692
  /**
6711
- * Unique identifier of the integration that was installed on the bot
6693
+ *
6712
6694
  * @type {string}
6713
6695
  * @memberof UpdateBotBodyRecurringEventsValue
6714
6696
  */
@@ -6764,13 +6746,11 @@ export type UpdateBotBodyStatesValueTypeEnum = typeof UpdateBotBodyStatesValueTy
6764
6746
  export interface UpdateBotBodySubscriptions {
6765
6747
  /**
6766
6748
  *
6767
- * @type {{ [key: string]: { [key: string]: any; } | null; }}
6749
+ * @type {{ [key: string]: object | null; }}
6768
6750
  * @memberof UpdateBotBodySubscriptions
6769
6751
  */
6770
6752
  'events': {
6771
- [key: string]: {
6772
- [key: string]: any;
6773
- } | null;
6753
+ [key: string]: object | null;
6774
6754
  } | null;
6775
6755
  }
6776
6756
  /**
@@ -6857,32 +6837,41 @@ export interface UpdateConversationResponse {
6857
6837
  /**
6858
6838
  *
6859
6839
  * @export
6860
- * @interface UpdateFileMetadataBody
6840
+ * @interface UpdateFileBody
6861
6841
  */
6862
- export interface UpdateFileMetadataBody {
6842
+ export interface UpdateFileBody {
6863
6843
  /**
6864
- * The file tags to update as an object of key/value pairs with string (text) values. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
6844
+ * The file tags to update as an object of key/value pairs with string (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
6865
6845
  * @type {{ [key: string]: string | null; }}
6866
- * @memberof UpdateFileMetadataBody
6846
+ * @memberof UpdateFileBody
6867
6847
  */
6868
- 'tags': {
6848
+ 'tags'?: {
6869
6849
  [key: string]: string | null;
6870
6850
  };
6851
+ /**
6852
+ * New access policies to set for the file. Omit to keep existing policies intact.
6853
+ * @type {Array<string>}
6854
+ * @memberof UpdateFileBody
6855
+ */
6856
+ 'accessPolicies'?: Array<UpdateFileBodyAccessPoliciesEnum>;
6871
6857
  }
6858
+ export declare const UpdateFileBodyAccessPoliciesEnum: {
6859
+ readonly Integrations: "integrations";
6860
+ readonly PublicContent: "public_content";
6861
+ };
6862
+ export type UpdateFileBodyAccessPoliciesEnum = typeof UpdateFileBodyAccessPoliciesEnum[keyof typeof UpdateFileBodyAccessPoliciesEnum];
6872
6863
  /**
6873
6864
  *
6874
6865
  * @export
6875
- * @interface UpdateFileMetadataResponse
6866
+ * @interface UpdateFileResponse
6876
6867
  */
6877
- export interface UpdateFileMetadataResponse {
6868
+ export interface UpdateFileResponse {
6878
6869
  /**
6879
- * The updated tags of the file.
6880
- * @type {{ [key: string]: string; }}
6881
- * @memberof UpdateFileMetadataResponse
6870
+ *
6871
+ * @type {GetFileResponseFile}
6872
+ * @memberof UpdateFileResponse
6882
6873
  */
6883
- 'tags': {
6884
- [key: string]: string;
6885
- };
6874
+ 'file': GetFileResponseFile;
6886
6875
  }
6887
6876
  /**
6888
6877
  *
@@ -7102,7 +7091,7 @@ export interface UpdateIntegrationBodyConfiguration {
7102
7091
  */
7103
7092
  export interface UpdateIntegrationBodyConfigurationIdentifier {
7104
7093
  /**
7105
- * Title describing the task
7094
+ *
7106
7095
  * @type {string}
7107
7096
  * @memberof UpdateIntegrationBodyConfigurationIdentifier
7108
7097
  */
@@ -7148,13 +7137,13 @@ export interface UpdateIntegrationBodyEntitiesValue {
7148
7137
  */
7149
7138
  export interface UpdateIntegrationBodyIdentifier {
7150
7139
  /**
7151
- * Title describing the task
7140
+ *
7152
7141
  * @type {string}
7153
7142
  * @memberof UpdateIntegrationBodyIdentifier
7154
7143
  */
7155
7144
  'extractScript'?: string | null;
7156
7145
  /**
7157
- * Title describing the task
7146
+ *
7158
7147
  * @type {string}
7159
7148
  * @memberof UpdateIntegrationBodyIdentifier
7160
7149
  */
@@ -7228,7 +7217,7 @@ export interface UpdateIntegrationResponse {
7228
7217
  */
7229
7218
  export interface UpdateMessageBody {
7230
7219
  /**
7231
- * 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.
7232
7221
  * @type {{ [key: string]: string; }}
7233
7222
  * @memberof UpdateMessageBody
7234
7223
  */
@@ -7975,7 +7964,7 @@ export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
7975
7964
  */
7976
7965
  export interface User {
7977
7966
  /**
7978
- * ID of the [Conversation](#schema_conversation)
7967
+ * Id of the [User](#schema_user)
7979
7968
  * @type {string}
7980
7969
  * @memberof User
7981
7970
  */
@@ -8539,19 +8528,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8539
8528
  */
8540
8529
  getEvent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8541
8530
  /**
8542
- * Returns a presigned URL to download the file content.
8543
- * @param {string} id File ID
8544
- * @param {*} [options] Override http request option.
8545
- * @throws {RequiredError}
8546
- */
8547
- getFileContent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8548
- /**
8549
- * Get file metadata
8531
+ * Get file
8550
8532
  * @param {string} id File ID
8551
8533
  * @param {*} [options] Override http request option.
8552
8534
  * @throws {RequiredError}
8553
8535
  */
8554
- getFileMetadata: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8536
+ getFile: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8555
8537
  /**
8556
8538
  * Get integration
8557
8539
  * @param {string} id Integration ID
@@ -8768,12 +8750,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8768
8750
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8769
8751
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8770
8752
  * @param {Array<string>} [participantIds] Filter by participant ids
8753
+ * @param {string} [integrationName] Filter by integration name
8771
8754
  * @param {*} [options] Override http request option.
8772
8755
  * @throws {RequiredError}
8773
8756
  */
8774
8757
  listConversations: (nextToken?: string, tags?: {
8775
8758
  [key: string]: string;
8776
- } | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8759
+ } | undefined, participantIds?: Array<string>, integrationName?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8777
8760
  /**
8778
8761
  * Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
8779
8762
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -8788,13 +8771,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8788
8771
  listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, status?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8789
8772
  /**
8790
8773
  * List files for bot
8791
- * @param {string} botId Bot ID
8792
8774
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8793
8775
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8794
8776
  * @param {*} [options] Override http request option.
8795
8777
  * @throws {RequiredError}
8796
8778
  */
8797
- listFiles: (botId: string, nextToken?: string, tags?: {
8779
+ listFiles: (nextToken?: string, tags?: {
8798
8780
  [key: string]: string;
8799
8781
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8800
8782
  /**
@@ -8815,7 +8797,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8815
8797
  */
8816
8798
  listIntegrations: (nextToken?: string, name?: string, version?: string, dev?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8817
8799
  /**
8818
- * 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).
8819
8801
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8820
8802
  * @param {string} [conversationId] Conversation id
8821
8803
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -8858,7 +8840,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8858
8840
  [key: string]: string;
8859
8841
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8860
8842
  /**
8861
- * 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).
8862
8844
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8863
8845
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8864
8846
  * @param {string} [conversationId] Conversation id
@@ -8881,7 +8863,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8881
8863
  */
8882
8864
  listUsageHistory: (type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8883
8865
  /**
8884
- * 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).
8885
8867
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8886
8868
  * @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
8887
8869
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -8964,7 +8946,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8964
8946
  runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8965
8947
  /**
8966
8948
  * Search files
8967
- * @param {string} botId Bot ID
8968
8949
  * @param {string} query Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
8969
8950
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8970
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
@@ -8972,7 +8953,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8972
8953
  * @param {*} [options] Override http request option.
8973
8954
  * @throws {RequiredError}
8974
8955
  */
8975
- searchFiles: (botId: string, query: string, tags?: {
8956
+ searchFiles: (query: string, tags?: {
8976
8957
  [key: string]: string;
8977
8958
  } | undefined, contextDepth?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8978
8959
  /**
@@ -9040,13 +9021,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
9040
9021
  */
9041
9022
  updateConversation: (id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9042
9023
  /**
9043
- * Update file metadata
9024
+ * Update file
9044
9025
  * @param {string} id File ID
9045
- * @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
9026
+ * @param {UpdateFileBody} [updateFileBody] File metadata to update.
9046
9027
  * @param {*} [options] Override http request option.
9047
9028
  * @throws {RequiredError}
9048
9029
  */
9049
- updateFileMetadata: (id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9030
+ updateFile: (id: string, updateFileBody?: UpdateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9050
9031
  /**
9051
9032
  * Update integration
9052
9033
  * @param {string} id Integration ID
@@ -9471,19 +9452,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9471
9452
  */
9472
9453
  getEvent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
9473
9454
  /**
9474
- * Returns a presigned URL to download the file content.
9455
+ * Get file
9475
9456
  * @param {string} id File ID
9476
9457
  * @param {*} [options] Override http request option.
9477
9458
  * @throws {RequiredError}
9478
9459
  */
9479
- getFileContent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileContentResponse>>;
9480
- /**
9481
- * Get file metadata
9482
- * @param {string} id File ID
9483
- * @param {*} [options] Override http request option.
9484
- * @throws {RequiredError}
9485
- */
9486
- getFileMetadata(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileMetadataResponse>>;
9460
+ getFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileResponse>>;
9487
9461
  /**
9488
9462
  * Get integration
9489
9463
  * @param {string} id Integration ID
@@ -9700,12 +9674,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9700
9674
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9701
9675
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9702
9676
  * @param {Array<string>} [participantIds] Filter by participant ids
9677
+ * @param {string} [integrationName] Filter by integration name
9703
9678
  * @param {*} [options] Override http request option.
9704
9679
  * @throws {RequiredError}
9705
9680
  */
9706
9681
  listConversations(nextToken?: string, tags?: {
9707
9682
  [key: string]: string;
9708
- } | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
9683
+ } | undefined, participantIds?: Array<string>, integrationName?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
9709
9684
  /**
9710
9685
  * Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
9711
9686
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -9720,13 +9695,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9720
9695
  listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, status?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
9721
9696
  /**
9722
9697
  * List files for bot
9723
- * @param {string} botId Bot ID
9724
9698
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9725
9699
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9726
9700
  * @param {*} [options] Override http request option.
9727
9701
  * @throws {RequiredError}
9728
9702
  */
9729
- listFiles(botId: string, nextToken?: string, tags?: {
9703
+ listFiles(nextToken?: string, tags?: {
9730
9704
  [key: string]: string;
9731
9705
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
9732
9706
  /**
@@ -9747,7 +9721,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9747
9721
  */
9748
9722
  listIntegrations(nextToken?: string, name?: string, version?: string, dev?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationsResponse>>;
9749
9723
  /**
9750
- * 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).
9751
9725
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9752
9726
  * @param {string} [conversationId] Conversation id
9753
9727
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -9790,7 +9764,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9790
9764
  [key: string]: string;
9791
9765
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTablesResponse>>;
9792
9766
  /**
9793
- * 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).
9794
9768
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9795
9769
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9796
9770
  * @param {string} [conversationId] Conversation id
@@ -9813,7 +9787,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9813
9787
  */
9814
9788
  listUsageHistory(type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsageHistoryResponse>>;
9815
9789
  /**
9816
- * 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).
9817
9791
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9818
9792
  * @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
9819
9793
  * @param {{ [key: string]: string; }} [tags] Filter by tags
@@ -9896,7 +9870,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9896
9870
  runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
9897
9871
  /**
9898
9872
  * Search files
9899
- * @param {string} botId Bot ID
9900
9873
  * @param {string} query Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
9901
9874
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9902
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
@@ -9904,7 +9877,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9904
9877
  * @param {*} [options] Override http request option.
9905
9878
  * @throws {RequiredError}
9906
9879
  */
9907
- searchFiles(botId: string, query: string, tags?: {
9880
+ searchFiles(query: string, tags?: {
9908
9881
  [key: string]: string;
9909
9882
  } | undefined, contextDepth?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
9910
9883
  /**
@@ -9972,13 +9945,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9972
9945
  */
9973
9946
  updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateConversationResponse>>;
9974
9947
  /**
9975
- * Update file metadata
9948
+ * Update file
9976
9949
  * @param {string} id File ID
9977
- * @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
9950
+ * @param {UpdateFileBody} [updateFileBody] File metadata to update.
9978
9951
  * @param {*} [options] Override http request option.
9979
9952
  * @throws {RequiredError}
9980
9953
  */
9981
- updateFileMetadata(id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFileMetadataResponse>>;
9954
+ updateFile(id: string, updateFileBody?: UpdateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFileResponse>>;
9982
9955
  /**
9983
9956
  * Update integration
9984
9957
  * @param {string} id Integration ID
@@ -10387,19 +10360,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10387
10360
  */
10388
10361
  getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
10389
10362
  /**
10390
- * Returns a presigned URL to download the file content.
10391
- * @param {DefaultApiGetFileContentRequest} requestParameters Request parameters.
10363
+ * Get file
10364
+ * @param {DefaultApiGetFileRequest} requestParameters Request parameters.
10392
10365
  * @param {*} [options] Override http request option.
10393
10366
  * @throws {RequiredError}
10394
10367
  */
10395
- getFileContent(requestParameters: DefaultApiGetFileContentRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileContentResponse>;
10396
- /**
10397
- * Get file metadata
10398
- * @param {DefaultApiGetFileMetadataRequest} requestParameters Request parameters.
10399
- * @param {*} [options] Override http request option.
10400
- * @throws {RequiredError}
10401
- */
10402
- getFileMetadata(requestParameters: DefaultApiGetFileMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileMetadataResponse>;
10368
+ getFile(requestParameters: DefaultApiGetFileRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileResponse>;
10403
10369
  /**
10404
10370
  * Get integration
10405
10371
  * @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
@@ -10609,7 +10575,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10609
10575
  * @param {*} [options] Override http request option.
10610
10576
  * @throws {RequiredError}
10611
10577
  */
10612
- listFiles(requestParameters: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
10578
+ listFiles(requestParameters?: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
10613
10579
  /**
10614
10580
  * List IAKs (Integration Api Keys) of an integration
10615
10581
  * @param {DefaultApiListIntegrationApiKeysRequest} requestParameters Request parameters.
@@ -10625,7 +10591,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10625
10591
  */
10626
10592
  listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListIntegrationsResponse>;
10627
10593
  /**
10628
- * 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).
10629
10595
  * @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
10630
10596
  * @param {*} [options] Override http request option.
10631
10597
  * @throws {RequiredError}
@@ -10659,7 +10625,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10659
10625
  */
10660
10626
  listTables(requestParameters?: DefaultApiListTablesRequest, options?: AxiosRequestConfig): AxiosPromise<ListTablesResponse>;
10661
10627
  /**
10662
- * 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).
10663
10629
  * @param {DefaultApiListTasksRequest} requestParameters Request parameters.
10664
10630
  * @param {*} [options] Override http request option.
10665
10631
  * @throws {RequiredError}
@@ -10673,7 +10639,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10673
10639
  */
10674
10640
  listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsageHistoryResponse>;
10675
10641
  /**
10676
- * 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).
10677
10643
  * @param {DefaultApiListUsersRequest} requestParameters Request parameters.
10678
10644
  * @param {*} [options] Override http request option.
10679
10645
  * @throws {RequiredError}
@@ -10806,12 +10772,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10806
10772
  */
10807
10773
  updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateConversationResponse>;
10808
10774
  /**
10809
- * Update file metadata
10810
- * @param {DefaultApiUpdateFileMetadataRequest} requestParameters Request parameters.
10775
+ * Update file
10776
+ * @param {DefaultApiUpdateFileRequest} requestParameters Request parameters.
10811
10777
  * @param {*} [options] Override http request option.
10812
10778
  * @throws {RequiredError}
10813
10779
  */
10814
- updateFileMetadata(requestParameters: DefaultApiUpdateFileMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateFileMetadataResponse>;
10780
+ updateFile(requestParameters: DefaultApiUpdateFileRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateFileResponse>;
10815
10781
  /**
10816
10782
  * Update integration
10817
10783
  * @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.
@@ -11558,28 +11524,15 @@ export interface DefaultApiGetEventRequest {
11558
11524
  readonly id: string;
11559
11525
  }
11560
11526
  /**
11561
- * Request parameters for getFileContent operation in DefaultApi.
11527
+ * Request parameters for getFile operation in DefaultApi.
11562
11528
  * @export
11563
- * @interface DefaultApiGetFileContentRequest
11529
+ * @interface DefaultApiGetFileRequest
11564
11530
  */
11565
- export interface DefaultApiGetFileContentRequest {
11531
+ export interface DefaultApiGetFileRequest {
11566
11532
  /**
11567
11533
  * File ID
11568
11534
  * @type {string}
11569
- * @memberof DefaultApiGetFileContent
11570
- */
11571
- readonly id: string;
11572
- }
11573
- /**
11574
- * Request parameters for getFileMetadata operation in DefaultApi.
11575
- * @export
11576
- * @interface DefaultApiGetFileMetadataRequest
11577
- */
11578
- export interface DefaultApiGetFileMetadataRequest {
11579
- /**
11580
- * File ID
11581
- * @type {string}
11582
- * @memberof DefaultApiGetFileMetadata
11535
+ * @memberof DefaultApiGetFile
11583
11536
  */
11584
11537
  readonly id: string;
11585
11538
  }
@@ -12092,6 +12045,12 @@ export interface DefaultApiListConversationsRequest {
12092
12045
  * @memberof DefaultApiListConversations
12093
12046
  */
12094
12047
  readonly participantIds?: Array<string>;
12048
+ /**
12049
+ * Filter by integration name
12050
+ * @type {string}
12051
+ * @memberof DefaultApiListConversations
12052
+ */
12053
+ readonly integrationName?: string;
12095
12054
  }
12096
12055
  /**
12097
12056
  * Request parameters for listEvents operation in DefaultApi.
@@ -12142,12 +12101,6 @@ export interface DefaultApiListEventsRequest {
12142
12101
  * @interface DefaultApiListFilesRequest
12143
12102
  */
12144
12103
  export interface DefaultApiListFilesRequest {
12145
- /**
12146
- * Bot ID
12147
- * @type {string}
12148
- * @memberof DefaultApiListFiles
12149
- */
12150
- readonly botId: string;
12151
12104
  /**
12152
12105
  * Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
12153
12106
  * @type {string}
@@ -12561,12 +12514,6 @@ export interface DefaultApiRunVrlRequest {
12561
12514
  * @interface DefaultApiSearchFilesRequest
12562
12515
  */
12563
12516
  export interface DefaultApiSearchFilesRequest {
12564
- /**
12565
- * Bot ID
12566
- * @type {string}
12567
- * @memberof DefaultApiSearchFiles
12568
- */
12569
- readonly botId: string;
12570
12517
  /**
12571
12518
  * Query expressed in natural language to retrieve matching text passages within all indexed files in the bot using semantical search.
12572
12519
  * @type {string}
@@ -12747,23 +12694,23 @@ export interface DefaultApiUpdateConversationRequest {
12747
12694
  readonly updateConversationBody?: UpdateConversationBody;
12748
12695
  }
12749
12696
  /**
12750
- * Request parameters for updateFileMetadata operation in DefaultApi.
12697
+ * Request parameters for updateFile operation in DefaultApi.
12751
12698
  * @export
12752
- * @interface DefaultApiUpdateFileMetadataRequest
12699
+ * @interface DefaultApiUpdateFileRequest
12753
12700
  */
12754
- export interface DefaultApiUpdateFileMetadataRequest {
12701
+ export interface DefaultApiUpdateFileRequest {
12755
12702
  /**
12756
12703
  * File ID
12757
12704
  * @type {string}
12758
- * @memberof DefaultApiUpdateFileMetadata
12705
+ * @memberof DefaultApiUpdateFile
12759
12706
  */
12760
12707
  readonly id: string;
12761
12708
  /**
12762
12709
  * File metadata to update.
12763
- * @type {UpdateFileMetadataBody}
12764
- * @memberof DefaultApiUpdateFileMetadata
12710
+ * @type {UpdateFileBody}
12711
+ * @memberof DefaultApiUpdateFile
12765
12712
  */
12766
- readonly updateFileMetadataBody?: UpdateFileMetadataBody;
12713
+ readonly updateFileBody?: UpdateFileBody;
12767
12714
  }
12768
12715
  /**
12769
12716
  * Request parameters for updateIntegration operation in DefaultApi.
@@ -13320,21 +13267,13 @@ export declare class DefaultApi extends BaseAPI {
13320
13267
  */
13321
13268
  getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any>>;
13322
13269
  /**
13323
- * Returns a presigned URL to download the file content.
13324
- * @param {DefaultApiGetFileContentRequest} requestParameters Request parameters.
13325
- * @param {*} [options] Override http request option.
13326
- * @throws {RequiredError}
13327
- * @memberof DefaultApi
13328
- */
13329
- getFileContent(requestParameters: DefaultApiGetFileContentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFileContentResponse, any>>;
13330
- /**
13331
- * Get file metadata
13332
- * @param {DefaultApiGetFileMetadataRequest} requestParameters Request parameters.
13270
+ * Get file
13271
+ * @param {DefaultApiGetFileRequest} requestParameters Request parameters.
13333
13272
  * @param {*} [options] Override http request option.
13334
13273
  * @throws {RequiredError}
13335
13274
  * @memberof DefaultApi
13336
13275
  */
13337
- getFileMetadata(requestParameters: DefaultApiGetFileMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFileMetadataResponse, any>>;
13276
+ getFile(requestParameters: DefaultApiGetFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFileResponse, any>>;
13338
13277
  /**
13339
13278
  * Get integration
13340
13279
  * @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
@@ -13574,7 +13513,7 @@ export declare class DefaultApi extends BaseAPI {
13574
13513
  * @throws {RequiredError}
13575
13514
  * @memberof DefaultApi
13576
13515
  */
13577
- listFiles(requestParameters: DefaultApiListFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
13516
+ listFiles(requestParameters?: DefaultApiListFilesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
13578
13517
  /**
13579
13518
  * List IAKs (Integration Api Keys) of an integration
13580
13519
  * @param {DefaultApiListIntegrationApiKeysRequest} requestParameters Request parameters.
@@ -13592,7 +13531,7 @@ export declare class DefaultApi extends BaseAPI {
13592
13531
  */
13593
13532
  listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIntegrationsResponse, any>>;
13594
13533
  /**
13595
- * 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).
13596
13535
  * @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
13597
13536
  * @param {*} [options] Override http request option.
13598
13537
  * @throws {RequiredError}
@@ -13631,7 +13570,7 @@ export declare class DefaultApi extends BaseAPI {
13631
13570
  */
13632
13571
  listTables(requestParameters?: DefaultApiListTablesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTablesResponse, any>>;
13633
13572
  /**
13634
- * 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).
13635
13574
  * @param {DefaultApiListTasksRequest} requestParameters Request parameters.
13636
13575
  * @param {*} [options] Override http request option.
13637
13576
  * @throws {RequiredError}
@@ -13647,7 +13586,7 @@ export declare class DefaultApi extends BaseAPI {
13647
13586
  */
13648
13587
  listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsageHistoryResponse, any>>;
13649
13588
  /**
13650
- * 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).
13651
13590
  * @param {DefaultApiListUsersRequest} requestParameters Request parameters.
13652
13591
  * @param {*} [options] Override http request option.
13653
13592
  * @throws {RequiredError}
@@ -13799,13 +13738,13 @@ export declare class DefaultApi extends BaseAPI {
13799
13738
  */
13800
13739
  updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateConversationResponse, any>>;
13801
13740
  /**
13802
- * Update file metadata
13803
- * @param {DefaultApiUpdateFileMetadataRequest} requestParameters Request parameters.
13741
+ * Update file
13742
+ * @param {DefaultApiUpdateFileRequest} requestParameters Request parameters.
13804
13743
  * @param {*} [options] Override http request option.
13805
13744
  * @throws {RequiredError}
13806
13745
  * @memberof DefaultApi
13807
13746
  */
13808
- updateFileMetadata(requestParameters: DefaultApiUpdateFileMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFileMetadataResponse, any>>;
13747
+ updateFile(requestParameters: DefaultApiUpdateFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFileResponse, any>>;
13809
13748
  /**
13810
13749
  * Update integration
13811
13750
  * @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.