chargebee 3.1.0 → 3.2.0

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+### v3.2.0 (2024-11-27)
+* * *
+#### New Resource: 
+* OmnichannelSubscriptionItem has been added. 
+
+#### New Attribute: 
+* resource_version has been added to OmnichannelSubscription.
+* resource_version has been added to OmnichannelTransaction.
+* resource_version has been added to RecordedPurchase.
+
+#### New Input Parameters:
+* limit has been added to OmnichannelSubscription#ListRequest.
+* offset has been added to OmnichannelSubscription#ListRequest.
+* customer_id has been added to OmnichannelSubscription#ListRequest.
+* replace_coupon_list has been added to HostedPage#CheckoutExistingRequest.
+* replace_coupon_list has been added to HostedPage#CheckoutExistingForItemsRequest.
+* subscription[po_number] has been added to HostedPage#CheckoutNewForItemsRequest.
+
+#### Removed Subresource: 
+* OmnichannelSubscriptionItem subresource has been removed from OmnichannelSubscription and is now a standalone resource.
+
+#### Removed Attribute: 
+* metadata has been removed from subscription. 
+
 ### v3.1.0 (2024-11-14)
 * * *
 

package/cjs/environment.js

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

package/cjs/resources/api_endpoints.js

@@ -1108,6 +1108,7 @@ exports.Endpoints = {
         ],
     ],
     omnichannelTransaction: [],
+    omnichannelSubscriptionItem: [],
     recordedPurchase: [
         ['create', 'POST', '/recorded_purchases', null, false],
         ['retrieve', 'GET', '/recorded_purchases', null, true],

package/esm/environment.js

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

package/esm/resources/api_endpoints.js

@@ -1105,6 +1105,7 @@ export const Endpoints = {
         ],
     ],
     omnichannelTransaction: [],
+    omnichannelSubscriptionItem: [],
     recordedPurchase: [
         ['create', 'POST', '/recorded_purchases', null, false],
         ['retrieve', 'GET', '/recorded_purchases', null, true],

package/package.json

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

package/types/index.d.ts

@@ -42,6 +42,7 @@
 ///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
 ///<reference path='./resources/OmnichannelSubscription.d.ts' />
+///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
 ///<reference path='./resources/OmnichannelTransaction.d.ts' />
 ///<reference path='./resources/Order.d.ts' />
 ///<reference path='./resources/PaymentIntent.d.ts' />

package/types/resources/HostedPage.d.ts

@@ -337,6 +337,7 @@ declare module 'chargebee' {
       reactivate_from?: number;
       billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
+      replace_coupon_list?: boolean;
       reactivate?: boolean;
       force_term_reset?: boolean;
       redirect_url?: string;
@@ -362,6 +363,7 @@ declare module 'chargebee' {
       reactivate_from?: number;
       billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
+      replace_coupon_list?: boolean;
       reactivate?: boolean;
       force_term_reset?: boolean;
       change_option?: ChangeOptionEnum;
@@ -808,6 +810,7 @@ declare module 'chargebee' {
       coupon?: string;
       auto_collection?: AutoCollectionEnum;
       invoice_notes?: string;
+      po_number?: string;
       contract_term_billing_cycle_on_renewal?: number;
     }
     export interface CardCheckoutNewForItemsInputParam {

package/types/resources/OmnichannelSubscription.d.ts

@@ -9,7 +9,8 @@ declare module 'chargebee' {
     source: 'apple_app_store';
     customer_id?: string;
     created_at: number;
-    omnichannel_subscription_items: OmnichannelSubscription.OmnichannelSubscriptionItem[];
+    resource_version?: number;
+    omnichannel_subscription_items: OmnichannelSubscriptionItem[];
   }
 
   export namespace OmnichannelSubscription {
@@ -47,25 +48,13 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
-    export interface OmnichannelSubscriptionItem {
-      id: string;
-      id_at_source: string;
-      status: 'active' | 'expired' | 'cancelled';
-      current_term_start?: number;
-      current_term_end?: number;
-      expired_at?: number;
-      expiration_reason?: 'billing_error' | 'product_not_available' | 'other';
-      cancelled_at?: number;
-      cancellation_reason?:
-        | 'customer_cancelled'
-        | 'customer_did_not_consent_to_price_increase';
-    }
     // REQUEST PARAMS
     //---------------
 
     export interface ListInputParam {
       limit?: number;
       offset?: string;
+      customer_id?: filter.String;
     }
     export interface OmnichannelTransactionsForOmnichannelSubscriptionInputParam {
       limit?: number;

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -0,0 +1,19 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OmnichannelSubscriptionItem {
+    id: string;
+    item_id_at_source: string;
+    status: 'active' | 'expired' | 'cancelled';
+    current_term_start?: number;
+    current_term_end?: number;
+    expired_at?: number;
+    expiration_reason?: 'billing_error' | 'product_not_available' | 'other';
+    cancelled_at?: number;
+    cancellation_reason?:
+      | 'customer_cancelled'
+      | 'customer_did_not_consent_to_price_increase';
+    resource_version?: number;
+  }
+}

package/types/resources/OmnichannelTransaction.d.ts

@@ -12,5 +12,6 @@ declare module 'chargebee' {
     type: 'purchase' | 'renewal';
     transacted_at: number;
     created_at: number;
+    resource_version?: number;
   }
 }

package/types/resources/RecordedPurchase.d.ts

@@ -10,6 +10,7 @@ declare module 'chargebee' {
     status: 'in_process' | 'completed' | 'failed';
     omnichannel_transaction_id?: string;
     created_at: number;
+    resource_version?: number;
     linked_omnichannel_subscriptions?: RecordedPurchase.LinkedOmnichannelSubscription[];
     error_detail?: RecordedPurchase.ErrorDetail;
   }

package/types/resources/Subscription.d.ts

@@ -85,7 +85,6 @@ declare module 'chargebee' {
     referral_info?: Subscription.ReferralInfo;
     invoice_notes?: string;
     meta_data?: any;
-    metadata?: any;
     deleted: boolean;
     changes_scheduled_at?: number;
     contract_term?: Subscription.ContractTerm;