chargebee 2.51.0 → 2.53.0

package/types/resources/Customer.d.ts

@@ -3,157 +3,139 @@
 declare module 'chargebee' {
   export interface Customer {
     [key : string] : any;
-    /**
-      * @description Identifier of the customer.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description First name of the customer
 
-      */
-    
     first_name?:string;
-    
-    /**
-      * @description Last name of the customer
 
-      */
-    
     last_name?:string;
-    
-    /**
-      * @description Email of the customer. Configured email notifications will be sent to this email.
 
-      */
-    
     email?:string;
-    
+
     phone?:string;
-    
+
     company?:string;
-    
+
     vat_number?:string;
-    
+
     auto_collection:AutoCollection;
-    
+
     offline_payment_method?:OfflinePaymentMethod;
-    
+
     net_term_days:number;
-    
+
     vat_number_validated_time?:number;
-    
+
     vat_number_status?:'valid' | 'invalid' | 'not_validated' | 'undetermined';
-    
+
     allow_direct_debit:boolean;
-    
+
     is_location_valid?:boolean;
-    
+
     created_at:number;
-    
+
     created_from_ip?:string;
-    
+
     exemption_details?:any[];
-    
+
     taxability?:Taxability;
-    
+
     entity_code?:EntityCode;
-    
+
     exempt_number?:string;
-    
+
     resource_version?:number;
-    
+
     updated_at?:number;
-    
+
     locale?:string;
-    
+
     billing_date?:number;
-    
+
     billing_month?:number;
-    
+
     billing_date_mode?:BillingDateMode;
-    
+
     billing_day_of_week?:'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday';
-    
+
     billing_day_of_week_mode?:BillingDayOfWeekMode;
-    
+
     pii_cleared?:'active' | 'scheduled_for_clear' | 'cleared';
-    
+
     auto_close_invoices?:boolean;
-    
+
     channel?:Channel;
-    
+
     active_id?:string;
-    
+
     card_status?:'no_card' | 'valid' | 'expiring' | 'expired' | 'pending_verification' | 'invalid';
-    
+
     fraud_flag?:'safe' | 'suspicious' | 'fraudulent';
-    
+
     primary_payment_source_id?:string;
-    
+
     backup_payment_source_id?:string;
-    
+
     billing_address?:Customer.BillingAddress;
-    
+
     referral_urls?:Customer.ReferralUrl[];
-    
+
     contacts?:Customer.Contact[];
-    
+
     payment_method?:Customer.PaymentMethod;
-    
+
     invoice_notes?:string;
-    
+
     business_entity_id?:string;
-    
+
     preferred_currency_code?:string;
-    
+
     promotional_credits:number;
-    
+
     unbilled_charges:number;
-    
+
     refundable_credits:number;
-    
+
     excess_payments:number;
-    
+
     balances?:Customer.Balance[];
-    
+
     entity_identifiers?:Customer.EntityIdentifier[];
-    
+
     tax_providers_fields?:Customer.TaxProvidersField[];
-    
+
     is_einvoice_enabled?:boolean;
-    
+
     einvoicing_method?:EinvoicingMethod;
-    
+
     meta_data?:object;
-    
+
     deleted:boolean;
-    
+
     registered_for_gst?:boolean;
-    
+
     consolidated_invoicing?:boolean;
-    
+
     customer_type?:CustomerType;
-    
+
     business_customer_without_vat_number?:boolean;
-    
+
     client_profile_id?:string;
-    
+
     relationship?:Customer.Relationship;
-    
+
     use_default_hierarchy_settings?:boolean;
-    
+
     parent_account_access?:Customer.ParentAccountAccess;
-    
+
     child_account_access?:Customer.ChildAccountAccess;
-    
+
     vat_number_prefix?:string;
-    
+
     entity_identifier_scheme?:string;
-    
+
     entity_identifier_standard?:string;
+
   }
   export namespace Customer {
     export class CustomerResource {  
@@ -205,6 +187,8 @@ declare module 'chargebee' {
        
       hierarchy(customer_id:string, input:HierarchyInputParam):ChargebeeRequest<HierarchyResponse>;
        
+      list_hierarchy_detail(customer_id:string, input:ListHierarchyDetailInputParam):ChargebeeRequest<ListHierarchyDetailResponse>;
+       
       update_hierarchy_settings(customer_id:string, input?:UpdateHierarchySettingsInputParam):ChargebeeRequest<UpdateHierarchySettingsResponse>;
     }
     export interface CreateResponse {  
@@ -213,14 +197,14 @@ declare module 'chargebee' {
        card?:Card;
     }
     export interface CreateInputParam {
-      [key : string] : any;  
+       
       card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
        
       bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
        
       payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
        
       billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
        
@@ -311,7 +295,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 \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; 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 &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
 
         */
         
@@ -331,8 +315,6 @@ declare module 'chargebee' {
         
       include_deleted?:boolean;
        
-      include_deprecated?:boolean;
-       
       /**
         * @description Identifier of the customer.
 
@@ -435,7 +417,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
         
       business_entity_id?:{is?:string};
        
-      sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
+      sort_by?:object;
     }
     export interface RetrieveResponse {  
        customer:Customer;
@@ -449,7 +431,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        card?:Card;
     }
     export interface UpdateInputParam {
-      [key : string] : any;  
+       
       tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
        
       first_name?:string;
@@ -551,7 +533,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 \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; 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 &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
 
         */
         
@@ -647,7 +629,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
     }
     export interface RecordExcessPaymentInputParam {
        
-      transaction:{amount:number,currency_code?:string,custom_payment_method_id?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
+      transaction:{amount:number,currency_code?:string,custom_payment_method_id?:string,date:number,id?:string,payment_method:PaymentMethod,reference_number?:string};
        
       comment?:string;
     }
@@ -662,7 +644,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa'};
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
        
       invoice_allocations:{allocation_amount?:number,invoice_id:string}[];
        
@@ -692,8 +674,6 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
     }
     export interface MoveInputParam {
        
-      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
-       
       id_at_from_site:string;
        
       from_site:string;
@@ -718,8 +698,6 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
     }
     export interface MergeInputParam {
        
-      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
-       
       from_customer_id:string;
        
       to_customer_id:string;
@@ -756,6 +734,29 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       hierarchy_operation_type:'complete_hierarchy' | 'subordinates' | 'path_to_root';
     }
+    export interface ListHierarchyDetailResponse {  
+       list:{hierarchies:any[]}[];
+       
+       next_offset?:string;
+    }
+    export interface ListHierarchyDetailInputParam {
+      [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;
+       
+      hierarchy_operation_type:'complete_hierarchy' | 'subordinates' | 'path_to_root';
+    }
     export interface UpdateHierarchySettingsResponse {  
        customer:Customer;
     }

package/types/resources/CustomerEntitlement.d.ts

@@ -36,11 +36,13 @@ 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.
 
         */
         
       offset?:string;
+       
+      consolidate_entitlements?:boolean;
     }
     
   }

package/types/resources/DifferentialPrice.d.ts

@@ -108,7 +108,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/Discount.d.ts

@@ -1,129 +1,44 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface Discount {
     
-    /**
-      * @description An immutable unique id for the discount. It is always auto-generated.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices?prod_cat_ver&#x3D;2) and [hosted pages](/docs/api/hosted_pages?prod_cat_ver&#x3D;2). This is auto-generated based on the &#x60;type&#x60;, &#x60;amount&#x60;, and &#x60;currency_code&#x60; of the discount. For example, it can be &#x60;10% off&#x60; or &#x60;10$ off&#x60;.
 
-      */
-    
     invoice_name?:string;
-    
-    /**
-      * @description The type of discount. Possible value are: \* percentage - The specified percentage will be given as discount. \* fixed_amount - The specified amount will be given as discount.
 
-      */
-    
-    type:'fixed_amount' | 'percentage';
-    
-    /**
-      * @description The percentage of the original amount that should be deducted from it. Only applicable when &#x60;discount.type&#x60; is percentage.
+    type:'fixed_amount' | 'percentage' | 'offer_quantity';
 
-      */
-    
     percentage?:number;
-    
-    /**
-      * @description The value of the discount. [The format of this value](https://apidocs.chargebee.com/docs/api?prod_cat_ver&#x3D;2#currencies) depends on the kind of currency. This is only applicable when &#x60;discount.type&#x60; is &#x60;fixed_amount&#x60;.
 
-      */
-    
     amount?:number;
-    
-    /**
-      * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the discount. This is only applicable when &#x60;discount.type&#x60; is &#x60;fixed_amount&#x60;.
 
-      */
-    
+    quantity?:number;
+
     currency_code?:string;
-    
-    /**
-      * @description Specifies the time duration for which this discount is attached to the subscription. \* forever - The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions?prod_cat_ver&#x3D;2#update_subscription_for_items_discounts_operation_type). \* limited_period - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by &#x60;period&#x60; and &#x60;period_unit&#x60;. \* one_time - The discount stays attached to the subscription till it is applied on an invoice **once**. It is removed after that from the subscription.
 
-      */
-    
     duration_type:DurationType;
-    
-    /**
-      * @description The duration of time for which the discount is attached to the subscription, in &#x60;period_units&#x60;. Applicable only when &#x60;duration_type&#x60; is &#x60;limited_period&#x60;.
 
-      */
-    
     period?:number;
-    
-    /**
-      * @description The unit of time for &#x60;period&#x60;. Applicable only when &#x60;duration_type&#x60; is &#x60;limited_period&#x60;. \* year - A period of 1 calendar year. \* month - A period of 1 calendar month. \* week - A period of 7 days. \* day - A period of 24 hours.
 
-      */
-    
     period_unit?:PeriodUnit;
-    
-    /**
-      * @description The discount is included in MRR calculations for your site. This attribute is only applicable when &#x60;duration_type&#x60; is &#x60;one_time&#x60; and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation) in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation) is to exclude one-time discounts from MRR calculations, this value is always returned &#x60;false&#x60;.
 
-      */
-    
     included_in_mrr:boolean;
-    
-    /**
-      * @description The amount on the invoice to which the discount is applied. \* invoice_amount - The discount is applied to the invoice &#x60;sub_total&#x60;. \* specific_item_price - The discount is applied to the &#x60;invoice.line_item.amount&#x60; that corresponds to the item price specified by &#x60;item_price_id&#x60;.
 
-      */
-    
     apply_on:ApplyOn;
-    
-    /**
-      * @description The [id of the item price](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when &#x60;apply_on&#x60; &#x3D; &#x60;specific_item_price&#x60;.
 
-      */
-    
     item_price_id?:string;
-    
-    /**
-      * @description Timestamp indicating when this discount is created.
 
-      */
-    
     created_at:number;
-    
-    /**
-      * @description Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for &#x60;limited_period&#x60; duration type discount.
 
-      */
-    
     apply_till?:number;
-    
-    /**
-      * @description Specifies the number of times the discount has been applied.
 
-      */
-    
     applied_count?:number;
-    
-    /**
-      * @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.  
-**Note:**
-
-
-When the coupon ID contains a special character; for example: &#x60;#&#x60;, the API returns an error.
-Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the path parameter before making an API call.
 
-      */
-    
     coupon_id:string;
-    
-    /**
-      * @description The index number of the subscription to which the item price is added. Provide a unique number between &#x60;0&#x60; and &#x60;4&#x60; (inclusive) for each subscription that is to be created.
 
-      */
-    
     index:number;
+
   }
 }

package/types/resources/Download.d.ts

@@ -1,26 +1,14 @@
 ///<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;
+
   }
 }