chargebee 2.52.0 → 2.53.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.
Files changed (59) hide show
  1. package/CHANGELOG.md +56 -0
  2. package/lib/chargebee.js +1 -1
  3. package/lib/resources/api_endpoints.js +90 -5
  4. package/package.json +1 -1
  5. package/types/core.d.ts +2 -2
  6. package/types/index.d.ts +8 -0
  7. package/types/resources/Addon.d.ts +3 -3
  8. package/types/resources/AttachedItem.d.ts +1 -1
  9. package/types/resources/BusinessEntity.d.ts +2 -2
  10. package/types/resources/Comment.d.ts +5 -3
  11. package/types/resources/Coupon.d.ts +4 -4
  12. package/types/resources/CouponCode.d.ts +1 -1
  13. package/types/resources/CouponSet.d.ts +1 -1
  14. package/types/resources/CreditNote.d.ts +89 -89
  15. package/types/resources/Customer.d.ts +7 -7
  16. package/types/resources/CustomerEntitlement.d.ts +3 -1
  17. package/types/resources/DifferentialPrice.d.ts +1 -1
  18. package/types/resources/Discount.d.ts +3 -1
  19. package/types/resources/Entitlement.d.ts +1 -1
  20. package/types/resources/EntitlementOverride.d.ts +1 -1
  21. package/types/resources/Estimate.d.ts +4 -4
  22. package/types/resources/Event.d.ts +3 -3
  23. package/types/resources/Feature.d.ts +3 -3
  24. package/types/resources/Gift.d.ts +1 -1
  25. package/types/resources/HostedPage.d.ts +4 -4
  26. package/types/resources/ImpactedCustomer.d.ts +23 -0
  27. package/types/resources/Invoice.d.ts +110 -110
  28. package/types/resources/Item.d.ts +4 -4
  29. package/types/resources/ItemEntitlement.d.ts +2 -2
  30. package/types/resources/ItemFamily.d.ts +3 -3
  31. package/types/resources/ItemPrice.d.ts +7 -7
  32. package/types/resources/OmnichannelOneTimeOrder.d.ts +90 -0
  33. package/types/resources/OmnichannelOneTimeOrderItem.d.ts +24 -0
  34. package/types/resources/OmnichannelSubscription.d.ts +2 -2
  35. package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -1
  36. package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +1 -1
  37. package/types/resources/Order.d.ts +3 -3
  38. package/types/resources/PaymentSource.d.ts +2 -2
  39. package/types/resources/PaymentVoucher.d.ts +4 -4
  40. package/types/resources/Plan.d.ts +3 -3
  41. package/types/resources/PriceVariant.d.ts +2 -2
  42. package/types/resources/PricingPageSession.d.ts +2 -2
  43. package/types/resources/PromotionalCredit.d.ts +3 -1
  44. package/types/resources/Purchase.d.ts +2 -2
  45. package/types/resources/Quote.d.ts +13 -13
  46. package/types/resources/QuotedCharge.d.ts +7 -0
  47. package/types/resources/Ramp.d.ts +7 -7
  48. package/types/resources/RecordedPurchase.d.ts +6 -1
  49. package/types/resources/SiteMigrationDetail.d.ts +1 -1
  50. package/types/resources/Subscription.d.ts +22 -20
  51. package/types/resources/SubscriptionEntitlement.d.ts +1 -1
  52. package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
  53. package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
  54. package/types/resources/Transaction.d.ts +6 -6
  55. package/types/resources/UnbilledCharge.d.ts +1 -1
  56. package/types/resources/Usage.d.ts +2 -2
  57. package/types/resources/UsageFile.d.ts +5 -5
  58. package/types/resources/VirtualBankAccount.d.ts +1 -1
  59. package/types/resources/WebhookEndpoint.d.ts +117 -0
