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,209 +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 UnbilledCharge {
6
- id?: string;
7
- customer_id?: string;
8
- subscription_id?: string;
9
- date_from?: number;
10
- date_to?: number;
11
- unit_amount?: number;
12
- pricing_model?: PricingModel;
13
- quantity?: number;
14
- amount?: number;
15
- currency_code: string;
16
- discount_amount?: number;
17
- description?: string;
18
- entity_type:
19
- | 'adhoc'
20
- | 'plan_item_price'
21
- | 'addon_item_price'
22
- | 'charge_item_price'
23
- | 'plan_setup'
24
- | 'plan'
25
- | 'addon';
26
- entity_id?: string;
27
- is_voided: boolean;
28
- voided_at?: number;
29
- unit_amount_in_decimal?: string;
30
- quantity_in_decimal?: string;
31
- amount_in_decimal?: string;
32
- updated_at: number;
33
- tiers?: UnbilledCharge.Tier[];
34
- is_advance_charge?: boolean;
35
- business_entity_id?: string;
36
- deleted: boolean;
37
- }
38
-
39
- export namespace UnbilledCharge {
40
- export class UnbilledChargeResource {
41
- createUnbilledCharge(
42
- input: CreateUnbilledChargeInputParam,
43
- headers?: ChargebeeRequestHeader,
44
- ): Promise<ChargebeeResponse<CreateUnbilledChargeResponse>>;
45
-
46
- create(
47
- input: CreateInputParam,
48
- headers?: ChargebeeRequestHeader,
49
- ): Promise<ChargebeeResponse<CreateResponse>>;
50
-
51
- invoiceUnbilledCharges(
52
- input?: InvoiceUnbilledChargesInputParam,
53
- headers?: ChargebeeRequestHeader,
54
- ): Promise<ChargebeeResponse<InvoiceUnbilledChargesResponse>>;
55
-
56
- delete(
57
- unbilled_charge_id: string,
58
- headers?: ChargebeeRequestHeader,
59
- ): Promise<ChargebeeResponse<DeleteResponse>>;
60
-
61
- list(
62
- input?: ListInputParam,
63
- headers?: ChargebeeRequestHeader,
64
- ): Promise<ChargebeeResponse<ListResponse>>;
65
-
66
- invoiceNowEstimate(
67
- input?: InvoiceNowEstimateInputParam,
68
- headers?: ChargebeeRequestHeader,
69
- ): Promise<ChargebeeResponse<InvoiceNowEstimateResponse>>;
70
- }
71
-
72
- export interface CreateUnbilledChargeResponse {
73
- unbilled_charges: UnbilledCharge[];
74
- }
75
-
76
- export interface CreateResponse {
77
- unbilled_charges: UnbilledCharge[];
78
- }
79
-
80
- export interface InvoiceUnbilledChargesResponse {
81
- invoices: Invoice[];
82
- }
83
-
84
- export interface DeleteResponse {
85
- unbilled_charge: UnbilledCharge;
86
- }
87
-
88
- export interface ListResponse {
89
- list: { unbilled_charge: UnbilledCharge }[];
90
- next_offset?: string;
91
- }
92
-
93
- export interface InvoiceNowEstimateResponse {
94
- estimate: Estimate;
95
- }
96
-
97
- export interface Tier {
98
- starting_unit: number;
99
- ending_unit?: number;
100
- quantity_used: number;
101
- unit_amount: number;
102
- starting_unit_in_decimal?: string;
103
- ending_unit_in_decimal?: string;
104
- quantity_used_in_decimal?: string;
105
- unit_amount_in_decimal?: string;
106
- }
107
- // REQUEST PARAMS
108
- //---------------
109
-
110
- export interface CreateUnbilledChargeInputParam {
111
- subscription_id: string;
112
- currency_code?: string;
113
- addons?: AddonsCreateUnbilledChargeInputParam[];
114
- charges?: ChargesCreateUnbilledChargeInputParam[];
115
- tax_providers_fields?: TaxProvidersFieldsCreateUnbilledChargeInputParam[];
116
- }
117
- export interface CreateInputParam {
118
- subscription_id: string;
119
- currency_code?: string;
120
- item_prices?: ItemPricesCreateInputParam[];
121
- item_tiers?: ItemTiersCreateInputParam[];
122
- charges?: ChargesCreateInputParam[];
123
- tax_providers_fields?: TaxProvidersFieldsCreateInputParam[];
124
- }
125
- export interface InvoiceUnbilledChargesInputParam {
126
- subscription_id?: string;
127
- customer_id?: string;
128
- }
129
- export interface ListInputParam {
130
- limit?: number;
131
- offset?: string;
132
- include_deleted?: boolean;
133
- is_voided?: boolean;
134
- subscription_id?: filter.String;
135
- customer_id?: filter.String;
136
- }
137
- export interface InvoiceNowEstimateInputParam {
138
- subscription_id?: string;
139
- customer_id?: string;
140
- }
141
- export interface ChargesCreateUnbilledChargeInputParam {
142
- amount?: number;
143
- amount_in_decimal?: string;
144
- description?: string;
145
- taxable?: boolean;
146
- tax_profile_id?: string;
147
- avalara_tax_code?: string;
148
- hsn_code?: string;
149
- taxjar_product_code?: string;
150
- avalara_sale_type?: AvalaraSaleType;
151
- avalara_transaction_type?: number;
152
- avalara_service_type?: number;
153
- date_from?: number;
154
- date_to?: number;
155
- }
156
- export interface AddonsCreateUnbilledChargeInputParam {
157
- id?: string;
158
- quantity?: number;
159
- unit_price?: number;
160
- quantity_in_decimal?: string;
161
- unit_price_in_decimal?: string;
162
- date_from?: number;
163
- date_to?: number;
164
- }
165
- export interface TaxProvidersFieldsCreateUnbilledChargeInputParam {
166
- provider_name?: string;
167
- field_id?: string;
168
- field_value?: string;
169
- }
170
- export interface ChargesCreateInputParam {
171
- amount?: number;
172
- amount_in_decimal?: string;
173
- description?: string;
174
- taxable?: boolean;
175
- tax_profile_id?: string;
176
- avalara_tax_code?: string;
177
- hsn_code?: string;
178
- taxjar_product_code?: string;
179
- avalara_sale_type?: AvalaraSaleType;
180
- avalara_transaction_type?: number;
181
- avalara_service_type?: number;
182
- date_from?: number;
183
- date_to?: number;
184
- }
185
- export interface ItemTiersCreateInputParam {
186
- item_price_id?: string;
187
- starting_unit?: number;
188
- ending_unit?: number;
189
- price?: number;
190
- starting_unit_in_decimal?: string;
191
- ending_unit_in_decimal?: string;
192
- price_in_decimal?: string;
193
- }
194
- export interface ItemPricesCreateInputParam {
195
- item_price_id?: string;
196
- quantity?: number;
197
- quantity_in_decimal?: string;
198
- unit_price?: number;
199
- unit_price_in_decimal?: string;
200
- date_from?: number;
201
- date_to?: number;
202
- }
203
- export interface TaxProvidersFieldsCreateInputParam {
204
- provider_name?: string;
205
- field_id?: string;
206
- field_value?: string;
207
- }
208
- }
209
- }
@@ -1,113 +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 Usage {
6
- id?: string;
7
- usage_date: number;
8
- subscription_id: string;
9
- item_price_id: string;
10
- invoice_id?: string;
11
- line_item_id?: string;
12
- quantity: string;
13
- source?: Source;
14
- note?: string;
15
- resource_version?: number;
16
- updated_at?: number;
17
- created_at: number;
18
- }
19
-
20
- export namespace Usage {
21
- export class UsageResource {
22
- create(
23
- subscription_id: string,
24
- input: CreateInputParam,
25
- headers?: ChargebeeRequestHeader,
26
- ): Promise<ChargebeeResponse<CreateResponse>>;
27
-
28
- retrieve(
29
- subscription_id: string,
30
- input: RetrieveInputParam,
31
- headers?: ChargebeeRequestHeader,
32
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
33
-
34
- delete(
35
- subscription_id: string,
36
- input: DeleteInputParam,
37
- headers?: ChargebeeRequestHeader,
38
- ): Promise<ChargebeeResponse<DeleteResponse>>;
39
-
40
- list(
41
- input?: ListInputParam,
42
- headers?: ChargebeeRequestHeader,
43
- ): Promise<ChargebeeResponse<ListResponse>>;
44
-
45
- pdf(
46
- input: PdfInputParam,
47
- headers?: ChargebeeRequestHeader,
48
- ): Promise<ChargebeeResponse<PdfResponse>>;
49
- }
50
-
51
- export interface CreateResponse {
52
- usage: Usage;
53
- }
54
-
55
- export interface RetrieveResponse {
56
- usage: Usage;
57
- }
58
-
59
- export interface DeleteResponse {
60
- usage: Usage;
61
- }
62
-
63
- export interface ListResponse {
64
- list: { usage: Usage }[];
65
- next_offset?: string;
66
- }
67
-
68
- export interface PdfResponse {
69
- download: Download;
70
- }
71
-
72
- // REQUEST PARAMS
73
- //---------------
74
-
75
- export interface CreateInputParam {
76
- id?: string;
77
- item_price_id: string;
78
- quantity: string;
79
- usage_date: number /**
80
- * @deprecated Please refer API docs to use other attributes
81
- */;
82
-
83
- dedupe_option?: DedupeOption;
84
- note?: string;
85
- }
86
- export interface RetrieveInputParam {
87
- id: string;
88
- }
89
- export interface DeleteInputParam {
90
- id: string;
91
- }
92
- export interface ListInputParam {
93
- limit?: number;
94
- offset?: string;
95
- id?: filter.String;
96
- subscription_id?: filter.String;
97
- usage_date?: filter.Timestamp;
98
- updated_at?: filter.Timestamp;
99
- item_price_id?: filter.String;
100
- invoice_id?: filter.String;
101
- source?: filter.Enum;
102
- 'sort_by[asc]'?: string;
103
- 'sort_by[desc]'?: string;
104
- }
105
- export interface PdfInputParam {
106
- disposition_type?: DispositionType;
107
- invoice?: InvoicePdfInputParam;
108
- }
109
- export interface InvoicePdfInputParam {
110
- id: string;
111
- }
112
- }
113
- }
@@ -1,125 +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 VirtualBankAccount {
6
- id: string;
7
- customer_id: string;
8
- email: string;
9
- scheme?:
10
- | 'ach_credit'
11
- | 'sepa_credit'
12
- | 'us_automated_bank_transfer'
13
- | 'gb_automated_bank_transfer'
14
- | 'eu_automated_bank_transfer'
15
- | 'jp_automated_bank_transfer'
16
- | 'mx_automated_bank_transfer';
17
- bank_name?: string;
18
- account_number: string;
19
- routing_number?: string;
20
- swift_code: string;
21
- gateway: Gateway;
22
- gateway_account_id: string;
23
- resource_version?: number;
24
- updated_at?: number;
25
- created_at: number;
26
- reference_id: string;
27
- deleted: boolean;
28
- }
29
-
30
- export namespace VirtualBankAccount {
31
- export class VirtualBankAccountResource {
32
- createUsingPermanentToken(
33
- input: CreateUsingPermanentTokenInputParam,
34
- headers?: ChargebeeRequestHeader,
35
- ): Promise<ChargebeeResponse<CreateUsingPermanentTokenResponse>>;
36
-
37
- create(
38
- input: CreateInputParam,
39
- headers?: ChargebeeRequestHeader,
40
- ): Promise<ChargebeeResponse<CreateResponse>>;
41
-
42
- retrieve(
43
- virtual_bank_account_id: string,
44
- headers?: ChargebeeRequestHeader,
45
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
46
-
47
- list(
48
- input?: ListInputParam,
49
- headers?: ChargebeeRequestHeader,
50
- ): Promise<ChargebeeResponse<ListResponse>>;
51
-
52
- delete(
53
- virtual_bank_account_id: string,
54
- headers?: ChargebeeRequestHeader,
55
- ): Promise<ChargebeeResponse<DeleteResponse>>;
56
-
57
- deleteLocal(
58
- virtual_bank_account_id: string,
59
- headers?: ChargebeeRequestHeader,
60
- ): Promise<ChargebeeResponse<DeleteLocalResponse>>;
61
- }
62
-
63
- export interface CreateUsingPermanentTokenResponse {
64
- virtual_bank_account: VirtualBankAccount;
65
- customer?: Customer;
66
- }
67
-
68
- export interface CreateResponse {
69
- virtual_bank_account: VirtualBankAccount;
70
- customer?: Customer;
71
- }
72
-
73
- export interface RetrieveResponse {
74
- virtual_bank_account: VirtualBankAccount;
75
- }
76
-
77
- export interface ListResponse {
78
- list: { virtual_bank_account: VirtualBankAccount }[];
79
- next_offset?: string;
80
- }
81
-
82
- export interface DeleteResponse {
83
- virtual_bank_account: VirtualBankAccount;
84
- }
85
-
86
- export interface DeleteLocalResponse {
87
- virtual_bank_account: VirtualBankAccount;
88
- }
89
-
90
- // REQUEST PARAMS
91
- //---------------
92
-
93
- export interface CreateUsingPermanentTokenInputParam {
94
- customer_id: string;
95
- reference_id: string;
96
- scheme?:
97
- | 'ach_credit'
98
- | 'sepa_credit'
99
- | 'us_automated_bank_transfer'
100
- | 'gb_automated_bank_transfer'
101
- | 'eu_automated_bank_transfer'
102
- | 'jp_automated_bank_transfer'
103
- | 'mx_automated_bank_transfer';
104
- }
105
- export interface CreateInputParam {
106
- customer_id: string;
107
- email?: string;
108
- scheme?:
109
- | 'ach_credit'
110
- | 'sepa_credit'
111
- | 'us_automated_bank_transfer'
112
- | 'gb_automated_bank_transfer'
113
- | 'eu_automated_bank_transfer'
114
- | 'jp_automated_bank_transfer'
115
- | 'mx_automated_bank_transfer';
116
- }
117
- export interface ListInputParam {
118
- limit?: number;
119
- offset?: string;
120
- customer_id?: filter.String;
121
- updated_at?: filter.Timestamp;
122
- created_at?: filter.Timestamp;
123
- }
124
- }
125
- }
@@ -1,52 +0,0 @@
1
- declare module 'chargebee' {
2
- export namespace filter {
3
- export interface String {
4
- is?: string;
5
- is_not?: string;
6
- starts_with?: string;
7
- is_present?: boolean;
8
- in?: string[];
9
- not_in?: string[];
10
- }
11
-
12
- export interface Timestamp {
13
- on?: number;
14
- before?: number;
15
- after?: number;
16
- between?: [number, number];
17
- is_present?: boolean;
18
- }
19
-
20
- export interface Date {
21
- on?: number;
22
- before?: number;
23
- after?: number;
24
- between?: [number, number];
25
- is_present?: boolean;
26
- }
27
-
28
- export interface Number {
29
- gt?: number;
30
- lt?: number;
31
- gte?: number;
32
- lte?: number;
33
- between?: [number, number];
34
- is?: number;
35
- is_not?: number;
36
- is_present?: number;
37
- }
38
-
39
- export interface Boolean {
40
- is?: boolean;
41
- is_present?: boolean;
42
- }
43
-
44
- export interface Enum {
45
- is?: any;
46
- is_not?: any;
47
- is_present?: any;
48
- in?: any[];
49
- not_in?: any[];
50
- }
51
- }
52
- }