@botpress/client 0.14.0 → 0.14.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/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.24.0
5
+ * The version of the OpenAPI document: 0.26.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -601,155 +601,6 @@ export interface ChangeAISpendQuotaBody {
601
601
  */
602
602
  'monthlySpendingLimit': number;
603
603
  }
604
- /**
605
- *
606
- * @export
607
- * @interface ChangeWorkspacePlanBody
608
- */
609
- export interface ChangeWorkspacePlanBody {
610
- /**
611
- *
612
- * @type {string}
613
- * @memberof ChangeWorkspacePlanBody
614
- */
615
- 'plan': ChangeWorkspacePlanBodyPlanEnum;
616
- }
617
- export declare const ChangeWorkspacePlanBodyPlanEnum: {
618
- readonly Free: "free";
619
- readonly Premium: "premium";
620
- };
621
- export type ChangeWorkspacePlanBodyPlanEnum = typeof ChangeWorkspacePlanBodyPlanEnum[keyof typeof ChangeWorkspacePlanBodyPlanEnum];
622
- /**
623
- *
624
- * @export
625
- * @interface ChangeWorkspacePlanResponse
626
- */
627
- export interface ChangeWorkspacePlanResponse {
628
- /**
629
- *
630
- * @type {string}
631
- * @memberof ChangeWorkspacePlanResponse
632
- */
633
- 'id': string;
634
- /**
635
- *
636
- * @type {string}
637
- * @memberof ChangeWorkspacePlanResponse
638
- */
639
- 'name': string;
640
- /**
641
- *
642
- * @type {string}
643
- * @memberof ChangeWorkspacePlanResponse
644
- */
645
- 'ownerId': string;
646
- /**
647
- *
648
- * @type {string}
649
- * @memberof ChangeWorkspacePlanResponse
650
- */
651
- 'createdAt': string;
652
- /**
653
- *
654
- * @type {string}
655
- * @memberof ChangeWorkspacePlanResponse
656
- */
657
- 'updatedAt': string;
658
- /**
659
- *
660
- * @type {number}
661
- * @memberof ChangeWorkspacePlanResponse
662
- */
663
- 'botCount': number;
664
- /**
665
- *
666
- * @type {string}
667
- * @memberof ChangeWorkspacePlanResponse
668
- */
669
- 'accountType': ChangeWorkspacePlanResponseAccountTypeEnum;
670
- /**
671
- *
672
- * @type {string}
673
- * @memberof ChangeWorkspacePlanResponse
674
- */
675
- 'billingVersion': ChangeWorkspacePlanResponseBillingVersionEnum;
676
- /**
677
- *
678
- * @type {string}
679
- * @memberof ChangeWorkspacePlanResponse
680
- */
681
- 'plan': ChangeWorkspacePlanResponsePlanEnum;
682
- /**
683
- *
684
- * @type {boolean}
685
- * @memberof ChangeWorkspacePlanResponse
686
- */
687
- 'blocked': boolean;
688
- /**
689
- *
690
- * @type {number}
691
- * @memberof ChangeWorkspacePlanResponse
692
- */
693
- 'spendingLimit': number;
694
- /**
695
- *
696
- * @type {string}
697
- * @memberof ChangeWorkspacePlanResponse
698
- */
699
- 'about'?: string;
700
- /**
701
- *
702
- * @type {string}
703
- * @memberof ChangeWorkspacePlanResponse
704
- */
705
- 'profilePicture'?: string;
706
- /**
707
- *
708
- * @type {string}
709
- * @memberof ChangeWorkspacePlanResponse
710
- */
711
- 'contactEmail'?: string;
712
- /**
713
- *
714
- * @type {string}
715
- * @memberof ChangeWorkspacePlanResponse
716
- */
717
- 'website'?: string;
718
- /**
719
- *
720
- * @type {Array<string>}
721
- * @memberof ChangeWorkspacePlanResponse
722
- */
723
- 'socialAccounts'?: Array<string>;
724
- /**
725
- *
726
- * @type {boolean}
727
- * @memberof ChangeWorkspacePlanResponse
728
- */
729
- 'isPublic'?: boolean;
730
- /**
731
- *
732
- * @type {string}
733
- * @memberof ChangeWorkspacePlanResponse
734
- */
735
- 'handle'?: string;
736
- }
737
- export declare const ChangeWorkspacePlanResponseAccountTypeEnum: {
738
- readonly Free: "free";
739
- readonly Premium: "premium";
740
- };
741
- export type ChangeWorkspacePlanResponseAccountTypeEnum = typeof ChangeWorkspacePlanResponseAccountTypeEnum[keyof typeof ChangeWorkspacePlanResponseAccountTypeEnum];
742
- export declare const ChangeWorkspacePlanResponseBillingVersionEnum: {
743
- readonly V1: "v1";
744
- readonly V2: "v2";
745
- };
746
- export type ChangeWorkspacePlanResponseBillingVersionEnum = typeof ChangeWorkspacePlanResponseBillingVersionEnum[keyof typeof ChangeWorkspacePlanResponseBillingVersionEnum];
747
- export declare const ChangeWorkspacePlanResponsePlanEnum: {
748
- readonly Community: "community";
749
- readonly Team: "team";
750
- readonly Enterprise: "enterprise";
751
- };
752
- export type ChangeWorkspacePlanResponsePlanEnum = typeof ChangeWorkspacePlanResponsePlanEnum[keyof typeof ChangeWorkspacePlanResponsePlanEnum];
753
604
  /**
754
605
  *
755
606
  * @export
@@ -1372,12 +1223,43 @@ export interface CreateEventResponse {
1372
1223
  */
