chargebee 2.6.6 → 2.9.0

package/CHANGELOG.md

@@ -1,3 +1,98 @@
+### v2.9.0 (2022-01-21)
+* * *
+
+#### New endpoints:
+* credit_notes#download_einvoice has been added to the credit_notes resource.
+* invoice#download_einvoice has been added to the invoice resource.
+
+#### New attributes:
+* is_einvoice_enabled, entity_identifier_scheme, entity_identifier_standard and entity_identifiers[] have been added to the customer resource.
+* einvoice has been added to the invoice resource.
+* einvoice has been added to the credit_notes resource.
+* mime_type has been added to the download resource.
+
+#### New Input parameters:
+* entity_identifier_scheme, entity_identifier_standard, is_einvoice_enabled, entity_identifiers[id][0..N], entity_identifiers[scheme][0..N], entity_identifiers[value][0..N], entity_identifiers[standard][0..N] have been added to customers#create_a_customer, customers#update_billing_info_for_a_customer apis.
+* customer[entity_identifier_scheme], customer[entity_identifier_standard], customer[is_einvoice_enabled], entity_identifiers[id][0..N], entity_identifiers[scheme][0..N], entity_identifiers[value][0..N], entity_identifiers[standard][0..N] have been added to the subscriptions#create_a_subscription api.
+* customer[entity_identifier_scheme], customer[entity_identifier_standard], customer[is_einvoice_enabled] have been added to subscriptions#update_a_subscription and subscriptions#update_subscription_for_items apis.
+
+#### New Enum values:
+* operation enum has been added.
+* status enum has been added in credit_notes_einvoice subresource of credit_notes resource.
+
+#### Deprecated attributes:
+* user, type, payment_method and exchange_rate have been deprecated from TaxWithHeld resource.
+
+#### Deprecated enums:
+* type and payment_method have been deprecated in TaxWithHeld resource.
+
+#### Updated parameters:
+* hierarchy_operation_type has been made mandatory in customers#get_hierarchy api.
+
+#### Removed Filter parameters:
+* create_pending_invoices has been removed from subscriptions#list_subscriptions api.
+
+
+### v2.8.1 (2022-01-05)
+* * *
+
+### Fixes:
+* Improved error message for Invalid JSON response.
+
+### v2.8.0 (2021-12-08)
+* * *
+
+### Fixes:
+* Exposed function chargebee#updateRequestTimeoutInMillis to set custom time out.
+* Updated default request timeout to 80000ms.
+
+#### New endpoints:
+* payment_sources#update_bank_account have been added in payment_sources resource.
+* item_price#item_price_find_applicable_items and item_price#item_price_find_applicable_item_prices have been added in item_price resource.
+
+#### New Attributes:
+* hsn_code have been added to the resource addon, item_price and plan.
+* first_name, last_name and email have been added to the resource payment_sources.
+
+#### New Resource:
+* TaxWithheld has been added.Applicable only for API V2. 
+
+#### New Input parameters:
+* hsn_code have been added to addons#create_an_addon, addons#update_an_addon, plan#create_an_plan and plan#update_an_plan  apis.
+* bank_account[first_name],bank_account[last_name] and bank_account[email] have been added to payment_sources#update_bank_account api.
+* charges[hsn_code] have been added in estimate#Create_Invoice, estimate#Create_Invoice_For_Items, hosted_pages#Checkout_One_Time, hosted_pages#Checkout_One_Time_For_Items, invoice#create_an_invoice, invoice#Create_For_Charge_Items_And_Charges and unbilledCharge#create_an_unbilledCharge apis.
+* tax_detail[hsn_code] have been added in item_price#create_an_itemPrice and item_price#update_an_itemPrice apis.
+* include_deleted have been added in plan#plan_list and addon#addon_list apis.Applicable only for Product Catalog V1.
+
+#### New Enum values:
+* subscription_activated_with_backdating, tax_withheld_recorded, tax_withheld_deleted and tax_withheld_refunded has been added to event_type enum.
+
+### v2.7.0 (2021-08-16)
+* * *
+#### New Attributes:
+* generated_at has been added in credit_note and invoice resources.
+* change_option have been added in quoted_subscription resource.
+* changes_scheduled_at has been added in subscription and quoted_subscription resources.
+* iin and last4 have been added in transaction resource.
+
+#### New Resource:
+* quoted_charge has been added. 
+
+#### New Input parameters:
+* invoice_date has been added in estimates##create_subscription_estimate, estimates#estimate_for_creating_a_customer_and_subscription, estimates#estimate_for_creating_a_subscription, estimates#create_subscription_for_a_customer_estimate, estimates#update_subscription_estimate, estimates#estimate_for_updating_a_subscription, estimates#cancel_subscription_estimate, estimates#cancel_subscription_for_items_estimate, estimates#create_invoice_for_items_estimate, estimates#create_invoice_estimate, hosted_pages#checkout_existing_subscription, hosted_pages#create_checkout_to_update_a_subscription, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, subscriptions#create_a_subscription, subscriptions#create_subscription_for_customer, subscriptions#update_a_subscription, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items, subscriptions#reactivate_a_subscription, subscriptions#cancel_subscription_for_items and subscriptions#cancel_a_subscription endpoints.
+* coupon_ids has been added to invoices#create_invoice_for_a_one-time_charge, invoice#create_invoice_for_a_non-recurring_addon, quotes#create_quote_for_one-time_charges, quotes#edit_quote_for_one-time_charges, quotes#create_a_quote_for_charge_and_charge_items, quotes#edit_quote_for_charge_items_and_charges endpoints.
+* change_option and changes_scheduled_at have been added in quotes#create_quote_for_updating_a_subscription, quotes#edit_quote_for_updating_a_subscription, quotes#create_a_quote_for_update_subscription_items, quotes#edit_update_subscription_quote_for_items, subscriptions#update_a_subscription and subscriptions#create_subscription_for_items endpoints.
+* invoice_date, create_pending_invoices and first_invoice_pending have been added in quotes#convert_a_quote endpoint.
+* subscription[auto_close_invoices] has been added in quotes#convert_a_quote endpoint.
+
+#### New Enum values:
+* subscription_cancel has been added to charge_event enum in quote_line_groups resource.
+* subscription_created_with_backdating, subscription_changed_with_backdating, subscription_canceled_with_backdating, subscription_reactivated_with_backdating, invoice_generated_with_backdating and credit_note_created_with_backdating have been added to event_type enum 
+* change_option enum has been added.
+
+#### Deprecated parameters:
+* coupon has been deprecated in invoices#create_invoice_for_a_one-time_charge and invoices#create_invoice_for_a_non-recurring_addon endpoints.
+
 ### v2.6.6 (2021-07-22)
 * * *
 #### Fixes:

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2020 ChargeBee, Inc.
+Copyright (c) 2011-2022 ChargeBee, Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/lib/chargebee.js

