chargebee 2.51.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.
Files changed (89) hide show
  1. package/CHANGELOG.md +83 -0
  2. package/lib/chargebee.js +1 -1
  3. package/lib/resources/api_endpoints.js +103 -5
  4. package/package.json +1 -1
  5. package/types/core.d.ts +6 -6
  6. package/types/index.d.ts +10 -0
  7. package/types/resources/Addon.d.ts +3 -3
  8. package/types/resources/Address.d.ts +2 -194
  9. package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
  10. package/types/resources/AttachedItem.d.ts +1 -1
  11. package/types/resources/Attribute.d.ts +4 -1
  12. package/types/resources/BillingConfiguration.d.ts +21 -0
  13. package/types/resources/Brand.d.ts +12 -0
  14. package/types/resources/BusinessEntity.d.ts +10 -8
  15. package/types/resources/BusinessEntityTransfer.d.ts +10 -7
  16. package/types/resources/Card.d.ts +11 -311
  17. package/types/resources/Comment.d.ts +10 -125
  18. package/types/resources/Contact.d.ts +2 -44
  19. package/types/resources/ContractTerm.d.ts +4 -72
  20. package/types/resources/Coupon.d.ts +4 -41
  21. package/types/resources/CouponCode.d.ts +67 -35
  22. package/types/resources/CouponSet.d.ts +12 -121
  23. package/types/resources/CreditNote.d.ts +89 -95
  24. package/types/resources/Currency.d.ts +8 -5
  25. package/types/resources/Customer.d.ts +96 -95
  26. package/types/resources/CustomerEntitlement.d.ts +3 -1
  27. package/types/resources/DifferentialPrice.d.ts +1 -1
  28. package/types/resources/Discount.d.ts +5 -90
  29. package/types/resources/Download.d.ts +2 -14
  30. package/types/resources/Entitlement.d.ts +15 -103
  31. package/types/resources/EntitlementOverride.d.ts +4 -89
  32. package/types/resources/Estimate.d.ts +6 -14
  33. package/types/resources/Event.d.ts +24 -109
  34. package/types/resources/Export.d.ts +116 -432
  35. package/types/resources/Feature.d.ts +19 -321
  36. package/types/resources/GatewayErrorDetail.d.ts +6 -48
  37. package/types/resources/Gift.d.ts +34 -294
  38. package/types/resources/Hierarchy.d.ts +4 -24
  39. package/types/resources/HostedPage.d.ts +4 -4
  40. package/types/resources/ImpactedCustomer.d.ts +23 -0
  41. package/types/resources/ImpactedItem.d.ts +4 -36
  42. package/types/resources/ImpactedItemPrice.d.ts +5 -2
  43. package/types/resources/ImpactedSubscription.d.ts +3 -30
  44. package/types/resources/InAppSubscription.d.ts +13 -355
  45. package/types/resources/Invoice.d.ts +112 -126
  46. package/types/resources/InvoiceEstimate.d.ts +1 -1
  47. package/types/resources/Item.d.ts +4 -11
  48. package/types/resources/ItemEntitlement.d.ts +15 -155
  49. package/types/resources/ItemFamily.d.ts +3 -3
  50. package/types/resources/ItemPrice.d.ts +7 -7
  51. package/types/resources/NonSubscription.d.ts +9 -6
  52. package/types/resources/OmnichannelOneTimeOrder.d.ts +90 -0
  53. package/types/resources/OmnichannelOneTimeOrderItem.d.ts +24 -0
  54. package/types/resources/OmnichannelSubscription.d.ts +2 -2
  55. package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -1
  56. package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +1 -1
  57. package/types/resources/Order.d.ts +3 -3
  58. package/types/resources/PaymentIntent.d.ts +9 -255
  59. package/types/resources/PaymentReferenceNumber.d.ts +3 -20
  60. package/types/resources/PaymentSource.d.ts +4 -4
  61. package/types/resources/PaymentVoucher.d.ts +22 -205
  62. package/types/resources/Plan.d.ts +3 -3
  63. package/types/resources/PortalSession.d.ts +4 -146
  64. package/types/resources/PriceVariant.d.ts +2 -2
  65. package/types/resources/PricingPageSession.d.ts +2 -2
  66. package/types/resources/PromotionalCredit.d.ts +12 -215
  67. package/types/resources/Purchase.d.ts +5 -3
  68. package/types/resources/Quote.d.ts +32 -14
  69. package/types/resources/QuotedCharge.d.ts +7 -0
  70. package/types/resources/QuotedRamp.d.ts +11 -16
  71. package/types/resources/Ramp.d.ts +7 -7
  72. package/types/resources/RecordedPurchase.d.ts +8 -1
  73. package/types/resources/ResourceMigration.d.ts +2 -54
  74. package/types/resources/SiteMigrationDetail.d.ts +13 -55
  75. package/types/resources/Subscription.d.ts +33 -29
  76. package/types/resources/SubscriptionEntitlement.d.ts +6 -106
  77. package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
  78. package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
  79. package/types/resources/SubscriptionEstimate.d.ts +14 -11
  80. package/types/resources/TaxWithheld.d.ts +14 -26
  81. package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -19
  82. package/types/resources/TimeMachine.d.ts +3 -64
  83. package/types/resources/Token.d.ts +3 -60
  84. package/types/resources/Transaction.d.ts +8 -8
  85. package/types/resources/UnbilledCharge.d.ts +1 -1
  86. package/types/resources/Usage.d.ts +21 -165
  87. package/types/resources/UsageFile.d.ts +5 -5
  88. package/types/resources/VirtualBankAccount.d.ts +1 -1
  89. package/types/resources/WebhookEndpoint.d.ts +117 -0
