chargebee 2.41.0 → 3.0.0-beta.2
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.
- package/CHANGELOG.md +11 -15
- package/LICENSE +1 -1
- package/README.md +90 -170
- package/cjs/RequestWrapper.js +84 -0
- package/cjs/asyncApiSupport.js +39 -0
- package/cjs/chargebee.cjs.js +13 -0
- package/cjs/chargebee.cjs.worker.js +9 -0
- package/cjs/chargebeeError.js +17 -0
- package/cjs/coreCommon.js +72 -0
- package/cjs/createChargebee.js +92 -0
- package/cjs/environment.js +18 -0
- package/cjs/filter.js +1 -0
- package/cjs/net/ClientInterface.js +40 -0
- package/cjs/net/FetchClient.js +86 -0
- package/cjs/net/NodeClient.js +61 -0
- package/cjs/package.json +1 -0
- package/cjs/resources/api_endpoints.js +1086 -0
- package/cjs/util.js +218 -0
- package/esm/RequestWrapper.js +80 -0
- package/esm/asyncApiSupport.js +35 -0
- package/esm/chargebee.esm.js +9 -0
- package/esm/chargebee.esm.worker.js +5 -0
- package/esm/chargebeeError.js +13 -0
- package/esm/coreCommon.js +67 -0
- package/esm/createChargebee.js +88 -0
- package/esm/environment.js +15 -0
- package/esm/filter.js +1 -0
- package/esm/net/ClientInterface.js +35 -0
- package/esm/net/FetchClient.js +81 -0
- package/esm/net/NodeClient.js +56 -0
- package/esm/package.json +1 -0
- package/esm/resources/api_endpoints.js +1083 -0
- package/esm/util.js +202 -0
- package/package.json +69 -38
- package/types/core.d.ts +558 -89
- package/types/index.d.ts +90 -55
- package/types/resources/Address.d.ts +57 -272
- package/types/resources/AdvanceInvoiceSchedule.d.ts +21 -94
- package/types/resources/AttachedItem.d.ts +91 -329
- package/types/resources/Attribute.d.ts +5 -5
- package/types/resources/BusinessEntity.d.ts +49 -69
- package/types/resources/BusinessEntityTransfer.d.ts +11 -17
- package/types/resources/Card.d.ts +146 -424
- package/types/resources/Comment.d.ts +72 -189
- package/types/resources/Contact.d.ts +12 -64
- package/types/resources/ContractTerm.d.ts +15 -96
- package/types/resources/Coupon.d.ts +282 -758
- package/types/resources/CouponCode.d.ts +56 -52
- package/types/resources/CouponSet.d.ts +92 -234
- package/types/resources/CreditNote.d.ts +588 -1758
- package/types/resources/CreditNoteEstimate.d.ts +131 -157
- package/types/resources/Currency.d.ts +75 -62
- package/types/resources/Customer.d.ts +892 -835
- package/types/resources/CustomerEntitlement.d.ts +24 -35
- package/types/resources/DifferentialPrice.d.ts +116 -314
- package/types/resources/Discount.d.ts +20 -125
- package/types/resources/Download.d.ts +6 -22
- package/types/resources/Entitlement.d.ts +51 -160
- package/types/resources/EntitlementOverride.d.ts +58 -139
- package/types/resources/Estimate.d.ts +1178 -527
- package/types/resources/Event.d.ts +67 -178
- package/types/resources/Export.d.ts +563 -723
- package/types/resources/Feature.d.ts +117 -433
- package/types/resources/GatewayErrorDetail.d.ts +16 -72
- package/types/resources/Gift.d.ts +265 -432
- package/types/resources/Hierarchy.d.ts +8 -36
- package/types/resources/HostedPage.d.ts +1017 -1153
- package/types/resources/ImpactedItem.d.ts +13 -50
- package/types/resources/ImpactedItemPrice.d.ts +13 -15
- package/types/resources/ImpactedSubscription.d.ts +13 -45
- package/types/resources/InAppSubscription.d.ts +93 -389
- package/types/resources/Installment.d.ts +35 -110
- package/types/resources/InstallmentConfig.d.ts +54 -155
- package/types/resources/InstallmentDetail.d.ts +19 -27
- package/types/resources/Invoice.d.ts +1574 -3157
- package/types/resources/InvoiceEstimate.d.ts +131 -161
- package/types/resources/Item.d.ts +133 -611
- package/types/resources/ItemEntitlement.d.ts +78 -215
- package/types/resources/ItemFamily.d.ts +69 -178
- package/types/resources/ItemPrice.d.ts +291 -1203
- package/types/resources/Metadata.d.ts +3 -5
- package/types/resources/Order.d.ts +538 -1471
- package/types/resources/PaymentIntent.d.ts +163 -347
- package/types/resources/PaymentReferenceNumber.d.ts +7 -29
- package/types/resources/PaymentSource.d.ts +476 -1272
- package/types/resources/PaymentVoucher.d.ts +87 -306
- package/types/resources/PortalSession.d.ts +71 -207
- package/types/resources/PriceVariant.d.ts +91 -279
- package/types/resources/PricingPageSession.d.ts +92 -41
- package/types/resources/PromotionalCredit.d.ts +90 -346
- package/types/resources/Purchase.d.ts +185 -315
- package/types/resources/Quote.d.ts +1406 -887
- package/types/resources/QuoteLineGroup.d.ts +125 -452
- package/types/resources/QuotedCharge.d.ts +45 -274
- package/types/resources/QuotedSubscription.d.ts +100 -488
- package/types/resources/Ramp.d.ts +230 -747
- package/types/resources/ResourceMigration.d.ts +25 -80
- package/types/resources/SiteMigrationDetail.d.ts +34 -112
- package/types/resources/Subscription.d.ts +2390 -4336
- package/types/resources/SubscriptionEntitlement.d.ts +59 -160
- package/types/resources/SubscriptionEstimate.d.ts +51 -75
- package/types/resources/TaxWithheld.d.ts +15 -40
- package/types/resources/ThirdPartyPaymentMethod.d.ts +7 -29
- package/types/resources/TimeMachine.d.ts +43 -97
- package/types/resources/Token.d.ts +15 -85
- package/types/resources/Transaction.d.ts +276 -911
- package/types/resources/UnbilledCharge.d.ts +189 -164
- package/types/resources/Usage.d.ts +89 -279
- package/types/resources/VirtualBankAccount.d.ts +103 -255
- package/types/resources/filter.d.ts +52 -0
- package/.github/ISSUE_TEMPLATE/bug_report.yml +0 -81
- package/.github/ISSUE_TEMPLATE/config.yml +0 -6
- package/.github/ISSUE_TEMPLATE/feature_request.yml +0 -34
- package/.github/PULL_REQUEST_TEMPLATE.md +0 -8
- package/lib/chargebee.js +0 -512
- package/lib/resources/api_endpoints.js +0 -2935
- package/types/resources/NonSubscription.d.ts +0 -30
- package/types/resources/Session.d.ts +0 -41
|
@@ -1,173 +1,143 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
|
|
2
4
|
declare module 'chargebee' {
|
|
3
5
|
export interface InvoiceEstimate {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
round_off_amount?:number;
|
|
22
|
-
|
|
23
|
-
customer_id?:string;
|
|
24
|
-
|
|
25
|
-
line_items?:InvoiceEstimate.LineItem[];
|
|
26
|
-
|
|
27
|
-
discounts?:InvoiceEstimate.Discount[];
|
|
28
|
-
|
|
29
|
-
taxes?:InvoiceEstimate.Tax[];
|
|
30
|
-
|
|
31
|
-
line_item_taxes?:InvoiceEstimate.LineItemTax[];
|
|
32
|
-
|
|
33
|
-
line_item_tiers?:InvoiceEstimate.LineItemTier[];
|
|
34
|
-
|
|
35
|
-
line_item_discounts?:InvoiceEstimate.LineItemDiscount[];
|
|
6
|
+
recurring: boolean;
|
|
7
|
+
price_type: PriceType;
|
|
8
|
+
currency_code: string;
|
|
9
|
+
sub_total: number;
|
|
10
|
+
total?: number;
|
|
11
|
+
credits_applied?: number;
|
|
12
|
+
amount_paid?: number;
|
|
13
|
+
amount_due?: number;
|
|
14
|
+
line_items?: InvoiceEstimate.LineItem[];
|
|
15
|
+
discounts?: InvoiceEstimate.Discount[];
|
|
16
|
+
taxes?: InvoiceEstimate.Tax[];
|
|
17
|
+
line_item_taxes?: InvoiceEstimate.LineItemTax[];
|
|
18
|
+
line_item_tiers?: InvoiceEstimate.LineItemTier[];
|
|
19
|
+
line_item_discounts?: InvoiceEstimate.LineItemDiscount[];
|
|
20
|
+
round_off_amount?: number;
|
|
21
|
+
customer_id?: string;
|
|
36
22
|
}
|
|
37
|
-
export namespace InvoiceEstimate {
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
export interface LineItem {
|
|
41
|
-
id?:string;
|
|
42
|
-
|
|
43
|
-
subscription_id?:string;
|
|
44
|
-
|
|
45
|
-
date_from:number;
|
|
46
|
-
|
|
47
|
-
date_to:number;
|
|
48
|
-
|
|
49
|
-
unit_amount:number;
|
|
50
|
-
|
|
51
|
-
quantity?:number;
|
|
52
|
-
|
|
53
|
-
amount?:number;
|
|
54
|
-
|
|
55
|
-
pricing_model?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep';
|
|
56
|
-
|
|
57
|
-
is_taxed:boolean;
|
|
58
|
-
|
|
59
|
-
tax_amount?:number;
|
|
60
|
-
|
|
61
|
-
tax_rate?:number;
|
|
62
|
-
|
|
63
|
-
unit_amount_in_decimal?:string;
|
|
64
|
-
|
|
65
|
-
quantity_in_decimal?:string;
|
|
66
|
-
|
|
67
|
-
amount_in_decimal?:string;
|
|
68
|
-
|
|
69
|
-
discount_amount?:number;
|
|
70
|
-
|
|
71
|
-
item_level_discount_amount?:number;
|
|
72
23
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
24
|
+
export namespace InvoiceEstimate {
|
|
25
|
+
export interface LineItem {
|
|
26
|
+
id?: string;
|
|
27
|
+
subscription_id?: string;
|
|
28
|
+
date_from: number;
|
|
29
|
+
date_to: number;
|
|
30
|
+
unit_amount: number;
|
|
31
|
+
quantity?: number;
|
|
32
|
+
amount?: number;
|
|
33
|
+
pricing_model?:
|
|
34
|
+
| 'flat_fee'
|
|
35
|
+
| 'per_unit'
|
|
36
|
+
| 'tiered'
|
|
37
|
+
| 'volume'
|
|
38
|
+
| 'stairstep';
|
|
39
|
+
is_taxed: boolean;
|
|
40
|
+
tax_amount?: number;
|
|
41
|
+
tax_rate?: number;
|
|
42
|
+
unit_amount_in_decimal?: string;
|
|
43
|
+
quantity_in_decimal?: string;
|
|
44
|
+
amount_in_decimal?: string;
|
|
45
|
+
discount_amount?: number;
|
|
46
|
+
item_level_discount_amount?: number;
|
|
47
|
+
usage_percentage?: string;
|
|
48
|
+
reference_line_item_id?: string;
|
|
49
|
+
description: string;
|
|
50
|
+
entity_description?: string;
|
|
51
|
+
entity_type:
|
|
52
|
+
| 'adhoc'
|
|
53
|
+
| 'plan_item_price'
|
|
54
|
+
| 'addon_item_price'
|
|
55
|
+
| 'charge_item_price'
|
|
56
|
+
| 'plan_setup'
|
|
57
|
+
| 'plan'
|
|
58
|
+
| 'addon';
|
|
59
|
+
tax_exempt_reason?:
|
|
60
|
+
| 'tax_not_configured'
|
|
61
|
+
| 'region_non_taxable'
|
|
62
|
+
| 'export'
|
|
63
|
+
| 'customer_exempt'
|
|
64
|
+
| 'product_exempt'
|
|
65
|
+
| 'zero_rated'
|
|
66
|
+
| 'reverse_charge'
|
|
67
|
+
| 'high_value_physical_goods'
|
|
68
|
+
| 'zero_value_item'
|
|
69
|
+
| 'tax_not_configured_external_provider';
|
|
70
|
+
entity_id?: string;
|
|
71
|
+
customer_id?: string;
|
|
88
72
|
}
|
|
89
|
-
export interface Discount {
|
|
90
|
-
amount:number;
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
coupon_set_code?:string;
|
|
73
|
+
export interface Discount {
|
|
74
|
+
amount: number;
|
|
75
|
+
description?: string;
|
|
76
|
+
entity_type:
|
|
77
|
+
| 'item_level_coupon'
|
|
78
|
+
| 'document_level_coupon'
|
|
79
|
+
| 'promotional_credits'
|
|
80
|
+
| 'prorated_credits'
|
|
81
|
+
| 'item_level_discount'
|
|
82
|
+
| 'document_level_discount';
|
|
83
|
+
entity_id?: string;
|
|
84
|
+
coupon_set_code?: string;
|
|
103
85
|
}
|
|
104
|
-
export interface Tax {
|
|
105
|
-
name:string;
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
description?:string;
|
|
86
|
+
export interface Tax {
|
|
87
|
+
name: string;
|
|
88
|
+
amount: number;
|
|
89
|
+
description?: string;
|
|
110
90
|
}
|
|
111
|
-
export interface LineItemTax {
|
|
112
|
-
line_item_id?:string;
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
tax_juris_code?:string;
|
|
137
|
-
|
|
138
|
-
tax_amount_in_local_currency?:number;
|
|
139
|
-
|
|
140
|
-
local_currency_code?:string;
|
|
91
|
+
export interface LineItemTax {
|
|
92
|
+
line_item_id?: string;
|
|
93
|
+
tax_name: string;
|
|
94
|
+
tax_rate: number;
|
|
95
|
+
date_to?: number;
|
|
96
|
+
date_from?: number;
|
|
97
|
+
prorated_taxable_amount?: number;
|
|
98
|
+
is_partial_tax_applied?: boolean;
|
|
99
|
+
is_non_compliance_tax?: boolean;
|
|
100
|
+
taxable_amount: number;
|
|
101
|
+
tax_amount: number;
|
|
102
|
+
tax_juris_type?:
|
|
103
|
+
| 'country'
|
|
104
|
+
| 'federal'
|
|
105
|
+
| 'state'
|
|
106
|
+
| 'county'
|
|
107
|
+
| 'city'
|
|
108
|
+
| 'special'
|
|
109
|
+
| 'unincorporated'
|
|
110
|
+
| 'other';
|
|
111
|
+
tax_juris_name?: string;
|
|
112
|
+
tax_juris_code?: string;
|
|
113
|
+
tax_amount_in_local_currency?: number;
|
|
114
|
+
local_currency_code?: string;
|
|
141
115
|
}
|
|
142
|
-
export interface LineItemTier {
|
|
143
|
-
line_item_id?:string;
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
starting_unit_in_decimal?:string;
|
|
154
|
-
|
|
155
|
-
ending_unit_in_decimal?:string;
|
|
156
|
-
|
|
157
|
-
quantity_used_in_decimal?:string;
|
|
158
|
-
|
|
159
|
-
unit_amount_in_decimal?:string;
|
|
116
|
+
export interface LineItemTier {
|
|
117
|
+
line_item_id?: string;
|
|
118
|
+
starting_unit: number;
|
|
119
|
+
ending_unit?: number;
|
|
120
|
+
quantity_used: number;
|
|
121
|
+
unit_amount: number;
|
|
122
|
+
starting_unit_in_decimal?: string;
|
|
123
|
+
ending_unit_in_decimal?: string;
|
|
124
|
+
quantity_used_in_decimal?: string;
|
|
125
|
+
unit_amount_in_decimal?: string;
|
|
160
126
|
}
|
|
161
|
-
export interface LineItemDiscount {
|
|
162
|
-
line_item_id:string;
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
127
|
+
export interface LineItemDiscount {
|
|
128
|
+
line_item_id: string;
|
|
129
|
+
discount_type:
|
|
130
|
+
| 'item_level_coupon'
|
|
131
|
+
| 'document_level_coupon'
|
|
132
|
+
| 'promotional_credits'
|
|
133
|
+
| 'prorated_credits'
|
|
134
|
+
| 'item_level_discount'
|
|
135
|
+
| 'document_level_discount';
|
|
136
|
+
coupon_id?: string;
|
|
137
|
+
entity_id?: string;
|
|
138
|
+
discount_amount: number;
|
|
171
139
|
}
|
|
140
|
+
// REQUEST PARAMS
|
|
141
|
+
//---------------
|
|
172
142
|
}
|
|
173
|
-
}
|
|
143
|
+
}
|