chargebee 2.50.0 → 2.52.0

package/types/resources/CouponSet.d.ts

@@ -1,98 +1,38 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface CouponSet {
     
-    /**
-      * @description Uniquely identifies a coupon_set
 
-      */
-    
     id:string;
-    
-    /**
-      * @description Coupon id linked to coupon set
 
-      */
-    
     coupon_id:string;
-    
-    /**
-      * @description Name of the coupon set
 
-      */
-    
     name:string;
-    
-    /**
-      * @description No of coupon codes present in coupon set
 
-      */
-    
     total_count?:number;
-    
-    /**
-      * @description No of redeemed codes
 
-      */
-    
     redeemed_count?:number;
-    
-    /**
-      * @description No of archived codes
 
-      */
-    
     archived_count?:number;
+
+    meta_data?:object;
+
   }
   export namespace CouponSet {
     export class CouponSetResource {  
-      /**
-        * @description Create a coupon set with a coupon code compatible to your product offers and promotional discounts
-
-        */
-      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
-      /**
-        * @description This API add coupon codes to an existing coupon set.
-
-        */
-      
       add_coupon_codes(coupon_set_id:string, input?:AddCouponCodesInputParam):ChargebeeRequest<AddCouponCodesResponse>;
        
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
-      /**
-        * @description Use this API to retrieve a specific coupon set.
-
-        */
-      
       retrieve(coupon_set_id:string):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Use this API to update a specific coupon set by updating its &#x60;name&#x60; and the &#x60;meta_data&#x60;.
-
-        */
-      
       update(coupon_set_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
-      /**
-        * @description Use this endpoint to delete a specific coupon set
-
-        */
-      
       delete(coupon_set_id:string):ChargebeeRequest<DeleteResponse>;
        
-      /**
-        * @description Use this API to delete all the unutilised coupon codes from a specific coupon set.
-
-        */
-      
       delete_unused_coupon_codes(coupon_set_id:string):ChargebeeRequest<DeleteUnusedCouponCodesResponse>;
     }
     export interface CreateResponse {  
@@ -100,34 +40,12 @@ declare module 'chargebee' {
     }
     export interface CreateInputParam {
        
-      /**
-        * @description Coupon id linked to coupon set.
-
-        */
-       
       coupon_id:string;
        
-      /**
-        * @description Name of the coupon set.
-
-        */
-       
       name:string;
        
-      /**
-        * @description Uniquely identifies a coupon_set.
-
-        */
-       
       id:string;
        
-      /**
-        * @description A collection of key-value pairs that provides extra information about the coupon set.  
-**Note:** There&#x27;s a character limit of 65,535.
-[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
-
-        */
-       
       meta_data?:object;
     }
     export interface AddCouponCodesResponse {  
@@ -135,81 +53,66 @@ declare module 'chargebee' {
     }
     export interface AddCouponCodesInputParam {
        
-      /**
-        * @description You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.
-
-        */
-       
       code?:string[];
     }
     export interface ListResponse {  
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-       
        list:{coupon_set:CouponSet}[];
        
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @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 Use this API to get the list of all the coupon sets.
+        * @description Uniquely identifies a coupon_set
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description Name of the coupon set
 
         */
         
       name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description Coupon id linked to coupon set
 
         */
         
       coupon_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description No of coupon codes present in coupon set
 
         */
         
       total_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description No of redeemed codes
 
         */
         
       redeemed_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description No of archived codes
 
         */
         
@@ -224,20 +127,8 @@ declare module 'chargebee' {
     }
     export interface UpdateInputParam {
        
-      /**
-        * @description Name of the coupon set.
-
-        */
-       
       name?:string;
        
-      /**
-        * @description A collection of key-value pairs that provides extra information about the coupon set.  
-**Note:** There&#x27;s a character limit of 65,535.
-[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
-
-        */
-       
       meta_data?:object;
     }
     export interface DeleteResponse {  

package/types/resources/CreditNote.d.ts

@@ -163,9 +163,7 @@ declare module 'chargebee' {
     }
     export interface RetrieveInputParam {
        
-      line_items_limit?:number;
-       
-      line_items_offset?:string;
+      line_item?:{customer_id?:{is?:string},subscription_id?:{is?:string}};
     }
     export interface PdfResponse {  
        download:Download;
@@ -239,8 +237,6 @@ declare module 'chargebee' {
         
       einvoice?:{status?:{in?:string,is?:'scheduled' | 'skipped' | 'in_progress' | 'success' | 'failed' | 'registered',is_not?:'scheduled' | 'skipped' | 'in_progress' | 'success' | 'failed' | 'registered',not_in?:string}};
        
-      show_exempted_tax_lines?:boolean;
-       
       /**
         * @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \`deleted\` as \`true\`.
 
@@ -506,7 +502,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        
       metered?:boolean;
        
-      percentage?:string;
+      is_percentage_pricing?:boolean;
        
       reference_line_item_id?:string;
        

package/types/resources/CreditNoteEstimate.d.ts

@@ -75,7 +75,7 @@ declare module 'chargebee' {
        
       metered?:boolean;
        
-      percentage?:string;
+      is_percentage_pricing?:boolean;
        
       reference_line_item_id?:string;
        

package/types/resources/Currency.d.ts

@@ -1,18 +1,21 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface Currency {
     
+
     id?:string;
-    
+
     enabled:boolean;
-    
+
     forex_type?:'manual' | 'auto';
-    
+
     currency_code?:string;
-    
+
     is_base_currency?:boolean;
-    
+
     manual_exchange_rate?:string;
+
   }
   export namespace Currency {
     export class CurrencyResource {  

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 {  
@@ -220,7 +204,7 @@ declare module 'chargebee' {
        
       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};
        
@@ -331,8 +315,6 @@ declare module 'chargebee' {
         
       include_deleted?:boolean;
        
-      include_deprecated?:boolean;
-       
       /**
         * @description Identifier of the customer.
 
@@ -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 \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; 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;
     }