chargebee 3.2.1 → 3.3.0

package/CHANGELOG.md

@@ -1,3 +1,43 @@
+### v3.3.0 (2024-12-19)
+* * * 
+
+#### New Resource: 
+* Configuration has been added. 
+
+#### New Attribute:
+* discount_type has been added to CreditNote#Discount.
+* discount_type has been added to CreditNoteEstimate#Discount.
+* discount_type has been added to Invoice#Discount.
+* discount_type has been added to InvoiceEstimate#Discount.
+* discount_type has been added to QuoteLineGroup#Discount.
+* initial_purchase_transaction has been added to OmnichannelSubscription.
+* error_cause_id has been added to GatewayErrorDetail.
+* error_cause_id has been added to Transaction#GatewayErrorDetail.
+* error_cause_id has been added to APIError.
+* deleted has been added to Quote. 
+* current_term_start has been added to QuotedSubscripiton#SubscriptionItem.
+* current_term_end has been added to QuotedSubscripiton#SubscriptionItem.
+* next_billing_at has been added to QuotedSubscripiton#SubscriptionItem.
+* current_term_start has been added to Subscription#SubscriptionItem.
+* current_term_end has been added to Subscription#SubscriptionItem.
+* next_billing_at has been added to Subscription#SubscriptionItem.
+* billing_override has been added to Subscription. 
+* grace_period_expires_at has been added to OmnichannelSubscriptionItem.
+
+#### New Input Params:
+* billing_override has been added to Subscription#CreateWithItemsInputParam.
+* billing_override has been added to Subscription#UpdateForItemsInputParam.
+
+#### New Enum Values:
+* OMNICHANNEL_SUBSCRIPTION_IMPORTED has been added to EventTypeEnum.
+* DISABLED has been added to Event#WebhookStatus.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_STARTED has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_EXPIRED has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_STARTED has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_EXPIRED has been added to EventTypeEnum. 
+* IGNORED has been added to RecordedPurchase#StatusEnum.
+* IN_DUNNING & IN_GRACE_PERIOD have been added to OmnichannelSubscriptionItem#StatusEnum.
+
 ### v3.2.1 (2024-12-04)
 * * *
 

package/cjs/environment.js

@@ -11,7 +11,7 @@ exports.Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.2.1',
+    clientVersion: 'v3.3.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/cjs/resources/api_endpoints.js

@@ -930,6 +930,7 @@ exports.Endpoints = {
         ['delete', 'POST', '/differential_prices', '/delete', true],
         ['list', 'GET', '/differential_prices', null, false],
     ],
