@botpress/client 0.14.2 → 0.16.0

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.7
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1061,13 +1061,11 @@ export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTy
1061
1061
  export interface CreateBotBodySubscriptions {
1062
1062
  /**
1063
1063
  * 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; }; }}
1064
+ * @type {{ [key: string]: object; }}
1065
1065
  * @memberof CreateBotBodySubscriptions
1066
1066
  */
1067
1067
  'events': {
1068
- [key: string]: {
1069
- [key: string]: any;
1070
- };
1068
+ [key: string]: object;
1071
1069
  } | null;
1072
1070
  }
1073
1071
  /**
@@ -1236,6 +1234,12 @@ export interface CreateFileBody {
1236
1234
  'tags'?: {
1237
1235
  [key: string]: string;
1238
1236
  };
1237
+ /**
1238
+ * 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.
1239
+ * @type {number}
1240
+ * @memberof CreateFileBody
1241
+ */
1242
+ 'size': number;
1239
1243
  /**
1240
1244
  * 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
1245
  * @type {boolean}
@@ -1334,51 +1338,46 @@ export interface CreateFileResponseFile {
1334
1338
  * @type {Array<string>}
1335
1339
  * @memberof CreateFileResponseFile
1336
1340
  */
1337
- 'accessPolicies': Array<string>;
1338
- /**
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;
1341
+ 'accessPolicies': Array<CreateFileResponseFileAccessPoliciesEnum>;
1344
1342
  /**
1345
- * Last failure reason of the file indexing if the indexing status is \"FAILED\".
1346
- * @type {string}
1343
+ * Whether the file was requested to be indexed for search or not.
1344
+ * @type {boolean}
1347
1345
  * @memberof CreateFileResponseFile
1348
1346
  */
1349
- 'indexingFailureReason'?: string;
1347
+ 'index': boolean;
1350
1348
  /**
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.
1349
+ * 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
1350
  * @type {string}
1353
1351
  * @memberof CreateFileResponseFile
1354
1352
  */
1355
- 'uploadStatus': CreateFileResponseFileUploadStatusEnum;
1353
+ 'status': CreateFileResponseFileStatusEnum;
1356
1354
  /**
1357
- * Failure reason of the file upload if the upload status is \"FAILED\".
1355
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
1358
1356
  * @type {string}
1359
1357
  * @memberof CreateFileResponseFile
1360
1358
  */
1361
- 'uploadFailureReason'?: string;
1359
+ 'failedStatusReason'?: string;
1362
1360
  /**
1363
- * URL to upload the file content. File content needs to be sent to this URL via a POST request.
1361
+ * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
1364
1362
  * @type {string}
1365
1363
  * @memberof CreateFileResponseFile
1366
1364
  */
1367
1365
  'uploadUrl': string;
1368
1366
  }
