orb-billing 4.73.0 → 5.0.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 (141) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/README.md +18 -30
  3. package/index.d.mts +148 -14
  4. package/index.d.ts +148 -14
  5. package/index.d.ts.map +1 -1
  6. package/index.js +0 -3
  7. package/index.js.map +1 -1
  8. package/index.mjs +3 -6
  9. package/index.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/alerts.d.ts +20 -88
  12. package/resources/alerts.d.ts.map +1 -1
  13. package/resources/alerts.js.map +1 -1
  14. package/resources/alerts.mjs.map +1 -1
  15. package/resources/beta/beta.d.ts +9 -7313
  16. package/resources/beta/beta.d.ts.map +1 -1
  17. package/resources/beta/beta.js.map +1 -1
  18. package/resources/beta/beta.mjs.map +1 -1
  19. package/resources/beta/external-plan-id.d.ts +7 -7074
  20. package/resources/beta/external-plan-id.d.ts.map +1 -1
  21. package/resources/beta/external-plan-id.js.map +1 -1
  22. package/resources/beta/external-plan-id.mjs.map +1 -1
  23. package/resources/credit-notes.d.ts +9 -163
  24. package/resources/credit-notes.d.ts.map +1 -1
  25. package/resources/credit-notes.js +3 -6
  26. package/resources/credit-notes.js.map +1 -1
  27. package/resources/credit-notes.mjs +2 -4
  28. package/resources/credit-notes.mjs.map +1 -1
  29. package/resources/customers/balance-transactions.d.ts +5 -32
  30. package/resources/customers/balance-transactions.d.ts.map +1 -1
  31. package/resources/customers/balance-transactions.js.map +1 -1
  32. package/resources/customers/balance-transactions.mjs.map +1 -1
  33. package/resources/customers/costs.d.ts +3 -81
  34. package/resources/customers/costs.d.ts.map +1 -1
  35. package/resources/customers/credits/credits.d.ts +4 -4
  36. package/resources/customers/credits/credits.d.ts.map +1 -1
  37. package/resources/customers/credits/credits.js.map +1 -1
  38. package/resources/customers/credits/credits.mjs.map +1 -1
  39. package/resources/customers/credits/index.d.ts +2 -2
  40. package/resources/customers/credits/index.d.ts.map +1 -1
  41. package/resources/customers/credits/index.js.map +1 -1
  42. package/resources/customers/credits/index.mjs.map +1 -1
  43. package/resources/customers/credits/ledger.d.ts +171 -962
  44. package/resources/customers/credits/ledger.d.ts.map +1 -1
  45. package/resources/customers/credits/ledger.js.map +1 -1
  46. package/resources/customers/credits/ledger.mjs.map +1 -1
  47. package/resources/customers/credits/top-ups.d.ts +37 -117
  48. package/resources/customers/credits/top-ups.d.ts.map +1 -1
  49. package/resources/customers/credits/top-ups.js.map +1 -1
  50. package/resources/customers/credits/top-ups.mjs.map +1 -1
  51. package/resources/customers/customers.d.ts +72 -678
  52. package/resources/customers/customers.d.ts.map +1 -1
  53. package/resources/customers/customers.js.map +1 -1
  54. package/resources/customers/customers.mjs.map +1 -1
  55. package/resources/customers/index.d.ts +1 -1
  56. package/resources/customers/index.d.ts.map +1 -1
  57. package/resources/customers/index.js.map +1 -1
  58. package/resources/customers/index.mjs.map +1 -1
  59. package/resources/events/events.d.ts +3 -3
  60. package/resources/events/events.d.ts.map +1 -1
  61. package/resources/index.d.ts +7 -7
  62. package/resources/index.d.ts.map +1 -1
  63. package/resources/index.js +1 -4
  64. package/resources/index.js.map +1 -1
  65. package/resources/index.mjs +3 -3
  66. package/resources/index.mjs.map +1 -1
  67. package/resources/invoice-line-items.d.ts +6 -395
  68. package/resources/invoice-line-items.d.ts.map +1 -1
  69. package/resources/invoice-line-items.js.map +1 -1
  70. package/resources/invoice-line-items.mjs.map +1 -1
  71. package/resources/invoices.d.ts +30 -1700
  72. package/resources/invoices.d.ts.map +1 -1
  73. package/resources/invoices.js +3 -6
  74. package/resources/invoices.js.map +1 -1
  75. package/resources/invoices.mjs +2 -4
  76. package/resources/invoices.mjs.map +1 -1
  77. package/resources/plans/plans.d.ts +7 -3801
  78. package/resources/plans/plans.d.ts.map +1 -1
  79. package/resources/plans/plans.js.map +1 -1
  80. package/resources/plans/plans.mjs.map +1 -1
  81. package/resources/prices/external-price-id.d.ts +3 -3
  82. package/resources/prices/external-price-id.d.ts.map +1 -1
  83. package/resources/prices/index.d.ts +1 -1
  84. package/resources/prices/index.d.ts.map +1 -1
  85. package/resources/prices/index.js +1 -2
  86. package/resources/prices/index.js.map +1 -1
  87. package/resources/prices/index.mjs +1 -1
  88. package/resources/prices/index.mjs.map +1 -1
  89. package/resources/prices/prices.d.ts +347 -9373
  90. package/resources/prices/prices.d.ts.map +1 -1
  91. package/resources/prices/prices.js +39 -20
  92. package/resources/prices/prices.js.map +1 -1
  93. package/resources/prices/prices.mjs +38 -18
  94. package/resources/prices/prices.mjs.map +1 -1
  95. package/resources/shared.d.ts +7269 -9
  96. package/resources/shared.d.ts.map +1 -1
  97. package/resources/shared.js +11 -0
  98. package/resources/shared.js.map +1 -1
  99. package/resources/shared.mjs +7 -1
  100. package/resources/shared.mjs.map +1 -1
  101. package/resources/subscription-changes.d.ts +138 -2158
  102. package/resources/subscription-changes.d.ts.map +1 -1
  103. package/resources/subscription-changes.js.map +1 -1
  104. package/resources/subscription-changes.mjs.map +1 -1
  105. package/resources/subscriptions.d.ts +2722 -26580
  106. package/resources/subscriptions.d.ts.map +1 -1
  107. package/resources/subscriptions.js +7 -1
  108. package/resources/subscriptions.js.map +1 -1
  109. package/resources/subscriptions.mjs +7 -1
  110. package/resources/subscriptions.mjs.map +1 -1
  111. package/src/index.ts +221 -40
  112. package/src/resources/alerts.ts +20 -94
  113. package/src/resources/beta/beta.ts +124 -8892
  114. package/src/resources/beta/external-plan-id.ts +118 -8593
  115. package/src/resources/credit-notes.ts +10 -217
  116. package/src/resources/customers/balance-transactions.ts +5 -36
  117. package/src/resources/customers/costs.ts +3 -101
  118. package/src/resources/customers/credits/credits.ts +18 -0
  119. package/src/resources/customers/credits/index.ts +9 -0
  120. package/src/resources/customers/credits/ledger.ts +212 -1435
  121. package/src/resources/customers/credits/top-ups.ts +41 -132
  122. package/src/resources/customers/customers.ts +162 -1454
  123. package/src/resources/customers/index.ts +8 -0
  124. package/src/resources/events/events.ts +3 -3
  125. package/src/resources/index.ts +43 -21
  126. package/src/resources/invoice-line-items.ts +10 -501
  127. package/src/resources/invoices.ts +60 -2394
  128. package/src/resources/plans/plans.ts +38 -4588
  129. package/src/resources/prices/external-price-id.ts +3 -3
  130. package/src/resources/prices/index.ts +2 -2
  131. package/src/resources/prices/prices.ts +501 -11811
  132. package/src/resources/shared.ts +9582 -22
  133. package/src/resources/subscription-changes.ts +171 -2670
  134. package/src/resources/subscriptions.ts +3175 -31993
  135. package/src/version.ts +1 -1
  136. package/version.d.ts +1 -1
  137. package/version.d.ts.map +1 -1
  138. package/version.js +1 -1
  139. package/version.js.map +1 -1
  140. package/version.mjs +1 -1
  141. package/version.mjs.map +1 -1