@@ -3,141 +3,56 @@
3
3
  declare module 'chargebee' {
4
4
  export interface SubscriptionEntitlement {
5
5
 
6
- /**
7
- * @description The `id` of the [subscription](/docs/api/subscriptions) to which this entitlement belongs.
8
6
 
9
- */
10
-
11
7
  subscription_id:string;
12
-
13
- /**
14
- * @description The `id` of the [feature](/docs/api/features) towards which this subscription entitlement has been granted.
15
8
 
16
- */
17
-
18
9
  feature_id?:string;
19
-
20
- /**
21
- * @description The [name of the feature](/docs/api/features#feature_name) towards which this subscription entitlement has been granted.
22
10
 
23
- */
24
-
25
11
  feature_name?:string;
26
-
27
- /**
28
- * @description [The unit of measure](/docs/api/features#feature_unit) for the feature when its `type` is either `quantity` or `range`.
29
12
 
30
- */
31
-
32
13
  feature_unit?:string;
33
-
34
- /**
35
- * @description The value denoting the effective entitlement level that the subscription has towards the feature. When `components.entitlement_override` is present, then this is the same as `components.entitlement_override.value`. Otherwise, it is `components.inherited_entitlements.value`.
36
14
 
37
- */
38
-
39
- value?:string;
40
-
41
- /**
42
- * @description The display name of the effective entitlement level. When `components.entitlement_override` is present, then this is the same as `components.entitlement_override.name`. Otherwise, it is derived based on the `type` of feature as follows:
15
+ feature_type?:string;
43
16
 
44
- * When `feature.type` is `range` or `quantity`: the `name` is the space-separated concatenation of `inherited_entitlements.value` and the pluralized form of `feature_unit`. For example, if `value` is `20` and `feature_unit` is `user`, then `name` becomes `20 users`.
45
- * When `feature.type` is `custom`: the `name` is the same as `inherited_entitlements.value`.
46
- * When `feature.type` is `switch`: `name` is not applicable.
17
+ value?:string;
47
18
 
48
- */
49
-
50
19
  name?:string;
51
-
52
- /**
53
- * @description Indicates that `components.entitlement_overrides` exists.
54
20
 
55
- */
56
-
57
21
  is_overridden:boolean;
58
-
59
- /**
60
- * @description Indicates that `components.is_enabled` exists.
61
22
 
62
- */
63
-
64
23
  is_enabled:boolean;
65
-
66
- /**
67
- * @description Timestamp when the subscription entitlements are going to expire.
68
24
 
69
- */
70
25
  effective_from?:number;
71
26
 
72
27
  schedule_status?:'activated' | 'scheduled' | 'failed';
73
28
 
74
29
  expires_at?:number;
75
-
76
- /**
77
- * @description The component entitlements that constitute this `subscription_entitlement`. The effective entitlement [value](/docs/api/subscription_entitlements#subscription_entitlement_value) and [name](/docs/api/subscription_entitlements#subscription_entitlement_name) are determined from these component entitlements.
78
30
 
79
- */
80
-
81
31
  components?:SubscriptionEntitlement.Component;
82
- feature_type?:string;
32
+
83
33
  }
84
34
  export namespace SubscriptionEntitlement {
85
35
  export class SubscriptionEntitlementResource {
86
- /**
87
- * @description Retrieves the list of `subscription_entitlements` for the [subscription](/docs/api/subscriptions).
88
- **Note:**
89
-
90
- The `components` attribute is not returned for any of the `subscription_entitlements`. Use the retrieve operation(coming soon) to obtain the `components`.
91
-
92
- */
93
-
94
36
  subscription_entitlements_for_subscription(subscription_id:string, input?:SubscriptionEntitlementsForSubscriptionInputParam):ChargebeeRequest<SubscriptionEntitlementsForSubscriptionResponse>;
95
37
 
96
- /**
97
- * @description Enables or disables specific &#x60;subscription_entitlements&#x60; for a subscription.
98
-
99
- */
100
-
101
38
  set_subscription_entitlement_availability(subscription_id:string, input:SetSubscriptionEntitlementAvailabilityInputParam):ChargebeeRequest<SetSubscriptionEntitlementAvailabilityResponse>;
102
39
  }
103
40
  export interface SubscriptionEntitlementsForSubscriptionResponse {
104
- /**
105
- * @description Retrieves the list of &#x60;subscription_entitlements&#x60; for the [subscription](/docs/api/subscriptions).
106
- **Note:**
107
-
108
- The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscription_entitlements&#x60;. Use the retrieve operation(coming soon) to obtain the &#x60;components&#x60;.
109
-
110
- */
111
-
112
41
  list:{subscription_entitlement:SubscriptionEntitlement}[];
113
42
 
114
- /**
115
- * @description Retrieves the list of &#x60;subscription_entitlements&#x60; for the [subscription](/docs/api/subscriptions).
116
- **Note:**
117
-
118
- The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscription_entitlements&#x60;. Use the retrieve operation(coming soon) to obtain the &#x60;components&#x60;.
119
-
120
- */
121
-
122
43
  next_offset?:string;
123
44
  }
124
45
  export interface SubscriptionEntitlementsForSubscriptionInputParam {
125
46
  [key : string]: any;
126
47
  /**
127
- * @description Retrieves the list of &#x60;subscription_entitlements&#x60; for the [subscription](/docs/api/subscriptions).
128
- **Note:**
129
-
130
- The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscription_entitlements&#x60;. Use the retrieve operation(coming soon) to obtain the &#x60;components&#x60;.
48
+ * @description The number of resources to be returned.
131
49
 
132
50
  */
133
51
 
134
52
  limit?:number;
135
53
 
136
54
  /**
137
- * @description Retrieves the list of &#x60;subscription_entitlements&#x60; for the [subscription](/docs/api/subscriptions).
138
- **Note:**
139
-
140
- The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscription_entitlements&#x60;. Use the retrieve operation(coming soon) to obtain the &#x60;components&#x60;.
55
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
141
56
 
142
57
  */
143
58
 
@@ -154,26 +69,11 @@ The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscr
154
69
  }
155
70
  export interface SetSubscriptionEntitlementAvailabilityInputParam {
156
71
 
157
- /**
158
- * @description Specifies whether the &#x60;subscription_entitlements&#x60; are to be enabled or disabled.
159
-
160
- */
72
+ subscription_entitlements:{feature_id:string}[];
161
73
 
162
74
  is_enabled:boolean;
163
-
164
- /**
165
- * @description Parameters for subscription_entitlements
166
-
167
- */
168
-
169
- subscription_entitlements:{feature_id:string}[];
170
75
  }
171
76
  export interface Component {
172
- /**
173
- * @description When a subscription entitlement has been explicitly overridden, this object contains the details of said override. An &#x60;entitlement_override&#x60; can be [temporary](/docs/api/entitlement_overrides#entitlement_override_expires_at) such that it expires at some point in time and is no longer returned.
174
-
175
- */
176
-
177
77
  entitlement_overrides?:EntitlementOverride;
178
78
  }
179
79
  }
@@ -0,0 +1,12 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface SubscriptionEntitlementsCreatedDetail {
5
+
6
+
7
+ subscription_id?:string;
8
+
9
+ has_next:boolean;
10
+
11
+ }
12
+ }
@@ -0,0 +1,12 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface SubscriptionEntitlementsUpdatedDetail {
5
+
6
+
7
+ subscription_id?:string;
8
+
9
+ has_next:boolean;
10
+
11
+ }
12
+ }
@@ -1,24 +1,27 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface SubscriptionEstimate {
4
5
 
6
+
5
7
  id?:string;
6
-
8
+
7
9
  currency_code:string;
8
-
9
- status?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing';
10
-
10
+
11
+ status?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred';
12
+
11
13
  trial_end_action?:TrialEndAction;
12
-
14
+
13
15
  next_billing_at?:number;
14
-
16
+
15
17
  pause_date?:number;
16
-
18
+
17
19
  resume_date?:number;
18
-
20
+
19
21
  shipping_address?:SubscriptionEstimate.ShippingAddress;
20
-
22
+
21
23
  contract_term?:SubscriptionEstimate.ContractTerm;
24
+
22
25
  }
