@botpress/client 1.38.1 → 1.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/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
 
@@ -8564,6 +8588,7 @@ interface CreateWorkspaceMemberRequestParams$1 {
8564
8588
  interface CreateWorkspaceMemberRequestBody$1 {
8565
8589
  email: string;
8566
8590
  role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
8591
+ sendEmail?: boolean;
8567
8592
  }
8568
8593
  type CreateWorkspaceMemberInput$1 = CreateWorkspaceMemberRequestBody$1 & CreateWorkspaceMemberRequestHeaders$1 & CreateWorkspaceMemberRequestQuery$1 & CreateWorkspaceMemberRequestParams$1;
8569
8594
  interface CreateWorkspaceMemberResponse$1 {
@@ -15028,6 +15053,7 @@ declare class Client$8 extends Client$9 {
15028
15053
  tags: {
15029
15054
  [k: string]: string;
15030
15055
  };
15056
+ type: "studio" | "adk" | "desk";
15031
15057
  }>;
15032
15058
  botIssues: (props: {
15033
15059
  id: string;
@@ -15358,7 +15384,7 @@ type GetSubscriptionInput = GetSubscriptionRequestBody & GetSubscriptionRequestH
15358
15384
  interface GetSubscriptionResponse {
15359
15385
  plan: {
15360
15386
  current: {
15361
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15387
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15362
15388
  planId: string;
15363
15389
  interval: "month" | "year";
15364
15390
  price: number;
@@ -15387,6 +15413,22 @@ interface GetSubscriptionResponse {
15387
15413
  } | null;
15388
15414
  };
15389
15415
  };
15416
+ /**
15417
+ * Active discounts applied to the subscription
15418
+ */
15419
+ discounts: {
15420
+ id: string;
15421
+ couponId: string;
15422
+ promotionCode: string | null;
15423
+ name: string | null;
15424
+ percentOff: number | null;
15425
+ amountOff: number | null;
15426
+ currency: string | null;
15427
+ duration: "forever" | "once" | "repeating";
15428
+ durationInMonths: number | null;
15429
+ start: string;
15430
+ end: string | null;
15431
+ }[];
15390
15432
  }
15391
15433
 
15392
15434
  interface PreviewSubscriptionUpdateRequestHeaders {
@@ -15412,6 +15454,10 @@ interface PreviewSubscriptionUpdateRequestBody {
15412
15454
  addons?: {
15413
15455
  [k: string]: number;
15414
15456
  };
15457
+ /**
15458
+ * Promotion code to apply with this subscription change (optional)
15459
+ */
15460
+ couponCode?: string;
15415
15461
  }
15416
15462
  type PreviewSubscriptionUpdateInput = PreviewSubscriptionUpdateRequestBody & PreviewSubscriptionUpdateRequestHeaders & PreviewSubscriptionUpdateRequestQuery & PreviewSubscriptionUpdateRequestParams;
15417
15463
  /**
@@ -15440,7 +15486,7 @@ interface PreviewSubscriptionUpdateResponse {
15440
15486
  immediate: {
15441
15487
  total: number;
15442
15488
  lineItems: {
15443
- type: "plan" | "addon" | "proration_credit";
15489
+ type: "plan" | "addon" | "proration_credit" | "discount";
15444
15490
  id: string;
15445
15491
  description: string;
15446
15492
  amount: number;
@@ -15453,7 +15499,7 @@ interface PreviewSubscriptionUpdateResponse {
15453
15499
  monthly: {
15454
15500
  total: number;
15455
15501
  lineItems: {
15456
- type: "plan" | "addon" | "proration_credit";
15502
+ type: "plan" | "addon" | "proration_credit" | "discount";
15457
15503
  id: string;
15458
15504
  description: string;
15459
15505
  amount: number;
@@ -15466,7 +15512,7 @@ interface PreviewSubscriptionUpdateResponse {
15466
15512
  yearly: {
15467
15513
  total: number;
15468
15514
  lineItems: {
15469
- type: "plan" | "addon" | "proration_credit";
15515
+ type: "plan" | "addon" | "proration_credit" | "discount";
15470
15516
  id: string;
15471
15517
  description: string;
15472
15518
  amount: number;
@@ -15474,6 +15520,22 @@ interface PreviewSubscriptionUpdateResponse {
15474
15520
  }[];
15475
15521
  };
15476
15522
  };
15523
+ /**
15524
+ * Active discounts applied to the subscription
15525
+ */
15526
+ discounts?: {
15527
+ id: string;
15528
+ couponId: string;
15529
+ promotionCode: string | null;
15530
+ name: string | null;
15531
+ percentOff: number | null;
15532
+ amountOff: number | null;
15533
+ currency: string | null;
15534
+ duration: "forever" | "once" | "repeating";
15535
+ durationInMonths: number | null;
15536
+ start: string;
15537
+ end: string | null;
15538
+ }[];
15477
15539
  currentPeriodEnd: string;
15478
15540
  }
15479
15541
 
@@ -15490,6 +15552,10 @@ interface SetPlanRequestBody {
15490
15552
  planId: string;
15491
15553
  interval: "month" | "year";
15492
15554
  testReferenceTime?: number;
15555
+ /**
15556
+ * Promotion code to apply with this plan change (optional)
15557
+ */
15558
+ couponCode?: string;
15493
15559
  }
15494
15560
  type SetPlanInput = SetPlanRequestBody & SetPlanRequestHeaders & SetPlanRequestQuery & SetPlanRequestParams;
15495
15561
  /**
@@ -15498,7 +15564,7 @@ type SetPlanInput = SetPlanRequestBody & SetPlanRequestHeaders & SetPlanRequestQ
15498
15564
  interface SetPlanResponse {
15499
15565
  plan: {
15500
15566
  current: {
15501
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15567
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15502
15568
  planId: string;
15503
15569
  interval: "month" | "year";
15504
15570
  price: number;
@@ -15527,6 +15593,22 @@ interface SetPlanResponse {
15527
15593
  } | null;
15528
15594
  };
15529
15595
  };
15596
+ /**
15597
+ * Active discounts applied to the subscription
15598
+ */
15599
+ discounts: {
15600
+ id: string;
15601
+ couponId: string;
15602
+ promotionCode: string | null;
15603
+ name: string | null;
15604
+ percentOff: number | null;
15605
+ amountOff: number | null;
15606
+ currency: string | null;
15607
+ duration: "forever" | "once" | "repeating";
15608
+ durationInMonths: number | null;
15609
+ start: string;
15610
+ end: string | null;
15611
+ }[];
15530
15612
  }
15531
15613
 
15532
15614
  interface SetAddonsRequestHeaders {
@@ -15542,6 +15624,10 @@ interface SetAddonsRequestBody {
15542
15624
  addons: {
15543
15625
  [k: string]: number;
15544
15626
  };
15627
+ /**
15628
+ * Promotion code to apply with this addon change (optional)
15629
+ */
15630
+ couponCode?: string;
15545
15631
  }
15546
15632
  type SetAddonsInput = SetAddonsRequestBody & SetAddonsRequestHeaders & SetAddonsRequestQuery & SetAddonsRequestParams;
15547
15633
  /**
@@ -15550,7 +15636,7 @@ type SetAddonsInput = SetAddonsRequestBody & SetAddonsRequestHeaders & SetAddons
15550
15636
  interface SetAddonsResponse {
15551
15637
  plan: {
15552
15638
  current: {
15553
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15639
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15554
15640
  planId: string;
15555
15641
  interval: "month" | "year";
15556
15642
  price: number;
@@ -15579,6 +15665,22 @@ interface SetAddonsResponse {
15579
15665
  } | null;
15580
15666
  };
15581
15667
  };
15668
+ /**
15669
+ * Active discounts applied to the subscription
15670
+ */
15671
+ discounts: {
15672
+ id: string;
15673
+ couponId: string;
15674
+ promotionCode: string | null;
15675
+ name: string | null;
15676
+ percentOff: number | null;
15677
+ amountOff: number | null;
15678
+ currency: string | null;
15679
+ duration: "forever" | "once" | "repeating";
15680
+ durationInMonths: number | null;
15681
+ start: string;
15682
+ end: string | null;
15683
+ }[];
15582
15684
  }
15583
15685
 
15584
15686
  interface SetCancelAtPeriodEndRequestHeaders {
@@ -15588,7 +15690,6 @@ interface SetCancelAtPeriodEndRequestQuery {
15588
15690
  interface SetCancelAtPeriodEndRequestParams {
15589
15691
  }
15590
15692
  interface SetCancelAtPeriodEndRequestBody {
15591
- cancelAtPeriodEnd: boolean;
15592
15693
  }
15593
15694
  type SetCancelAtPeriodEndInput = SetCancelAtPeriodEndRequestBody & SetCancelAtPeriodEndRequestHeaders & SetCancelAtPeriodEndRequestQuery & SetCancelAtPeriodEndRequestParams;
15594
15695
  /**
@@ -15597,7 +15698,7 @@ type SetCancelAtPeriodEndInput = SetCancelAtPeriodEndRequestBody & SetCancelAtPe
15597
15698
  interface SetCancelAtPeriodEndResponse {
15598
15699
  plan: {
15599
15700
  current: {
15600
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15701
+ status: "active" | "canceled" | "past_due" | "action_required" | "incomplete" | "grace_period";
15601
15702
  planId: string;
15602
15703
  interval: "month" | "year";
15603
15704
  price: number;
@@ -15626,6 +15727,22 @@ interface SetCancelAtPeriodEndResponse {
15626
15727
  } | null;
15627
15728
  };
15628
15729
  };
15730
+ /**
15731
+ * Active discounts applied to the subscription
15732
+ */
15733
+ discounts: {
15734
+ id: string;
15735
+ couponId: string;
15736
+ promotionCode: string | null;
15737
+ name: string | null;
15738
+ percentOff: number | null;
15739
+ amountOff: number | null;
15740
+ currency: string | null;
15741
+ duration: "forever" | "once" | "repeating";
15742
+ durationInMonths: number | null;
15743
+ start: string;
15744
+ end: string | null;
15745
+ }[];
15629
15746
  }
15630
15747
 
15631
15748
  interface GetAutoRechargeSettingsRequestHeaders {
@@ -15639,28 +15756,9 @@ interface GetAutoRechargeSettingsRequestBody {
15639
15756
  type GetAutoRechargeSettingsInput = GetAutoRechargeSettingsRequestBody & GetAutoRechargeSettingsRequestHeaders & GetAutoRechargeSettingsRequestQuery & GetAutoRechargeSettingsRequestParams;
15640
15757
  interface GetAutoRechargeSettingsResponse {
15641
15758
  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: {
15759
+ [k: string]: {
15661
15760
  enabled: boolean;
15662
15761
  threshold?: number;
15663
- limit?: number;
15664
15762
  disabledReason?: string;
15665
15763
  };
15666
15764
  };
@@ -15674,57 +15772,18 @@ interface SetAutoRechargeSettingsRequestParams {
15674
15772
  }
15675
15773
  interface SetAutoRechargeSettingsRequestBody {
15676
15774
  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?: {
15775
+ [k: string]: {
15690
15776
  enabled: boolean;
15691
15777
  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
15778
  };
15701
15779
  };
15702
15780
  }
15703
15781
  type SetAutoRechargeSettingsInput = SetAutoRechargeSettingsRequestBody & SetAutoRechargeSettingsRequestHeaders & SetAutoRechargeSettingsRequestQuery & SetAutoRechargeSettingsRequestParams;
15704
15782
  interface SetAutoRechargeSettingsResponse {
15705
15783
  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: {
15784
+ [k: string]: {
15725
15785
  enabled: boolean;
15726
15786
  threshold?: number;
15727
- limit?: number;
15728
15787
  disabledReason?: string;
15729
15788
  };
15730
15789
  };
@@ -24429,6 +24488,10 @@ interface CreateBotRequestBody {
24429
24488
  * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
24430
24489
  */
24431
24490
  dev?: boolean;
24491
+ /**
24492
+ * Type of the [Bot](#schema_bot)
24493
+ */
24494
+ type?: "studio" | "adk" | "desk";
24432
24495
  }
24433
24496
  type CreateBotInput = CreateBotRequestBody & CreateBotRequestHeaders & CreateBotRequestQuery & CreateBotRequestParams;
24434
24497
  interface CreateBotResponse {
@@ -24848,6 +24911,10 @@ interface CreateBotResponse {
24848
24911
  */
24849
24912
  name: string;
24850
24913
  }[];
24914
+ /**
24915
+ * Type of the [Bot](#schema_bot)
24916
+ */
24917
+ type: "studio" | "adk" | "desk";
24851
24918
  };
24852
24919
  }
24853
24920
 
@@ -25119,6 +25186,10 @@ interface UpdateBotRequestBody {
25119
25186
  * UNUSED. Please ignore this field. It will be removed in the near future.
25120
25187
  */
25121
25188
  shouldMergePlugins?: boolean;
25189
+ /**
25190
+ * Type of the [Bot](#schema_bot)
25191
+ */
25192
+ type?: "studio" | "adk" | "desk";
25122
25193
  }
25123
25194
  type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
25124
25195
  interface UpdateBotResponse {
@@ -25538,6 +25609,10 @@ interface UpdateBotResponse {
25538
25609
  */
25539
25610
  name: string;
25540
25611
  }[];
25612
+ /**
25613
+ * Type of the [Bot](#schema_bot)
25614
+ */
25615
+ type: "studio" | "adk" | "desk";
25541
25616
  };
25542
25617
  }
25543
25618
 
@@ -25613,6 +25688,10 @@ interface ListBotsResponse {
25613
25688
  tags: {
25614
25689
  [k: string]: string;
25615
25690
  };
25691
+ /**
25692
+ * Type of the [Bot](#schema_bot)
25693
+ */
25694
+ type: "studio" | "adk" | "desk";
25616
25695
  }[];
25617
25696
  meta: {
25618
25697
  /**
@@ -26050,6 +26129,10 @@ interface GetBotResponse {
26050
26129
  */
26051
26130
  name: string;
26052
26131
  }[];
26132
+ /**
26133
+ * Type of the [Bot](#schema_bot)
26134
+ */
26135
+ type: "studio" | "adk" | "desk";
26053
26136
  };
26054
26137
  }
26055
26138
 
@@ -27241,6 +27324,7 @@ interface CreateWorkspaceMemberRequestParams {
27241
27324
  interface CreateWorkspaceMemberRequestBody {
27242
27325
  email: string;
27243
27326
  role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
27327
+ sendEmail?: boolean;
27244
27328
  }
27245
27329
  type CreateWorkspaceMemberInput = CreateWorkspaceMemberRequestBody & CreateWorkspaceMemberRequestHeaders & CreateWorkspaceMemberRequestQuery & CreateWorkspaceMemberRequestParams;
27246
27330
  interface CreateWorkspaceMemberResponse {
@@ -36695,6 +36779,10 @@ interface Bot {
36695
36779
  */
36696
36780
  name: string;
36697
36781
  }[];
36782
+ /**
36783
+ * Type of the [Bot](#schema_bot)
36784
+ */
36785
+ type: "studio" | "adk" | "desk";
36698
36786
  }
36699
36787
  interface Integration {
36700
36788
  /**
@@ -38562,6 +38650,7 @@ declare class Client extends Client$1 implements IClient {
38562
38650
  tags: {
38563
38651
  [k: string]: string;
38564
38652
  };
38653
+ type: "studio" | "adk" | "desk";
38565
38654
  }>;
38566
38655
  botIssues: (props: {
38567
38656
  id: string;