chargebee 3.15.1 → 3.17.0-beta.1

package/types/index.d.ts

@@ -24,6 +24,7 @@
 ///<reference path='./resources/DifferentialPrice.d.ts' />
 ///<reference path='./resources/Discount.d.ts' />
 ///<reference path='./resources/Download.d.ts' />
+///<reference path='./resources/Einvoice.d.ts' />
 ///<reference path='./resources/Entitlement.d.ts' />
 ///<reference path='./resources/EntitlementOverride.d.ts' />
 ///<reference path='./resources/Estimate.d.ts' />
@@ -75,6 +76,7 @@
 ///<reference path='./resources/Quote.d.ts' />
 ///<reference path='./resources/QuoteLineGroup.d.ts' />
 ///<reference path='./resources/QuotedCharge.d.ts' />
+///<reference path='./resources/QuotedDeltaRamp.d.ts' />
 ///<reference path='./resources/QuotedRamp.d.ts' />
 ///<reference path='./resources/QuotedSubscription.d.ts' />
 ///<reference path='./resources/Ramp.d.ts' />
@@ -248,4 +250,69 @@ declare module 'chargebee' {
     virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
     webhookEndpoint: WebhookEndpoint.WebhookEndpointResource;
   }
+
+  // Webhook Handler
+  export type WebhookEventName = EventTypeEnum | 'unhandled_event';
+  export type WebhookEventTypeValue = `${WebhookEventType}`;
+  /** @deprecated Use WebhookEventTypeValue instead */
+  export type WebhookContentTypeValue = WebhookEventTypeValue;
+
+  export type WebhookEventListener<
+    T extends WebhookEventType = WebhookEventType,
+  > = (event: WebhookEvent<T>) => Promise<void> | void;
+  export type WebhookErrorListener = (error: Error) => Promise<void> | void;
+
+  // Helper type to map string literal to enum member
+  type StringToWebhookEventType<S extends WebhookEventTypeValue> = {
+    [K in WebhookEventType]: `${K}` extends S ? K : never;
+  }[WebhookEventType];
+
+  export class WebhookHandler {
+    on<T extends WebhookEventType>(
+      eventName: T,
+      listener: WebhookEventListener<T>,
+    ): this;
+    on<S extends WebhookEventTypeValue>(
+      eventName: S,
+      listener: WebhookEventListener<StringToWebhookEventType<S>>,
+    ): this;
+    on(eventName: 'unhandled_event', listener: WebhookEventListener): this;
+    on(eventName: 'error', listener: WebhookErrorListener): this;
+    once<T extends WebhookEventType>(
+      eventName: T,
+      listener: WebhookEventListener<T>,
+    ): this;
+    once<S extends WebhookEventTypeValue>(
+      eventName: S,
+      listener: WebhookEventListener<StringToWebhookEventType<S>>,
+    ): this;
+    once(eventName: 'unhandled_event', listener: WebhookEventListener): this;
+    once(eventName: 'error', listener: WebhookErrorListener): this;
+    off<T extends WebhookEventType>(
+      eventName: T,
+      listener: WebhookEventListener<T>,
+    ): this;
+    off<S extends WebhookEventTypeValue>(
+      eventName: S,
+      listener: WebhookEventListener<StringToWebhookEventType<S>>,
+    ): this;
+    off(eventName: 'unhandled_event', listener: WebhookEventListener): this;
+    off(eventName: 'error', listener: WebhookErrorListener): this;
+    handle(
+      body: string | object,
+      headers?: Record<string, string | string[] | undefined>,
+    ): void;
+    onError?: (error: any) => void;
+    requestValidator?: (
+      headers: Record<string, string | string[] | undefined>,
+    ) => void;
+  }
+
+  // Webhook Auth
+  export function basicAuthValidator(
+    validateCredentials: (username: string, password: string) => boolean,
+  ): (headers: Record<string, string | string[] | undefined>) => void;
+
+  // Default webhook handler instance
+  export const webhook: WebhookHandler;
 }

package/types/resources/Content.d.ts

