chargebee 2.53.0 → 2.54.0

package/types/resources/OfferFulfillment.d.ts

@@ -0,0 +1,68 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface OfferFulfillment {
+    
+
+    id:string;
+
+    personalized_offer_id:string;
+
+    option_id:string;
+
+    processing_type:'billing_update' | 'checkout' | 'url_redirect' | 'webhook' | 'email';
+
+    status:'in_progress' | 'completed' | 'failed';
+
+    redirect_url?:string;
+
+    failed_at?:number;
+
+    created_at:number;
+
+    completed_at?:number;
+
+    error?:OfferFulfillment.Error;
+
+  }
+  export namespace OfferFulfillment {
+    export class OfferFulfillmentResource {  
+      offer_fulfillments(input:OfferFulfillmentsInputParam):ChargebeeRequest<OfferFulfillmentsResponse>;
+       
+      offer_fulfillments_get(offer_fulfillment_id:string):ChargebeeRequest<OfferFulfillmentsGetResponse>;
+       
+      offer_fulfillments_update(offer_fulfillment_id:string, input:OfferFulfillmentsUpdateInputParam):ChargebeeRequest<OfferFulfillmentsUpdateResponse>;
+    }
+    export interface OfferFulfillmentsResponse {  
+       offer_fulfillment:OfferFulfillment;
+       
+       hosted_page?:HostedPage;
+    }
+    export interface OfferFulfillmentsInputParam {
+       
+      personalized_offer_id:string;
+       
+      option_id:string;
+    }
+    export interface OfferFulfillmentsGetResponse {  
+       offer_fulfillment:OfferFulfillment;
+    }
+    
+    export interface OfferFulfillmentsUpdateResponse {  
+       offer_fulfillment:OfferFulfillment;
+    }
+    export interface OfferFulfillmentsUpdateInputParam {
+       
+      id:string;
+       
+      status:'completed' | 'failed';
+       
+      failure_reason?:string;
+    }
+    export interface Error {  
+      code:'billing_update_failed' | 'checkout_abandoned' | 'external_fulfillment_failed' | 'internal_error' | 'fulfillment_expired';
+       
+      message:string;
+    }
+  }
+}

package/types/resources/OmnichannelOneTimeOrder.d.ts

@@ -22,7 +22,7 @@ declare module 'chargebee' {
 
     omnichannel_one_time_order_items:OmnichannelOneTimeOrderItem[];
 
-    purchase_transaction?:OmnichannelOneTimeOrder.OmnichannelTransaction;
+    purchase_transaction?:OmnichannelTransaction;
 
   }
   export namespace OmnichannelOneTimeOrder {
@@ -65,26 +65,6 @@ declare module 'chargebee' {
         
       customer_id?:{is?:string,is_not?:string,starts_with?:string};
     }
-    export interface OmnichannelTransaction {  
-      id:string;
-       
-      id_at_source:string;
-       
-      app_id:string;
-       
-      price_currency?:string;
-       
-      price_units?:number;
-       
-      price_nanos?:number;
-       
-      type:'purchase' | 'renewal';
-       
-      transacted_at?:number;
-       
-      created_at:number;
-       
-      resource_version?:number;
-    }
+    
   }
 }

package/types/resources/OmnichannelSubscription.d.ts

