chargebee 2.51.0 → 2.53.0

package/types/resources/Contact.d.ts

@@ -1,68 +1,26 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface Contact {
     
-    /**
-      * @description Unique reference ID provided for the contact.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description First name of the contact.
 
-      */
-    
     first_name?:string;
-    
-    /**
-      * @description Last name of the contact.
 
-      */
-    
     last_name?:string;
-    
-    /**
-      * @description Email of the contact.
 
-      */
-    
     email:string;
-    
-    /**
-      * @description Phone number of the contact.
 
-      */
-    
     phone?:string;
-    
-    /**
-      * @description Label/Tag provided for contact.
 
-      */
-    
     label?:string;
-    
-    /**
-      * @description Contact enabled / disabled
 
-      */
-    
     enabled:boolean;
-    
-    /**
-      * @description Whether Account Emails option is enabled for the contact.
 
-      */
-    
     send_account_email:boolean;
-    
-    /**
-      * @description Whether Billing Emails option is enabled for the contact.
 
-      */
-    
     send_billing_email:boolean;
+
   }
 }

package/types/resources/ContractTerm.d.ts

@@ -1,100 +1,32 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface ContractTerm {
     
-    /**
-      * @description Id that uniquely identifies the contract term in the site.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description Current status of contract \* active - An actively running contract term. \* cancelled - The contract term was ended because:
 
-* a change in the subscription caused a [subscription term reset](subscriptions#update_a_subscription_force_term_reset).
-* the subscription was cancelled due to non-payment.
-\* terminated - The contract term was terminated ahead of completion. \* completed - The contract term has run its full duration.
+    status:'active' | 'completed' | 'cancelled' | 'terminated';
 
-      */
-    
-    status:'active' | 'cancelled' | 'completed' | 'terminated';
-    
-    /**
-      * @description The start date of the contract term
-
-      */
-    
     contract_start:number;
-    
-    /**
-      * @description The end date of the contract term
 
-      */
-    
     contract_end:number;
-    
-    /**
-      * @description The number of billing cycles of the subscription that the contract term is for.
 
-      */
-    
     billing_cycle:number;
-    
-    /**
-      * @description Action to be taken when the contract term completes. \* renew -
-* Contract term completes and a new contract term is started for the number of billing cycles specified in [&#x60;contract_billing_cycle_on_renewal&#x60;](subscriptions#create_subscription_for_customer_contract_term_billing_cycle_on_renewal).
-* The &#x60;action_at_term_end&#x60; for the new contract term is set to &#x60;renew&#x60;.
-\* evergreen - Contract term completes and the subscription renews. \* renew_once - Used when you want to renew the contract term just once. Does the following:
-* Contract term completes and a new contract term is started for the number of billing cycles specified in [&#x60;contract_billing_cycle_on_renewal&#x60;](subscriptions#create_subscription_for_customer_contract_term_billing_cycle_on_renewal).
-* The &#x60;action_at_term_end&#x60; for the new contract term is set to &#x60;cancel&#x60;.
-\* cancel - Contract term completes and subscription is canceled.
-
 
-      */
-    
-    action_at_term_end:'cancel' | 'renew_once' | 'renew' | 'evergreen';
-    
-    /**
-      * @description The sum of the [totals](invoices#invoice_total) of all the invoices raised as part of the contract term. For &#x60;active&#x60; contract terms, this is a predicted value. The value depends on the [type of currency](./#handling_currency_units). If the subscription was [imported](#import_a_subscription) with the contract term, then this value includes the value passed for &#x60;total_amount_raised&#x60;.
+    action_at_term_end:'renew' | 'evergreen' | 'cancel' | 'renew_once';
 
-      */
-    
     total_contract_value:number;
-    
-    /**
-      * @description It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for &#x60;total_amount_raised_before_tax&#x60; is included in the calculation of the total contract value before tax. It&#x27;s important to note that this value excludes any applicable taxes.
 
-      */
-    
     total_contract_value_before_tax:number;
-    
-    /**
-      * @description The number of days before [&#x60;contract_end&#x60;](contract_terms#contract_term_contract_end), during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
 
-      */
-    
     cancellation_cutoff_period?:number;
-    
-    /**
-      * @description The date when the contract term was created.
 
-      */
-    
     created_at:number;
-    
-    /**
-      * @description The [Id](subscriptions#subscription_id) of the subscription that this contract term is for.
 
-      */
-    
     subscription_id:string;
-    
-    /**
-      * @description The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for &#x60;active&#x60; contract terms.
 
-      */
-    
     remaining_billing_cycles?:number;
+
   }
 }

