chargebee 2.40.0 → 3.0.0-beta.1

package/types/resources/AttachedItem.d.ts

@@ -1,352 +1,114 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface AttachedItem {
-    
-    /**
-      * @description The unique id for the attached item. Set to a random, immutable value automatically when the attached item is created.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description The id of the plan-item to which the item is attached.
-
-      */
-    
-    parent_item_id:string;
-    
-    /**
-      * @description The id of the item being attached.
-
-      */
-    
-    item_id:string;
-    
-    /**
-      * @description The type of attachment for the addon. Only applicable for addon-items. \* recommended - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). \* optional - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a &#x60;quantity&#x60; and &#x60;billing_cycles&#x60; for the addon, for when it is applied to subscriptions with the plan. \* mandatory - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver&#x3D;2) via API.
-
-      */
-    
-    type:'optional' | 'mandatory' | 'recommended';
-    
-    /**
-      * @description The item state. \* active - New subscriptions can be created with the item. \* deleted - No subscriptions allowed for the item. \* archived - No new subscriptions allowed for the item.
-
-      */
-    
-    status?:'archived' | 'deleted' | 'active';
-    
-    /**
-      * @description The default quantity of the addon to be attached when the quantity is not specified while [creating](subscriptions?prod_cat_ver&#x3D;2#create_subscription_for_items)/[updating](subscriptions?prod_cat_ver&#x3D;2#update_subscription_for_items) the subscription.
-
-      */
-    
-    quantity?:number;
-    
-    /**
-      * @description The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-      */
-    
-    quantity_in_decimal?:string;
-    
-    /**
-      * @description The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) to be enabled for the site.   
-The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addon to a subscription](./subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items) takes precedence over this attribute. This attribute, in turn, has a higher precedence than [the value set for the addon-item price](./item_prices?prod_cat_ver&#x3D;2).
-
-      */
-    
-    billing_cycles?:number;
-    
-    /**
-      * @description Indicates when the item is charged. This attribute only applies to charge-items. \* contract_termination - when a contract term is [terminated](./subscriptions?prod_cat_ver&#x3D;2#cancel_subscription_for_items_contract_term_cancel_option). \* subscription_creation - the time of creation of the subscription. \* subscription_trial_start - the time when the trial period of the subscription begins. \* on_demand - Item can be charged on demand \* plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. \* subscription_activation - the moment a subscription enters an &#x60;active&#x60; or &#x60;non-renewing&#x60; state. Also includes reactivations of canceled subscriptions.
-
-      */
-    
-    charge_on_event:ChargeOnEvent;
-    
-    /**
-      * @description Indicates if the charge-item is to be charged only once or each time the &#x60;charge_on_event&#x60; occurs. This attribute only applies to charge-items.
-
-      */
-    
-    charge_once:boolean;
-    
-    /**
-      * @description The time at which this attached item was created.
-
-      */
-    
-    created_at:number;
-    
-    /**
-      * @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.
-
-      */
-    
-    resource_version?:number;
-    
-    /**
-      * @description The time at which this attached item was last updated.
-
-      */
-    
-    updated_at?:number;
-    
-    /**
-      * @description The subscription channel this object originated from and is maintained in. \* web - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* 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.
-
-      */
-    
-    channel?:Channel;
+    id: string;
+    parent_item_id: string;
+    item_id: string;
+    type: 'recommended' | 'mandatory' | 'optional';
+    status?: 'active' | 'archived' | 'deleted';
+    quantity?: number;
+    quantity_in_decimal?: string;
+    billing_cycles?: number;
+    charge_on_event: ChargeOnEvent;
+    charge_once: boolean;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    channel?: Channel;
   }
