chargebee 2.45.0 → 2.47.0

package/types/resources/CreditNoteEstimate.d.ts

@@ -1,38 +1,41 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface CreditNoteEstimate {
     
+
     reference_invoice_id:string;
-    
+
     type:'adjustment' | 'refundable';
-    
+
     price_type:PriceType;
-    
+
     currency_code:string;
-    
+
     sub_total:number;
-    
+
     total:number;
-    
+
     amount_allocated:number;
-    
+
     amount_available:number;
-    
+
     line_items?:CreditNoteEstimate.LineItem[];
-    
+
     discounts?:CreditNoteEstimate.Discount[];
-    
+
     taxes?:CreditNoteEstimate.Tax[];
-    
+
     line_item_taxes?:CreditNoteEstimate.LineItemTax[];
-    
+
     line_item_discounts?:CreditNoteEstimate.LineItemDiscount[];
-    
+
     line_item_tiers?:CreditNoteEstimate.LineItemTier[];
-    
+
     round_off_amount?:number;
-    
+
     customer_id?:string;
+
   }
   export namespace CreditNoteEstimate {
     
@@ -93,6 +96,8 @@ declare module 'chargebee' {
        
       entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
        
+      discount_type?:'fixed_amount' | 'percentage';
+       
       entity_id?:string;
        
       coupon_set_code?:string;

package/types/resources/DifferentialPrice.d.ts

@@ -1,135 +1,50 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface DifferentialPrice {
     
-    /**
-      * @description A unique and immutable ID for the differential price. It is auto-generated when the differential price is created.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description The ID of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
 
-      */
-    
     item_price_id:string;
-    
-    /**
-      * @description The ID of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard* or *Enterprise* plans-items mentioned in the [examples above](./differential_prices?prod_cat_ver&#x3D;2).
 
-      */
-    
     parent_item_id:string;
-    
-    /**
-      * @description The differential price. If the pricing model of the &#x60;item_price_id&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60;, or &#x60;stairstep&#x60;, pass &#x60;tiers&#x60; instead of this.
 
-      */
-    
     price?:number;
-    
-    /**
-      * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
 
-      */
-    
     price_in_decimal?:string;
-    
-    /**
-      * @description The item family state. \* active - New items can be created with the item family. \* deleted - No items allowed for the item family.
 
-      */
-    
-    status?:'deleted' | 'active';
-    
-    /**
-      * @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.
+    status?:'active' | 'deleted';
 
-      */
-    
     resource_version?:number;
-    
-    /**
-      * @description Timestamp when this differential price was last updated.
 
-      */
-    
     updated_at?:number;
-    
-    /**
-      * @description Timestamp at which this differential price was created.
 
-      */
-    
     created_at:number;
-    
-    /**
-      * @description Timestamp at which this differential price was last modified.
 
-      */
-    
     modified_at:number;
-    
-    /**
-      * @description The currency code (ISO 4217 format) of the plan
-
-      */
-    
-    currency_code:string;
-    
-    /**
-      * @description List of quantity-based pricing tiers for the differential price. Applicable only for &#x60;tiered&#x60;, &#x60;volume&#x60;, and &#x60;stairstep&#x60; &#x60;pricing_model&#x60; s. The tiers are exactly the same as those set for the item price. Only the &#x60;price&#x60; attribute for the various tiers can be overridden for the differential price.
 
-      */
-    
     tiers?:DifferentialPrice.Tier[];
-    
-    /**
-      * @description When &#x60;item_price_id&#x60; is a charge-item, you can specify the plan period for which the price applies. Although an array, currently you can specify only one period. In other words, only index &#x60;0&#x60; is allowed. Create another differential price to specify another period. Is permitted only when &#x60;item_price_id&#x60; is a charge-item.
 
-      */
-    
+    currency_code:string;
+
     parent_periods?:DifferentialPrice.ParentPeriod[];
 
     business_entity_id?:string;
+
+    deleted:boolean;
+
   }
   export namespace DifferentialPrice {
     export class DifferentialPriceResource {  
-      /**
-        * @description Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
-
-        */
-      
       create(item_price_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
-      /**
-        * @description Retrieve a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
-
-        */
-      
       retrieve(differential_price_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Update a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
-
-        */
-      
       update(differential_price_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
-      /**
-        * @description Delete a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
-
-        */
-      
       delete(differential_price_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
        
-      /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
     }
     export interface CreateResponse {  
@@ -137,41 +52,16 @@ declare module 'chargebee' {
     }
     export interface CreateInputParam {
        
-      /**
-        * @description The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard* or *Enterprise* plans-items mentioned in the [examples above](./differential_prices?prod_cat_ver&#x3D;2).
-
-        */
+      parent_periods:{period?:any[],period_unit:'day' | 'week' | 'month' | 'year'}[];
        
-      parent_item_id:string;
+      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
-      /**
-        * @description The differential price. If the pricing model of the &#x60;item_price_id&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60;, or &#x60;stairstep&#x60;, pass &#x60;tiers&#x60; instead of this.
-
-        */
+      parent_item_id:string;
        
       price?:number;
        
-      /**
-        * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-        */
-       
       price_in_decimal?:string;
        
-      /**
-        * @description Parameters for parent_periods
-
-        */
-       
-      parent_periods?:{period?:any[],period_unit:'week' | 'month' | 'year' | 'day'}[];
-       
-      /**
-        * @description Parameters for tiers
-
-        */
-       
-      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
-      
       business_entity_id?:string;
     }
     export interface RetrieveResponse {  
@@ -179,11 +69,6 @@ declare module 'chargebee' {
     }
     export interface RetrieveInputParam {
        
-      /**
-        * @description Retrieve a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
-
-        */
-        
       item_price_id:string;
     }
     export interface UpdateResponse {  
@@ -191,132 +76,77 @@ declare module 'chargebee' {
     }
     export interface UpdateInputParam {
        
-      /**
-        * @description The id of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
-
-        */
+      parent_periods:{period?:any[],period_unit:'day' | 'week' | 'month' | 'year'}[];
        
-      item_price_id:string;
+      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
-      /**
-        * @description The differential price. If the pricing model of the &#x60;item_price_id&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60;, or &#x60;stairstep&#x60;, pass &#x60;tiers&#x60; instead of this.
-
-        */
+      item_price_id:string;
        
       price?:number;
        
-      /**
-        * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-        */
-       
       price_in_decimal?:string;
-       
-      /**
-        * @description Parameters for parent_periods
-
-        */
-       
-      parent_periods?:{period?:any[],period_unit:'week' | 'month' | 'year' | 'day'}[];
-       
-      /**
-        * @description Parameters for tiers
-
-        */
-       
-      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
     export interface DeleteResponse {  
        differential_price:DifferentialPrice;
     }
     export interface DeleteInputParam {
        
-      /**
-        * @description The id of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
-
-        */
-       
       item_price_id:string;
     }
     export interface ListResponse {  
-      /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-       
        list:{differential_price:DifferentialPrice}[];
        
-      /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @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;
        
       /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @description The id of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
 
         */
         
       item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @description Item Id of Addon / Charge item price for which differential pricing is applied to
 
         */
         
       item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @description A unique and immutable id for the differential price. It is auto-generated when the differential price is created.
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @description The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard* or *Enterprise* plans-items mentioned in the [examples above](./differential_prices?prod_cat_ver&#x3D;2).
 
         */
         
       parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
     }
     export interface Tier {  
-         /**
-          * @description The lower limit of a range of units for the tier
-
-          */
-       
       starting_unit:number;
        
-         /**
-          * @description The upper limit of a range of units for the tier
-
-          */
-       
       ending_unit?:number;
        
-         /**
-          * @description The per-unit price for the tier when the &#x60;pricing_model&#x60; is &#x60;tiered&#x60; or &#x60;volume&#x60;; the total cost for the item price when the &#x60;pricing_model&#x60; is &#x60;stairstep&#x60;. The value is in the [minor unit of the currency](https://apidocs.chargebee.com/docs/api#handling_currency_units).
-
-          */
-       
       price:number;
        
       starting_unit_in_decimal?:string;
@@ -326,17 +156,7 @@ declare module 'chargebee' {
       price_in_decimal?:string;
     }
     export interface ParentPeriod {  
-         /**
-          * @description The unit of time for &#x60;period&#x60;. \* month - A period of 1 calendar month. \* day - A period of 24 hours. \* week - A period of 7 days. \* year - A period of 1 calendar year.
-
-          */
-       
-      period_unit:'week' | 'month' | 'year' | 'day';
-       
-         /**
-          * @description The billing period of the plan in &#x60;period_unit&#x60;s. For example, a 6 month plan has &#x60;period&#x60; as 6 and &#x60;period_unit&#x60; as &#x60;month&#x60;.
-
-          */
+      period_unit:'day' | 'week' | 'month' | 'year';
        
       period?:any[];
     }

package/types/resources/Event.d.ts

@@ -133,7 +133,7 @@ declare module 'chargebee' {
 
         */
         
-      webhook_status?:{in?:string,is?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped',is_not?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped',not_in?:string};
+      webhook_status?:{in?:string,is?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped' | 'disabled',is_not?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped',not_in?:string};
        
       /**
         * @description Retrieves list of events.
@@ -186,7 +186,7 @@ declare module 'chargebee' {
 
           */
        
-      webhook_status:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped';
+      webhook_status:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped' | 'disabled';
     }
   }
 }

package/types/resources/GatewayErrorDetail.d.ts

@@ -72,5 +72,7 @@ declare module 'chargebee' {
     processor_error_code?:string;
     
     processor_error_message?:string;
+
+    error_cause_id?:string;
   }
 }