chargebee 2.51.0 → 2.52.0

package/types/resources/PromotionalCredit.d.ts

@@ -1,134 +1,44 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface PromotionalCredit {
     
-    /**
-      * @description Unique reference ID provided for promotional credits
 
-      */
-    
     id:string;
-    
-    /**
-      * @description Identifier of the customer.
 
-      */
-    
     customer_id:string;
-    
-    /**
-      * @description Type of promotional credits \* decrement - Decrement \* increment - Increment
 
-      */
-    
-    type:'decrement' | 'increment';
-    
-    /**
-      * @description Amount in decimal
+    type:'increment' | 'decrement';
 
-      */
-    
     amount_in_decimal?:string;
-    
-    /**
-      * @description Promotional credits amount
 
-      */
-    
     amount:number;
-    
-    /**
-      * @description The currency code (ISO 4217 format) for promotional credit
 
-      */
-    
     currency_code:string;
-    
-    /**
-      * @description Detailed description of this promotional credits.
 
-      */
-    
     description:string;
-    
-    /**
-      * @description Type of promotional credits provided to customer \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits \* general - General
 
-      */
-    
     credit_type:CreditType;
-    
-    /**
-      * @description Describes why promotional credits were provided
 
-      */
-    
     reference?:string;
-    
-    /**
-      * @description Closing balance as on end date.
 
-      */
-    
     closing_balance:number;
-    
-    /**
-      * @description The user who added/deducted the credit. If created via API, this contains the name given for the API key used.
 
-      */
-    
     done_by?:string;
-    
-    /**
-      * @description Timestamp indicating when this promotional credit resource is created.
 
-      */
-    
     created_at:number;
+
   }
   export namespace PromotionalCredit {
     export class PromotionalCreditResource {  
-      /**
-        * @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer&#x27;s credit balance would become $20.
-
-        */
-      
       add(input:AddInputParam):ChargebeeRequest<AddResponse>;
        
-      /**
-        * @description This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer&#x27;s credit balance would become $15.
-
-If you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.
-
-        */
-      
       deduct(input:DeductInputParam):ChargebeeRequest<DeductResponse>;
        
-      /**
-        * @description This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.
-
-        */
-      
       set(input:SetInputParam):ChargebeeRequest<SetResponse>;
        
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
-      /**
-        * @description This endpoint retrieves the promotional credit based on the promotional credit id
-
-        */
-      
       retrieve(account_credit_id:string):ChargebeeRequest<RetrieveResponse>;
     }
     export interface AddResponse {  
@@ -138,53 +48,18 @@ For example, if a customer has a credit balance of $10 and if you would like to
     }
     export interface AddInputParam {
        
-      /**
-        * @description Identifier of the customer.
-
-        */
-       
       customer_id:string;
        
-      /**
-        * @description Promotional credits amount.
-
-        */
-       
       amount?:number;
        
-      /**
-        * @description Amount in decimal.
-
-        */
-       
       amount_in_decimal?:string;
        
-      /**
-        * @description The currency code (ISO 4217 format) for promotional credit.
-
-        */
-       
       currency_code?:string;
        
-      /**
-        * @description Detailed description of this promotional credits.
-
-        */
-       
       description:string;
        
-      /**
-        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
-
-        */
-       
       credit_type?:CreditType;
        
-      /**
-        * @description Describes why promotional credits were provided.
-
-        */
-       
       reference?:string;
     }
     export interface DeductResponse {  
@@ -194,53 +69,18 @@ For example, if a customer has a credit balance of $10 and if you would like to
     }
     export interface DeductInputParam {
        
-      /**
-        * @description Identifier of the customer.
-
-        */
-       
       customer_id:string;
        
-      /**
-        * @description Promotional credits amount.
-
-        */
-       
       amount?:number;
        
-      /**
-        * @description Amount in decimal.
-
-        */
-       
       amount_in_decimal?:string;
        
-      /**
-        * @description The currency code (ISO 4217 format) for promotional credit.
-
-        */
-       
       currency_code?:string;
        
-      /**
-        * @description Detailed description of this promotional credits.
-
-        */
-       
       description:string;
        
-      /**
-        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
-
-        */
-       
       credit_type?:CreditType;
        
-      /**
-        * @description Describes why promotional credits were provided.
-
-        */
-       
       reference?:string;
     }
     export interface SetResponse {  
@@ -250,109 +90,64 @@ For example, if a customer has a credit balance of $10 and if you would like to
     }
     export interface SetInputParam {
        
-      /**
-        * @description Identifier of the customer.
-
-        */
-       
       customer_id:string;
        
-      /**
-        * @description Promotional credits amount.
-
-        */
-       
       amount?:number;
        
-      /**
-        * @description Amount in decimal.
-
-        */
-       
       amount_in_decimal?:string;
        
-      /**
-        * @description The currency code (ISO 4217 format) for promotional credit.
-
-        */
-       
       currency_code?:string;
        
-      /**
-        * @description Detailed description of this promotional credits.
-
-        */
-       
       description:string;
        
-      /**
-        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
-
-        */
-       
       credit_type?:CreditType;
        
-      /**
-        * @description Describes why promotional credits were provided.
-
-        */
-       
       reference?:string;
     }
     export interface ListResponse {  
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-       
        list:{promotional_credit:PromotionalCredit}[];
        
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description This endpoint lists the promotional credits set for a customer
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description This endpoint lists the promotional credits set for a customer
+        * @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 This endpoint lists the promotional credits set for a customer
+        * @description Unique reference ID provided for promotional credits
 
         */
         
       id?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description This endpoint lists the promotional credits set for a customer
+        * @description Timestamp indicating when this promotional credit resource is created.
 
         */
         
       created_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description This endpoint lists the promotional credits set for a customer
+        * @description Type of promotional credits
 
         */
         
-      type?:{in?:string,is?:'decrement' | 'increment',is_not?:'decrement' | 'increment',not_in?:string};
+      type?:{in?:string,is?:'increment' | 'decrement',is_not?:'increment' | 'decrement',not_in?:string};
        
       /**
-        * @description This endpoint lists the promotional credits set for a customer
+        * @description Identifier of the customer.
 
         */
         

package/types/resources/Purchase.d.ts

@@ -34,7 +34,7 @@ declare module 'chargebee' {
        
       statement_descriptor?:{descriptor?: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',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};
        
       purchase_items:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
        
@@ -51,6 +51,8 @@ declare module 'chargebee' {
       customer_id:string;
        
       payment_source_id?:string;
+       
+      replace_primary_payment_source?:boolean;
     }
     export interface EstimateResponse {  
        estimate:Estimate;

package/types/resources/Quote.d.ts

@@ -135,6 +135,8 @@ declare module 'chargebee' {
        quoted_subscription?:QuotedSubscription;
        
        quoted_charge?:QuotedCharge;
+       
+       quoted_ramp?:QuotedRamp;
     }
     
     export interface CreateSubForCustomerQuoteResponse {  
@@ -363,6 +365,8 @@ declare module 'chargebee' {
        quote:Quote;
        
        quoted_subscription?:QuotedSubscription;
+       
+       quoted_ramp?:QuotedRamp;
     }
     export interface CreateSubItemsForCustomerQuoteInputParam {
       [key : string] : any;  
@@ -406,6 +410,8 @@ declare module 'chargebee' {
        quote:Quote;
        
        quoted_subscription?:QuotedSubscription;
+       
+       quoted_ramp?:QuotedRamp;
     }
     export interface EditCreateSubCustomerQuoteForItemsInputParam {
       [key : string] : any;  
@@ -447,6 +453,8 @@ declare module 'chargebee' {
        quote:Quote;
        
        quoted_subscription?:QuotedSubscription;
+       
+       quoted_ramp?:QuotedRamp;
     }
     export interface UpdateSubscriptionQuoteForItemsInputParam {
       [key : string] : any;  
@@ -504,6 +512,8 @@ declare module 'chargebee' {
        quote:Quote;
        
        quoted_subscription?:QuotedSubscription;
+       
+       quoted_ramp?:QuotedRamp;
     }
     export interface EditUpdateSubscriptionQuoteForItemsInputParam {
       [key : string] : any;  
@@ -626,7 +636,7 @@ declare module 'chargebee' {
       coupon_ids?:string[];
     }
     export interface ListResponse {  
-       list:{quote:Quote,quoted_subscription?:QuotedSubscription}[];
+       list:{quote:Quote,quoted_subscription?:QuotedSubscription,quoted_ramp?:QuotedRamp}[];
        
        next_offset?:string;
     }
@@ -726,6 +736,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        
        quoted_charge?:QuotedCharge;
        
+       quoted_ramp?:QuotedRamp;
+       
        customer:Customer;
        
        subscription?:Subscription;
@@ -754,6 +766,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        quoted_subscription?:QuotedSubscription;
        
        quoted_charge?:QuotedCharge;
+       
+       quoted_ramp?:QuotedRamp;
     }
     export interface UpdateStatusInputParam {
        
@@ -767,6 +781,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        quoted_subscription?:QuotedSubscription;
        
        quoted_charge?:QuotedCharge;
+       
+       quoted_ramp?:QuotedRamp;
     }
     export interface ExtendExpiryDateInputParam {
        
@@ -778,6 +794,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        quoted_subscription?:QuotedSubscription;
        
        quoted_charge?:QuotedCharge;
+       
+       quoted_ramp?:QuotedRamp;
     }
     export interface DeleteInputParam {
        

package/types/resources/QuotedRamp.d.ts

@@ -12,6 +12,8 @@ declare module 'chargebee' {
 
     item_tiers?:QuotedRamp.ItemTier[];
 
+    coupon_applicability_mappings?:QuotedRamp.CouponApplicabilityMapping[];
+
   }
   export namespace QuotedRamp {
     
@@ -59,14 +61,6 @@ declare module 'chargebee' {
        
       ramp_tier_id?:string;
        
-      discount_amount?:number;
-       
-      md_discount_amount?:string;
-       
-      item_level_discount_amount?:number;
-       
-      md_item_level_discount_amount?:string;
-       
       discount_per_billing_cycle?:number;
        
       discount_per_billing_cycle_in_decimal?:string;
@@ -75,10 +69,6 @@ declare module 'chargebee' {
        
       item_level_discount_per_billing_cycle_in_decimal?:string;
        
-      net_amount?:number;
-       
-      md_net_amount?:string;
-       
       amount_per_billing_cycle?:number;
        
       amount_per_billing_cycle_in_decimal?:string;
@@ -90,8 +80,6 @@ declare module 'chargebee' {
     export interface Discount {  
       id:string;
        
-      name:string;
-       
       invoice_name?:string;
        
       type:'fixed_amount' | 'percentage';
@@ -114,8 +102,6 @@ declare module 'chargebee' {
        
       apply_on:'invoice_amount' | 'specific_item_price';
        
-      apply_on_item_type?:'plan' | 'addon' | 'charge';
-       
       item_price_id?:string;
        
       created_at:number;
@@ -142,6 +128,15 @@ declare module 'chargebee' {
       price_in_decimal?:string;
        
       ramp_tier_id?:string;
+       
+      pricing_type?:'per_unit' | 'flat_fee' | 'package';
+       
+      package_size?:number;
+    }
+    export interface CouponApplicabilityMapping {  
+      coupon_id?:string;
+       
+      applicable_item_price_ids?:string[];
     }
   }
 }

package/types/resources/RecordedPurchase.d.ts

@@ -44,6 +44,8 @@ declare module 'chargebee' {
        
       google_play_store?:{purchase_token?:string};
        
+      omnichannel_subscription?:{id?:string};
+       
       app_id:string;
     }
     export interface RetrieveResponse {  

package/types/resources/ResourceMigration.d.ts

@@ -1,63 +1,26 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface ResourceMigration {
     
-    /**
-      * @description Domain name to which the item is moved.
 
-      */
-    
     from_site:string;
-    
-    /**
-      * @description Type of the entity this record is stored for \* customer - Entity that represents a customer
 
-      */
-    
     entity_type:'customer';
-    
-    /**
-      * @description Handle of the customer in the current site.
 
-      */
-    
     entity_id:string;
-    
-    /**
-      * @description Status of the copy customer process. \* failed - Failed \* succeeded - Succeeded \* scheduled - Scheduled
 
-      */
-    
     status:'scheduled' | 'failed' | 'succeeded';
-    
-    /**
-      * @description Filled only if the copy operation gets failed
 
-      */
-    
     errors?:string;
-    
-    /**
-      * @description Time the log is created
 
-      */
-    
     created_at:number;
-    
-    /**
-      * @description Time the log is updated
 
-      */
-    
     updated_at:number;
+
   }
   export namespace ResourceMigration {
     export class ResourceMigrationResource {  
-      /**
-        * @description Gets the last migration details.
-
-        */
-      
       retrieve_latest(input:RetrieveLatestInputParam):ChargebeeRequest<RetrieveLatestResponse>;
     }
     export interface RetrieveLatestResponse {  
@@ -65,25 +28,10 @@ declare module 'chargebee' {
     }
     export interface RetrieveLatestInputParam {
        
-      /**
-        * @description Gets the last migration details.
-
-        */
-        
       from_site:string;
        
-      /**
-        * @description Gets the last migration details.
-
-        */
-        
       entity_type:'customer';
        
-      /**
-        * @description Gets the last migration details.
-
-        */
-        
       entity_id:string;
     }