1373
1224
  export interface CreateFileBody {
1374
1225
  /**
1375
- *
1376
- * @type {any}
1226
+ * File name
1227
+ * @type {string}
1377
1228
  * @memberof CreateFileBody
1378
1229
  */
1379
- 'data'?: any | null;
1230
+ 'name'?: string;
1231
+ /**
1232
+ * File tags as an object of key/value pairs
1233
+ * @type {{ [key: string]: string; }}
1234
+ * @memberof CreateFileBody
1235
+ */
1236
+ 'tags'?: {
1237
+ [key: string]: string;
1238
+ };
1239
+ /**
1240
+ * 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
+ * @type {boolean}
1242
+ * @memberof CreateFileBody
1243
+ */
1244
+ 'index'?: boolean;
1245
+ /**
1246
+ * File access policies. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allow read, search and list operations for any integration installed in the bot.
1247
+ * @type {Array<string>}
1248
+ * @memberof CreateFileBody
1249
+ */
1250
+ 'accessPolicies'?: Array<CreateFileBodyAccessPoliciesEnum>;
1251
+ /**
1252
+ * File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\".
1253
+ * @type {string}
1254
+ * @memberof CreateFileBody
1255
+ */
1256
+ 'contentType'?: string;
1380
1257
  }
1258
+ export declare const CreateFileBodyAccessPoliciesEnum: {
1259
+ readonly PublicContent: "public_content";
1260
+ readonly Integrations: "integrations";
1261
+ };
1262
+ export type CreateFileBodyAccessPoliciesEnum = typeof CreateFileBodyAccessPoliciesEnum[keyof typeof CreateFileBodyAccessPoliciesEnum];
1381
1263
  /**
1382
1264
  *
1383
1265
  * @export
@@ -1416,7 +1298,7 @@ export interface CreateFileResponseFile {
1416
1298
  */
1417
1299
  'name': string | null;
1418
1300
  /**
1419
- * File size in bytes
1301
+ * File size in bytes. Non-null if file upload status is \"COMPLETE\".
1420
1302
  * @type {number}
1421
1303
  * @memberof CreateFileResponseFile
1422
1304
  */
@@ -1465,6 +1347,24 @@ export interface CreateFileResponseFile {
1465
1347
  * @memberof CreateFileResponseFile
1466
1348
  */
1467
1349
  'indexingFailureReason'?: string;
1350
+ /**
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.
1352
+ * @type {string}
1353
+ * @memberof CreateFileResponseFile
1354
+ */
1355
+ 'uploadStatus': CreateFileResponseFileUploadStatusEnum;
1356
+ /**
1357
+ * Failure reason of the file upload if the upload status is \"FAILED\".
1358
+ * @type {string}
1359
+ * @memberof CreateFileResponseFile
1360
+ */
1361
+ 'uploadFailureReason'?: string;
1362
+ /**
1363
+ * URL to upload the file content. File content needs to be sent to this URL via a POST request.
1364
+ * @type {string}
1365
+ * @memberof CreateFileResponseFile
1366
+ */
1367
+ 'uploadUrl': string;
1468
1368
  }
