chargebee 2.40.0 → 3.0.0-beta.1

package/types/resources/ItemEntitlement.d.ts

@@ -1,240 +1,103 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.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;
+    id: string;
+    item_id?: string;
+    item_type?: 'plan' | 'addon' | 'charge' | 'subscription' | 'item';
+    feature_id?: string;
+    feature_name?: string;
+    value?: string;
+    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 namespace ItemEntitlement {
+    export class ItemEntitlementResource {
+      itemEntitlementsForItem(
+        item_id: string,
+        input?: ItemEntitlementsForItemInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ItemEntitlementsForItemResponse>>;
+
+      itemEntitlementsForFeature(
+        feature_id: string,
+        input?: ItemEntitlementsForFeatureInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ItemEntitlementsForFeatureResponse>>;
+
+      addItemEntitlements(
+        feature_id: string,
+        input: AddItemEntitlementsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AddItemEntitlementsResponse>>;
+
+      upsertOrRemoveItemEntitlementsForItem(
+        item_id: string,
+        input: UpsertOrRemoveItemEntitlementsForItemInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<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 ItemEntitlementsForItemResponse {
+      list: { item_entitlement: ItemEntitlement }[];
+      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.
 
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description **Deprecated**
+    export interface ItemEntitlementsForFeatureResponse {
+      list: { item_entitlement: ItemEntitlement }[];
+      next_offset?: string;
+    }
 
-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.
+    export interface AddItemEntitlementsResponse {
+      item_entitlement: ItemEntitlement;
+    }
 
-        */
-        
-      offset?:string;
+    export interface UpsertOrRemoveItemEntitlementsForItemResponse {
+      item_entitlement: ItemEntitlement;
     }
-    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.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-       
-       list:{item_entitlement:ItemEntitlement}[];
-       
-      /**
-        * @description **Deprecated**
+    export interface ItemEntitlementsForItemInputParam {
+      limit?: number;
+      offset?: string /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
 
-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.
+      include_drafts?: boolean /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
 
-        */
-       
-       next_offset?:string;
+      embed?: 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.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description **Deprecated**
+      limit?: number;
+      offset?: string /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
 
-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.
-
-        */
-        
-      offset?:string;
-    }
-    export interface AddItemEntitlementsResponse {  
-       item_entitlement:ItemEntitlement;
+      include_drafts?: boolean;
     }
     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 UpsertOrRemoveItemEntitlementsForItemResponse {  
-       item_entitlement:ItemEntitlement;
+      action: Action;
+      item_entitlements?: ItemEntitlementsAddItemEntitlementsInputParam[];
     }
     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}[];
+      action: Action;
+      item_entitlements?: ItemEntitlementsUpsertOrRemoveItemEntitlementsForItemInputParam[];
+    }
+    export interface ItemEntitlementsAddItemEntitlementsInputParam {
+      item_id: string;
+      item_type?: 'plan' | 'addon' | 'charge' | 'subscription' | 'item';
+      value?: string;
+    }
+    export interface ItemEntitlementsUpsertOrRemoveItemEntitlementsForItemInputParam {
+      feature_id: string;
+      value?: string;
     }
-    
   }
-}
+}

package/types/resources/ItemFamily.d.ts

@@ -1,198 +1,89 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 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 &#x60;id&#x60; and &#x60;name&#x60; 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, &#x60;resource_version&#x60; 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;
+    [key: string]: unknown;
+    id: string;
+    name: string;
+    description?: string;
+    status?: 'active' | 'deleted';
+    resource_version?: number;
+    updated_at?: number;
+    channel?: Channel;
   }
-  export namespace ItemFamily {
-    export class ItemFamilyResource {  
-      /**
-        * @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 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 updates the name and/or description of the item family.
 
-        */
-      
-      update(item_family_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
-       
-      /**
-        * @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.
-
-        */
-      
-      delete(item_family_id:string):ChargebeeRequest<DeleteResponse>;
-    }
-    export interface CreateResponse {  
-       item_family:ItemFamily;
+  export namespace ItemFamily {
+    export class ItemFamilyResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        item_family_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      update(
+        item_family_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        item_family_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
     }
-    export interface CreateInputParam {
-      [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 CreateResponse {
+      item_family: ItemFamily;
     }
-    
-    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 RetrieveResponse {
+      item_family: ItemFamily;
     }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @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.
 
-        */
-        
-      limit?:number;
-       
-      /**
-        * @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.
+    export interface ListResponse {
+      list: { item_family: ItemFamily }[];
+      next_offset?: string;
+    }
 
-        */
-        
-      offset?:string;
-       
-      /**
-        * @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.
+    export interface UpdateResponse {
+      item_family: ItemFamily;
+    }
 
-        */
-        
-      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @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.
+    export interface DeleteResponse {
+      item_family: ItemFamily;
+    }
 
-        */
-        
-      name?:{is?:string,is_not?:string,starts_with?:string};
-       
-      /**
-        * @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.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-        
-      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+    export interface CreateInputParam {
+      id: string;
+      name: string;
+      description?: string;
+      [key: string]: unknown;
     }
-    export interface UpdateResponse {  
-       item_family:ItemFamily;
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      name?: filter.String;
+      updated_at?: filter.Timestamp;
+      [key: string]: unknown;
     }
     export interface UpdateInputParam {
-      [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;
-    }
-    export interface DeleteResponse {  
-       item_family:ItemFamily;
+      name?: string;
+      description?: string;
+      [key: string]: unknown;
     }
-    
-    
   }
-}
+}