chargebee 2.51.0 → 2.53.0

package/types/resources/ItemEntitlement.d.ts

@@ -1,239 +1,99 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface ItemEntitlement {
     
-    /**
-      * @description A unique identifier for the &#x60;item_entitlement&#x60;. This is auto-generated.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description The &#x60;id&#x60; of the &#x60;item&#x60; to which this entitlement belongs.
 
-      */
-    
     item_id?:string;
-    
-    /**
-      * @description The &#x60;type&#x60; of the &#x60;item&#x60; to which this entitlement belongs. \* charge - Charge \* item - Item \* subscription - Subscription \* addon - Addon \* plan - Plan
 
-      */
-    
-    item_type?:'item' | 'charge' | 'addon' | 'subscription' | 'plan';
-    
-    /**
-      * @description The &#x60;id&#x60; of the feature towards which this entitlement has been granted.
+    item_type?:'plan' | 'addon' | 'charge' | 'subscription' | 'item';
 
-      */
-    
     feature_id?:string;
-    
-    /**
-      * @description The &#x60;name&#x60; of the &#x60;feature&#x60; towards which this entitlement has been granted.
 
-      */
-    
     feature_name?:string;
-    
-    /**
-      * @description The level of entitlement that the item has towards the feature. The possible values depend on the value of &#x60;feature.type&#x60;:
 
-* When &#x60;feature.type&#x60; is &#x60;quantity&#x60; and:
-  * If &#x60;feature.levels[is_unlimited]&#x60; is not &#x60;true&#x60; for any one of &#x60;feature.levels[]&#x60;, then the value can be any one of &#x60;feature.levels[value][]&#x60;.
-  * If &#x60;feature.levels[is_unlimited]&#x60; is &#x60;true&#x60; for one of the &#x60;feature.levels[]&#x60;, then the value can also be:
-    * any one of &#x60;feature.levels[value][]&#x60;
-    * or it can be &#x60;unlimited&#x60; (case-insensitive), indicating unlimited entitlement.
-* When &#x60;type&#x60; is &#x60;range&#x60; and:
-  * If &#x60;feature.levels[is_unlimited]&#x60; is not &#x60;true&#x60; for any one of &#x60;feature.levels[]&#x60;, then the value can be any whole number between &#x60;levels[value][0]&#x60; and &#x60;levels[value][1]&#x60; (inclusive).
-  * If &#x60;feature.levels[is_unlimited]&#x60; is &#x60;true&#x60; for one of the &#x60;feature.levels[]&#x60;, then the value can be:
-    * any whole number equal to or greater than &#x60;levels[value][0]&#x60;
-    * or it can be &#x60;unlimited&#x60; (case-insensitive), indicating unlimited entitlement.
-* When &#x60;type&#x60; is &#x60;custom&#x60;, then the value can be any one of &#x60;feature.levels[value][]&#x60;.
-* When &#x60;type&#x60; is &#x60;switch&#x60;, then the value is set as &#x60;available&#x60; or &#x60;true&#x60;.
-
-      */
-    
     value?:string;
-    
-    /**
-      * @description The display name for the entitlement level. The default values are auto-generated based on &#x60;feature.type&#x60; as follows:
 
-* When &#x60;feature.type&#x60; is &#x60;quantity&#x60; or &#x60;range&#x60;, then &#x60;name&#x60; is the space-separated concatenation of &#x60;value&#x60; and the pluralized version 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;, then &#x60;name&#x60; is the same as &#x60;value&#x60;.a
-
-      */
-    
     name?:string;
+
   }
   export namespace ItemEntitlement {
     export class ItemEntitlementResource {  
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlements&#x60; for the &#x60;item&#x60; specified.
-
-        */
-      
       item_entitlements_for_item(item_id:string, input?:ItemEntitlementsForItemInputParam):ChargebeeRequest<ItemEntitlementsForItemResponse>;
        
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlement&#x60;s for the &#x60;feature&#x60; specified.
-
-        */
-      
       item_entitlements_for_feature(feature_id:string, input?:ItemEntitlementsForFeatureInputParam):ChargebeeRequest<ItemEntitlementsForFeatureResponse>;
        
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [Manage entitlements](entitlements?prod_cat_ver&#x3D;2#upsert_or_remove_entitlements_for_a_feature).
-
-Upserts or removes a set of &#x60;item_entitlement&#x60;s for an &#x60;feature&#x60; depending on the &#x60;action&#x60; specified. The API returns the upserted or deleted &#x60;item_entitlements&#x60; after successfully completing the operation. The operation returns an error when the first &#x60;item_entitlement&#x60; fails to be processed. Either all the &#x60;item_entitlement&#x60;s provided in the request are processed or none.
-
-        */
-      
       add_item_entitlements(feature_id:string, input:AddItemEntitlementsInputParam):ChargebeeRequest<AddItemEntitlementsResponse>;
        
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [Manage entitlements](entitlements?prod_cat_ver&#x3D;2#upsert_or_remove_entitlements_for_a_feature).
-
-Upserts or removes a set of &#x60;item_entitlements&#x60; for an [item](items?prod_cat_ver&#x3D;2) depending on the &#x60;action&#x60; specified. The API returns the upserted or deleted &#x60;item_entitlements&#x60; after successfully completing the operation. The operation returns an error when the first &#x60;item_entitlement&#x60; fails to be processed. Either all the &#x60;item_entitlement&#x60;s provided in the request are processed or none.
-
-        */
-      
       upsert_or_remove_item_entitlements_for_item(item_id:string, input:UpsertOrRemoveItemEntitlementsForItemInputParam):ChargebeeRequest<UpsertOrRemoveItemEntitlementsForItemResponse>;
     }
     export interface ItemEntitlementsForItemResponse {  
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlements&#x60; for the &#x60;item&#x60; specified.
-
-        */
-       
        list:{item_entitlement:ItemEntitlement}[];
        
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlements&#x60; for the &#x60;item&#x60; specified.
-
-        */
-       
        next_offset?:string;
     }
     export interface ItemEntitlementsForItemInputParam {
       [key : string]: any;  
       /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlements&#x60; for the &#x60;item&#x60; specified.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlements&#x60; for the &#x60;item&#x60; specified.
+        * @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;
+       
+      include_drafts?:boolean;
+       
+      embed?:string;
     }
     export interface ItemEntitlementsForFeatureResponse {  
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlement&#x60;s for the &#x60;feature&#x60; specified.
-
-        */
-       
        list:{item_entitlement:ItemEntitlement}[];
        
-      /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlement&#x60;s for the &#x60;feature&#x60; specified.
-
-        */
-       
        next_offset?:string;
     }
     export interface ItemEntitlementsForFeatureInputParam {
       [key : string]: any;  
       /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlement&#x60;s for the &#x60;feature&#x60; specified.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description **Deprecated**
-
-This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver&#x3D;2#list_all_entitlements).
-Retrieves a list of all the &#x60;item_entitlement&#x60;s for the &#x60;feature&#x60; specified.
+        * @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;
+       
+      include_drafts?:boolean;
     }
     export interface AddItemEntitlementsResponse {  
        item_entitlement:ItemEntitlement;
     }
     export interface AddItemEntitlementsInputParam {
        
-      /**
-        * @description The specific action to be performed for each &#x60;item_entitlement&#x60; specified. \* remove - Deletes the &#x60;item_entitlement&#x60; for the &#x60;feature_id&#x60; and &#x60;item_id&#x60; combination, if it exists. \* upsert - If the &#x60;item_entitlement&#x60; already exists for the &#x60;feature_id&#x60; and &#x60;item_id&#x60; combination, the &#x60;value&#x60; of the &#x60;item_entitlement&#x60; is updated. If it doesn&#x27;t exist, a new &#x60;item_entitelment&#x60; is created.
-
-        */
+      item_entitlements:{item_id:string,item_type?:'plan' | 'addon' | 'charge' | 'subscription' | 'item',value?:string}[];
        
       action:Action;
-       
-      /**
-        * @description Parameters for item_entitlements
-
-        */
-       
-      item_entitlements?:{item_id:string,item_type?:'item' | 'charge' | 'addon' | 'subscription' | 'plan',value?:string}[];
     }
     export interface UpsertOrRemoveItemEntitlementsForItemResponse {  
        item_entitlement:ItemEntitlement;
     }
     export interface UpsertOrRemoveItemEntitlementsForItemInputParam {
        
-      /**
-        * @description The specific action to be performed for each &#x60;item_entitlement&#x60; specified. \* remove - Deletes the &#x60;item_entitlement&#x60; for the &#x60;feature_id&#x60; and &#x60;item_id&#x60; combination, if it exists. \* upsert - If the &#x60;item_entitlement&#x60; already exists for the &#x60;feature_id&#x60; and &#x60;item_id&#x60; combination, the &#x60;value&#x60; of the &#x60;item_entitlement&#x60; is updated. If it doesn&#x27;t exist, a new &#x60;item_entitelment&#x60; is created.
-
-        */
+      item_entitlements:{feature_id:string,value?:string}[];
        
       action:Action;
-       
-      /**
-        * @description Parameters for item_entitlements
-
-        */
-       
-      item_entitlements?:{feature_id:string,value?:string}[];
     }
     
   }

package/types/resources/ItemFamily.d.ts

@@ -39,7 +39,7 @@ declare module 'chargebee' {
        item_family:ItemFamily;
     }
     export interface CreateInputParam {
-      [key : string] : any;  
+       
       id:string;
        
       name:string;
@@ -67,7 +67,7 @@ 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.
 
         */
         
@@ -111,7 +111,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        item_family:ItemFamily;
     }
     export interface UpdateInputParam {
-      [key : string] : any;  
+       
       name?:string;
        
       description?:string;

package/types/resources/ItemPrice.d.ts

@@ -111,7 +111,7 @@ declare module 'chargebee' {
        item_price:ItemPrice;
     }
     export interface CreateInputParam {
-      [key : string] : any;  
+       
       tax_detail?:{avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,hsn_code?:string,tax_profile_id?:string,taxjar_product_code?:string};
        
       accounting_detail?:{accounting_category1?:string,accounting_category2?:string,accounting_category3?:string,accounting_category4?:string,accounting_code?:string,sku?:string};
@@ -260,7 +260,7 @@ 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.
 
         */
         
@@ -384,7 +384,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
         
       channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string};
        
-      sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
+      sort_by?:object;
     }
     export interface DeleteResponse {  
        item_price:ItemPrice;
@@ -405,13 +405,13 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       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;
        
-      sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
+      sort_by?:object;
     }
     export interface FindApplicableItemPricesResponse {  
        list:{item_price:ItemPrice}[];
@@ -428,7 +428,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       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.
 
         */
         
@@ -436,7 +436,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       item_id?:string;
        
-      sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
+      sort_by?:object;
     }
     export interface Tier {  
       starting_unit:number;

package/types/resources/NonSubscription.d.ts

@@ -1,14 +1,17 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface NonSubscription {
     
+
     app_id:string;
-    
+
     invoice_id:string;
-    
+
     customer_id?:string;
-    
+
     charge_id:string;
+
   }
   export namespace NonSubscription {
     export class NonSubscriptionResource {  
@@ -19,11 +22,11 @@ declare module 'chargebee' {
     }
     export interface ProcessReceiptInputParam {
        
-      receipt:string;
-       
-      product:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'non_consumable' | 'consumable' | 'non_renewing_subscription'};
+      product:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'consumable' | 'non_consumable' | 'non_renewing_subscription'};
        
       customer?:{email?:string,first_name?:string,id?:string,last_name?:string};
+       
+      receipt:string;
     }
     
   }

package/types/resources/OmnichannelOneTimeOrder.d.ts

@@ -0,0 +1,90 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface OmnichannelOneTimeOrder {
+    
+
+    id:string;
+
+    app_id:string;
+
+    customer_id?:string;
+
+    id_at_source:string;
+
+    origin?:string;
+
+    source:'apple_app_store' | 'google_play_store';
+
+    created_at:number;
+
+    resource_version?:number;
+
+    omnichannel_one_time_order_items:OmnichannelOneTimeOrderItem[];
+
+    purchase_transaction?:OmnichannelOneTimeOrder.OmnichannelTransaction;
+
+  }
+  export namespace OmnichannelOneTimeOrder {
+    export class OmnichannelOneTimeOrderResource {  
+      retrieve(omnichannel_one_time_order_id:string):ChargebeeRequest<RetrieveResponse>;
+       
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+    }
+    export interface RetrieveResponse {  
+       omnichannel_one_time_order:OmnichannelOneTimeOrder;
+    }
+    
+    export interface ListResponse {  
+       list:{omnichannel_one_time_order:OmnichannelOneTimeOrder}[];
+       
+       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;
+       
+      source?:{in?:string,is?:'apple_app_store' | 'google_play_store',is_not?:'apple_app_store' | 'google_play_store',not_in?:string};
+       
+      /**
+        * @description Chargebee Customer External Identifier
+
+        */
+        
+      customer_id?:{is?:string,is_not?:string,starts_with?:string};
+    }
+    export interface OmnichannelTransaction {  
+      id:string;
+       
+      id_at_source:string;
+       
+      app_id:string;
+       
+      price_currency?:string;
+       
+      price_units?:number;
+       
+      price_nanos?:number;
+       
+      type:'purchase' | 'renewal';
+       
+      transacted_at?:number;
+       
+      created_at:number;
+       
+      resource_version?:number;
+    }
+  }
+}

package/types/resources/OmnichannelOneTimeOrderItem.d.ts

@@ -0,0 +1,24 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface OmnichannelOneTimeOrderItem {
+    
+
+    id:string;
+
+    item_id_at_source:string;
+
+    item_type_at_source?:string;
+
+    quantity?:number;
+
+    cancelled_at?:number;
+
+    cancellation_reason?:'customer_cancelled' | 'customer_did_not_consent_to_price_increase' | 'refunded_due_to_app_issue' | 'refunded_for_other_reason' | 'merchant_revoked';
+
+    created_at:number;
+
+    resource_version?:number;
+
+  }
+}

package/types/resources/OmnichannelSubscription.d.ts

@@ -50,7 +50,7 @@ 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.
 
         */
         
@@ -80,7 +80,7 @@ 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.
 
         */
         

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -58,7 +58,7 @@ 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.
 
         */
         

package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts

@@ -10,7 +10,7 @@ declare module 'chargebee' {
 
     scheduled_at:number;
 
-    change_type:'downgrade';
+    change_type:'downgrade' | 'pause';
 
     created_at:number;
 

package/types/resources/Order.d.ts

@@ -316,7 +316,7 @@ 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.
 
         */
         
@@ -429,7 +429,7 @@ declare module 'chargebee' {
         
       original_order_id?:{is?:string,is_not?:string,starts_with?:string};
        
-      sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
+      sort_by?:object;
     }
     export interface OrdersForInvoiceResponse {  
        list:{order:Order}[];
@@ -446,7 +446,7 @@ 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.
 
         */