1369
- export declare const CreateFileResponseFileIndexingStatusEnum: {
1370
- readonly Pending: "PENDING";
1371
- readonly InProgress: "IN_PROGRESS";
1372
- readonly Complete: "COMPLETE";
1373
- readonly Failed: "FAILED";
1367
+ export declare const CreateFileResponseFileAccessPoliciesEnum: {
1368
+ readonly Integrations: "integrations";
1369
+ readonly PublicContent: "public_content";
1374
1370
  };
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";
1371
+ export type CreateFileResponseFileAccessPoliciesEnum = typeof CreateFileResponseFileAccessPoliciesEnum[keyof typeof CreateFileResponseFileAccessPoliciesEnum];
1372
+ export declare const CreateFileResponseFileStatusEnum: {
1373
+ readonly UploadPending: "UPLOAD_PENDING";
1374
+ readonly UploadFailed: "UPLOAD_FAILED";
1375
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
1376
+ readonly IndexingPending: "INDEXING_PENDING";
1377
+ readonly IndexingFailed: "INDEXING_FAILED";
1378
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
1380
1379
  };
1381
- export type CreateFileResponseFileUploadStatusEnum = typeof CreateFileResponseFileUploadStatusEnum[keyof typeof CreateFileResponseFileUploadStatusEnum];
1380
+ export type CreateFileResponseFileStatusEnum = typeof CreateFileResponseFileStatusEnum[keyof typeof CreateFileResponseFileStatusEnum];
1382
1381
  /**
1383
1382
  *
1384
1383
  * @export
@@ -2513,11 +2512,11 @@ export interface FindTableRowsResponse {
2513
2512
  */
2514
2513
  'rows': Array<Row>;
2515
2514
  /**
2516
- * The total number of rows matching the search criteria, regardless of pagination.
2517
- * @type {number}
2515
+ * Flag indicating if there are more rows to fetch.
2516
+ * @type {boolean}
2518
2517
  * @memberof FindTableRowsResponse
2519
2518
  */
2520
- 'count': number;
2519
+ 'hasMore': boolean;
2521
2520
  /**
2522
2521
  *
2523
2522
  * @type {number}
@@ -2530,6 +2529,12 @@ export interface FindTableRowsResponse {
2530
2529
  * @memberof FindTableRowsResponse
2531
2530
  */
2532
2531
  'limit': number;
2532
+ /**
2533
+ * Alerts for minor issues that don\'t block the operation but suggest possible improvements.
2534
+ * @type {Array<string>}
2535
+ * @memberof FindTableRowsResponse
2536
+ */
2537
+ 'warnings'?: Array<string>;
2533
2538
  }
