chargebee 3.0.0-beta.4 → 3.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 (84) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +4 -3
  3. package/cjs/environment.js +1 -1
  4. package/cjs/util.js +1 -1
  5. package/esm/environment.js +1 -1
  6. package/esm/util.js +1 -1
  7. package/package.json +1 -1
  8. package/types/core.d.ts +0 -564
  9. package/types/index.d.ts +0 -167
  10. package/types/resources/Address.d.ts +0 -71
  11. package/types/resources/AdvanceInvoiceSchedule.d.ts +0 -29
  12. package/types/resources/AttachedItem.d.ts +0 -114
  13. package/types/resources/Attribute.d.ts +0 -9
  14. package/types/resources/BusinessEntity.d.ts +0 -64
  15. package/types/resources/BusinessEntityTransfer.d.ts +0 -15
  16. package/types/resources/Card.d.ts +0 -171
  17. package/types/resources/Comment.d.ts +0 -89
  18. package/types/resources/Contact.d.ts +0 -16
  19. package/types/resources/ContractTerm.d.ts +0 -19
  20. package/types/resources/Coupon.d.ts +0 -314
  21. package/types/resources/CouponCode.d.ts +0 -70
  22. package/types/resources/CouponSet.d.ts +0 -111
  23. package/types/resources/CreditNote.d.ts +0 -628
  24. package/types/resources/CreditNoteEstimate.d.ts +0 -143
  25. package/types/resources/Currency.d.ts +0 -91
  26. package/types/resources/Customer.d.ts +0 -962
  27. package/types/resources/CustomerEntitlement.d.ts +0 -36
  28. package/types/resources/DifferentialPrice.d.ts +0 -142
  29. package/types/resources/Discount.d.ts +0 -24
  30. package/types/resources/Download.d.ts +0 -10
  31. package/types/resources/Entitlement.d.ts +0 -66
  32. package/types/resources/EntitlementOverride.d.ts +0 -76
  33. package/types/resources/Estimate.d.ts +0 -1237
  34. package/types/resources/Event.d.ts +0 -81
  35. package/types/resources/Export.d.ts +0 -607
  36. package/types/resources/Feature.d.ts +0 -142
  37. package/types/resources/GatewayErrorDetail.d.ts +0 -20
  38. package/types/resources/Gift.d.ts +0 -296
  39. package/types/resources/Hierarchy.d.ts +0 -12
  40. package/types/resources/HostedPage.d.ts +0 -1112
  41. package/types/resources/ImpactedItem.d.ts +0 -20
  42. package/types/resources/ImpactedItemPrice.d.ts +0 -20
  43. package/types/resources/ImpactedSubscription.d.ts +0 -20
  44. package/types/resources/InAppSubscription.d.ts +0 -116
  45. package/types/resources/Invoice.d.ts +0 -1691
  46. package/types/resources/InvoiceEstimate.d.ts +0 -143
  47. package/types/resources/Item.d.ts +0 -204
  48. package/types/resources/ItemEntitlement.d.ts +0 -103
  49. package/types/resources/ItemFamily.d.ts +0 -89
  50. package/types/resources/ItemPrice.d.ts +0 -328
  51. package/types/resources/Metadata.d.ts +0 -8
  52. package/types/resources/NonSubscription.d.ts +0 -48
  53. package/types/resources/Order.d.ts +0 -586
  54. package/types/resources/PaymentIntent.d.ts +0 -178
  55. package/types/resources/PaymentReferenceNumber.d.ts +0 -11
  56. package/types/resources/PaymentSchedule.d.ts +0 -28
  57. package/types/resources/PaymentScheduleEstimate.d.ts +0 -25
  58. package/types/resources/PaymentScheduleScheme.d.ts +0 -62
  59. package/types/resources/PaymentSource.d.ts +0 -529
  60. package/types/resources/PaymentVoucher.d.ts +0 -107
  61. package/types/resources/PortalSession.d.ts +0 -88
  62. package/types/resources/PriceVariant.d.ts +0 -112
  63. package/types/resources/PricingPageSession.d.ts +0 -130
  64. package/types/resources/PromotionalCredit.d.ts +0 -111
  65. package/types/resources/Purchase.d.ts +0 -202
  66. package/types/resources/Quote.d.ts +0 -1467
  67. package/types/resources/QuoteLineGroup.d.ts +0 -136
  68. package/types/resources/QuotedCharge.d.ts +0 -56
  69. package/types/resources/QuotedSubscription.d.ts +0 -114
  70. package/types/resources/Ramp.d.ts +0 -260
  71. package/types/resources/ResourceMigration.d.ts +0 -36
  72. package/types/resources/SiteMigrationDetail.d.ts +0 -46
  73. package/types/resources/Subscription.d.ts +0 -2443
  74. package/types/resources/SubscriptionEntitlement.d.ts +0 -79
  75. package/types/resources/SubscriptionEstimate.d.ts +0 -59
  76. package/types/resources/TaxWithheld.d.ts +0 -19
  77. package/types/resources/ThirdPartyPaymentMethod.d.ts +0 -11
  78. package/types/resources/TimeMachine.d.ts +0 -57
  79. package/types/resources/Token.d.ts +0 -19
  80. package/types/resources/Transaction.d.ts +0 -313
  81. package/types/resources/UnbilledCharge.d.ts +0 -209
  82. package/types/resources/Usage.d.ts +0 -113
  83. package/types/resources/VirtualBankAccount.d.ts +0 -125
  84. package/types/resources/filter.d.ts +0 -52
