chargebee 2.41.0 → 3.0.0-beta.2

package/types/resources/Download.d.ts

@@ -1,26 +1,10 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface Download {
-    
-    /**
-      * @description The URL at which the file is available for download.
-
-      */
-    
-    download_url:string;
-    
-    /**
-      * @description The time until which the &#x60;download_url&#x60; is valid.
-
-      */
-    
-    valid_till:number;
-    
-    /**
-      * @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
-
-      */
-    
-    mime_type?:string;
+    download_url: string;
+    valid_till: number;
+    mime_type?: string;
   }
-}
+}

package/types/resources/Entitlement.d.ts

@@ -1,175 +1,66 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Entitlement {
-    
-    /**
-      * @description A unique identifier for the entitlement. This is auto-generated.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description The unique identifier of the entity being granted entitlement to a specific &#x60;feature&#x60;.
-
-      */
-    
-    entity_id?:string;
-    
-    /**
-      * @description The type of the entity that holds this entitlement. \* plan -
-
-Indicates that the entity is an &#x60;item&#x60; with [type](items?prod_cat_ver&#x3D;2#item_type) set to &#x60;plan&#x60;.
-\* addon -
-
-Indicates that the entity is an &#x60;item&#x60; with [type](items?prod_cat_ver&#x3D;2#item_type) set to &#x60;addon&#x60;.
-\* addon_price -
-
-Indicates that the entity is an &#x60;item_price&#x60; associated with an &#x60;item&#x60; with [type](items?prod_cat_ver&#x3D;2#item_type) set to &#x60;addon&#x60;.
-\* charge -
-
-Indicates that the entity is an &#x60;item&#x60; with [type](items?prod_cat_ver&#x3D;2#item_type) set to &#x60;charge&#x60;.
-\* plan_price -
-
-Indicates that the entity is an &#x60;item_price&#x60; associated with an &#x60;item&#x60; of [type](items?prod_cat_ver&#x3D;2#item_type) &#x60;plan&#x60;.
-
-      */
-    
-    entity_type?:'charge' | 'addon' | 'addon_price' | 'plan_price' | 'plan';
-    
-    /**
-      * @description The unique identifier of the &#x60;feature&#x60; to which the entity gains entitlement.
-
-      */
-    
-    feature_id?:string;
-    
-    /**
-      * @description The &#x60;name&#x60; of the feature associated with this entitlement.
-
-      */
-    
-    feature_name?:string;
-    
-    /**
-      * @description The level of entitlement that the entity 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 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 value is automatically generated based on &#x60;feature.type&#x60;:
-
-* When &#x60;feature.type&#x60; is &#x60;quantity&#x60; or &#x60;range&#x60;, the &#x60;name&#x60; is the space-separated concatenation of &#x60;value&#x60; and the plural form of &#x60;feature.unit&#x60;. For instance, if &#x60;value&#x60; is &#x60;20&#x60; and &#x60;feature.unit&#x60; is &#x60;user&#x60;, the &#x60;name&#x60; will be &#x60;20 users&#x60;.
-* When &#x60;feature.type&#x60; is &#x60;custom&#x60;, the &#x60;name&#x60; matches the &#x60;value&#x60;.
-
-      */
-    
-    name?:string;
+    id: string;
+    entity_id?: string;
+    entity_type?: 'plan' | 'addon' | 'charge' | 'plan_price' | 'addon_price';
+    feature_id?: string;
+    feature_name?: string;
+    value?: string;
+    name?: string;
   }
