chargebee 3.34.0 → 3.36.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 (198) hide show
  1. package/CHANGELOG.md +237 -0
  2. package/cjs/environment.js +1 -1
  3. package/cjs/resources/api_endpoints.js +230 -2
  4. package/cjs/resources/webhook/eventType.js +25 -1
  5. package/cjs/schema/addon.schema.js +221 -40
  6. package/cjs/schema/alert.schema.js +17 -2
  7. package/cjs/schema/alert_status.schema.js +6 -1
  8. package/cjs/schema/attached_item.schema.js +101 -26
  9. package/cjs/schema/business_entity.schema.js +43 -6
  10. package/cjs/schema/business_rule.schema.js +2 -2
  11. package/cjs/schema/business_ruleset.schema.js +2 -2
  12. package/cjs/schema/collections_payment_promise.schema.js +43 -0
  13. package/cjs/schema/comment.schema.js +17 -4
  14. package/cjs/schema/coupon.schema.js +218 -37
  15. package/cjs/schema/coupon_code.schema.js +36 -6
  16. package/cjs/schema/coupon_set.schema.js +108 -27
  17. package/cjs/schema/credit_note.schema.js +497 -105
  18. package/cjs/schema/credit_unit.schema.js +12 -2
  19. package/cjs/schema/customer.schema.js +212 -62
  20. package/cjs/schema/differential_price.schema.js +100 -12
  21. package/cjs/schema/dispute.schema.js +125 -33
  22. package/cjs/schema/einvoice.schema.js +27 -6
  23. package/cjs/schema/email_log.schema.js +15 -4
  24. package/cjs/schema/entitlement.schema.js +35 -6
  25. package/cjs/schema/entitlement_override.schema.js +17 -1
  26. package/cjs/schema/estimate.schema.js +585 -40
  27. package/cjs/schema/event.schema.js +1334 -585
  28. package/cjs/schema/export.schema.js +4459 -1412
  29. package/cjs/schema/feature.schema.js +73 -11
  30. package/cjs/schema/gateway_request_log.schema.js +309 -0
  31. package/cjs/schema/gateway_webhook_log.schema.js +257 -0
  32. package/cjs/schema/gift.schema.js +51 -5
  33. package/cjs/schema/grant_block.schema.js +45 -12
  34. package/cjs/schema/hosted_page.schema.js +564 -68
  35. package/cjs/schema/index.js +6 -0
  36. package/cjs/schema/invoice.schema.js +843 -123
  37. package/cjs/schema/item.schema.js +151 -28
  38. package/cjs/schema/item_entitlement.schema.js +23 -2
  39. package/cjs/schema/item_family.schema.js +29 -8
  40. package/cjs/schema/item_price.schema.js +263 -48
  41. package/cjs/schema/ledger_account_balance.schema.js +11 -2
  42. package/cjs/schema/ledger_operation.schema.js +44 -17
  43. package/cjs/schema/metered_feature.schema.js +10 -1
  44. package/cjs/schema/omnichannel_one_time_order.schema.js +42 -4
  45. package/cjs/schema/omnichannel_subscription.schema.js +146 -32
  46. package/cjs/schema/order.schema.js +233 -61
  47. package/cjs/schema/organization_detail.schema.js +36 -0
  48. package/cjs/schema/payment_schedule.schema.js +39 -8
  49. package/cjs/schema/payment_schedule_scheme.schema.js +37 -7
  50. package/cjs/schema/payment_source.schema.js +375 -148
  51. package/cjs/schema/payment_voucher.schema.js +33 -5
  52. package/cjs/schema/plan.schema.js +345 -57
  53. package/cjs/schema/price_ramp.schema.js +153 -0
  54. package/cjs/schema/price_variant.schema.js +88 -18
  55. package/cjs/schema/pricing_page_session.schema.js +36 -2
  56. package/cjs/schema/promotional_credit.schema.js +27 -6
  57. package/cjs/schema/purchase.schema.js +210 -12
  58. package/cjs/schema/quote.schema.js +907 -87
  59. package/cjs/schema/quote_entitlement.schema.js +6 -2
  60. package/cjs/schema/ramp.schema.js +242 -24
  61. package/cjs/schema/retry_segment.schema.js +12 -0
  62. package/cjs/schema/site_migration_detail.schema.js +50 -16
  63. package/cjs/schema/subscription.schema.js +1002 -173
  64. package/cjs/schema/subscription_entitlement.schema.js +9 -1
  65. package/cjs/schema/transaction.schema.js +780 -342
  66. package/cjs/schema/unbilled_charge.schema.js +141 -13
  67. package/cjs/schema/usage.schema.js +59 -11
  68. package/cjs/schema/usage_event.schema.js +13 -1
  69. package/cjs/schema/usage_summary.schema.js +1 -0
  70. package/cjs/schema/virtual_bank_account.schema.js +42 -10
  71. package/cjs/schema/webhook_endpoint.schema.js +50 -2
  72. package/esm/environment.js +1 -1
  73. package/esm/resources/api_endpoints.js +230 -2
  74. package/esm/resources/webhook/eventType.js +25 -1
  75. package/esm/schema/addon.schema.js +221 -40
  76. package/esm/schema/alert.schema.js +17 -2
  77. package/esm/schema/alert_status.schema.js +6 -1
  78. package/esm/schema/attached_item.schema.js +101 -26
  79. package/esm/schema/business_entity.schema.js +42 -5
  80. package/esm/schema/business_rule.schema.js +2 -2
  81. package/esm/schema/business_ruleset.schema.js +2 -2
  82. package/esm/schema/collections_payment_promise.schema.js +40 -0
  83. package/esm/schema/comment.schema.js +17 -4
  84. package/esm/schema/coupon.schema.js +218 -37
  85. package/esm/schema/coupon_code.schema.js +36 -6
  86. package/esm/schema/coupon_set.schema.js +108 -27
  87. package/esm/schema/credit_note.schema.js +497 -105
  88. package/esm/schema/credit_unit.schema.js +12 -2
  89. package/esm/schema/customer.schema.js +212 -62
  90. package/esm/schema/differential_price.schema.js +100 -12
  91. package/esm/schema/dispute.schema.js +125 -33
  92. package/esm/schema/einvoice.schema.js +27 -6
  93. package/esm/schema/email_log.schema.js +15 -4
  94. package/esm/schema/entitlement.schema.js +35 -6
  95. package/esm/schema/entitlement_override.schema.js +17 -1
  96. package/esm/schema/estimate.schema.js +585 -40
  97. package/esm/schema/event.schema.js +1334 -585
  98. package/esm/schema/export.schema.js +4459 -1412
  99. package/esm/schema/feature.schema.js +73 -11
  100. package/esm/schema/gateway_request_log.schema.js +306 -0
  101. package/esm/schema/gateway_webhook_log.schema.js +254 -0
  102. package/esm/schema/gift.schema.js +51 -5
  103. package/esm/schema/grant_block.schema.js +45 -12
  104. package/esm/schema/hosted_page.schema.js +564 -68
  105. package/esm/schema/index.js +6 -0
  106. package/esm/schema/invoice.schema.js +842 -122
  107. package/esm/schema/item.schema.js +151 -28
  108. package/esm/schema/item_entitlement.schema.js +23 -2
  109. package/esm/schema/item_family.schema.js +29 -8
  110. package/esm/schema/item_price.schema.js +263 -48
  111. package/esm/schema/ledger_account_balance.schema.js +10 -1
  112. package/esm/schema/ledger_operation.schema.js +44 -17
  113. package/esm/schema/metered_feature.schema.js +10 -1
  114. package/esm/schema/omnichannel_one_time_order.schema.js +42 -4
  115. package/esm/schema/omnichannel_subscription.schema.js +146 -32
  116. package/esm/schema/order.schema.js +233 -61
  117. package/esm/schema/organization_detail.schema.js +33 -0
  118. package/esm/schema/payment_schedule.schema.js +39 -8
  119. package/esm/schema/payment_schedule_scheme.schema.js +37 -7
  120. package/esm/schema/payment_source.schema.js +375 -148
  121. package/esm/schema/payment_voucher.schema.js +33 -5
  122. package/esm/schema/plan.schema.js +345 -57
  123. package/esm/schema/price_ramp.schema.js +150 -0
  124. package/esm/schema/price_variant.schema.js +88 -18
  125. package/esm/schema/pricing_page_session.schema.js +36 -2
  126. package/esm/schema/promotional_credit.schema.js +27 -6
  127. package/esm/schema/purchase.schema.js +210 -12
  128. package/esm/schema/quote.schema.js +907 -87
  129. package/esm/schema/quote_entitlement.schema.js +6 -2
  130. package/esm/schema/ramp.schema.js +242 -24
  131. package/esm/schema/retry_segment.schema.js +9 -0
  132. package/esm/schema/site_migration_detail.schema.js +50 -16
  133. package/esm/schema/subscription.schema.js +1002 -173
  134. package/esm/schema/subscription_entitlement.schema.js +9 -1
  135. package/esm/schema/transaction.schema.js +780 -342
  136. package/esm/schema/unbilled_charge.schema.js +141 -13
  137. package/esm/schema/usage.schema.js +59 -11
  138. package/esm/schema/usage_event.schema.js +13 -1
  139. package/esm/schema/usage_summary.schema.js +1 -0
  140. package/esm/schema/virtual_bank_account.schema.js +42 -10
  141. package/esm/schema/webhook_endpoint.schema.js +50 -2
  142. package/package.json +1 -1
  143. package/types/core.d.ts +63 -74
  144. package/types/index.d.ts +29 -1
  145. package/types/resources/BillingLineItem.d.ts +10 -0
  146. package/types/resources/BillingMetadata.d.ts +9 -0
  147. package/types/resources/BusinessEntity.d.ts +52 -0
  148. package/types/resources/Citation.d.ts +13 -0
  149. package/types/resources/CollectionsDispute.d.ts +24 -0
  150. package/types/resources/CollectionsPaymentPromise.d.ts +93 -0
  151. package/types/resources/CollectionsReminderSequence.d.ts +35 -0
  152. package/types/resources/Comment.d.ts +2 -1
  153. package/types/resources/Content.d.ts +23 -1
  154. package/types/resources/CreditNote.d.ts +1 -0
  155. package/types/resources/CustomData.d.ts +14 -0
  156. package/types/resources/Discount.d.ts +1 -0
  157. package/types/resources/DraftEstimate.d.ts +13 -0
  158. package/types/resources/DraftRequest.d.ts +45 -0
  159. package/types/resources/EmailAttachment.d.ts +16 -0
  160. package/types/resources/EmailConversation.d.ts +18 -0
  161. package/types/resources/EmailLog.d.ts +1 -0
  162. package/types/resources/EmailMessage.d.ts +40 -0
  163. package/types/resources/Estimate.d.ts +3 -0
  164. package/types/resources/Event.d.ts +25 -1
  165. package/types/resources/Execution.d.ts +12 -0
  166. package/types/resources/GatewayPaymentMethodToken.d.ts +2 -2
  167. package/types/resources/GatewayRequestLog.d.ts +82 -0
  168. package/types/resources/GatewayWebhookLog.d.ts +74 -0
  169. package/types/resources/GrantBlock.d.ts +5 -0
  170. package/types/resources/GroupByAttribute.d.ts +15 -0
  171. package/types/resources/GroupByRecommendation.d.ts +10 -0
  172. package/types/resources/HostedPage.d.ts +18 -0
  173. package/types/resources/Invoice.d.ts +19 -0
  174. package/types/resources/ItemPrice.d.ts +1 -0
  175. package/types/resources/LedgerAccountBalance.d.ts +19 -0
  176. package/types/resources/Meter.d.ts +1 -0
  177. package/types/resources/MeteredFeature.d.ts +1 -0
  178. package/types/resources/OmnichannelOneTimeOrder.d.ts +5 -1
  179. package/types/resources/OmnichannelSubscription.d.ts +6 -1
  180. package/types/resources/OmnichannelSubscriptionItem.d.ts +4 -1
  181. package/types/resources/OrganizationDetail.d.ts +84 -0
  182. package/types/resources/PaymentSchedule.d.ts +1 -1
  183. package/types/resources/PaymentScheduleEstimate.d.ts +1 -1
  184. package/types/resources/PaymentSource.d.ts +19 -0
  185. package/types/resources/PreferenceVariant.d.ts +10 -0
  186. package/types/resources/PriceRamp.d.ts +113 -0
  187. package/types/resources/PrivateNote.d.ts +18 -0
  188. package/types/resources/Purchase.d.ts +6 -0
  189. package/types/resources/Ramp.d.ts +6 -0
  190. package/types/resources/RampInterval.d.ts +12 -0
  191. package/types/resources/RecordedPurchase.d.ts +5 -1
  192. package/types/resources/RetrySegment.d.ts +36 -0
  193. package/types/resources/Subscription.d.ts +3 -0
  194. package/types/resources/Transaction.d.ts +4 -0
  195. package/types/resources/Usage.d.ts +7 -0
  196. package/types/resources/UsageSummary.d.ts +2 -0
  197. package/types/resources/WebhookEvent.d.ts +159 -5
  198. package/types/resources/AppliedBusinessRule.d.ts +0 -15