@@ -1,142 +0,0 @@
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 Feature {
6
- id: string;
7
- name: string;
8
- description?: string;
9
- status?: 'active' | 'archived' | 'draft';
10
- type?: 'switch' | 'custom' | 'quantity' | 'range';
11
- unit?: string;
12
- resource_version?: number;
13
- updated_at?: number;
14
- created_at: number;
15
- levels?: Feature.Level[];
16
- }
17
-
18
- export namespace Feature {
19
- export class FeatureResource {
20
- list(
21
- input?: ListInputParam,
22
- headers?: ChargebeeRequestHeader,
23
- ): Promise<ChargebeeResponse<ListResponse>>;
24
-
25
- create(
26
- input: CreateInputParam,
27
- headers?: ChargebeeRequestHeader,
28
- ): Promise<ChargebeeResponse<CreateResponse>>;
29
-
30
- update(
31
- feature_id: string,
32
- input?: UpdateInputParam,
33
- headers?: ChargebeeRequestHeader,
34
- ): Promise<ChargebeeResponse<UpdateResponse>>;
35
-
36
- retrieve(
37
- feature_id: string,
38
- headers?: ChargebeeRequestHeader,
39
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
40
-
41
- delete(
42
- feature_id: string,
43
- headers?: ChargebeeRequestHeader,
44
- ): Promise<ChargebeeResponse<DeleteResponse>>;
45
-
46
- activate(
47
- feature_id: string,
48
- headers?: ChargebeeRequestHeader,
49
- ): Promise<ChargebeeResponse<ActivateResponse>>;
50
-
51
- archive(
52
- feature_id: string,
53
- headers?: ChargebeeRequestHeader,
54
- ): Promise<ChargebeeResponse<ArchiveResponse>>;
55
-
56
- reactivate(
57
- feature_id: string,
58
- headers?: ChargebeeRequestHeader,
59
- ): Promise<ChargebeeResponse<ReactivateResponse>>;
60
- }
61
-
62
- export interface ListResponse {
63
- list: { feature: Feature }[];
64
- next_offset?: string;
65
- }
66
-
67
- export interface CreateResponse {
68
- feature: Feature;
69
- }
70
-
71
- export interface UpdateResponse {
72
- feature: Feature;
73
- }
74
-
75
- export interface RetrieveResponse {
76
- feature: Feature;
77
- }
78
-
79
- export interface DeleteResponse {
80
- feature: Feature;
81
- }
82
-
83
- export interface ActivateResponse {
84
- feature: Feature;
85
- }
86
-
87
- export interface ArchiveResponse {
88
- feature: Feature;
89
- }
90
-
91
- export interface ReactivateResponse {
92
- feature: Feature;
93
- }
94
-
95
- export interface Level {
96
- name?: string;
97
- value: string;
98
- level: number;
99
- is_unlimited: boolean;
100
- }
101
- // REQUEST PARAMS
102
- //---------------
103
-
104
- export interface ListInputParam {
105
- limit?: number;
106
- offset?: string;
107
- name?: filter.String;
108
- id?: filter.String;
109
- status?: filter.Enum;
110
- type?: filter.Enum;
111
- [key: `cf_${string}`]: unknown;
112
- }
113
- export interface CreateInputParam {
114
- id?: string;
115
- name: string;
116
- description?: string;
117
- type?: 'switch' | 'custom' | 'quantity' | 'range';
118
- unit?: string;
119
- levels?: LevelsCreateInputParam[];
120
- [key: `cf_${string}`]: unknown;
121
- }
122
- export interface UpdateInputParam {
123
- name?: string;
124
- description?: string;
125
- unit?: string;
126
- levels?: LevelsUpdateInputParam[];
127
- [key: `cf_${string}`]: unknown;
128
- }
129
- export interface LevelsCreateInputParam {
130
- name?: string;
131
- value?: string;
132
- is_unlimited?: boolean;
133
- level?: number;
134
- }
135
- export interface LevelsUpdateInputParam {
136
- name?: string;
137
- value?: string;
138
- is_unlimited?: boolean;
139
- level?: number;
140
- }
141
- }
142
- }
@@ -1,20 +0,0 @@
1
- ///<reference path='./../core.d.ts'/>
2
- ///<reference path='./../index.d.ts'/>
3
-
4
- declare module 'chargebee' {
5
- export interface GatewayErrorDetail {
6
- request_id?: string;
7
- error_category?: string;
8
- error_code?: string;
9
- error_message?: string;
10
- decline_code?: string;
11
- decline_message?: string;
12
- network_error_code?: string;
13
- network_error_message?: string;
14
- error_field?: string;
15
- recommendation_code?: string;
16
- recommendation_message?: string;
17
- processor_error_code?: string;
18
- processor_error_message?: string;
19
- }
20
- }
@@ -1,296 +0,0 @@
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 Gift {
6
- id: string;
7
- status: 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired';
8
- scheduled_at?: number;
9
- auto_claim: boolean;
10
- no_expiry: boolean;
11
- claim_expiry_date?: number;
12
- resource_version?: number;
13
- updated_at?: number;
14
- gifter: Gift.Gifter;
15
- gift_receiver: Gift.GiftReceiver;
16
- gift_timelines?: Gift.GiftTimeline[];
17
- }
18
-
19
- export namespace Gift {
20
- export class GiftResource {
21
- create(
22
- input: CreateInputParam,
23
- headers?: ChargebeeRequestHeader,
24
- ): Promise<ChargebeeResponse<CreateResponse>>;
25
-
26
- createForItems(
27
- input: CreateForItemsInputParam,
28
- headers?: ChargebeeRequestHeader,
29
- ): Promise<ChargebeeResponse<CreateForItemsResponse>>;
30
-
31
- retrieve(
32
- gift_id: string,
33
- headers?: ChargebeeRequestHeader,
34
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
35
-
36
- list(
37
- input?: ListInputParam,
38
- headers?: ChargebeeRequestHeader,
39
- ): Promise<ChargebeeResponse<ListResponse>>;
40
-
41
- claim(
42
- gift_id: string,
43
- headers?: ChargebeeRequestHeader,
44
- ): Promise<ChargebeeResponse<ClaimResponse>>;
45
-
46
- cancel(
47
- gift_id: string,
48
- headers?: ChargebeeRequestHeader,
49
- ): Promise<ChargebeeResponse<CancelResponse>>;
50
-
51
- updateGift(
52
- gift_id: string,
53
- input: UpdateGiftInputParam,
54
- headers?: ChargebeeRequestHeader,
55
- ): Promise<ChargebeeResponse<UpdateGiftResponse>>;
56
- }
57
-
58
- export interface CreateResponse {
59
- gift: Gift;
60
- subscription: Subscription;
61
- invoice?: Invoice;
62
- }
63
-
64
- export interface CreateForItemsResponse {
65
- gift: Gift;
66
- subscription: Subscription;
67
- invoice?: Invoice;
68
- }
69
-
70
- export interface RetrieveResponse {
71
- gift: Gift;
72
- subscription: Subscription;
73
- }
74
-
75
- export interface ListResponse {
76
- list: { gift: Gift; subscription: Subscription }[];
77
- next_offset?: string;
78
- }
79
-
80
- export interface ClaimResponse {
81
- gift: Gift;
82
- subscription: Subscription;
83
- }
84
-
85
- export interface CancelResponse {
86
- gift: Gift;
87
- subscription: Subscription;
88
- }
89
-
90
- export interface UpdateGiftResponse {
91
- gift: Gift;
92
- subscription: Subscription;
93
- }
94
-
95
- export interface Gifter {
96
- customer_id: string;
97
- invoice_id?: string;
98
- signature?: string;
99
- note?: string;
100
- }
101
- export interface GiftReceiver {
102
- customer_id: string;
103
- subscription_id: string;
104
- first_name?: string;
105
- last_name?: string;
106
- email?: string;
107
- }
108
- export interface GiftTimeline {
109
- status: 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired';
110
- occurred_at?: number;
111
- }
112
- // REQUEST PARAMS
113
- //---------------
114
-
115
- export interface CreateInputParam {
116
- scheduled_at?: number;
117
- auto_claim?: boolean;
118
- no_expiry?: boolean;
119
- claim_expiry_date?: number;
120
- coupon_ids?: string[];
121
- gifter?: GifterCreateInputParam;
122
- gift_receiver?: GiftReceiverCreateInputParam;
123
- payment_intent?: PaymentIntentCreateInputParam;
124
- shipping_address?: ShippingAddressCreateInputParam;
125
- subscription?: SubscriptionCreateInputParam;
126
- addons?: AddonsCreateInputParam[];
127
- }
128
- export interface CreateForItemsInputParam {
129
- scheduled_at?: number;
130
- auto_claim?: boolean;
131
- no_expiry?: boolean;
132
- claim_expiry_date?: number;
133
- coupon_ids?: string[];
134
- gifter?: GifterCreateForItemsInputParam;
135
- gift_receiver?: GiftReceiverCreateForItemsInputParam;
136
- payment_intent?: PaymentIntentCreateForItemsInputParam;
137
- shipping_address?: ShippingAddressCreateForItemsInputParam;
138
- subscription_items?: SubscriptionItemsCreateForItemsInputParam[];
139
- }
140
- export interface ListInputParam {
141
- limit?: number;
142
- offset?: string;
143
- gift_receiver?: GiftReceiverGiftListInputParam;
144
- gifter?: GifterGiftListInputParam;
145
- status?: filter.Enum;
146
- }
147
- export interface UpdateGiftInputParam {
148
- scheduled_at: number;
149
- comment?: string;
150
- }
151
- export interface GiftReceiverCreateInputParam {
152
- customer_id: string;
153
- first_name: string;
154
- last_name: string;
155
- email: string;
156
- }
157
- export interface GifterCreateInputParam {
158
- customer_id: string;
159
- signature: string;
160
- note?: string;
161
- payment_src_id?: string;
162
- }
163
- export interface ShippingAddressCreateInputParam {
164
- first_name?: string;
165
- last_name?: string;
166
- email?: string;
167
- company?: string;
168
- phone?: string;
169
- line1?: string;
170
- line2?: string;
171
- line3?: string;
172
- city?: string;
173
- state_code?: string;
174
- state?: string;
175
- zip?: string;
176
- country?: string;
177
- validation_status?: ValidationStatus;
178
- }
179
- export interface PaymentIntentCreateInputParam {
180
- id?: string;
181
- gateway_account_id?: string;
182
- gw_token?: string;
183
- payment_method_type?:
184
- | 'card'
185
- | 'ideal'
186
- | 'sofort'
187
- | 'bancontact'
188
- | 'google_pay'
189
- | 'dotpay'
190
- | 'giropay'
191
- | 'apple_pay'
192
- | 'upi'
193
- | 'netbanking_emandates'
194
- | 'paypal_express_checkout'
195
- | 'direct_debit'
196
- | 'boleto'
197
- | 'venmo'
198
- | 'amazon_payments'
199
- | 'pay_to'
200
- | 'faster_payments'
201
- | 'sepa_instant_transfer'
202
- | 'klarna_pay_now'
203
- | 'online_banking_poland';
204
- reference_id?: string;
205
- /**
206
- * @deprecated Please refer API docs to use other attributes
207
- */
208
- gw_payment_method_id?: string;
209
- additional_information?: any;
210
- }
211
- export interface SubscriptionCreateInputParam {
212
- plan_id: string;
213
- plan_quantity?: number;
214
- plan_quantity_in_decimal?: string;
215
- }
216
-
217
- export interface AddonsCreateInputParam {
218
- id?: string;
219
- quantity?: number;
220
- quantity_in_decimal?: string;
221
- }
222
- export interface GiftReceiverCreateForItemsInputParam {
223
- customer_id: string;
224
- first_name: string;
225
- last_name: string;
226
- email: string;
227
- }
228
- export interface GifterCreateForItemsInputParam {
229
- customer_id: string;
230
- signature: string;
231
- note?: string;
232
- payment_src_id?: string;
233
- }
234
- export interface ShippingAddressCreateForItemsInputParam {
235
- first_name?: string;
236
- last_name?: string;
237
- email?: string;
238
- company?: string;
239
- phone?: string;
240
- line1?: string;
241
- line2?: string;
242
- line3?: string;
243
- city?: string;
244
- state_code?: string;
245
- state?: string;
246
- zip?: string;
247
- country?: string;
248
- validation_status?: ValidationStatus;
249
- }
250
- export interface PaymentIntentCreateForItemsInputParam {
251
- id?: string;
252
- gateway_account_id?: string;
253
- gw_token?: string;
254
- payment_method_type?:
255
- | 'card'
256
- | 'ideal'
257
- | 'sofort'
258
- | 'bancontact'
259
- | 'google_pay'
260
- | 'dotpay'
261
- | 'giropay'
262
- | 'apple_pay'
263
- | 'upi'
264
- | 'netbanking_emandates'
265
- | 'paypal_express_checkout'
266
- | 'direct_debit'
267
- | 'boleto'
268
- | 'venmo'
269
- | 'amazon_payments'
270
- | 'pay_to'
271
- | 'faster_payments'
272
- | 'sepa_instant_transfer'
273
- | 'klarna_pay_now'
274
- | 'online_banking_poland';
275
- reference_id?: string;
276
- /**
277
- * @deprecated Please refer API docs to use other attributes
278
- */
279
- gw_payment_method_id?: string;
280
- additional_information?: any;
281
- }
282
-
283
- export interface SubscriptionItemsCreateForItemsInputParam {
284
- item_price_id?: string;
285
- quantity?: number;
286
- quantity_in_decimal?: string;
287
- }
288
- export interface GifterGiftListInputParam {
289
- customer_id?: filter.String;
290
- }
291
- export interface GiftReceiverGiftListInputParam {
292
- email?: filter.String;
293
- customer_id?: filter.String;
294
- }
295
- }
296
- }
@@ -1,12 +0,0 @@
1
- ///<reference path='./../core.d.ts'/>
2
- ///<reference path='./../index.d.ts'/>
3
-
4
- declare module 'chargebee' {
5
- export interface Hierarchy {
6
- customer_id: string;
7
- parent_id?: string;
8
- payment_owner_id: string;
9
- invoice_owner_id: string;
10
- children_ids?: string[];
11
- }
12
- }