chargebee 3.25.0-beta.1 → 3.26.0

package/esm/resources/api_endpoints.js

@@ -3029,7 +3029,6 @@ export const Endpoints = {
     quotedDeltaRamp: [],
     billingConfiguration: [],
     quoteLineGroup: [],
-    quoteEntitlement: [],
     cpqQuoteSignature: [],
     plan: [
         [
@@ -4693,6 +4692,7 @@ export const Endpoints = {
             },
         ],
     ],
+    omnichannelSubscriptionItemScheduledChange: [],
     omnichannelSubscription: [
         [
             'retrieve',
@@ -4825,7 +4825,6 @@ export const Endpoints = {
             {},
         ],
     ],
-    omnichannelSubscriptionItemScheduledChange: [],
     usageFile: [
         [
             'uploadUrl',
@@ -4885,7 +4884,7 @@ export const Endpoints = {
             null,
             true,
             'grow',
-            true,
+            false,
             {},
             {},
         ],
@@ -5052,6 +5051,125 @@ export const Endpoints = {
             {},
         ],
     ],
+    ledgerAccountBalance: [
+        [
+            'listLedgerAccountBalances',
+            'GET',
+            '/ledger_account_balances',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
+    ledgerOperation: [
+        [
+            'retrieveLedgerOperation',
+            'GET',
+            '/ledger_operations',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+        [
+            'listLedgerOperations',
+            'GET',
+            '/ledger_operations',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
+        [
+            'capture',
+            'POST',
+            '/ledger_operations',
+            '/capture',
+            false,
+            null,
+            true,
+            {
+                metadata: 0,
+            },
+            {},
+        ],
+        [
+            'authorize',
+            'POST',
+            '/ledger_operations',
+            '/authorize',
+            false,
+            null,
+            true,
+            {
+                metadata: 0,
+            },
+            {},
+        ],
+        [
+            'captureAuthorization',
+            'POST',
+            '/ledger_operations',
+            '/capture_authorization',
+            false,
+            null,
+            true,
+            {
+                metadata: 0,
+            },
+            {},
+        ],
+        [
+            'releaseAuthorization',
+            'POST',
+            '/ledger_operations',
+            '/release_authorization',
+            false,
+            null,
+            true,
+            {
+                metadata: 0,
+            },
+            {},
+        ],
+    ],
+    grantBlock: [
+        [
+            'listGrantBlocks',
+            'GET',
+            '/grant_blocks',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
+    promotionalGrant: [
+        [
+            'promotionalGrants',
+            'POST',
+            '/promotional_grants',
+            null,
+            false,
+            null,
+            true,
+            {
+                metadata: 0,
+            },
+            {
+                isIdempotent: true,
+            },
+        ],
+    ],
     impactedCustomer: [],
     subscriptionEntitlementsUpdatedDetail: [],
     subscriptionEntitlementsCreatedDetail: [],

package/esm/resources/webhook/eventType.js

@@ -105,12 +105,14 @@ export var WebhookEventType;
     WebhookEventType["OmnichannelSubscriptionItemPauseScheduled"] = "omnichannel_subscription_item_pause_scheduled";
     WebhookEventType["OmnichannelSubscriptionItemPaused"] = "omnichannel_subscription_item_paused";
     WebhookEventType["OmnichannelSubscriptionItemReactivated"] = "omnichannel_subscription_item_reactivated";
+    WebhookEventType["OmnichannelSubscriptionItemRecovered"] = "omnichannel_subscription_item_recovered";
     WebhookEventType["OmnichannelSubscriptionItemRenewed"] = "omnichannel_subscription_item_renewed";
     WebhookEventType["OmnichannelSubscriptionItemResubscribed"] = "omnichannel_subscription_item_resubscribed";
     WebhookEventType["OmnichannelSubscriptionItemResumed"] = "omnichannel_subscription_item_resumed";
     WebhookEventType["OmnichannelSubscriptionItemScheduledCancellationRemoved"] = "omnichannel_subscription_item_scheduled_cancellation_removed";
     WebhookEventType["OmnichannelSubscriptionItemScheduledChangeRemoved"] = "omnichannel_subscription_item_scheduled_change_removed";
     WebhookEventType["OmnichannelSubscriptionItemScheduledDowngradeRemoved"] = "omnichannel_subscription_item_scheduled_downgrade_removed";
+    WebhookEventType["OmnichannelSubscriptionItemUpdated"] = "omnichannel_subscription_item_updated";
     WebhookEventType["OmnichannelSubscriptionItemUpgraded"] = "omnichannel_subscription_item_upgraded";
     WebhookEventType["OmnichannelSubscriptionMovedIn"] = "omnichannel_subscription_moved_in";
     WebhookEventType["OmnichannelTransactionCreated"] = "omnichannel_transaction_created";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.25.0-beta.1",
+  "version": "3.26.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",
@@ -75,8 +75,5 @@
     "semi": true,
     "singleQuote": true,
     "parser": "typescript"
-  },
-  "dependencies": {
-    "zod": "^4.3.6"
   }
 }

package/types/core.d.ts

@@ -5,8 +5,6 @@ declare module 'chargebee' {
     timeout?: number;
     timemachineWaitInMillis?: number;
     exportWaitInMillis?: number;
-    /** When true, request parameters are validated against Zod schemas before each HTTP call (where a schema exists). */
-    enableValidation?: boolean;
   }
   export type ChargebeeResponse<T> = T & {
     headers: { [key: string]: string };
@@ -370,6 +368,8 @@ declare module 'chargebee' {
     | 'omnichannel_subscription_moved_in'
     | 'omnichannel_transaction_created'
     | 'alert_status_changed'
+    | 'omnichannel_subscription_item_updated'
+    | 'omnichannel_subscription_item_recovered'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -532,7 +532,12 @@ declare module 'chargebee' {
     | 'pay_co'
     | 'after_pay'
     | 'swish'
-    | 'payme';
+    | 'payme'
+    | 'klarna'
+    | 'alipay_hk'
+    | 'paypay'
+    | 'gcash'
+    | 'south_korean_cards';
   type PaymentMethodSavePolicyEnum = 'always' | 'ask' | 'never';
   type PaymentMethodTypeEnum =
     | 'card'
@@ -569,14 +574,19 @@ declare module 'chargebee' {
     | 'naver_pay'
     | 'revolut_pay'
     | 'cash_app_pay'
-    | 'pix'
     | 'twint'
     | 'go_pay'
     | 'grab_pay'
     | 'pay_co'
     | 'after_pay'
     | 'swish'
-    | 'payme';
+    | 'payme'
+    | 'pix'
+    | 'klarna'
+    | 'alipay_hk'
+    | 'paypay'
+    | 'gcash'
+    | 'south_korean_cards';
   type PaymentVoucherTypeEnum = 'boleto';
   type PeriodUnitEnum = 'day' | 'week' | 'month' | 'year';
   type PriceTypeEnum = 'tax_exclusive' | 'tax_inclusive';
@@ -616,6 +626,7 @@ declare module 'chargebee' {
     | 'js_api'
     | 'migration'
     | 'external_service';
+  type StatusEnum = 'available' | 'exhausted' | 'scheduled' | 'in_grace_period';
   type TaxExemptReasonEnum =
     | 'tax_not_configured'
     | 'region_non_taxable'
@@ -679,7 +690,6 @@ declare module 'chargebee' {
     | 'naver_pay'
     | 'revolut_pay'
     | 'cash_app_pay'
-    | 'pix'
     | 'twint'
     | 'go_pay'
     | 'grab_pay'
@@ -687,6 +697,12 @@ declare module 'chargebee' {
     | 'after_pay'
     | 'swish'
     | 'payme'
+    | 'pix'
+    | 'klarna'
+    | 'alipay_hk'
+    | 'paypay'
+    | 'gcash'
+    | 'south_korean_cards'
     | 'free_trial'
     | 'pay_up_front'
     | 'pay_as_you_go'
@@ -917,6 +933,8 @@ declare module 'chargebee' {
     | 'omnichannel_subscription_moved_in'
     | 'omnichannel_transaction_created'
     | 'alert_status_changed'
+    | 'omnichannel_subscription_item_updated'
+    | 'omnichannel_subscription_item_recovered'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'

package/types/index.d.ts

@@ -36,6 +36,7 @@
 ///<reference path='./resources/FilterCondition.d.ts' />
 ///<reference path='./resources/GatewayErrorDetail.d.ts' />
 ///<reference path='./resources/Gift.d.ts' />
+///<reference path='./resources/GrantBlock.d.ts' />
 ///<reference path='./resources/Hierarchy.d.ts' />
 ///<reference path='./resources/HostedPage.d.ts' />
 ///<reference path='./resources/ImpactedCustomer.d.ts' />
@@ -49,6 +50,8 @@
 ///<reference path='./resources/ItemEntitlement.d.ts' />
 ///<reference path='./resources/ItemFamily.d.ts' />
 ///<reference path='./resources/ItemPrice.d.ts' />
+///<reference path='./resources/LedgerAccountBalance.d.ts' />
+///<reference path='./resources/LedgerOperation.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
 ///<reference path='./resources/OfferEvent.d.ts' />
@@ -74,9 +77,9 @@
 ///<reference path='./resources/PriceVariant.d.ts' />
 ///<reference path='./resources/PricingPageSession.d.ts' />
 ///<reference path='./resources/PromotionalCredit.d.ts' />
+///<reference path='./resources/PromotionalGrant.d.ts' />
 ///<reference path='./resources/Purchase.d.ts' />
 ///<reference path='./resources/Quote.d.ts' />
-///<reference path='./resources/QuoteEntitlement.d.ts' />
 ///<reference path='./resources/QuoteLineGroup.d.ts' />
 ///<reference path='./resources/QuotedCharge.d.ts' />
 ///<reference path='./resources/QuotedDeltaRamp.d.ts' />
@@ -165,11 +168,6 @@ declare module 'chargebee' {
      * @httpClient optional http client implementation, default http client will be used if not provided
      */
     httpClient?: HttpClientInterface;
-
-    /**
-     * @enableValidation When true, every request's parameters are validated against each endpoint's generated Zod schema before the HTTP request is sent. Violations throw `ChargebeeZodValidationError` with structured Zod issues. Calls with no params argument are validated as `{}`. Required resource ids in the URL path are still checked separately.
-     */
-    enableValidation?: boolean;
   };
 
   export interface HttpClientInterface {
@@ -215,6 +213,7 @@ declare module 'chargebee' {
     export: Export.ExportResource;
     feature: Feature.FeatureResource;
     gift: Gift.GiftResource;
+    grantBlock: GrantBlock.GrantBlockResource;
     hostedPage: HostedPage.HostedPageResource;
     inAppSubscription: InAppSubscription.InAppSubscriptionResource;
     invoice: Invoice.InvoiceResource;
@@ -222,6 +221,8 @@ declare module 'chargebee' {
     itemEntitlement: ItemEntitlement.ItemEntitlementResource;
     itemFamily: ItemFamily.ItemFamilyResource;
     itemPrice: ItemPrice.ItemPriceResource;
+    ledgerAccountBalance: LedgerAccountBalance.LedgerAccountBalanceResource;
+    ledgerOperation: LedgerOperation.LedgerOperationResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
     offerEvent: OfferEvent.OfferEventResource;
     offerFulfillment: OfferFulfillment.OfferFulfillmentResource;
@@ -239,6 +240,7 @@ declare module 'chargebee' {
     priceVariant: PriceVariant.PriceVariantResource;
     pricingPageSession: PricingPageSession.PricingPageSessionResource;
     promotionalCredit: PromotionalCredit.PromotionalCreditResource;
+    promotionalGrant: PromotionalGrant.PromotionalGrantResource;
     purchase: Purchase.PurchaseResource;
     quote: Quote.QuoteResource;
     ramp: Ramp.RampResource;
@@ -449,15 +451,4 @@ declare module 'chargebee' {
     name: string;
     readonly rawBody?: string;
   }
-
-  /**
-   * Thrown when `enableValidation` is on and request parameters fail the action's Zod schema.
-   * Carries `actionName` and the original `ZodError` (issues, `flatten()`, etc.) for programmatic handling.
-   */
-  export class ChargebeeZodValidationError extends Error {
-    constructor(actionName: string, zodError: import('zod').ZodError);
-    name: string;
-    readonly actionName: string;
-    readonly zodError: import('zod').ZodError;
-  }
 }

package/types/resources/Content.d.ts

@@ -41,6 +41,7 @@ declare module 'chargebee' {
     filter_condition: FilterCondition;
     gateway_error_detail: GatewayErrorDetail;
     gift: Gift;
+    grant_block: GrantBlock;
     hierarchy: Hierarchy;
     hosted_page: HostedPage;
     impacted_customer: ImpactedCustomer;
@@ -54,6 +55,8 @@ declare module 'chargebee' {
     item_entitlement: ItemEntitlement;
     item_family: ItemFamily;
     item_price: ItemPrice;
+    ledger_account_balance: LedgerAccountBalance;
+    ledger_operation: LedgerOperation;
     metadata: Metadata;
     non_subscription: NonSubscription;
     offer_event: OfferEvent;
@@ -79,9 +82,9 @@ declare module 'chargebee' {
     price_variant: PriceVariant;
     pricing_page_session: PricingPageSession;
     promotional_credit: PromotionalCredit;
+    promotional_grant: PromotionalGrant;
     purchase: Purchase;
     quote: Quote;
-    quote_entitlement: QuoteEntitlement;
     quote_line_group: QuoteLineGroup;
     quoted_charge: QuotedCharge;
     quoted_delta_ramp: QuotedDeltaRamp;

package/types/resources/CreditNote.d.ts

@@ -44,6 +44,7 @@ declare module 'chargebee' {
     local_currency_code?: string;
     round_off_amount?: number;
     fractional_correction?: number;
+    notes?: string[];
     line_items?: CreditNote.LineItem[];
     line_item_tiers?: CreditNote.LineItemTier[];
     line_item_discounts?: CreditNote.LineItemDiscount[];

package/types/resources/Customer.d.ts

@@ -762,14 +762,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -954,14 +959,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       /**
        * @deprecated Please refer API docs to use other attributes
        */

package/types/resources/Estimate.d.ts

@@ -1058,14 +1058,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1155,14 +1160,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Event.d.ts

@@ -65,6 +65,7 @@ declare module 'chargebee' {
       GiftUnclaimedContent &
       VirtualBankAccountAddedContent &
       PaymentIntentCreatedContent &
+      OmnichannelSubscriptionItemUpdatedContent &
       CreditNoteCreatedWithBackdatingContent &
       ContractTermTerminatedContent &
       ItemFamilyUpdatedContent &
@@ -77,6 +78,7 @@ declare module 'chargebee' {
       ItemDeletedContent &
       SubscriptionRampDraftedContent &
       DunningUpdatedContent &
+      OmnichannelSubscriptionItemRecoveredContent &
       ItemEntitlementsUpdatedContent &
       TokenConsumedContent &
       HierarchyDeletedContent &

package/types/resources/Gift.d.ts

@@ -50,7 +50,7 @@ declare module 'chargebee' {
 
       updateGift(
         gift_id: string,
-        input: UpdateGiftInputParam,
+        input?: UpdateGiftInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<UpdateGiftResponse>>;
     }
@@ -147,8 +147,9 @@ declare module 'chargebee' {
       status?: filter.Enum;
     }
     export interface UpdateGiftInputParam {
-      scheduled_at: number;
+      scheduled_at?: number;
       comment?: string;
+      gift_receiver?: GiftReceiverUpdateGiftInputParam;
     }
     export interface GiftReceiverCreateInputParam {
       customer_id: string;
@@ -215,14 +216,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -306,14 +312,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -345,5 +356,11 @@ declare module 'chargebee' {
       email?: filter.String;
       customer_id?: filter.String;
     }
+
+    export interface GiftReceiverUpdateGiftInputParam {
+      email?: string;
+      first_name?: string;
+      last_name?: string;
+    }
   }
 }

package/types/resources/GrantBlock.d.ts

@@ -0,0 +1,59 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface GrantBlock {
+    id: string;
+    granted_amount: string;
+    effective_from: number;
+    expires_at: number;
+    balance: string;
+    hold_amount: string;
+    used_amount: string;
+    expired_amount: string;
+    rolled_over_amount: string;
+    voided_amount: string;
+    origin_grant_block_id?: string;
+    status: StatusEnum;
+    metadata?: string;
+    grant_source:
+      | 'subscription_created'
+      | 'subscription_changed'
+      | 'top_up'
+      | 'promotional_grants'
+      | 'rollover';
+    created_at?: number;
+    account_type?: 'provisioned' | 'overdraft';
+    unit_id?: string;
+    unit_type?: 'credit_unit';
+  }
+
+  export namespace GrantBlock {
+    export class GrantBlockResource {
+      listGrantBlocks(
+        input: ListGrantBlocksInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListGrantBlocksResponse>>;
+    }
+
+    export interface ListGrantBlocksResponse {
+      list: { grant_block: GrantBlock }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListGrantBlocksInputParam {
+      limit?: number;
+      offset?: string;
+      subscription_id: filter.String;
+      unit_id?: filter.String;
+      effective_from?: filter.Timestamp;
+      expires_at?: filter.Timestamp;
+      created_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/HostedPage.d.ts

@@ -7,7 +7,6 @@ declare module 'chargebee' {
     type?:
       | 'checkout_new'
       | 'checkout_existing'
-      | 'update_payment_method'
       | 'manage_payment_sources'
       | 'collect_now'
       | 'extend_subscription'
@@ -29,6 +28,7 @@ declare module 'chargebee' {
     embed: boolean;
     created_at?: number;
     expires_at?: number;
+    layout?: LayoutEnum;
     content: Content;
     updated_at?: number;
     resource_version?: number;
@@ -77,6 +77,10 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<UpdateCardResponse>>;
 
+      /**
+       * @deprecated This method is deprecated and will be removed in a future version.
+       */
+
       updatePaymentMethod(
         input: UpdatePaymentMethodInputParam,
         headers?: ChargebeeRequestHeader,
@@ -437,6 +441,7 @@ declare module 'chargebee' {
       addons?: AddonsCheckoutGiftInputParam[];
     }
     export interface CheckoutGiftForItemsInputParam {
+      layout?: LayoutEnum;
       business_entity_id?: string;
       redirect_url?: string;
       coupon_ids?: string[];