chargebee 2.52.0 → 2.53.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.
- package/CHANGELOG.md +56 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +90 -5
- package/package.json +1 -1
- package/types/core.d.ts +2 -2
- package/types/index.d.ts +8 -0
- package/types/resources/Addon.d.ts +3 -3
- package/types/resources/AttachedItem.d.ts +1 -1
- package/types/resources/BusinessEntity.d.ts +2 -2
- package/types/resources/Comment.d.ts +5 -3
- package/types/resources/Coupon.d.ts +4 -4
- package/types/resources/CouponCode.d.ts +1 -1
- package/types/resources/CouponSet.d.ts +1 -1
- package/types/resources/CreditNote.d.ts +89 -89
- package/types/resources/Customer.d.ts +7 -7
- package/types/resources/CustomerEntitlement.d.ts +3 -1
- package/types/resources/DifferentialPrice.d.ts +1 -1
- package/types/resources/Discount.d.ts +3 -1
- package/types/resources/Entitlement.d.ts +1 -1
- package/types/resources/EntitlementOverride.d.ts +1 -1
- package/types/resources/Estimate.d.ts +4 -4
- package/types/resources/Event.d.ts +3 -3
- package/types/resources/Feature.d.ts +3 -3
- package/types/resources/Gift.d.ts +1 -1
- package/types/resources/HostedPage.d.ts +4 -4
- package/types/resources/ImpactedCustomer.d.ts +23 -0
- package/types/resources/Invoice.d.ts +110 -110
- package/types/resources/Item.d.ts +4 -4
- package/types/resources/ItemEntitlement.d.ts +2 -2
- package/types/resources/ItemFamily.d.ts +3 -3
- package/types/resources/ItemPrice.d.ts +7 -7
- package/types/resources/OmnichannelOneTimeOrder.d.ts +90 -0
- package/types/resources/OmnichannelOneTimeOrderItem.d.ts +24 -0
- package/types/resources/OmnichannelSubscription.d.ts +2 -2
- package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -1
- package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +1 -1
- package/types/resources/Order.d.ts +3 -3
- package/types/resources/PaymentSource.d.ts +2 -2
- package/types/resources/PaymentVoucher.d.ts +4 -4
- package/types/resources/Plan.d.ts +3 -3
- package/types/resources/PriceVariant.d.ts +2 -2
- package/types/resources/PricingPageSession.d.ts +2 -2
- package/types/resources/PromotionalCredit.d.ts +3 -1
- package/types/resources/Purchase.d.ts +2 -2
- package/types/resources/Quote.d.ts +13 -13
- package/types/resources/QuotedCharge.d.ts +7 -0
- package/types/resources/Ramp.d.ts +7 -7
- package/types/resources/RecordedPurchase.d.ts +6 -1
- package/types/resources/SiteMigrationDetail.d.ts +1 -1
- package/types/resources/Subscription.d.ts +22 -20
- package/types/resources/SubscriptionEntitlement.d.ts +1 -1
- package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
- package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
- package/types/resources/Transaction.d.ts +6 -6
- package/types/resources/UnbilledCharge.d.ts +1 -1
- package/types/resources/Usage.d.ts +2 -2
- package/types/resources/UsageFile.d.ts +5 -5
- package/types/resources/VirtualBankAccount.d.ts +1 -1
- package/types/resources/WebhookEndpoint.d.ts +117 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
declare module 'chargebee' {
|
|
4
|
+
export interface ImpactedCustomer {
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
action_type?:string;
|
|
8
|
+
|
|
9
|
+
download?:ImpactedCustomer.Download;
|
|
10
|
+
|
|
11
|
+
}
|
|
12
|
+
export namespace ImpactedCustomer {
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
export interface Download {
|
|
16
|
+
download_url:string;
|
|
17
|
+
|
|
18
|
+
valid_till:number;
|
|
19
|
+
|
|
20
|
+
mime_type?:string;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
@@ -6,44 +6,58 @@ declare module 'chargebee' {
|
|
|
6
6
|
|
|
7
7
|
id:string;
|
|
8
8
|
|
|
9
|
-
po_number?:string;
|
|
10
|
-
|
|
11
9
|
customer_id:string;
|
|
12
10
|
|
|
11
|
+
payment_owner?:string;
|
|
12
|
+
|
|
13
13
|
subscription_id?:string;
|
|
14
14
|
|
|
15
15
|
recurring:boolean;
|
|
16
16
|
|
|
17
17
|
status:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending';
|
|
18
18
|
|
|
19
|
-
vat_number?:string;
|
|
20
|
-
|
|
21
|
-
price_type:PriceType;
|
|
22
|
-
|
|
23
19
|
date?:number;
|
|
24
20
|
|
|
25
21
|
due_date?:number;
|
|
26
22
|
|
|
27
23
|
net_term_days?:number;
|
|
28
24
|
|
|
25
|
+
po_number?:string;
|
|
26
|
+
|
|
27
|
+
vat_number?:string;
|
|
28
|
+
|
|
29
|
+
price_type:PriceType;
|
|
30
|
+
|
|
29
31
|
exchange_rate?:number;
|
|
30
32
|
|
|
33
|
+
local_currency_exchange_rate?:number;
|
|
34
|
+
|
|
31
35
|
currency_code:string;
|
|
32
36
|
|
|
33
|
-
|
|
37
|
+
local_currency_code?:string;
|
|
34
38
|
|
|
35
|
-
|
|
39
|
+
tax:number;
|
|
36
40
|
|
|
37
|
-
|
|
41
|
+
sub_total:number;
|
|
38
42
|
|
|
39
|
-
|
|
43
|
+
sub_total_in_local_currency?:number;
|
|
40
44
|
|
|
41
|
-
|
|
45
|
+
total?:number;
|
|
46
|
+
|
|
47
|
+
total_in_local_currency?:number;
|
|
42
48
|
|
|
43
49
|
amount_due?:number;
|
|
44
50
|
|
|
51
|
+
amount_adjusted?:number;
|
|
52
|
+
|
|
53
|
+
amount_paid?:number;
|
|
54
|
+
|
|
45
55
|
paid_at?:number;
|
|
46
56
|
|
|
57
|
+
write_off_amount?:number;
|
|
58
|
+
|
|
59
|
+
credits_applied?:number;
|
|
60
|
+
|
|
47
61
|
dunning_status?:'in_progress' | 'exhausted' | 'stopped' | 'success';
|
|
48
62
|
|
|
49
63
|
next_retry_at?:number;
|
|
@@ -54,18 +68,6 @@ declare module 'chargebee' {
|
|
|
54
68
|
|
|
55
69
|
updated_at?:number;
|
|
56
70
|
|
|
57
|
-
sub_total:number;
|
|
58
|
-
|
|
59
|
-
sub_total_in_local_currency?:number;
|
|
60
|
-
|
|
61
|
-
total_in_local_currency?:number;
|
|
62
|
-
|
|
63
|
-
local_currency_code?:string;
|
|
64
|
-
|
|
65
|
-
tax:number;
|
|
66
|
-
|
|
67
|
-
local_currency_exchange_rate?:number;
|
|
68
|
-
|
|
69
71
|
first_invoice?:boolean;
|
|
70
72
|
|
|
71
73
|
new_sales_amount?:number;
|
|
@@ -86,17 +88,21 @@ declare module 'chargebee' {
|
|
|
86
88
|
|
|
87
89
|
line_items?:Invoice.LineItem[];
|
|
88
90
|
|
|
89
|
-
|
|
91
|
+
line_item_tiers?:Invoice.LineItemTier[];
|
|
90
92
|
|
|
91
93
|
line_item_discounts?:Invoice.LineItemDiscount[];
|
|
92
94
|
|
|
93
|
-
taxes?:Invoice.Tax[];
|
|
94
|
-
|
|
95
95
|
line_item_taxes?:Invoice.LineItemTax[];
|
|
96
96
|
|
|
97
97
|
line_item_credits?:Invoice.LineItemCredit[];
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
line_item_addresses?:Invoice.LineItemAddress[];
|
|
100
|
+
|
|
101
|
+
discounts?:Invoice.Discount[];
|
|
102
|
+
|
|
103
|
+
taxes?:Invoice.Tax[];
|
|
104
|
+
|
|
105
|
+
tax_origin?:Invoice.TaxOrigin;
|
|
100
106
|
|
|
101
107
|
linked_payments?:Invoice.LinkedPayment[];
|
|
102
108
|
|
|
@@ -114,13 +120,11 @@ declare module 'chargebee' {
|
|
|
114
120
|
|
|
115
121
|
shipping_address?:Invoice.ShippingAddress;
|
|
116
122
|
|
|
117
|
-
statement_descriptor?:Invoice.StatementDescriptor;
|
|
118
|
-
|
|
119
123
|
billing_address?:Invoice.BillingAddress;
|
|
120
124
|
|
|
121
|
-
|
|
125
|
+
statement_descriptor?:Invoice.StatementDescriptor;
|
|
122
126
|
|
|
123
|
-
|
|
127
|
+
einvoice?:Invoice.Einvoice;
|
|
124
128
|
|
|
125
129
|
void_reason_code?:string;
|
|
126
130
|
|
|
@@ -136,10 +140,6 @@ declare module 'chargebee' {
|
|
|
136
140
|
|
|
137
141
|
site_details_at_creation?:Invoice.SiteDetailsAtCreation;
|
|
138
142
|
|
|
139
|
-
tax_origin?:Invoice.TaxOrigin;
|
|
140
|
-
|
|
141
|
-
line_item_addresses?:Invoice.LineItemAddress[];
|
|
142
|
-
|
|
143
143
|
}
|
|
144
144
|
export namespace Invoice {
|
|
145
145
|
export class InvoiceResource {
|
|
@@ -307,7 +307,7 @@ declare module 'chargebee' {
|
|
|
307
307
|
|
|
308
308
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
309
309
|
|
|
310
|
-
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
310
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
|
|
311
311
|
|
|
312
312
|
customer_id?:string;
|
|
313
313
|
|
|
@@ -476,7 +476,7 @@ declare module 'chargebee' {
|
|
|
476
476
|
|
|
477
477
|
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
478
478
|
|
|
479
|
-
line_items:{amount?:number,amount_in_decimal?:string,created_at?:number,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
479
|
+
line_items:{amount?:number,amount_in_decimal?:string,created_at?:number,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
480
480
|
|
|
481
481
|
payment_reference_numbers:{id?:string,number:string,type:'kid' | 'ocr' | 'frn' | 'fik' | 'swiss_reference'}[];
|
|
482
482
|
|
|
@@ -486,9 +486,9 @@ declare module 'chargebee' {
|
|
|
486
486
|
|
|
487
487
|
taxes:{amount?:number,description?:string,juris_code?:string,juris_name?:string,juris_type?:'country' | 'federal' | 'state' | 'county' | 'city' | 'special' | 'unincorporated' | 'other',name:string,rate:number}[];
|
|
488
488
|
|
|
489
|
-
payments:{amount:number,date?:number,payment_method:PaymentMethod,reference_number?:string}[];
|
|
489
|
+
payments:{amount:number,date?:number,id?:string,payment_method:PaymentMethod,reference_number?:string}[];
|
|
490
490
|
|
|
491
|
-
notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',note?:string}[];
|
|
491
|
+
notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan' | 'addon',note?:string}[];
|
|
492
492
|
|
|
493
493
|
line_item_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,line_item_id?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
|
|
494
494
|
|
|
@@ -580,7 +580,7 @@ declare module 'chargebee' {
|
|
|
580
580
|
limit?:number;
|
|
581
581
|
|
|
582
582
|
/**
|
|
583
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
583
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
584
584
|
|
|
585
585
|
*/
|
|
586
586
|
|
|
@@ -736,7 +736,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
736
736
|
|
|
737
737
|
void_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
738
738
|
|
|
739
|
-
sort_by?:
|
|
739
|
+
sort_by?:object;
|
|
740
740
|
}
|
|
741
741
|
export interface InvoicesForCustomerResponse {
|
|
742
742
|
list:{invoice:Invoice}[];
|
|
@@ -753,7 +753,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
753
753
|
limit?:number;
|
|
754
754
|
|
|
755
755
|
/**
|
|
756
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
756
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
757
757
|
|
|
758
758
|
*/
|
|
759
759
|
|
|
@@ -774,7 +774,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
774
774
|
limit?:number;
|
|
775
775
|
|
|
776
776
|
/**
|
|
777
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
777
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
778
778
|
|
|
779
779
|
*/
|
|
780
780
|
|
|
@@ -813,7 +813,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
813
813
|
limit?:number;
|
|
814
814
|
|
|
815
815
|
/**
|
|
816
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
816
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
817
817
|
|
|
818
818
|
*/
|
|
819
819
|
|
|
@@ -1122,18 +1122,28 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
1122
1122
|
|
|
1123
1123
|
customer_id?:string;
|
|
1124
1124
|
}
|
|
1125
|
-
export interface
|
|
1126
|
-
|
|
1125
|
+
export interface LineItemTier {
|
|
1126
|
+
line_item_id?:string;
|
|
1127
1127
|
|
|
1128
|
-
|
|
1128
|
+
starting_unit:number;
|
|
1129
1129
|
|
|
1130
|
-
|
|
1130
|
+
ending_unit?:number;
|
|
1131
1131
|
|
|
1132
|
-
|
|
1132
|
+
quantity_used:number;
|
|
1133
1133
|
|
|
1134
|
-
|
|
1134
|
+
unit_amount:number;
|
|
1135
1135
|
|
|
1136
|
-
|
|
1136
|
+
starting_unit_in_decimal?:string;
|
|
1137
|
+
|
|
1138
|
+
ending_unit_in_decimal?:string;
|
|
1139
|
+
|
|
1140
|
+
quantity_used_in_decimal?:string;
|
|
1141
|
+
|
|
1142
|
+
unit_amount_in_decimal?:string;
|
|
1143
|
+
|
|
1144
|
+
pricing_type?:'per_unit' | 'flat_fee' | 'package';
|
|
1145
|
+
|
|
1146
|
+
package_size?:number;
|
|
1137
1147
|
}
|
|
1138
1148
|
export interface LineItemDiscount {
|
|
1139
1149
|
line_item_id:string;
|
|
@@ -1146,13 +1156,6 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
1146
1156
|
|
|
1147
1157
|
discount_amount:number;
|
|
1148
1158
|
}
|
|
1149
|
-
export interface Tax {
|
|
1150
|
-
name:string;
|
|
1151
|
-
|
|
1152
|
-
amount:number;
|
|
1153
|
-
|
|
1154
|
-
description?:string;
|
|
1155
|
-
}
|
|
1156
1159
|
export interface LineItemTax {
|
|
1157
1160
|
line_item_id?:string;
|
|
1158
1161
|
|
|
@@ -1191,28 +1194,61 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
1191
1194
|
|
|
1192
1195
|
line_item_id?:string;
|
|
1193
1196
|
}
|
|
1194
|
-
export interface
|
|
1197
|
+
export interface LineItemAddress {
|
|
1195
1198
|
line_item_id?:string;
|
|
1196
1199
|
|
|
1197
|
-
|
|
1200
|
+
first_name?:string;
|
|
1198
1201
|
|
|
1199
|
-
|
|
1202
|
+
last_name?:string;
|
|
1200
1203
|
|
|
1201
|
-
|
|
1204
|
+
email?:string;
|
|
1202
1205
|
|
|
1203
|
-
|
|
1206
|
+
company?:string;
|
|
1204
1207
|
|
|
1205
|
-
|
|
1208
|
+
phone?:string;
|
|
1206
1209
|
|
|
1207
|
-
|
|
1210
|
+
line1?:string;
|
|
1208
1211
|
|
|
1209
|
-
|
|
1212
|
+
line2?:string;
|
|
1210
1213
|
|
|
1211
|
-
|
|
1214
|
+
line3?:string;
|
|
1212
1215
|
|
|
1213
|
-
|
|
1216
|
+
city?:string;
|
|
1214
1217
|
|
|
1215
|
-
|
|
1218
|
+
state_code?:string;
|
|
1219
|
+
|
|
1220
|
+
state?:string;
|
|
1221
|
+
|
|
1222
|
+
country?:string;
|
|
1223
|
+
|
|
1224
|
+
zip?:string;
|
|
1225
|
+
|
|
1226
|
+
validation_status?:'not_validated' | 'valid' | 'partially_valid' | 'invalid';
|
|
1227
|
+
}
|
|
1228
|
+
export interface Discount {
|
|
1229
|
+
amount:number;
|
|
1230
|
+
|
|
1231
|
+
description?:string;
|
|
1232
|
+
|
|
1233
|
+
entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
1234
|
+
|
|
1235
|
+
discount_type?:'fixed_amount' | 'percentage';
|
|
1236
|
+
|
|
1237
|
+
entity_id?:string;
|
|
1238
|
+
|
|
1239
|
+
coupon_set_code?:string;
|
|
1240
|
+
}
|
|
1241
|
+
export interface Tax {
|
|
1242
|
+
name:string;
|
|
1243
|
+
|
|
1244
|
+
amount:number;
|
|
1245
|
+
|
|
1246
|
+
description?:string;
|
|
1247
|
+
}
|
|
1248
|
+
export interface TaxOrigin {
|
|
1249
|
+
country?:string;
|
|
1250
|
+
|
|
1251
|
+
registration_number?:string;
|
|
1216
1252
|
}
|
|
1217
1253
|
export interface LinkedPayment {
|
|
1218
1254
|
txn_id:string;
|
|
@@ -1338,11 +1374,6 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
1338
1374
|
|
|
1339
1375
|
index:number;
|
|
1340
1376
|
}
|
|
1341
|
-
export interface StatementDescriptor {
|
|
1342
|
-
id:string;
|
|
1343
|
-
|
|
1344
|
-
descriptor?:string;
|
|
1345
|
-
}
|
|
1346
1377
|
export interface BillingAddress {
|
|
1347
1378
|
first_name?:string;
|
|
1348
1379
|
|
|
@@ -1372,6 +1403,11 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
1372
1403
|
|
|
1373
1404
|
validation_status?:ValidationStatus;
|
|
1374
1405
|
}
|
|
1406
|
+
export interface StatementDescriptor {
|
|
1407
|
+
id:string;
|
|
1408
|
+
|
|
1409
|
+
descriptor?:string;
|
|
1410
|
+
}
|
|
1375
1411
|
export interface Einvoice {
|
|
1376
1412
|
id:string;
|
|
1377
1413
|
|
|
@@ -1386,41 +1422,5 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
1386
1422
|
|
|
1387
1423
|
organization_address?:object;
|
|
1388
1424
|
}
|
|
1389
|
-
export interface TaxOrigin {
|
|
1390
|
-
country?:string;
|
|
1391
|
-
|
|
1392
|
-
registration_number?:string;
|
|
1393
|
-
}
|
|
1394
|
-
export interface LineItemAddress {
|
|
1395
|
-
line_item_id?:string;
|
|
1396
|
-
|
|
1397
|
-
first_name?:string;
|
|
1398
|
-
|
|
1399
|
-
last_name?:string;
|
|
1400
|
-
|
|
1401
|
-
email?:string;
|
|
1402
|
-
|
|
1403
|
-
company?:string;
|
|
1404
|
-
|
|
1405
|
-
phone?:string;
|
|
1406
|
-
|
|
1407
|
-
line1?:string;
|
|
1408
|
-
|
|
1409
|
-
line2?:string;
|
|
1410
|
-
|
|
1411
|
-
line3?:string;
|
|
1412
|
-
|
|
1413
|
-
city?:string;
|
|
1414
|
-
|
|
1415
|
-
state_code?:string;
|
|
1416
|
-
|
|
1417
|
-
state?:string;
|
|
1418
|
-
|
|
1419
|
-
country?:string;
|
|
1420
|
-
|
|
1421
|
-
zip?:string;
|
|
1422
|
-
|
|
1423
|
-
validation_status?:'not_validated' | 'valid' | 'partially_valid' | 'invalid';
|
|
1424
|
-
}
|
|
1425
1425
|
}
|
|
1426
1426
|
}
|
|
@@ -79,7 +79,7 @@ declare module 'chargebee' {
|
|
|
79
79
|
item:Item;
|
|
80
80
|
}
|
|
81
81
|
export interface CreateInputParam {
|
|
82
|
-
|
|
82
|
+
|
|
83
83
|
bundle_configuration?:{type?:'fixed'};
|
|
84
84
|
|
|
85
85
|
bundle_items_to_add?:{item_id?:string,item_type?:ItemType,price_allocation?:number,quantity?:number}[];
|
|
@@ -134,7 +134,7 @@ declare module 'chargebee' {
|
|
|
134
134
|
item:Item;
|
|
135
135
|
}
|
|
136
136
|
export interface UpdateInputParam {
|
|
137
|
-
|
|
137
|
+
|
|
138
138
|
bundle_configuration?:{type?:'fixed'};
|
|
139
139
|
|
|
140
140
|
bundle_items_to_add?:{item_id?:string,item_type?:ItemType,price_allocation?:number,quantity?:number}[];
|
|
@@ -192,7 +192,7 @@ declare module 'chargebee' {
|
|
|
192
192
|
limit?:number;
|
|
193
193
|
|
|
194
194
|
/**
|
|
195
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
195
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
196
196
|
|
|
197
197
|
*/
|
|
198
198
|
|
|
@@ -310,7 +310,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
310
310
|
|
|
311
311
|
include_site_level_resources?:{is?:'true' | 'false'};
|
|
312
312
|
|
|
313
|
-
sort_by?:
|
|
313
|
+
sort_by?:object;
|
|
314
314
|
}
|
|
315
315
|
export interface DeleteResponse {
|
|
316
316
|
item:Item;
|
|
@@ -44,7 +44,7 @@ declare module 'chargebee' {
|
|
|
44
44
|
limit?:number;
|
|
45
45
|
|
|
46
46
|
/**
|
|
47
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
47
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
48
48
|
|
|
49
49
|
*/
|
|
50
50
|
|
|
@@ -69,7 +69,7 @@ declare module 'chargebee' {
|
|
|
69
69
|
limit?:number;
|
|
70
70
|
|
|
71
71
|
/**
|
|
72
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
72
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
73
73
|
|
|
74
74
|
*/
|
|
75
75
|
|
|
@@ -39,7 +39,7 @@ declare module 'chargebee' {
|
|
|
39
39
|
item_family:ItemFamily;
|
|
40
40
|
}
|
|
41
41
|
export interface CreateInputParam {
|
|
42
|
-
|
|
42
|
+
|
|
43
43
|
id:string;
|
|
44
44
|
|
|
45
45
|
name:string;
|
|
@@ -67,7 +67,7 @@ declare module 'chargebee' {
|
|
|
67
67
|
limit?:number;
|
|
68
68
|
|
|
69
69
|
/**
|
|
70
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
70
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
71
71
|
|
|
72
72
|
*/
|
|
73
73
|
|
|
@@ -111,7 +111,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
111
111
|
item_family:ItemFamily;
|
|
112
112
|
}
|
|
113
113
|
export interface UpdateInputParam {
|
|
114
|
-
|
|
114
|
+
|
|
115
115
|
name?:string;
|
|
116
116
|
|
|
117
117
|
description?:string;
|
|
@@ -111,7 +111,7 @@ declare module 'chargebee' {
|
|
|
111
111
|
item_price:ItemPrice;
|
|
112
112
|
}
|
|
113
113
|
export interface CreateInputParam {
|
|
114
|
-
|
|
114
|
+
|
|
115
115
|
tax_detail?:{avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,hsn_code?:string,tax_profile_id?:string,taxjar_product_code?:string};
|
|
116
116
|
|
|
117
117
|
accounting_detail?:{accounting_category1?:string,accounting_category2?:string,accounting_category3?:string,accounting_category4?:string,accounting_code?:string,sku?:string};
|
|
@@ -260,7 +260,7 @@ declare module 'chargebee' {
|
|
|
260
260
|
limit?:number;
|
|
261
261
|
|
|
262
262
|
/**
|
|
263
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
263
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
264
264
|
|
|
265
265
|
*/
|
|
266
266
|
|
|
@@ -384,7 +384,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
384
384
|
|
|
385
385
|
channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string};
|
|
386
386
|
|
|
387
|
-
sort_by?:
|
|
387
|
+
sort_by?:object;
|
|
388
388
|
}
|
|
389
389
|
export interface DeleteResponse {
|
|
390
390
|
item_price:ItemPrice;
|
|
@@ -405,13 +405,13 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
405
405
|
limit?:number;
|
|
406
406
|
|
|
407
407
|
/**
|
|
408
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
408
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
409
409
|
|
|
410
410
|
*/
|
|
411
411
|
|
|
412
412
|
offset?:string;
|
|
413
413
|
|
|
414
|
-
sort_by?:
|
|
414
|
+
sort_by?:object;
|
|
415
415
|
}
|
|
416
416
|
export interface FindApplicableItemPricesResponse {
|
|
417
417
|
list:{item_price:ItemPrice}[];
|
|
@@ -428,7 +428,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
428
428
|
limit?:number;
|
|
429
429
|
|
|
430
430
|
/**
|
|
431
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
431
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
432
432
|
|
|
433
433
|
*/
|
|
434
434
|
|
|
@@ -436,7 +436,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
436
436
|
|
|
437
437
|
item_id?:string;
|
|
438
438
|
|
|
439
|
-
sort_by?:
|
|
439
|
+
sort_by?:object;
|
|
440
440
|
}
|
|
441
441
|
export interface Tier {
|
|
442
442
|
starting_unit:number;
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
declare module 'chargebee' {
|
|
4
|
+
export interface OmnichannelOneTimeOrder {
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
id:string;
|
|
8
|
+
|
|
9
|
+
app_id:string;
|
|
10
|
+
|
|
11
|
+
customer_id?:string;
|
|
12
|
+
|
|
13
|
+
id_at_source:string;
|
|
14
|
+
|
|
15
|
+
origin?:string;
|
|
16
|
+
|
|
17
|
+
source:'apple_app_store' | 'google_play_store';
|
|
18
|
+
|
|
19
|
+
created_at:number;
|
|
20
|
+
|
|
21
|
+
resource_version?:number;
|
|
22
|
+
|
|
23
|
+
omnichannel_one_time_order_items:OmnichannelOneTimeOrderItem[];
|
|
24
|
+
|
|
25
|
+
purchase_transaction?:OmnichannelOneTimeOrder.OmnichannelTransaction;
|
|
26
|
+
|
|
27
|
+
}
|
|
28
|
+
export namespace OmnichannelOneTimeOrder {
|
|
29
|
+
export class OmnichannelOneTimeOrderResource {
|
|
30
|
+
retrieve(omnichannel_one_time_order_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
31
|
+
|
|
32
|
+
list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
|
|
33
|
+
}
|
|
34
|
+
export interface RetrieveResponse {
|
|
35
|
+
omnichannel_one_time_order:OmnichannelOneTimeOrder;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export interface ListResponse {
|
|
39
|
+
list:{omnichannel_one_time_order:OmnichannelOneTimeOrder}[];
|
|
40
|
+
|
|
41
|
+
next_offset?:string;
|
|
42
|
+
}
|
|
43
|
+
export interface ListInputParam {
|
|
44
|
+
[key : string]: any;
|
|
45
|
+
/**
|
|
46
|
+
* @description The number of resources to be returned.
|
|
47
|
+
|
|
48
|
+
*/
|
|
49
|
+
|
|
50
|
+
limit?:number;
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
54
|
+
|
|
55
|
+
*/
|
|
56
|
+
|
|
57
|
+
offset?:string;
|
|
58
|
+
|
|
59
|
+
source?:{in?:string,is?:'apple_app_store' | 'google_play_store',is_not?:'apple_app_store' | 'google_play_store',not_in?:string};
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* @description Chargebee Customer External Identifier
|
|
63
|
+
|
|
64
|
+
*/
|
|
65
|
+
|
|
66
|
+
customer_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
67
|
+
}
|
|
68
|
+
export interface OmnichannelTransaction {
|
|
69
|
+
id:string;
|
|
70
|
+
|
|
71
|
+
id_at_source:string;
|
|
72
|
+
|
|
73
|
+
app_id:string;
|
|
74
|
+
|
|
75
|
+
price_currency?:string;
|
|
76
|
+
|
|
77
|
+
price_units?:number;
|
|
78
|
+
|
|
79
|
+
price_nanos?:number;
|
|
80
|
+
|
|
81
|
+
type:'purchase' | 'renewal';
|
|
82
|
+
|
|
83
|
+
transacted_at?:number;
|
|
84
|
+
|
|
85
|
+
created_at:number;
|
|
86
|
+
|
|
87
|
+
resource_version?:number;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
declare module 'chargebee' {
|
|
4
|
+
export interface OmnichannelOneTimeOrderItem {
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
id:string;
|
|
8
|
+
|
|
9
|
+
item_id_at_source:string;
|
|
10
|
+
|
|
11
|
+
item_type_at_source?:string;
|
|
12
|
+
|
|
13
|
+
quantity?:number;
|
|
14
|
+
|
|
15
|
+
cancelled_at?:number;
|
|
16
|
+
|
|
17
|
+
cancellation_reason?:'customer_cancelled' | 'customer_did_not_consent_to_price_increase' | 'refunded_due_to_app_issue' | 'refunded_for_other_reason' | 'merchant_revoked';
|
|
18
|
+
|
|
19
|
+
created_at:number;
|
|
20
|
+
|
|
21
|
+
resource_version?:number;
|
|
22
|
+
|
|
23
|
+
}
|
|
24
|
+
}
|