package/CHANGELOG.md CHANGED
@@ -1,3 +1,59 @@
1
+ ### v2.53.0 (2025-08-19)
2
+ * * *
3
+
4
+ ### New Resources:
5
+ * WebhookEndpoints has been added.
6
+ * OmnichannelOneTimeOrder has been added.
7
+ * OmnichannelOneTimeOrderItem has been added.
8
+
9
+ ### New Attributes:
10
+ * business_entity_id has been added to Comment.
11
+ * business_entity_id has been added to PromotionalCredit.
12
+ * quantity has been added to Discount.
13
+ * business_entity_id has been added to PromotionalCredit.
14
+ * coupon_applicability_mappings[] has been added to QuotedCharge.
15
+ * linked_omnichannel_one_time_orders[] has been added to RecordedPurchase.
16
+ * quantity has been added to Subscripiton#Discount.
17
+
18
+ ### New Input Parameters:
19
+ * transaction[id] has been added to Customer#RecordExcessPaymentRequest.
20
+ * discounts[quantity][] has been added to Estimate#CreateSubItemEstimateRequest.
21
+ * consolidate_entitlements has been added to CustomerEntitlement#EntitlementsForCustomer.
22
+ * discounts[quantity][] has been added to Estimate#CreateSubItemEstimateRequest.
23
+ * discounts[quantity][] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
24
+ * discounts[quantity][] has been added to Estimate#UpdateSubscriptionForItemsRequest.
25
+ * discounts[quantity][] has been added to Estimate#CreateInvoiceForItemsRequest.
26
+ * discounts[quantity][] has been added to HostedPage#CheckoutOneTimeForItemsRequest.
27
+ * discounts[quantity][] has been added to HostedPage#CheckoutNewForItemsRequest.
28
+ * discounts[quantity][] has been added to HostedPage#CheckoutExistingForItemsRequest.
29
+ * discounts[quantity][] has been added to PricingPageSession#CreateForNewSubscriptionRequest.
30
+ * discounts[quantity][] has been added to PricingPageSession#CreateForExistingSubscriptionRequest.
31
+ * discounts[quantity][] has been added to Purchase#CreateRequest.
32
+ * discounts[quantity][] has been added to Purchase#EstimateRequest.
33
+ * discounts[quantity][] has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
34
+ * discounts[quantity][] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
35
+ * discounts[quantity][] has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
36
+ * discounts[quantity][] has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
37
+ * discounts[quantity][] has been added to Quote#CreateForChargeItemsAndChargesRequest.
38
+ * discounts[quantity][] has been added to Quote#EditForChargeItemsAndChargesRequest.
39
+ * discounts[quantity][] has been added to Subscription#CreateWithItemsRequest.
40
+ * discounts[quantity][] has been added to Subscription#UpdateForItemsRequest.
41
+ * discounts[quantity][] has been added to Subscription#ImportForItemsRequest.
42
+ * google_play_store[product_id] has been added to RecordedPurchase#CreateRequest.
43
+ * google_play_store[order_id] has been added to RecordedPurchase#CreateRequest.
44
+
45
+ ### New Enums
46
+ * PAUSE has been added to OmnichannelSubscriptionItemScheduledChange#ChangeType.
47
+ * OFFER_QUANTITY has been added to Discount#Type.
48
+ * OFFER_QUANTITY has been added to Subscription#Discount#Type.
49
+ * OMNICHANNEL_ONE_TIME_ORDER has been added to EntityType.
50
+ * OMNICHANNEL_ONE_TIME_ORDER_ITEM has been added to EntityType.
51
+ * USAGE_FILE has been added to EntityType.
52
+ * OMNICHANNEL_ONE_TIME_ORDER_CREATED has been added to EventType.
53
+ * OMNICHANNEL_ONE_TIME_ORDER_ITEM_CANCELLED has been added to EventType.
54
+ * USAGE_FILE_INGESTED has been added to EventType.
55
+ * OMNICHANNEL_SUBSCRIPTION_ITEM_PAUSE_SCHEDULED has been added to EventType.
56
+
1
57
  ### v2.52.0 (2025-07-18)
2
58
  * * *
3
59
 
package/lib/chargebee.js CHANGED
@@ -11,7 +11,7 @@ ChargeBee._env = {
11
11
  hostSuffix: '.chargebee.com',
12
12
  apiPath: '/api/v2',
13
13
  timeout: 80000,
14
- clientVersion: 'v2.52.0',
14
+ clientVersion: 'v2.53.0',
15
15
  port: 443,
16
16
  timemachineWaitInMillis: 3000,
17
17
  exportWaitInMillis: 3000
@@ -4727,6 +4727,31 @@ var _endpoints = {
4727
4727
  }
4728
4728
  ]
