@botpress/client 0.14.0 → 0.14.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.24.0
5
+ * The version of the OpenAPI document: 0.26.1
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}
1228
+ * @memberof CreateFileBody
1229
+ */
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}
1377
1254
  * @memberof CreateFileBody
1378
1255
  */
1379
- 'data'?: any | null;
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
  };
@@ -3019,11 +2923,111 @@ export interface GetFileContentResponse {
3019
2923
  export interface GetFileMetadataResponse {
3020
2924
  /**
3021
2925
  *
3022
- * @type {CreateFileResponseFile}
2926
+ * @type {GetFileMetadataResponseFile}
3023
2927
  * @memberof GetFileMetadataResponse
3024
2928
  */
3025
- 'file': CreateFileResponseFile;
2929
+ 'file': GetFileMetadataResponseFile;
2930
+ }
2931
+ /**
2932
+ *
2933
+ * @export
2934
+ * @interface GetFileMetadataResponseFile
2935
+ */
2936
+ export interface GetFileMetadataResponseFile {
2937
+ /**
2938
+ * File ID
2939
+ * @type {string}
2940
+ * @memberof GetFileMetadataResponseFile
2941
+ */
2942
+ 'id': string;
2943
+ /**
2944
+ * The ID of the bot the file belongs to
2945
+ * @type {string}
2946
+ * @memberof GetFileMetadataResponseFile
2947
+ */
2948
+ 'botId': string;
2949
+ /**
2950
+ * File name
2951
+ * @type {string}
2952
+ * @memberof GetFileMetadataResponseFile
2953
+ */
2954
+ 'name': string | null;
2955
+ /**
2956
+ * File size in bytes. Non-null if file upload status is \"COMPLETE\".
2957
+ * @type {number}
2958
+ * @memberof GetFileMetadataResponseFile
2959
+ */
2960
+ 'size': number | null;
2961
+ /**
2962
+ * MIME type of the file\'s content
2963
+ * @type {string}
2964
+ * @memberof GetFileMetadataResponseFile
2965
+ */
2966
+ 'contentType': string;
2967
+ /**
2968
+ * The tags of the file as an object of key/value pairs
2969
+ * @type {{ [key: string]: string; }}
2970
+ * @memberof GetFileMetadataResponseFile
2971
+ */
2972
+ 'tags': {
2973
+ [key: string]: string;
2974
+ };
2975
+ /**
2976
+ * File creation timestamp in ISO 8601 format
2977
+ * @type {string}
2978
+ * @memberof GetFileMetadataResponseFile
2979
+ */
2980
+ 'createdAt': string;
2981
+ /**
2982
+ * File last update timestamp in ISO 8601 format
2983
+ * @type {string}
2984
+ * @memberof GetFileMetadataResponseFile
2985
+ */
2986
+ 'updatedAt': string;
2987
+ /**
2988
+ * Access policies configured for the file.
2989
+ * @type {Array<string>}
2990
+ * @memberof GetFileMetadataResponseFile
2991
+ */
2992
+ 'accessPolicies': Array<string>;
2993
+ /**
2994
+ * Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created.
2995
+ * @type {string}
2996
+ * @memberof GetFileMetadataResponseFile
2997
+ */
2998
+ 'indexingStatus'?: GetFileMetadataResponseFileIndexingStatusEnum;
2999
+ /**
3000
+ * Last failure reason of the file indexing if the indexing status is \"FAILED\".
3001
+ * @type {string}
3002
+ * @memberof GetFileMetadataResponseFile
3003
+ */
3004
+ 'indexingFailureReason'?: string;
3005
+ /**
3006
+ * 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.
3007
+ * @type {string}
3008
+ * @memberof GetFileMetadataResponseFile
3009
+ */
3010
+ 'uploadStatus': GetFileMetadataResponseFileUploadStatusEnum;
3011
+ /**
3012
+ * Failure reason of the file upload if the upload status is \"FAILED\".
3013
+ * @type {string}
3014
+ * @memberof GetFileMetadataResponseFile
3015
+ */
3016
+ 'uploadFailureReason'?: string;
3026
3017
  }
3018
+ export declare const GetFileMetadataResponseFileIndexingStatusEnum: {
3019
+ readonly Pending: "PENDING";
3020
+ readonly InProgress: "IN_PROGRESS";
3021
+ readonly Complete: "COMPLETE";
3022
+ readonly Failed: "FAILED";
3023
+ };
3024
+ export type GetFileMetadataResponseFileIndexingStatusEnum = typeof GetFileMetadataResponseFileIndexingStatusEnum[keyof typeof GetFileMetadataResponseFileIndexingStatusEnum];
3025
+ export declare const GetFileMetadataResponseFileUploadStatusEnum: {
3026
+ readonly Pending: "PENDING";
3027
+ readonly Complete: "COMPLETE";
3028
+ readonly Failed: "FAILED";
3029
+ };
3030
+ export type GetFileMetadataResponseFileUploadStatusEnum = typeof GetFileMetadataResponseFileUploadStatusEnum[keyof typeof GetFileMetadataResponseFileUploadStatusEnum];
3027
3031
  /**
3028
3032
  *
3029
3033
  * @export
@@ -3386,6 +3390,12 @@ export interface GetPublicIntegrationByIdResponseIntegration {
3386
3390
  * @memberof GetPublicIntegrationByIdResponseIntegration
3387
3391
  */
3388
3392
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
3393
+ /**
3394
+ * Title describing the task
3395
+ * @type {string}
3396
+ * @memberof GetPublicIntegrationByIdResponseIntegration
3397
+ */
3398
+ 'url': string;
3389
3399
  /**
3390
3400
  * Unique identifier of the integration that was installed on the bot
3391
3401
  * @type {string}
@@ -4282,6 +4292,12 @@ export interface Integration {
4282
4292
  * @memberof Integration
4283
4293
  */
4284
4294
  'identifier': GetPublicIntegrationByIdResponseIntegrationIdentifier;
4295
+ /**
4296
+ * Title describing the task
4297
+ * @type {string}
4298
+ * @memberof Integration
4299
+ */
4300
+ 'url': string;
4285
4301
  /**
4286
4302
  * Type of the task
4287
4303
  * @type {string}
@@ -4873,7 +4889,7 @@ export interface ListFilesResponseFilesInner {
4873
4889
  */
4874
4890
  'name': string | null;
4875
4891
  /**
4876
- * File size in bytes
4892
+ * File size in bytes. Non-null if file upload status is \"COMPLETE\".
4877
4893
  * @type {number}
4878
4894
  * @memberof ListFilesResponseFilesInner
4879
4895
  */
@@ -4922,6 +4938,18 @@ export interface ListFilesResponseFilesInner {
4922
4938
  * @memberof ListFilesResponseFilesInner
4923
4939
  */
4924
4940
  'indexingFailureReason'?: string;
4941
+ /**
4942
+ * 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
+ * @type {string}
4944
+ * @memberof ListFilesResponseFilesInner
4945
+ */
4946
+ 'uploadStatus': ListFilesResponseFilesInnerUploadStatusEnum;
4947
+ /**
4948
+ * Failure reason of the file upload if the upload status is \"FAILED\".
4949
+ * @type {string}
4950
+ * @memberof ListFilesResponseFilesInner
4951
+ */
4952
+ 'uploadFailureReason'?: string;
4925
4953
  }
4926
4954
  export declare const ListFilesResponseFilesInnerIndexingStatusEnum: {
4927
4955
  readonly Pending: "PENDING";
@@ -4930,6 +4958,12 @@ export declare const ListFilesResponseFilesInnerIndexingStatusEnum: {
4930
4958
  readonly Failed: "FAILED";
4931
4959
  };
4932
4960
  export type ListFilesResponseFilesInnerIndexingStatusEnum = typeof ListFilesResponseFilesInnerIndexingStatusEnum[keyof typeof ListFilesResponseFilesInnerIndexingStatusEnum];
4961
+ export declare const ListFilesResponseFilesInnerUploadStatusEnum: {
4962
+ readonly Pending: "PENDING";
4963
+ readonly Complete: "COMPLETE";
4964
+ readonly Failed: "FAILED";
4965
+ };
4966
+ export type ListFilesResponseFilesInnerUploadStatusEnum = typeof ListFilesResponseFilesInnerUploadStatusEnum[keyof typeof ListFilesResponseFilesInnerUploadStatusEnum];
4933
4967
  /**
4934
4968
  *
4935
4969
  * @export
@@ -5612,7 +5646,7 @@ export interface ModelFile {
5612
5646
  */
5613
5647
  'name': string | null;
5614
5648
  /**
5615
- * File size in bytes
5649
+ * File size in bytes. Non-null if file upload status is \"COMPLETE\".
5616
5650
  * @type {number}
5617
5651
  * @memberof ModelFile
5618
5652
  */
@@ -5661,6 +5695,18 @@ export interface ModelFile {
5661
5695
  * @memberof ModelFile
5662
5696
  */
5663
5697
  'indexingFailureReason'?: string;
5698
+ /**
5699
+ * 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.
5700
+ * @type {string}
5701
+ * @memberof ModelFile
5702
+ */
5703
+ 'uploadStatus': ModelFileUploadStatusEnum;
5704
+ /**
5705
+ * Failure reason of the file upload if the upload status is \"FAILED\".
5706
+ * @type {string}
5707
+ * @memberof ModelFile
5708
+ */
5709
+ 'uploadFailureReason'?: string;
5664
5710
  }
5665
5711
  export declare const ModelFileIndexingStatusEnum: {
5666
5712
  readonly Pending: "PENDING";
@@ -5669,6 +5715,12 @@ export declare const ModelFileIndexingStatusEnum: {
5669
5715
  readonly Failed: "FAILED";
5670
5716
  };
5671
5717
  export type ModelFileIndexingStatusEnum = typeof ModelFileIndexingStatusEnum[keyof typeof ModelFileIndexingStatusEnum];
5718
+ export declare const ModelFileUploadStatusEnum: {
5719
+ readonly Pending: "PENDING";
5720
+ readonly Complete: "COMPLETE";
5721
+ readonly Failed: "FAILED";
5722
+ };
5723
+ export type ModelFileUploadStatusEnum = typeof ModelFileUploadStatusEnum[keyof typeof ModelFileUploadStatusEnum];
5672
5724
  /**
5673
5725
  *
5674
5726
  * @export
@@ -6369,6 +6421,25 @@ export declare const TaskStatusEnum: {
6369
6421
  readonly Cancelled: "cancelled";
6370
6422
  };
6371
6423
  export type TaskStatusEnum = typeof TaskStatusEnum[keyof typeof TaskStatusEnum];
6424
+ /**
6425
+ *
6426
+ * @export
6427
+ * @interface TrackAnalyticsBody
6428
+ */
6429
+ export interface TrackAnalyticsBody {
6430
+ /**
6431
+ *
6432
+ * @type {string}
6433
+ * @memberof TrackAnalyticsBody
6434
+ */
6435
+ 'name': string;
6436
+ /**
6437
+ *
6438
+ * @type {number}
6439
+ * @memberof TrackAnalyticsBody
6440
+ */
6441
+ 'count': number;
6442
+ }
6372
6443
  /**
6373
6444
  *
6374
6445
  * @export
@@ -6782,12 +6853,12 @@ export interface UpdateConversationResponse {
6782
6853
  */
6783
6854
  export interface UpdateFileMetadataBody {
6784
6855
  /**
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; }}
6856
+ * 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
+ * @type {{ [key: string]: string | null; }}
6787
6858
  * @memberof UpdateFileMetadataBody
6788
6859
  */
6789
6860
  'tags': {
6790
- [key: string]: string;
6861
+ [key: string]: string | null;
6791
6862
  };
6792
6863
  }
6793
6864
  /**
@@ -6908,11 +6979,11 @@ export interface UpdateIntegrationBody {
6908
6979
  */
6909
6980
  'description'?: string;
6910
6981
  /**
6911
- * URL of the integration; Only available for dev integrations
6982
+ * URL of the integration
6912
6983
  * @type {string}
6913
6984
  * @memberof UpdateIntegrationBody
6914
6985
  */
6915
- 'url'?: string;
6986
+ 'url'?: string | null;
6916
6987
  /**
6917
6988
  * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
6918
6989
  * @type {boolean}
@@ -8147,14 +8218,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8147
8218
  * @throws {RequiredError}
8148
8219
  */
8149
8220
  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
8221
  /**
8159
8222
  * Charge unpaid invoices of a workspace.
8160
8223
  * @param {string} id Workspace ID
@@ -8200,17 +8263,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8200
8263
  createEvent: (createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8201
8264
  /**
8202
8265
  * 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
8266
  * @param {CreateFileBody} [createFileBody] The file to upload.
8210
8267
  * @param {*} [options] Override http request option.
8211
8268
  * @throws {RequiredError}
8212
8269
  */
8213
- createFile: (xName?: string, xTags?: string, xAccessPolicies?: string, xIndex?: boolean, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8270
+ createFile: (createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8214
8271
  /**
8215
8272
  * Create integration
8216
8273
  * @param {CreateIntegrationBody} [createIntegrationBody] Integration
@@ -8734,11 +8791,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8734
8791
  } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8735
8792
  /**
8736
8793
  * List IAKs (Integration Api Keys) of an integration
8737
- * @param {string} integrationVersionId ID of the integration version
8794
+ * @param {string} integrationId ID of the integration
8738
8795
  * @param {*} [options] Override http request option.
8739
8796
  * @throws {RequiredError}
8740
8797
  */
8741
- listIntegrationApiKeys: (integrationVersionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8798
+ listIntegrationApiKeys: (integrationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8742
8799
  /**
8743
8800
  * List integrations
8744
8801
  * @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 +8993,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8936
8993
  * @throws {RequiredError}
8937
8994
  */
8938
8995
  setWorkspacePaymentMethod: (id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8996
+ /**
8997
+ * Add an event to the analytics
8998
+ * @param {TrackAnalyticsBody} [trackAnalyticsBody] Add an event to the analytics
8999
+ * @param {*} [options] Override http request option.
9000
+ * @throws {RequiredError}
9001
+ */
9002
+ trackAnalytics: (trackAnalyticsBody?: TrackAnalyticsBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8939
9003
  /**
8940
9004
  * 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
9005
  * @param {string} id Bot ID
@@ -9084,14 +9148,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9084
9148
  * @throws {RequiredError}
9085
9149
  */
9086
9150
  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
9151
  /**
9096
9152
  * Charge unpaid invoices of a workspace.
9097
9153
  * @param {string} id Workspace ID
@@ -9137,17 +9193,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9137
9193
  createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
9138
9194
  /**
9139
9195
  * 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
9196
  * @param {CreateFileBody} [createFileBody] The file to upload.
9147
9197
  * @param {*} [options] Override http request option.
9148
9198
  * @throws {RequiredError}
9149
9199
  */
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>>;
9200
+ createFile(createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
9151
9201
  /**
9152
9202
  * Create integration
9153
9203
  * @param {CreateIntegrationBody} [createIntegrationBody] Integration
@@ -9673,11 +9723,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9673
9723
  } | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
9674
9724
  /**
9675
9725
  * List IAKs (Integration Api Keys) of an integration
9676
- * @param {string} integrationVersionId ID of the integration version
9726
+ * @param {string} integrationId ID of the integration
9677
9727
  * @param {*} [options] Override http request option.
9678
9728
  * @throws {RequiredError}
9679
9729
  */
9680
- listIntegrationApiKeys(integrationVersionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationApiKeysResponse>>;
9730
+ listIntegrationApiKeys(integrationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationApiKeysResponse>>;
9681
9731
  /**
9682
9732
  * List integrations
9683
9733
  * @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 +9925,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9875
9925
  * @throws {RequiredError}
9876
9926
  */
9877
9927
  setWorkspacePaymentMethod(id: string, setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetWorkspacePaymentMethodResponse>>;
9928
+ /**
9929
+ * Add an event to the analytics
9930
+ * @param {TrackAnalyticsBody} [trackAnalyticsBody] Add an event to the analytics
9931
+ * @param {*} [options] Override http request option.
9932
+ * @throws {RequiredError}
9933
+ */
9934
+ trackAnalytics(trackAnalyticsBody?: TrackAnalyticsBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
9878
9935
  /**
9879
9936
  * 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
9937
  * @param {string} id Bot ID
@@ -10020,13 +10077,6 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10020
10077
  * @throws {RequiredError}
10021
10078
  */
10022
10079
  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
10080
  /**
10031
10081
  * Charge unpaid invoices of a workspace.
10032
10082
  * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
@@ -10712,6 +10762,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10712
10762
  * @throws {RequiredError}
10713
10763
  */
10714
10764
  setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): AxiosPromise<SetWorkspacePaymentMethodResponse>;
10765
+ /**
10766
+ * Add an event to the analytics
10767
+ * @param {DefaultApiTrackAnalyticsRequest} requestParameters Request parameters.
10768
+ * @param {*} [options] Override http request option.
10769
+ * @throws {RequiredError}
10770
+ */
10771
+ trackAnalytics(requestParameters?: DefaultApiTrackAnalyticsRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
10715
10772
  /**
10716
10773
  * 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
10774
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
@@ -10881,25 +10938,6 @@ export interface DefaultApiChangeAISpendQuotaRequest {
10881
10938
  */
10882
10939
  readonly changeAISpendQuotaBody?: ChangeAISpendQuotaBody;
10883
10940
  }
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
10941
  /**
10904
10942
  * Request parameters for chargeWorkspaceUnpaidInvoices operation in DefaultApi.
10905
10943
  * @export
@@ -10990,42 +11028,6 @@ export interface DefaultApiCreateEventRequest {
10990
11028
  * @interface DefaultApiCreateFileRequest
10991
11029
  */
10992
11030
  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
11031
  /**
11030
11032
  * The file to upload.
11031
11033
  * @type {CreateFileBody}
@@ -12160,11 +12162,11 @@ export interface DefaultApiListFilesRequest {
12160
12162
  */
12161
12163
  export interface DefaultApiListIntegrationApiKeysRequest {
12162
12164
  /**
12163
- * ID of the integration version
12165
+ * ID of the integration
12164
12166
  * @type {string}
12165
12167
  * @memberof DefaultApiListIntegrationApiKeys
12166
12168
  */
12167
- readonly integrationVersionId: string;
12169
+ readonly integrationId: string;
12168
12170
  }
12169
12171
  /**
12170
12172
  * Request parameters for listIntegrations operation in DefaultApi.
@@ -12653,6 +12655,19 @@ export interface DefaultApiSetWorkspacePaymentMethodRequest {
12653
12655
  */
12654
12656
  readonly setWorkspacePaymentMethodBody?: SetWorkspacePaymentMethodBody;
12655
12657
  }
12658
+ /**
12659
+ * Request parameters for trackAnalytics operation in DefaultApi.
12660
+ * @export
12661
+ * @interface DefaultApiTrackAnalyticsRequest
12662
+ */
12663
+ export interface DefaultApiTrackAnalyticsRequest {
12664
+ /**
12665
+ * Add an event to the analytics
12666
+ * @type {TrackAnalyticsBody}
12667
+ * @memberof DefaultApiTrackAnalytics
12668
+ */
12669
+ readonly trackAnalyticsBody?: TrackAnalyticsBody;
12670
+ }
12656
12671
  /**
12657
12672
  * Request parameters for transferBot operation in DefaultApi.
12658
12673
  * @export
@@ -12952,14 +12967,6 @@ export declare class DefaultApi extends BaseAPI {
12952
12967
  * @memberof DefaultApi
12953
12968
  */
12954
12969
  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
12970
  /**
12964
12971
  * Charge unpaid invoices of a workspace.
12965
12972
  * @param {DefaultApiChargeWorkspaceUnpaidInvoicesRequest} requestParameters Request parameters.
@@ -13743,6 +13750,14 @@ export declare class DefaultApi extends BaseAPI {
13743
13750
  * @memberof DefaultApi
13744
13751
  */
13745
13752
  setWorkspacePaymentMethod(requestParameters: DefaultApiSetWorkspacePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SetWorkspacePaymentMethodResponse, any>>;
13753
+ /**
13754
+ * Add an event to the analytics
13755
+ * @param {DefaultApiTrackAnalyticsRequest} requestParameters Request parameters.
13756
+ * @param {*} [options] Override http request option.
13757
+ * @throws {RequiredError}
13758
+ * @memberof DefaultApi
13759
+ */
13760
+ trackAnalytics(requestParameters?: DefaultApiTrackAnalyticsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
13746
13761
  /**
13747
13762
  * 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
13763
  * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.