@@ -7,8 +7,8 @@ ChargeBee._env = {
     protocol: 'https',
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
-    timeout: 40000,
-    clientVersion: 'v2.6.6',
+    timeout: 80000,
+    clientVersion: 'v2.9.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000
@@ -18,6 +18,10 @@ ChargeBee.configure = function(conf) {
     ChargeBee._util.extend(true, ChargeBee._env, conf);
 };
 
+ChargeBee.updateRequestTimeoutInMillis = function(timeout) {
+    ChargeBee._env.timeout = timeout;
+};
+
 ChargeBee._endpoints = require('./resources/api_endpoints.js');
 
 
@@ -187,7 +191,36 @@ ChargeBee._core = (function() {
                 try {
                     response = JSON.parse(response);
                 } catch (e) {
-                    throwError(callBack,'client_error', 500, 'invalid_json', 'invalid json in response. Probably not a ChargeBee response', e);
+                    if (response.includes('503')) { 
+                        return throwError(
+                            callBack,
+                            'internal_temporary_error', 
+                            503, 
+                            'internal_temporary_error', 
+                            'Sorry, the server is currently unable to handle the request due to a temporary overload or scheduled maintenance. Please retry after sometime.',
+                            e 
+                          );
+                      }
+                      else if(response.includes('504')) {
+                        return throwError(
+                            callBack,
+                            'gateway_timeout', 
+                             504, 
+                            'gateway_timeout', 
+                            'The server did not receive a timely response from an upstream server, request aborted. If this problem persists, contact us at support@chargebee.com.',
+                            e 
+                          );
+                      }
+                      else {
+                        return throwError(
+                            callBack,
+                            'internal_error', 
+                            500, 
+                            'internal_error', 
+                            'Sorry, something went wrong when trying to process the request. If this problem persists, contact us at support@chargebee.com.',
+                            e 
+                          );
+                      }                
                 }
                 if (res.statusCode < 200 || res.statusCode > 299) {
                     response.http_status_code = res.statusCode;
@@ -459,4 +492,5 @@ ChargeBee._util = (function() {
     }
     module.exports.time_machine.wait_for_time_travel_completion = ChargeBee._timeMachineWait;
     module.exports.export.wait_for_export_completion = ChargeBee._waitForExport;
+    module.exports.updateRequestTimeoutInMillis = ChargeBee.updateRequestTimeoutInMillis;
 })();

package/lib/resources/api_endpoints.js

@@ -471,6 +471,13 @@ var _endpoints = {
       "/update_card",
       true
     ],
+    [
+      "update_bank_account",
+      "POST",
+      "/payment_sources",
+      "/update_bank_account",
+      true
+    ],
     [
       "verify_bank_account",
       "POST",
@@ -739,6 +746,13 @@ var _endpoints = {
       "/pdf",
       true
     ],
+    [
+      "download_einvoice",
+      "GET",
+      "/invoices",
+      "/download_einvoice",
+      true
+    ],
     [
       "add_charge",
       "POST",
@@ -838,6 +852,7 @@ var _endpoints = {
       true
     ]
   ],
+  "tax_withheld": [],
   "credit_note": [
     [
       "create",
@@ -860,6 +875,13 @@ var _endpoints = {
       "/pdf",
       true
     ],
+    [
+      "download_einvoice",
+      "GET",
+      "/credit_notes",
+      "/download_einvoice",
+      true
+    ],
     [
       "refund",
       "POST",
@@ -1562,6 +1584,7 @@ var _endpoints = {
     ]
   ],
   "quoted_subscription": [],
+  "quoted_charge": [],
   "quote_line_group": [],
   "plan": [
     [
@@ -2231,6 +2254,20 @@ var _endpoints = {
       "/item_prices",
       "/delete",
       true
+    ],
+    [
+      "find_applicable_items",
+      "GET",
+      "/item_prices",
+      "/applicable_items",
+      true
+    ],
+    [
+      "find_applicable_item_prices",
+      "GET",
+      "/item_prices",
+      "/applicable_item_prices",
+      true
     ]
   ],
   "attached_item": [
@@ -2268,13 +2305,6 @@ var _endpoints = {
       "/items",
       "/attached_items",
       true
-    ],
-    [
-      "list_internal",
-      "GET",
-      "/attached_items",
-      "/list_internal",
-      false
     ]
   ],
   "differential_price": [
@@ -2313,6 +2343,6 @@ var _endpoints = {
       null,
       false
     ]
-  ],
+  ]
 };
 module.exports = _endpoints;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.6.6",
+   "version":"2.9.0",
    "description":"A library for integrating with ChargeBee.",
    "keywords":[
       "payments",