23
26
  export namespace SubscriptionEstimate {
24
27
 
@@ -57,7 +60,7 @@ declare module 'chargebee' {
57
60
  export interface ContractTerm {
58
61
  id:string;
59
62
 
60
- status:'active' | 'cancelled' | 'completed' | 'terminated';
63
+ status:'active' | 'completed' | 'cancelled' | 'terminated';
61
64
 
62
65
  contract_start:number;
63
66
 
@@ -65,7 +68,7 @@ declare module 'chargebee' {
65
68
 
66
69
  billing_cycle:number;
67
70
 
68
- action_at_term_end:'cancel' | 'renew_once' | 'renew' | 'evergreen';
71
+ action_at_term_end:'renew' | 'evergreen' | 'cancel' | 'renew_once';
69
72
 
70
73
  total_contract_value:number;
71
74
 
@@ -1,44 +1,32 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface TaxWithheld {
4
5
 
5
- /**
6
- * @description An auto-generated unique identifier for the tax withheld. The value starts with the prefix &#x60;tax_wh_&#x60;. For example, &#x60;tax_wh_16BdDXSlbu4uV1Ee6&#x60;.
7
6
 
8
- */
9
-
10
7
  id:string;
11
-
12
- /**
13
- * @description A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.
14
8
 
15
- */
16
-
9
+ user?:string;
10
+
17
11
  reference_number?:string;
18
-
19
- /**
20
- * @description The description for this tax withheld.
21
12
 
22
- */
23
-
24
13
  description?:string;
25
-
26
- /**
27
- * @description Date or time associated with the tax withheld.
28
14
 
29
- */
30
-
15
+ type:'payment' | 'refund';
16
+
17
+ payment_method:'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'other';
18
+
31
19
  date?:number;
32
-
33
- /**
34
- * @description The amount withheld by the customer as tax from the invoice. The unit depends on the [type of currency](/docs/api#md_disabled).
35
20
 
36
- */
37
-
21
+ currency_code:string;
22
+
38
23
  amount?:number;
39
-
24
+
40
25
  resource_version?:number;
41
-
26
+
42
27
  updated_at?:number;
28
+
29
+ exchange_rate?:number;
30
+
43
31
  }
44
32
  }
@@ -1,33 +1,16 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface ThirdPartyPaymentMethod {
4
5
 
5
- /**
6
- * @description Type of the payment method. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* unionpay - Payments made via UnionPay. \* google_pay - Payments made via Google Pay. \* dotpay - Payments made via Dotpay. \* generic - Payments made via Generic Payment Method. \* giropay - Payments made via giropay. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* alipay - Payments made via Alipay. \* sofort - Payments made via Sofort. \* wechat_pay - Payments made via WeChat Pay. \* ideal - Payments made via iDEAL. \* netbanking_emandates - Netbanking (eMandates) Payments. \* upi - UPI Payments. \* bancontact - Payments made via Bancontact Card. \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* amazon_payments - Payments made via Amazon Payments. \* apple_pay - Payments made via Apple Pay.
7
6
 
8
- */
9
-
10
7
  type:Type;
11
-
12
- /**
13
- * @description Name of the gateway this card is stored with. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
14
8
 
15
- */
16
-
17
9
  gateway:Gateway;
18
-
19
- /**
20
- * @description The gateway account this payment method is stored with.
21
10
 
22
- */
23
-
24
11
  gateway_account_id?:string;
25
-
26
- /**
27
- * @description Identifier provided by the gateway to reference that specific card.
28
12
 
29
- */
30
-
31
13
  reference_id:string;
14
+
32
15
  }
33
16
  }
@@ -1,80 +1,30 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface TimeMachine {
4
5
 
5
- /**
6
- * @description The name of the time machine. Currently only **delorean** is allowed
7
6
 
8
- */
9
-
10
7
  name:string;
11
-
12
- /**
13
- * @description The current status of time travel \* succeeded - Time travel has succeeded. \* not_enabled - Time travel has not been enabled for the site \* failed - Time travel has failed. Check the failure code and failure reason attributes for further details.
14
- **Note:** The time machine needs to be reset by starting afresh again. \* in_progress - Time travel is in progress
15
8
 
16
- */
17
-
18
- time_travel_status:'in_progress' | 'not_enabled' | 'failed' | 'succeeded';
19
-
20
- /**
21
- * @description The start time of the time machine. Specified when &#x27;starting afresh&#x27;
9
+ time_travel_status:'not_enabled' | 'in_progress' | 'succeeded' | 'failed';
22
10
 
23
- */
24
-
25
11
  genesis_time:number;
26
-
27
- /**
28
- * @description The destination time to which the time machine is travelling (or has traveled)
29
12
 
30
- */
31
-
32
13
  destination_time:number;
33
-
34
- /**
35
- * @description The failure code. This will follow the api error code convention
36
14
 
37
- */
38
-
39
15
  failure_code?:string;
40
-
41
- /**
42
- * @description The more descriptive failure reason.
43
16
 
44
- */
45
-
46
17
  failure_reason?:string;
47
-
48
- /**
49
- * @description The failure details as error json.
50
18
 
51
- */
52
-
53
19
  error_json?:string;
20
+
54
21
  }
55
22
  export namespace TimeMachine {
56
23
  export class TimeMachineResource {
57
- /**
58
- * @description Retrieves the time machine. Currently only one time machine is available per site and is named &#x27;delorean&#x27;.
59
-
60
- */
61
-
62
24
  retrieve(time_machine_name:string):ChargebeeRequest<RetrieveResponse>;
63
25
 
64
- /**
65
- * @description Restart the time machine. This will clear the &quot;customer&quot; data like customer details, subscriptions, invoices, transactions. Also a time travel is initiated to travel back to specified genesis time.
66
-
67
- **Note:** This API call is asynchronous. You need to check if the &quot;start afresh&quot; operation has completed by checking if the time travel status is **successful** by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for time travel completion** function provided as a instance method in the library. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **WaitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes.
68
-
69
- */
70
-
71
26
  start_afresh(time_machine_name:string, input?:StartAfreshInputParam):ChargebeeRequest<StartAfreshResponse>;
72
27
 
73
- /**
74
- * @description Travel forward in time. This operation is **asynchronous** . You need to check if the &quot;start afresh&quot; operation has completed by checking if the time travel status is **successful** by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. Use method **waitForTimeTravelCompletion()** on the returned time_machine resource which will block until the time travel completes.
75
-
76
- */
77
-
78
28
  travel_forward(time_machine_name:string, input?:TravelForwardInputParam):ChargebeeRequest<TravelForwardResponse>;
79
29
  }
80
30
  export interface RetrieveResponse {
@@ -86,12 +36,6 @@ declare module 'chargebee' {
86
36
  }
87
37
  export interface StartAfreshInputParam {
88
38
 
89
- /**
90
- * @description The genesis time to travel back as part of the reset operation. If not provided, then the travel is set to 6 months in the past.
91
- **Note:** Can only be in the past.
92
-
93
- */
94
-
95
39
  genesis_time?:number;
96
40
  }
97
41
  export interface TravelForwardResponse {
@@ -99,11 +43,6 @@ declare module 'chargebee' {
99
43
  }
100
44
  export interface TravelForwardInputParam {
101
45
 
102
- /**
103
- * @description The **time** to travel to. Should be between the &#x27;current&#x27; destination time of the time machine and present time.
104
-
105
- */
106
-
107
46
  destination_time?:number;
108
47
  }
109
48
 
@@ -1,89 +1,32 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface Token {
4
5
 
5
- /**
6
- * @description Identifier of the Chargebee Token
7
6
 
8
- */
9
-
10
7
  id:string;
11
-
12
- /**
13
- * @description Name of the gateway this token is stored in. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway.
14
8
 
15
- */
16
-
17
9
  gateway:Gateway;
18
-
19
- /**
20
- * @description The gateway account in which this token is stored.
21
10
 
22
- */
23
-
24
11
  gateway_account_id:string;
25
-
26
- /**
27
- * @description Type of payment method of the token. \* google_pay - Payments made via Google Pay. \* apple_pay - Payments made via Apple Pay. \* unionpay - Payments made via UnionPay. \* ideal - Payments made via iDEAL. \* bancontact - Payments made via Bancontact Card. \* netbanking_emandates - Netbanking (eMandates) Payments. \* alipay - Payments made via Alipay. \* dotpay - Payments made via Dotpay. \* giropay - Payments made via giropay. \* sofort - Payments made via Sofort. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* amazon_payments - Payments made via Amazon Payments. \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* upi - UPI Payments. \* generic - Payments made via Generic Payment Method. \* wechat_pay - Payments made via WeChat Pay.
28
12
 
29
- */
30
-
31
13
  payment_method_type:PaymentMethodType;
32
-
33
- /**
34
- * @description Status of the token \* new - new \* consumed - The token is already used \* expired - expired
35
14
 
36
- */
37
-
38
- status:'consumed' | 'new' | 'expired';
39
-
40
- /**
41
- * @description The id with which this token is referred in gateway
15
+ status:'new' | 'expired' | 'consumed';
42
16
 
43
- */
44
-
45
17
  id_at_vault:string;
46
-
47
- /**
48
- * @description Name of the gateway/vault provider where the payment method is tokenized \* gateway - gateway \* spreedly - spreedly
49
18
 
50
- */
51
-
52
19
  vault:'spreedly' | 'gateway';
53
-
54
- /**
55
- * @description The IP address from where the token is created. Used primarily for EU VAT validation.
56
20
 
57
- */
58
-
59
21
  ip_address?:string;
60
-
61
- /**
62
- * @description Version number of this resource. The &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
63
22
 
64
- */
65
-
66
23
  resource_version?:number;
67
-
68
- /**
69
- * @description Timestamp indicating when this token resource was last updated.
70
24
 
71
- */
72
-
73
25
  updated_at?:number;
74
-
75
- /**
76
- * @description Timestamp indicating when this token resource is created.
77
26
 
78
- */
79
-
80
27
  created_at:number;
81
-
82
- /**
83
- * @description Timestamp indicating when this token is expired
84
28
 
85
- */
86
-
87
29
  expired_at?:number;
30
+
88
31
  }
89
32
  }
@@ -190,7 +190,7 @@ declare module 'chargebee' {
190
190
  limit?:number;
191
191
 
192
192
  /**
193
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
193
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
194
194
 
195
195
  */
196
196
 
@@ -236,14 +236,14 @@ declare module 'chargebee' {
236
236
 
237
237
  */
238
238
 
239
- payment_method?:{in?:string,is?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland',is_not?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland',not_in?:string};
239
+ payment_method?:{in?:string,is?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',is_not?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',not_in?:string};
240
240
 
241
241
  /**
242
242
  * @description Gateway through which this transaction was done. Applicable only for &#x27;Card&#x27; Payment Method
243
243
 
244
244
  */
245
245
 
246
- gateway?:{in?:string,is?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'paystack' | 'jp_morgan' | 'not_applicable',is_not?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'paystack' | 'jp_morgan' | 'not_applicable',not_in?:string};
246
+ gateway?:{in?:string,is?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'solidgate' | 'paystack' | 'jp_morgan' | 'not_applicable',is_not?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'solidgate' | 'paystack' | 'jp_morgan' | 'not_applicable',not_in?:string};
247
247
 
248
248
  /**
249
249
  * @description The gateway account used for this transaction
@@ -288,7 +288,7 @@ declare module 'chargebee' {
288
288
  amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
289
289
 
290
290
  /**
291
- * @description To filter based on transaction&#x27;s unused authorized/blocked amount.
291
+ * @description To filter based on transaction?s unused authorized/blocked amount.
292
292
 
293
293
  */
294
294
 
@@ -308,7 +308,7 @@ declare module 'chargebee' {
308
308
 
309
309
  updated_at?:{after?:string,before?:string,between?:string,on?:string};
310
310
 
311
- sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
311
+ sort_by?:object;
312
312
  }
313
313
  export interface TransactionsForCustomerResponse {
314
314
  list:{transaction:Transaction}[];
@@ -325,7 +325,7 @@ declare module 'chargebee' {
325
325
  limit?:number;
326
326
 
327
327
  /**
328
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
328
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
329
329
 
330
330
  */
331
331
 
@@ -346,7 +346,7 @@ declare module 'chargebee' {
346
346
  limit?:number;
347
347
 
348
348
  /**
349
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
349
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
350
350
 
351
351
  */
352
352
 
@@ -367,7 +367,7 @@ declare module 'chargebee' {
367
367
  limit?:number;
368
368
 
369
369
  /**
370
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
370
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
371
371
 
372
372
  */
373
373
 
@@ -127,7 +127,7 @@ declare module 'chargebee' {
127
127
  limit?:number;
128
128
 
129
129
  /**
130
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
130
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
131
131
 
132
132
  */
133
133