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,36 +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 CustomerEntitlement {
6
- customer_id: string;
7
- subscription_id?: string;
8
- feature_id?: string;
9
- value?: string;
10
- name?: string;
11
- is_enabled: boolean;
12
- }
13
-
14
- export namespace CustomerEntitlement {
15
- export class CustomerEntitlementResource {
16
- entitlementsForCustomer(
17
- customer_id: string,
18
- input?: EntitlementsForCustomerInputParam,
19
- headers?: ChargebeeRequestHeader,
20
- ): Promise<ChargebeeResponse<EntitlementsForCustomerResponse>>;
21
- }
22
-
23
- export interface EntitlementsForCustomerResponse {
24
- list: { customer_entitlement: CustomerEntitlement }[];
25
- next_offset?: string;
26
- }
27
-
28
- // REQUEST PARAMS
29
- //---------------
30
-
31
- export interface EntitlementsForCustomerInputParam {
32
- limit?: number;
33
- offset?: string;
34
- }
35
- }
36
- }
@@ -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 DifferentialPrice {
6
- id: string;
7
- item_price_id: string;
8
- parent_item_id: string;
9
- price?: number;
10
- price_in_decimal?: string;
11
- status?: 'active' | 'deleted';
12
- resource_version?: number;
13
- updated_at?: number;
14
- created_at: number;
15
- modified_at: number;
16
- tiers?: DifferentialPrice.Tier[];
17
- currency_code: string;
18
- parent_periods?: DifferentialPrice.ParentPeriod[];
19
- }
20
-
21
- export namespace DifferentialPrice {
22
- export class DifferentialPriceResource {
23
- create(
24
- item_price_id: string,
25
- input: CreateInputParam,
26
- headers?: ChargebeeRequestHeader,
27
- ): Promise<ChargebeeResponse<CreateResponse>>;
28
-
29
- retrieve(
30
- differential_price_id: string,
31
- input: RetrieveInputParam,
32
- headers?: ChargebeeRequestHeader,
33
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
34
-
35
- update(
36
- differential_price_id: string,
37
- input: UpdateInputParam,
38
- headers?: ChargebeeRequestHeader,
39
- ): Promise<ChargebeeResponse<UpdateResponse>>;
40
-
41
- delete(
42
- differential_price_id: string,
43
- input: DeleteInputParam,
44
- headers?: ChargebeeRequestHeader,
45
- ): Promise<ChargebeeResponse<DeleteResponse>>;
46
-
47
- list(
48
- input?: ListInputParam,
49
- headers?: ChargebeeRequestHeader,
50
- ): Promise<ChargebeeResponse<ListResponse>>;
51
- }
52
-
53
- export interface CreateResponse {
54
- differential_price: DifferentialPrice;
55
- }
56
-
57
- export interface RetrieveResponse {
58
- differential_price: DifferentialPrice;
59
- }
60
-
61
- export interface UpdateResponse {
62
- differential_price: DifferentialPrice;
63
- }
64
-
65
- export interface DeleteResponse {
66
- differential_price: DifferentialPrice;
67
- }
68
-
69
- export interface ListResponse {
70
- list: { differential_price: DifferentialPrice }[];
71
- next_offset?: string;
72
- }
73
-
74
- export interface Tier {
75
- starting_unit: number;
76
- ending_unit?: number;
77
- price: number;
78
- starting_unit_in_decimal?: string;
79
- ending_unit_in_decimal?: string;
80
- price_in_decimal?: string;
81
- }
82
- export interface ParentPeriod {
83
- period_unit: 'day' | 'week' | 'month' | 'year';
84
- period?: any[];
85
- }
86
- // REQUEST PARAMS
87
- //---------------
88
-
89
- export interface CreateInputParam {
90
- parent_item_id: string;
91
- price?: number;
92
- price_in_decimal?: string;
93
- parent_periods?: ParentPeriodsCreateInputParam[];
94
- tiers?: TiersCreateInputParam[];
95
- }
96
- export interface RetrieveInputParam {
97
- item_price_id: string;
98
- }
99
- export interface UpdateInputParam {
100
- item_price_id: string;
101
- price?: number;
102
- price_in_decimal?: string;
103
- parent_periods?: ParentPeriodsUpdateInputParam[];
104
- tiers?: TiersUpdateInputParam[];
105
- }
106
- export interface DeleteInputParam {
107
- item_price_id: string;
108
- }
109
- export interface ListInputParam {
110
- limit?: number;
111
- offset?: string;
112
- item_price_id?: filter.String;
113
- item_id?: filter.String;
114
- id?: filter.String;
115
- parent_item_id?: filter.String;
116
- }
117
- export interface TiersCreateInputParam {
118
- starting_unit?: number;
119
- ending_unit?: number;
120
- price?: number;
121
- starting_unit_in_decimal?: string;
122
- ending_unit_in_decimal?: string;
123
- price_in_decimal?: string;
124
- }
125
- export interface ParentPeriodsCreateInputParam {
126
- period_unit: 'day' | 'week' | 'month' | 'year';
127
- period?: any;
128
- }
129
- export interface TiersUpdateInputParam {
130
- starting_unit?: number;
131
- ending_unit?: number;
132
- price?: number;
133
- starting_unit_in_decimal?: string;
134
- ending_unit_in_decimal?: string;
135
- price_in_decimal?: string;
136
- }
137
- export interface ParentPeriodsUpdateInputParam {
138
- period_unit: 'day' | 'week' | 'month' | 'year';
139
- period?: any;
140
- }
141
- }
142
- }
@@ -1,24 +0,0 @@
1
- ///<reference path='./../core.d.ts'/>
2
- ///<reference path='./../index.d.ts'/>
3
-
4
- declare module 'chargebee' {
5
- export interface Discount {
6
- id: string;
7
- invoice_name?: string;
8
- type: 'fixed_amount' | 'percentage';
9
- percentage?: number;
10
- amount?: number;
11
- currency_code?: string;
12
- duration_type: DurationType;
13
- period?: number;
14
- period_unit?: PeriodUnit;
15
- included_in_mrr: boolean;
16
- apply_on: ApplyOn;
17
- item_price_id?: string;
18
- created_at: number;
19
- apply_till?: number;
20
- applied_count?: number;
21
- coupon_id: string;
22
- index: number;
23
- }
24
- }
@@ -1,10 +0,0 @@
1
- ///<reference path='./../core.d.ts'/>
2
- ///<reference path='./../index.d.ts'/>
3
-
4
- declare module 'chargebee' {
5
- export interface Download {
6
- download_url: string;
7
- valid_till: number;
8
- mime_type?: string;
9
- }
10
- }
@@ -1,66 +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 Entitlement {
6
- id: string;
7
- entity_id?: string;
8
- entity_type?: 'plan' | 'addon' | 'charge' | 'plan_price' | 'addon_price';
9
- feature_id?: string;
10
- feature_name?: string;
11
- value?: string;
12
- name?: string;
13
- }
14
-
15
- export namespace Entitlement {
16
- export class EntitlementResource {
17
- list(
18
- input?: ListInputParam,
19
- headers?: ChargebeeRequestHeader,
20
- ): Promise<ChargebeeResponse<ListResponse>>;
21
-
22
- create(
23
- input: CreateInputParam,
24
- headers?: ChargebeeRequestHeader,
25
- ): Promise<ChargebeeResponse<CreateResponse>>;
26
- }
27
-
28
- export interface ListResponse {
29
- list: { entitlement: Entitlement }[];
30
- next_offset?: string;
31
- }
32
-
33
- export interface CreateResponse {
34
- entitlement: Entitlement;
35
- }
36
-
37
- // REQUEST PARAMS
38
- //---------------
39
-
40
- export interface ListInputParam {
41
- limit?: number;
42
- offset?: string;
43
- feature_id?: filter.String;
44
- entity_type?: filter.Enum;
45
- entity_id?: filter.String /**
46
- * @deprecated Please refer API docs to use other attributes
47
- */;
48
-
49
- include_drafts?: boolean /**
50
- * @deprecated Please refer API docs to use other attributes
51
- */;
52
-
53
- embed?: string;
54
- }
55
- export interface CreateInputParam {
56
- action: Action;
57
- entitlements?: EntitlementsCreateInputParam[];
58
- }
59
- export interface EntitlementsCreateInputParam {
60
- entity_id: string;
61
- feature_id: string;
62
- entity_type?: 'plan' | 'addon' | 'charge' | 'plan_price' | 'addon_price';
63
- value?: string;
64
- }
65
- }
66
- }
@@ -1,76 +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 EntitlementOverride {
6
- id: string;
7
- entity_id?: string;
8
- entity_type?: string;
9
- feature_id?: string;
10
- feature_name?: string;
11
- value?: string;
12
- name?: string;
13
- expires_at?: number;
14
- effective_from?: number;
15
- schedule_status?: 'activated' | 'scheduled' | 'failed';
16
- }
17
-
18
- export namespace EntitlementOverride {
19
- export class EntitlementOverrideResource {
20
- addEntitlementOverrideForSubscription(
21
- subscription_id: string,
22
- input: AddEntitlementOverrideForSubscriptionInputParam,
23
- headers?: ChargebeeRequestHeader,
24
- ): Promise<
25
- ChargebeeResponse<AddEntitlementOverrideForSubscriptionResponse>
26
- >;
27
-
28
- listEntitlementOverrideForSubscription(
29
- subscription_id: string,
30
- input?: ListEntitlementOverrideForSubscriptionInputParam,
31
- headers?: ChargebeeRequestHeader,
32
- ): Promise<
33
- ChargebeeResponse<ListEntitlementOverrideForSubscriptionResponse>
34
- >;
35
- }
36
-
37
- export interface AddEntitlementOverrideForSubscriptionResponse {
38
- entitlement_override: EntitlementOverride;
39
- }
40
-
41
- export interface ListEntitlementOverrideForSubscriptionResponse {
42
- list: { entitlement_override: EntitlementOverride }[];
43
- next_offset?: string;
44
- }
45
-
46
- // REQUEST PARAMS
47
- //---------------
48
-
49
- export interface AddEntitlementOverrideForSubscriptionInputParam {
50
- action?: Action;
51
- entitlement_overrides?: EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam[];
52
- }
53
- export interface ListEntitlementOverrideForSubscriptionInputParam {
54
- limit?: number;
55
- offset?: string /**
56
- * @deprecated Please refer API docs to use other attributes
57
- */;
58
-
59
- embed?: string /**
60
- * @deprecated Please refer API docs to use other attributes
61
- */;
62
-
63
- include_drafts?: boolean /**
64
- * @deprecated Please refer API docs to use other attributes
65
- */;
66
-
67
- include_scheduled_overrides?: boolean;
68
- }
69
- export interface EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam {
70
- feature_id: string;
71
- value?: string;
72
- expires_at?: number;
73
- effective_from?: number;
74
- }
75
- }
76
- }