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
@@ -116,6 +116,11 @@ const CreateGiftSubscriptionSchema = z.looseObject({
116
116
  plan_quantity: z.number().int().min(1).optional(),
117
117
  plan_quantity_in_decimal: z.string().max(33).optional(),
118
118
  });
119
+ const CreateGiftAddonsItemSchema = z.object({
120
+ id: z.string().max(100).optional(),
121
+ quantity: z.number().int().min(1).optional(),
122
+ quantity_in_decimal: z.string().max(33).optional(),
123
+ });
119
124
  const CreateGiftAddonsSchema = z.object({
120
125
  id: z.array(z.string().max(100).optional()).optional(),
121
126
  quantity: z.array(z.number().int().min(1).optional()).optional(),
@@ -132,7 +137,12 @@ const CreateGiftBodySchema = z.looseObject({
132
137
  payment_intent: CreateGiftPaymentIntentSchema.optional(),
133
138
  shipping_address: CreateGiftShippingAddressSchema.optional(),
134
139
  subscription: CreateGiftSubscriptionSchema.optional(),
135
- addons: CreateGiftAddonsSchema.optional(),
140
+ addons: z
141
+ .union([
142
+ z.array(CreateGiftAddonsItemSchema.optional()),
143
+ CreateGiftAddonsSchema,
144
+ ])
145
+ .optional(),
136
146
  });
137
147
  export { CreateGiftBodySchema };
138
148
  //Gift.createForItems
@@ -245,6 +255,13 @@ const CreateForItemsGiftShippingAddressSchema = z.object({
245
255
  .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
246
256
  .optional(),
247
257
  });
258
+ const CreateForItemsGiftSubscriptionItemsItemSchema = z.object({
259
+ item_price_id: z.string().max(100).optional(),
260
+ quantity: z.number().int().min(1).optional(),
261
+ quantity_in_decimal: z.string().max(33).optional(),
262
+ unit_price: z.number().int().min(0).optional(),
263
+ unit_price_in_decimal: z.string().max(39).optional(),
264
+ });
248
265
  const CreateForItemsGiftSubscriptionItemsSchema = z.object({
249
266
  item_price_id: z.array(z.string().max(100).optional()).optional(),
250
267
  quantity: z.array(z.number().int().min(1).optional()).optional(),
@@ -252,6 +269,15 @@ const CreateForItemsGiftSubscriptionItemsSchema = z.object({
252
269
  unit_price: z.array(z.number().int().min(0).optional()).optional(),
253
270
  unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
254
271
  });
272
+ const CreateForItemsGiftItemTiersItemSchema = z.object({
273
+ item_price_id: z.string().max(100).optional(),
274
+ starting_unit: z.number().int().min(1).optional(),
275
+ ending_unit: z.number().int().optional(),
276
+ price: z.number().int().min(0).optional(),
277
+ starting_unit_in_decimal: z.string().max(33).optional(),
278
+ ending_unit_in_decimal: z.string().max(33).optional(),
279
+ price_in_decimal: z.string().max(39).optional(),
280
+ });
255
281
  const CreateForItemsGiftItemTiersSchema = z.object({
256
282
  item_price_id: z.array(z.string().max(100).optional()).optional(),
257
283
  starting_unit: z.array(z.number().int().min(1).optional()).optional(),
@@ -272,8 +298,18 @@ const CreateForItemsGiftBodySchema = z.looseObject({
272
298
  gift_receiver: CreateForItemsGiftGiftReceiverSchema.optional(),
273
299
  payment_intent: CreateForItemsGiftPaymentIntentSchema.optional(),
274
300
  shipping_address: CreateForItemsGiftShippingAddressSchema.optional(),
275
- subscription_items: CreateForItemsGiftSubscriptionItemsSchema.optional(),
276
- item_tiers: CreateForItemsGiftItemTiersSchema.optional(),
301
+ subscription_items: z
302
+ .union([
303
+ z.array(CreateForItemsGiftSubscriptionItemsItemSchema.optional()),
304
+ CreateForItemsGiftSubscriptionItemsSchema,
305
+ ])
306
+ .optional(),
307
+ item_tiers: z
308
+ .union([
309
+ z.array(CreateForItemsGiftItemTiersItemSchema.optional()),
310
+ CreateForItemsGiftItemTiersSchema,
311
+ ])
312
+ .optional(),
277
313
  });
278
314
  export { CreateForItemsGiftBodySchema };
279
315
  //Gift.list
@@ -285,10 +321,20 @@ const ListGiftStatusSchema = z.object({
285
321
  .enum(['scheduled', 'unclaimed', 'claimed', 'cancelled', 'expired'])
286
322
  .optional(),
287
323
  in: z
288
- .enum(['scheduled', 'unclaimed', 'claimed', 'cancelled', 'expired'])
324
+ .union([
325
+ z.array(z
326
+ .enum(['scheduled', 'unclaimed', 'claimed', 'cancelled', 'expired'])
327
+ .optional()),
328
+ z.enum(['scheduled', 'unclaimed', 'claimed', 'cancelled', 'expired']),
329
+ ])
289
330
  .optional(),
290
331
  not_in: z
291
- .enum(['scheduled', 'unclaimed', 'claimed', 'cancelled', 'expired'])
332
+ .union([
333
+ z.array(z
334
+ .enum(['scheduled', 'unclaimed', 'claimed', 'cancelled', 'expired'])
335
+ .optional()),
336
+ z.enum(['scheduled', 'unclaimed', 'claimed', 'cancelled', 'expired']),
337
+ ])
292
338
  .optional(),
293
339
  });
294
340
  const ListGiftEmailSchema = z.object({
@@ -13,22 +13,55 @@ const ListGrantBlocksGrantBlockAccountTypeSchema = z.object({
13
13
  is: z.enum(['provisioned', 'overdraft']).optional(),
14
14
  });
15
15
  const ListGrantBlocksGrantBlockEffectiveFromSchema = z.object({
16
- after: z.string().regex(RegExp('^\\d{10}$')).optional(),
17
- before: z.string().regex(RegExp('^\\d{10}$')).optional(),
18
- on: z.string().regex(RegExp('^\\d{10}$')).optional(),
19
- between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
16
+ after: z
17
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
18
+ .optional(),
19
+ before: z
20
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
21
+ .optional(),
22
+ on: z
23
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
24
+ .optional(),
25
+ between: z
26
+ .union([
27
+ z.array(z.number().int().optional()).min(2).max(2),
28
+ z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')),
29
+ ])
30
+ .optional(),
20
31
  });
21
32
  const ListGrantBlocksGrantBlockExpiresAtSchema = z.object({
22
- after: z.string().regex(RegExp('^\\d{10}$')).optional(),
23
- before: z.string().regex(RegExp('^\\d{10}$')).optional(),
24
- on: z.string().regex(RegExp('^\\d{10}$')).optional(),
25
- between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
33
+ after: z
34
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
35
+ .optional(),
36
+ before: z
37
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
38
+ .optional(),
39
+ on: z
40
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
41
+ .optional(),
42
+ between: z
43
+ .union([
44
+ z.array(z.number().int().optional()).min(2).max(2),
45
+ z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')),
46
+ ])
47
+ .optional(),
26
48
  });
27
49
  const ListGrantBlocksGrantBlockCreatedAtSchema = z.object({
28
- after: z.string().regex(RegExp('^\\d{10}$')).optional(),
29
- before: z.string().regex(RegExp('^\\d{10}$')).optional(),
30
- on: z.string().regex(RegExp('^\\d{10}$')).optional(),
31
- between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
50
+ after: z
51
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
52
+ .optional(),
53
+ before: z
54
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
55
+ .optional(),
56
+ on: z
57
+ .union([z.number().int(), z.string().regex(RegExp('^\\d{10}$'))])
58
+ .optional(),
59
+ between: z
60
+ .union([
61
+ z.array(z.number().int().optional()).min(2).max(2),
62
+ z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')),
63
+ ])
64
+ .optional(),
32
65
  });
33
66
  const ListGrantBlocksGrantBlockSortBySchema = z.looseObject({
34
67
  asc: z.enum(['effective_from', 'expires_at', 'created_at']).optional(),