1469
1369
  export declare const CreateFileResponseFileIndexingStatusEnum: {
1470
1370
  readonly Pending: "PENDING";
@@ -1473,6 +1373,12 @@ export declare const CreateFileResponseFileIndexingStatusEnum: {
1473
1373
  readonly Failed: "FAILED";
1474
1374
  };
1475
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";
1380
+ };
1381
+ export type CreateFileResponseFileUploadStatusEnum = typeof CreateFileResponseFileUploadStatusEnum[keyof typeof CreateFileResponseFileUploadStatusEnum];
1476
1382
  /**
1477
1383
  *
1478
1384
  * @export
@@ -1484,7 +1390,7 @@ export interface CreateIntegrationApiKeyBody {
1484
1390
  * @type {string}
1485
1391
  * @memberof CreateIntegrationApiKeyBody
1486
1392
  */
1487
- 'integrationVersionId': string;
1393
+ 'integrationId': string;
1488
1394
  /**
1489
1395
  *
1490
1396
  * @type {string}
@@ -1614,7 +1520,7 @@ export interface CreateIntegrationBody {
1614
1520
  */
1615
1521
  'code'?: string;
1616
1522
  /**
1617
- * URL of the integration; Only available for dev integrations
1523
+ * URL of the integration
1618
1524
  * @type {string}
1619
1525
  * @memberof CreateIntegrationBody
1620
1526
  */
@@ -2808,14 +2714,12 @@ export declare const GetAuditRecordsResponseRecordsInnerActionEnum: {
2808
2714
  readonly DeleteBot: "DELETE_BOT";
2809
2715
  readonly DeployBot: "DEPLOY_BOT";
2810
2716
  readonly TransferBot: "TRANSFER_BOT";
2811
- readonly DowngradeWorkspacePlan: "DOWNGRADE_WORKSPACE_PLAN";
2812
2717
  readonly DownloadBotArchive: "DOWNLOAD_BOT_ARCHIVE";
2813
2718
  readonly UpdateBot: "UPDATE_BOT";
2814
2719
  readonly UpdateBotChannel: "UPDATE_BOT_CHANNEL";
2815
2720
  readonly UpdateBotConfig: "UPDATE_BOT_CONFIG";
2816
2721
  readonly UpdatePaymentMethod: "UPDATE_PAYMENT_METHOD";
2817
2722
  readonly UpdateWorkspace: "UPDATE_WORKSPACE";
2818
- readonly UpgradeWorkspacePlan: "UPGRADE_WORKSPACE_PLAN";
2819
2723
  readonly SetSpendingLimit: "SET_SPENDING_LIMIT";
2820
2724
  readonly SetAiSpendingLimit: "SET_AI_SPENDING_LIMIT";
2821
2725
  };
@@ -2901,6 +2805,14 @@ export interface GetBotAnalyticsResponseRecordsInner {
2901
2805
  'eventTypes': {
2902
2806
  [key: string]: number;
2903
2807
  };
2808
+ /**
2809
+ *
2810
+ * @type {{ [key: string]: number; }}
2811
+ * @memberof GetBotAnalyticsResponseRecordsInner
2812
+ */
2813
+ 'customEvents': {
2814
+ [key: string]: number;
2815
+ };
2904
2816
  }
2905
2817
  /**
2906
2818
  *
@@ -3019,11 +2931,111 @@ export interface GetFileContentResponse {
3019
2931
  export interface GetFileMetadataResponse {
3020
2932
  /**
3021
2933
  *
3022
- * @type {CreateFileResponseFile}
2934
+ * @type {GetFileMetadataResponseFile}
3023
2935
  * @memberof GetFileMetadataResponse
3024
2936
  */
3025
- 'file': CreateFileResponseFile;
2937
+ 'file': GetFileMetadataResponseFile;
3026
2938
  }
