chargebee 3.13.0 → 3.14.0

package/types/resources/Invoice.d.ts

@@ -3,6 +3,7 @@
 ///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Invoice {
+    [key: string]: unknown;
     id: string;
     customer_id: string;
     payment_owner?: string;
@@ -776,7 +777,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface BillingAddress {
       first_name?: string;
@@ -880,6 +880,7 @@ declare module 'chargebee' {
       notes_to_remove?: NotesToRemoveCreateForChargeItemsAndChargesInputParam[];
       tax_providers_fields?: TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam[];
       discounts?: DiscountsCreateForChargeItemsAndChargesInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface ChargeInputParam {
       customer_id?: string;
@@ -985,6 +986,7 @@ declare module 'chargebee' {
       payments?: PaymentsImportInvoiceInputParam[];
       notes?: NotesImportInvoiceInputParam[];
       line_item_addresses?: LineItemAddressesImportInvoiceInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface ApplyPaymentsInputParam {
       comment?: string;
@@ -1083,6 +1085,7 @@ declare module 'chargebee' {
       remove_general_note?: boolean;
       invoice_date?: number;
       notes_to_remove?: NotesToRemoveCloseInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface CollectPaymentInputParam {
       amount?: number;
@@ -1137,6 +1140,7 @@ declare module 'chargebee' {
       billing_address?: BillingAddressUpdateDetailsInputParam;
       shipping_address?: ShippingAddressUpdateDetailsInputParam;
       statement_descriptor?: StatementDescriptorUpdateDetailsInputParam;
+      [key: `cf_${string}`]: unknown;
     }
     export interface ApplyPaymentScheduleSchemeInputParam {
       scheme_id: string;

package/types/resources/InvoiceEstimate.d.ts

@@ -12,15 +12,15 @@ declare module 'chargebee' {
     amount_paid?: number;
     amount_due?: number;
     line_items?: InvoiceEstimate.LineItem[];
-    discounts?: InvoiceEstimate.Discount[];
-    taxes?: InvoiceEstimate.Tax[];
-    line_item_taxes?: InvoiceEstimate.LineItemTax[];
     line_item_tiers?: InvoiceEstimate.LineItemTier[];
-    line_item_credits?: InvoiceEstimate.LineItemCredit[];
     line_item_discounts?: InvoiceEstimate.LineItemDiscount[];
+    line_item_taxes?: InvoiceEstimate.LineItemTax[];
+    line_item_credits?: InvoiceEstimate.LineItemCredit[];
+    line_item_addresses?: InvoiceEstimate.LineItemAddress[];
+    discounts?: InvoiceEstimate.Discount[];
+    taxes?: InvoiceEstimate.Tax[];
     round_off_amount?: number;
     customer_id?: string;
-    line_item_addresses?: InvoiceEstimate.LineItemAddress[];
   }
 
   export namespace InvoiceEstimate {
@@ -73,24 +73,31 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    export interface Discount {
-      amount: number;
-      description?: string;
-      entity_type:
+    export interface LineItemTier {
+      line_item_id?: string;
+      starting_unit: number;
+      ending_unit?: number;
+      quantity_used: number;
+      unit_amount: number;
+      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;
+      discount_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
         | 'promotional_credits'
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
-      discount_type?: 'fixed_amount' | 'percentage';
+      coupon_id?: string;
       entity_id?: string;
-      coupon_set_code?: string;
-    }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
+      discount_amount: number;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -117,37 +124,11 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
-    export interface LineItemTier {
-      line_item_id?: string;
-      starting_unit: number;
-      ending_unit?: number;
-      quantity_used: number;
-      unit_amount: number;
-      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 LineItemCredit {
       cn_id: string;
       applied_amount: number;
       line_item_id?: string;
     }
-    export interface LineItemDiscount {
-      line_item_id: string;
-      discount_type:
-        | 'item_level_coupon'
-        | 'document_level_coupon'
-        | 'promotional_credits'
-        | 'prorated_credits'
-        | 'item_level_discount'
-        | 'document_level_discount';
-      coupon_id?: string;
-      entity_id?: string;
-      discount_amount: number;
-    }
     export interface LineItemAddress {
       line_item_id?: string;
       first_name?: string;
@@ -169,6 +150,25 @@ declare module 'chargebee' {
         | 'partially_valid'
         | 'invalid';
     }
+    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;
+    }
     // REQUEST PARAMS
     //---------------
   }

package/types/resources/OfferEvent.d.ts

@@ -0,0 +1,25 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OfferEvent {}
+
+  export namespace OfferEvent {
+    export class OfferEventResource {
+      offerEvents(
+        input: OfferEventsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<OfferEventsResponse>>;
+    }
+
+    export interface OfferEventsResponse {}
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface OfferEventsInputParam {
+      personalized_offer_id: string;
+      type: 'viewed' | 'dismissed';
+    }
+  }
+}

package/types/resources/OfferFulfillment.d.ts

@@ -0,0 +1,77 @@
+///<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 {
+      offerFulfillments(
+        input: OfferFulfillmentsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<OfferFulfillmentsResponse>>;
+
+      offerFulfillmentsGet(
+        offer_fulfillment_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<OfferFulfillmentsGetResponse>>;
+
+      offerFulfillmentsUpdate(
+        offer_fulfillment_id: string,
+        input: OfferFulfillmentsUpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<OfferFulfillmentsUpdateResponse>>;
+    }
+
+    export interface OfferFulfillmentsResponse {
+      offer_fulfillment: OfferFulfillment;
+      hosted_page?: HostedPage;
+    }
+
+    export interface OfferFulfillmentsGetResponse {
+      offer_fulfillment: OfferFulfillment;
+    }
+
+    export interface OfferFulfillmentsUpdateResponse {
+      offer_fulfillment: OfferFulfillment;
+    }
+
+    export interface Error {
+      code:
+        | 'billing_update_failed'
+        | 'checkout_abandoned'
+        | 'external_fulfillment_failed'
+        | 'internal_error'
+        | 'fulfillment_expired';
+      message: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface OfferFulfillmentsInputParam {
+      personalized_offer_id: string;
+      option_id: string;
+    }
+    export interface OfferFulfillmentsUpdateInputParam {
+      id: string;
+      status: 'completed' | 'failed';
+      failure_reason?: string;
+    }
+  }
+}

package/types/resources/OmnichannelOneTimeOrder.d.ts

@@ -12,7 +12,7 @@ declare module 'chargebee' {
     created_at: number;
     resource_version?: number;
     omnichannel_one_time_order_items: OmnichannelOneTimeOrderItem[];
-    purchase_transaction?: OmnichannelOneTimeOrder.OmnichannelTransaction;
+    purchase_transaction?: OmnichannelTransaction;
   }
 
   export namespace OmnichannelOneTimeOrder {
@@ -37,18 +37,6 @@ declare module 'chargebee' {
       next_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;
-      resource_version?: number;
-    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/OmnichannelSubscription.d.ts

@@ -11,7 +11,7 @@ declare module 'chargebee' {
     created_at: number;
     resource_version?: number;
     omnichannel_subscription_items: OmnichannelSubscriptionItem[];
-    initial_purchase_transaction?: OmnichannelSubscription.OmnichannelTransaction;
+    initial_purchase_transaction?: OmnichannelTransaction;
   }
 
   export namespace OmnichannelSubscription {
@@ -33,6 +33,12 @@ declare module 'chargebee' {
       ): Promise<
         ChargebeeResponse<OmnichannelTransactionsForOmnichannelSubscriptionResponse>
       >;
+
+      move(
+        omnichannel_subscription_id: string,
+        input: MoveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<MoveResponse>>;
     }
 
     export interface RetrieveResponse {
@@ -49,18 +55,10 @@ declare module 'chargebee' {
       next_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;
-      resource_version?: number;
+    export interface MoveResponse {
+      omnichannel_subscription: OmnichannelSubscription;
     }
+
     // REQUEST PARAMS
     //---------------
 
@@ -74,5 +72,8 @@ declare module 'chargebee' {
       limit?: number;
       offset?: string;
     }
+    export interface MoveInputParam {
+      to_customer_id: string;
+    }
   }
 }

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -29,6 +29,7 @@ declare module 'chargebee' {
     resumes_at?: number;
     has_scheduled_changes: boolean;
     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,22 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OmnichannelSubscriptionItemOffer {
+    id: string;
+    offer_id_at_source?: string;
+    category: CategoryEnum;
+    category_at_source?: string;
+    type: TypeEnum;
+    type_at_source?: string;
+    discount_type?: DiscountTypeEnum;
+    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

@@ -13,5 +13,18 @@ declare module 'chargebee' {
     transacted_at?: number;
     created_at: number;
     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;
+    }
+    // REQUEST PARAMS
+    //---------------
   }
 }

package/types/resources/Order.d.ts

@@ -258,7 +258,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface BillingAddress {
       first_name?: 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 {
+      personalizedOffers(
+        input: PersonalizedOffersInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<PersonalizedOffersResponse>>;
+    }
+
+    export interface PersonalizedOffersResponse {
+      personalized_offers: PersonalizedOffer[];
+      brand?: Brand;
+      expires_at: number;
+    }
+
+    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;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface PersonalizedOffersInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      roles?: string[];
+      external_user_id?: string;
+      subscription_id?: string;
+      customer_id: string;
+      custom?: any;
+      request_context?: RequestContextPersonalizedOffersInputParam;
+    }
+    export interface RequestContextPersonalizedOffersInputParam {
+      user_agent?: string;
+      locale?: string;
+      timezone?: string;
+      url?: string;
+      referrer_url?: string;
+    }
+  }
+}

package/types/resources/Quote.d.ts

@@ -42,11 +42,11 @@ declare module 'chargebee' {
     updated_at?: number;
     vat_number_prefix?: string;
     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;
     currency_code: string;
     notes?: any;
@@ -351,19 +351,18 @@ declare module 'chargebee' {
       entity_id?: string;
       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 LineItemTier {
+      line_item_id?: string;
+      starting_unit: number;
+      ending_unit?: number;
+      quantity_used: number;
+      unit_amount: number;
+      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;
@@ -378,11 +377,6 @@ declare module 'chargebee' {
       entity_id?: string;
       discount_amount: number;
     }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
-    }
     export interface LineItemTax {
       line_item_id?: string;
       tax_name: string;
@@ -408,18 +402,24 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
-    export interface LineItemTier {
-      line_item_id?: string;
-      starting_unit: number;
-      ending_unit?: number;
-      quantity_used: number;
-      unit_amount: number;
-      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 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;
     }
     export interface ShippingAddress {
       first_name?: string;
@@ -436,7 +436,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface BillingAddress {
       first_name?: string;
@@ -1118,6 +1117,7 @@ declare module 'chargebee' {
        */
       setup_fee?: number;
       start_date?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -1216,6 +1216,7 @@ declare module 'chargebee' {
        */
       setup_fee?: number;
       start_date?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 

package/types/resources/QuoteLineGroup.d.ts

@@ -19,10 +19,10 @@ declare module 'chargebee' {
       | 'subscription_cancel';
     billing_cycle_number?: number;
     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 {
@@ -75,20 +75,6 @@ declare module 'chargebee' {
       entity_id?: string;
       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;
       discount_type:
@@ -102,11 +88,6 @@ declare module 'chargebee' {
       entity_id?: string;
       discount_amount: number;
     }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
-    }
     export interface LineItemTax {
       line_item_id?: string;
       tax_name: string;
@@ -132,6 +113,25 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       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;
+    }
     // REQUEST PARAMS
     //---------------
   }