-  export namespace Entitlement {
-    export class EntitlementResource {  
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
-
-        */
-      
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
-       
-      /**
-        * @description Create, update, or remove a set of &#x60;entitlement&#x60;s for a feature.
 
-The behavior depends on the specified &#x60;action&#x60;. It tries to create, update, or delete &#x60;entitlement&#x60; objects. If any of the entitlement objects fail to process, the entire operation stops with an error, and no entitlements are processed. In essence, the request processes either all the provided entitlements or none of them.
-
-        */
-      
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+  export namespace Entitlement {
+    export class EntitlementResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
     }
-    export interface ListResponse {  
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
 
-        */
-       
-       list:{entitlement:Entitlement}[];
-       
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
-
-        */
-       
-       next_offset?:string;
+    export interface ListResponse {
+      list: { entitlement: Entitlement }[];
+      next_offset?: string;
     }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
 
-        */
-        
-      offset?:string;
-       
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
-
-        */
-        
-      feature_id?:{in?:string,is?:string};
-       
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
+    export interface CreateResponse {
+      entitlement: Entitlement;
+    }
 
-        */
-        
-      entity_type?:{in?:string,is?:'charge' | 'addon' | 'addon_price' | 'plan_price' | 'plan'};
-       
-      /**
-        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-        
-      entity_id?:{in?:string,is?:string};
-    }
-    export interface CreateResponse {  
-       entitlement:Entitlement;
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      feature_id?: filter.String;
+      entity_type?: filter.Enum;
+      entity_id?: filter.String /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      include_drafts?: boolean /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      embed?: string;
     }
     export interface CreateInputParam {
-       
-      /**
-        * @description The specific action to be performed for each &#x60;entitlement&#x60; specified. \* upsert - If the &#x60;entitlement&#x60; already exists for the &#x60;feature_id&#x60; and &#x60;entity_id&#x60; combination, the &#x60;value&#x60; of the &#x60;entitlement&#x60; is updated. If it doesn&#x27;t exist, a new &#x60;entitlement&#x60; is created. \* remove - Deletes the &#x60;entitlement&#x60; for the &#x60;feature_id&#x60; and &#x60;entity_id&#x60; combination, if it exists.
-
-        */
-       
-      action:Action;
-       
-      /**
-        * @description Parameters for entitlements
-
-        */
-       
-      entitlements:{entity_id:string,entity_type?:'charge' | 'addon' | 'addon_price' | 'plan_price' | 'plan',feature_id:string,value?:string}[];
+      action: Action;
+      entitlements?: EntitlementsCreateInputParam[];
+    }
+    export interface EntitlementsCreateInputParam {
+      entity_id: string;
+      feature_id: string;
+      entity_type?: 'plan' | 'addon' | 'charge' | 'plan_price' | 'addon_price';
+      value?: string;
     }
-    
   }
-}
+}

package/types/resources/EntitlementOverride.d.ts

@@ -1,157 +1,76 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface EntitlementOverride {
-    
-    /**
-      * @description Unique identifier for the entitlement override. This is always auto-generated.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description The &#x60;id&#x60; of the subscription to which this entitlement override belongs.
-
-      */
-    
-    entity_id?:string;
-    
-    /**
-      * @description The name of Chargebee resource that this entitlement override is associated with. The value is always &#x60;subscription&#x60;.
-
-      */
-    
-    entity_type?:string;
-    
-    /**
-      * @description The &#x60;id&#x60; of the &#x60;feature&#x60; towards which this entitlement override has been granted.
-
-      */
-    
-    feature_id?:string;
-    
-    /**
-      * @description The &#x60;name&#x60; of the &#x60;feature&#x60; towards which this entitlement override 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;true&#x60; if the feature is available; it is set as &#x60;false&#x60; when the feature is unavailable.
-
-      */
-    
-    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;
-
-      */
-    
-    name?:string;
-    
-    /**
-      * @description The expiry date for the &#x60;entitlement_override&#x60;. Once expired, the &#x60;entitlement_override&#x60; object is no longer returned.
-
-      */
-    
-    expires_at?:number;
-
-    effective_from?:number;
-
-    schedule_status?:'activated' | 'scheduled' | 'failed';
-
+    id: string;
+    entity_id?: string;
+    entity_type?: string;
+    feature_id?: string;
+    feature_name?: string;
+    value?: string;
+    name?: string;
+    expires_at?: number;
+    effective_from?: number;
+    schedule_status?: 'activated' | 'scheduled' | 'failed';
   }