package/types/resources/Coupon.d.ts

@@ -148,7 +148,7 @@ declare module 'chargebee' {
        coupon:Coupon;
     }
     export interface CreateForItemsInputParam {
-      [key : string] : any;  
+       
       item_constraints:{constraint:'none' | 'all' | 'specific' | 'criteria',item_price_ids?:any[],item_type:'plan' | 'addon' | 'charge'}[];
        
       item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'plan' | 'addon' | 'charge'}[];
@@ -199,7 +199,7 @@ declare module 'chargebee' {
        coupon:Coupon;
     }
     export interface UpdateForItemsInputParam {
-      [key : string] : any;  
+       
       item_constraints:{constraint:'none' | 'all' | 'specific' | 'criteria',item_price_ids?:any[],item_type:'plan' | 'addon' | 'charge'}[];
        
       item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'plan' | 'addon' | 'charge'}[];
@@ -257,26 +257,12 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
       offset?:string;
        
-      /**
-        * @description Parameters for addon
-
-        */
-        
-      addon?:{};
-       
-      /**
-        * @description Parameters for plan
-
-        */
-        
-      plan?:{};
-       
       /**
         * @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.  
 **Note:**
@@ -343,21 +329,7 @@ Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon
         
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
        
-      /**
-        * @description Plans the coupon can be applied to.
-
-        */
-        
-      plan_constraint?:{in?:string,is?:'none' | 'all' | 'specific' | 'not_applicable',is_not?:'none' | 'all' | 'specific' | 'not_applicable',not_in?:string};
-       
-      /**
-        * @description Addons the coupon can be applied to.
-
-        */
-        
-      addon_constraint?:{in?:string,is?:'none' | 'all' | 'specific' | 'not_applicable',is_not?:'none' | 'all' | 'specific' | 'not_applicable',not_in?:string};
-       
-      sort_by?:{asc?:'created_at',desc?:'created_at'};
+      sort_by?:object;
        
       /**
         * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
@@ -365,15 +337,6 @@ Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon
         */
         
       currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Item families for which this coupon is applicable.
