chargebee 3.13.0 → 3.15.0

package/esm/resources/api_endpoints.js

@@ -4642,6 +4642,19 @@ export const Endpoints = {
             {},
             {},
         ],
+        [
+            'move',
+            'POST',
+            '/omnichannel_subscriptions',
+            '/move',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
     ],
     omnichannelTransaction: [],
     omnichannelSubscriptionItem: [
@@ -4752,7 +4765,60 @@ export const Endpoints = {
             {},
         ],
     ],
+    personalizedOffer: [
+        [
+            'personalizedOffers',
+            'POST',
+            '/personalized_offers',
+            null,
+            false,
+            'grow',
+            true,
+            {
+                custom: 0,
+            },
+            {},
+        ],
+    ],
     brand: [],
+    offerFulfillment: [
+        [
+            'offerFulfillments',
+            'POST',
+            '/offer_fulfillments',
+            null,
+            false,
+            'grow',
+            true,
+            {},
+            {},
+        ],
+        [
+            'offerFulfillmentsGet',
+            'GET',
+            '/offer_fulfillments',
+            null,
+            true,
+            'grow',
+            true,
+            {},
+            {},
+        ],
+        [
+            'offerFulfillmentsUpdate',
+            'POST',
+            '/offer_fulfillments',
+            null,
+            true,
+            'grow',
+            true,
+            {},
+            {},
+        ],
+    ],
+    offerEvent: [
+        ['offerEvents', 'POST', '/offer_events', null, false, 'grow', true, {}, {}],
+    ],
     webhookEndpoint: [
         [
             'create',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.13.0",
+  "version": "3.15.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",

package/types/core.d.ts

@@ -45,6 +45,7 @@ declare module 'chargebee' {
     | 'end_of_term'
     | 'specific_date'
     | 'end_of_billing_term';
+  type CategoryEnum = 'introductory' | 'promotional' | 'developer_determined';
   type ChangeOptionEnum = 'immediately' | 'end_of_term' | 'specific_date';
   type ChannelEnum = 'web' | 'app_store' | 'play_store';
   type ChargeModelEnum = 'full_charge' | 'prorate';
@@ -80,6 +81,7 @@ declare module 'chargebee' {
     | 'becs_nz'
     | 'pad'
     | 'not_applicable';
+  type DiscountTypeEnum = 'fixed_amount' | 'percentage' | 'price';
   type DispositionTypeEnum = 'attachment' | 'inline';
   type DunningTypeEnum = 'auto_collect' | 'offline' | 'direct_debit';
   type DurationTypeEnum = 'one_time' | 'forever' | 'limited_period';
@@ -219,6 +221,7 @@ declare module 'chargebee' {
     | 'transaction_deleted'
     | 'payment_succeeded'
     | 'payment_failed'
+    | 'dunning_updated'
     | 'payment_refunded'
     | 'payment_initiated'
     | 'refund_initiated'
@@ -356,6 +359,8 @@ declare module 'chargebee' {
     | 'omnichannel_one_time_order_item_cancelled'
     | 'usage_file_ingested'
     | 'omnichannel_subscription_item_pause_scheduled'
+    | 'omnichannel_subscription_moved_in'
+    | 'omnichannel_transaction_created'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -419,6 +424,7 @@ declare module 'chargebee' {
     | 'solidgate'
     | 'paystack'
     | 'jp_morgan'
+    | 'deutsche_bank'
     | 'gocardless'
     | 'not_applicable';
   type HierarchyOperationTypeEnum =
@@ -611,7 +617,10 @@ declare module 'chargebee' {
     | 'automated_bank_transfer'
     | 'klarna_pay_now'
     | 'online_banking_poland'
-    | 'payconiq_by_bancontact';
+    | 'payconiq_by_bancontact'
+    | 'free_trial'
+    | 'pay_up_front'
+    | 'pay_as_you_go';
   type UnbilledChargesHandlingEnum = 'no_action' | 'invoice';
   type UnbilledChargesOptionEnum = 'invoice' | 'delete';
   type UnpaidInvoicesHandlingEnum = 'no_action' | 'schedule_payment_collection';

package/types/index.d.ts

@@ -47,10 +47,13 @@
 ///<reference path='./resources/ItemPrice.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
+///<reference path='./resources/OfferEvent.d.ts' />
+///<reference path='./resources/OfferFulfillment.d.ts' />
 ///<reference path='./resources/OmnichannelOneTimeOrder.d.ts' />
 ///<reference path='./resources/OmnichannelOneTimeOrderItem.d.ts' />
 ///<reference path='./resources/OmnichannelSubscription.d.ts' />
 ///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
+///<reference path='./resources/OmnichannelSubscriptionItemOffer.d.ts' />
 ///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
 ///<reference path='./resources/OmnichannelTransaction.d.ts' />
 ///<reference path='./resources/Order.d.ts' />
@@ -61,6 +64,7 @@
 ///<reference path='./resources/PaymentScheduleScheme.d.ts' />
 ///<reference path='./resources/PaymentSource.d.ts' />
 ///<reference path='./resources/PaymentVoucher.d.ts' />
+///<reference path='./resources/PersonalizedOffer.d.ts' />
 ///<reference path='./resources/Plan.d.ts' />
 ///<reference path='./resources/PortalSession.d.ts' />
 ///<reference path='./resources/PriceVariant.d.ts' />
@@ -99,74 +103,83 @@
 ///<reference path='./resources/WebhookEndpoint.d.ts' />
 ///<reference path='./resources/Content.d.ts' />
 ///<reference path='./resources/WebhookEvent.d.ts' />
+declare module 'chargebee' {
+  export type Config = {
+    /**
+     * @apiKey api key for the site.
+     */
+    apiKey: string;
+    /**
+     * @site api site name.
+     */
+    site: string;
+    /**
+     * @apiPath this value indicates the api version, default value is /api/v2.
+     */
+    apiPath?: '/api/v2' | '/api/v1';
+    /**
+     * @timeout client side request timeout in milliseconds, default value is 80000ms.
+     */
+    timeout?: number;
+    /**
+     * @port url port
+     */
+    port?: number;
+    /**
+     * @timemachineWaitInMillis time interval at which two subsequent retrieve timemachine call in milliseconds, default value is 3000ms.
+     */
+    timemachineWaitInMillis?: number;
+    /**
+     * @exportWaitInMillis time interval at which two subsequent retrieve export call in milliseconds, default value is 3000ms.
+     */
+    exportWaitInMillis?: number;
+    /**
+     * @protocol http protocol, default value is https
+     */
+    protocol?: 'https' | 'http';
+    /**
+     * @hostSuffix url host suffix, default value is .chargebee.com
+     */
+    hostSuffix?: string;
 
-export type Config = {
-  /**
-   * @apiKey api key for the site.
-   */
-  apiKey: string;
-  /**
-   * @site api site name.
-   */
-  site: string;
-  /**
-   * @apiPath this value indicates the api version, default value is /api/v2.
-   */
-  apiPath?: '/api/v2' | '/api/v1';
-  /**
-   * @timeout client side request timeout in milliseconds, default value is 80000ms.
-   */
-  timeout?: number;
-  /**
-   * @port url port
-   */
-  port?: number;
-  /**
-   * @timemachineWaitInMillis time interval at which two subsequent retrieve timemachine call in milliseconds, default value is 3000ms.
-   */
-  timemachineWaitInMillis?: number;
-  /**
-   * @exportWaitInMillis time interval at which two subsequent retrieve export call in milliseconds, default value is 3000ms.
-   */
-  exportWaitInMillis?: number;
-  /**
-   * @protocol http protocol, default value is https
-   */
-  protocol?: 'https' | 'http';
-  /**
-   * @hostSuffix url host suffix, default value is .chargebee.com
-   */
-  hostSuffix?: string;
+    /**
+     * @retryConfig retry configuration for the client, default value is { enabled: false, maxRetries: 3, delayMs: 1000, retryOn: [500, 502, 503, 504]}
+     */
+    retryConfig?: RetryConfig;
 
-  /**
-   * @retryConfig retry configuration for the client, default value is { enabled: false, maxRetries: 3, delayMs: 1000, retryOn: [500, 502, 503, 504]}
-   */
-  retryConfig?: RetryConfig;
+    /**
+     * @enableDebugLogs whether to enable debug logs, default value is false
+     */
+    enableDebugLogs?: boolean;
 
-  /**
-   * @enableDebugLogs whether to enable debug logs, default value is false
-   */
-  enableDebugLogs?: boolean;
+    /**
+     * @userAgentSuffix optional string appended to the User-Agent header for additional logging
+     */
+    userAgentSuffix?: string;
 
-  /**
-   * @userAgentSuffix optional string appended to the User-Agent header for additional logging
-   */
-  userAgentSuffix?: string;
-};
+    /**
+     * @httpClient optional http client implementation, default http client will be used if not provided
+     */
+    httpClient?: HttpClientInterface;
+  };
+
+  export interface HttpClientInterface {
+    makeApiRequest: (request: Request, timeout: number) => Promise<Response>;
+  }
+
+  export type RetryConfig = {
+    /**
+     * @enabled whether to enable retry logic, default value is false
+     * @maxRetries maximum number of retries, default value is 3
+     * @delayMs delay in milliseconds between retries, default value is 1000ms
+     * @retryOn array of HTTP status codes to retry on, default value is [500, 502, 503, 504]
+     */
+    enabled?: boolean;
+    maxRetries?: number;
+    delayMs?: number;
+    retryOn?: Array<number>;
+  };
 
-export type RetryConfig = {
-  /**
-   * @enabled whether to enable retry logic, default value is false
-   * @maxRetries maximum number of retries, default value is 3
-   * @delayMs delay in milliseconds between retries, default value is 1000ms
-   * @retryOn array of HTTP status codes to retry on, default value is [500, 502, 503, 504]
-   */
-  enabled?: boolean;
-  maxRetries?: number;
-  delayMs?: number;
-  retryOn?: Array<number>;
-};
-declare module 'chargebee' {
   export default class Chargebee {
     constructor(config: Config);
     addon: Addon.AddonResource;
@@ -199,6 +212,8 @@ declare module 'chargebee' {
     itemFamily: ItemFamily.ItemFamilyResource;
     itemPrice: ItemPrice.ItemPriceResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
+    offerEvent: OfferEvent.OfferEventResource;
+    offerFulfillment: OfferFulfillment.OfferFulfillmentResource;
     omnichannelOneTimeOrder: OmnichannelOneTimeOrder.OmnichannelOneTimeOrderResource;
     omnichannelSubscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
     omnichannelSubscriptionItem: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
@@ -207,6 +222,7 @@ declare module 'chargebee' {
     paymentScheduleScheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
     paymentSource: PaymentSource.PaymentSourceResource;
     paymentVoucher: PaymentVoucher.PaymentVoucherResource;
+    personalizedOffer: PersonalizedOffer.PersonalizedOfferResource;
     plan: Plan.PlanResource;
     portalSession: PortalSession.PortalSessionResource;
     priceVariant: PriceVariant.PriceVariantResource;

package/types/resources/Comment.d.ts

@@ -77,15 +77,6 @@ declare module 'chargebee' {
         | 'coupon'
         | 'order'
         | 'business_entity'
-        | 'omnichannel_subscription'
-        | 'omnichannel_subscription_item'
-        | 'omnichannel_transaction'
-        | 'recorded_purchase'
-        | 'omnichannel_subscription_item_scheduled_change'
-        | 'sales_order'
-        | 'omnichannel_one_time_order'
-        | 'omnichannel_one_time_order_item'
-        | 'usage_file'
         | 'item_family'
         | 'item'
         | 'item_price'

package/types/resources/Content.d.ts

@@ -52,10 +52,13 @@ declare module 'chargebee' {
     item_price: ItemPrice;
     metadata: Metadata;
     non_subscription: NonSubscription;
+    offer_event: OfferEvent;
+    offer_fulfillment: OfferFulfillment;
     omnichannel_one_time_order: OmnichannelOneTimeOrder;
     omnichannel_one_time_order_item: OmnichannelOneTimeOrderItem;
     omnichannel_subscription: OmnichannelSubscription;
     omnichannel_subscription_item: OmnichannelSubscriptionItem;
+    omnichannel_subscription_item_offer: OmnichannelSubscriptionItemOffer;
     omnichannel_subscription_item_scheduled_change: OmnichannelSubscriptionItemScheduledChange;
     omnichannel_transaction: OmnichannelTransaction;
     order: Order;
@@ -66,6 +69,7 @@ declare module 'chargebee' {
     payment_schedule_scheme: PaymentScheduleScheme;
     payment_source: PaymentSource;
     payment_voucher: PaymentVoucher;
+    personalized_offer: PersonalizedOffer;
     plan: Plan;
     portal_session: PortalSession;
     price_variant: PriceVariant;

package/types/resources/CreditNote.d.ts

@@ -3,6 +3,7 @@
 ///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface CreditNote {
+    [key: string]: unknown;
     id: string;
     customer_id: string;
     subscription_id?: string;
@@ -330,6 +331,7 @@ declare module 'chargebee' {
     export interface Discount {
       amount: number;
       description?: string;
+      line_item_id?: string;
       entity_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
@@ -395,7 +397,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface BillingAddress {
       first_name?: string;
@@ -450,6 +451,7 @@ declare module 'chargebee' {
       currency_code?: string;
       comment?: string;
       line_items?: LineItemsCreateInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface RetrieveInputParam {
       line_item?: LineItemRetrieveInputParam;
@@ -528,6 +530,7 @@ declare module 'chargebee' {
       taxes?: TaxesImportCreditNoteInputParam[];
       allocations?: AllocationsImportCreditNoteInputParam[];
       linked_refunds?: LinkedRefundsImportCreditNoteInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface LineItemsCreateInputParam {
       reference_line_item_id?: string;
@@ -582,6 +585,7 @@ declare module 'chargebee' {
       allocated_at: number;
     }
     export interface DiscountsImportCreditNoteInputParam {
+      line_item_id?: string;
       entity_type:
         | 'item_level_coupon'
         | 'document_level_coupon'

package/types/resources/CreditNoteEstimate.d.ts

@@ -12,11 +12,11 @@ declare module 'chargebee' {
     amount_allocated: number;
     amount_available: number;
     line_items?: CreditNoteEstimate.LineItem[];
+    line_item_tiers?: CreditNoteEstimate.LineItemTier[];
+    line_item_discounts?: CreditNoteEstimate.LineItemDiscount[];
+    line_item_taxes?: CreditNoteEstimate.LineItemTax[];
     discounts?: CreditNoteEstimate.Discount[];
     taxes?: CreditNoteEstimate.Tax[];
-    line_item_taxes?: CreditNoteEstimate.LineItemTax[];
-    line_item_discounts?: CreditNoteEstimate.LineItemDiscount[];
-    line_item_tiers?: CreditNoteEstimate.LineItemTier[];
     round_off_amount?: number;
     customer_id?: string;
   }
@@ -71,24 +71,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;
@@ -115,31 +122,25 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
-    export interface LineItemDiscount {
-      line_item_id: string;
-      discount_type:
+    export interface Discount {
+      amount: number;
+      description?: string;
+      line_item_id?: string;
+      entity_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
         | 'promotional_credits'
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
-      coupon_id?: string;
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
-      discount_amount: number;
+      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 Tax {
+      name: string;
+      amount: number;
+      description?: string;
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/Currency.d.ts

@@ -1,19 +1,20 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Currency {
-    id?: string;
+    id: string;
     enabled: boolean;
     forex_type?: 'manual' | 'auto';
-    currency_code?: string;
-    is_base_currency?: boolean;
+    currency_code: string;
+    is_base_currency: boolean;
     manual_exchange_rate?: string;
   }
 
   export namespace Currency {
     export class CurrencyResource {
       list(
+        input?: ListInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<ListResponse>>;
 
@@ -46,7 +47,8 @@ declare module 'chargebee' {
     }
 
     export interface ListResponse {
-      currency: Currency;
+      list: { currency: Currency }[];
+      next_offset?: string;
     }
 
     export interface RetrieveResponse {
@@ -74,6 +76,10 @@ declare module 'chargebee' {
     // REQUEST PARAMS
     //---------------
 
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+    }
     export interface CreateInputParam {
       currency_code: string;
       forex_type: 'manual' | 'auto';

package/types/resources/Customer.d.ts

@@ -348,7 +348,7 @@ declare module 'chargebee' {
     }
 
     export interface ListHierarchyDetailResponse {
-      list: { hierarchies: any[] }[];
+      list: { hierarchy: Hierarchy }[];
       next_offset?: string;
     }
 
@@ -412,6 +412,7 @@ declare module 'chargebee' {
       unbilled_charges: number;
       currency_code: string;
       balance_currency_code: string;
+      business_entity_id?: string;
     }
     export interface EntityIdentifier {
       id: string;

package/types/resources/Entitlement.d.ts

@@ -31,7 +31,7 @@ declare module 'chargebee' {
     }
 
     export interface CreateResponse {
-      entitlement: Entitlement;
+      list: { entitlement: Entitlement }[];
     }
 
     // REQUEST PARAMS

package/types/resources/EntitlementOverride.d.ts

@@ -35,7 +35,7 @@ declare module 'chargebee' {
     }
 
     export interface AddEntitlementOverrideForSubscriptionResponse {
-      entitlement_override: EntitlementOverride;
+      list: { entitlement_override: EntitlementOverride }[];
     }
 
     export interface ListEntitlementOverrideForSubscriptionResponse {

package/types/resources/Estimate.d.ts

@@ -593,6 +593,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       coupon?: string;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       free_period?: number;
       free_period_unit?: FreePeriodUnitEnum;
       contract_term_billing_cycle_on_renewal?: number;
@@ -734,6 +735,7 @@ declare module 'chargebee' {
        */
       setup_fee?: number;
       start_date?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       free_period?: number;
       free_period_unit?: FreePeriodUnitEnum;
       contract_term_billing_cycle_on_renewal?: number;

package/types/resources/Event.d.ts

@@ -47,6 +47,7 @@ declare module 'chargebee' {
       CustomerDeletedContent &
       RefundInitiatedContent &
       InvoiceGeneratedWithBackdatingContent &
+      OmnichannelTransactionCreatedContent &
       AddUsagesReminderContent &
       VoucherCreatedContent &
       RuleUpdatedContent &
@@ -73,6 +74,7 @@ declare module 'chargebee' {
       SubscriptionAdvanceInvoiceScheduleUpdatedContent &
       ItemDeletedContent &
       SubscriptionRampDraftedContent &
+      DunningUpdatedContent &
       ItemEntitlementsUpdatedContent &
       TokenConsumedContent &
       HierarchyDeletedContent &
@@ -166,6 +168,7 @@ declare module 'chargebee' {
       SubscriptionScheduledCancellationRemovedContent &
       PaymentRefundedContent &
       UsageFileIngestedContent &
+      OmnichannelSubscriptionMovedInContent &
       DifferentialPriceCreatedContent &
       TransactionCreatedContent &
       PaymentSucceededContent &

package/types/resources/GatewayErrorDetail.d.ts

@@ -17,5 +17,6 @@ declare module 'chargebee' {
     processor_error_code?: string;
     processor_error_message?: string;
     error_cause_id?: string;
+    processor_advice_code?: string;
   }
 }

package/types/resources/HostedPage.d.ts

@@ -14,6 +14,7 @@ declare module 'chargebee' {
       | 'checkout_one_time'
       | 'pre_cancel'
       | 'view_voucher'
+      | 'accept_quote'
       | 'checkout_gift'
       | 'claim_gift';
     url?: string;
@@ -813,6 +814,7 @@ declare module 'chargebee' {
       start_date?: number;
       coupon?: string;
       auto_collection?: AutoCollectionEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       invoice_notes?: string;
       po_number?: string;
       contract_term_billing_cycle_on_renewal?: number;