@@ -27,7 +27,15 @@ export {
27
27
  export {
28
28
  CustomersPage,
29
29
  Customers,
30
+ type AccountingProviderConfig,
31
+ type AddressInput,
30
32
  type Customer,
33
+ type CustomerHierarchyConfig,
34
+ type NewAccountingSyncConfiguration,
35
+ type NewAvalaraTaxConfiguration,
36
+ type NewReportingConfiguration,
37
+ type NewSphereConfiguration,
38
+ type NewTaxJarConfiguration,
31
39
  type CustomerCreateParams,
32
40
  type CustomerUpdateParams,
33
41
  type CustomerListParams,
@@ -451,7 +451,7 @@ export namespace EventSearchResponse {
451
451
  * A dictionary of custom properties. Values in this dictionary must be numeric,
452
452
  * boolean, or strings. Nested dictionaries are disallowed.
453
453
  */
454
- properties: unknown;
454
+ properties: Record<string, unknown>;
455
455
 
456
456
  /**
457
457
  * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -472,7 +472,7 @@ export interface EventUpdateParams {
472
472
  * A dictionary of custom properties. Values in this dictionary must be numeric,
473
473
  * boolean, or strings. Nested dictionaries are disallowed.
474
474
  */
475
- properties: unknown;
475
+ properties: Record<string, unknown>;
476
476
 
477
477
  /**
478
478
  * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -530,7 +530,7 @@ export namespace EventIngestParams {
530
530
  * A dictionary of custom properties. Values in this dictionary must be numeric,
531
531
  * boolean, or strings. Nested dictionaries are disallowed.
532
532
  */
533
- properties: unknown;
533
+ properties: Record<string, unknown>;
534
534
 
535
535
  /**
536
536
  * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -5,6 +5,7 @@ export {
5
5
  AlertsPage,
6
6
  Alerts,
7
7
  type Alert,
8
+ type Threshold,
8
9
  type AlertUpdateParams,
9
10
  type AlertListParams,
10
11
  type AlertCreateForCustomerParams,
@@ -35,17 +36,19 @@ export {
35
36
  type CouponCreateParams,
36
37
  type CouponListParams,
37
38
  } from './coupons/coupons';
38
- export {
39
- CreditNotesPage,
40
- CreditNotes,
41
- type CreditNote,
42
- type CreditNoteCreateParams,
43
- type CreditNoteListParams,
44
- } from './credit-notes';
39
+ export { CreditNotes, type CreditNoteCreateParams, type CreditNoteListParams } from './credit-notes';
45
40
  export {
46
41
  CustomersPage,
47
42
  Customers,
43
+ type AccountingProviderConfig,
44
+ type AddressInput,
48
45
  type Customer,
46
+ type CustomerHierarchyConfig,
47
+ type NewAccountingSyncConfiguration,
48
+ type NewAvalaraTaxConfiguration,
49
+ type NewReportingConfiguration,
50
+ type NewSphereConfiguration,
51
+ type NewTaxJarConfiguration,
49
52
  type CustomerCreateParams,
50
53
  type CustomerUpdateParams,
51
54
  type CustomerListParams,
@@ -74,9 +77,7 @@ export {
74
77
  type InvoiceLineItemCreateParams,
75
78
  } from './invoice-line-items';
76
79
  export {
77
- InvoicesPage,
78
80
  Invoices,
79
- type Invoice,
80
81
  type InvoiceFetchUpcomingResponse,
81
82
  type InvoiceCreateParams,
82
83
  type InvoiceUpdateParams,
@@ -102,20 +103,21 @@ export {
102
103
  type PlanListParams,
103
104
  } from './plans/plans';
104
105
  export {
105
- PricesPage,
106
106
  Prices,
107
107
  type EvaluatePriceGroup,
108
- type Price,
109
108
  type PriceEvaluateResponse,
110
109
  type PriceEvaluateMultipleResponse,
110
+ type PriceEvaluatePreviewEventsResponse,
111
111
  type PriceCreateParams,
112
112
  type PriceUpdateParams,
113
113
  type PriceListParams,
114
114
  type PriceEvaluateParams,
115
115
  type PriceEvaluateMultipleParams,
116
+ type PriceEvaluatePreviewEventsParams,
116
117
  } from './prices/prices';
117
118
  export {
118
119
  SubscriptionChanges,
120
+ type MutatedSubscription,
119
121
  type SubscriptionChangeRetrieveResponse,
120
122
  type SubscriptionChangeApplyResponse,
121
123
  type SubscriptionChangeCancelResponse,
@@ -125,20 +127,39 @@ export {
125
127
  SubscriptionsPage,
126
128
  SubscriptionFetchScheduleResponsesPage,
127
129
  Subscriptions,
130
+ type DiscountOverride,
131
+ type NewSubscriptionBPSPrice,
132
+ type NewSubscriptionBulkBPSPrice,
133
+ type NewSubscriptionBulkPrice,
134
+ type NewSubscriptionBulkWithProrationPrice,
135
+ type NewSubscriptionCumulativeGroupedBulkPrice,
136
+ type NewSubscriptionGroupedAllocationPrice,
137
+ type NewSubscriptionGroupedTieredPackagePrice,
138
+ type NewSubscriptionGroupedTieredPrice,
139
+ type NewSubscriptionGroupedWithMeteredMinimumPrice,
140
+ type NewSubscriptionGroupedWithProratedMinimumPrice,
141
+ type NewSubscriptionMatrixPrice,
142
+ type NewSubscriptionMatrixWithAllocationPrice,
143
+ type NewSubscriptionMatrixWithDisplayNamePrice,
144
+ type NewSubscriptionMaxGroupTieredPackagePrice,
145
+ type NewSubscriptionPackagePrice,
146
+ type NewSubscriptionPackageWithAllocationPrice,
147
+ type NewSubscriptionScalableMatrixWithTieredPricingPrice,
148
+ type NewSubscriptionScalableMatrixWithUnitPricingPrice,
149
+ type NewSubscriptionThresholdTotalAmountPrice,
150
+ type NewSubscriptionTierWithProrationPrice,
151
+ type NewSubscriptionTieredBPSPrice,
152
+ type NewSubscriptionTieredPackagePrice,
153
+ type NewSubscriptionTieredPackageWithMinimumPrice,
154
+ type NewSubscriptionTieredPrice,
155
+ type NewSubscriptionTieredWithMinimumPrice,
156
+ type NewSubscriptionUnitPrice,
157
+ type NewSubscriptionUnitWithPercentPrice,
158
+ type NewSubscriptionUnitWithProrationPrice,
128
159
  type Subscription,
129
160
  type SubscriptionUsage,
130
- type SubscriptionCreateResponse,
131
- type SubscriptionCancelResponse,
132
161
  type SubscriptionFetchCostsResponse,
133
162
  type SubscriptionFetchScheduleResponse,
134
- type SubscriptionPriceIntervalsResponse,
135
- type SubscriptionSchedulePlanChangeResponse,
136
- type SubscriptionTriggerPhaseResponse,
137
- type SubscriptionUnscheduleCancellationResponse,
138
- type SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse,
139
- type SubscriptionUnschedulePendingPlanChangesResponse,
140
- type SubscriptionUpdateFixedFeeQuantityResponse,
141
- type SubscriptionUpdateTrialResponse,
142
163
  type SubscriptionCreateParams,
143
164
  type SubscriptionUpdateParams,
144
165
  type SubscriptionListParams,
@@ -147,6 +168,7 @@ export {
147
168
  type SubscriptionFetchScheduleParams,
148
169
  type SubscriptionFetchUsageParams,
149
170
  type SubscriptionPriceIntervalsParams,
171
+ type SubscriptionRedeemCouponParams,
150
172
  type SubscriptionSchedulePlanChangeParams,
151
173
  type SubscriptionTriggerPhaseParams,
152
174
  type SubscriptionUnscheduleFixedFeeQuantityUpdatesParams,