chargebee 3.0.0-beta.4 → 3.0.0-beta.5

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 (47) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/cjs/environment.js +1 -1
  3. package/cjs/util.js +1 -1
  4. package/esm/environment.js +1 -1
  5. package/esm/util.js +1 -1
  6. package/package.json +1 -1
  7. package/types/core.d.ts +88 -78
  8. package/types/resources/Address.d.ts +2 -2
  9. package/types/resources/AdvanceInvoiceSchedule.d.ts +1 -1
  10. package/types/resources/AttachedItem.d.ts +4 -4
  11. package/types/resources/Card.d.ts +3 -3
  12. package/types/resources/Comment.d.ts +2 -2
  13. package/types/resources/Coupon.d.ts +5 -5
  14. package/types/resources/CreditNote.d.ts +7 -7
  15. package/types/resources/CreditNoteEstimate.d.ts +1 -1
  16. package/types/resources/Customer.d.ts +46 -46
  17. package/types/resources/Discount.d.ts +3 -3
  18. package/types/resources/Entitlement.d.ts +1 -1
  19. package/types/resources/EntitlementOverride.d.ts +1 -1
  20. package/types/resources/Estimate.d.ts +100 -100
  21. package/types/resources/Event.d.ts +3 -3
  22. package/types/resources/Export.d.ts +4 -4
  23. package/types/resources/Gift.d.ts +2 -2
  24. package/types/resources/HostedPage.d.ts +64 -64
  25. package/types/resources/Invoice.d.ts +44 -44
  26. package/types/resources/InvoiceEstimate.d.ts +1 -1
  27. package/types/resources/Item.d.ts +5 -5
  28. package/types/resources/ItemEntitlement.d.ts +2 -2
  29. package/types/resources/ItemFamily.d.ts +1 -1
  30. package/types/resources/ItemPrice.d.ts +11 -11
  31. package/types/resources/Order.d.ts +6 -6
  32. package/types/resources/PaymentSource.d.ts +13 -13
  33. package/types/resources/PaymentVoucher.d.ts +9 -9
  34. package/types/resources/PricingPageSession.d.ts +8 -8
  35. package/types/resources/PromotionalCredit.d.ts +4 -4
  36. package/types/resources/Purchase.d.ts +6 -6
  37. package/types/resources/Quote.d.ts +83 -83
  38. package/types/resources/QuotedSubscription.d.ts +1 -1
  39. package/types/resources/Ramp.d.ts +6 -6
  40. package/types/resources/Subscription.d.ts +144 -144
  41. package/types/resources/SubscriptionEstimate.d.ts +2 -2
  42. package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -2
  43. package/types/resources/Token.d.ts +2 -2
  44. package/types/resources/Transaction.d.ts +3 -3
  45. package/types/resources/UnbilledCharge.d.ts +3 -3
  46. package/types/resources/Usage.d.ts +3 -3
  47. package/types/resources/VirtualBankAccount.d.ts +1 -1