package/types/core.d.ts CHANGED
@@ -132,12 +132,12 @@ declare module 'chargebee' {
132
132
  | 'plan_price'
133
133
  | 'addon_price'
134
134
  | 'charge_price'
135
+ | 'addon'
135
136
  | 'invoice'
136
137
  | 'quote'
137
138
  | 'credit_note'
138
139
  | 'transaction'
139
140
  | 'plan'
140
- | 'addon'
141
141
  | 'order'
142
142
  | 'item_family'
143
143
  | 'item'
@@ -165,7 +165,8 @@ declare module 'chargebee' {
165
165
  | 'business_ruleset'
166
166
  | 'alert_status'
167
167
  | 'omnichannel_subscription_item_metric'
168
- | 'price_ramp';
168
+ | 'price_ramp'
169
+ | 'task';
169
170
  type EventNameEnum = 'cancellation_page_loaded';
170
171
  type EventTypeEnum =
171
172
  | 'coupon_created'
@@ -232,6 +233,7 @@ declare module 'chargebee' {
232
233
  | 'payment_schedules_updated'
233
234
  | 'payment_schedule_scheme_created'
234
235
  | 'payment_schedule_scheme_deleted'
236
+ | 'payment_schedules_cancelled'
235
237
  | 'subscription_renewal_reminder'
236
238
  | 'add_usages_reminder'
237
239
  | 'payment_due_reminder'
@@ -242,6 +244,7 @@ declare module 'chargebee' {
242
244
  | 'payment_failed'
243
245
  | 'dunning_updated'
244
246
  | 'payment_refunded'
247
+ | 'refund_failed'
245
248
  | 'payment_initiated'
246
249
  | 'refund_initiated'
247
250
  | 'authorization_succeeded'
@@ -331,6 +334,8 @@ declare module 'chargebee' {
331
334
  | 'customer_business_entity_changed'
332
335
  | 'subscription_business_entity_changed'
333
336
  | 'payment_source_business_entity_changed'
337
+ | 'organization_details_created'
338
+ | 'organization_details_updated'
334
339
  | 'purchase_created'
335
340
  | 'voucher_created'
336
341
  | 'voucher_expired'
@@ -384,6 +389,9 @@ declare module 'chargebee' {
384
389
  | 'alert_status_changed'
385
390
  | 'omnichannel_subscription_item_updated'
386
391
  | 'omnichannel_subscription_item_recovered'
392
+ | 'price_ramp_created'
393
+ | 'price_ramp_updated'
394
+ | 'price_ramp_deleted'
387
395
  | 'omnichannel_subscription_item_mrr_updated'
388
396
  | 'ledger_account_balance_updated'
389
397
  | 'grant_blocks_created'
@@ -398,12 +406,29 @@ declare module 'chargebee' {
398
406
  | 'vault_token_created'
399
407
  | 'vault_token_updated'
400
408
  | 'vault_token_deleted'
401
- | 'business_rules_applied'
409
+ | 'chargeback_initiated'
410
+ | 'chargeback_won'
411
+ | 'chargeback_lost'
402
412
  | 'business_ruleset_created'
403
413
  | 'business_ruleset_updated'
404
414
  | 'business_ruleset_activated'
405
415
  | 'business_ruleset_deactivated'
406
416
  | 'business_ruleset_deleted'
417
+ | 'collections_reminder_sequence_created'
418
+ | 'collections_reminder_sequence_paused'
419
+ | 'collections_reminder_sequence_resumed'
420
+ | 'collections_reminder_sequence_completed'
421
+ | 'collections_payment_promise_created'
422
+ | 'collections_payment_promise_updated'
423
+ | 'collections_payment_promise_fulfilled'
424
+ | 'collections_payment_promise_cancelled'
425
+ | 'collections_payment_promise_broken'
426
+ | 'collections_dispute_created'
427
+ | 'collections_dispute_updated'
428
+ | 'collections_dispute_resolved'
429
+ | 'collections_dispute_withdrawn'
430
+ | 'email_message_received'
431
+ | 'private_note_added'
407
432
  | 'plan_created'
408
433
  | 'plan_updated'
409
434
  | 'plan_deleted'
@@ -477,69 +502,6 @@ declare module 'chargebee' {
477
502
  | 'payu'
478
503
  | 'gocardless'
479
504
  | 'not_applicable';
480
- type GatewayNameEnum =
481
- | 'chargebee'
482
- | 'chargebee_payments'
483
- | 'adyen'
484
- | 'stripe'
485
- | 'wepay'
486
- | 'braintree'
487
- | 'authorize_net'
488
- | 'paypal_pro'
489
- | 'pin'
490
- | 'eway'
491
- | 'eway_rapid'
492
- | 'worldpay'
493
- | 'balanced_payments'
494
- | 'beanstream'
495
- | 'bluepay'
496
- | 'elavon'
497
- | 'first_data_global'
498
- | 'hdfc'
499
- | 'migs'
500
- | 'nmi'
501
- | 'ogone'
502
- | 'paymill'
503
- | 'paypal_payflow_pro'
504
- | 'sage_pay'
505
- | 'tco'
506
- | 'wirecard'
507
- | 'amazon_payments'
508
- | 'paypal_express_checkout'
509
- | 'gocardless'
510
- | 'orbital'
511
- | 'moneris_us'
512
- | 'moneris'
513
- | 'bluesnap'
514
- | 'cybersource'
515
- | 'vantiv'
516
- | 'checkout_com'
517
- | 'paypal'
518
- | 'ingenico_direct'
519
- | 'exact'
520
- | 'mollie'
521
- | 'quickbooks'
522
- | 'razorpay'
523
- | 'global_payments'
524
- | 'bank_of_america'
525
- | 'ecentric'
526
- | 'metrics_global'
527
- | 'windcave'
528
- | 'pay_com'
529
- | 'ebanx'
530
- | 'dlocal'
531
- | 'nuvei'
532
- | 'solidgate'
533
- | 'paystack'
534
- | 'jp_morgan'
535
- | 'deutsche_bank'
536
- | 'ezidebit'
537
- | 'twikey'
538
- | 'tempus'
539
- | 'moyasar'
540
- | 'payway'
541
- | 'payu'
542
- | 'not_applicable';
543
505
  type HierarchyOperationTypeEnum =
544
506
  | 'complete_hierarchy'
545
507
  | 'subordinates'
@@ -587,12 +549,6 @@ declare module 'chargebee' {
587
549
  | 'bank_transfer'
588
550
  | 'other'
589
551
  | 'custom'
590
- | 'tamara'
591
- | 'qpay'
592
- | 'blik'
593
- | 'fpx'
594
- | 'wero'
595
- | 'p24'
596
552
  | 'chargeback'
597
553
  | 'card'
598
554
  | 'amazon_payments'
@@ -648,6 +604,8 @@ declare module 'chargebee' {
648
604
  | 'promptpay'
649
605
  | 'dana'
650
606
  | 'touch_n_go'
607
+ | 'tamara'
608
+ | 'qpay'
651
609
  | 'ovo'
652
610
  | 'momo'
653
611
  | 'mercado_pago'
@@ -655,6 +613,10 @@ declare module 'chargebee' {
655
613
  | 'nupay'
656
614
  | 'picpay'
657
615
  | 'thai_qr'
616
+ | 'blik'
617
+ | 'fpx'
618
+ | 'wero'
619
+ | 'p24'
658
620
  | 'affirm_pay'
659
621
  | 'rakuten_pay';
660
622
  type PaymentMethodSavePolicyEnum = 'always' | 'ask' | 'never';
@@ -764,7 +726,10 @@ declare module 'chargebee' {
764
726
  | 'none'
765
727
  | 'js_api'
766
728
  | 'migration'
767
- | 'external_service';
729
+ | 'external_service'
730
+ | 'mcp'
731
+ | 'copilot'
732
+ | 'agent';
768
733
  type StatusEnum =
769
734
  | 'scheduled'
770
735
  | 'rescheduled'
@@ -977,6 +942,7 @@ declare module 'chargebee' {
977
942
  | 'payment_schedules_updated'
978
943
  | 'payment_schedule_scheme_created'
979
944
  | 'payment_schedule_scheme_deleted'
945
+ | 'payment_schedules_cancelled'
980
946
  | 'subscription_renewal_reminder'
981
947
  | 'add_usages_reminder'
982
948
  | 'payment_due_reminder'
@@ -987,6 +953,7 @@ declare module 'chargebee' {
987
953
  | 'payment_failed'
988
954
  | 'dunning_updated'
989
955
  | 'payment_refunded'
956
+ | 'refund_failed'
990
957
  | 'payment_initiated'
991
958
  | 'refund_initiated'
992
959
  | 'authorization_succeeded'
@@ -1076,6 +1043,8 @@ declare module 'chargebee' {
1076
1043
  | 'customer_business_entity_changed'
1077
1044
  | 'subscription_business_entity_changed'
1078
1045
  | 'payment_source_business_entity_changed'
1046
+ | 'organization_details_created'
1047
+ | 'organization_details_updated'
1079
1048
  | 'purchase_created'
1080
1049
  | 'voucher_created'
1081
1050
  | 'voucher_expired'
@@ -1129,6 +1098,9 @@ declare module 'chargebee' {
1129
1098
  | 'alert_status_changed'
1130
1099
  | 'omnichannel_subscription_item_updated'
1131
1100
  | 'omnichannel_subscription_item_recovered'
1101
+ | 'price_ramp_created'
1102
+ | 'price_ramp_updated'
1103
+ | 'price_ramp_deleted'
1132
1104
  | 'omnichannel_subscription_item_mrr_updated'
1133
1105
  | 'ledger_account_balance_updated'
1134
1106
  | 'grant_blocks_created'
@@ -1143,12 +1115,29 @@ declare module 'chargebee' {
1143
1115
  | 'vault_token_created'
1144
1116
  | 'vault_token_updated'
1145
1117
  | 'vault_token_deleted'
1146
- | 'business_rules_applied'
1118
+ | 'chargeback_initiated'
1119
+ | 'chargeback_won'
1120
+ | 'chargeback_lost'
1147
1121
  | 'business_ruleset_created'
1148
1122
  | 'business_ruleset_updated'
1149
1123
  | 'business_ruleset_activated'
1150
1124
  | 'business_ruleset_deactivated'
1151
1125
  | 'business_ruleset_deleted'
1126
+ | 'collections_reminder_sequence_created'
1127
+ | 'collections_reminder_sequence_paused'
1128
+ | 'collections_reminder_sequence_resumed'
1129
+ | 'collections_reminder_sequence_completed'
1130
+ | 'collections_payment_promise_created'
1131
+ | 'collections_payment_promise_updated'
1132
+ | 'collections_payment_promise_fulfilled'
1133
+ | 'collections_payment_promise_cancelled'
1134
+ | 'collections_payment_promise_broken'
1135
+ | 'collections_dispute_created'
1136
+ | 'collections_dispute_updated'
1137
+ | 'collections_dispute_resolved'
1138
+ | 'collections_dispute_withdrawn'
1139
+ | 'email_message_received'
1140
+ | 'private_note_added'
1152
1141
  | 'plan_created'
1153
1142
  | 'plan_updated'
1154
1143
  | 'plan_deleted'
package/types/index.d.ts CHANGED
@@ -3,7 +3,6 @@
3
3
  ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
4
4
  ///<reference path='./resources/Alert.d.ts' />
5
5
  ///<reference path='./resources/AlertStatus.d.ts' />
6
- ///<reference path='./resources/AppliedBusinessRule.d.ts' />
7
6
  ///<reference path='./resources/AppliedRule.d.ts' />
8
7
  ///<reference path='./resources/ApplyRule.d.ts' />
9
8
  ///<reference path='./resources/AsyncResponse.d.ts' />
@@ -11,6 +10,8 @@
11
10
  ///<reference path='./resources/AttachedItem.d.ts' />
12
11
  ///<reference path='./resources/Attribute.d.ts' />
13
12
  ///<reference path='./resources/BillingConfiguration.d.ts' />
13
+ ///<reference path='./resources/BillingLineItem.d.ts' />
14
+ ///<reference path='./resources/BillingMetadata.d.ts' />
14
15
  ///<reference path='./resources/Brand.d.ts' />
15
16
  ///<reference path='./resources/BusinessEntity.d.ts' />
16
17
  ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
@@ -18,6 +19,10 @@
18
19
  ///<reference path='./resources/BusinessRuleset.d.ts' />
19
20
  ///<reference path='./resources/BusinessRulesetRule.d.ts' />
20
21
  ///<reference path='./resources/Card.d.ts' />
22
+ ///<reference path='./resources/Citation.d.ts' />
23
+ ///<reference path='./resources/CollectionsDispute.d.ts' />
24
+ ///<reference path='./resources/CollectionsPaymentPromise.d.ts' />
25
+ ///<reference path='./resources/CollectionsReminderSequence.d.ts' />
21
26
  ///<reference path='./resources/ColumnDefinition.d.ts' />
22
27
  ///<reference path='./resources/Comment.d.ts' />
23
28
  ///<reference path='./resources/Configuration.d.ts' />
@@ -31,6 +36,7 @@
31
36
  ///<reference path='./resources/CreditNoteEstimate.d.ts' />
32
37
  ///<reference path='./resources/CreditUnit.d.ts' />
33
38
  ///<reference path='./resources/Currency.d.ts' />
39
+ ///<reference path='./resources/CustomData.d.ts' />
34
40
  ///<reference path='./resources/CustomDataSchema.d.ts' />
35
41
  ///<reference path='./resources/Customer.d.ts' />
36
42
  ///<reference path='./resources/CustomerEntitlement.d.ts' />
@@ -38,19 +44,29 @@
38
44
  ///<reference path='./resources/Discount.d.ts' />
39
45
  ///<reference path='./resources/Dispute.d.ts' />
40
46
  ///<reference path='./resources/Download.d.ts' />
47
+ ///<reference path='./resources/DraftEstimate.d.ts' />
48
+ ///<reference path='./resources/DraftRequest.d.ts' />
41
49
  ///<reference path='./resources/Einvoice.d.ts' />
50
+ ///<reference path='./resources/EmailAttachment.d.ts' />
51
+ ///<reference path='./resources/EmailConversation.d.ts' />
42
52
  ///<reference path='./resources/EmailLog.d.ts' />
53
+ ///<reference path='./resources/EmailMessage.d.ts' />
43
54
  ///<reference path='./resources/Entitlement.d.ts' />
44
55
  ///<reference path='./resources/EntitlementOverride.d.ts' />
45
56
  ///<reference path='./resources/Estimate.d.ts' />
46
57
  ///<reference path='./resources/Event.d.ts' />
58
+ ///<reference path='./resources/Execution.d.ts' />
47
59
  ///<reference path='./resources/Export.d.ts' />
48
60
  ///<reference path='./resources/Feature.d.ts' />
49
61
  ///<reference path='./resources/FilterCondition.d.ts' />
50
62
  ///<reference path='./resources/GatewayErrorDetail.d.ts' />
51
63
  ///<reference path='./resources/GatewayPaymentMethodToken.d.ts' />
64
+ ///<reference path='./resources/GatewayRequestLog.d.ts' />
65
+ ///<reference path='./resources/GatewayWebhookLog.d.ts' />
52
66
  ///<reference path='./resources/Gift.d.ts' />
53
67
  ///<reference path='./resources/GrantBlock.d.ts' />
68
+ ///<reference path='./resources/GroupByAttribute.d.ts' />
69
+ ///<reference path='./resources/GroupByRecommendation.d.ts' />
54
70
  ///<reference path='./resources/Hierarchy.d.ts' />
55
71
  ///<reference path='./resources/HostedPage.d.ts' />
56
72
  ///<reference path='./resources/ImpactedCustomer.d.ts' />
@@ -82,6 +98,7 @@
82
98
  ///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
83
99
  ///<reference path='./resources/OmnichannelTransaction.d.ts' />
84
100
  ///<reference path='./resources/Order.d.ts' />
101
+ ///<reference path='./resources/OrganizationDetail.d.ts' />
85
102
  ///<reference path='./resources/PaymentIntent.d.ts' />
86
103
  ///<reference path='./resources/PaymentReferenceNumber.d.ts' />
87
104
  ///<reference path='./resources/PaymentSchedule.d.ts' />
@@ -92,8 +109,11 @@
92
109
  ///<reference path='./resources/PersonalizedOffer.d.ts' />
93
110
  ///<reference path='./resources/Plan.d.ts' />
94
111
  ///<reference path='./resources/PortalSession.d.ts' />
112
+ ///<reference path='./resources/PreferenceVariant.d.ts' />
113
+ ///<reference path='./resources/PriceRamp.d.ts' />
95
114
  ///<reference path='./resources/PriceVariant.d.ts' />
96
115
  ///<reference path='./resources/PricingPageSession.d.ts' />
116
+ ///<reference path='./resources/PrivateNote.d.ts' />
97
117
  ///<reference path='./resources/PromotionalCredit.d.ts' />
98
118
  ///<reference path='./resources/PromotionalGrant.d.ts' />
99
119
  ///<reference path='./resources/Purchase.d.ts' />
@@ -105,8 +125,10 @@
105
125
  ///<reference path='./resources/QuotedRamp.d.ts' />
106
126
  ///<reference path='./resources/QuotedSubscription.d.ts' />
107
127
  ///<reference path='./resources/Ramp.d.ts' />
128
+ ///<reference path='./resources/RampInterval.d.ts' />
108
129
  ///<reference path='./resources/RecordedPurchase.d.ts' />
109
130
  ///<reference path='./resources/ResourceMigration.d.ts' />
131
+ ///<reference path='./resources/RetrySegment.d.ts' />
110
132
  ///<reference path='./resources/Rule.d.ts' />
111
133
  ///<reference path='./resources/SiteMigrationDetail.d.ts' />
112
134
  ///<reference path='./resources/Subscription.d.ts' />
@@ -296,6 +318,7 @@ declare module 'chargebee' {
296
318
  businessRule: BusinessRule.BusinessRuleResource;
297
319
  businessRuleset: BusinessRuleset.BusinessRulesetResource;
298
320
  card: Card.CardResource;
321
+ collectionsPaymentPromise: CollectionsPaymentPromise.CollectionsPaymentPromiseResource;
299
322
  comment: Comment.CommentResource;
300
323
  configuration: Configuration.ConfigurationResource;
301
324
  coupon: Coupon.CouponResource;
@@ -316,6 +339,8 @@ declare module 'chargebee' {
316
339
  event: Event.EventResource;
317
340
  export: Export.ExportResource;
318
341
  feature: Feature.FeatureResource;
342
+ gatewayRequestLog: GatewayRequestLog.GatewayRequestLogResource;
343
+ gatewayWebhookLog: GatewayWebhookLog.GatewayWebhookLogResource;
319
344
  gift: Gift.GiftResource;
320
345
  grantBlock: GrantBlock.GrantBlockResource;
321
346
  hostedPage: HostedPage.HostedPageResource;
@@ -336,6 +361,7 @@ declare module 'chargebee' {
336
361
  omnichannelSubscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
337
362
  omnichannelSubscriptionItem: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
338
363
  order: Order.OrderResource;
364
+ organizationDetail: OrganizationDetail.OrganizationDetailResource;
339
365
  paymentIntent: PaymentIntent.PaymentIntentResource;
340
366
  paymentSchedule: PaymentSchedule.PaymentScheduleResource;
341
367
  paymentScheduleScheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
@@ -344,6 +370,7 @@ declare module 'chargebee' {
344
370
  personalizedOffer: PersonalizedOffer.PersonalizedOfferResource;
345
371
  plan: Plan.PlanResource;
346
372
  portalSession: PortalSession.PortalSessionResource;
373
+ priceRamp: PriceRamp.PriceRampResource;
347
374
  priceVariant: PriceVariant.PriceVariantResource;
348
375
  pricingPageSession: PricingPageSession.PricingPageSessionResource;
349
376
  promotionalCredit: PromotionalCredit.PromotionalCreditResource;
@@ -354,6 +381,7 @@ declare module 'chargebee' {
354
381
  ramp: Ramp.RampResource;
355
382
  recordedPurchase: RecordedPurchase.RecordedPurchaseResource;
356
383
  resourceMigration: ResourceMigration.ResourceMigrationResource;
384
+ retrySegment: RetrySegment.RetrySegmentResource;
357
385
  rule: Rule.RuleResource;
358
386
  siteMigrationDetail: SiteMigrationDetail.SiteMigrationDetailResource;
359
387
  subscription: Subscription.SubscriptionResource;
@@ -0,0 +1,10 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface BillingLineItem {
6
+ id?: string;
7
+ invoice_number?: string;
8
+ quantity?: number;
9
+ }
10
+ }
@@ -0,0 +1,9 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface BillingMetadata {
6
+ item_price_id?: string;
7
+ line_items?: BillingLineItem[];
8
+ }
9
+ }
@@ -14,6 +14,27 @@ declare module 'chargebee' {
14
14
 
15
15
  export namespace BusinessEntity {
16
16
  export class BusinessEntityResource {
17
+ create(
18
+ input: CreateInputParam,
19
+ headers?: ChargebeeRequestHeader,
20
+ ): Promise<ChargebeeResponse<CreateResponse>>;
21
+
22
+ list(
23
+ input?: ListInputParam,
24
+ headers?: ChargebeeRequestHeader,
25
+ ): Promise<ChargebeeResponse<ListResponse>>;
26
+
27
+ retrieve(
28
+ business_entity_id: string,
29
+ headers?: ChargebeeRequestHeader,
30
+ ): Promise<ChargebeeResponse<RetrieveResponse>>;
31
+
32
+ update(
33
+ business_entity_id: string,
34
+ input?: UpdateInputParam,
35
+ headers?: ChargebeeRequestHeader,
36
+ ): Promise<ChargebeeResponse<UpdateResponse>>;
37
+
17
38
  createTransfers(
18
39
  input: CreateTransfersInputParam,
19
40
  headers?: ChargebeeRequestHeader,
@@ -25,6 +46,23 @@ declare module 'chargebee' {
25
46
  ): Promise<ChargebeeResponse<GetTransfersResponse>>;
26
47
  }
27
48
 
49
+ export interface CreateResponse {
50
+ business_entity: BusinessEntity;
51
+ }
52
+
53
+ export interface ListResponse {
54
+ list: { business_entity: BusinessEntity }[];
55
+ next_offset?: string;
56
+ }
57
+
58
+ export interface RetrieveResponse {
59
+ business_entity: BusinessEntity;
60
+ }
61
+
62
+ export interface UpdateResponse {
63
+ business_entity: BusinessEntity;
64
+ }
65
+
28
66
  export interface CreateTransfersResponse {
29
67
  business_entity_transfer: BusinessEntityTransfer;
30
68
  }
@@ -37,6 +75,20 @@ declare module 'chargebee' {
37
75
  // REQUEST PARAMS
38
76
  //---------------
39
77
 
78
+ export interface CreateInputParam {
79
+ name: string;
80
+ status: 'active' | 'inactive';
81
+ }
82
+ export interface ListInputParam {
83
+ limit?: number;
84
+ offset?: string;
85
+ include_deleted?: boolean;
86
+ name?: filter.String;
87
+ }
88
+ export interface UpdateInputParam {
89
+ name?: string;
90
+ status?: 'active' | 'inactive';
91
+ }
40
92
  export interface CreateTransfersInputParam {
41
93
  active_resource_ids: string[];
42
94
  destination_business_entity_ids: string[] /**
@@ -0,0 +1,13 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface Citation {
6
+ id: string;
7
+ param_name?: string;
8
+ author_name: string;
9
+ confidence_level?: 'low' | 'medium' | 'high' | 'not_provided';
10
+ created_at: number;
11
+ content: any;
12
+ }
13
+ }
@@ -0,0 +1,24 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface CollectionsDispute {
6
+ id: string;
7
+ customer_id: string;
8
+ invoice_id: string;
9
+ line_item_id?: string;
10
+ currency_code: string;
11
+ billed_amount: number;
12
+ claimed_deduction: number;
13
+ status: 'open' | 'resolved' | 'withdrawn';
14
+ dispute_reason_code: string;
15
+ resolved_reason_code?: string;
16
+ reason?: string;
17
+ opened_at: number;
18
+ resolved_at?: number;
19
+ created_at: number;
20
+ updated_at: number;
21
+ resource_version?: number;
22
+ undisputed_amount?: number;
23
+ }
24
+ }
@@ -0,0 +1,93 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ ///<reference path='./filter.d.ts'/>
4
+ declare module 'chargebee' {
5
+ export interface CollectionsPaymentPromise {
6
+ id: string;
7
+ customer_id: string;
8
+ invoice_id: string;
9
+ status: 'active' | 'fulfilled' | 'broken' | 'cancelled';
10
+ reason?: string;
11
+ promised_by?: string;
12
+ promised_on: number;
13
+ created_at: number;
14
+ updated_at: number;
15
+ resource_version?: number;
16
+ }
17
+
18
+ export namespace CollectionsPaymentPromise {
19
+ export class CollectionsPaymentPromiseResource {
20
+ retrieve(
21
+ collections_payment_promise_id: string,
22
+ headers?: ChargebeeRequestHeader,
23
+ ): Promise<ChargebeeResponse<RetrieveResponse>>;
24
+
25
+ listCollectionsPaymentPromises(
26
+ input?: ListCollectionsPaymentPromisesInputParam,
27
+ headers?: ChargebeeRequestHeader,
28
+ ): Promise<ChargebeeResponse<ListCollectionsPaymentPromisesResponse>>;
29
+
30
+ createCollectionsPaymentPromise(
31
+ input: CreateCollectionsPaymentPromiseInputParam,
32
+ headers?: ChargebeeRequestHeader,
33
+ ): Promise<ChargebeeResponse<CreateCollectionsPaymentPromiseResponse>>;
34
+
35
+ updateCollectionsPaymentPromise(
36
+ collections_payment_promise_id: string,
37
+ input?: UpdateCollectionsPaymentPromiseInputParam,
38
+ headers?: ChargebeeRequestHeader,
39
+ ): Promise<ChargebeeResponse<UpdateCollectionsPaymentPromiseResponse>>;
40
+
41
+ cancel(
42
+ collections_payment_promise_id: string,
43
+ headers?: ChargebeeRequestHeader,
44
+ ): Promise<ChargebeeResponse<CancelResponse>>;
45
+ }
46
+
47
+ export interface RetrieveResponse {
48
+ collections_payment_promise: CollectionsPaymentPromise;
49
+ }
50
+
51
+ export interface ListCollectionsPaymentPromisesResponse {
52
+ list: { collections_payment_promise: CollectionsPaymentPromise }[];
53
+ next_offset?: string;
54
+ }
55
+
56
+ export interface CreateCollectionsPaymentPromiseResponse {
57
+ collections_payment_promises: CollectionsPaymentPromise[];
58
+ }
59
+
60
+ export interface UpdateCollectionsPaymentPromiseResponse {
61
+ collections_payment_promise: CollectionsPaymentPromise;
62
+ }
63
+
64
+ export interface CancelResponse {
65
+ collections_payment_promise: CollectionsPaymentPromise;
66
+ }
67
+
68
+ // REQUEST PARAMS
69
+ //---------------
70
+
71
+ export interface ListCollectionsPaymentPromisesInputParam {
72
+ limit?: number;
73
+ offset?: string;
74
+ customer_id?: filter.String;
75
+ invoice_id?: filter.String;
76
+ status?: filter.Enum;
77
+ }
78
+ export interface CreateCollectionsPaymentPromiseInputParam {
79
+ customer_id: string;
80
+ invoice_id?: string;
81
+ amount: number;
82
+ currency_code?: string;
83
+ promised_on: number;
84
+ reason?: string;
85
+ promised_by?: string;
86
+ }
87
+ export interface UpdateCollectionsPaymentPromiseInputParam {
88
+ promised_on?: number;
89
+ reason?: string;
90
+ promised_by?: string;
91
+ }
92
+ }
93
+ }
@@ -0,0 +1,35 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface CollectionsReminderSequence {
6
+ id: string;
7
+ invoice_id: string;
8
+ customer_id: string;
9
+ status: 'active' | 'completed' | 'paused' | 'failed';
10
+ paused_until?: number;
11
+ pause_note?: string;
12
+ started_at?: number;
13
+ completed_at?: number;
14
+ created_at: number;
15
+ updated_at: number;
16
+ resource_version?: number;
17
+ action_logs?: CollectionsReminderSequence.ActionLog[];
18
+ }
19
+
20
+ export namespace CollectionsReminderSequence {
21
+ export interface ActionLog {
22
+ action_type: 'send_email';
23
+ status: 'completed' | 'scheduled' | 'skipped';
24
+ reason_code?:
25
+ | 'date_already_passed'
26
+ | 'before_invoice_date'
27
+ | 'trigger_event_not_received'
28
+ | 'sequence_paused';
29
+ executed_at?: number;
30
+ scheduled_at?: number;
31
+ }
32
+ // REQUEST PARAMS
33
+ //---------------
34
+ }
35
+ }
@@ -80,7 +80,8 @@ declare module 'chargebee' {
80
80
  | 'item_family'
81
81
  | 'item'
82
82
  | 'item_price'
83
- | 'price_variant';
83
+ | 'price_variant'
84
+ | 'task';
84
85
  entity_id?: string;
85
86
  created_at?: filter.Timestamp;
86
87
  'sort_by[asc]'?: string;