chargebee 3.0.0-beta.3 → 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 (52) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/cjs/environment.js +1 -1
  3. package/cjs/resources/api_endpoints.js +1 -0
  4. package/cjs/util.js +1 -1
  5. package/esm/environment.js +1 -1
  6. package/esm/resources/api_endpoints.js +1 -0
  7. package/esm/util.js +1 -1
  8. package/package.json +2 -2
  9. package/types/core.d.ts +93 -80
  10. package/types/index.d.ts +1 -0
  11. package/types/resources/Address.d.ts +2 -2
  12. package/types/resources/AdvanceInvoiceSchedule.d.ts +1 -1
  13. package/types/resources/AttachedItem.d.ts +4 -4
  14. package/types/resources/Card.d.ts +5 -3
  15. package/types/resources/Comment.d.ts +2 -2
  16. package/types/resources/Coupon.d.ts +10 -10
  17. package/types/resources/CreditNote.d.ts +7 -7
  18. package/types/resources/CreditNoteEstimate.d.ts +1 -1
  19. package/types/resources/Customer.d.ts +46 -46
  20. package/types/resources/Discount.d.ts +3 -3
  21. package/types/resources/Entitlement.d.ts +1 -1
  22. package/types/resources/EntitlementOverride.d.ts +1 -1
  23. package/types/resources/Estimate.d.ts +116 -100
  24. package/types/resources/Event.d.ts +3 -3
  25. package/types/resources/Export.d.ts +4 -4
  26. package/types/resources/Gift.d.ts +2 -2
  27. package/types/resources/HostedPage.d.ts +64 -64
  28. package/types/resources/Invoice.d.ts +44 -44
  29. package/types/resources/InvoiceEstimate.d.ts +1 -1
  30. package/types/resources/Item.d.ts +5 -5
  31. package/types/resources/ItemEntitlement.d.ts +2 -2
  32. package/types/resources/ItemFamily.d.ts +1 -1
  33. package/types/resources/ItemPrice.d.ts +11 -8
  34. package/types/resources/Order.d.ts +6 -6
  35. package/types/resources/PaymentScheduleEstimate.d.ts +25 -0
  36. package/types/resources/PaymentScheduleScheme.d.ts +1 -0
  37. package/types/resources/PaymentSource.d.ts +18 -14
  38. package/types/resources/PaymentVoucher.d.ts +9 -9
  39. package/types/resources/PricingPageSession.d.ts +27 -2
  40. package/types/resources/PromotionalCredit.d.ts +4 -4
  41. package/types/resources/Purchase.d.ts +6 -6
  42. package/types/resources/Quote.d.ts +84 -83
  43. package/types/resources/QuotedSubscription.d.ts +4 -1
  44. package/types/resources/Ramp.d.ts +6 -6
  45. package/types/resources/Subscription.d.ts +147 -142
  46. package/types/resources/SubscriptionEstimate.d.ts +2 -2
  47. package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -2
  48. package/types/resources/Token.d.ts +2 -2
  49. package/types/resources/Transaction.d.ts +3 -3
  50. package/types/resources/UnbilledCharge.d.ts +3 -3
  51. package/types/resources/Usage.d.ts +3 -3
  52. package/types/resources/VirtualBankAccount.d.ts +1 -1
