chargebee 3.1.0 → 3.2.1

package/CHANGELOG.md

@@ -1,3 +1,34 @@
+### v3.2.1 (2024-12-04)
+* * *
+
+#### Bug Fixes
+* unable to access content of HostedPage & Event (#57).
+* uncaught promise in case of fetch failure (#58). 
+
+### 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/RequestWrapper.js

@@ -41,42 +41,47 @@ class RequestWrapper {
                     resolve(response);
                 }
             }
-            let path = (0, util_js_1.getApiURL)(env, this.apiCall.urlPrefix, this.apiCall.urlSuffix, urlIdParam);
-            if (typeof params === 'undefined' || params === null) {
-                params = {};
-            }
-            if (this.apiCall.httpMethod === 'GET') {
-                params = (0, util_js_1.serialize)(params);
-                let queryParam = this.apiCall.isListReq
-                    ? (0, util_js_1.encodeListParams)(params)
-                    : (0, util_js_1.encodeParams)(params);
-                path += '?' + queryParam;
-                params = {};
-            }
-            let data = (0, util_js_1.encodeParams)(params);
-            if (data.length) {
+            try {
+                let path = (0, util_js_1.getApiURL)(env, this.apiCall.urlPrefix, this.apiCall.urlSuffix, urlIdParam);
+                if (typeof params === 'undefined' || params === null) {
+                    params = {};
+                }
+                if (this.apiCall.httpMethod === 'GET') {
+                    params = (0, util_js_1.serialize)(params);
+                    let queryParam = this.apiCall.isListReq
+                        ? (0, util_js_1.encodeListParams)(params)
+                        : (0, util_js_1.encodeParams)(params);
+                    path += '?' + queryParam;
+                    params = {};
+                }
+                let data = (0, util_js_1.encodeParams)(params);
+                if (data.length) {
+                    (0, util_js_1.extend)(true, this.httpHeaders, {
+                        'Content-Length': data.length,
+                    });
+                }
                 (0, util_js_1.extend)(true, this.httpHeaders, {
-                    'Content-Length': data.length,
+                    Authorization: 'Basic ' + node_buffer_1.Buffer.from(env.apiKey + ':').toString('base64'),
+                    Accept: 'application/json',
+                    'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
+                    'User-Agent': 'Chargebee-NodeJs-Client ' + env.clientVersion,
+                    'Lang-Version': typeof process === 'undefined' ? '' : process.version,
+                });
+                const resp = await this.envArg.httpClient.makeApiRequest({
+                    host: (0, util_js_1.getHost)(env),
+                    port: env.port,
+                    path,
+                    method: this.apiCall.httpMethod,
+                    protocol: env.protocol,
+                    headers: this.httpHeaders,
+                    data: data,
+                    timeout: env.timeout,
                 });
+                (0, coreCommon_js_1.handleResponse)(callBackWrapper, resp);
+            }
+            catch (err) {
+                callBackWrapper(err, null);
             }
-            (0, util_js_1.extend)(true, this.httpHeaders, {
-                Authorization: 'Basic ' + node_buffer_1.Buffer.from(env.apiKey + ':').toString('base64'),
-                Accept: 'application/json',
-                'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
-                'User-Agent': 'Chargebee-NodeJs-Client ' + env.clientVersion,
-                'Lang-Version': typeof process === 'undefined' ? '' : process.version,
-            });
-            const resp = await this.envArg.httpClient.makeApiRequest({
-                host: (0, util_js_1.getHost)(env),
-                port: env.port,
-                path,
-                method: this.apiCall.httpMethod,
-                protocol: env.protocol,
-                headers: this.httpHeaders,
-                data: data,
-                timeout: env.timeout,
-            });
-            (0, coreCommon_js_1.handleResponse)(callBackWrapper, resp);
         });
         return (0, util_js_1.callbackifyPromise)(promise);
     }

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.1',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/cjs/net/FetchClient.js

@@ -11,10 +11,15 @@ class FetchHttpClient extends ClientInterface_js_1.HttpClient {
             headers: headers,
             body: props.data ? props.data : undefined,
         };
-        const response = globalThis.AbortController
-            ? await this.fetchWithAbortTimeout(url, fetchOptions, props.timeout)
-            : await this.fetchWithTimeout(url, fetchOptions, props.timeout);
-        return new FetchHttpClientResponse(response);
+        try {
+            const response = globalThis.AbortController
+                ? await this.fetchWithAbortTimeout(url, fetchOptions, props.timeout)
+                : await this.fetchWithTimeout(url, fetchOptions, props.timeout);
+            return new FetchHttpClientResponse(response);
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
     }
     _createHeaders(httpHeaders) {
         const headers = new Headers();
@@ -44,20 +49,22 @@ class FetchHttpClient extends ClientInterface_js_1.HttpClient {
             timeoutId = null;
             abort.abort(ClientInterface_js_1.HttpClient.timeOutError());
         }, timeout);
-        const fetchPromise = fetch(url, Object.assign(Object.assign({}, fetchOptions), { signal: abort.signal }));
-        fetchPromise.finally(() => {
-            if (timeoutId) {
-                clearTimeout(timeoutId);
-            }
-        });
-        return fetchPromise.catch((err) => {
+        try {
+            return await fetch(url, Object.assign(Object.assign({}, fetchOptions), { signal: abort.signal }));
+        }
+        catch (err) {
             if (err.name === 'AbortError') {
-                throw ClientInterface_js_1.HttpClient.timeOutError();
+                return Promise.reject(ClientInterface_js_1.HttpClient.timeOutError());
             }
             else {
-                throw err;
+                return Promise.reject(err);
             }
-        });
+        }
+        finally {
+            if (timeoutId) {
+                clearTimeout(timeoutId);
+            }
+        }
     }
 }
 exports.FetchHttpClient = FetchHttpClient;

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/RequestWrapper.js

