chargebee 2.25.3 → 2.26.1

package/types/resources/ItemEntitlement.d.ts

@@ -1,51 +1,210 @@
 ///<reference path='./../core.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.
+
+      */
+    
     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 {
+    export class ItemEntitlementResource {  
+      /**
+        * @description 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 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 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 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 ItemEntitlementsForFeatureResponse {
-      list:{item_entitlement:ItemEntitlement}[];
-      next_offset?:string;
+    export interface ItemEntitlementsForFeatureResponse {  
+      /**
+        * @description Retrieves a list of all the &#x60;item_entitlement&#x60;s for the &#x60;feature&#x60; specified.
+
+        */
+       
+       list:{item_entitlement:ItemEntitlement}[];
+       
+      /**
+        * @description 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;
+      [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 AddItemEntitlementsResponse {
-      item_entitlement:ItemEntitlement;
+    export interface AddItemEntitlementsResponse {  
+      /**
+        * @description 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.
+
+        */
+       
+       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.
+
+        */
+       
       action:Action;
+       
+      /**
+        * @description Parameters for item_entitlements
+
+        */
+       
       item_entitlements?:{item_id:string,item_type?:'item' | 'charge' | 'addon' | 'subscription' | 'plan',value?:string}[];
     }
-    export interface ItemEntitlementsForItemResponse {
-      list:{item_entitlement:ItemEntitlement}[];
-      next_offset?:string;
+    export interface ItemEntitlementsForItemResponse {  
+      /**
+        * @description Retrieves a list of all the &#x60;item_entitlements&#x60; for the &#x60;item&#x60; specified.
+
+        */
+       
+       list:{item_entitlement:ItemEntitlement}[];
+       
+      /**
+        * @description 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;
+      [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 UpsertOrRemoveItemEntitlementsForItemResponse {
-      item_entitlement:ItemEntitlement;
+    export interface UpsertOrRemoveItemEntitlementsForItemResponse {  
+      /**
+        * @description 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.
+
+        */
+       
+       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.
+
+        */
+       
       action:Action;
+       
+      /**
+        * @description Parameters for item_entitlements
+
+        */
+       
       item_entitlements?:{feature_id:string,value?:string}[];
     }
     

package/types/resources/ItemFamily.d.ts

@@ -2,57 +2,215 @@
 declare module 'chargebee' {
   export interface ItemFamily {
     [key : string] : any;
+    /**
+      * @description The identifier for the item family. It is unique and immutable.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description A unique display name for the item family. This is visible only in Chargebee and not to customers.
+
+      */
+    
     name:string;
+    
+    /**
+      * @description Description of the item family. This is visible only in Chargebee and not to customers.
+
+      */
+    
     description?:string;
+    
+    /**
+      * @description Status of the item family. \* active - The item family is active and can be used to create new items. \* deleted - The item family has been deleted and cannot be used to create new items. The `id` and `name` can be reused to create a new item family.
+
+      */
+    
     status?:'deleted' | 'active';
+    
+    /**
+      * @description The version number of this resource. For every change made to the resource, `resource_version` is updated with a new timestamp in milliseconds.
+
+      */
+    
     resource_version?:number;
+    
+    /**
+      * @description When the item family was last updated.
+
+      */
+    
     updated_at?:number;
+    
+    /**
+      * @description The subscription channel this object originated from and is maintained in. \* app_store - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* play_store - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \* web - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI.
+
+      */
+    
     channel?:Channel;
   }
   export namespace ItemFamily {
-    export class ItemFamilyResource {
+    export class ItemFamilyResource {  
+      /**
+        * @description Deletes an item family, marking its `status` as `deleted`. This is not allowed if there are `active` items under the item family. Once deleted, the `id` and `name` of the item family can be reused to create a new item family.
+
+        */
+      
       delete(item_family_id:string):ChargebeeRequest<DeleteResponse>;
+       
+      /**
+        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+
+        */
+      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
+      /**
+        * @description This endpoint creates an item family for your product line or service.
+
+        */
+      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+       
+      /**
+        * @description This endpoint retrieves an item family based on the item family id.
+
+        */
+      
       retrieve(item_family_id:string):ChargebeeRequest<RetrieveResponse>;
+       
+      /**
+        * @description This endpoint updates the name and/or description of the item family.
+
+        */
+      
       update(item_family_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
     }
-    export interface DeleteResponse {
-      item_family:ItemFamily;
+    export interface DeleteResponse {  
+      /**
+        * @description Deletes an item family, marking its &#x60;status&#x60; as &#x60;deleted&#x60;. This is not allowed if there are &#x60;active&#x60; items under the item family. Once deleted, the &#x60;id&#x60; and &#x60;name&#x60; of the item family can be reused to create a new item family.
+
+        */
+       
+       item_family:ItemFamily;
     }
     
-    export interface ListResponse {
-      list:{item_family:ItemFamily}[];
-      next_offset?:string;
+    export interface ListResponse {  
+      /**
+        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+
+        */
+       
+       list:{item_family:ItemFamily}[];
+       
+      /**
+        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+
+        */
+       
+       next_offset?:string;
     }
     export interface ListInputParam {
-      [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;
+       
+      /**
+        * @description The identifier for the item family. It is unique and immutable.
+
+        */
+        
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description A unique display name for the item family. This is visible only in Chargebee and not to customers.
+
+        */
+        
       name?:{is?:string,is_not?:string,starts_with?:string};
+       
+      /**
+        * @description When the item family was last updated.
+
+        */
+        
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
     }
-    export interface CreateResponse {
-      item_family:ItemFamily;
+    export interface CreateResponse {  
+      /**
+        * @description This endpoint creates an item family for your product line or service.
+
+        */
+       
+       item_family:ItemFamily;
     }
     export interface CreateInputParam {
-      [key : string] : any;
+      [key : string] : any;  
+      /**
+        * @description The identifier for the item family. Must be unique and is immutable.
+
+        */
+       
       id:string;
+       
+      /**
+        * @description The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.
+
+        */
+       
       name:string;
+       
+      /**
+        * @description Description of the item family. This is visible only in Chargebee and not to customers.
+
+        */
+       
       description?:string;
     }
-    export interface RetrieveResponse {
-      item_family:ItemFamily;
+    export interface RetrieveResponse {  
+      /**
+        * @description This endpoint retrieves an item family based on the item family id.
+
+        */
+       
+       item_family:ItemFamily;
     }
     
-    export interface UpdateResponse {
-      item_family:ItemFamily;
+    export interface UpdateResponse {  
+      /**
+        * @description This endpoint updates the name and/or description of the item family.
+
+        */
+       
+       item_family:ItemFamily;
     }
     export interface UpdateInputParam {
-      [key : string] : any;
+      [key : string] : any;  
+      /**
+        * @description The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.
+
+        */
+       
       name?:string;
+       
+      /**
+        * @description Description of the item family. This is visible only in Chargebee and not to customers.
+
+        */
+       
       description?:string;
     }