-  export namespace EntitlementOverride {
-    export class EntitlementOverrideResource {  
-      /**
-        * @description Upserts or removes a set of &#x60;entitlement_overrides&#x60; for a &#x60;subscription&#x60; depending on the &#x60;action&#x60; specified. The API returns the upserted or deleted &#x60;entitlement_overrides&#x60; after successfully completing the operation. The operation returns an error when the first &#x60;entitlement_override&#x60; fails to be processed. Either all the &#x60;entitlement_overrides&#x60; provided in the request are processed or none.
 
-        */
-      
-      add_entitlement_override_for_subscription(subscription_id:string, input?:AddEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<AddEntitlementOverrideForSubscriptionResponse>;
-       
-      /**
-        * @description Retrieve the list of entitlement overrides for a subscription.
-
-        */
-      
-      list_entitlement_override_for_subscription(subscription_id:string, input?:ListEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<ListEntitlementOverrideForSubscriptionResponse>;
-    }
-    export interface AddEntitlementOverrideForSubscriptionResponse {  
-       entitlement_override:EntitlementOverride;
+  export namespace EntitlementOverride {
+    export class EntitlementOverrideResource {
+      addEntitlementOverrideForSubscription(
+        subscription_id: string,
+        input: AddEntitlementOverrideForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<AddEntitlementOverrideForSubscriptionResponse>
+      >;
+
+      listEntitlementOverrideForSubscription(
+        subscription_id: string,
+        input?: ListEntitlementOverrideForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<ListEntitlementOverrideForSubscriptionResponse>
+      >;
     }
-    export interface AddEntitlementOverrideForSubscriptionInputParam {
-       
-      /**
-        * @description The specific action to be performed for each &#x60;entitlement_override&#x60; specified. . \* remove - Deletes the &#x60;entitlement_override&#x60; for the &#x60;feature_id&#x60; and &#x60;item_id&#x60; combination, if it exists. \* upsert - If the &#x60;entitlement_override&#x60; already exists for the &#x60;feature_id&#x60; and &#x60;{subscription_id}&#x60; combination, the &#x60;value&#x60; of the &#x60;entitlement_override&#x60; is updated. If it doesn&#x27;t exist, a new &#x60;entitlement_override&#x60; is created.
 
-        */
-       
-      action?:Action;
-       
-      /**
-        * @description Parameters for entitlement_overrides
+    export interface AddEntitlementOverrideForSubscriptionResponse {
+      entitlement_override: EntitlementOverride;
+    }
 
-        */
-       
-      entitlement_overrides?:{expires_at?:number,feature_id:string,value?:string}[];
+    export interface ListEntitlementOverrideForSubscriptionResponse {
+      list: { entitlement_override: EntitlementOverride }[];
+      next_offset?: string;
     }
-    export interface ListEntitlementOverrideForSubscriptionResponse {  
-      /**
-        * @description Retrieve the list of entitlement overrides for a subscription.
 
-        */
-       
-       list:{entitlement_override:EntitlementOverride}[];
-       
-      /**
-        * @description Retrieve the list of entitlement overrides for a subscription.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-       
-       next_offset?:string;
+    export interface AddEntitlementOverrideForSubscriptionInputParam {
+      action?: Action;
+      entitlement_overrides?: EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam[];
     }
     export interface ListEntitlementOverrideForSubscriptionInputParam {
-      [key : string]: any;  
-      /**
-        * @description Retrieve the list of entitlement overrides for a subscription.
+      limit?: number;
+      offset?: string /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
 
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description Retrieve the list of entitlement overrides for a subscription.
+      embed?: string /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
 
-        */
-        
-      offset?:string;
-       
-      embed?:string;
-       
-      include_drafts?:boolean;
-       
-      include_scheduled_overrides?:boolean;
+      include_drafts?: boolean /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      include_scheduled_overrides?: boolean;
+    }
+    export interface EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam {
+      feature_id: string;
+      value?: string;
+      expires_at?: number;
+      effective_from?: number;
     }
-    
   }
-}
+}