@botpress/client 1.38.0 → 1.38.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/index.d.ts CHANGED
@@ -5753,6 +5753,10 @@ interface CreateBotRequestBody$1 {
5753
5753
  * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
5754
5754
  */
5755
5755
  dev?: boolean;
5756
+ /**
5757
+ * Type of the [Bot](#schema_bot)
5758
+ */
5759
+ type?: "studio" | "adk" | "desk";
5756
5760
  }
5757
5761
  type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
5758
5762
  interface CreateBotResponse$1 {
@@ -6172,6 +6176,10 @@ interface CreateBotResponse$1 {
6172
6176
  */
6173
6177
  name: string;
6174
6178
  }[];
6179
+ /**
6180
+ * Type of the [Bot](#schema_bot)
6181
+ */
6182
+ type: "studio" | "adk" | "desk";
6175
6183
  };
6176
6184
  }
6177
6185
 
@@ -6443,6 +6451,10 @@ interface UpdateBotRequestBody$1 {
6443
6451
  * UNUSED. Please ignore this field. It will be removed in the near future.
6444
6452
  */
6445
6453
  shouldMergePlugins?: boolean;
6454
+ /**
6455
+ * Type of the [Bot](#schema_bot)
6456
+ */
6457
+ type?: "studio" | "adk" | "desk";
6446
6458
  }
6447
6459
  type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
6448
6460
  interface UpdateBotResponse$1 {
@@ -6862,6 +6874,10 @@ interface UpdateBotResponse$1 {
6862
6874
  */
6863
6875
  name: string;
6864
6876
  }[];
6877
+ /**
6878
+ * Type of the [Bot](#schema_bot)
6879
+ */
6880
+ type: "studio" | "adk" | "desk";
6865
6881
  };
6866
6882
  }
6867
6883
 
@@ -6937,6 +6953,10 @@ interface ListBotsResponse$1 {
6937
6953
  tags: {
6938
6954
  [k: string]: string;
6939
6955
  };
6956
+ /**
6957
+ * Type of the [Bot](#schema_bot)
6958
+ */
6959
+ type: "studio" | "adk" | "desk";
6940
6960
  }[];
6941
6961
  meta: {
6942
6962
  /**
@@ -7374,6 +7394,10 @@ interface GetBotResponse$1 {
7374
7394
  */
7375
7395
  name: string;
7376
7396
  }[];
7397
+ /**
7398
+ * Type of the [Bot](#schema_bot)
7399
+ */
7400
+ type: "studio" | "adk" | "desk";
7377
7401
  };
7378
7402
  }
7379
7403
 
@@ -15028,6 +15052,7 @@ declare class Client$8 extends Client$9 {
15028
15052
  tags: {
15029
15053
  [k: string]: string;
15030
15054
  };
15055
+ type: "studio" | "adk" | "desk";
15031
15056
  }>;