@@ -20,7 +20,7 @@ declare module 'chargebee' {
 
     omnichannel_subscription_items:OmnichannelSubscriptionItem[];
 
-    initial_purchase_transaction?:OmnichannelSubscription.OmnichannelTransaction;
+    initial_purchase_transaction?:OmnichannelTransaction;
 
   }
   export namespace OmnichannelSubscription {
@@ -30,6 +30,8 @@ declare module 'chargebee' {
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
       omnichannel_transactions_for_omnichannel_subscription(omnichannel_subscription_id:string, input?:Omnichannel_transactionsForOmnichannelSubscriptionInputParam):ChargebeeRequest<OmnichannelTransactionsForOmnichannelSubscriptionResponse>;
+       
+      move(omnichannel_subscription_id:string, input:MoveInputParam):ChargebeeRequest<MoveResponse>;
     }
     export interface RetrieveResponse {  
        omnichannel_subscription:OmnichannelSubscription;
@@ -86,26 +88,13 @@ declare module 'chargebee' {
         
       offset?:string;
     }
-    export interface OmnichannelTransaction {  
-      id:string;
-       
-      id_at_source:string;
-       
-      app_id:string;
-       
-      price_currency?:string;
-       
-      price_units?:number;
-       
-      price_nanos?:number;
-       
-      type:'purchase' | 'renewal';
-       
-      transacted_at?:number;
-       
-      created_at:number;
+    export interface MoveResponse {  
+       omnichannel_subscription:OmnichannelSubscription;
+    }
+    export interface MoveInputParam {
        
-      resource_version?:number;
+      to_customer_id:string;
     }
+    
   }
 }

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -34,6 +34,8 @@ declare module 'chargebee' {
 
     resource_version?:number;
 
+    omnichannel_subscription_item_offers:OmnichannelSubscriptionItemOffer[];
+
     upcoming_renewal?:OmnichannelSubscriptionItem.UpcomingRenewal;
 
     linked_item?:OmnichannelSubscriptionItem.LinkedItem;

package/types/resources/OmnichannelSubscriptionItemOffer.d.ts

@@ -0,0 +1,38 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface OmnichannelSubscriptionItemOffer {
+    
+
+    id:string;
+
+    offer_id_at_source?:string;
+
+    category:Category;
+
+    category_at_source?:string;
+
+    type:Type;
+
+    type_at_source?:string;
+
+    discount_type?:DiscountType;
+
+    duration:string;
+
+    percentage?:number;
+
+    price_currency?:string;
+
+    price_units?:number;
+
+    price_nanos?:number;
+
+    offer_term_start?:number;
+
+    offer_term_end?:number;
+
+    resource_version?:number;
+
+  }
+}

package/types/resources/OmnichannelTransaction.d.ts

@@ -24,5 +24,19 @@ declare module 'chargebee' {
 
     resource_version?:number;
 
+    linked_omnichannel_subscriptions?:OmnichannelTransaction.LinkedOmnichannelSubscription[];
+
+    linked_omnichannel_one_time_orders?:OmnichannelTransaction.LinkedOmnichannelOneTimeOrder[];
+
+  }
+  export namespace OmnichannelTransaction {
+    
+    
+    export interface LinkedOmnichannelSubscription {  
+      omnichannel_subscription_id?:string;
+    }
+    export interface LinkedOmnichannelOneTimeOrder {  
+      omnichannel_one_time_order_id?:string;
+    }
   }
 }

package/types/resources/Order.d.ts

