chargebee 2.25.3 → 2.26.1

package/types/resources/SubscriptionEntitlement.d.ts

@@ -1,39 +1,147 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface SubscriptionEntitlement {
+    
+    /**
+      * @description The &#x60;id&#x60; of the [subscription](/docs/api/subscriptions) to which this entitlement belongs.
+
+      */
+    
     subscription_id:string;
+    
+    /**
+      * @description The &#x60;id&#x60; of the [feature](/docs/api/features) towards which this subscription entitlement has been granted.
+
+      */
+    
     feature_id?:string;
+    
+    /**
+      * @description The [name of the feature](/docs/api/features#feature_name) towards which this subscription entitlement has been granted.
+
+      */
+    
     feature_name?:string;
+    
+    /**
+      * @description [The unit of measure](/docs/api/features#feature_unit) for the feature when its &#x60;type&#x60; is either &#x60;quantity&#x60; or &#x60;range&#x60;.
+
+      */
+    
     feature_unit?:string;
+    
+    /**
+      * @description The value denoting the effective entitlement level that the subscription has towards the feature. When &#x60;components.entitlement_override&#x60; is present, then this is the same as &#x60;components.entitlement_override.value&#x60;. Otherwise, it is &#x60;components.inherited_entitlements.value&#x60;.
+
+      */
+    
     value?:string;
+    
+    /**
+      * @description The display name of the effective entitlement level. When &#x60;components.entitlement_override&#x60; is present, then this is the same as &#x60;components.entitlement_override.name&#x60;. Otherwise, it is derived based on the &#x60;type&#x60; of feature as follows:
+
+* When &#x60;feature.type&#x60; is &#x60;range&#x60; or &#x60;quantity&#x60;: the &#x60;name&#x60; is the space-separated concatenation of &#x60;inherited_entitlements.value&#x60; and the pluralized form of &#x60;feature_unit&#x60;. For example, if &#x60;value&#x60; is &#x60;20&#x60; and &#x60;feature_unit&#x60; is &#x60;user&#x60;, then &#x60;name&#x60; becomes &#x60;20 users&#x60;.
+* When &#x60;feature.type&#x60; is &#x60;custom&#x60;: the &#x60;name&#x60; is the same as &#x60;inherited_entitlements.value&#x60;.
+* When &#x60;feature.type&#x60; is &#x60;switch&#x60;: &#x60;name&#x60; is not applicable.
+
+      */
+    
     name?:string;
+    
+    /**
+      * @description Indicates that &#x60;components.entitlement_overrides&#x60; exists.
+
+      */
+    
     is_overridden:boolean;
+    
+    /**
+      * @description Indicates that &#x60;components.is_enabled&#x60; exists.
+
+      */
+    
     is_enabled:boolean;
+    
+    /**
+      * @description Timestamp when the subscription entitlements are going to expire.
+
+      */
+    
     expires_at?:number;
+    
+    /**
+      * @description The component entitlements that constitute this &#x60;subscription_entitlement&#x60;. 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.
+
+      */
+    
     components?:SubscriptionEntitlement.Component;
   }
   export namespace SubscriptionEntitlement {
-    export class SubscriptionEntitlementResource {
+    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:**
+
+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;.
+
+        */
+      
       subscription_entitlements_for_subscription(subscription_id:string, input?:SubscriptionEntitlementsForSubscriptionInputParam):ChargebeeRequest<SubscriptionEntitlementsForSubscriptionResponse>;
     }
-    export interface SetSubscriptionEntitlementAvailabilityResponse {
-      subscription_entitlement:SubscriptionEntitlement;
+    export interface SetSubscriptionEntitlementAvailabilityResponse {  
+       subscription_entitlement:SubscriptionEntitlement;
     }
     export interface SetSubscriptionEntitlementAvailabilityInputParam {
+       
       is_enabled:boolean;
+       
       subscription_entitlements?:{feature_id:string}[];
     }
-    export interface SubscriptionEntitlementsForSubscriptionResponse {
-      list:{subscription_entitlement:SubscriptionEntitlement}[];
-      next_offset?:string;
+    export interface SubscriptionEntitlementsForSubscriptionResponse {  
+      /**
+        * @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;.
+
+        */
+       
+       list:{subscription_entitlement:SubscriptionEntitlement}[];
+       
+      /**
+        * @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;.
+
+        */
+       
+       next_offset?:string;
     }
     export interface SubscriptionEntitlementsForSubscriptionInputParam {
-      [key : string]: any;
+      [key : string]: any;  
+      /**
+        * @description The number of resources to be returned.
+
+        */
+        
       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.
+
+        */
+        
       offset?:string;
     }
-    export interface Component {
+    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.
+
+          */
+       
       entitlement_overrides?:EntitlementOverride;
     }
   }

package/types/resources/SubscriptionEstimate.d.ts

@@ -1,48 +1,82 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface SubscriptionEstimate {
+    
     id?:string;
+    
     currency_code:string;
+    
     status?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing';
+    
     trial_end_action?:TrialEndAction;
+    
     next_billing_at?:number;
+    
     pause_date?:number;
+    
     resume_date?:number;
+    
     shipping_address?:SubscriptionEstimate.ShippingAddress;
+    
     contract_term?:SubscriptionEstimate.ContractTerm;
   }
   export namespace SubscriptionEstimate {
     
     
-    export interface ShippingAddress {
+    export interface ShippingAddress {  
       first_name?:string;
+       
       last_name?:string;
+       
       email?:string;
+       
       company?:string;
+       
       phone?:string;
+       
       line1?:string;
+       
       line2?:string;
+       
       line3?:string;
+       
       city?:string;
+       
       state_code?:string;
+       
       state?:string;
+       
       country?:string;
+       
       zip?:string;
+       
       validation_status?:ValidationStatus;
+       
       index?:number;
     }
-    export interface ContractTerm {
+    export interface ContractTerm {  
       id?:string;
+       
       status?:'active' | 'cancelled' | 'completed' | 'terminated';
+       
       contract_start?:number;
+       
       contract_end?:number;
+       
       billing_cycle?:number;
+       
       action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen';
+       
       total_contract_value?:number;
+       
       total_contract_value_before_tax?:number;
+       
       cancellation_cutoff_period?:number;
+       
       created_at?:number;
+       
       subscription_id?:string;
+       
       remaining_billing_cycles?:number;
     }
   }

package/types/resources/TaxWithheld.d.ts

@@ -1,12 +1,44 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface TaxWithheld {
+    
+    /**
+      * @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;.
+
+      */
+    
     id:string;
+    
+    /**
+      * @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.
+
+      */
+    
     reference_number?:string;
+    
+    /**
+      * @description The description for this tax withheld.
+
+      */
+    
     description?:string;
+    
+    /**
+      * @description Date or time associated with the tax withheld.
+
+      */
+    
     date?:number;
+    
+    /**
+      * @description The amount withheld by the customer as tax from the invoice. The unit depends on the [type of currency](/docs/api#md_disabled).
+
+      */
+    
     amount?:number;
+    
     resource_version?:number;
+    
     updated_at?:number;
   }
 }

package/types/resources/ThirdPartyPaymentMethod.d.ts

@@ -1,9 +1,33 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface ThirdPartyPaymentMethod {
+    
+    /**
+      * @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.
+
+      */
+    
     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.
+
+      */
+    
     gateway:Gateway;
+    
+    /**
+      * @description The gateway account this payment method is stored with.
+
+      */
+    
     gateway_account_id?:string;
+    
+    /**
+      * @description Identifier provided by the gateway to reference that specific card.
+
+      */
+    
     reference_id:string;
   }
 }

package/types/resources/TimeMachine.d.ts

@@ -1,34 +1,126 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface TimeMachine {
+    
+    /**
+      * @description The name of the time machine. Currently only **delorean** is allowed
+
+      */
+    
     name:string;
+    
+    /**
+      * @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.  
+**Note:** The time machine needs to be reset by starting afresh again. \* in_progress - Time travel is in progress
+
+      */
+    
     time_travel_status:'in_progress' | 'not_enabled' | 'failed' | 'succeeded';
+    
+    /**
+      * @description The start time of the time machine. Specified when &#x27;starting afresh&#x27;
+
+      */
+    
     genesis_time:number;
+    
+    /**
+      * @description The destination time to which the time machine is travelling (or has traveled)
+
+      */
+    
     destination_time:number;
+    
+    /**
+      * @description The failure code. This will follow the api error code convention
+
+      */
+    
     failure_code?:string;
+    
+    /**
+      * @description The more descriptive failure reason.
+
+      */
+    
     failure_reason?:string;
+    
+    /**
+      * @description The failure details as error json.
+
+      */
+    
     error_json?:string;
   }
   export namespace TimeMachine {
-    export class TimeMachineResource {
+    export class TimeMachineResource {  
+      /**
+        * @description Retrieves the time machine. Currently only one time machine is available per site and is named &#x27;delorean&#x27;.
+
+        */
+      
       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.
+
+        */
+      
       travel_forward(time_machine_name:string, input?:TravelForwardInputParam):ChargebeeRequest<TravelForwardResponse>;
+       
+      /**
+        * @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.
+
+        */
+      
       start_afresh(time_machine_name:string, input?:StartAfreshInputParam):ChargebeeRequest<StartAfreshResponse>;
     }
-    export interface RetrieveResponse {
-      time_machine:TimeMachine;
+    export interface RetrieveResponse {  
+      /**
+        * @description Retrieves the time machine. Currently only one time machine is available per site and is named &#x27;delorean&#x27;.
+
+        */
+       
+       time_machine:TimeMachine;
     }
     
-    export interface TravelForwardResponse {
-      time_machine:TimeMachine;
+    export interface TravelForwardResponse {  
+      /**
+        * @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.
+
+        */
+       
+       time_machine:TimeMachine;
     }
     export interface TravelForwardInputParam {
+       
+      /**
+        * @description The **time** to travel to. Should be between the &#x27;current&#x27; destination time of the time machine and present time.
+
+        */
+       
       destination_time?:number;
     }
-    export interface StartAfreshResponse {
-      time_machine:TimeMachine;
+    export interface 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.
+
+        */
+       
+       time_machine:TimeMachine;
     }
     export interface StartAfreshInputParam {
+       
+      /**
+        * @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.
+
+        */
+       
       genesis_time?:number;
     }