chargebee 2.6.4 → 2.8.0

package/CHANGELOG.md

@@ -1,3 +1,160 @@
+### 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:
+* Changed use of deprecated Buffer allocation to 'safer-buffer' module. 'safer-buffer' is used inorder to support older versions of Node.js (<8.0.0) . By end of September, support for Node.js < 8.0.0 will be dropped and [native Buffer module](https://nodejs.org/api/buffer.html#buffer_static_method_buffer_from_string_encoding) will be used instead of 'safer-buffer'.
+#### New endpoints:
+* hosted_pages#checkout_one_time_for_items and hosted_pages#checkout_gift_for_items have been added in hosted_pages resource. 
+* orders#resend_an_order has been added in orders resource.
+* quotes#edit_create_subscription_quote_for_items, quotes#edit_update_subscription_quote_for_items and quotes#edit_quote_for_charge_items_and_charges have been added in quotes resource. Applicable only for Product Catalog V2.
+
+#### New attributes:
+* accounting_category3 and accounting_category4 have been added to addon, item_price and plan resources. 
+* quantity_in_decimal has been added to attached_item resource.
+* period and period_unit have been added to coupon resource.
+* entity_id has been added to line_item_discounts object of credit_note, credit_note_estimate, invoice, invoice_estimate, quote and quote_line_group resources. 
+* vat_number_prefix has been added to credit_note, customer, invoice and quote resources.
+* price_in_decimal has been added to differential_price and item_price resources. 
+* exchange_rate and new_sales_amount have been added to invoice resource.
+* archived_at has been added to item and item_price resources.
+* trial_end_action has been added to item_price, plan, subscription and subscription_estimate resources.
+* resent_orders, tracking_url, resent_status, is_resent, original_order_id and resend_reasons have been added to order resource. 
+* line_item_tiers have been added to quote resource.
+* plan_quantity_in_decimal and plan_unit_price_in_decimal have been added to quoted_subscription and subscription resources. Applicable only for Product Catalog V1.
+* contract_term_billing_cycle_on_renewal and quoted_contract_term have been added to quoted_subscription resource.
+* quantity_in_decimal, metered_quantity, last_calculated_at, unit_price_in_decimal, amount_in_decimal and free_quantity_in_decimal have been added to subscription_items object of quoted_subscription and subscription resources.
+* starting_unit_in_decimal, ending_unit_in_decimal and price_in_decimal have been added to item_tiers object in quoted_subscription resources.
+* cancel_schedule_created_at has been added to subscription resource.
+* exchange_rate and merchant_reference_id have been added to transaction resource.
+
+#### New parameters:
+* accounting_category3 and accounting_category4 have been added in addons#create_an_addon, addons#update_an_addon, plans#create_a_plan and plans#update_a_plan endpoints.
+* quantity_in_decimal has been added in attached_items#create_an_attached_item, attached_items#update_an_attached_item and gifts#create_a_gift_subscription_for_items endpoints.
+* period and period_unit have been added in coupons#create_a_coupon, coupons#update_a_coupon, coupons#create_a_coupon_for_items and coupons#update_a_coupon_for_items endpoints.
+* vat_number_prefix has been added in customers#create_a_customer, customers#update_billing_info_for_a_customer, estimates#create_subscription, estimates#create_subscription_estimate, estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, hosted_pages#checkout_new_subscription, hosted_pages#checkout_one-time_payments, hosted_pages#create_checkout_for_a_new_subscription hosted_pages#checkout_existing_subscription, hosted_pages#create_checkout_to_update_a_subscription, invoices#import_invoice, invoices#update_invoice_details, subscriptions#create_a_subscription, subscriptions#update_a_subscription, subscriptions#update_subscription_for_items and subscriptions#import_a_subscription endpoints.
+* payment_method[additional_information] has been added in customers#create_a_customer, customers#update_payment_method_for_a_customer,  customers#collect_payment_for_customer, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, subscriptions#create_a_subscription, subscriptions#update_a_subscription, subscriptions#update_subscription_for_items and subscriptions#import_a_subscription endpoints.
+* card[additional_information] has been added in customers#create_a_customer, customers#collect_payment_for_customer, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, payment_sources#create_a_card_payment_source, subscriptions#create_a_subscription, subscriptions#update_a_subscription, subscriptions#update_subscription_for_items and subscriptions#import_a_subscription endpoints.
+* bank_account[billing_address] has been added in customers#create_a_customer, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, payment_sources#create_a_bank_account_payment_source and subscriptions#create_a_subscription endpoints.
+* price_in_decimal has been added in differential_prices#create_a_differential_price and differential_prices#update_a_differential_price endpoints.
+* tiers[starting_unit_in_decimal][0..N], tiers[ending_unit_in_decimal][0..N] and tiers[price_in_decimal][0..N] have been added in differential_prices#create_a_differential_price, differential_prices#update_a_differential_price, item_prices#create_an_item_price and item_prices#update_an_item_price endpoints.
+* remove_general_note and notes_to_remove been added in estimates#create_invoice_estimate, estimates#create_invoice_for_items_estimate and invoices#create_invoice_for_items_and_one-time_charges endpoints.
+* trial_end_action has been added in estimates#create_subscription, estimates#create_subscription_estimate, estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, plans#create_a_plan, plans#update_a_plan, item_prices#create_an_item_price, item_prices#update_an_item_price, subscriptions#create_a_subscription, subscriptions#create_subscription_for_customer, subscriptions#create_subscription_for_items, subscriptions#update_a_subscription and subscriptions#update_subscription_for_items endpoints.
+* subscription_items[unit_price_in_decimal][0..N], item_tiers[starting_unit][0..N], item_tiers[ending_unit][0..N] and item_tiers[price_in_decimal][0..N] have been added in estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, estimates#cancel_subscription_for_items_estimate, hosted_pages#create_checkout_for_a_new_subscription, hosted_pages#create_checkout_to_update_a_subscription, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items and subscriptions#import_subscription_for_items endpoints.
+* subscription_items[quantity_in_decimal][0..N] has been added in estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#cancel_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, estimates#gift_subscription_for_items, estimates#cancel_subscription_for_items_estimate, gifts#create_a_gift_subscription_for_items, hosted_pages#create_checkout_for_a_new_subscription, hosted_pages#create_checkout_to_update_a_subscription, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items, subscriptions#import_subscription_for_items and subscriptions#cancel_subscription_for_items endpoints.
+* notes_to_remove[entity_type][0..N] and notes_to_remove[entity_id][0..N] have been added in estimates#create_invoice, estimates#create_invoice_for_items and invoices#create_invoice_for_items_and_one-time_charges endpoints.
+* item_prices[quantity_in_decimal][0..N] and item_prices[unit_price_in_decimal][0..N] have been added in estimates#create_invoice_for_items, invoices#create_invoice_for_items_and_one-time_charges and unbilled_charges#create_unbilled_charges_for_a_subscription endpoints.
+* item_tiers[starting_unit_in_decimal][0..N], item_tiers[ending_unit_in_decimal][0..N] and item_tiers[price_in_decimal][0..N] have been added in estimates#create_invoice_for_items, invoices#create_invoice_for_items_and_one-time_charges and unbilled_charges#create_unbilled_charges_for_a_subscription endpoints.
+* payment_intent[additional_information] has been added in customers#create_a_customer, customers#collect_payment_for_customer, gifts#create_a_gift_subscription_for_items, gifts#create_a_gif and payment_sources#create_using_payment_intent endpoints.
+* invoice_note has been added in hosted_pages#checkout_one-time_payments endpoint.
+* allow_offline_payment_methods has been added in hosted_pages#create_checkout_for_a_new_subscription and hosted_pages#create_checkout_to_update_a_subscription endpoints.
+* free_quantity_in_decimal, price_in_decimal and trial_end_action have been added in item_prices#create_an_item_price and item_prices#update_an_item_price endpoints.
+* tracking_url has been added in orders#create_an_order, orders#update_an_order and orders#import_an_order endpoints.
+* additional_information has been added in payment_sources#create_using_gateway_temporary_token and payment_sources#create_using_permanent_token endpoints.
+
+#### New enum values:
+* bancontact has been added to card_type enum.
+* card and latam_local_card have been added to powered_by enum.
+* item_level_discount and document_level_discount have been added to entity_type enum of credit_note_discount, credit_note_estimate_discount, invoice_discount, line_item_discount and invoice_estimate_discount resources.
+* item_level_discount and document_level_discount have been added to discount_type enum.
+* add_usages_reminder and order_resent have been added to event_type enum.
+* ingenico_direct and exact have been added to gateway enum. 
+* max_usage has been added to usage_calculation enum.
+* trial_end_action enum has been added.
+* order_resent has been added to cancellation_reason enum.
+* resent_status enum has been added.
+* custom_discount has been added in discount_type enum of order_line_item_discount. 
+
+#### New filter parameters:
+* resent_status, is_resent and original_order_id filter parameters have been added in exports#orders and orders#list_orders enpoints.
+* updated_at filter parameter has been added in exports#item_families and item_families#list_item_families endpoints.
+
+#### New sort parameters:
+* name, id and updated_at sort parameters are added to items#list_items and item_prices#list_item_prices endpoints.
+* created_at and updated_at sort parameters are added to payment_sources#list_payment_sources endpoint.
+* usage_date sort parameter has been added to usages#list_usages endpoint.
+
+#### Deprecated parameters:
+* duration_month parameter has been deprecated in coupon resource.
+
+### v2.6.5 (2021-01-19)
+* * *
+##### New resources:
+* Usages is added. Applicable only for Product Catalog V2
+
+##### New end points:
+* hosted_pages#checkout_one-time_payments has been added in hosted_pages resource
+
+##### New attributes:
+* auto_close_invoices has been added to customers, subscriptions resources
+* metered, usage_calculation have been added to items resources
+* create_pending_invoices, auto_close_invoices have been added to subscriptions resources
+
+##### New parameters:
+* auto_close_invoices has been added to the endpoint: customers#create_a_customer, customers#list_customers, customers#update_a_customer
+* invoice_allocations[invoice_id] has been added to the endpoint: customers#collect_payment_for_customer
+* coupon_ids has been added to the endpoint: estimates#create_invoice_for_items_estimate. Applicable only for Product Catalog V2
+* subscription[auto_close_invoices] has been added to the endpoint: exports#export_revenue_recognition_reports, exports#export_deferred_revenue_reports, exports#export_subscriptions
+* customer[auto_close_invoices] has been added to the endpoint: exports#export_revenue_recognition_reports, exports#export_deferred_revenue_reports, exports#export_customers
+* item[metered], item[usage_calculation] have been added to the endpoint: exports#export_items. Applicable only for Product Catalog V2
+* subscription_id has been added to the endpoint: invoices#add_one-time_charge_to_a_pending_invoice, invoices#add_non-recurring_addon_to_a_pending_invoice
+* subscription_id has been added to the endpoint: invoices#add_a_charge-item_to_a_pending_invoice. Applicable only for Product Catalog V2
+* metered, usage_calculation have been added to the endpoint: items#create_an_item, items#list_item. Applicable only for Product Catalog V2
+* create_pending_invoices, auto_close_invoices, first_invoice_pending have been added to the endpoint: subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items,subscriptions#import_subscription_for_items. Applicable only for Product Catalog V2
+* create_pending_invoices, auto_close_invoices have been added to the endpoint: subscriptions#list_subscriptions
+
 ### v2.6.4 (2020-12-15)
 * * *
 ##### New end points:

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2020 ChargeBee, Inc.
+Copyright (c) 2011-2021 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

@@ -2,12 +2,13 @@ var ChargeBee = {};
 
 var Q = require("q");
 var os = require("os");
+var Buffer = require("safer-buffer").Buffer;
 ChargeBee._env = {
     protocol: 'https',
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
-    timeout: 40000,
-    clientVersion: 'v2.6.4',
+    timeout: 80000,
+    clientVersion: 'v2.8.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000
@@ -17,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');
 
 
@@ -218,8 +223,9 @@ ChargeBee._core = (function() {
         }
         var data = encodeParams(params);
         var protocol = (env.protocol === 'http' ? http : https);
+
         ChargeBee._util.extend(true, headers, {
-            'Authorization': 'Basic ' + new Buffer(env.api_key + ':').toString('base64'),
+            'Authorization': 'Basic ' + Buffer.from(env.api_key+':').toString('base64'),
             'Accept': 'application/json',
             'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
             "Content-Length": data.length,
@@ -457,4 +463,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",
@@ -838,6 +845,7 @@ var _endpoints = {
       true
     ]
   ],
+  "tax_withheld": [],
   "credit_note": [
     [
       "create",
@@ -1017,6 +1025,13 @@ var _endpoints = {
       "/invoices",
       "/orders",
       true
+    ],
+    [
+      "resend",
+      "POST",
+      "/orders",
+      "/resend",
+      true
     ]
   ],
   "gift": [
@@ -1150,6 +1165,20 @@ var _endpoints = {
       "/checkout_new",
       false
     ],
+    [
+      "checkout_one_time",
+      "POST",
+      "/hosted_pages",
+      "/checkout_one_time",
+      false
+    ],
+    [
+      "checkout_one_time_for_items",
+      "POST",
+      "/hosted_pages",
+      "/checkout_one_time_for_items",
+      false
+    ],
     [
       "checkout_new_for_items",
       "POST",
@@ -1220,6 +1249,13 @@ var _endpoints = {
       "/checkout_gift",
       false
     ],
+    [
+      "checkout_gift_for_items",
+      "POST",
+      "/hosted_pages",
+      "/checkout_gift_for_items",
+      false
+    ],
     [
       "claim_gift",
       "POST",
@@ -1413,13 +1449,6 @@ var _endpoints = {
       "/edit_create_subscription_quote",
       true
     ],
-    [
-      "create_sub_items_for_customer_quote",
-      "POST",
-      "/customers",
-      "/create_subscription_quote_for_items",
-      true
-    ],
     [
       "update_subscription_quote",
       "POST",
@@ -1434,6 +1463,34 @@ var _endpoints = {
       "/edit_update_subscription_quote",
       true
     ],
+    [
+      "create_for_onetime_charges",
+      "POST",
+      "/quotes",
+      "/create_for_onetime_charges",
+      false
+    ],
+    [
+      "edit_one_time_quote",
+      "POST",
+      "/quotes",
+      "/edit_one_time_quote",
+      true
+    ],
+    [
+      "create_sub_items_for_customer_quote",
+      "POST",
+      "/customers",
+      "/create_subscription_quote_for_items",
+      true
+    ],
+    [
+      "edit_create_sub_customer_quote_for_items",
+      "POST",
+      "/quotes",
+      "/edit_create_subscription_quote_for_items",
+      true
+    ],
     [
       "update_subscription_quote_for_items",
       "POST",
@@ -1442,11 +1499,11 @@ var _endpoints = {
       false
     ],
     [
-      "create_for_onetime_charges",
+      "edit_update_subscription_quote_for_items",
       "POST",
       "/quotes",
-      "/create_for_onetime_charges",
-      false
+      "/edit_update_subscription_quote_for_items",
+      true
     ],
     [
       "create_for_charge_items_and_charges",
@@ -1456,10 +1513,10 @@ var _endpoints = {
       false
     ],
     [
-      "edit_one_time_quote",
+      "edit_for_charge_items_and_charges",
       "POST",
       "/quotes",
-      "/edit_one_time_quote",
+      "/edit_for_charge_items_and_charges",
       true
     ],
     [
@@ -1513,6 +1570,7 @@ var _endpoints = {
     ]
   ],
   "quoted_subscription": [],
+  "quoted_charge": [],
   "quote_line_group": [],
   "plan": [
     [
@@ -1778,6 +1836,43 @@ var _endpoints = {
       false
     ]
   ],
+  "usage": [
+    [
+      "create",
+      "POST",
+      "/subscriptions",
+      "/usages",
+      true
+    ],
+    [
+      "retrieve",
+      "GET",
+      "/subscriptions",
+      "/usages",
+      true
+    ],
+    [
+      "delete",
+      "POST",
+      "/subscriptions",
+      "/delete_usage",
+      true
+    ],
+    [
+      "list",
+      "GET",
+      "/usages",
+      null,
+      false
+    ],
+    [
+      "pdf",
+      "POST",
+      "/usages",
+      "/pdf",
+      false
+    ]
+  ],
   "event": [
     [
       "list",
@@ -2145,6 +2240,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": [
@@ -2182,13 +2291,6 @@ var _endpoints = {
       "/items",
       "/attached_items",
       true
-    ],
-    [
-      "list_internal",
-      "GET",
-      "/attached_items",
-      "/list_internal",
-      false
     ]
   ],
   "differential_price": [
@@ -2227,6 +2329,6 @@ var _endpoints = {
       null,
       false
     ]
-  ],
+  ]
 };
 module.exports = _endpoints;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.6.4",
+   "version":"2.8.0",
    "description":"A library for integrating with ChargeBee.",
    "keywords":[
       "payments",
@@ -12,7 +12,8 @@
    "author":"Ajit <ajit@chargebee.com> (https://www.chargebee.com)",
    "main":"lib/chargebee.js",
    "dependencies":{
-     "q" : ">=1.0.1"
+     "q" : ">=1.0.1",
+     "safer-buffer": "2.1.2"
    },
    "directories":{
       "lib":"./lib"