2939
+ /**
2940
+ *
2941
+ * @export
2942
+ * @interface GetFileMetadataResponseFile
2943
+ */
2944
+ export interface GetFileMetadataResponseFile {
2945
+ /**
2946
+ * File ID
2947
+ * @type {string}
2948
+ * @memberof GetFileMetadataResponseFile
2949
+ */
2950
+ 'id': string;
2951
+ /**
2952
+ * The ID of the bot the file belongs to
2953
+ * @type {string}
2954
+ * @memberof GetFileMetadataResponseFile
2955
+ */
2956
+ 'botId': string;
2957
+ /**
2958
+ * File name
2959
+ * @type {string}
2960
+ * @memberof GetFileMetadataResponseFile
2961
+ */
2962
+ 'name': string | null;
2963
+ /**
2964
+ * File size in bytes. Non-null if file upload status is \"COMPLETE\".
2965
+ * @type {number}
2966
+ * @memberof GetFileMetadataResponseFile
2967
+ */
2968
+ 'size': number | null;
2969
+ /**
2970
+ * MIME type of the file\'s content
2971
+ * @type {string}
2972
+ * @memberof GetFileMetadataResponseFile
2973
+ */
2974
+ 'contentType': string;
2975
+ /**
2976
+ * The tags of the file as an object of key/value pairs
2977
+ * @type {{ [key: string]: string; }}
2978
+ * @memberof GetFileMetadataResponseFile
2979
+ */
2980
+ 'tags': {
2981
+ [key: string]: string;
2982
+ };
2983
+ /**
2984
+ * File creation timestamp in ISO 8601 format
2985
+ * @type {string}
2986
+ * @memberof GetFileMetadataResponseFile
2987
+ */
2988
+ 'createdAt': string;
2989
+ /**
2990
+ * File last update timestamp in ISO 8601 format
2991
+ * @type {string}
2992
+ * @memberof GetFileMetadataResponseFile
2993
+ */
2994
+ 'updatedAt': string;
2995
+ /**
2996
+ * Access policies configured for the file.
2997
+ * @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
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
3011
+ */
3012
+ 'indexingFailureReason'?: string;
3013
+ /**
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.
3015
+ * @type {string}
3016
+ * @memberof GetFileMetadataResponseFile
3017
+ */
3018
+ 'uploadStatus': GetFileMetadataResponseFileUploadStatusEnum;
3019
+ /**
3020
+ * Failure reason of the file upload if the upload status is \"FAILED\".
3021
+ * @type {string}
3022
+ * @memberof GetFileMetadataResponseFile
3023
+ */
3024
+ 'uploadFailureReason'?: string;
3025
+ }
3026
+ export declare const GetFileMetadataResponseFileIndexingStatusEnum: {
3027
+ readonly Pending: "PENDING";
3028
+ readonly InProgress: "IN_PROGRESS";
3029
+ readonly Complete: "COMPLETE";
3030
+ readonly Failed: "FAILED";
3031
+ };
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";
3037
+ };
3038
+ export type GetFileMetadataResponseFileUploadStatusEnum = typeof GetFileMetadataResponseFileUploadStatusEnum[keyof typeof GetFileMetadataResponseFileUploadStatusEnum];
3027
3039
  /**
3028
3040
  *
3029
3041
  * @export
@@ -3386,6 +3398,12 @@ export interface GetPublicIntegrationByIdResponseIntegration {
3386
3398
  * @memberof GetPublicIntegrationByIdResponseIntegration
3387
3399
  */
3388
3400
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
3401
+ /**
3402
+ * Title describing the task
3403
+ * @type {string}
3404
+ * @memberof GetPublicIntegrationByIdResponseIntegration
3405
+ */
3406
+ 'url': string;
3389
3407
  /**
3390
3408
  * Unique identifier of the integration that was installed on the bot
3391
3409
  * @type {string}
@@ -4282,6 +4300,12 @@ export interface Integration {
4282
4300
  * @memberof Integration
4283
4301
  */
4284
4302
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
4303
+ /**
4304
+ * Title describing the task
4305
+ * @type {string}
4306
+ * @memberof Integration
4307
+ */
4308
+ 'url': string;
4285
4309
  /**
4286
4310
  * Type of the task
4287
4311
  * @type {string}
@@ -4873,7 +4897,7 @@ export interface ListFilesResponseFilesInner {
4873
4897
  */
4874
4898
  'name': string | null;
4875
4899
  /**
4876
- * File size in bytes
4900
+ * File size in bytes. Non-null if file upload status is \"COMPLETE\".
4877
4901
  * @type {number}
4878
4902
  * @memberof ListFilesResponseFilesInner
4879
4903
  */
@@ -4922,6 +4946,18 @@ export interface ListFilesResponseFilesInner {
4922
4946
  * @memberof ListFilesResponseFilesInner
4923
4947
  */
4924
4948
  'indexingFailureReason'?: string;
4949
+ /**
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.
4951
+ * @type {string}
4952
+ * @memberof ListFilesResponseFilesInner
4953
+ */
4954
+ 'uploadStatus': ListFilesResponseFilesInnerUploadStatusEnum;
4955
+ /**
4956
+ * Failure reason of the file upload if the upload status is \"FAILED\".
4957
+ * @type {string}
4958
+ * @memberof ListFilesResponseFilesInner
4959
+ */
4960
+ 'uploadFailureReason'?: string;
4925
4961
  }
