chargebee 3.23.1 → 3.25.0-beta.1

package/types/index.d.ts

@@ -33,6 +33,7 @@
 ///<reference path='./resources/Event.d.ts' />
 ///<reference path='./resources/Export.d.ts' />
 ///<reference path='./resources/Feature.d.ts' />
+///<reference path='./resources/FilterCondition.d.ts' />
 ///<reference path='./resources/GatewayErrorDetail.d.ts' />
 ///<reference path='./resources/Gift.d.ts' />
 ///<reference path='./resources/Hierarchy.d.ts' />
@@ -75,6 +76,7 @@
 ///<reference path='./resources/PromotionalCredit.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' />
@@ -163,6 +165,11 @@ 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 {
@@ -186,6 +193,8 @@ declare module 'chargebee' {
     constructor(config: Config);
     addon: Addon.AddonResource;
     address: Address.AddressResource;
+    alert: Alert.AlertResource;
+    alertStatu: AlertStatus.AlertStatusResource;
     attachedItem: AttachedItem.AttachedItemResource;
     businessEntity: BusinessEntity.BusinessEntityResource;
     card: Card.CardResource;
@@ -440,4 +449,15 @@ 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/Alert.d.ts

@@ -1,19 +1,125 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Alert {
     id: string;
-    type?: TypeEnum;
+    type: TypeEnum;
     name: string;
     description?: string;
     metered_feature_id: string;
     subscription_id?: string;
     status?: 'enabled' | 'disabled';
-    alarm_triggered_at?: number;
-    scope?: 'global' | 'subscription';
     meta?: string;
     created_at: number;
     updated_at: number;
   }
+
+  export namespace Alert {
+    export class AlertResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        alert_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      update(
+        alert_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        alert_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      applicationAlertsForSubscription(
+        subscription_id: string,
+        input?: ApplicationAlertsForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ApplicationAlertsForSubscriptionResponse>>;
+    }
+
+    export interface CreateResponse {
+      alert: Alert;
+    }
+
+    export interface RetrieveResponse {
+      alert: Alert;
+    }
+
+    export interface ListResponse {
+      list: { alert: Alert }[];
+      next_offset?: string;
+    }
+
+    export interface UpdateResponse {
+      alert: Alert;
+    }
+
+    export interface DeleteResponse {
+      alert: Alert;
+    }
+
+    export interface ApplicationAlertsForSubscriptionResponse {
+      list: { alert: Alert }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      type: TypeEnum;
+      name: string;
+      description?: string;
+      metered_feature_id: string;
+      subscription_id?: string;
+      meta?: string;
+      threshold?: ThresholdCreateInputParam;
+      filter_conditions?: FilterConditionsCreateInputParam[];
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      type?: filter.Enum;
+      subscription_id?: filter.String;
+      status?: filter.Enum;
+    }
+    export interface UpdateInputParam {
+      status?: 'enabled' | 'disabled';
+      threshold?: ThresholdUpdateInputParam;
+    }
+    export interface ApplicationAlertsForSubscriptionInputParam {
+      limit?: number;
+      offset?: string;
+      status?: filter.Enum;
+      type?: filter.Enum;
+    }
+    export interface ThresholdCreateInputParam {
+      mode: ModeEnum;
+      value: number;
+    }
+
+    export interface FilterConditionsCreateInputParam {
+      field?: 'plan_price_id';
+      operator?: 'equals' | 'not_equals';
+      value?: string;
+    }
+    export interface ThresholdUpdateInputParam {
+      mode?: ModeEnum;
+      value?: number;
+    }
+  }
 }

package/types/resources/AlertStatus.d.ts

@@ -1,11 +1,52 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface AlertStatus {
     alert_id: string;
     subscription_id: string;
-    alert_status: AlertStatusEnum;
+    alarm_status: AlarmStatusEnum;
     alarm_triggered_at?: number;
   }
+
+  export namespace AlertStatus {
+    export class AlertStatusResource {
+      alertStatusesForSubscription(
+        subscription_id: string,
+        input?: AlertStatusesForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AlertStatusesForSubscriptionResponse>>;
+
+      alertStatusesForAlert(
+        alert_id: string,
+        input?: AlertStatusesForAlertInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AlertStatusesForAlertResponse>>;
+    }
+
+    export interface AlertStatusesForSubscriptionResponse {
+      list: { alert_status: AlertStatus }[];
+      next_offset?: string;
+    }
+
+    export interface AlertStatusesForAlertResponse {
+      list: { alert_status: AlertStatus }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface AlertStatusesForSubscriptionInputParam {
+      limit?: number;
+      offset?: string;
+      alarm_status?: filter.Enum;
+      alert_id?: filter.String;
+    }
+    export interface AlertStatusesForAlertInputParam {
+      limit?: number;
+      offset?: string;
+      alarm_status?: filter.Enum;
+    }
+  }
 }

package/types/resources/Card.d.ts

@@ -33,6 +33,7 @@ declare module 'chargebee' {
       | 'maestro'
       | 'dankort'
       | 'cartes_bancaires'
+      | 'mada'
       | 'other'
       | 'not_applicable';
     funding_type:

package/types/resources/Content.d.ts

@@ -38,6 +38,7 @@ declare module 'chargebee' {
     event: Event;
     export: Export;
     feature: Feature;
+    filter_condition: FilterCondition;
     gateway_error_detail: GatewayErrorDetail;
     gift: Gift;
     hierarchy: Hierarchy;
@@ -80,6 +81,7 @@ declare module 'chargebee' {
     promotional_credit: PromotionalCredit;
     purchase: Purchase;
     quote: Quote;
+    quote_entitlement: QuoteEntitlement;
     quote_line_group: QuoteLineGroup;
     quoted_charge: QuotedCharge;
     quoted_delta_ramp: QuotedDeltaRamp;

package/types/resources/Customer.d.ts

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

package/types/resources/Estimate.d.ts

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

package/types/resources/Event.d.ts

@@ -15,7 +15,8 @@ declare module 'chargebee' {
       | 'failed'
       | 'skipped'
       | 'not_applicable'
-      | 'disabled';
+      | 'disabled'
+      | 'rate_limited';
     webhook_failure_reason?: string;
     webhooks?: Event.Webhook[];
     event_type?: EventTypeEnum;
@@ -272,7 +273,8 @@ declare module 'chargebee' {
         | 'failed'
         | 'skipped'
         | 'not_applicable'
-        | 'disabled';
+        | 'disabled'
+        | 'rate_limited';
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/FilterCondition.d.ts

@@ -0,0 +1,10 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface FilterCondition {
+    field: 'plan_price_id';
+    operator: 'equals' | 'not_equals';
+    value: string;
+  }
+}

package/types/resources/Gift.d.ts

@@ -215,7 +215,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -299,7 +306,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Invoice.d.ts

@@ -1074,6 +1074,7 @@ declare module 'chargebee' {
       channel?: filter.Enum;
       voided_at?: filter.Timestamp;
       void_reason_code?: filter.String;
+      exclude?: filter.String;
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }
@@ -1282,7 +1283,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1441,7 +1449,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/PaymentIntent.d.ts

@@ -7,7 +7,7 @@ declare module 'chargebee' {
     status: 'inited' | 'in_progress' | 'authorized' | 'consumed' | 'expired';
     currency_code?: string;
     amount: number;
-    gateway_account_id: string;
+    gateway_account_id?: string;
     expires_at: number;
     reference_id?: string;
     payment_method_type?:
@@ -43,7 +43,14 @@ declare module 'chargebee' {
       | 'cash_app_pay'
       | 'wechat_pay'
       | 'alipay'
-      | 'pix';
+      | 'pix'
+      | 'twint'
+      | 'go_pay'
+      | 'grab_pay'
+      | 'pay_co'
+      | 'after_pay'
+      | 'swish'
+      | 'payme';
     success_url?: string;
     failure_url?: string;
     created_at: number;
@@ -131,7 +138,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -183,7 +197,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -202,6 +223,7 @@ declare module 'chargebee' {
       currency_code: string;
       gateway_account_id?: string;
       reference_id?: string;
+      defer_payment_method_type?: boolean;
       payment_method_type?:
         | 'card'
         | 'ideal'
@@ -235,7 +257,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       success_url?: string;
       failure_url?: string;
     }
@@ -276,7 +305,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       success_url?: string;
       failure_url?: string;
     }

package/types/resources/PaymentSource.d.ts

@@ -226,6 +226,7 @@ declare module 'chargebee' {
         | 'maestro'
         | 'dankort'
         | 'cartes_bancaires'
+        | 'mada'
         | 'not_applicable';
       funding_type:
         | 'credit'
@@ -424,7 +425,8 @@ declare module 'chargebee' {
         | 'rupay'
         | 'maestro'
         | 'dankort'
-        | 'cartes_bancaires';
+        | 'cartes_bancaires'
+        | 'mada';
       funding_type?: 'credit' | 'debit' | 'prepaid' | 'not_known';
     }
 
@@ -465,7 +467,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Purchase.d.ts

@@ -110,7 +110,14 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix';
+        | 'pix'
+        | 'twint'
+        | 'go_pay'
+        | 'grab_pay'
+        | 'pay_co'
+        | 'after_pay'
+        | 'swish'
+        | 'payme';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Quote.d.ts

@@ -743,6 +743,7 @@ declare module 'chargebee' {
       currency_code?: string;
       coupon?: string;
       coupon_ids?: string[];
+      net_term_days?: number;
       billing_address?: BillingAddressCreateForChargeItemsAndChargesInputParam;
       shipping_address?: ShippingAddressCreateForChargeItemsAndChargesInputParam;
       item_prices?: ItemPricesCreateForChargeItemsAndChargesInputParam[];
@@ -758,6 +759,7 @@ declare module 'chargebee' {
       currency_code?: string;
       coupon?: string;
       coupon_ids?: string[];
+      net_term_days?: number;
       billing_address?: BillingAddressEditForChargeItemsAndChargesInputParam;
       shipping_address?: ShippingAddressEditForChargeItemsAndChargesInputParam;
       item_prices?: ItemPricesEditForChargeItemsAndChargesInputParam[];

package/types/resources/QuoteEntitlement.d.ts

@@ -0,0 +1,16 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface QuoteEntitlement {
+    entity_id: string;
+    entity_type: 'plan_price' | 'addon_price' | 'charge_price' | 'charge';
+    feature_id: string;
+    value: string;
+    is_enabled: boolean;
+    start_date?: number;
+    end_date?: number;
+    created_at: number;
+    modified_at: number;
+  }
+}