+    configuration: [['list', 'GET', '/configurations', null, false]],
     feature: [
         ['list', 'GET', '/features', null, false],
         ['create', 'POST', '/features', null, false],

package/esm/environment.js

@@ -8,7 +8,7 @@ export const Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.2.1',
+    clientVersion: 'v3.3.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/esm/resources/api_endpoints.js

@@ -927,6 +927,7 @@ export const Endpoints = {
         ['delete', 'POST', '/differential_prices', '/delete', true],
         ['list', 'GET', '/differential_prices', null, false],
     ],
+    configuration: [['list', 'GET', '/configurations', null, false]],
     feature: [
         ['list', 'GET', '/features', null, false],
         ['create', 'POST', '/features', null, false],

package/package.json

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

package/types/core.d.ts

@@ -324,6 +324,11 @@ declare module 'chargebee' {
     | 'omnichannel_subscription_item_resubscribed'
     | 'omnichannel_subscription_item_upgraded'
     | 'omnichannel_subscription_item_cancelled'
+    | 'omnichannel_subscription_imported'
+    | 'omnichannel_subscription_item_grace_period_started'
+    | 'omnichannel_subscription_item_grace_period_expired'
+    | 'omnichannel_subscription_item_dunning_started'
+    | 'omnichannel_subscription_item_dunning_expired'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -492,6 +497,7 @@ declare module 'chargebee' {
     | 'tiered'
     | 'volume'
     | 'stairstep';
+  type ProductCatalogVersionEnum = 'v1' | 'v2';
   type ProrationTypeEnum = 'full_term' | 'partial_term' | 'none';
   type ReferralSystemEnum =
     | 'referral_candy'

package/types/index.d.ts

@@ -6,6 +6,7 @@
 ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
 ///<reference path='./resources/Card.d.ts' />
 ///<reference path='./resources/Comment.d.ts' />
+///<reference path='./resources/Configuration.d.ts' />
 ///<reference path='./resources/Contact.d.ts' />
 ///<reference path='./resources/ContractTerm.d.ts' />
 ///<reference path='./resources/Coupon.d.ts' />
@@ -123,6 +124,7 @@ declare module 'chargebee' {
     businessEntity: BusinessEntity.BusinessEntityResource;
     card: Card.CardResource;
     comment: Comment.CommentResource;
+    configuration: Configuration.ConfigurationResource;
     coupon: Coupon.CouponResource;
     couponCode: CouponCode.CouponCodeResource;
     couponSet: CouponSet.CouponSetResource;

package/types/resources/Configuration.d.ts

@@ -0,0 +1,24 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Configuration {
+    domain?: string;
+    product_catalog_version?: ProductCatalogVersionEnum;
+  }
+
+  export namespace Configuration {
+    export class ConfigurationResource {
+      list(
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface ListResponse {
+      configurations: Configuration[];
+    }
+
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/CreditNote.d.ts

@@ -274,6 +274,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/CreditNoteEstimate.d.ts

@@ -80,6 +80,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/Event.d.ts

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

package/types/resources/GatewayErrorDetail.d.ts

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

package/types/resources/Invoice.d.ts

@@ -519,6 +519,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/InvoiceEstimate.d.ts

@@ -80,6 +80,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/OmnichannelSubscription.d.ts

@@ -11,6 +11,7 @@ declare module 'chargebee' {
     created_at: number;
     resource_version?: number;
     omnichannel_subscription_items: OmnichannelSubscriptionItem[];
+    initial_purchase_transaction?: OmnichannelSubscription.OmnichannelTransaction;
   }
 
   export namespace OmnichannelSubscription {
@@ -48,6 +49,18 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface OmnichannelTransaction {
+      id: string;
+      id_at_source: string;
+      app_id: string;
+      price_currency: string;
+      price_units: number;
+      price_nanos: number;
+      type: 'purchase' | 'renewal';
+      transacted_at: number;
+      created_at: number;
+      resource_version?: number;
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -5,7 +5,12 @@ declare module 'chargebee' {
   export interface OmnichannelSubscriptionItem {
     id: string;
     item_id_at_source: string;
-    status: 'active' | 'expired' | 'cancelled';
+    status:
+      | 'active'
+      | 'expired'
+      | 'cancelled'
+      | 'in_dunning'
+      | 'in_grace_period';
     current_term_start?: number;
     current_term_end?: number;
     expired_at?: number;
@@ -14,6 +19,7 @@ declare module 'chargebee' {
     cancellation_reason?:
       | 'customer_cancelled'
       | 'customer_did_not_consent_to_price_increase';
+    grace_period_expires_at?: number;
     resource_version?: number;
   }
 }

package/types/resources/Quote.d.ts

@@ -44,6 +44,7 @@ declare module 'chargebee' {
     contract_term_end?: number;
     contract_term_termination_fee?: number;
     business_entity_id?: string;
+    deleted: boolean;
   }
 
   export namespace Quote {
@@ -332,6 +333,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/QuoteLineGroup.d.ts

@@ -84,6 +84,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/QuotedSubscription.d.ts

@@ -69,6 +69,9 @@ declare module 'chargebee' {
       unit_price?: number;
       unit_price_in_decimal?: string;
       amount?: number;
+      current_term_start?: number;
+      current_term_end?: number;
+      next_billing_at?: number;
       amount_in_decimal?: string;
       billing_period?: number;
       billing_period_unit?: 'day' | 'week' | 'month' | 'year';

package/types/resources/RecordedPurchase.d.ts

@@ -7,7 +7,7 @@ declare module 'chargebee' {
     customer_id: string;
     app_id: string;
     source: 'apple_app_store';
-    status: 'in_process' | 'completed' | 'failed';
+    status: 'in_process' | 'completed' | 'failed' | 'ignored';
     omnichannel_transaction_id?: string;
     created_at: number;
     resource_version?: number;

package/types/resources/Subscription.d.ts

@@ -83,6 +83,7 @@ declare module 'chargebee' {
     coupons?: Subscription.Coupon[];
     shipping_address?: Subscription.ShippingAddress;
     referral_info?: Subscription.ReferralInfo;
+    billing_override?: Subscription.BillingOverride;
     invoice_notes?: string;
     meta_data?: any;
     deleted: boolean;
@@ -557,6 +558,9 @@ declare module 'chargebee' {
       unit_price?: number;
       unit_price_in_decimal?: string;
       amount?: number;
+      current_term_start?: number;
+      current_term_end?: number;
+      next_billing_at?: number;
       amount_in_decimal?: string;
       billing_period?: number;
       billing_period_unit?: 'day' | 'week' | 'month' | 'year';
@@ -662,6 +666,10 @@ declare module 'chargebee' {
       destination_url?: string;
       post_purchase_widget_enabled: boolean;
     }
+    export interface BillingOverride {
+      max_excess_payment_usage?: number;
+      max_refundable_credits_usage?: number;
+    }
     export interface ContractTerm {
       id: string;
       status: 'active' | 'completed' | 'cancelled' | 'terminated';
@@ -835,6 +843,7 @@ declare module 'chargebee' {
       statement_descriptor?: StatementDescriptorCreateWithItemsInputParam;
       payment_intent?: PaymentIntentCreateWithItemsInputParam;
       contract_term?: ContractTermCreateWithItemsInputParam;
+      billing_override?: BillingOverrideCreateWithItemsInputParam;
       subscription_items?: SubscriptionItemsCreateWithItemsInputParam[];
       discounts?: DiscountsCreateWithItemsInputParam[];
       item_tiers?: ItemTiersCreateWithItemsInputParam[];
@@ -991,6 +1000,7 @@ declare module 'chargebee' {
       statement_descriptor?: StatementDescriptorUpdateForItemsInputParam;
       customer?: CustomerUpdateForItemsInputParam;
       contract_term?: ContractTermUpdateForItemsInputParam;
+      billing_override?: BillingOverrideUpdateForItemsInputParam;
       subscription_items?: SubscriptionItemsUpdateForItemsInputParam[];
       discounts?: DiscountsUpdateForItemsInputParam[];
       item_tiers?: ItemTiersUpdateForItemsInputParam[];
@@ -1548,6 +1558,10 @@ declare module 'chargebee' {
       billing_cycles?: number;
       trial_end?: number;
     }
+    export interface BillingOverrideCreateWithItemsInputParam {
+      max_excess_payment_usage?: number;
+      max_refundable_credits_usage?: number;
+    }
     export interface StatementDescriptorCreateWithItemsInputParam {
       descriptor?: string;
     }
@@ -1810,6 +1824,10 @@ declare module 'chargebee' {
       trial_end?: number;
       proration_type?: ProrationTypeEnum;
     }
+    export interface BillingOverrideUpdateForItemsInputParam {
+      max_excess_payment_usage?: number;
+      max_refundable_credits_usage?: number;
+    }
     export interface BillingAddressUpdateForItemsInputParam {
       first_name?: string;
       last_name?: string;

package/types/resources/Transaction.d.ts

@@ -248,6 +248,7 @@ declare module 'chargebee' {
       recommendation_message?: string;
       processor_error_code?: string;
       processor_error_message?: string;
+      error_cause_id?: string;
     }
     // REQUEST PARAMS
     //---------------