4926
4962
  export declare const ListFilesResponseFilesInnerIndexingStatusEnum: {
4927
4963
  readonly Pending: "PENDING";
@@ -4930,6 +4966,12 @@ export declare const ListFilesResponseFilesInnerIndexingStatusEnum: {
4930
4966
  readonly Failed: "FAILED";
4931
4967
  };
4932
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";
4973
+ };
4974
+ export type ListFilesResponseFilesInnerUploadStatusEnum = typeof ListFilesResponseFilesInnerUploadStatusEnum[keyof typeof ListFilesResponseFilesInnerUploadStatusEnum];
4933
4975
  /**
4934
4976
  *
4935
4977
  * @export
@@ -5612,7 +5654,7 @@ export interface ModelFile {
5612
5654
  */
5613
5655
  'name': string | null;
5614
5656
  /**
5615
- * File size in bytes
5657
+ * File size in bytes. Non-null if file upload status is \"COMPLETE\".
5616
5658
  * @type {number}
5617
5659
  * @memberof ModelFile
5618
5660
  */
@@ -5661,6 +5703,18 @@ export interface ModelFile {
5661
5703
  * @memberof ModelFile
5662
5704
  */
5663
5705
  'indexingFailureReason'?: string;
5706
+ /**
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.
5708
+ * @type {string}
5709
+ * @memberof ModelFile
5710
+ */
5711
+ 'uploadStatus': ModelFileUploadStatusEnum;
5712
+ /**
5713
+ * Failure reason of the file upload if the upload status is \"FAILED\".
5714
+ * @type {string}
5715
+ * @memberof ModelFile
5716
+ */
5717
+ 'uploadFailureReason'?: string;
5664
5718
  }
5665
5719
  export declare const ModelFileIndexingStatusEnum: {
5666
5720
  readonly Pending: "PENDING";
@@ -5669,6 +5723,12 @@ export declare const ModelFileIndexingStatusEnum: {
5669
5723
  readonly Failed: "FAILED";
5670
5724
  };
5671
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";
5730
+ };
5731
+ export type ModelFileUploadStatusEnum = typeof ModelFileUploadStatusEnum[keyof typeof ModelFileUploadStatusEnum];
5672
5732
  /**
5673
5733
  *
5674
5734
  * @export
@@ -6369,6 +6429,25 @@ export declare const TaskStatusEnum: {
6369
6429
  readonly Cancelled: "cancelled";
6370
6430
  };
6371
6431
  export type TaskStatusEnum = typeof TaskStatusEnum[keyof typeof TaskStatusEnum];
6432
+ /**
6433
+ *
6434
+ * @export
6435
+ * @interface TrackAnalyticsBody
6436
+ */
6437
+ export interface TrackAnalyticsBody {
6438
+ /**
6439
+ *
6440
+ * @type {string}
6441
+ * @memberof TrackAnalyticsBody
6442
+ */
6443
+ 'name': string;
6444
+ /**
6445
+ *
6446
+ * @type {number}
6447
+ * @memberof TrackAnalyticsBody
6448
+ */
6449
+ 'count': number;
6450
+ }
6372
6451
  /**
6373
6452
  *
6374
6453
  * @export
@@ -6782,12 +6861,12 @@ export interface UpdateConversationResponse {
6782
6861
  */
6783
6862
  export interface UpdateFileMetadataBody {
6784
6863
  /**
6785
- * The tags to update as an object of key/value pairs. A tag key can be set to a null value to delete it.
6786
- * @type {{ [key: string]: string; }}
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`.
6865
+ * @type {{ [key: string]: string | null; }}
6787
6866
  * @memberof UpdateFileMetadataBody
6788
6867
  */
6789
6868
  'tags': {
6790
- [key: string]: string;
6869
+ [key: string]: string | null;
6791
6870
  };
6792
6871
  }
6793
6872
  /**
@@ -6908,11 +6987,11 @@ export interface UpdateIntegrationBody {
6908
6987
  */
6909
6988
  'description'?: string;
6910
6989
  /**
6911
- * URL of the integration; Only available for dev integrations
6990
+ * URL of the integration
6912
6991
  * @type {string}
6913
6992
  * @memberof UpdateIntegrationBody
6914
6993
  */
6915
- 'url'?: string;
6994
+ 'url'?: string | null;
6916
6995
  /**
6917
6996
  * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
6918
6997
  * @type {boolean}
@@ -8147,14 +8226,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8147
8226
  * @throws {RequiredError}
8148
8227
  */