-  export namespace AttachedItem {
-    export class AttachedItemResource {  
-      /**
-        * @description Creates an attached addon or a charge item for a plan.
-
-        */
-      
-      create(item_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-       
-      /**
-        * @description Updates an attached addon or a charge item for a plan.
-
-        */
-      
-      update(attached_item_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
-       
-      /**
-        * @description Retrieves details of an attached addon or a charge item.
-
-        */
-      
-      retrieve(attached_item_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description Deletes an attached addon or a charge item.
 
-        */
-      
-      delete(attached_item_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
-       
-      /**
-        * @description Returns a list of attached items 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(item_id:string, input?:ListInputParam):ChargebeeRequest<ListResponse>;
-    }
-    export interface CreateResponse {  
-       attached_item:AttachedItem;
+  export namespace AttachedItem {
+    export class AttachedItemResource {
+      create(
+        item_id: string,
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        attached_item_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      retrieve(
+        attached_item_id: string,
+        input: RetrieveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        attached_item_id: string,
+        input: DeleteInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        item_id: string,
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
     }
-    export interface CreateInputParam {
-       
-      /**
-        * @description The id of the addon or charge that is being attached to the plan-item.
-
-        */
-       
-      item_id:string;
-       
-      /**
-        * @description The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items. \* recommended - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). \* optional - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a &#x60;quantity&#x60; and &#x60;billing_cycles&#x60; for the addon, for when it is applied to subscriptions with the plan. \* mandatory - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver&#x3D;2) via API.
-
-        */
-       
-      type?:'optional' | 'mandatory' | 'recommended';
-       
-      /**
-        * @description The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) to be enabled for the site.  
-
-The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addon to a subscription](./subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items) takes precedence over this parameter. This parameter, in turn, has a higher precedence than [the value set for the addon-item price](./item_prices?prod_cat_ver&#x3D;2).
-
-        */
-       
-      billing_cycles?:number;
-       
-      /**
-        * @description The default quantity of the addon to be attached when the quantity is not specified while [creating](subscriptions?prod_cat_ver&#x3D;2#create_subscription_for_items)/[updating](subscriptions?prod_cat_ver&#x3D;2#update_subscription_for_items) the subscription.
-
-        */
-       
-      quantity?:number;
-       
-      /**
-        * @description The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
 
-        */
-       
-      quantity_in_decimal?:string;
-       
-      /**
-        * @description Indicates when the item is charged. This parameter only applies to charge-items. \* contract_termination - when a contract term is [terminated](./subscriptions?prod_cat_ver&#x3D;2#cancel_subscription_for_items_contract_term_cancel_option). \* subscription_creation - the time of creation of the subscription. \* subscription_trial_start - the time when the trial period of the subscription begins. \* on_demand - Item can be charged on demand \* plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. \* subscription_activation - the moment a subscription enters an &#x60;active&#x60; or &#x60;non-renewing&#x60; state. Also includes reactivations of canceled subscriptions.
-
-        */
-       
-      charge_on_event?:ChargeOnEvent;
-       
-      /**
-        * @description Indicates if the charge-item is to be charged only once or each time the &#x60;charge_on_event&#x60; occurs. This parameter only applies to charge-items.
-
-        */
-       
-      charge_once?:boolean;
+    export interface CreateResponse {
+      attached_item: AttachedItem;
     }
-    export interface UpdateResponse {  
-       attached_item:AttachedItem;
-    }
-    export interface UpdateInputParam {
-       
-      /**
-        * @description The id of the parent item in the attachment relationship.
 
-        */
-       
-      parent_item_id:string;
-       
-      /**
-        * @description The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items. \* recommended - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). \* optional - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a &#x60;quantity&#x60; and &#x60;billing_cycles&#x60; for the addon, for when it is applied to subscriptions with the plan. \* mandatory - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver&#x3D;2) via API.
-
-        */
-       
-      type?:'optional' | 'mandatory' | 'recommended';
-       
-      /**
-        * @description The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) to be enabled for the site.  
-
-The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addon to a subscription](./subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items) takes precedence over this parameter. This parameter, in turn, has a higher precedence than [the value set for the addon-item price](./item_prices?prod_cat_ver&#x3D;2).
+    export interface UpdateResponse {
+      attached_item: AttachedItem;
+    }
 
-        */
-       
-      billing_cycles?:number;
-       
-      /**
-        * @description The default quantity of the addon to be attached when the quantity is not specified while [creating](subscriptions?prod_cat_ver&#x3D;2#create_subscription_for_items)/[updating](subscriptions?prod_cat_ver&#x3D;2#update_subscription_for_items) the subscription.
+    export interface RetrieveResponse {
+      attached_item: AttachedItem;
+    }
 
-        */
-       
-      quantity?:number;
-       
-      /**
-        * @description The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+    export interface DeleteResponse {
+      attached_item: AttachedItem;
+    }
 
-        */
-       
-      quantity_in_decimal?:string;
-       
-      /**
-        * @description Indicates when the item is charged. This parameter only applies to charge-items. \* contract_termination - when a contract term is [terminated](./subscriptions?prod_cat_ver&#x3D;2#cancel_subscription_for_items_contract_term_cancel_option). \* subscription_creation - the time of creation of the subscription. \* subscription_trial_start - the time when the trial period of the subscription begins. \* on_demand - Item can be charged on demand \* plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. \* subscription_activation - the moment a subscription enters an &#x60;active&#x60; or &#x60;non-renewing&#x60; state. Also includes reactivations of canceled subscriptions.
+    export interface ListResponse {
+      list: { attached_item: AttachedItem }[];
+      next_offset?: string;
+    }
 
-        */
-       
-      charge_on_event?:ChargeOnEvent;
-       
-      /**
-        * @description Indicates if the charge-item is to be charged only once or each time the &#x60;charge_on_event&#x60; occurs. This parameter only applies to charge-items.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-       
-      charge_once?:boolean;
+    export interface CreateInputParam {
+      item_id: string;
+      type?: 'recommended' | 'mandatory' | 'optional';
+      billing_cycles?: number;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      charge_on_event?: ChargeOnEvent;
+      charge_once?: boolean;
     }
-    export interface RetrieveResponse {  
-       attached_item:AttachedItem;
+    export interface UpdateInputParam {
+      parent_item_id: string;
+      type?: 'recommended' | 'mandatory' | 'optional';
+      billing_cycles?: number;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      charge_on_event?: ChargeOnEvent;
+      charge_once?: boolean;
     }
     export interface RetrieveInputParam {
-       
-      /**
-        * @description Retrieves details of an attached addon or a charge item.
-
-        */
-        
-      parent_item_id:string;
-    }
-    export interface DeleteResponse {  
-       attached_item:AttachedItem;
+      parent_item_id: string;
     }
     export interface DeleteInputParam {
-       
-      /**
-        * @description The id of the addon or charge that is being attached to the plan-item.
-
-        */
-       
-      parent_item_id:string;
-    }
-    export interface ListResponse {  
-      /**
-        * @description Returns a list of attached items 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:{attached_item:AttachedItem}[];
-       
-      /**
-        * @description Returns a list of attached items 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;
+      parent_item_id: string;
     }
     export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      offset?:string;
-       
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      type?:{in?:string,is?:'optional' | 'mandatory' | 'recommended',is_not?:'optional' | 'mandatory' | 'recommended',not_in?:string};
-       
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
-       
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      charge_on_event?:{in?:string,is?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',is_not?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',not_in?:string};
-       
-      /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-        
-      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      item_id?: filter.String;
+      type?: filter.Enum;
+      item_type?: filter.Enum;
+      charge_on_event?: filter.Enum;
+      updated_at?: filter.Timestamp;
     }
-    
   }
-}
+}

package/types/resources/Attribute.d.ts

@@ -1,9 +1,9 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface Attribute {
-    
-    name:string;
-    
-    value:string;
+    name: string;
+    value: string;
   }
-}
+}

package/types/resources/BusinessEntity.d.ts

@@ -1,84 +1,64 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface BusinessEntity {
-    
-    id:string;
-    
-    name:string;
-    
-    status:'active' | 'inactive';
-    
-    deleted:boolean;
-    
-    created_at:number;
-    
-    resource_version?:number;
-    
-    updated_at?:number;
+    id: string;
+    name: string;
+    status: 'active' | 'inactive';
+    deleted: boolean;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
   }
+
   export namespace BusinessEntity {
-    export class BusinessEntityResource {  
-      create_transfers(input:CreateTransfersInputParam):ChargebeeRequest<CreateTransfersResponse>;
-       
-      get_transfers(input?:GetTransfersInputParam):ChargebeeRequest<GetTransfersResponse>;
-    }
-    export interface CreateTransfersResponse {  
-       business_entity_transfer:BusinessEntityTransfer;
+    export class BusinessEntityResource {
+      createTransfers(
+        input: CreateTransfersInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateTransfersResponse>>;
+
+      getTransfers(
+        input?: GetTransfersInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<GetTransfersResponse>>;
     }
-    export interface CreateTransfersInputParam {
-       
-      active_resource_ids:string[];
-       
-      destination_business_entity_ids:string[];
-       
-      source_business_entity_ids?:string[];
-       
-      resource_types:string[];
-       
-      reason_codes:string[];
+
+    export interface CreateTransfersResponse {
+      business_entity_transfer: BusinessEntityTransfer;
     }
-    export interface GetTransfersResponse {  
-       list:{business_entity_transfer:BusinessEntityTransfer}[];
-       
-       next_offset?:string;
+
+    export interface GetTransfersResponse {
+      list: { business_entity_transfer: BusinessEntityTransfer }[];
+      next_offset?: string;
     }
-    export interface GetTransfersInputParam {
-      [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.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-        
-      offset?:string;
-       
-      resource_type?:{is?:string};
-       
-      /**
-        * @description External handle of the resource from old business entity id
+    export interface CreateTransfersInputParam {
+      active_resource_ids: string[];
+      destination_business_entity_ids: string[] /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
 
-        */
-        
-      resource_id?:{is?:string};
-       
-      /**
-        * @description External handle of the active resource
+      source_business_entity_ids?: string[] /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
 
-        */
-        
-      active_resource_id?:{is?:string};
-       
-      created_at?:{after?:string,before?:string,between?:string,on?:string};
-       
-      sort_by?:{asc?:'created_at',desc?:'created_at'};
+      resource_types: string[];
+      reason_codes: string[];
+    }
+    export interface GetTransfersInputParam {
+      limit?: number;
+      offset?: string;
+      resource_type?: filter.String;
+      resource_id?: filter.String;
+      active_resource_id?: filter.String;
+      created_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
     }
-    
   }
-}
+}

package/types/resources/BusinessEntityTransfer.d.ts

@@ -1,21 +1,15 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface BusinessEntityTransfer {
-    
-    id:string;
-    
-    resource_type:'customer' | 'subscription';
-    
-    resource_id:string;
-    
-    active_resource_id:string;
-    
-    destination_business_entity_id:string;
-    
-    source_business_entity_id:string;
-    
-    reason_code:'correction';
-    
-    created_at:number;
+    id: string;
+    resource_type: 'customer' | 'subscription';
+    resource_id: string;
+    active_resource_id: string;
+    destination_business_entity_id: string;
+    source_business_entity_id: string;
+    reason_code: 'correction';
+    created_at: number;
   }
-}
+}