chargebee 3.13.0 → 3.15.0

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,25 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
-    export interface LineItemTier {
+    export interface Discount {
+      amount: number;
+      description?: string;
       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;
+      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 +437,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface BillingAddress {
       first_name?: string;
@@ -1118,6 +1118,7 @@ declare module 'chargebee' {
        */
       setup_fee?: number;
       start_date?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -1216,6 +1217,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,26 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
+    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';
+      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/Ramp.d.ts

@@ -19,6 +19,7 @@ declare module 'chargebee' {
     items_to_remove?: string[];
     coupons_to_remove?: string[];
     discounts_to_remove?: string[];
+    contract_term?: Ramp.ContractTerm;
     deleted: boolean;
     status_transition_reason?: Ramp.StatusTransitionReason;
   }
@@ -88,6 +89,13 @@ declare module 'chargebee' {
       billing_cycles?: number;
       service_period_days?: number;
       metered_quantity?: string;
+      charge_once?: boolean;
+      charge_on_option?: 'immediately' | 'on_event';
+      charge_on_event?:
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
     }
     export interface ItemsToUpdate {
       item_price_id: string;
@@ -103,6 +111,13 @@ declare module 'chargebee' {
       billing_cycles?: number;
       service_period_days?: number;
       metered_quantity?: string;
+      charge_once?: boolean;
+      charge_on_option?: 'immediately' | 'on_event';
+      charge_on_event?:
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
     }
     export interface CouponsToAdd {
       coupon_id: string;
@@ -134,6 +149,11 @@ declare module 'chargebee' {
       package_size?: number;
       index: number;
     }
+    export interface ContractTerm {
+      cancellation_cutoff_period?: number;
+      renewal_billing_cycles?: number;
+      action_at_term_end: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+    }
     export interface StatusTransitionReason {
       code?: string;
       message?: string;
@@ -147,6 +167,7 @@ declare module 'chargebee' {
       coupons_to_remove?: string[];
       discounts_to_remove?: string[];
       items_to_remove?: string[];
+      contract_term?: ContractTermCreateForSubscriptionInputParam;
       items_to_add?: ItemsToAddCreateForSubscriptionInputParam[];
       items_to_update?: ItemsToUpdateCreateForSubscriptionInputParam[];
       item_tiers?: ItemTiersCreateForSubscriptionInputParam[];
@@ -159,6 +180,7 @@ declare module 'chargebee' {
       coupons_to_remove?: string[];
       discounts_to_remove?: string[];
       items_to_remove?: string[];
+      contract_term?: ContractTermUpdateInputParam;
       items_to_add?: ItemsToAddUpdateInputParam[];
       items_to_update?: ItemsToUpdateUpdateInputParam[];
       item_tiers?: ItemTiersUpdateInputParam[];
@@ -176,6 +198,12 @@ declare module 'chargebee' {
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }
+    export interface ContractTermCreateForSubscriptionInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+      renewal_billing_cycles?: number;
+    }
+
     export interface ItemsToAddCreateForSubscriptionInputParam {
       item_price_id: string;
       quantity?: number;
@@ -184,6 +212,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface CouponsToAddCreateForSubscriptionInputParam {
       coupon_id?: string;
@@ -208,6 +239,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsToAddCreateForSubscriptionInputParam {
       apply_on: ApplyOnEnum;
@@ -219,6 +253,12 @@ declare module 'chargebee' {
       included_in_mrr?: boolean;
       item_price_id?: string;
     }
+    export interface ContractTermUpdateInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+      renewal_billing_cycles?: number;
+    }
+
     export interface ItemsToAddUpdateInputParam {
       item_price_id: string;
       quantity?: number;
@@ -227,6 +267,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface CouponsToAddUpdateInputParam {
       coupon_id?: string;
@@ -251,6 +294,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsToAddUpdateInputParam {
       apply_on: ApplyOnEnum;

package/types/resources/SalesOrder.d.ts

@@ -15,6 +15,7 @@ declare module 'chargebee' {
     end_date?: number;
     business_entity_id?: string;
     customer_id: string;
+    subscription_id: string;
     currency_code: string;
     line_items?: SalesOrder.LineItem[];
     billing_addresses?: SalesOrder.BillingAddress[];
@@ -75,7 +76,7 @@ declare module 'chargebee' {
     export interface Discount {
       id: string;
       invoice_name?: string;
-      type: 'fixed_amount' | 'percentage';
+      type: 'fixed_amount' | 'percentage' | 'offer_quantity';
       apply_on: 'invoice_amount' | 'specific_item_price';
       duration_type: 'one_time' | 'forever' | 'limited_period';
       percentage?: number;
@@ -106,7 +107,6 @@ declare module 'chargebee' {
         | 'valid'
         | 'partially_valid'
         | 'invalid';
-      index: number;
     }
     export interface LineItemTier {
       starting_unit: string;

package/types/resources/Subscription.d.ts

@@ -650,7 +650,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface ReferralInfo {
       referral_code?: string;
@@ -825,6 +824,7 @@ declare module 'chargebee' {
       auto_collection?: AutoCollectionEnum;
       terms_to_charge?: number;
       billing_alignment_mode?: BillingAlignmentModeEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       po_number?: string;
       coupon_ids?: string[];
       payment_source_id?: string;

package/types/resources/SubscriptionEntitlement.d.ts

@@ -43,7 +43,7 @@ declare module 'chargebee' {
     }
 
     export interface SetSubscriptionEntitlementAvailabilityResponse {
-      subscription_entitlement: SubscriptionEntitlement;
+      list: { subscription_entitlement: SubscriptionEntitlement }[];
     }
 
     export interface Component {

package/types/resources/SubscriptionEstimate.d.ts

@@ -37,7 +37,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface ContractTerm {
       id: string;

package/types/resources/Transaction.d.ts

@@ -29,7 +29,10 @@ declare module 'chargebee' {
     fraud_flag?: 'safe' | 'suspicious' | 'fraudulent';
     initiator_type?: 'customer' | 'merchant';
     three_d_secure?: boolean;
-    authorization_reason?: 'blocking_funds' | 'verification';
+    authorization_reason?:
+      | 'blocking_funds'
+      | 'verification'
+      | 'scheduled_capture';
     error_code?: string;
     error_text?: string;
     voided_at?: number;
@@ -249,6 +252,7 @@ declare module 'chargebee' {
       processor_error_code?: string;
       processor_error_message?: string;
       error_cause_id?: string;
+      processor_advice_code?: string;
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/UsageFile.d.ts

@@ -17,6 +17,8 @@ declare module 'chargebee' {
     processing_completed_at?: number;
     uploaded_by?: string;
     uploaded_at?: number;
+    error_file_path?: string;
+    error_file_url?: string;
     upload_details?: UsageFile.UploadDetail;
   }
 

package/types/resources/WebhookEvent.d.ts

@@ -31,6 +31,7 @@ declare module 'chargebee' {
     CustomerDeleted = 'customer_deleted',
     RefundInitiated = 'refund_initiated',
     InvoiceGeneratedWithBackdating = 'invoice_generated_with_backdating',
+    OmnichannelTransactionCreated = 'omnichannel_transaction_created',
     AddUsagesReminder = 'add_usages_reminder',
     VoucherCreated = 'voucher_created',
     RuleUpdated = 'rule_updated',
@@ -57,6 +58,7 @@ declare module 'chargebee' {
     SubscriptionAdvanceInvoiceScheduleUpdated = 'subscription_advance_invoice_schedule_updated',
     ItemDeleted = 'item_deleted',
     SubscriptionRampDrafted = 'subscription_ramp_drafted',
+    DunningUpdated = 'dunning_updated',
     ItemEntitlementsUpdated = 'item_entitlements_updated',
     TokenConsumed = 'token_consumed',
     HierarchyDeleted = 'hierarchy_deleted',
@@ -150,6 +152,7 @@ declare module 'chargebee' {
     SubscriptionScheduledCancellationRemoved = 'subscription_scheduled_cancellation_removed',
     PaymentRefunded = 'payment_refunded',
     UsageFileIngested = 'usage_file_ingested',
+    OmnichannelSubscriptionMovedIn = 'omnichannel_subscription_moved_in',
     DifferentialPriceCreated = 'differential_price_created',
     TransactionCreated = 'transaction_created',
     PaymentSucceeded = 'payment_succeeded',
@@ -240,6 +243,7 @@ declare module 'chargebee' {
     [WebhookContentType.CustomerDeleted]: CustomerDeletedContent;
     [WebhookContentType.RefundInitiated]: RefundInitiatedContent;
     [WebhookContentType.InvoiceGeneratedWithBackdating]: InvoiceGeneratedWithBackdatingContent;
+    [WebhookContentType.OmnichannelTransactionCreated]: OmnichannelTransactionCreatedContent;
     [WebhookContentType.AddUsagesReminder]: AddUsagesReminderContent;
     [WebhookContentType.VoucherCreated]: VoucherCreatedContent;
     [WebhookContentType.RuleUpdated]: RuleUpdatedContent;
@@ -266,6 +270,7 @@ declare module 'chargebee' {
     [WebhookContentType.SubscriptionAdvanceInvoiceScheduleUpdated]: SubscriptionAdvanceInvoiceScheduleUpdatedContent;
     [WebhookContentType.ItemDeleted]: ItemDeletedContent;
     [WebhookContentType.SubscriptionRampDrafted]: SubscriptionRampDraftedContent;
+    [WebhookContentType.DunningUpdated]: DunningUpdatedContent;
     [WebhookContentType.ItemEntitlementsUpdated]: ItemEntitlementsUpdatedContent;
     [WebhookContentType.TokenConsumed]: TokenConsumedContent;
     [WebhookContentType.HierarchyDeleted]: HierarchyDeletedContent;
@@ -359,6 +364,7 @@ declare module 'chargebee' {
     [WebhookContentType.SubscriptionScheduledCancellationRemoved]: SubscriptionScheduledCancellationRemovedContent;
     [WebhookContentType.PaymentRefunded]: PaymentRefundedContent;
     [WebhookContentType.UsageFileIngested]: UsageFileIngestedContent;
+    [WebhookContentType.OmnichannelSubscriptionMovedIn]: OmnichannelSubscriptionMovedInContent;
     [WebhookContentType.DifferentialPriceCreated]: DifferentialPriceCreatedContent;
     [WebhookContentType.TransactionCreated]: TransactionCreatedContent;
     [WebhookContentType.PaymentSucceeded]: PaymentSucceededContent;
@@ -629,6 +635,9 @@ declare module 'chargebee' {
   export type InvoiceGeneratedWithBackdatingContent = {
     invoice: Invoice;
   };
+  export type OmnichannelTransactionCreatedContent = {
+    omnichannel_transaction: OmnichannelTransaction;
+  };
   export type AddUsagesReminderContent = {
     subscription: Subscription;
 
@@ -753,6 +762,9 @@ declare module 'chargebee' {
   export type SubscriptionRampDraftedContent = {
     ramp: Ramp;
   };
+  export type DunningUpdatedContent = {
+    invoice: Invoice;
+  };
   export type ItemEntitlementsUpdatedContent = {
     feature: Feature;
 
@@ -1288,6 +1300,11 @@ declare module 'chargebee' {
   export type UsageFileIngestedContent = {
     usage_file: UsageFile;
   };
+  export type OmnichannelSubscriptionMovedInContent = {
+    omnichannel_subscription: OmnichannelSubscription;
+
+    customer: Customer;
+  };
   export type DifferentialPriceCreatedContent = {
     differential_price: DifferentialPrice;
   };

package/cjs/net/NodeClient.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeHttpClientResponse = exports.NodeHttpClient = void 0;
-const ClientInterface_js_1 = require("./ClientInterface.js");
-const http = require("http");
-const https = require("https");
-class NodeHttpClient extends ClientInterface_js_1.HttpClient {
-    async makeApiRequest(props) {
-        const protocol = props.protocol === 'http' ? http : https;
-        const requestPromise = new Promise((resolve, reject) => {
-            const req = protocol.request({
-                hostname: props.host,
-                path: props.path,
-                method: props.method,
-                port: props.port,
-                headers: props.headers,
-            });
-            req.setTimeout(props.timeout, () => {
-                throw ClientInterface_js_1.HttpClient.timeOutError();
-            });
-            req.on('response', (res) => {
-                resolve(new NodeHttpClientResponse(res));
-            });
-            req.on('error', (error) => {
-                reject(error);
-            });
-            req.write(props.data);
-            req.end();
-        });
-        return requestPromise;
-    }
-}
-exports.NodeHttpClient = NodeHttpClient;
-class NodeHttpClientResponse extends ClientInterface_js_1.HttpClientResponse {
-    constructor(res) {
-        //@ts-ignore
-        super(res.statusCode, res.headers);
-        this._res = res;
-    }
-    getRawResponse() {
-        return this._res;
-    }
-    toJson() {
-        return new Promise((resolve, reject) => {
-            let response = '';
-            this._res.setEncoding('utf8');
-            this._res.on('data', (chunk) => {
-                response += chunk;
-            });
-            this._res.once('end', () => {
-                try {
-                    resolve(JSON.parse(response));
-                }
-                catch (e) {
-                    reject(e);
-                }
-            });
-        });
-    }
-}
-exports.NodeHttpClientResponse = NodeHttpClientResponse;

package/esm/net/NodeClient.js

@@ -1,56 +0,0 @@
-import { HttpClient, HttpClientResponse, } from './ClientInterface.js';
-import * as http from 'http';
-import * as https from 'https';
-export class NodeHttpClient extends HttpClient {
-    async makeApiRequest(props) {
-        const protocol = props.protocol === 'http' ? http : https;
-        const requestPromise = new Promise((resolve, reject) => {
-            const req = protocol.request({
-                hostname: props.host,
-                path: props.path,
-                method: props.method,
-                port: props.port,
-                headers: props.headers,
-            });
-            req.setTimeout(props.timeout, () => {
-                throw HttpClient.timeOutError();
-            });
-            req.on('response', (res) => {
-                resolve(new NodeHttpClientResponse(res));
-            });
-            req.on('error', (error) => {
-                reject(error);
-            });
-            req.write(props.data);
-            req.end();
-        });
-        return requestPromise;
-    }
-}
-export class NodeHttpClientResponse extends HttpClientResponse {
-    constructor(res) {
-        //@ts-ignore
-        super(res.statusCode, res.headers);
-        this._res = res;
-    }
-    getRawResponse() {
-        return this._res;
-    }
-    toJson() {
-        return new Promise((resolve, reject) => {
-            let response = '';
-            this._res.setEncoding('utf8');
-            this._res.on('data', (chunk) => {
-                response += chunk;
-            });
-            this._res.once('end', () => {
-                try {
-                    resolve(JSON.parse(response));
-                }
-                catch (e) {
-                    reject(e);
-                }
-            });
-        });
-    }
-}