8149
8228
  changeAISpendQuota: (changeAISpendQuotaBody?: ChangeAISpendQuotaBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8150
- /**
8151
- * Change workspace billing plan
8152
- * @param {string} id Workspace ID
8153
- * @param {ChangeWorkspacePlanBody} [changeWorkspacePlanBody] Billing plan to change the workspace to
8154
- * @param {*} [options] Override http request option.
8155
- * @throws {RequiredError}
8156
- */
8157
- changeWorkspacePlan: (id: string, changeWorkspacePlanBody?: ChangeWorkspacePlanBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8158
8229
  /**
8159
8230
  * Charge unpaid invoices of a workspace.
8160
8231
  * @param {string} id Workspace ID
@@ -8200,17 +8271,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8200
8271
  createEvent: (createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8201
8272
  /**
8202
8273
  * Creates a file.
8203
- * @param {string} [xName] File name
8204
- * @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
8205
- * @param {string} [xAccessPolicies] File access policies, comma-separated. Add \&quot;public_content\&quot; to allow public access to the file content. Add \&quot;integrations\&quot; to allo read, search and list operations for any integration installed in the bot.
8206
- * @param {boolean} [xIndex] Set to a value of \&quot;true\&quot; to index the file in vector storage (default: false). 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.
8207
- * @param {string} [contentType] File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \&quot;application/octet-stream\&quot;.
8208
- * @param {string} [contentLength] File content length
8209
8274
  * @param {CreateFileBody} [createFileBody] The file to upload.
8210
8275
  * @param {*} [options] Override http request option.
8211
8276
  * @throws {RequiredError}
8212
8277
  */
8213
- createFile: (xName?: string, xTags?: string, xAccessPolicies?: string, xIndex?: boolean, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8278
+ createFile: (createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8214
8279
  /**
8215
8280
  * Create integration
8216
8281
  * @param {CreateIntegrationBody} [createIntegrationBody] Integration
@@ -8734,11 +8799,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8734
8799
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8735
8800
  /**
8736
8801
  * List IAKs (Integration Api Keys) of an integration
8737
- * @param {string} integrationVersionId ID of the integration version
8802
+ * @param {string} integrationId ID of the integration
8738
8803
  * @param {*} [options] Override http request option.
8739
8804
  * @throws {RequiredError}
8740
8805
  */
8741
- listIntegrationApiKeys: (integrationVersionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8806
+ listIntegrationApiKeys: (integrationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8742
8807
  /**
8743
8808
  * List integrations
8744
8809
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -8936,6 +9001,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8936
9001
  * @throws {RequiredError}
8937
9002
  */
8938
9003
  setWorkspacePaymentMethod: (id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9004
+ /**
9005
+ * Add an event to the analytics
9006
+ * @param {TrackAnalyticsBody} [trackAnalyticsBody] Add an event to the analytics
9007
+ * @param {*} [options] Override http request option.
9008
+ * @throws {RequiredError}
9009
+ */
9010
+ trackAnalytics: (trackAnalyticsBody?: TrackAnalyticsBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8939
9011
  /**
8940
9012
  * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
8941
9013
  * @param {string} id Bot ID
@@ -9084,14 +9156,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9084
9156
  * @throws {RequiredError}
9085
9157
  */
9086
9158
  changeAISpendQuota(changeAISpendQuotaBody?: ChangeAISpendQuotaBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
9087
- /**
9088
- * Change workspace billing plan
9089
- * @param {string} id Workspace ID
9090
- * @param {ChangeWorkspacePlanBody} [changeWorkspacePlanBody] Billing plan to change the workspace to
9091
- * @param {*} [options] Override http request option.
9092
- * @throws {RequiredError}
9093
- */
9094
- changeWorkspacePlan(id: string, changeWorkspacePlanBody?: ChangeWorkspacePlanBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangeWorkspacePlanResponse>>;
9095
9159
  /**
9096
9160
  * Charge unpaid invoices of a workspace.
9097
9161
  * @param {string} id Workspace ID
@@ -9137,17 +9201,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9137
9201
  createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
9138
9202
  /**
9139
9203
  * Creates a file.
9140
- * @param {string} [xName] File name
9141
- * @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
9142
- * @param {string} [xAccessPolicies] File access policies, comma-separated. Add \&quot;public_content\&quot; to allow public access to the file content. Add \&quot;integrations\&quot; to allo read, search and list operations for any integration installed in the bot.
9143
- * @param {boolean} [xIndex] Set to a value of \&quot;true\&quot; to index the file in vector storage (default: false). 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.
9144
- * @param {string} [contentType] File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \&quot;application/octet-stream\&quot;.
9145
- * @param {string} [contentLength] File content length
9146
9204
  * @param {CreateFileBody} [createFileBody] The file to upload.
9147
9205
  * @param {*} [options] Override http request option.
9148
9206
  * @throws {RequiredError}
9149
9207
  */
9150
- createFile(xName?: string, xTags?: string, xAccessPolicies?: string, xIndex?: boolean, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
9208
+ createFile(createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
9151
9209
  /**
9152
9210
  * Create integration
9153
9211
  * @param {CreateIntegrationBody} [createIntegrationBody] Integration
@@ -9673,11 +9731,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9673
9731
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
9674
9732
  /**
9675
9733
  * List IAKs (Integration Api Keys) of an integration
9676
- * @param {string} integrationVersionId ID of the integration version
9734
+ * @param {string} integrationId ID of the integration
9677
9735
  * @param {*} [options] Override http request option.
9678
9736
  * @throws {RequiredError}
9679
9737
  */
9680
- listIntegrationApiKeys(integrationVersionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationApiKeysResponse>>;
9738
+ listIntegrationApiKeys(integrationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationApiKeysResponse>>;
9681
9739
  /**
9682
9740
  * List integrations
9683
9741
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -9875,6 +9933,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9875
9933
  * @throws {RequiredError}
9876
9934
  */
9877
9935
  setWorkspacePaymentMethod(id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetWorkspacePaymentMethodResponse>>;
9936
+ /**
9937
+ * Add an event to the analytics
9938
+ * @param {TrackAnalyticsBody} [trackAnalyticsBody] Add an event to the analytics
9939
+ * @param {*} [options] Override http request option.
9940
+ * @throws {RequiredError}
9941
+ */
9942
+ trackAnalytics(trackAnalyticsBody?: TrackAnalyticsBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
9878
9943
  /**
9879
9944
  * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
9880
9945
  * @param {string} id Bot ID
@@ -10020,13 +10085,6 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10020
10085
  * @throws {RequiredError}
10021
10086
  */
10022
10087
  changeAISpendQuota(requestParameters?: DefaultApiChangeAISpendQuotaRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
10023
- /**
10024
- * Change workspace billing plan
10025
- * @param {DefaultApiChangeWorkspacePlanRequest} requestParameters Request parameters.
10026
- * @param {*} [options] Override http request option.
10027
- * @throws {RequiredError}
10028
- */
10029
- changeWorkspacePlan(requestParameters: DefaultApiChangeWorkspacePlanRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeWorkspacePlanResponse>;
10030
10088
  /**
10031
10089
  * Charge unpaid invoices of a workspace.
10032
10090
  * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
@@ -10712,6 +10770,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10712
10770
  * @throws {RequiredError}
10713
10771
  */
10714
10772
  setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): AxiosPromise<SetWorkspacePaymentMethodResponse>;
10773
+ /**
10774
+ * Add an event to the analytics
10775
+ * @param {DefaultApiTrackAnalyticsRequest} requestParameters Request parameters.
10776
+ * @param {*} [options] Override http request option.
10777
+ * @throws {RequiredError}
10778
+ */
10779
+ trackAnalytics(requestParameters?: DefaultApiTrackAnalyticsRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
10715
10780
  /**
10716
10781
  * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
10717
10782
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
@@ -10881,25 +10946,6 @@ export interface DefaultApiChangeAISpendQuotaRequest {
10881
10946
  */
10882
10947
  readonly changeAISpendQuotaBody?: ChangeAISpendQuotaBody;
10883
10948
  }
10884
- /**
10885
- * Request parameters for changeWorkspacePlan operation in DefaultApi.
10886
- * @export
10887
- * @interface DefaultApiChangeWorkspacePlanRequest
10888
- */
10889
- export interface DefaultApiChangeWorkspacePlanRequest {
10890
- /**
10891
- * Workspace ID
10892
- * @type {string}
10893
- * @memberof DefaultApiChangeWorkspacePlan
10894
- */
10895
- readonly id: string;
10896
- /**
10897
- * Billing plan to change the workspace to
10898
- * @type {ChangeWorkspacePlanBody}
10899
- * @memberof DefaultApiChangeWorkspacePlan
10900
- */
10901
- readonly changeWorkspacePlanBody?: ChangeWorkspacePlanBody;
10902
- }
10903
10949
  /**
10904
10950
  * Request parameters for chargeWorkspaceUnpaidInvoices operation in DefaultApi.
10905
10951
  * @export
@@ -10990,42 +11036,6 @@ export interface DefaultApiCreateEventRequest {
10990
11036
  * @interface DefaultApiCreateFileRequest
10991
11037
  */
10992
11038
  export interface DefaultApiCreateFileRequest {
10993
- /**
10994
- * File name
10995
- * @type {string}
10996
- * @memberof DefaultApiCreateFile
10997
- */
10998
- readonly xName?: string;
10999
- /**
11000
- * File tags as URL-encoded JSON string representing an object of key-value pairs.
11001
- * @type {string}
11002
- * @memberof DefaultApiCreateFile
11003
- */
11004
- readonly xTags?: string;
11005
- /**
11006
- * File access policies, comma-separated. Add \&quot;public_content\&quot; to allow public access to the file content. Add \&quot;integrations\&quot; to allo read, search and list operations for any integration installed in the bot.
11007
- * @type {string}
11008
- * @memberof DefaultApiCreateFile
11009
- */
11010
- readonly xAccessPolicies?: string;
11011
- /**
11012
- * Set to a value of \&quot;true\&quot; to index the file in vector storage (default: false). 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.
11013
- * @type {boolean}
11014
- * @memberof DefaultApiCreateFile
11015
- */
11016
- readonly xIndex?: boolean;
11017
- /**
11018
- * File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \&quot;application/octet-stream\&quot;.
11019
- * @type {string}
11020
- * @memberof DefaultApiCreateFile
11021
- */
11022
- readonly contentType?: string;
11023
- /**
11024
- * File content length
11025
- * @type {string}
11026
- * @memberof DefaultApiCreateFile
11027
- */
11028
- readonly contentLength?: string;
11029
11039
  /**
11030
11040
  * The file to upload.
11031
11041
  * @type {CreateFileBody}
@@ -12160,11 +12170,11 @@ export interface DefaultApiListFilesRequest {
12160
12170
  */
12161
12171
  export interface DefaultApiListIntegrationApiKeysRequest {
12162
12172
  /**
12163
- * ID of the integration version
12173
+ * ID of the integration
12164
12174
  * @type {string}
12165
12175
  * @memberof DefaultApiListIntegrationApiKeys
12166
12176
  */
12167
- readonly integrationVersionId: string;
12177
+ readonly integrationId: string;
12168
12178
  }
12169
12179
  /**
12170
12180
  * Request parameters for listIntegrations operation in DefaultApi.
@@ -12653,6 +12663,19 @@ export interface DefaultApiSetWorkspacePaymentMethodRequest {
12653
12663
  */
12654
12664
  readonly setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody;
12655
12665
  }
12666
+ /**
12667
+ * Request parameters for trackAnalytics operation in DefaultApi.
12668
+ * @export
12669
+ * @interface DefaultApiTrackAnalyticsRequest
12670
+ */
12671
+ export interface DefaultApiTrackAnalyticsRequest {
12672
+ /**
12673
+ * Add an event to the analytics
12674
+ * @type {TrackAnalyticsBody}
12675
+ * @memberof DefaultApiTrackAnalytics
12676
+ */
12677
+ readonly trackAnalyticsBody?: TrackAnalyticsBody;
12678
+ }
12656
12679
  /**
12657
12680
  * Request parameters for transferBot operation in DefaultApi.
12658
12681
  * @export
@@ -12952,14 +12975,6 @@ export declare class DefaultApi extends BaseAPI {
12952
12975
  * @memberof DefaultApi
12953
12976
  */
12954
12977
  changeAISpendQuota(requestParameters?: DefaultApiChangeAISpendQuotaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
12955
- /**
12956
- * Change workspace billing plan
12957
- * @param {DefaultApiChangeWorkspacePlanRequest} requestParameters Request parameters.
12958
- * @param {*} [options] Override http request option.
12959
- * @throws {RequiredError}
12960
- * @memberof DefaultApi
12961
- */
12962
- changeWorkspacePlan(requestParameters: DefaultApiChangeWorkspacePlanRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangeWorkspacePlanResponse, any>>;
12963
12978
  /**
12964
12979
  * Charge unpaid invoices of a workspace.
12965
12980
  * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
@@ -13743,6 +13758,14 @@ export declare class DefaultApi extends BaseAPI {
13743
13758
  * @memberof DefaultApi
13744
13759
  */
13745
13760
  setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetWorkspacePaymentMethodResponse, any>>;
13761
+ /**
13762
+ * Add an event to the analytics
13763
+ * @param {DefaultApiTrackAnalyticsRequest} requestParameters Request parameters.
13764
+ * @param {*} [options] Override http request option.
13765
+ * @throws {RequiredError}
13766
+ * @memberof DefaultApi
13767
+ */
13768
+ trackAnalytics(requestParameters?: DefaultApiTrackAnalyticsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
13746
13769
  /**
13747
13770
  * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
13748
13771
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.