@@ -429,7 +429,7 @@ declare module 'chargebee' {
         
       original_order_id?:{is?:string,is_not?:string,starts_with?:string};
        
-      sort_by?:object;
+      sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
     }
     export interface OrdersForInvoiceResponse {  
        list:{order:Order}[];
@@ -532,8 +532,6 @@ declare module 'chargebee' {
       zip?:string;
        
       validation_status?:ValidationStatus;
-       
-      index:number;
     }
     export interface BillingAddress {  
       first_name?:string;

package/types/resources/PaymentSource.d.ts

@@ -303,7 +303,7 @@ declare module 'chargebee' {
         
       created_at?:{after?:string,before?:string,between?:string,on?:string};
        
-      sort_by?:object;
+      sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
     }
     export interface SwitchGatewayAccountResponse {  
        customer:Customer;

package/types/resources/PaymentVoucher.d.ts

@@ -100,7 +100,7 @@ declare module 'chargebee' {
         
       status?:{in?:string,is?:'active' | 'consumed' | 'expired' | 'failure',is_not?:'active' | 'consumed' | 'expired' | 'failure',not_in?:string};
        
-      sort_by?:object;
+      sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
     }
     export interface PaymentVouchersForCustomerResponse {  
        list:{payment_voucher:PaymentVoucher}[];
@@ -130,7 +130,7 @@ declare module 'chargebee' {
         
       status?:{in?:string,is?:'active' | 'consumed' | 'expired' | 'failure',is_not?:'active' | 'consumed' | 'expired' | 'failure',not_in?:string};
        
-      sort_by?:object;
+      sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
     }
     export interface LinkedInvoice {  
       invoice_id:string;

package/types/resources/PersonalizedOffer.d.ts

@@ -0,0 +1,64 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface PersonalizedOffer {
+    
+
+    id:string;
+
+    offer_id:string;
+
+    content:PersonalizedOffer.Content;
+
+    options:PersonalizedOffer.Option[];
+
+  }
+  export namespace PersonalizedOffer {
+    export class PersonalizedOfferResource {  
+      personalized_offers(input:PersonalizedOffersInputParam):ChargebeeRequest<PersonalizedOffersResponse>;
+    }
+    export interface PersonalizedOffersResponse {  
+       personalized_offers:PersonalizedOffer[];
+       
+       brand?:Brand;
+       
+       expires_at:number;
+    }
+    export interface PersonalizedOffersInputParam {
+       
+      request_context?:{locale?:string,referrer_url?:string,timezone?:string,url?:string,user_agent?:string};
+       
+      first_name?:string;
+       
+      last_name?:string;
+       
+      email?:string;
+       
+      roles?:string[];
+       
+      external_user_id?:string;
+       
+      subscription_id?:string;
+       
+      customer_id:string;
+       
+      custom?:object;
+    }
+    export interface Content {  
+      title:string;
+       
+      description:string;
+    }
+    export interface Option {  
+      id:string;
+       
+      label:string;
+       
+      processing_type:'billing_update' | 'checkout' | 'url_redirect' | 'webhook' | 'email';
+       
+      processing_layout:'in_app' | 'full_page';
+       
+      redirect_url:string;
+    }
+  }
+}

package/types/resources/Plan.d.ts

@@ -137,7 +137,7 @@ declare module 'chargebee' {
        plan:Plan;
     }
     export interface CreateInputParam {
-       
+      [key : string] : any;  
       tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
       tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];
@@ -246,7 +246,7 @@ declare module 'chargebee' {
        plan:Plan;
     }
     export interface UpdateInputParam {
-       
+      [key : string] : any;  
       tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
       tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];

package/types/resources/PriceVariant.d.ts

@@ -156,7 +156,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       include_site_level_resources?:{is?:'true' | 'false'};
        
-      sort_by?:object;
+      sort_by?:{asc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at',desc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at'};
     }
     export interface Attribute {  
       name:string;

package/types/resources/PricingPageSession.d.ts

@@ -26,9 +26,9 @@ declare module 'chargebee' {
        
       pricing_page:{id:string};
        
-      subscription?:object;
+      subscription?:{id?:string};
        
-      customer?:object;
+      customer?:{company?:string,email?:string,first_name?:string,id?:string,last_name?:string,locale?:string,phone?: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};
        
@@ -47,7 +47,7 @@ declare module 'chargebee' {
        
       pricing_page:{id:string};
        
-      subscription:object;
+      subscription:{id:string};
        
       discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
        

package/types/resources/Quote.d.ts

@@ -52,15 +52,15 @@ declare module 'chargebee' {
 
     line_items?:Quote.LineItem[];
 
-    discounts?:Quote.Discount[];
+    line_item_tiers?:Quote.LineItemTier[];
 
     line_item_discounts?:Quote.LineItemDiscount[];
 
-    taxes?:Quote.Tax[];
-
     line_item_taxes?:Quote.LineItemTax[];
 
-    line_item_tiers?:Quote.LineItemTier[];
+    discounts?:Quote.Discount[];
+
+    taxes?:Quote.Tax[];
 
     tax_category?:string;
 
@@ -369,8 +369,8 @@ declare module 'chargebee' {
        quoted_ramp?:QuotedRamp;
     }
     export interface CreateSubItemsForCustomerQuoteInputParam {
-       
-      subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
+      [key : string] : any;  
+      subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,offline_payment_method?:OfflinePaymentMethod,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
        
       shipping_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};
        
@@ -414,8 +414,8 @@ declare module 'chargebee' {
        quoted_ramp?:QuotedRamp;
     }
     export interface EditCreateSubCustomerQuoteForItemsInputParam {
-       
-      subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
+      [key : string] : any;  
+      subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,offline_payment_method?:OfflinePaymentMethod,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
        
       shipping_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};
        
@@ -457,7 +457,7 @@ declare module 'chargebee' {
        quoted_ramp?:QuotedRamp;
     }
     export interface UpdateSubscriptionQuoteForItemsInputParam {
-       
+      [key : string] : any;  
       subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
        
       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};
@@ -516,7 +516,7 @@ declare module 'chargebee' {
        quoted_ramp?:QuotedRamp;
     }
     export interface EditUpdateSubscriptionQuoteForItemsInputParam {
-       
+      [key : string] : any;  
       subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
        
       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};
@@ -706,7 +706,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
         
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
        
-      sort_by?:object;
+      sort_by?:{asc?:'date',desc?:'date'};
     }
     export interface QuoteLineGroupsForQuoteResponse {  
        list:{quote_line_group:QuoteLineGroup}[];
@@ -861,18 +861,28 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        
       customer_id?:string;
     }
-    export interface Discount {  
-      amount:number;
+    export interface LineItemTier {  
+      line_item_id?:string;
        
-      description?:string;
+      starting_unit:number;
        
-      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
+      ending_unit?:number;
        
-      discount_type?:'fixed_amount' | 'percentage';
+      quantity_used:number;
        
-      entity_id?:string;
+      unit_amount:number;
        
-      coupon_set_code?:string;
+      starting_unit_in_decimal?:string;
+       
+      ending_unit_in_decimal?:string;
+       
+      quantity_used_in_decimal?:string;
+       
+      unit_amount_in_decimal?:string;
+       
+      pricing_type?:'per_unit' | 'flat_fee' | 'package';
+       
+      package_size?:number;
     }
     export interface LineItemDiscount {  
       line_item_id:string;
@@ -885,13 +895,6 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        
       discount_amount:number;
     }
-    export interface Tax {  
-      name:string;
-       
-      amount:number;
-       
-      description?:string;
-    }
     export interface LineItemTax {  
       line_item_id?:string;
        
@@ -923,28 +926,25 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        
       local_currency_code?:string;
     }
-    export interface LineItemTier {  
-      line_item_id?:string;
-       
-      starting_unit:number;
-       
-      ending_unit?:number;
-       
-      quantity_used:number;
+    export interface Discount {  
+      amount:number;
        
-      unit_amount:number;
+      description?:string;
        
-      starting_unit_in_decimal?:string;
+      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
        
-      ending_unit_in_decimal?:string;
+      discount_type?:'fixed_amount' | 'percentage';
        
-      quantity_used_in_decimal?:string;
+      entity_id?:string;
        
-      unit_amount_in_decimal?:string;
+      coupon_set_code?:string;
+    }
+    export interface Tax {  
+      name:string;
        
-      pricing_type?:'per_unit' | 'flat_fee' | 'package';
+      amount:number;
        
-      package_size?:number;
+      description?:string;
     }
     export interface ShippingAddress {  
       first_name?:string;
@@ -974,8 +974,6 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
       zip?:string;
        
       validation_status?:ValidationStatus;
-       
-      index:number;
     }
     export interface BillingAddress {  
       first_name?:string;

package/types/resources/QuoteLineGroup.d.ts

@@ -24,14 +24,14 @@ declare module 'chargebee' {
 
     line_items?:QuoteLineGroup.LineItem[];
 
-    discounts?:QuoteLineGroup.Discount[];
-
     line_item_discounts?:QuoteLineGroup.LineItemDiscount[];
 
-    taxes?:QuoteLineGroup.Tax[];
-
     line_item_taxes?:QuoteLineGroup.LineItemTax[];
 
+    discounts?:QuoteLineGroup.Discount[];
+
+    taxes?:QuoteLineGroup.Tax[];
+
   }
   export namespace QuoteLineGroup {
     
@@ -87,19 +87,6 @@ declare module 'chargebee' {
        
       customer_id?:string;
     }
-    export interface Discount {  
-      amount:number;
-       
-      description?:string;
-       
-      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
-       
-      discount_type?:'fixed_amount' | 'percentage';
-       
-      entity_id?:string;
-       
-      coupon_set_code?:string;
-    }
     export interface LineItemDiscount {  
       line_item_id:string;
        
@@ -111,13 +98,6 @@ declare module 'chargebee' {
        
       discount_amount:number;
     }
-    export interface Tax {  
-      name:string;
-       
-      amount:number;
-       
-      description?:string;
-    }
     export interface LineItemTax {  
       line_item_id?:string;
        
@@ -149,5 +129,25 @@ declare module 'chargebee' {
        
       local_currency_code?:string;
     }
+    export interface Discount {  
+      amount:number;
+       
+      description?:string;
+       
+      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
+       
+      discount_type?:'fixed_amount' | 'percentage';
+       
+      entity_id?:string;
+       
+      coupon_set_code?:string;
+    }
+    export interface Tax {  
+      name:string;
+       
+      amount:number;
+       
+      description?:string;
+    }
   }
 }