@@ -29,6 +29,7 @@ declare module 'chargebee' {
     differential_price: DifferentialPrice;
     discount: Discount;
     download: Download;
+    einvoice: Einvoice;
     entitlement: Entitlement;
     entitlement_override: EntitlementOverride;
     estimate: Estimate;
@@ -80,6 +81,7 @@ declare module 'chargebee' {
     quote: Quote;
     quote_line_group: QuoteLineGroup;
     quoted_charge: QuotedCharge;
+    quoted_delta_ramp: QuotedDeltaRamp;
     quoted_ramp: QuotedRamp;
     quoted_subscription: QuotedSubscription;
     ramp: Ramp;

package/types/resources/CreditNote.d.ts

@@ -37,6 +37,7 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     channel?: ChannelEnum;
+    line_items_next_offset?: string;
     sub_total: number;
     sub_total_in_local_currency?: number;
     total_in_local_currency?: number;
@@ -454,6 +455,8 @@ declare module 'chargebee' {
       [key: `cf_${string}`]: unknown;
     }
     export interface RetrieveInputParam {
+      line_items_limit?: number;
+      line_items_offset?: string;
       line_item?: LineItemRetrieveInputParam;
     }
     export interface PdfInputParam {

package/types/resources/Einvoice.d.ts

@@ -0,0 +1,17 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Einvoice {
+    id: string;
+    reference_number?: string;
+    status:
+      | 'scheduled'
+      | 'skipped'
+      | 'in_progress'
+      | 'success'
+      | 'failed'
+      | 'registered';
+    message?: string;
+  }
+}

package/types/resources/Estimate.d.ts

@@ -413,6 +413,7 @@ declare module 'chargebee' {
       payment_intent?: PaymentIntentGiftSubscriptionForItemsInputParam;
       shipping_address?: ShippingAddressGiftSubscriptionForItemsInputParam;
       subscription_items?: SubscriptionItemsGiftSubscriptionForItemsInputParam[];
+      item_tiers?: ItemTiersGiftSubscriptionForItemsInputParam[];
     }
     export interface CreateInvoiceInputParam {
       currency_code?: string;
@@ -1131,6 +1132,17 @@ declare module 'chargebee' {
       item_price_id?: string;
       quantity?: number;
       quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+    }
+    export interface ItemTiersGiftSubscriptionForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
     }
     export interface InvoiceCreateInvoiceInputParam {
       customer_id?: string;

package/types/resources/Event.d.ts

@@ -228,7 +228,13 @@ declare module 'chargebee' {
       PaymentSourceUpdatedContent &
       BusinessEntityDeletedContent &
       AuthorizationVoidedContent &
-      SubscriptionRampDeletedContent;
+      SubscriptionRampDeletedContent &
+      PlanDeletedContent &
+      AddonDeletedContent &
+      AddonUpdatedContent &
+      AddonCreatedContent &
+      PlanCreatedContent &
+      PlanUpdatedContent;
     origin_user?: string;
   }
 

package/types/resources/Gift.d.ts

@@ -131,11 +131,13 @@ declare module 'chargebee' {
       no_expiry?: boolean;
       claim_expiry_date?: number;
       coupon_ids?: string[];
+      meta_data?: any;
       gifter?: GifterCreateForItemsInputParam;
       gift_receiver?: GiftReceiverCreateForItemsInputParam;
       payment_intent?: PaymentIntentCreateForItemsInputParam;
       shipping_address?: ShippingAddressCreateForItemsInputParam;
       subscription_items?: SubscriptionItemsCreateForItemsInputParam[];
+      item_tiers?: ItemTiersCreateForItemsInputParam[];
     }
     export interface ListInputParam {
       limit?: number;
@@ -286,6 +288,17 @@ declare module 'chargebee' {
       item_price_id?: string;
       quantity?: number;
       quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+    }
+    export interface ItemTiersCreateForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
     }
     export interface GifterGiftListInputParam {
       customer_id?: filter.String;

package/types/resources/HostedPage.d.ts

@@ -435,6 +435,7 @@ declare module 'chargebee' {
       coupon_ids?: string[];
       gifter?: GifterCheckoutGiftForItemsInputParam;
       subscription_items?: SubscriptionItemsCheckoutGiftForItemsInputParam[];
+      item_tiers?: ItemTiersCheckoutGiftForItemsInputParam[];
     }
     export interface ClaimGiftInputParam {
       redirect_url?: string;
@@ -1105,6 +1106,17 @@ declare module 'chargebee' {
       item_price_id?: string;
       quantity?: number;
       quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+    }
+    export interface ItemTiersCheckoutGiftForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
     }
     export interface GiftClaimGiftInputParam {
       id: string;

package/types/resources/Invoice.d.ts

@@ -42,6 +42,7 @@ declare module 'chargebee' {
     voided_at?: number;
     resource_version?: number;
     updated_at?: number;
+    line_items_next_offset?: string;
     first_invoice?: boolean;
     new_sales_amount?: number;
     has_advance_charges?: boolean;
@@ -1062,6 +1063,8 @@ declare module 'chargebee' {
       offset?: string;
     }
     export interface RetrieveInputParam {
+      line_items_limit?: number;
+      line_items_offset?: string;
       line_item?: LineItemRetrieveInputParam;
     }
     export interface PdfInputParam {

package/types/resources/ItemPrice.d.ts

@@ -91,6 +91,12 @@ declare module 'chargebee' {
         input?: FindApplicableItemPricesInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<FindApplicableItemPricesResponse>>;
+
+      moveItemPrice(
+        item_price_id: string,
+        input: MoveItemPriceInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<MoveItemPriceResponse>>;
     }
 
     export interface CreateResponse {
@@ -124,6 +130,10 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface MoveItemPriceResponse {
+      item_price: ItemPrice;
+    }
+
     export interface Tier {
       starting_unit: number;
       ending_unit?: number;
@@ -269,6 +279,9 @@ declare module 'chargebee' {
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }
+    export interface MoveItemPriceInputParam {
+      destination_item_id: string;
+    }
     export interface TaxDetailCreateInputParam {
       tax_profile_id?: string;
       avalara_tax_code?: string;

package/types/resources/PricingPageSession.d.ts

@@ -36,6 +36,7 @@ declare module 'chargebee' {
     export interface CreateForNewSubscriptionInputParam {
       redirect_url?: string;
       business_entity_id?: string;
+      auto_select_local_currency?: boolean;
       pricing_page?: PricingPageCreateForNewSubscriptionInputParam;
       subscription?: SubscriptionCreateForNewSubscriptionInputParam;
       customer?: CustomerCreateForNewSubscriptionInputParam;

package/types/resources/QuotedDeltaRamp.d.ts

@@ -0,0 +1,16 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface QuotedDeltaRamp {
+    line_items?: QuotedDeltaRamp.LineItem[];
+  }
+
+  export namespace QuotedDeltaRamp {
+    export interface LineItem {
+      item_level_discount_per_billing_cycle_in_decimal?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/SalesOrder.d.ts

@@ -27,6 +27,7 @@ declare module 'chargebee' {
     billing_configuration?: SalesOrder.BillingConfiguration;
     renewal_term?: SalesOrder.RenewalTerm;
     status: 'active' | 'completed';
+    credit_lines?: SalesOrder.CreditLine[];
   }
 
   export namespace SalesOrder {
@@ -37,6 +38,9 @@ declare module 'chargebee' {
       name?: string;
       quantity: string;
       unit_price: string;
+      billable_unit_price?: string;
+      billable_quantity?: string;
+      billable_amount?: string;
       billing_period?: number;
       billing_period_unit?: 'day' | 'week' | 'month' | 'year';
       service_period_days?: number;
@@ -137,6 +141,11 @@ declare module 'chargebee' {
       cancellation_cutoff_period?: number;
       renewal_billing_cycles?: number;
     }
+    export interface CreditLine {
+      amount: string;
+      unit_price: string;
+      line_item_association_id?: string;
+    }
     // REQUEST PARAMS
     //---------------
   }