@botpress/client 0.29.3 → 0.29.4

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.
Files changed (10) hide show
  1. package/.turbo/turbo-build.log +7 -7
  2. package/.turbo/turbo-generate.log +1 -1
  3. package/dist/bundle.cjs +1 -1
  4. package/dist/bundle.cjs.map +2 -2
  5. package/dist/index.cjs +3 -3
  6. package/dist/index.cjs.map +2 -2
  7. package/dist/index.d.ts +240 -24
  8. package/dist/index.mjs +3 -3
  9. package/dist/index.mjs.map +2 -2
  10. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -2333,6 +2333,10 @@ interface GetPublicIntegrationByIdResponse {
2333
2333
  interfaces: {
2334
2334
  [k: string]: {
2335
2335
  id: string;
2336
+ /**
2337
+ * Name of the interface
2338
+ */
2339
+ name: string;
2336
2340
  entities: {
2337
2341
  [k: string]: {
2338
2342
  name: string;
@@ -2354,6 +2358,14 @@ interface GetPublicIntegrationByIdResponse {
2354
2358
  * Configuration definition
2355
2359
  */
2356
2360
  configuration: {
2361
+ /**
2362
+ * Title of the configuration
2363
+ */
2364
+ title?: string;
2365
+ /**
2366
+ * Description of the configuration
2367
+ */
2368
+ description?: string;
2357
2369
  /**
2358
2370
  * Identifier configuration of the [Integration](#schema_integration)
2359
2371
  */
@@ -2373,6 +2385,14 @@ interface GetPublicIntegrationByIdResponse {
2373
2385
  * Configuration definition
2374
2386
  */
2375
2387
  [k: string]: {
2388
+ /**
2389
+ * Title of the configuration
2390
+ */
2391
+ title?: string;
2392
+ /**
2393
+ * Description of the configuration
2394
+ */
2395
+ description?: string;
2376
2396
  /**
2377
2397
  * Identifier configuration of the [Integration](#schema_integration)
2378
2398
  */
@@ -2514,6 +2534,8 @@ interface GetPublicIntegrationByIdResponse {
2514
2534
  * Description of the action
2515
2535
  */
2516
2536
  description?: string;
2537
+ billable?: boolean;
2538
+ cacheable?: boolean;
2517
2539
  input: {
2518
2540
  schema: {
2519
2541
  [k: string]: any;
@@ -2670,6 +2692,10 @@ interface GetPublicIntegrationResponse {
2670
2692
  interfaces: {
2671
2693
  [k: string]: {
2672
2694
  id: string;
2695
+ /**
2696
+ * Name of the interface
2697
+ */
2698
+ name: string;
2673
2699
  entities: {
2674
2700
  [k: string]: {
2675
2701
  name: string;
@@ -2691,6 +2717,14 @@ interface GetPublicIntegrationResponse {
2691
2717
  * Configuration definition
2692
2718
  */
2693
2719
  configuration: {
2720
+ /**
2721
+ * Title of the configuration
2722
+ */
2723
+ title?: string;
2724
+ /**
2725
+ * Description of the configuration
2726
+ */
2727
+ description?: string;
2694
2728
  /**
2695
2729
  * Identifier configuration of the [Integration](#schema_integration)
2696
2730
  */
@@ -2710,6 +2744,14 @@ interface GetPublicIntegrationResponse {
2710
2744
  * Configuration definition
2711
2745
  */
2712
2746
  [k: string]: {
2747
+ /**
2748
+ * Title of the configuration
2749
+ */
2750
+ title?: string;
2751
+ /**
2752
+ * Description of the configuration
2753
+ */
2754
+ description?: string;
2713
2755
  /**
2714
2756
  * Identifier configuration of the [Integration](#schema_integration)
2715
2757
  */
@@ -2851,6 +2893,8 @@ interface GetPublicIntegrationResponse {
2851
2893
  * Description of the action
2852
2894
  */
2853
2895
  description?: string;
2896
+ billable?: boolean;
2897
+ cacheable?: boolean;
2854
2898
  input: {
2855
2899
  schema: {
2856
2900
  [k: string]: any;
@@ -3041,6 +3085,8 @@ interface CreateBotRequestBody {
3041
3085
  * Description of the action
3042
3086
  */
3043
3087
  description?: string;
3088
+ billable?: boolean;
3089
+ cacheable?: boolean;
3044
3090
  input: {
3045
3091
  schema: {
3046
3092
  [k: string]: any;
@@ -3178,6 +3224,7 @@ interface CreateBotResponse {
3178
3224
  webhookUrl: string;
3179
3225
  webhookId: string;
3180
3226
  identifier?: string;
3227
+ configurationType: string | null;
3181
3228
  configuration: {
3182
3229
  [k: string]: any;
3183
3230
  };
@@ -3385,6 +3432,8 @@ interface CreateBotResponse {
3385
3432
  * Description of the action
3386
3433
  */
3387
3434
  description?: string;
3435
+ billable?: boolean;
3436
+ cacheable?: boolean;
3388
3437
  input: {
3389
3438
  schema: {
3390
3439
  [k: string]: any;
@@ -3554,6 +3603,8 @@ interface UpdateBotRequestBody {
3554
3603
  * Description of the action
3555
3604
  */
3556
3605
  description?: string;
3606
+ billable?: boolean;
3607
+ cacheable?: boolean;
3557
3608
  input: {
3558
3609
  schema: {
3559
3610
  [k: string]: any;
@@ -3664,6 +3715,7 @@ interface UpdateBotResponse {
3664
3715
  webhookUrl: string;
3665
3716
  webhookId: string;
3666
3717
  identifier?: string;
3718
+ configurationType: string | null;
3667
3719
  configuration: {
3668
3720
  [k: string]: any;
3669
3721
  };
@@ -3871,6 +3923,8 @@ interface UpdateBotResponse {
3871
3923
  * Description of the action
3872
3924
  */
3873
3925
  description?: string;
3926
+ billable?: boolean;
3927
+ cacheable?: boolean;
3874
3928
  input: {
3875
3929
  schema: {
3876
3930
  [k: string]: any;
@@ -4023,6 +4077,7 @@ interface GetBotResponse {
4023
4077
  webhookUrl: string;
4024
4078
  webhookId: string;
4025
4079
  identifier?: string;
4080
+ configurationType: string | null;
4026
4081
  configuration: {
4027
4082
  [k: string]: any;
4028
4083
  };
@@ -4230,6 +4285,8 @@ interface GetBotResponse {
4230
4285
  * Description of the action
4231
4286
  */
4232
4287
  description?: string;
4288
+ billable?: boolean;
4289
+ cacheable?: boolean;
4233
4290
  input: {
4234
4291
  schema: {
4235
4292
  [k: string]: any;
@@ -4635,10 +4692,6 @@ interface GetUpcomingInvoiceRequestBody {
4635
4692
  }
4636
4693
  type GetUpcomingInvoiceInput = GetUpcomingInvoiceRequestBody & GetUpcomingInvoiceRequestHeaders & GetUpcomingInvoiceRequestQuery & GetUpcomingInvoiceRequestParams;
4637
4694
  interface GetUpcomingInvoiceResponse {
4638
- /**
4639
- * ID of the invoice.
4640
- */
4641
- id: string;
4642
4695
  /**
4643
4696
  * Total amount to pay of the invoice.
4644
4697
  */
@@ -5232,30 +5285,18 @@ interface CreateIntegrationRequestBody {
5232
5285
  * Version of the [Integration](#schema_integration)
5233
5286
  */
5234
5287
  version: string;
5235
- interfaces?: {
5236
- [k: string]: {
5237
- id: string;
5238
- entities: {
5239
- [k: string]: {
5240
- name: string;
5241
- };
5242
- };
5243
- actions: {
5244
- [k: string]: {
5245
- name: string;
5246
- };
5247
- };
5248
- events: {
5249
- [k: string]: {
5250
- name: string;
5251
- };
5252
- };
5253
- };
5254
- };
5255
5288
  /**
5256
5289
  * Default configuration definition of the integration
5257
5290
  */
5258
5291
  configuration?: {
5292
+ /**
5293
+ * Title of the configuration
5294
+ */
5295
+ title?: string;
5296
+ /**
5297
+ * Description of the configuration
5298
+ */
5299
+ description?: string;
5259
5300
  /**
5260
5301
  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
5261
5302
  */
@@ -5272,6 +5313,14 @@ interface CreateIntegrationRequestBody {
5272
5313
  */
5273
5314
  configurations?: {
5274
5315
  [k: string]: {
5316
+ /**
5317
+ * Title of the configuration
5318
+ */
5319
+ title?: string;
5320
+ /**
5321
+ * Description of the configuration
5322
+ */
5323
+ description?: string;
5275
5324
  /**
5276
5325
  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
5277
5326
  */
@@ -5332,6 +5381,8 @@ interface CreateIntegrationRequestBody {
5332
5381
  * Description of the action
5333
5382
  */
5334
5383
  description?: string;
5384
+ billable?: boolean;
5385
+ cacheable?: boolean;
5335
5386
  input: {
5336
5387
  schema: {
5337
5388
  [k: string]: any;
@@ -5465,6 +5516,26 @@ interface CreateIntegrationRequestBody {
5465
5516
  };
5466
5517
  };
5467
5518
  };
5519
+ interfaces?: {
5520
+ [k: string]: {
5521
+ id: string;
5522
+ entities: {
5523
+ [k: string]: {
5524
+ name: string;
5525
+ };
5526
+ };
5527
+ actions: {
5528
+ [k: string]: {
5529
+ name: string;
5530
+ };
5531
+ };
5532
+ events: {
5533
+ [k: string]: {
5534
+ name: string;
5535
+ };
5536
+ };
5537
+ };
5538
+ };
5468
5539
  /**
5469
5540
  * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
5470
5541
  */
@@ -5547,6 +5618,10 @@ interface CreateIntegrationResponse {
5547
5618
  interfaces: {
5548
5619
  [k: string]: {
5549
5620
  id: string;
5621
+ /**
5622
+ * Name of the interface
5623
+ */
5624
+ name: string;
5550
5625
  entities: {
5551
5626
  [k: string]: {
5552
5627
  name: string;
@@ -5568,6 +5643,14 @@ interface CreateIntegrationResponse {
5568
5643
  * Configuration definition
5569
5644
  */
5570
5645
  configuration: {
5646
+ /**
5647
+ * Title of the configuration
5648
+ */
5649
+ title?: string;
5650
+ /**
5651
+ * Description of the configuration
5652
+ */
5653
+ description?: string;
5571
5654
  /**
5572
5655
  * Identifier configuration of the [Integration](#schema_integration)
5573
5656
  */
@@ -5587,6 +5670,14 @@ interface CreateIntegrationResponse {
5587
5670
  * Configuration definition
5588
5671
  */
5589
5672
  [k: string]: {
5673
+ /**
5674
+ * Title of the configuration
5675
+ */
5676
+ title?: string;
5677
+ /**
5678
+ * Description of the configuration
5679
+ */
5680
+ description?: string;
5590
5681
  /**
5591
5682
  * Identifier configuration of the [Integration](#schema_integration)
5592
5683
  */
@@ -5728,6 +5819,8 @@ interface CreateIntegrationResponse {
5728
5819
  * Description of the action
5729
5820
  */
5730
5821
  description?: string;
5822
+ billable?: boolean;
5823
+ cacheable?: boolean;
5731
5824
  input: {
5732
5825
  schema: {
5733
5826
  [k: string]: any;
@@ -5838,6 +5931,14 @@ interface UpdateIntegrationRequestBody {
5838
5931
  * Default configuration definition of the integration
5839
5932
  */
5840
5933
  configuration?: {
5934
+ /**
5935
+ * Title of the configuration
5936
+ */
5937
+ title?: string;
5938
+ /**
5939
+ * Description of the configuration
5940
+ */
5941
+ description?: string;
5841
5942
  /**
5842
5943
  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
5843
5944
  */
@@ -5854,6 +5955,14 @@ interface UpdateIntegrationRequestBody {
5854
5955
  */
5855
5956
  configurations?: {
5856
5957
  [k: string]: {
5958
+ /**
5959
+ * Title of the configuration
5960
+ */
5961
+ title?: string;
5962
+ /**
5963
+ * Description of the configuration
5964
+ */
5965
+ description?: string;
5857
5966
  /**
5858
5967
  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
5859
5968
  */
@@ -5952,6 +6061,8 @@ interface UpdateIntegrationRequestBody {
5952
6061
  * Description of the action
5953
6062
  */
5954
6063
  description?: string;
6064
+ billable?: boolean;
6065
+ cacheable?: boolean;
5955
6066
  input: {
5956
6067
  schema: {
5957
6068
  [k: string]: any;
@@ -6145,6 +6256,10 @@ interface UpdateIntegrationResponse {
6145
6256
  interfaces: {
6146
6257
  [k: string]: {
6147
6258
  id: string;
6259
+ /**
6260
+ * Name of the interface
6261
+ */
6262
+ name: string;
6148
6263
  entities: {
6149
6264
  [k: string]: {
6150
6265
  name: string;
@@ -6166,6 +6281,14 @@ interface UpdateIntegrationResponse {
6166
6281
  * Configuration definition
6167
6282
  */
6168
6283
  configuration: {
6284
+ /**
6285
+ * Title of the configuration
6286
+ */
6287
+ title?: string;
6288
+ /**
6289
+ * Description of the configuration
6290
+ */
6291
+ description?: string;
6169
6292
  /**
6170
6293
  * Identifier configuration of the [Integration](#schema_integration)
6171
6294
  */
@@ -6185,6 +6308,14 @@ interface UpdateIntegrationResponse {
6185
6308
  * Configuration definition
6186
6309
  */
6187
6310
  [k: string]: {
6311
+ /**
6312
+ * Title of the configuration
6313
+ */
6314
+ title?: string;
6315
+ /**
6316
+ * Description of the configuration
6317
+ */
6318
+ description?: string;
6188
6319
  /**
6189
6320
  * Identifier configuration of the [Integration](#schema_integration)
6190
6321
  */
@@ -6326,6 +6457,8 @@ interface UpdateIntegrationResponse {
6326
6457
  * Description of the action
6327
6458
  */
6328
6459
  description?: string;
6460
+ billable?: boolean;
6461
+ cacheable?: boolean;
6329
6462
  input: {
6330
6463
  schema: {
6331
6464
  [k: string]: any;
@@ -6540,6 +6673,10 @@ interface GetIntegrationResponse {
6540
6673
  interfaces: {
6541
6674
  [k: string]: {
6542
6675
  id: string;
6676
+ /**
6677
+ * Name of the interface
6678
+ */
6679
+ name: string;
6543
6680
  entities: {
6544
6681
  [k: string]: {
6545
6682
  name: string;
@@ -6561,6 +6698,14 @@ interface GetIntegrationResponse {
6561
6698
  * Configuration definition
6562
6699
  */
6563
6700
  configuration: {
6701
+ /**
6702
+ * Title of the configuration
6703
+ */
6704
+ title?: string;
6705
+ /**
6706
+ * Description of the configuration
6707
+ */
6708
+ description?: string;
6564
6709
  /**
6565
6710
  * Identifier configuration of the [Integration](#schema_integration)
6566
6711
  */
@@ -6580,6 +6725,14 @@ interface GetIntegrationResponse {
6580
6725
  * Configuration definition
6581
6726
  */
6582
6727
  [k: string]: {
6728
+ /**
6729
+ * Title of the configuration
6730
+ */
6731
+ title?: string;
6732
+ /**
6733
+ * Description of the configuration
6734
+ */
6735
+ description?: string;
6583
6736
  /**
6584
6737
  * Identifier configuration of the [Integration](#schema_integration)
6585
6738
  */
@@ -6721,6 +6874,8 @@ interface GetIntegrationResponse {
6721
6874
  * Description of the action
6722
6875
  */
6723
6876
  description?: string;
6877
+ billable?: boolean;
6878
+ cacheable?: boolean;
6724
6879
  input: {
6725
6880
  schema: {
6726
6881
  [k: string]: any;
@@ -6894,6 +7049,10 @@ interface GetIntegrationByNameResponse {
6894
7049
  interfaces: {
6895
7050
  [k: string]: {
6896
7051
  id: string;
7052
+ /**
7053
+ * Name of the interface
7054
+ */
7055
+ name: string;
6897
7056
  entities: {
6898
7057
  [k: string]: {
6899
7058
  name: string;
@@ -6915,6 +7074,14 @@ interface GetIntegrationByNameResponse {
6915
7074
  * Configuration definition
6916
7075
  */
6917
7076
  configuration: {
7077
+ /**
7078
+ * Title of the configuration
7079
+ */
7080
+ title?: string;
7081
+ /**
7082
+ * Description of the configuration
7083
+ */
7084
+ description?: string;
6918
7085
  /**
6919
7086
  * Identifier configuration of the [Integration](#schema_integration)
6920
7087
  */
@@ -6934,6 +7101,14 @@ interface GetIntegrationByNameResponse {
6934
7101
  * Configuration definition
6935
7102
  */
6936
7103
  [k: string]: {
7104
+ /**
7105
+ * Title of the configuration
7106
+ */
7107
+ title?: string;
7108
+ /**
7109
+ * Description of the configuration
7110
+ */
7111
+ description?: string;
6937
7112
  /**
6938
7113
  * Identifier configuration of the [Integration](#schema_integration)
6939
7114
  */
@@ -7075,6 +7250,8 @@ interface GetIntegrationByNameResponse {
7075
7250
  * Description of the action
7076
7251
  */
7077
7252
  description?: string;
7253
+ billable?: boolean;
7254
+ cacheable?: boolean;
7078
7255
  input: {
7079
7256
  schema: {
7080
7257
  [k: string]: any;
@@ -7245,6 +7422,8 @@ interface CreateInterfaceRequestBody {
7245
7422
  * Description of the action
7246
7423
  */
7247
7424
  description?: string;
7425
+ billable?: boolean;
7426
+ cacheable?: boolean;
7248
7427
  input: {
7249
7428
  schema: {
7250
7429
  [k: string]: any;
@@ -7330,6 +7509,8 @@ interface CreateInterfaceResponse {
7330
7509
  * Description of the action
7331
7510
  */
7332
7511
  description?: string;
7512
+ billable?: boolean;
7513
+ cacheable?: boolean;
7333
7514
  input: {
7334
7515
  schema: {
7335
7516
  [k: string]: any;
@@ -7426,6 +7607,8 @@ interface GetInterfaceResponse {
7426
7607
  * Description of the action
7427
7608
  */
7428
7609
  description?: string;
7610
+ billable?: boolean;
7611
+ cacheable?: boolean;
7429
7612
  input: {
7430
7613
  schema: {
7431
7614
  [k: string]: any;
@@ -7523,6 +7706,8 @@ interface GetInterfaceByNameResponse {
7523
7706
  * Description of the action
7524
7707
  */
7525
7708
  description?: string;
7709
+ billable?: boolean;
7710
+ cacheable?: boolean;
7526
7711
  input: {
7527
7712
  schema: {
7528
7713
  [k: string]: any;
@@ -7595,6 +7780,8 @@ interface UpdateInterfaceRequestBody {
7595
7780
  * Description of the action
7596
7781
  */
7597
7782
  description?: string;
7783
+ billable?: boolean;
7784
+ cacheable?: boolean;
7598
7785
  input: {
7599
7786
  schema: {
7600
7787
  [k: string]: any;
@@ -7680,6 +7867,8 @@ interface UpdateInterfaceResponse {
7680
7867
  * Description of the action
7681
7868
  */
7682
7869
  description?: string;
7870
+ billable?: boolean;
7871
+ cacheable?: boolean;
7683
7872
  input: {
7684
7873
  schema: {
7685
7874
  [k: string]: any;
@@ -9867,6 +10056,7 @@ interface Bot {
9867
10056
  webhookUrl: string;
9868
10057
  webhookId: string;
9869
10058
  identifier?: string;
10059
+ configurationType: string | null;
9870
10060
  configuration: {
9871
10061
  [k: string]: any;
9872
10062
  };
@@ -10074,6 +10264,8 @@ interface Bot {
10074
10264
  * Description of the action
10075
10265
  */
10076
10266
  description?: string;
10267
+ billable?: boolean;
10268
+ cacheable?: boolean;
10077
10269
  input: {
10078
10270
  schema: {
10079
10271
  [k: string]: any;
@@ -10165,6 +10357,10 @@ interface Integration {
10165
10357
  interfaces: {
10166
10358
  [k: string]: {
10167
10359
  id: string;
10360
+ /**
10361
+ * Name of the interface
10362
+ */
10363
+ name: string;
10168
10364
  entities: {
10169
10365
  [k: string]: {
10170
10366
  name: string;
@@ -10186,6 +10382,14 @@ interface Integration {
10186
10382
  * Configuration definition
10187
10383
  */
10188
10384
  configuration: {
10385
+ /**
10386
+ * Title of the configuration
10387
+ */
10388
+ title?: string;
10389
+ /**
10390
+ * Description of the configuration
10391
+ */
10392
+ description?: string;
10189
10393
  /**
10190
10394
  * Identifier configuration of the [Integration](#schema_integration)
10191
10395
  */
@@ -10205,6 +10409,14 @@ interface Integration {
10205
10409
  * Configuration definition
10206
10410
  */
10207
10411
  [k: string]: {
10412
+ /**
10413
+ * Title of the configuration
10414
+ */
10415
+ title?: string;
10416
+ /**
10417
+ * Description of the configuration
10418
+ */
10419
+ description?: string;
10208
10420
  /**
10209
10421
  * Identifier configuration of the [Integration](#schema_integration)
10210
10422
  */
@@ -10346,6 +10558,8 @@ interface Integration {
10346
10558
  * Description of the action
10347
10559
  */
10348
10560
  description?: string;
10561
+ billable?: boolean;
10562
+ cacheable?: boolean;
10349
10563
  input: {
10350
10564
  schema: {
10351
10565
  [k: string]: any;
@@ -10494,6 +10708,8 @@ interface Interface {
10494
10708
  * Description of the action
10495
10709
  */
10496
10710
  description?: string;
10711
+ billable?: boolean;
10712
+ cacheable?: boolean;
10497
10713
  input: {
10498
10714
  schema: {
10499
10715
  [k: string]: any;