@@ -243,7 +243,7 @@ declare module 'chargebee' {
243
243
  billing_cycles?: number;
244
244
  mandatory_addons_to_remove?: string[];
245
245
  terms_to_charge?: number;
246
- billing_alignment_mode?: BillingAlignmentMode;
246
+ billing_alignment_mode?: BillingAlignmentModeEnum;
247
247
  coupon_ids?: string[];
248
248
  redirect_url?: string;
249
249
  cancel_url?: string;
@@ -283,7 +283,7 @@ declare module 'chargebee' {
283
283
  }
284
284
  export interface CheckoutOneTimeForItemsInputParam {
285
285
  business_entity_id?: string;
286
- layout?: Layout;
286
+ layout?: LayoutEnum;
287
287
  invoice_note?: string /**
288
288
  * @deprecated Please refer API docs to use other attributes
289
289
  */;
@@ -306,12 +306,12 @@ declare module 'chargebee' {
306
306
  entity_identifiers?: EntityIdentifiersCheckoutOneTimeForItemsInputParam[];
307
307
  }
308
308
  export interface CheckoutNewForItemsInputParam {
309
- layout?: Layout;
309
+ layout?: LayoutEnum;
310
310
  business_entity_id?: string;
311
311
  billing_cycles?: number;
312
312
  mandatory_items_to_remove?: string[];
313
313
  terms_to_charge?: number;
314
- billing_alignment_mode?: BillingAlignmentMode;
314
+ billing_alignment_mode?: BillingAlignmentModeEnum;
315
315
  coupon_ids?: string[];
316
316
  redirect_url?: string;
317
317
  cancel_url?: string;
@@ -335,7 +335,7 @@ declare module 'chargebee' {
335
335
  billing_cycles?: number;
336
336
  terms_to_charge?: number;
337
337
  reactivate_from?: number;
338
- billing_alignment_mode?: BillingAlignmentMode;
338
+ billing_alignment_mode?: BillingAlignmentModeEnum;
339
339
  coupon_ids?: string[];
340
340
  reactivate?: boolean;
341
341
  force_term_reset?: boolean;
@@ -353,18 +353,18 @@ declare module 'chargebee' {
353
353
  event_based_addons?: EventBasedAddonsCheckoutExistingInputParam[];
354
354
  }
355
355
  export interface CheckoutExistingForItemsInputParam {
356
- layout?: Layout;
356
+ layout?: LayoutEnum;
357
357
  mandatory_items_to_remove?: string[];
358
358
  replace_items_list?: boolean;
359
359
  invoice_date?: number;
360
360
  billing_cycles?: number;
361
361
  terms_to_charge?: number;
362
362
  reactivate_from?: number;
363
- billing_alignment_mode?: BillingAlignmentMode;
363
+ billing_alignment_mode?: BillingAlignmentModeEnum;
364
364
  coupon_ids?: string[];
365
365
  reactivate?: boolean;
366
366
  force_term_reset?: boolean;
367
- change_option?: ChangeOption;
367
+ change_option?: ChangeOptionEnum;
368
368
  changes_scheduled_at?: number;
369
369
  redirect_url?: string;
370
370
  cancel_url?: string;
@@ -410,7 +410,7 @@ declare module 'chargebee' {
410
410
  }
411
411
  export interface AcceptQuoteInputParam {
412
412
  redirect_url?: string;
413
- layout?: Layout;
413
+ layout?: LayoutEnum;
414
414
  quote?: QuoteAcceptQuoteInputParam;
415
415
  }
416
416
  export interface ExtendSubscriptionInputParam {
@@ -455,7 +455,7 @@ declare module 'chargebee' {
455
455
  subscription?: SubscriptionPreCancelInputParam;
456
456
  }
457
457
  export interface EventsInputParam {
458
- event_name: EventName;
458
+ event_name: EventNameEnum;
459
459
  occurred_at?: number;
460
460
  event_data: any;
461
461
  }
@@ -477,7 +477,7 @@ declare module 'chargebee' {
477
477
  state?: string;
478
478
  zip?: string;
479
479
  country?: string;
480
- validation_status?: ValidationStatus;
480
+ validation_status?: ValidationStatusEnum;
481
481
  }
482
482
  export interface CustomerCheckoutNewInputParam {
483
483
  id?: string;
@@ -487,7 +487,7 @@ declare module 'chargebee' {
487
487
  company?: string;
488
488
  phone?: string;
489
489
  locale?: string;
490
- taxability?: Taxability;
490
+ taxability?: TaxabilityEnum;
491
491
  vat_number?: string;
492
492
  vat_number_prefix?: string;
493
493
  consolidated_invoicing?: boolean;
@@ -506,7 +506,7 @@ declare module 'chargebee' {
506
506
  state?: string;
507
507
  zip?: string;
508
508
  country?: string;
509
- validation_status?: ValidationStatus;
509
+ validation_status?: ValidationStatusEnum;
510
510
  }
511
511
  export interface ContractTermCheckoutNewInputParam {
512
512
  action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
@@ -526,8 +526,8 @@ declare module 'chargebee' {
526
526
  * @deprecated Please refer API docs to use other attributes
527
527
  */
528
528
  coupon?: string;
529
- auto_collection?: AutoCollection;
530
- offline_payment_method?: OfflinePaymentMethod;
529
+ auto_collection?: AutoCollectionEnum;
530
+ offline_payment_method?: OfflinePaymentMethodEnum;
531
531
  invoice_notes?: string;
532
532
  affiliate_token?: string;
533
533
  contract_term_billing_cycle_on_renewal?: number;
@@ -536,7 +536,7 @@ declare module 'chargebee' {
536
536
  /**
537
537
  * @deprecated Please refer API docs to use other attributes
538
538
  */
539
- gateway?: Gateway;
539
+ gateway?: GatewayEnum;
540
540
  gateway_account_id?: string;
541
541
  }
542
542
 
@@ -547,9 +547,9 @@ declare module 'chargebee' {
547
547
  quantity_in_decimal?: string;
548
548
  unit_price_in_decimal?: string;
549
549
  service_period_in_days?: number;
550
- on_event?: OnEvent;
550
+ on_event?: OnEventEnum;
551
551
  charge_once?: boolean;
552
- charge_on?: ChargeOn;
552
+ charge_on?: ChargeOnEnum;
553
553
  }
554
554
  export interface AddonsCheckoutNewInputParam {
555
555
  id?: string;
@@ -573,7 +573,7 @@ declare module 'chargebee' {
573
573
  state?: string;
574
574
  zip?: string;
575
575
  country?: string;
576
- validation_status?: ValidationStatus;
576
+ validation_status?: ValidationStatusEnum;
577
577
  }
578
578
  export interface InvoiceCheckoutOneTimeInputParam {
579
579
  po_number?: string;
@@ -586,7 +586,7 @@ declare module 'chargebee' {
586
586
  company?: string;
587
587
  phone?: string;
588
588
  locale?: string;
589
- taxability?: Taxability;
589
+ taxability?: TaxabilityEnum;
590
590
  vat_number?: string;
591
591
  vat_number_prefix?: string;
592
592
  consolidated_invoicing?: boolean;
@@ -605,13 +605,13 @@ declare module 'chargebee' {
605
605
  state?: string;
606
606
  zip?: string;
607
607
  country?: string;
608
- validation_status?: ValidationStatus;
608
+ validation_status?: ValidationStatusEnum;
609
609
  }
610
610
  export interface CardCheckoutOneTimeInputParam {
611
611
  /**
612
612
  * @deprecated Please refer API docs to use other attributes
613
613
  */
614
- gateway?: Gateway;
614
+ gateway?: GatewayEnum;
615
615
  gateway_account_id?: string;
616
616
  }
617
617
 
@@ -624,7 +624,7 @@ declare module 'chargebee' {
624
624
  avalara_tax_code?: string;
625
625
  hsn_code?: string;
626
626
  taxjar_product_code?: string;
627
- avalara_sale_type?: AvalaraSaleType;
627
+ avalara_sale_type?: AvalaraSaleTypeEnum;
628
628
  avalara_transaction_type?: number;
629
629
  avalara_service_type?: number;
630
630
  date_from?: number;
@@ -653,7 +653,7 @@ declare module 'chargebee' {
653
653
  state?: string;
654
654
  zip?: string;
655
655
  country?: string;
656
- validation_status?: ValidationStatus;
656
+ validation_status?: ValidationStatusEnum;
657
657
  }
658
658
  export interface InvoiceCheckoutOneTimeForItemsInputParam {
659
659
  po_number?: string;
@@ -666,10 +666,10 @@ declare module 'chargebee' {
666
666
  company?: string;
667
667
  phone?: string;
668
668
  locale?: string;
669
- taxability?: Taxability;
669
+ taxability?: TaxabilityEnum;
670
670
  vat_number?: string;
671
671
  vat_number_prefix?: string;
672
- einvoicing_method?: EinvoicingMethod;
672
+ einvoicing_method?: EinvoicingMethodEnum;
673
673
  is_einvoice_enabled?: boolean;
674
674
  entity_identifier_scheme?: string;
675
675
  entity_identifier_standard?: string;
@@ -689,13 +689,13 @@ declare module 'chargebee' {
689
689
  state?: string;
690
690
  zip?: string;
691
691
  country?: string;
692
- validation_status?: ValidationStatus;
692
+ validation_status?: ValidationStatusEnum;
693
693
  }
694
694
  export interface CardCheckoutOneTimeForItemsInputParam {
695
695
  /**
696
696
  * @deprecated Please refer API docs to use other attributes
697
697
  */
698
- gateway?: Gateway;
698
+ gateway?: GatewayEnum;
699
699
  gateway_account_id?: string;
700
700
  }
701
701
 
@@ -708,7 +708,7 @@ declare module 'chargebee' {
708
708
  avalara_tax_code?: string;
709
709
  hsn_code?: string;
710
710
  taxjar_product_code?: string;
711
- avalara_sale_type?: AvalaraSaleType;
711
+ avalara_sale_type?: AvalaraSaleTypeEnum;
712
712
  avalara_transaction_type?: number;
713
713
  avalara_service_type?: number;
714
714
  date_from?: number;
@@ -717,14 +717,14 @@ declare module 'chargebee' {
717
717
  export interface DiscountsCheckoutOneTimeForItemsInputParam {
718
718
  percentage?: number;
719
719
  amount?: number;
720
- apply_on: ApplyOn;
720
+ apply_on: ApplyOnEnum;
721
721
  item_price_id?: string;
722
722
  }
723
723
  export interface EntityIdentifiersCheckoutOneTimeForItemsInputParam {
724
724
  id?: string;
725
725
  scheme?: string;
726
726
  value?: string;
727
- operation?: Operation;
727
+ operation?: OperationEnum;
728
728
  standard?: string;
729
729
  }
730
730
  export interface ItemTiersCheckoutOneTimeForItemsInputParam {
@@ -759,7 +759,7 @@ declare module 'chargebee' {
759
759
  state?: string;
760
760
  zip?: string;
761
761
  country?: string;
762
- validation_status?: ValidationStatus;
762
+ validation_status?: ValidationStatusEnum;
763
763
  }
764
764
  export interface CustomerCheckoutNewForItemsInputParam {
765
765
  id?: string;
@@ -769,13 +769,13 @@ declare module 'chargebee' {
769
769
  company?: string;
770
770
  phone?: string;
771
771
  locale?: string;
772
- taxability?: Taxability;
772
+ taxability?: TaxabilityEnum;
773
773
  vat_number?: string;
774
774
  vat_number_prefix?: string;
775
775
  is_einvoice_enabled?: boolean;
776
776
  entity_identifier_scheme?: string;
777
777
  entity_identifier_standard?: string;
778
- einvoicing_method?: EinvoicingMethod;
778
+ einvoicing_method?: EinvoicingMethodEnum;
779
779
  }
780
780
  export interface ShippingAddressCheckoutNewForItemsInputParam {
781
781
  first_name?: string;
@@ -791,7 +791,7 @@ declare module 'chargebee' {
791
791
  state?: string;
792
792
  zip?: string;
793
793
  country?: string;
794
- validation_status?: ValidationStatus;
794
+ validation_status?: ValidationStatusEnum;
795
795
  }
796
796
  export interface ContractTermCheckoutNewForItemsInputParam {
797
797
  action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
@@ -806,7 +806,7 @@ declare module 'chargebee' {
806
806
  setup_fee?: number;
807
807
  start_date?: number;
808
808
  coupon?: string;
809
- auto_collection?: AutoCollection;
809
+ auto_collection?: AutoCollectionEnum;
810
810
  invoice_notes?: string;
811
811
  contract_term_billing_cycle_on_renewal?: number;
812
812
  }
@@ -814,7 +814,7 @@ declare module 'chargebee' {
814
814
  /**
815
815
  * @deprecated Please refer API docs to use other attributes
816
816
  */
817
- gateway?: Gateway;
817
+ gateway?: GatewayEnum;
818
818
  gateway_account_id?: string;
819
819
  }
820
820
 
@@ -827,21 +827,21 @@ declare module 'chargebee' {
827
827
  billing_cycles?: number;
828
828
  trial_end?: number;
829
829
  service_period_days?: number;
830
- charge_on_event?: ChargeOnEvent;
830
+ charge_on_event?: ChargeOnEventEnum;
831
831
  charge_once?: boolean;
832
832
  /**
833
833
  * @deprecated Please refer API docs to use other attributes
834
834
  */
835
- item_type?: ItemType;
836
- charge_on_option?: ChargeOnOption;
835
+ item_type?: ItemTypeEnum;
836
+ charge_on_option?: ChargeOnOptionEnum;
837
837
  }
838
838
  export interface DiscountsCheckoutNewForItemsInputParam {
839
- apply_on: ApplyOn;
840
- duration_type: DurationType;
839
+ apply_on: ApplyOnEnum;
840
+ duration_type: DurationTypeEnum;
841
841
  percentage?: number;
842
842
  amount?: number;
843
843
  period?: number;
844
- period_unit?: PeriodUnit;
844
+ period_unit?: PeriodUnitEnum;
845
845
  included_in_mrr?: boolean;
846
846
  item_price_id?: string;
847
847
  }
@@ -849,7 +849,7 @@ declare module 'chargebee' {
849
849
  id?: string;
850
850
  scheme?: string;
851
851
  value?: string;
852
- operation?: Operation;
852
+ operation?: OperationEnum;
853
853
  standard?: string;
854
854
  }
855
855
  export interface ItemTiersCheckoutNewForItemsInputParam {
@@ -883,8 +883,8 @@ declare module 'chargebee' {
883
883
  * @deprecated Please refer API docs to use other attributes
884
884
  */
885
885
  coupon?: string;
886
- auto_collection?: AutoCollection;
887
- offline_payment_method?: OfflinePaymentMethod;
886
+ auto_collection?: AutoCollectionEnum;
887
+ offline_payment_method?: OfflinePaymentMethodEnum;
888
888
  invoice_notes?: string;
889
889
  contract_term_billing_cycle_on_renewal?: number;
890
890
  }
@@ -892,7 +892,7 @@ declare module 'chargebee' {
892
892
  /**
893
893
  * @deprecated Please refer API docs to use other attributes
894
894
  */
895
- gateway?: Gateway;
895
+ gateway?: GatewayEnum;
896
896
  gateway_account_id?: string;
897
897
  }
898
898
 
@@ -901,8 +901,8 @@ declare module 'chargebee' {
901
901
  quantity?: number;
902
902
  unit_price?: number;
903
903
  service_period_in_days?: number;
904
- charge_on?: ChargeOn;
905
- on_event?: OnEvent;
904
+ charge_on?: ChargeOnEnum;
905
+ on_event?: OnEventEnum;
906
906
  charge_once?: boolean;
907
907
  quantity_in_decimal?: string;
908
908
  unit_price_in_decimal?: string;
@@ -938,8 +938,8 @@ declare module 'chargebee' {
938
938
  * @deprecated Please refer API docs to use other attributes
939
939
  */
940
940
  coupon?: string;
941
- auto_collection?: AutoCollection;
942
- offline_payment_method?: OfflinePaymentMethod;
941
+ auto_collection?: AutoCollectionEnum;
942
+ offline_payment_method?: OfflinePaymentMethodEnum;
943
943
  invoice_notes?: string;
944
944
  contract_term_billing_cycle_on_renewal?: number;
945
945
  }
@@ -947,7 +947,7 @@ declare module 'chargebee' {
947
947
  /**
948
948
  * @deprecated Please refer API docs to use other attributes
949
949
  */
950
- gateway?: Gateway;
950
+ gateway?: GatewayEnum;
951
951
  gateway_account_id?: string;
952
952
  }
953
953
 
@@ -960,31 +960,31 @@ declare module 'chargebee' {
960
960
  billing_cycles?: number;
961
961
  trial_end?: number;
962
962
  service_period_days?: number;
963
- charge_on_event?: ChargeOnEvent;
963
+ charge_on_event?: ChargeOnEventEnum;
964
964
  charge_once?: boolean;
965
- charge_on_option?: ChargeOnOption;
965
+ charge_on_option?: ChargeOnOptionEnum;
966
966
  /**
967
967
  * @deprecated Please refer API docs to use other attributes
968
968
  */
969
- item_type?: ItemType;
969
+ item_type?: ItemTypeEnum;
970
970
  }
971
971
  export interface DiscountsCheckoutExistingForItemsInputParam {
972
- apply_on: ApplyOn;
973
- duration_type: DurationType;
972
+ apply_on: ApplyOnEnum;
973
+ duration_type: DurationTypeEnum;
974
974
  percentage?: number;
975
975
  amount?: number;
976
976
  period?: number;
977
- period_unit?: PeriodUnit;
977
+ period_unit?: PeriodUnitEnum;
978
978
  included_in_mrr?: boolean;
979
979
  item_price_id?: string;
980
- operation_type: OperationType;
980
+ operation_type: OperationTypeEnum;
981
981
  id?: string;
982
982
  }
983
983
  export interface EntityIdentifiersCheckoutExistingForItemsInputParam {
984
984
  id?: string;
985
985
  scheme?: string;
986
986
  value?: string;
987
- operation?: Operation;
987
+ operation?: OperationEnum;
988
988
  standard?: string;
989
989
  }
990
990
  export interface ItemTiersCheckoutExistingForItemsInputParam {
@@ -1011,7 +1011,7 @@ declare module 'chargebee' {
1011
1011
  /**
1012
1012
  * @deprecated Please refer API docs to use other attributes
1013
1013
  */
1014
- gateway?: Gateway;
1014
+ gateway?: GatewayEnum;
1015
1015
  gateway_account_id?: string;
1016
1016
  }
1017
1017
 
@@ -1030,7 +1030,7 @@ declare module 'chargebee' {
1030
1030
  /**
1031
1031
  * @deprecated Please refer API docs to use other attributes
1032
1032
  */
1033
- gateway?: Gateway;
1033
+ gateway?: GatewayEnum;
1034
1034
  gateway_account_id?: string;
1035
1035
  }
1036
1036
 
@@ -1041,7 +1041,7 @@ declare module 'chargebee' {
1041
1041
  /**
1042
1042
  * @deprecated Please refer API docs to use other attributes
1043
1043
  */
1044
- gateway?: Gateway;
1044
+ gateway?: GatewayEnum;
1045
1045
  gateway_account_id?: string;
1046
1046
  }
1047
1047
 
@@ -1052,7 +1052,7 @@ declare module 'chargebee' {
1052
1052
  /**
1053
1053
  * @deprecated Please refer API docs to use other attributes
1054
1054
  */
1055
- gateway?: Gateway;
1055
+ gateway?: GatewayEnum;
1056
1056
  gateway_account_id?: string;
1057
1057
  }
1058
1058