chargebee 2.28.0 → 2.29.0

package/types/resources/SubscriptionEntitlement.d.ts

@@ -78,8 +78,6 @@ declare module 'chargebee' {
   }
   export namespace SubscriptionEntitlement {
     export class SubscriptionEntitlementResource {  
-      set_subscription_entitlement_availability(subscription_id:string, input:SetSubscriptionEntitlementAvailabilityInputParam):ChargebeeRequest<SetSubscriptionEntitlementAvailabilityResponse>;
-       
       /**
         * @description Retrieves the list of &#x60;subscription_entitlements&#x60; for the [subscription](/docs/api/subscriptions).  
 **Note:**
@@ -89,15 +87,13 @@ The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscr
         */
       
       subscription_entitlements_for_subscription(subscription_id:string, input?:SubscriptionEntitlementsForSubscriptionInputParam):ChargebeeRequest<SubscriptionEntitlementsForSubscriptionResponse>;
-    }
-    export interface SetSubscriptionEntitlementAvailabilityResponse {  
-       subscription_entitlement:SubscriptionEntitlement;
-    }
-    export interface SetSubscriptionEntitlementAvailabilityInputParam {
        
-      is_enabled:boolean;
-       
-      subscription_entitlements?:{feature_id:string}[];
+      /**
+        * @description Enables or disables specific &#x60;subscription_entitlements&#x60; for a subscription.
+
+        */
+      
+      set_subscription_entitlement_availability(subscription_id:string, input:SetSubscriptionEntitlementAvailabilityInputParam):ChargebeeRequest<SetSubscriptionEntitlementAvailabilityResponse>;
     }
     export interface SubscriptionEntitlementsForSubscriptionResponse {  
       /**
@@ -123,19 +119,44 @@ The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscr
     export interface SubscriptionEntitlementsForSubscriptionInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Retrieves the list of &#x60;subscription_entitlements&#x60; for the [subscription](/docs/api/subscriptions).  
+**Note:**
+
+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;.
 
         */
         
       limit?:number;
        
       /**
-        * @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.
+        * @description Retrieves the list of &#x60;subscription_entitlements&#x60; for the [subscription](/docs/api/subscriptions).  
+**Note:**
+
+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;.
 
         */
         
       offset?:string;
     }
+    export interface SetSubscriptionEntitlementAvailabilityResponse {  
+       subscription_entitlement:SubscriptionEntitlement;
+    }
+    export interface SetSubscriptionEntitlementAvailabilityInputParam {
+       
+      /**
+        * @description Specifies whether the &#x60;subscription_entitlements&#x60; are to be enabled or disabled.
+
+        */
+       
+      is_enabled:boolean;
+       
+      /**
+        * @description Parameters for subscription_entitlements
+
+        */
+       
+      subscription_entitlements?:{feature_id:string}[];
+    }
     export interface Component {  
          /**
           * @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.

package/types/resources/ThirdPartyPaymentMethod.d.ts

@@ -10,7 +10,7 @@ declare module 'chargebee' {
     type:Type;
     
     /**
-      * @description Name of the gateway this card is stored with. \* 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.
+      * @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.
 
       */
     

package/types/resources/TimeMachine.d.ts

@@ -62,49 +62,49 @@ declare module 'chargebee' {
       retrieve(time_machine_name:string):ChargebeeRequest<RetrieveResponse>;
        
       /**
-        * @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.
+        * @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.
+
+**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.
 
         */
       
-      travel_forward(time_machine_name:string, input?:TravelForwardInputParam):ChargebeeRequest<TravelForwardResponse>;
+      start_afresh(time_machine_name:string, input?:StartAfreshInputParam):ChargebeeRequest<StartAfreshResponse>;
        
       /**
-        * @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.
-
-**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.
+        * @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.
 
         */
       
-      start_afresh(time_machine_name:string, input?:StartAfreshInputParam):ChargebeeRequest<StartAfreshResponse>;
+      travel_forward(time_machine_name:string, input?:TravelForwardInputParam):ChargebeeRequest<TravelForwardResponse>;
     }
     export interface RetrieveResponse {  
        time_machine:TimeMachine;
     }
     
-    export interface TravelForwardResponse {  
+    export interface StartAfreshResponse {  
        time_machine:TimeMachine;
     }
-    export interface TravelForwardInputParam {
+    export interface StartAfreshInputParam {
        
       /**
-        * @description The **time** to travel to. Should be between the &#x27;current&#x27; destination time of the time machine and present time.
+        * @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.   
+**Note:** Can only be in the past.
 
         */
        
-      destination_time?:number;
+      genesis_time?:number;
     }
-    export interface StartAfreshResponse {  
+    export interface TravelForwardResponse {  
        time_machine:TimeMachine;
     }
-    export interface StartAfreshInputParam {
+    export interface TravelForwardInputParam {
        
       /**
-        * @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.   
-**Note:** Can only be in the past.
+        * @description The **time** to travel to. Should be between the &#x27;current&#x27; destination time of the time machine and present time.
 
         */
        
-      genesis_time?:number;
+      destination_time?:number;
     }
     
   }

package/types/resources/Token.d.ts

@@ -89,18 +89,18 @@ declare module 'chargebee' {
   export namespace Token {
     export class TokenResource {  
       /**
-        * @description Generate a token using the one time token created by payment gateways for any specific payment method.
+        * @description Generate a token that holds card related information.
 
         */
       
-      create_using_temp_token(input:CreateUsingTempTokenInputParam):ChargebeeRequest<CreateUsingTempTokenResponse>;
+      create_for_card(input?:CreateForCardInputParam):ChargebeeRequest<CreateForCardResponse>;
        
       /**
-        * @description Generate a token that holds card related information.
+        * @description Generate a token using the one time token created by payment gateways for any specific payment method.
 
         */
       
-      create_for_card(input?:CreateForCardInputParam):ChargebeeRequest<CreateForCardResponse>;
+      create_using_temp_token(input:CreateUsingTempTokenInputParam):ChargebeeRequest<CreateUsingTempTokenResponse>;
        
       /**
         * @description Retrieve a token using token ID.
@@ -109,6 +109,18 @@ declare module 'chargebee' {
       
       retrieve(cb_token_id:string):ChargebeeRequest<RetrieveResponse>;
     }
+    export interface CreateForCardResponse {  
+       token:Token;
+    }
+    export interface CreateForCardInputParam {
+       
+      /**
+        * @description Parameters for card
+
+        */
+       
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,card_type?:'discover' | 'bancontact' | 'other' | 'visa' | 'jcb' | 'diners_club' | 'mastercard' | 'not_applicable' | 'american_express',cvv?:string,expiry_month:number,expiry_year:number,first_name?:string,gateway_account_id?:string,last_name?:string,number:string};
+    }
     export interface CreateUsingTempTokenResponse {  
        token:Token;
     }
@@ -150,17 +162,17 @@ declare module 'chargebee' {
       currency_code?:string;
        
       /**
-        * @description * &#x60;checkout_com&#x60;: While adding a new payment method using [permanent token](./payment_sources?#create_using_permanent_token) or passing raw card details to Checkout.com, &#x60;document&#x60; ID and &#x60;country_of_residence&#x60; are required to support payments through [dLocal](https://docs.checkout.com/payment-methods/cards/dlocal).
+        * @description * &#x60;checkout_com&#x60;: While adding a new payment method using [permanent token](./payment_sources?#create_using_permanent_token) or passing raw card details to Checkout.com, &#x60;document&#x60; ID and &#x60;country_of_residence&#x60; are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).
   * &#x60;payer&#x60;: User related information.
-    * &#x60;country_of_residence&#x60;: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a [two-character ISO code](https://docs.checkout.com/resources/codes/country-codes).
-    * &#x60;document&#x60;: Document ID is the user&#x27;s [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country.
-* &#x60;bluesnap&#x60;: While passing raw card details to BlueSnap, if &#x60;fraud_session_id&#x60; is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions.
+    * &#x60;country_of_residence&#x60;: This is required since the billing country associated with the user&#x27;s payment method may not be the same as their country of residence. Hence the user&#x27;s country of residence needs to be specified. The country code should be a [two-character ISO code](https://www.checkout.com/docs/developer-resources/testing/codes/country-codes).
+    * &#x60;document&#x60;: Document ID is the user&#x27;s [identification number](https://docs.dlocal.com/reference/country-reference#documents) based on their country.
+* &#x60;bluesnap&#x60;: While passing raw card details to BlueSnap, if &#x60;fraud_session_id&#x60; is added, [additional validation](https://developers.bluesnap.com/reference/fraud-prevention) is performed to avoid fraudulent transactions.
   * &#x60;fraud&#x60;: Fraud identification related information.
-    * &#x60;fraud_session_id&#x60;: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
-* &#x60;braintree&#x60;: While passing raw card details to Braintree, your &#x60;fraud_merchant_id&#x60; and the user&#x27;s &#x60;device_session_id&#x60; can be added to perform [additional validation](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.
+    * &#x60;fraud_session_id&#x60;: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/reference/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation.
+* &#x60;braintree&#x60;: While passing raw card details to Braintree, your &#x60;fraud_merchant_id&#x60; and the user&#x27;s &#x60;device_session_id&#x60; can be added to perform [additional validation](https://developer.paypal.com/braintree/docs/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) and avoid fraudulent transactions.
   * &#x60;fraud&#x60;: Fraud identification related information.
     * &#x60;device_session_id&#x60;: Session ID associated with the user&#x27;s device.
-    * &#x60;fraud_merchant_id&#x60;: Your [merchant ID](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
+    * &#x60;fraud_merchant_id&#x60;: Your [merchant ID](https://developer.paypal.com/braintree/docs/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) for fraud detection.
 * &#x60;chargebee_payments&#x60;: While passing raw card details to Chargebee Payments, if &#x60;fraud_session_id&#x60; is added, additional validation is performed to avoid fraudulent transactions.
   * &#x60;fraud&#x60;: Fraud identification related information.
     * &#x60;fraud_session_id&#x60;: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
@@ -184,18 +196,6 @@ declare module 'chargebee' {
        
       token_billing_address?:{city?:string,country_code?:string,line1?:string,line2?:string,state?:string,state_code?:string,zip?:string};
     }
-    export interface CreateForCardResponse {  
-       token:Token;
-    }
-    export interface CreateForCardInputParam {
-       
-      /**
-        * @description Parameters for card
-
-        */
-       
-      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,card_type?:'discover' | 'bancontact' | 'other' | 'visa' | 'jcb' | 'diners_club' | 'mastercard' | 'not_applicable' | 'american_express',cvv?:string,expiry_month:number,expiry_year:number,first_name?:string,gateway_account_id?:string,last_name?:string,number:string};
-    }
     export interface RetrieveResponse {  
        token:Token;
     }