-
-        */
-        
-      item_family?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      include_discounts?:boolean;
     }
     export interface RetrieveResponse {  
        coupon:Coupon;

package/types/resources/CouponCode.d.ts

@@ -1,62 +1,94 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface CouponCode {
     
-    /**
-      * @description Unique coupon code that can be redeemed only once.
 
-      */
-    
     code:string;
-    
-    /**
-      * @description Status of the coupon code. \* not_redeemed - Can be applied to a subscription. \* redeemed - Cannot be applied to a subscription as the coupon code has been already used. \* archived - Cannot be applied to a subscription as it has been made inactive.
 
-      */
-    
-    status:'archived' | 'redeemed' | 'not_redeemed';
-    
-    /**
-      * @description Id of the main coupon resource.
+    status:'not_redeemed' | 'redeemed' | 'archived';
 
-      */
-    
     coupon_id:string;
-    
-    /**
-      * @description Uniquely identifies a coupon_set
 
-      */
-    
     coupon_set_id:string;
-    
-    /**
-      * @description Coupon set name to which this coupon code would be grouped under. If the coupon set with the passed name is not present, a new coupon set will be created.
 
-      */
-    
     coupon_set_name:string;
+
   }
   export namespace CouponCode {
     export class CouponCodeResource {  
-      /**
-        * @description Retrieves a specific coupon code details.
-
-        */
-      
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+       
       retrieve(coupon_code_code:string):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Archives a coupon code thereby making it inactive. The archived coupon code cannot be applied to any subscription.
-
-        */
-      
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
       archive(coupon_code_code:string):ChargebeeRequest<ArchiveResponse>;
     }
+    export interface CreateResponse {  
+       coupon_code:CouponCode;
+    }
+    export interface CreateInputParam {
+       
+      coupon_id:string;
+       
+      coupon_set_name:string;
+       
+      code:string;
+    }
     export interface RetrieveResponse {  
        coupon_code:CouponCode;
     }
     
+    export interface ListResponse {  
+       list:{coupon_code:CouponCode}[];
+       
+       next_offset?:string;
+    }
+    export interface ListInputParam {
+      [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 &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
+
+        */
+        
+      offset?:string;
+       
+      /**
+        * @description Unique coupon code that can be redeemed only once.
+
+        */
+        
+      code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Id of the main coupon resource.
+
+        */
+        
+      coupon_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Coupon set name to which this coupon code would be grouped under. If the coupon set with the passed name is not present, a new coupon set will be created.
+
+        */
+        
+      coupon_set_name?:{is?:string,is_not?:string,starts_with?:string};
+       
+      /**
+        * @description Status of the coupon code.
+
+        */
+        
+      status?:{in?:string,is?:'not_redeemed' | 'redeemed' | 'archived',is_not?:'not_redeemed' | 'redeemed' | 'archived',not_in?:string};
+    }
     export interface ArchiveResponse {  
        coupon_code:CouponCode;
     }

package/types/resources/CouponSet.d.ts

@@ -1,98 +1,38 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface CouponSet {
     
-    /**
-      * @description Uniquely identifies a coupon_set
 
-      */
-    
     id:string;
-    
-    /**
-      * @description Coupon id linked to coupon set
 
-      */
-    
     coupon_id:string;
-    
-    /**
-      * @description Name of the coupon set
 
-      */
-    
     name:string;
-    
-    /**
-      * @description No of coupon codes present in coupon set
 
-      */
-    
     total_count?:number;
-    
-    /**
-      * @description No of redeemed codes
 
-      */
-    
     redeemed_count?:number;
-    
-    /**
-      * @description No of archived codes
 
-      */
-    
     archived_count?:number;
+
+    meta_data?:object;
+
   }
   export namespace CouponSet {
     export class CouponSetResource {  
-      /**
-        * @description Create a coupon set with a coupon code compatible to your product offers and promotional discounts
-
-        */
-      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
-      /**
-        * @description This API add coupon codes to an existing coupon set.
-
-        */
-      
       add_coupon_codes(coupon_set_id:string, input?:AddCouponCodesInputParam):ChargebeeRequest<AddCouponCodesResponse>;
        
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
-      /**
-        * @description Use this API to retrieve a specific coupon set.
-
-        */
-      
       retrieve(coupon_set_id:string):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Use this API to update a specific coupon set by updating its &#x60;name&#x60; and the &#x60;meta_data&#x60;.
-
-        */
-      
       update(coupon_set_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
-      /**
-        * @description Use this endpoint to delete a specific coupon set
-
-        */
-      
       delete(coupon_set_id:string):ChargebeeRequest<DeleteResponse>;
        
-      /**
-        * @description Use this API to delete all the unutilised coupon codes from a specific coupon set.
-
-        */
-      
       delete_unused_coupon_codes(coupon_set_id:string):ChargebeeRequest<DeleteUnusedCouponCodesResponse>;
     }
     export interface CreateResponse {  
@@ -100,34 +40,12 @@ declare module 'chargebee' {
     }
     export interface CreateInputParam {
        
-      /**
-        * @description Coupon id linked to coupon set.
-
-        */
-       
       coupon_id:string;
        
-      /**
-        * @description Name of the coupon set.
-
-        */
-       
       name:string;
        
-      /**
-        * @description Uniquely identifies a coupon_set.
-
-        */
-       
       id:string;
        
-      /**
-        * @description A collection of key-value pairs that provides extra information about the coupon set.  
-**Note:** There&#x27;s a character limit of 65,535.
-[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
-
-        */
-       
       meta_data?:object;
     }
     export interface AddCouponCodesResponse {  
@@ -135,81 +53,66 @@ declare module 'chargebee' {
     }
     export interface AddCouponCodesInputParam {
        
-      /**
-        * @description You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.
-
-        */
-       
       code?:string[];
     }
     export interface ListResponse {  
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-       
        list:{coupon_set:CouponSet}[];
        
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @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.
 
         */
         
       offset?:string;
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description Uniquely identifies a coupon_set
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description Name of the coupon set
 
         */
         
       name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description Coupon id linked to coupon set
 
         */
         
       coupon_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description No of coupon codes present in coupon set
 
         */
         
       total_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description No of redeemed codes
 
         */
         
       redeemed_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description No of archived codes
 
         */
         
@@ -224,20 +127,8 @@ declare module 'chargebee' {
     }
     export interface UpdateInputParam {
        
-      /**
-        * @description Name of the coupon set.
-
-        */
-       
       name?:string;
        
-      /**
-        * @description A collection of key-value pairs that provides extra information about the coupon set.  
-**Note:** There&#x27;s a character limit of 65,535.
-[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
-
-        */
-       
       meta_data?:object;
     }
     export interface DeleteResponse {