4729
4729
  ],
4730
+ "omnichannel_one_time_order": [
4731
+ [
4732
+ "retrieve",
4733
+ "GET",
4734
+ "/omnichannel_one_time_orders",
4735
+ null,
4736
+ true,
4737
+ null,
4738
+ false,
4739
+ {
4740
+ }
4741
+ ],
4742
+ [
4743
+ "list",
4744
+ "GET",
4745
+ "/omnichannel_one_time_orders",
4746
+ null,
4747
+ false,
4748
+ null,
4749
+ false,
4750
+ {
4751
+ }
4752
+ ]
4753
+ ],
4754
+ "omnichannel_one_time_order_item": [],
4730
4755
  "rule": [
4731
4756
  [
4732
4757
  "retrieve",
@@ -4769,10 +4794,10 @@ var _endpoints = {
4769
4794
  "omnichannel_subscription_item_scheduled_change": [],
4770
4795
  "usage_file": [
4771
4796
  [
4772
- "upload",
4797
+ "upload_url",
4773
4798
  "POST",
4774
4799
  "/usage_files",
4775
- "/upload",
4800
+ "/upload_url",
4776
4801
  false,
4777
4802
  "file-ingest",
4778
4803
  false,
@@ -4780,10 +4805,10 @@ var _endpoints = {
4780
4805
  }
4781
4806
  ],
4782
4807
  [
4783
- "status",
4808
+ "processing_status",
4784
4809
  "GET",
4785
4810
  "/usage_files",
4786
- "/status",
4811
+ "/processing_status",
4787
4812
  true,
4788
4813
  "file-ingest",
4789
4814
  false,
@@ -4791,6 +4816,66 @@ var _endpoints = {
4791
4816
  }
4792
4817
  ]
4793
4818
  ],
4794
- "brand": []
4819
+ "brand": [],
4820
+ "webhook_endpoint": [
4821
+ [
4822
+ "create",
4823
+ "POST",
4824
+ "/webhook_endpoints",
4825
+ null,
4826
+ false,
4827
+ null,
4828
+ false,
4829
+ {
4830
+ }
4831
+ ],
4832
+ [
4833
+ "update",
4834
+ "POST",
4835
+ "/webhook_endpoints",
4836
+ null,
4837
+ true,
4838
+ null,
4839
+ false,
4840
+ {
4841
+ }
4842
+ ],
4843
+ [
4844
+ "retrieve",
4845
+ "GET",
4846
+ "/webhook_endpoints",
4847
+ null,
4848
+ true,
4849
+ null,
4850
+ false,
4851
+ {
4852
+ }
4853
+ ],
4854
+ [
4855
+ "delete",
4856
+ "POST",
4857
+ "/webhook_endpoints",
4858
+ "/delete",
4859
+ true,
4860
+ null,
4861
+ false,
4862
+ {
4863
+ }
4864
+ ],
4865
+ [
4866
+ "list",
4867
+ "GET",
4868
+ "/webhook_endpoints",
4869
+ null,
4870
+ false,
4871
+ null,
4872
+ false,
4873
+ {
4874
+ }
4875
+ ]
4876
+ ],
4877
+ "impacted_customer": [],
4878
+ "subscription_entitlements_updated_detail": [],
4879
+ "subscription_entitlements_created_detail": []
4795
4880
  };
4796
4881
  module.exports = _endpoints;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name":"chargebee",
3
- "version":"2.52.0",
3
+ "version":"2.53.0",
4
4
  "description":"A library for integrating with ChargeBee.",
5
5
  "keywords":[
6
6
  "payments",
package/types/core.d.ts CHANGED
@@ -45,9 +45,9 @@ declare module 'chargebee' {
45
45
  type EinvoicingMethod = 'automatic' | 'manual' | 'site_default'
46
46
  type EndScheduleOn = 'after_number_of_intervals' | 'specific_date' | 'subscription_end'
47
47
  type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
48
- type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase' | 'omnichannel_subscription_item_scheduled_change' | 'sales_order'
48
+ type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase' | 'omnichannel_subscription_item_scheduled_change' | 'sales_order' | 'omnichannel_one_time_order' | 'omnichannel_one_time_order_item' | 'usage_file'
49
49
  type EventName = 'cancellation_page_loaded'
50
- type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
50
+ type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
51
51
  type ExportType = 'data' | 'import_friendly_data'
52
52
  type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
53
53
  type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
package/types/index.d.ts CHANGED
@@ -33,6 +33,7 @@
33
33
  ///<reference path='./resources/Gift.d.ts' />
34
34
  ///<reference path='./resources/Hierarchy.d.ts' />
35
35
  ///<reference path='./resources/HostedPage.d.ts' />
36
+ ///<reference path='./resources/ImpactedCustomer.d.ts' />
36
37
  ///<reference path='./resources/ImpactedItem.d.ts' />
37
38
  ///<reference path='./resources/ImpactedItemPrice.d.ts' />
38
39
  ///<reference path='./resources/ImpactedSubscription.d.ts' />
@@ -45,6 +46,8 @@
45
46
  ///<reference path='./resources/ItemPrice.d.ts' />
46
47
  ///<reference path='./resources/Metadata.d.ts' />
47
48
  ///<reference path='./resources/NonSubscription.d.ts' />
49
+ ///<reference path='./resources/OmnichannelOneTimeOrder.d.ts' />
50
+ ///<reference path='./resources/OmnichannelOneTimeOrderItem.d.ts' />
48
51
  ///<reference path='./resources/OmnichannelSubscription.d.ts' />
49
52
  ///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
50
53
  ///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
@@ -75,6 +78,8 @@
75
78
  ///<reference path='./resources/SiteMigrationDetail.d.ts' />
76
79
  ///<reference path='./resources/Subscription.d.ts' />
77
80
  ///<reference path='./resources/SubscriptionEntitlement.d.ts' />
81
+ ///<reference path='./resources/SubscriptionEntitlementsCreatedDetail.d.ts' />
82
+ ///<reference path='./resources/SubscriptionEntitlementsUpdatedDetail.d.ts' />
78
83
  ///<reference path='./resources/SubscriptionEstimate.d.ts' />
79
84
  ///<reference path='./resources/TaxWithheld.d.ts' />
80
85
  ///<reference path='./resources/ThirdPartyPaymentMethod.d.ts' />
@@ -86,6 +91,7 @@
86
91
  ///<reference path='./resources/UsageEvent.d.ts' />
87
92
  ///<reference path='./resources/UsageFile.d.ts' />
88
93
  ///<reference path='./resources/VirtualBankAccount.d.ts' />
94
+ ///<reference path='./resources/WebhookEndpoint.d.ts' />
89
95
 
90
96
  declare module 'chargebee' {
91
97
  export default class {
@@ -120,6 +126,7 @@ declare module 'chargebee' {
120
126
  static item_family: ItemFamily.ItemFamilyResource;
121
127
  static item_price: ItemPrice.ItemPriceResource;
122
128
  static non_subscription: NonSubscription.NonSubscriptionResource;
129
+ static omnichannel_one_time_order: OmnichannelOneTimeOrder.OmnichannelOneTimeOrderResource;
123
130
  static omnichannel_subscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
124
131
  static omnichannel_subscription_item: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
125
132
  static order: Order.OrderResource;
@@ -148,6 +155,7 @@ declare module 'chargebee' {
148
155
  static usage_event: UsageEvent.UsageEventResource;
149
156
  static usage_file: UsageFile.UsageFileResource;
150
157
  static virtual_bank_account: VirtualBankAccount.VirtualBankAccountResource;
158
+ static webhook_endpoint: WebhookEndpoint.WebhookEndpointResource;
151
159
 
152
160
  }
153
161
  }
@@ -113,7 +113,7 @@ declare module 'chargebee' {
113
113
  addon:Addon;
114
114
  }
115
115
  export interface CreateInputParam {
116
- [key : string] : any;
116
+
117
117
  tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
118
118
 
119
119
  tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];
@@ -198,7 +198,7 @@ declare module 'chargebee' {
198
198
  addon:Addon;
199
199
  }
200
200
  export interface UpdateInputParam {
201
- [key : string] : any;
201
+
202
202
  tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
203
203
 
204
204
  tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];
@@ -290,7 +290,7 @@ declare module 'chargebee' {
290
290
  limit?:number;
291
291
 
292
292
  /**
293
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
293
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
294
294
 
295
295
  */
296
296
 
@@ -118,7 +118,7 @@ declare module 'chargebee' {
118
118
  limit?:number;
119
119
 
120
120
  /**
121
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
121
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
122
122
 
123
123
  */
124
124
 
@@ -55,7 +55,7 @@ declare module 'chargebee' {
55
55
  limit?:number;
56
56
 
57
57
  /**
58
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
58
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
59
59
 
60
60
  */
61
61
 
@@ -79,7 +79,7 @@ declare module 'chargebee' {
79
79
 
80
80
  created_at?:{after?:string,before?:string,between?:string,on?:string};
81
81
 
82
- sort_by?:{asc?:'created_at',desc?:'created_at'};
82
+ sort_by?:object;
83
83
  }
84
84
 
85
85
  }
@@ -18,6 +18,8 @@ declare module 'chargebee' {
18
18
 
19
19
  entity_id:string;
20
20
 
21
+ business_entity_id?:string;
22
+
21
23
  }
22
24
  export namespace Comment {
23
25
  export class CommentResource {
@@ -61,13 +63,13 @@ declare module 'chargebee' {
61
63
  limit?:number;
62
64
 
63
65
  /**
64
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
66
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
65
67
 
66
68
  */
67
69
 
68
70
  offset?:string;
69
71
 
70
- entity_type?:'customer' | 'subscription' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'coupon' | 'order' | 'business_entity' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase' | 'omnichannel_subscription_item_scheduled_change' | 'sales_order' | 'item_family' | 'item' | 'item_price' | 'price_variant';
72
+ entity_type?:'customer' | 'subscription' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'coupon' | 'order' | 'business_entity' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase' | 'omnichannel_subscription_item_scheduled_change' | 'sales_order' | 'omnichannel_one_time_order' | 'omnichannel_one_time_order_item' | 'usage_file' | 'item_family' | 'item' | 'item_price' | 'price_variant';
71
73
 
72
74
  entity_id?:string;
73
75
 
@@ -78,7 +80,7 @@ declare module 'chargebee' {
78
80
 
79
81
  created_at?:{after?:string,before?:string,between?:string,on?:string};
80
82
 
81
- sort_by?:{asc?:'created_at',desc?:'created_at'};
83
+ sort_by?:object;
82
84
  }
83
85
  export interface DeleteResponse {
84
86
  comment:Comment;
@@ -148,7 +148,7 @@ declare module 'chargebee' {
148
148
  coupon:Coupon;
149
149
  }
150
150
  export interface CreateForItemsInputParam {
151
- [key : string] : any;
151
+
152
152
  item_constraints:{constraint:'none' | 'all' | 'specific' | 'criteria',item_price_ids?:any[],item_type:'plan' | 'addon' | 'charge'}[];
153
153
 
154
154
  item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'plan' | 'addon' | 'charge'}[];
@@ -199,7 +199,7 @@ declare module 'chargebee' {
199
199
  coupon:Coupon;
200
200
  }
201
201
  export interface UpdateForItemsInputParam {
202
- [key : string] : any;
202
+
203
203
  item_constraints:{constraint:'none' | 'all' | 'specific' | 'criteria',item_price_ids?:any[],item_type:'plan' | 'addon' | 'charge'}[];
204
204
 
205
205
  item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'plan' | 'addon' | 'charge'}[];
@@ -257,7 +257,7 @@ declare module 'chargebee' {
257
257
  limit?:number;
258
258
 
259
259
  /**
260
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
260
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
261
261
 
262
262
  */
263
263
 
@@ -329,7 +329,7 @@ Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon
329
329
 
330
330
  updated_at?:{after?:string,before?:string,between?:string,on?:string};
331
331
 
332
- sort_by?:{asc?:'created_at',desc?:'created_at'};
332
+ sort_by?:object;
333
333
 
334
334
  /**
335
335
  * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
@@ -55,7 +55,7 @@ declare module 'chargebee' {
55
55
  limit?:number;
56
56
 
57
57
  /**
58
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
58
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
59
59
 
60
60
  */
61
61
 
@@ -70,7 +70,7 @@ declare module 'chargebee' {
70
70
  limit?:number;
71
71
 
72
72
  /**
73
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
73
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
74
74
 
75
75
  */
76
76