@@ -38,42 +38,47 @@ export class RequestWrapper {
                     resolve(response);
                 }
             }
-            let path = getApiURL(env, this.apiCall.urlPrefix, this.apiCall.urlSuffix, urlIdParam);
-            if (typeof params === 'undefined' || params === null) {
-                params = {};
-            }
-            if (this.apiCall.httpMethod === 'GET') {
-                params = serialize(params);
-                let queryParam = this.apiCall.isListReq
-                    ? encodeListParams(params)
-                    : encodeParams(params);
-                path += '?' + queryParam;
-                params = {};
-            }
-            let data = encodeParams(params);
-            if (data.length) {
+            try {
+                let path = getApiURL(env, this.apiCall.urlPrefix, this.apiCall.urlSuffix, urlIdParam);
+                if (typeof params === 'undefined' || params === null) {
+                    params = {};
+                }
+                if (this.apiCall.httpMethod === 'GET') {
+                    params = serialize(params);
+                    let queryParam = this.apiCall.isListReq
+                        ? encodeListParams(params)
+                        : encodeParams(params);
+                    path += '?' + queryParam;
+                    params = {};
+                }
+                let data = encodeParams(params);
+                if (data.length) {
+                    extend(true, this.httpHeaders, {
+                        'Content-Length': data.length,
+                    });
+                }
                 extend(true, this.httpHeaders, {
-                    'Content-Length': data.length,
+                    Authorization: 'Basic ' + Buffer.from(env.apiKey + ':').toString('base64'),
+                    Accept: 'application/json',
+                    'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
+                    'User-Agent': 'Chargebee-NodeJs-Client ' + env.clientVersion,
+                    'Lang-Version': typeof process === 'undefined' ? '' : process.version,
+                });
+                const resp = await this.envArg.httpClient.makeApiRequest({
+                    host: getHost(env),
+                    port: env.port,
+                    path,
+                    method: this.apiCall.httpMethod,
+                    protocol: env.protocol,
+                    headers: this.httpHeaders,
+                    data: data,
+                    timeout: env.timeout,
                 });
+                handleResponse(callBackWrapper, resp);
+            }
+            catch (err) {
+                callBackWrapper(err, null);
             }
-            extend(true, this.httpHeaders, {
-                Authorization: 'Basic ' + Buffer.from(env.apiKey + ':').toString('base64'),
-                Accept: 'application/json',
-                'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
-                'User-Agent': 'Chargebee-NodeJs-Client ' + env.clientVersion,
-                'Lang-Version': typeof process === 'undefined' ? '' : process.version,
-            });
-            const resp = await this.envArg.httpClient.makeApiRequest({
-                host: getHost(env),
-                port: env.port,
-                path,
-                method: this.apiCall.httpMethod,
-                protocol: env.protocol,
-                headers: this.httpHeaders,
-                data: data,
-                timeout: env.timeout,
-            });
-            handleResponse(callBackWrapper, resp);
         });
         return callbackifyPromise(promise);
     }

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.1',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/esm/net/FetchClient.js

@@ -8,10 +8,15 @@ export class FetchHttpClient extends HttpClient {
             headers: headers,
             body: props.data ? props.data : undefined,
         };
-        const response = globalThis.AbortController
-            ? await this.fetchWithAbortTimeout(url, fetchOptions, props.timeout)
-            : await this.fetchWithTimeout(url, fetchOptions, props.timeout);
-        return new FetchHttpClientResponse(response);
+        try {
+            const response = globalThis.AbortController
+                ? await this.fetchWithAbortTimeout(url, fetchOptions, props.timeout)
+                : await this.fetchWithTimeout(url, fetchOptions, props.timeout);
+            return new FetchHttpClientResponse(response);
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
     }
     _createHeaders(httpHeaders) {
         const headers = new Headers();
@@ -41,20 +46,22 @@ export class FetchHttpClient extends HttpClient {
             timeoutId = null;
             abort.abort(HttpClient.timeOutError());
         }, timeout);
-        const fetchPromise = fetch(url, Object.assign(Object.assign({}, fetchOptions), { signal: abort.signal }));
-        fetchPromise.finally(() => {
-            if (timeoutId) {
-                clearTimeout(timeoutId);
-            }
-        });
-        return fetchPromise.catch((err) => {
+        try {
+            return await fetch(url, Object.assign(Object.assign({}, fetchOptions), { signal: abort.signal }));
+        }
+        catch (err) {
             if (err.name === 'AbortError') {
-                throw HttpClient.timeOutError();
+                return Promise.reject(HttpClient.timeOutError());
             }
             else {
-                throw err;
+                return Promise.reject(err);
             }
-        });
+        }
+        finally {
+            if (timeoutId) {
+                clearTimeout(timeoutId);
+            }
+        }
     }
 }
 export class FetchHttpClientResponse extends HttpClientResponse {

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.1",
   "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/Event.d.ts

@@ -19,6 +19,7 @@ declare module 'chargebee' {
     webhooks?: Event.Webhook[];
     event_type?: EventTypeEnum;
     api_version?: ApiVersionEnum;
+    content: any;
     origin_user?: string;
   }
 

package/types/resources/HostedPage.d.ts

@@ -28,6 +28,7 @@ declare module 'chargebee' {
     embed: boolean;
     created_at?: number;
     expires_at?: number;
+    content: any;
     updated_at?: number;
     resource_version?: number;
     checkout_info?: any;
@@ -337,6 +338,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 +364,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 +811,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;