@@ -24,7 +24,7 @@ declare module 'chargebee' {
24
24
  status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
25
25
  vat_number?: string;
26
26
  date?: number;
27
- price_type: PriceType;
27
+ price_type: PriceTypeEnum;
28
28
  currency_code: string;
29
29
  total?: number;
30
30
  amount_allocated?: number;
@@ -35,7 +35,7 @@ declare module 'chargebee' {
35
35
  generated_at?: number;
36
36
  resource_version?: number;
37
37
  updated_at?: number;
38
- channel?: Channel;
38
+ channel?: ChannelEnum;
39
39
  einvoice?: CreditNote.Einvoice;
40
40
  sub_total: number;
41
41
  sub_total_in_local_currency?: number;
@@ -373,7 +373,7 @@ declare module 'chargebee' {
373
373
  state?: string;
374
374
  country?: string;
375
375
  zip?: string;
376
- validation_status?: ValidationStatus;
376
+ validation_status?: ValidationStatusEnum;
377
377
  index: number;
378
378
  }
379
379
  export interface BillingAddress {
@@ -390,7 +390,7 @@ declare module 'chargebee' {
390
390
  state?: string;
391
391
  country?: string;
392
392
  zip?: string;
393
- validation_status?: ValidationStatus;
393
+ validation_status?: ValidationStatusEnum;
394
394
  }
395
395
  export interface SiteDetailsAtCreation {
396
396
  timezone?: string;
@@ -423,7 +423,7 @@ declare module 'chargebee' {
423
423
  line_items?: LineItemsCreateInputParam[];
424
424
  }
425
425
  export interface PdfInputParam {
426
- disposition_type?: DispositionType;
426
+ disposition_type?: DispositionTypeEnum;
427
427
  }
428
428
  export interface RefundInputParam {
429
429
  refund_amount?: number;
@@ -516,7 +516,7 @@ declare module 'chargebee' {
516
516
  }
517
517
  export interface TransactionRecordRefundInputParam {
518
518
  amount?: number;
519
- payment_method: PaymentMethod;
519
+ payment_method: PaymentMethodEnum;
520
520
  reference_number?: string;
521
521
  custom_payment_method_id?: string;
522
522
  date: number;
@@ -548,7 +548,7 @@ declare module 'chargebee' {
548
548
  }
549
549
  export interface LinkedRefundsImportCreditNoteInputParam {
550
550
  amount: number;
551
- payment_method: PaymentMethod;
551
+ payment_method: PaymentMethodEnum;
552
552
  date: number;
553
553
  reference_number?: string;
554
554
  }
@@ -5,7 +5,7 @@ declare module 'chargebee' {
5
5
  export interface CreditNoteEstimate {
6
6
  reference_invoice_id: string;
7
7
  type: 'adjustment' | 'refundable';
8
- price_type: PriceType;
8
+ price_type: PriceTypeEnum;
9
9
  currency_code: string;
10
10
  sub_total: number;
11
11
  total: number;
@@ -11,8 +11,8 @@ declare module 'chargebee' {
11
11
  phone?: string;
12
12
  company?: string;
13
13
  vat_number?: string;
14
- auto_collection: AutoCollection;
15
- offline_payment_method?: OfflinePaymentMethod;
14
+ auto_collection: AutoCollectionEnum;
15
+ offline_payment_method?: OfflinePaymentMethodEnum;
16
16
  net_term_days: number;
17
17
  vat_number_validated_time?: number;
18
18
  vat_number_status?: 'valid' | 'invalid' | 'not_validated' | 'undetermined';
@@ -21,15 +21,15 @@ declare module 'chargebee' {
21
21
  created_at: number;
22
22
  created_from_ip?: string;
23
23
  exemption_details?: any;
24
- taxability?: Taxability;
25
- entity_code?: EntityCode;
24
+ taxability?: TaxabilityEnum;
25
+ entity_code?: EntityCodeEnum;
26
26
  exempt_number?: string;
27
27
  resource_version?: number;
28
28
  updated_at?: number;
29
29
  locale?: string;
30
30
  billing_date?: number;
31
31
  billing_month?: number;
32
- billing_date_mode?: BillingDateMode;
32
+ billing_date_mode?: BillingDateModeEnum;
33
33
  billing_day_of_week?:
34
34
  | 'sunday'
35
35
  | 'monday'
@@ -38,10 +38,10 @@ declare module 'chargebee' {
38
38
  | 'thursday'
39
39
  | 'friday'
40
40
  | 'saturday';
41
- billing_day_of_week_mode?: BillingDayOfWeekMode;
41
+ billing_day_of_week_mode?: BillingDayOfWeekModeEnum;
42
42
  pii_cleared?: 'active' | 'scheduled_for_clear' | 'cleared';
43
43
  auto_close_invoices?: boolean;
44
- channel?: Channel;
44
+ channel?: ChannelEnum;
45
45
  active_id?: string;
46
46
  card_status?:
47
47
  | 'no_card'
@@ -68,12 +68,12 @@ declare module 'chargebee' {
68
68
  entity_identifiers?: Customer.EntityIdentifier[];
69
69
  tax_providers_fields?: Customer.TaxProvidersField[];
70
70
  is_einvoice_enabled?: boolean;
71
- einvoicing_method?: EinvoicingMethod;
71
+ einvoicing_method?: EinvoicingMethodEnum;
72
72
  meta_data?: any;
73
73
  deleted: boolean;
74
74
  registered_for_gst?: boolean;
75
75
  consolidated_invoicing?: boolean;
76
- customer_type?: CustomerType;
76
+ customer_type?: CustomerTypeEnum;
77
77
  business_customer_without_vat_number?: boolean;
78
78
  client_profile_id?: string;
79
79
  relationship?: Customer.Relationship;
@@ -359,7 +359,7 @@ declare module 'chargebee' {
359
359
  state?: string;
360
360
  country?: string;
361
361
  zip?: string;
362
- validation_status?: ValidationStatus;
362
+ validation_status?: ValidationStatusEnum;
363
363
  }
364
364
  export interface ReferralUrl {
365
365
  external_customer_id?: string;
@@ -383,8 +383,8 @@ declare module 'chargebee' {
383
383
  send_billing_email: boolean;
384
384
  }
385
385
  export interface PaymentMethod {
386
- type: Type;
387
- gateway: Gateway;
386
+ type: TypeEnum;
387
+ gateway: GatewayEnum;
388
388
  gateway_account_id?: string;
389
389
  status:
390
390
  | 'valid'
@@ -443,7 +443,7 @@ declare module 'chargebee' {
443
443
  preferred_currency_code?: string;
444
444
  phone?: string;
445
445
  company?: string;
446
- auto_collection?: AutoCollection;
446
+ auto_collection?: AutoCollectionEnum;
447
447
  net_term_days?: number;
448
448
  allow_direct_debit?: boolean;
449
449
  vat_number?: string;
@@ -452,18 +452,18 @@ declare module 'chargebee' {
452
452
  entity_identifier_standard?: string;
453
453
  registered_for_gst?: boolean;
454
454
  is_einvoice_enabled?: boolean;
455
- einvoicing_method?: EinvoicingMethod;
456
- taxability?: Taxability;
455
+ einvoicing_method?: EinvoicingMethodEnum;
456
+ taxability?: TaxabilityEnum;
457
457
  exemption_details?: any;
458
- customer_type?: CustomerType;
458
+ customer_type?: CustomerTypeEnum;
459
459
  client_profile_id?: string;
460
- taxjar_exemption_category?: TaxjarExemptionCategory;
460
+ taxjar_exemption_category?: TaxjarExemptionCategoryEnum;
461
461
  business_customer_without_vat_number?: boolean;
462
462
  locale?: string;
463
- entity_code?: EntityCode;
463
+ entity_code?: EntityCodeEnum;
464
464
  exempt_number?: string;
465
465
  meta_data?: any;
466
- offline_payment_method?: OfflinePaymentMethod;
466
+ offline_payment_method?: OfflinePaymentMethodEnum;
467
467
  auto_close_invoices?: boolean;
468
468
  consolidated_invoicing?: boolean;
469
469
  token_id?: string;
@@ -512,18 +512,18 @@ declare module 'chargebee' {
512
512
  preferred_currency_code?: string;
513
513
  phone?: string;
514
514
  company?: string;
515
- auto_collection?: AutoCollection;
515
+ auto_collection?: AutoCollectionEnum;
516
516
  allow_direct_debit?: boolean;
517
517
  net_term_days?: number;
518
- taxability?: Taxability;
518
+ taxability?: TaxabilityEnum;
519
519
  exemption_details?: any;
520
- customer_type?: CustomerType;
520
+ customer_type?: CustomerTypeEnum;
521
521
  client_profile_id?: string;
522
- taxjar_exemption_category?: TaxjarExemptionCategory;
522
+ taxjar_exemption_category?: TaxjarExemptionCategoryEnum;
523
523
  locale?: string;
524
- entity_code?: EntityCode;
524
+ entity_code?: EntityCodeEnum;
525
525
  exempt_number?: string;
526
- offline_payment_method?: OfflinePaymentMethod;
526
+ offline_payment_method?: OfflinePaymentMethodEnum;
527
527
  invoice_notes?: string;
528
528
  auto_close_invoices?: boolean;
529
529
  meta_data?: any;
@@ -543,7 +543,7 @@ declare module 'chargebee' {
543
543
  registered_for_gst?: boolean;
544
544
  business_customer_without_vat_number?: boolean;
545
545
  is_einvoice_enabled?: boolean;
546
- einvoicing_method?: EinvoicingMethod;
546
+ einvoicing_method?: EinvoicingMethodEnum;
547
547
  billing_address?: BillingAddressUpdateBillingInfoInputParam;
548
548
  entity_identifiers?: EntityIdentifiersUpdateBillingInfoInputParam[];
549
549
  tax_providers_fields?: TaxProvidersFieldsUpdateBillingInfoInputParam[];
@@ -554,7 +554,7 @@ declare module 'chargebee' {
554
554
  }
555
555
  export interface AssignPaymentRoleInputParam {
556
556
  payment_source_id: string;
557
- role: Role;
557
+ role: RoleEnum;
558
558
  }
559
559
  export interface AddContactInputParam {
560
560
  contact?: ContactAddContactInputParam;
@@ -569,21 +569,21 @@ declare module 'chargebee' {
569
569
  amount: number;
570
570
  currency_code?: string;
571
571
  description: string;
572
- credit_type?: CreditType;
572
+ credit_type?: CreditTypeEnum;
573
573
  reference?: string;
574
574
  }
575
575
  export interface DeductPromotionalCreditsInputParam {
576
576
  amount: number;
577
577
  currency_code?: string;
578
578
  description: string;
579
- credit_type?: CreditType;
579
+ credit_type?: CreditTypeEnum;
580
580
  reference?: string;
581
581
  }
582
582
  export interface SetPromotionalCreditsInputParam {
583
583
  amount: number;
584
584
  currency_code?: string;
585
585
  description: string;
586
- credit_type?: CreditType;
586
+ credit_type?: CreditTypeEnum;
587
587
  reference?: string;
588
588
  }
589
589
  export interface RecordExcessPaymentInputParam {
@@ -596,7 +596,7 @@ declare module 'chargebee' {
596
596
  token_id?: string;
597
597
  replace_primary_payment_source?: boolean;
598
598
  retain_payment_source?: boolean;
599
- payment_initiator?: PaymentInitiator;
599
+ payment_initiator?: PaymentInitiatorEnum;
600
600
  payment_method?: PaymentMethodCollectPaymentInputParam;
601
601
  card?: CardCollectPaymentInputParam;
602
602
  payment_intent?: PaymentIntentCollectPaymentInputParam;
@@ -613,7 +613,7 @@ declare module 'chargebee' {
613
613
  export interface ChangeBillingDateInputParam {
614
614
  billing_date?: number;
615
615
  billing_month?: number;
616
- billing_date_mode?: BillingDateMode;
616
+ billing_date_mode?: BillingDateModeEnum;
617
617
  billing_day_of_week?:
618
618
  | 'sunday'
619
619
  | 'monday'
@@ -622,7 +622,7 @@ declare module 'chargebee' {
622
622
  | 'thursday'
623
623
  | 'friday'
624
624
  | 'saturday';
625
- billing_day_of_week_mode?: BillingDayOfWeekMode;
625
+ billing_day_of_week_mode?: BillingDayOfWeekModeEnum;
626
626
  }
627
627
  export interface MergeInputParam {
628
628
  from_customer_id: string;
@@ -662,14 +662,14 @@ declare module 'chargebee' {
662
662
  state?: string;
663
663
  zip?: string;
664
664
  country?: string;
665
- validation_status?: ValidationStatus;
665
+ validation_status?: ValidationStatusEnum;
666
666
  }
667
667
  export interface PaymentMethodCreateInputParam {
668
- type?: Type;
668
+ type?: TypeEnum;
669
669
  /**
670
670
  * @deprecated Please refer API docs to use other attributes
671
671
  */
672
- gateway?: Gateway;
672
+ gateway?: GatewayEnum;
673
673
  gateway_account_id?: string;
674
674
  reference_id?: string;
675
675
  tmp_token?: string;
@@ -688,9 +688,9 @@ declare module 'chargebee' {
688
688
  account_number?: string;
689
689
  routing_number?: string;
690
690
  bank_code?: string;
691
- account_type?: AccountType;
692
- account_holder_type?: AccountHolderType;
693
- echeck_type?: EcheckType;
691
+ account_type?: AccountTypeEnum;
692
+ account_holder_type?: AccountHolderTypeEnum;
693
+ echeck_type?: EcheckTypeEnum;
694
694
  issuing_country?: string;
695
695
  swedish_identity_number?: string;
696
696
  billing_address?: any;
@@ -731,7 +731,7 @@ declare module 'chargebee' {
731
731
  /**
732
732
  * @deprecated Please refer API docs to use other attributes
733
733
  */
734
- gateway?: Gateway;
734
+ gateway?: GatewayEnum;
735
735
  gateway_account_id?: string;
736
736
  /**
737
737
  * @deprecated Please refer API docs to use other attributes
@@ -780,11 +780,11 @@ declare module 'chargebee' {
780
780
  field_value?: string;
781
781
  }
782
782
  export interface PaymentMethodUpdatePaymentMethodInputParam {
783
- type: Type;
783
+ type: TypeEnum;
784
784
  /**
785
785
  * @deprecated Please refer API docs to use other attributes
786
786
  */
787
- gateway?: Gateway;
787
+ gateway?: GatewayEnum;
788
788
  gateway_account_id?: string;
789
789
  reference_id?: string;
790
790
  tmp_token?: string;
@@ -806,14 +806,14 @@ declare module 'chargebee' {
806
806
  state?: string;
807
807
  zip?: string;
808
808
  country?: string;
809
- validation_status?: ValidationStatus;
809
+ validation_status?: ValidationStatusEnum;
810
810
  }
811
811
 
812
812
  export interface EntityIdentifiersUpdateBillingInfoInputParam {
813
813
  id?: string;
814
814
  scheme?: string;
815
815
  value?: string;
816
- operation?: Operation;
816
+ operation?: OperationEnum;
817
817
  standard?: string;
818
818
  }
819
819
  export interface TaxProvidersFieldsUpdateBillingInfoInputParam {
@@ -853,13 +853,13 @@ declare module 'chargebee' {
853
853
  amount: number;
854
854
  currency_code?: string;
855
855
  date: number;
856
- payment_method: PaymentMethod;
856
+ payment_method: PaymentMethodEnum;
857
857
  reference_number?: string;
858
858
  custom_payment_method_id?: string;
859
859
  }
860
860
 
861
861
  export interface PaymentMethodCollectPaymentInputParam {
862
- type?: Type;
862
+ type?: TypeEnum;
863
863
  gateway_account_id?: string;
864
864
  reference_id?: string;
865
865
  tmp_token?: string;
@@ -9,11 +9,11 @@ declare module 'chargebee' {
9
9
  percentage?: number;
10
10
  amount?: number;
11
11
  currency_code?: string;
12
- duration_type: DurationType;
12
+ duration_type: DurationTypeEnum;
13
13
  period?: number;
14
- period_unit?: PeriodUnit;
14
+ period_unit?: PeriodUnitEnum;
15
15
  included_in_mrr: boolean;
16
- apply_on: ApplyOn;
16
+ apply_on: ApplyOnEnum;
17
17
  item_price_id?: string;
18
18
  created_at: number;
19
19
  apply_till?: number;
@@ -53,7 +53,7 @@ declare module 'chargebee' {
53
53
  embed?: string;
54
54
  }
55
55
  export interface CreateInputParam {
56
- action: Action;
56
+ action: ActionEnum;
57
57
  entitlements?: EntitlementsCreateInputParam[];
58
58
  }
59
59
  export interface EntitlementsCreateInputParam {
@@ -47,7 +47,7 @@ declare module 'chargebee' {
47
47
  //---------------
48
48
 
49
49
  export interface AddEntitlementOverrideForSubscriptionInputParam {
50
- action?: Action;
50
+ action?: ActionEnum;
51
51
  entitlement_overrides?: EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam[];
52
52
  }
53
53
  export interface ListEntitlementOverrideForSubscriptionInputParam {