15032
15057
  botIssues: (props: {
15033
15058
  id: string;
@@ -15358,7 +15383,7 @@ type GetSubscriptionInput = GetSubscriptionRequestBody & GetSubscriptionRequestH
15358
15383
  interface GetSubscriptionResponse {
15359
15384
  plan: {
15360
15385
  current: {
15361
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15386
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15362
15387
  planId: string;
15363
15388
  interval: "month" | "year";
15364
15389
  price: number;
@@ -15387,6 +15412,22 @@ interface GetSubscriptionResponse {
15387
15412
  } | null;
15388
15413
  };
15389
15414
  };
15415
+ /**
15416
+ * Active discounts applied to the subscription
15417
+ */
15418
+ discounts: {
15419
+ id: string;
15420
+ couponId: string;
15421
+ promotionCode: string | null;
15422
+ name: string | null;
15423
+ percentOff: number | null;
15424
+ amountOff: number | null;
15425
+ currency: string | null;
15426
+ duration: "forever" | "once" | "repeating";
15427
+ durationInMonths: number | null;
15428
+ start: string;
15429
+ end: string | null;
15430
+ }[];
15390
15431
  }
15391
15432
 
15392
15433
  interface PreviewSubscriptionUpdateRequestHeaders {
@@ -15412,6 +15453,10 @@ interface PreviewSubscriptionUpdateRequestBody {
15412
15453
  addons?: {
15413
15454
  [k: string]: number;
15414
15455
  };
15456
+ /**
15457
+ * Promotion code to apply with this subscription change (optional)
15458
+ */
15459
+ couponCode?: string;
15415
15460
  }
15416
15461
  type PreviewSubscriptionUpdateInput = PreviewSubscriptionUpdateRequestBody & PreviewSubscriptionUpdateRequestHeaders & PreviewSubscriptionUpdateRequestQuery & PreviewSubscriptionUpdateRequestParams;
15417
15462
  /**
@@ -15440,7 +15485,7 @@ interface PreviewSubscriptionUpdateResponse {
15440
15485
  immediate: {
15441
15486
  total: number;
15442
15487
  lineItems: {
15443
- type: "plan" | "addon" | "proration_credit";
15488
+ type: "plan" | "addon" | "proration_credit" | "discount";
15444
15489
  id: string;
15445
15490
  description: string;
15446
15491
  amount: number;
@@ -15453,7 +15498,7 @@ interface PreviewSubscriptionUpdateResponse {
15453
15498
  monthly: {
15454
15499
  total: number;
15455
15500
  lineItems: {
15456
- type: "plan" | "addon" | "proration_credit";
15501
+ type: "plan" | "addon" | "proration_credit" | "discount";
15457
15502
  id: string;
15458
15503
  description: string;
15459
15504
  amount: number;
@@ -15466,7 +15511,7 @@ interface PreviewSubscriptionUpdateResponse {
15466
15511
  yearly: {
15467
15512
  total: number;
15468
15513
  lineItems: {
15469
- type: "plan" | "addon" | "proration_credit";
15514
+ type: "plan" | "addon" | "proration_credit" | "discount";
15470
15515
  id: string;
15471
15516
  description: string;
15472
15517
  amount: number;
@@ -15474,6 +15519,22 @@ interface PreviewSubscriptionUpdateResponse {
15474
15519
  }[];
15475
15520
  };
15476
15521
  };
15522
+ /**
15523
+ * Active discounts applied to the subscription
15524
+ */
15525
+ discounts?: {
15526
+ id: string;
15527
+ couponId: string;
15528
+ promotionCode: string | null;
15529
+ name: string | null;
15530
+ percentOff: number | null;
15531
+ amountOff: number | null;
15532
+ currency: string | null;
15533
+ duration: "forever" | "once" | "repeating";
15534
+ durationInMonths: number | null;
15535
+ start: string;
15536
+ end: string | null;
15537
+ }[];
15477
15538
  currentPeriodEnd: string;
15478
15539
  }
15479
15540
 
@@ -15490,6 +15551,10 @@ interface SetPlanRequestBody {
15490
15551
  planId: string;
15491
15552
  interval: "month" | "year";
15492
15553
  testReferenceTime?: number;
15554
+ /**
15555
+ * Promotion code to apply with this plan change (optional)
15556
+ */
15557
+ couponCode?: string;
15493
15558
  }
15494
15559
  type SetPlanInput = SetPlanRequestBody & SetPlanRequestHeaders & SetPlanRequestQuery & SetPlanRequestParams;
15495
15560
  /**
@@ -15498,7 +15563,7 @@ type SetPlanInput = SetPlanRequestBody & SetPlanRequestHeaders & SetPlanRequestQ
15498
15563
  interface SetPlanResponse {
15499
15564
  plan: {
15500
15565
  current: {
15501
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15566
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15502
15567
  planId: string;
15503
15568
  interval: "month" | "year";
15504
15569
  price: number;
@@ -15527,6 +15592,22 @@ interface SetPlanResponse {
15527
15592
  } | null;
15528
15593
  };
15529
15594
  };
15595
+ /**
15596
+ * Active discounts applied to the subscription
15597
+ */
15598
+ discounts: {
15599
+ id: string;
15600
+ couponId: string;
15601
+ promotionCode: string | null;
15602
+ name: string | null;
15603
+ percentOff: number | null;
15604
+ amountOff: number | null;
15605
+ currency: string | null;
15606
+ duration: "forever" | "once" | "repeating";
15607
+ durationInMonths: number | null;
15608
+ start: string;
15609
+ end: string | null;
15610
+ }[];
15530
15611
  }
15531
15612
 
15532
15613
  interface SetAddonsRequestHeaders {
@@ -15542,6 +15623,10 @@ interface SetAddonsRequestBody {
15542
15623
  addons: {
15543
15624
  [k: string]: number;
15544
15625
  };
15626
+ /**
15627
+ * Promotion code to apply with this addon change (optional)
15628
+ */
15629
+ couponCode?: string;
15545
15630
  }
15546
15631
  type SetAddonsInput = SetAddonsRequestBody & SetAddonsRequestHeaders & SetAddonsRequestQuery & SetAddonsRequestParams;
15547
15632
  /**
@@ -15550,7 +15635,7 @@ type SetAddonsInput = SetAddonsRequestBody & SetAddonsRequestHeaders & SetAddons
15550
15635
  interface SetAddonsResponse {
15551
15636
  plan: {
15552
15637
  current: {
15553
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15638
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15554
15639
  planId: string;
15555
15640
  interval: "month" | "year";
15556
15641
  price: number;
@@ -15579,6 +15664,22 @@ interface SetAddonsResponse {
15579
15664
  } | null;
15580
15665
  };
15581
15666
  };
15667
+ /**
15668
+ * Active discounts applied to the subscription
15669
+ */
15670
+ discounts: {
15671
+ id: string;
15672
+ couponId: string;
15673
+ promotionCode: string | null;
15674
+ name: string | null;
15675
+ percentOff: number | null;
15676
+ amountOff: number | null;
15677
+ currency: string | null;
15678
+ duration: "forever" | "once" | "repeating";
15679
+ durationInMonths: number | null;
15680
+ start: string;
15681
+ end: string | null;
15682
+ }[];
15582
15683
  }
15583
15684
 
15584
15685
  interface SetCancelAtPeriodEndRequestHeaders {
@@ -15588,7 +15689,6 @@ interface SetCancelAtPeriodEndRequestQuery {
15588
15689
  interface SetCancelAtPeriodEndRequestParams {
15589
15690
  }
15590
15691
  interface SetCancelAtPeriodEndRequestBody {
15591
- cancelAtPeriodEnd: boolean;
15592
15692
  }
15593
15693
  type SetCancelAtPeriodEndInput = SetCancelAtPeriodEndRequestBody & SetCancelAtPeriodEndRequestHeaders & SetCancelAtPeriodEndRequestQuery & SetCancelAtPeriodEndRequestParams;
15594
15694
  /**
@@ -15597,7 +15697,7 @@ type SetCancelAtPeriodEndInput = SetCancelAtPeriodEndRequestBody & SetCancelAtPe
15597
15697
  interface SetCancelAtPeriodEndResponse {
15598
15698
  plan: {
15599
15699
  current: {
15600
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15700
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15601
15701
  planId: string;
15602
15702
  interval: "month" | "year";
15603
15703
  price: number;
@@ -15626,6 +15726,22 @@ interface SetCancelAtPeriodEndResponse {
15626
15726
  } | null;
15627
15727
  };
15628
15728
  };
15729
+ /**
15730
+ * Active discounts applied to the subscription
15731
+ */
15732
+ discounts: {
15733
+ id: string;
15734
+ couponId: string;
15735
+ promotionCode: string | null;
15736
+ name: string | null;
15737
+ percentOff: number | null;
15738
+ amountOff: number | null;
15739
+ currency: string | null;
15740
+ duration: "forever" | "once" | "repeating";
15741
+ durationInMonths: number | null;
15742
+ start: string;
15743
+ end: string | null;
15744
+ }[];
15629
15745
  }
15630
15746
 
15631
15747
  interface GetAutoRechargeSettingsRequestHeaders {
@@ -15639,28 +15755,9 @@ interface GetAutoRechargeSettingsRequestBody {
15639
15755
  type GetAutoRechargeSettingsInput = GetAutoRechargeSettingsRequestBody & GetAutoRechargeSettingsRequestHeaders & GetAutoRechargeSettingsRequestQuery & GetAutoRechargeSettingsRequestParams;
15640
15756
  interface GetAutoRechargeSettingsResponse {
15641
15757
  settings: {
15642
- table_row_count: {
15643
- enabled: boolean;
15644
- threshold?: number;
15645
- limit?: number;
15646
- disabledReason?: string;
15647
- };
15648
- invocation_calls: {
15649
- enabled: boolean;
15650
- threshold?: number;
15651
- limit?: number;
15652
- disabledReason?: string;
15653
- };
15654
- knowledgebase_vector_storage: {
15655
- enabled: boolean;
15656
- threshold?: number;
15657
- limit?: number;
15658
- disabledReason?: string;
15659
- };
15660
- storage_count: {
15758
+ [k: string]: {
15661
15759
  enabled: boolean;
15662
15760
  threshold?: number;
15663
- limit?: number;
15664
15761
  disabledReason?: string;
15665
15762
  };
15666
15763
  };
@@ -15674,57 +15771,18 @@ interface SetAutoRechargeSettingsRequestParams {
15674
15771
  }
15675
15772
  interface SetAutoRechargeSettingsRequestBody {
15676
15773
  settings: {
15677
- table_row_count?: {
15678
- enabled: boolean;
15679
- threshold?: number;
15680
- limit?: number;
15681
- disabledReason?: string;
15682
- };
15683
- invocation_calls?: {
15684
- enabled: boolean;
15685
- threshold?: number;
15686
- limit?: number;
15687
- disabledReason?: string;
15688
- };
15689
- knowledgebase_vector_storage?: {
15774
+ [k: string]: {
15690
15775
  enabled: boolean;
15691
15776
  threshold?: number;
15692
- limit?: number;
15693
- disabledReason?: string;
15694
- };
15695
- storage_count?: {
15696
- enabled: boolean;
15697
- threshold?: number;
15698
- limit?: number;
15699
- disabledReason?: string;
15700
15777
  };
15701
15778
  };
15702
15779
  }
15703
15780
  type SetAutoRechargeSettingsInput = SetAutoRechargeSettingsRequestBody & SetAutoRechargeSettingsRequestHeaders & SetAutoRechargeSettingsRequestQuery & SetAutoRechargeSettingsRequestParams;
15704
15781
  interface SetAutoRechargeSettingsResponse {
15705
15782
  settings: {
15706
- table_row_count: {
15707
- enabled: boolean;
15708
- threshold?: number;
15709
- limit?: number;
15710
- disabledReason?: string;
15711
- };
15712
- invocation_calls: {
15713
- enabled: boolean;
15714
- threshold?: number;
15715
- limit?: number;
15716
- disabledReason?: string;
15717
- };
15718
- knowledgebase_vector_storage: {
15719
- enabled: boolean;
15720
- threshold?: number;
15721
- limit?: number;
15722
- disabledReason?: string;
15723
- };
15724
- storage_count: {
15783
+ [k: string]: {
15725
15784
  enabled: boolean;
15726
15785
  threshold?: number;
15727
- limit?: number;
15728
15786
  disabledReason?: string;
15729
15787
  };
15730
15788
  };
@@ -24429,6 +24487,10 @@ interface CreateBotRequestBody {
24429
24487
  * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
24430
24488
  */
24431
24489
  dev?: boolean;
24490
+ /**
24491
+ * Type of the [Bot](#schema_bot)
24492
+ */
24493
+ type?: "studio" | "adk" | "desk";
24432
24494
  }
24433
24495
  type CreateBotInput = CreateBotRequestBody & CreateBotRequestHeaders & CreateBotRequestQuery & CreateBotRequestParams;
24434
24496
  interface CreateBotResponse {
@@ -24848,6 +24910,10 @@ interface CreateBotResponse {
24848
24910
  */
24849
24911
  name: string;
24850
24912
  }[];
24913
+ /**
24914
+ * Type of the [Bot](#schema_bot)
24915
+ */
24916
+ type: "studio" | "adk" | "desk";
24851
24917
  };
24852
24918
  }
24853
24919
 
@@ -25119,6 +25185,10 @@ interface UpdateBotRequestBody {
25119
25185
  * UNUSED. Please ignore this field. It will be removed in the near future.
25120
25186
  */
25121
25187
  shouldMergePlugins?: boolean;
25188
+ /**
25189
+ * Type of the [Bot](#schema_bot)
25190
+ */
25191
+ type?: "studio" | "adk" | "desk";
25122
25192
  }
25123
25193
  type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
25124
25194
  interface UpdateBotResponse {
@@ -25538,6 +25608,10 @@ interface UpdateBotResponse {
25538
25608
  */
25539
25609
  name: string;
25540
25610
  }[];
25611
+ /**
25612
+ * Type of the [Bot](#schema_bot)
25613
+ */
25614
+ type: "studio" | "adk" | "desk";
25541
25615
  };
25542
25616
  }
25543
25617
 
@@ -25613,6 +25687,10 @@ interface ListBotsResponse {
25613
25687
  tags: {
25614
25688
  [k: string]: string;
25615
25689
  };
25690
+ /**
25691
+ * Type of the [Bot](#schema_bot)
25692
+ */
25693
+ type: "studio" | "adk" | "desk";
25616
25694
  }[];
25617
25695
  meta: {
25618
25696
  /**
@@ -26050,6 +26128,10 @@ interface GetBotResponse {
26050
26128
  */
26051
26129
  name: string;
26052
26130
  }[];
26131
+ /**
26132
+ * Type of the [Bot](#schema_bot)
26133
+ */
26134
+ type: "studio" | "adk" | "desk";
26053
26135
  };
26054
26136
  }
26055
26137
 
@@ -36695,6 +36777,10 @@ interface Bot {
36695
36777
  */
36696
36778
  name: string;
36697
36779
  }[];
36780
+ /**
36781
+ * Type of the [Bot](#schema_bot)
36782
+ */
36783
+ type: "studio" | "adk" | "desk";
36698
36784
  }
36699
36785
  interface Integration {
36700
36786
  /**
@@ -38562,6 +38648,7 @@ declare class Client extends Client$1 implements IClient {
38562
38648
  tags: {
38563
38649
  [k: string]: string;
38564
38650
  };
38651
+ type: "studio" | "adk" | "desk";
38565
38652
  }>;
38566
38653
  botIssues: (props: {
38567
38654
  id: string;