2534
2539
  /**
2535
2540
  *
@@ -2913,69 +2918,62 @@ export interface GetEventResponse {
2913
2918
  /**
2914
2919
  *
2915
2920
  * @export
2916
- * @interface GetFileContentResponse
2921
+ * @interface GetFileResponse
2917
2922
  */
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 {
2923
+ export interface GetFileResponse {
2932
2924
  /**
2933
2925
  *
2934
- * @type {GetFileMetadataResponseFile}
2935
- * @memberof GetFileMetadataResponse
2926
+ * @type {GetFileResponseFile}
2927
+ * @memberof GetFileResponse
2936
2928
  */
2937
- 'file': GetFileMetadataResponseFile;
2929
+ 'file': GetFileResponseFile;
2938
2930
  }
2939
2931
  /**
2940
2932
  *
2941
2933
  * @export
2942
- * @interface GetFileMetadataResponseFile
2934
+ * @interface GetFileResponseFile
2943
2935
  */
2944
- export interface GetFileMetadataResponseFile {
2936
+ export interface GetFileResponseFile {
2945
2937
  /**
2946
2938
  * File ID
2947
2939
  * @type {string}
2948
- * @memberof GetFileMetadataResponseFile
2940
+ * @memberof GetFileResponseFile
2949
2941
  */
2950
2942
  'id': string;
2951
2943
  /**
2952
2944
  * The ID of the bot the file belongs to
2953
2945
  * @type {string}
2954
- * @memberof GetFileMetadataResponseFile
2946
+ * @memberof GetFileResponseFile
2955
2947
  */
2956
2948
  'botId': string;
2957
2949
  /**
2958
2950
  * File name
2959
2951
  * @type {string}
2960
- * @memberof GetFileMetadataResponseFile
2952
+ * @memberof GetFileResponseFile
2961
2953
  */
2962
2954
  'name': string | null;
2955
+ /**
2956
+ * 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.
2957
+ * @type {string}
2958
+ * @memberof GetFileResponseFile
2959
+ */
2960
+ 'url': string | null;
2963
2961
  /**
2964
2962
  * File size in bytes. Non-null if file upload status is \"COMPLETE\".
2965
2963
  * @type {number}
2966
- * @memberof GetFileMetadataResponseFile
2964
+ * @memberof GetFileResponseFile
2967
2965
  */
2968
2966
  'size': number | null;
2969
2967
  /**
2970
2968
  * MIME type of the file\'s content
2971
2969
  * @type {string}
2972
- * @memberof GetFileMetadataResponseFile
2970
+ * @memberof GetFileResponseFile
2973
2971
  */
2974
2972
  'contentType': string;
2975
2973
  /**
2976
2974
  * The tags of the file as an object of key/value pairs
2977
2975
  * @type {{ [key: string]: string; }}
2978
- * @memberof GetFileMetadataResponseFile
2976
+ * @memberof GetFileResponseFile
2979
2977
  */
2980
2978
  'tags': {
2981
2979
  [key: string]: string;
@@ -2983,59 +2981,54 @@ export interface GetFileMetadataResponseFile {
2983
2981
  /**
2984
2982
  * File creation timestamp in ISO 8601 format
2985
2983
  * @type {string}
2986
- * @memberof GetFileMetadataResponseFile
2984
+ * @memberof GetFileResponseFile
2987
2985
  */
2988
2986
  'createdAt': string;
2989
2987
  /**
2990
2988
  * File last update timestamp in ISO 8601 format
2991
2989
  * @type {string}
2992
- * @memberof GetFileMetadataResponseFile
2990
+ * @memberof GetFileResponseFile
2993
2991
  */
2994
2992
  'updatedAt': string;
2995
2993
  /**
2996
2994
  * Access policies configured for the file.
2997
2995
  * @type {Array<string>}
2998
- * @memberof GetFileMetadataResponseFile
2999
- */
3000
- 'accessPolicies': Array<string>;
3001
- /**
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
2996
+ * @memberof GetFileResponseFile
3005
2997
  */
3006
- 'indexingStatus'?: GetFileMetadataResponseFileIndexingStatusEnum;
2998
+ 'accessPolicies': Array<GetFileResponseFileAccessPoliciesEnum>;
3007
2999
  /**
3008
- * Last failure reason of the file indexing if the indexing status is \"FAILED\".
3009
- * @type {string}
3010
- * @memberof GetFileMetadataResponseFile
3000
+ * Whether the file was requested to be indexed for search or not.
3001
+ * @type {boolean}
3002
+ * @memberof GetFileResponseFile
3011
3003
  */
3012
- 'indexingFailureReason'?: string;
3004
+ 'index': boolean;
3013
3005
  /**
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.
3006
+ * 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
3007
  * @type {string}
3016
- * @memberof GetFileMetadataResponseFile
3008
+ * @memberof GetFileResponseFile
3017
3009
  */
3018
- 'uploadStatus': GetFileMetadataResponseFileUploadStatusEnum;
3010
+ 'status': GetFileResponseFileStatusEnum;
3019
3011
  /**
3020
- * Failure reason of the file upload if the upload status is \"FAILED\".
3012
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
3021
3013
  * @type {string}
3022
- * @memberof GetFileMetadataResponseFile
3014
+ * @memberof GetFileResponseFile
3023
3015
  */
3024
- 'uploadFailureReason'?: string;
3016
+ 'failedStatusReason'?: string;
3025
3017
  }
3026
- export declare const GetFileMetadataResponseFileIndexingStatusEnum: {
3027
- readonly Pending: "PENDING";
3028
- readonly InProgress: "IN_PROGRESS";
3029
- readonly Complete: "COMPLETE";
3030
- readonly Failed: "FAILED";
3018
+ export declare const GetFileResponseFileAccessPoliciesEnum: {
3019
+ readonly Integrations: "integrations";
3020
+ readonly PublicContent: "public_content";
3031
3021
  };
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";
3022
+ export type GetFileResponseFileAccessPoliciesEnum = typeof GetFileResponseFileAccessPoliciesEnum[keyof typeof GetFileResponseFileAccessPoliciesEnum];
3023
+ export declare const GetFileResponseFileStatusEnum: {
3024
+ readonly UploadPending: "UPLOAD_PENDING";
3025
+ readonly UploadFailed: "UPLOAD_FAILED";
3026
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
3027
+ readonly IndexingPending: "INDEXING_PENDING";
3028
+ readonly IndexingFailed: "INDEXING_FAILED";
3029
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
3037
3030
  };
3038
- export type GetFileMetadataResponseFileUploadStatusEnum = typeof GetFileMetadataResponseFileUploadStatusEnum[keyof typeof GetFileMetadataResponseFileUploadStatusEnum];
3031
+ export type GetFileResponseFileStatusEnum = typeof GetFileResponseFileStatusEnum[keyof typeof GetFileResponseFileStatusEnum];
3039
3032
  /**
3040
3033
  *
3041
3034
  * @export
@@ -4896,6 +4889,12 @@ export interface ListFilesResponseFilesInner {
4896
4889
  * @memberof ListFilesResponseFilesInner
4897
4890
  */
4898
4891
  'name': string | null;
4892
+ /**
4893
+ * 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.
4894
+ * @type {string}
4895
+ * @memberof ListFilesResponseFilesInner
4896
+ */
4897
+ 'url': string | null;
4899
4898
  /**
4900
4899
  * File size in bytes. Non-null if file upload status is \"COMPLETE\".
4901
4900
  * @type {number}
@@ -4933,45 +4932,40 @@ export interface ListFilesResponseFilesInner {
4933
4932
  * @type {Array<string>}
4934
4933
  * @memberof ListFilesResponseFilesInner
4935
4934
  */
4936
- 'accessPolicies': Array<string>;
4935
+ 'accessPolicies': Array<ListFilesResponseFilesInnerAccessPoliciesEnum>;
4937
4936
  /**
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;
4943
- /**
4944
- * Last failure reason of the file indexing if the indexing status is \"FAILED\".
4945
- * @type {string}
4937
+ * Whether the file was requested to be indexed for search or not.
4938
+ * @type {boolean}
4946
4939
  * @memberof ListFilesResponseFilesInner
4947
4940
  */
4948
- 'indexingFailureReason'?: string;
4941
+ 'index': boolean;
4949
4942
  /**
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.
4943
+ * 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
4944
  * @type {string}
4952
4945
  * @memberof ListFilesResponseFilesInner
4953
4946
  */
4954
- 'uploadStatus': ListFilesResponseFilesInnerUploadStatusEnum;
4947
+ 'status': ListFilesResponseFilesInnerStatusEnum;
4955
4948
  /**
4956
- * Failure reason of the file upload if the upload status is \"FAILED\".
4949
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
4957
4950
  * @type {string}
4958
4951
  * @memberof ListFilesResponseFilesInner
4959
4952
  */
4960
- 'uploadFailureReason'?: string;
4953
+ 'failedStatusReason'?: string;
4961
4954
  }
4962
- export declare const ListFilesResponseFilesInnerIndexingStatusEnum: {
4963
- readonly Pending: "PENDING";
4964
- readonly InProgress: "IN_PROGRESS";
4965
- readonly Complete: "COMPLETE";
4966
- readonly Failed: "FAILED";
4955
+ export declare const ListFilesResponseFilesInnerAccessPoliciesEnum: {
4956
+ readonly Integrations: "integrations";
4957
+ readonly PublicContent: "public_content";
4967
4958
  };
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";
4959
+ export type ListFilesResponseFilesInnerAccessPoliciesEnum = typeof ListFilesResponseFilesInnerAccessPoliciesEnum[keyof typeof ListFilesResponseFilesInnerAccessPoliciesEnum];
4960
+ export declare const ListFilesResponseFilesInnerStatusEnum: {
4961
+ readonly UploadPending: "UPLOAD_PENDING";
4962
+ readonly UploadFailed: "UPLOAD_FAILED";
4963
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
4964
+ readonly IndexingPending: "INDEXING_PENDING";
4965
+ readonly IndexingFailed: "INDEXING_FAILED";
4966
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
4973
4967
  };
4974
- export type ListFilesResponseFilesInnerUploadStatusEnum = typeof ListFilesResponseFilesInnerUploadStatusEnum[keyof typeof ListFilesResponseFilesInnerUploadStatusEnum];
4968
+ export type ListFilesResponseFilesInnerStatusEnum = typeof ListFilesResponseFilesInnerStatusEnum[keyof typeof ListFilesResponseFilesInnerStatusEnum];
4975
4969
  /**
4976
4970
  *
4977
4971
  * @export
@@ -5653,6 +5647,12 @@ export interface ModelFile {
5653
5647
  * @memberof ModelFile
5654
5648
  */
5655
5649
  'name': string | null;
5650
+ /**
5651
+ * 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.
5652
+ * @type {string}
5653
+ * @memberof ModelFile
5654
+ */
5655
+ 'url': string | null;
5656
5656
  /**
5657
5657
  * File size in bytes. Non-null if file upload status is \"COMPLETE\".
5658
5658
  * @type {number}
@@ -5690,45 +5690,40 @@ export interface ModelFile {
5690
5690
  * @type {Array<string>}
5691
5691
  * @memberof ModelFile
5692
5692
  */
5693
- 'accessPolicies': Array<string>;
5693
+ 'accessPolicies': Array<ModelFileAccessPoliciesEnum>;
5694
5694
  /**
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}
5695
+ * Whether the file was requested to be indexed for search or not.
5696
+ * @type {boolean}
5703
5697
  * @memberof ModelFile
5704
5698
  */
5705
- 'indexingFailureReason'?: string;
5699
+ 'index': boolean;
5706
5700
  /**
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.
5701
+ * 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
5702
  * @type {string}
5709
5703
  * @memberof ModelFile
5710
5704
  */
5711
- 'uploadStatus': ModelFileUploadStatusEnum;
5705
+ 'status': ModelFileStatusEnum;
5712
5706
  /**
5713
- * Failure reason of the file upload if the upload status is \"FAILED\".
5707
+ * If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure.
5714
5708
  * @type {string}
5715
5709
  * @memberof ModelFile
5716
5710
  */
5717
- 'uploadFailureReason'?: string;
5711
+ 'failedStatusReason'?: string;
5718
5712
  }
5719
- export declare const ModelFileIndexingStatusEnum: {
5720
- readonly Pending: "PENDING";
5721
- readonly InProgress: "IN_PROGRESS";
5722
- readonly Complete: "COMPLETE";
5723
- readonly Failed: "FAILED";
5713
+ export declare const ModelFileAccessPoliciesEnum: {
5714
+ readonly Integrations: "integrations";
5715
+ readonly PublicContent: "public_content";
5724
5716
  };
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";
5717
+ export type ModelFileAccessPoliciesEnum = typeof ModelFileAccessPoliciesEnum[keyof typeof ModelFileAccessPoliciesEnum];
5718
+ export declare const ModelFileStatusEnum: {
5719
+ readonly UploadPending: "UPLOAD_PENDING";
5720
+ readonly UploadFailed: "UPLOAD_FAILED";
5721
+ readonly UploadCompleted: "UPLOAD_COMPLETED";
5722
+ readonly IndexingPending: "INDEXING_PENDING";
5723
+ readonly IndexingFailed: "INDEXING_FAILED";
5724
+ readonly IndexingCompleted: "INDEXING_COMPLETED";
5730
5725
  };
5731
- export type ModelFileUploadStatusEnum = typeof ModelFileUploadStatusEnum[keyof typeof ModelFileUploadStatusEnum];
5726
+ export type ModelFileStatusEnum = typeof ModelFileStatusEnum[keyof typeof ModelFileStatusEnum];
5732
5727
  /**
5733
5728
  *
5734
5729
  * @export
@@ -6764,13 +6759,11 @@ export type UpdateBotBodyStatesValueTypeEnum = typeof UpdateBotBodyStatesValueTy
6764
6759
  export interface UpdateBotBodySubscriptions {
6765
6760
  /**
6766
6761
  *
6767
- * @type {{ [key: string]: { [key: string]: any; } | null; }}
6762
+ * @type {{ [key: string]: object | null; }}
6768
6763
  * @memberof UpdateBotBodySubscriptions
6769
6764
  */
6770
6765
  'events': {
6771
- [key: string]: {
6772
- [key: string]: any;
6773
- } | null;
6766
+ [key: string]: object | null;
6774
6767
  } | null;
6775
6768
  }
6776
6769
  /**
@@ -6857,32 +6850,41 @@ export interface UpdateConversationResponse {
6857
6850
  /**
6858
6851
  *
6859
6852
  * @export
6860
- * @interface UpdateFileMetadataBody
6853
+ * @interface UpdateFileBody
6861
6854
  */
6862
- export interface UpdateFileMetadataBody {
6855
+ export interface UpdateFileBody {
6863
6856
  /**
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`.
6857
+ * 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
6858
  * @type {{ [key: string]: string | null; }}
6866
- * @memberof UpdateFileMetadataBody
6859
+ * @memberof UpdateFileBody
6867
6860
  */
6868
- 'tags': {
6861
+ 'tags'?: {
6869
6862
  [key: string]: string | null;
6870
6863
  };
6864
+ /**
6865
+ * New access policies to set for the file. Omit to keep existing policies intact.
6866
+ * @type {Array<string>}
6867
+ * @memberof UpdateFileBody
6868
+ */
6869
+ 'accessPolicies'?: Array<UpdateFileBodyAccessPoliciesEnum>;
6871
6870
  }
6871
+ export declare const UpdateFileBodyAccessPoliciesEnum: {
6872
+ readonly Integrations: "integrations";
6873
+ readonly PublicContent: "public_content";
6874
+ };
6875
+ export type UpdateFileBodyAccessPoliciesEnum = typeof UpdateFileBodyAccessPoliciesEnum[keyof typeof UpdateFileBodyAccessPoliciesEnum];
6872
6876
  /**
6873
6877
  *
6874
6878
  * @export
6875
- * @interface UpdateFileMetadataResponse
6879
+ * @interface UpdateFileResponse
6876
6880
  */
6877
- export interface UpdateFileMetadataResponse {
6881
+ export interface UpdateFileResponse {
6878
6882
  /**
6879
- * The updated tags of the file.
6880
- * @type {{ [key: string]: string; }}
6881
- * @memberof UpdateFileMetadataResponse
6883
+ *
6884
+ * @type {GetFileResponseFile}
6885
+ * @memberof UpdateFileResponse
6882
6886
  */
6883
- 'tags': {
6884
- [key: string]: string;
6885
- };
6887
+ 'file': GetFileResponseFile;
6886
6888
  }
6887
6889
  /**
6888
6890
  *
@@ -8539,19 +8541,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8539
8541
  */
8540
8542
  getEvent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8541
8543
  /**
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
8544
+ * Get file
8550
8545
  * @param {string} id File ID
8551
8546
  * @param {*} [options] Override http request option.
8552
8547
  * @throws {RequiredError}
8553
8548
  */
8554
- getFileMetadata: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8549
+ getFile: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8555
8550
  /**
8556
8551
  * Get integration
8557
8552
  * @param {string} id Integration ID
@@ -8768,12 +8763,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8768
8763
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
8769
8764
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8770
8765
  * @param {Array<string>} [participantIds] Filter by participant ids
8766
+ * @param {string} [integrationName] Filter by integration name
8771
8767
  * @param {*} [options] Override http request option.
8772
8768
  * @throws {RequiredError}
8773
8769
  */
8774
8770
  listConversations: (nextToken?: string, tags?: {
8775
8771
  [key: string]: string;
8776
- } | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8772
+ } | undefined, participantIds?: Array<string>, integrationName?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8777
8773
  /**
8778
8774
  * 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
8775
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -9040,13 +9036,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
9040
9036
  */
9041
9037
  updateConversation: (id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9042
9038
  /**
9043
- * Update file metadata
9039
+ * Update file
9044
9040
  * @param {string} id File ID
9045
- * @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
9041
+ * @param {UpdateFileBody} [updateFileBody] File metadata to update.
9046
9042
  * @param {*} [options] Override http request option.
9047
9043
  * @throws {RequiredError}
9048
9044
  */
9049
- updateFileMetadata: (id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9045
+ updateFile: (id: string, updateFileBody?: UpdateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9050
9046
  /**
9051
9047
  * Update integration
9052
9048
  * @param {string} id Integration ID
@@ -9471,19 +9467,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9471
9467
  */
9472
9468
  getEvent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
9473
9469
  /**
9474
- * Returns a presigned URL to download the file content.
9470
+ * Get file
9475
9471
  * @param {string} id File ID
9476
9472
  * @param {*} [options] Override http request option.
9477
9473
  * @throws {RequiredError}
9478
9474
  */
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>>;
9475
+ getFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileResponse>>;
9487
9476
  /**
9488
9477
  * Get integration
9489
9478
  * @param {string} id Integration ID
@@ -9700,12 +9689,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9700
9689
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
9701
9690
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9702
9691
  * @param {Array<string>} [participantIds] Filter by participant ids
9692
+ * @param {string} [integrationName] Filter by integration name
9703
9693
  * @param {*} [options] Override http request option.
9704
9694
  * @throws {RequiredError}
9705
9695
  */
9706
9696
  listConversations(nextToken?: string, tags?: {
9707
9697
  [key: string]: string;
9708
- } | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
9698
+ } | undefined, participantIds?: Array<string>, integrationName?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
9709
9699
  /**
9710
9700
  * 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
9701
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -9972,13 +9962,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9972
9962
  */
9973
9963
  updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateConversationResponse>>;
9974
9964
  /**
9975
- * Update file metadata
9965
+ * Update file
9976
9966
  * @param {string} id File ID
9977
- * @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
9967
+ * @param {UpdateFileBody} [updateFileBody] File metadata to update.
9978
9968
  * @param {*} [options] Override http request option.
9979
9969
  * @throws {RequiredError}
9980
9970
  */
9981
- updateFileMetadata(id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFileMetadataResponse>>;
9971
+ updateFile(id: string, updateFileBody?: UpdateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFileResponse>>;
9982
9972
  /**
9983
9973
  * Update integration
9984
9974
  * @param {string} id Integration ID
@@ -10387,19 +10377,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10387
10377
  */
10388
10378
  getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
10389
10379
  /**
10390
- * Returns a presigned URL to download the file content.
10391
- * @param {DefaultApiGetFileContentRequest} requestParameters Request parameters.
10392
- * @param {*} [options] Override http request option.
10393
- * @throws {RequiredError}
10394
- */
10395
- getFileContent(requestParameters: DefaultApiGetFileContentRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileContentResponse>;
10396
- /**
10397
- * Get file metadata
10398
- * @param {DefaultApiGetFileMetadataRequest} requestParameters Request parameters.
10380
+ * Get file
10381
+ * @param {DefaultApiGetFileRequest} requestParameters Request parameters.
10399
10382
  * @param {*} [options] Override http request option.
10400
10383
  * @throws {RequiredError}
10401
10384
  */
10402
- getFileMetadata(requestParameters: DefaultApiGetFileMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileMetadataResponse>;
10385
+ getFile(requestParameters: DefaultApiGetFileRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileResponse>;
10403
10386
  /**
10404
10387
  * Get integration
10405
10388
  * @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
@@ -10806,12 +10789,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10806
10789
  */
10807
10790
  updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateConversationResponse>;
10808
10791
  /**
10809
- * Update file metadata
10810
- * @param {DefaultApiUpdateFileMetadataRequest} requestParameters Request parameters.
10792
+ * Update file
10793
+ * @param {DefaultApiUpdateFileRequest} requestParameters Request parameters.
10811
10794
  * @param {*} [options] Override http request option.
10812
10795
  * @throws {RequiredError}
10813
10796
  */
10814
- updateFileMetadata(requestParameters: DefaultApiUpdateFileMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateFileMetadataResponse>;
10797
+ updateFile(requestParameters: DefaultApiUpdateFileRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateFileResponse>;
10815
10798
  /**
10816
10799
  * Update integration
10817
10800
  * @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.
@@ -11558,28 +11541,15 @@ export interface DefaultApiGetEventRequest {
11558
11541
  readonly id: string;
11559
11542
  }
11560
11543
  /**
11561
- * Request parameters for getFileContent operation in DefaultApi.
11544
+ * Request parameters for getFile operation in DefaultApi.
11562
11545
  * @export
11563
- * @interface DefaultApiGetFileContentRequest
11546
+ * @interface DefaultApiGetFileRequest
11564
11547
  */
11565
- export interface DefaultApiGetFileContentRequest {
11548
+ export interface DefaultApiGetFileRequest {
11566
11549
  /**
11567
11550
  * File ID
11568
11551
  * @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
11552
+ * @memberof DefaultApiGetFile
11583
11553
  */
11584
11554
  readonly id: string;
11585
11555
  }
@@ -12092,6 +12062,12 @@ export interface DefaultApiListConversationsRequest {
12092
12062
  * @memberof DefaultApiListConversations
12093
12063
  */
12094
12064
  readonly participantIds?: Array<string>;
12065
+ /**
12066
+ * Filter by integration name
12067
+ * @type {string}
12068
+ * @memberof DefaultApiListConversations
12069
+ */
12070
+ readonly integrationName?: string;
12095
12071
  }
12096
12072
  /**
12097
12073
  * Request parameters for listEvents operation in DefaultApi.
@@ -12747,23 +12723,23 @@ export interface DefaultApiUpdateConversationRequest {
12747
12723
  readonly updateConversationBody?: UpdateConversationBody;
12748
12724
  }
12749
12725
  /**
12750
- * Request parameters for updateFileMetadata operation in DefaultApi.
12726
+ * Request parameters for updateFile operation in DefaultApi.
12751
12727
  * @export
12752
- * @interface DefaultApiUpdateFileMetadataRequest
12728
+ * @interface DefaultApiUpdateFileRequest
12753
12729
  */
12754
- export interface DefaultApiUpdateFileMetadataRequest {
12730
+ export interface DefaultApiUpdateFileRequest {
12755
12731
  /**
12756
12732
  * File ID
12757
12733
  * @type {string}
12758
- * @memberof DefaultApiUpdateFileMetadata
12734
+ * @memberof DefaultApiUpdateFile
12759
12735
  */
12760
12736
  readonly id: string;
12761
12737
  /**
12762
12738
  * File metadata to update.
12763
- * @type {UpdateFileMetadataBody}
12764
- * @memberof DefaultApiUpdateFileMetadata
12739
+ * @type {UpdateFileBody}
12740
+ * @memberof DefaultApiUpdateFile
12765
12741
  */
12766
- readonly updateFileMetadataBody?: UpdateFileMetadataBody;
12742
+ readonly updateFileBody?: UpdateFileBody;
12767
12743
  }
12768
12744
  /**
12769
12745
  * Request parameters for updateIntegration operation in DefaultApi.
@@ -13320,21 +13296,13 @@ export declare class DefaultApi extends BaseAPI {
13320
13296
  */
13321
13297
  getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any>>;
13322
13298
  /**
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.
13299
+ * Get file
13300
+ * @param {DefaultApiGetFileRequest} requestParameters Request parameters.
13333
13301
  * @param {*} [options] Override http request option.
13334
13302
  * @throws {RequiredError}
13335
13303
  * @memberof DefaultApi
13336
13304
  */
13337
- getFileMetadata(requestParameters: DefaultApiGetFileMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFileMetadataResponse, any>>;
13305
+ getFile(requestParameters: DefaultApiGetFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFileResponse, any>>;
13338
13306
  /**
13339
13307
  * Get integration
13340
13308
  * @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
@@ -13799,13 +13767,13 @@ export declare class DefaultApi extends BaseAPI {
13799
13767
  */
13800
13768
  updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateConversationResponse, any>>;
13801
13769
  /**
13802
- * Update file metadata
13803
- * @param {DefaultApiUpdateFileMetadataRequest} requestParameters Request parameters.
13770
+ * Update file
13771
+ * @param {DefaultApiUpdateFileRequest} requestParameters Request parameters.
13804
13772
  * @param {*} [options] Override http request option.
13805
13773
  * @throws {RequiredError}
13806
13774
  * @memberof DefaultApi
13807
13775
  */
13808
- updateFileMetadata(requestParameters: DefaultApiUpdateFileMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFileMetadataResponse, any>>;
13776
+ updateFile(requestParameters: DefaultApiUpdateFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFileResponse, any>>;
13809
13777
  /**
13810
13778
  * Update integration
13811
13779
  * @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.