chargebee 2.21.0 → 2.22.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+### v2.22.0 (2023-05-16)
+* * *
+
+#### New Feature:
+* Added setIdempotencyKey("UUID") utility to pass **Idempotency key** along with request headers to allow a safe retry of POST requests.
+* Added isIdempotencyReplayed utility to differentiate between original and replayed requests.
+* Added headers utility to fetch the response headers.
+
+
 ### v2.21.0 (2023-04-28)
 * * *
 

package/README.md

@@ -21,6 +21,35 @@ Then require the library as:
 
 	var chargebee = require('chargebee');
 
+## Usage
+
+### Create an idempotent request
+[Idempotency keys](https://apidocs.chargebee.com/docs/api) are passed along with request headers to allow a safe retry of POST requests. 
+
+```node
+var chargebee = require("chargebee");
+chargebee.configure({site : "{site}", api_key : "{site_api_key}"})
+chargebee.customer.create({
+    first_name : "John",
+    last_name : "Doe",
+    email : "john@test.com"
+   })
+    .setIdempotencyKey("<<UUID>>") // Replace <<UUID>> with a unique string
+    .request(function(error,result, headers) {
+    if(error){
+        //handle error
+        console.log(error);
+    }else{
+        console.log(result);
+        console.log(headers); // Retrieves response headers
+        console.log(isIdempotencyReplayed); // Retrieves idempotency replayed header value 
+        var customer = result.customer;
+        var card = result.card;
+    }
+});
+```
+`isIdempotencyReplayed()` method can be accessed to differentiate between original and replayed requests.
+
 ## Documentation
 
 The full documentation can be found on the chargebee site here:

package/lib/chargebee.js

@@ -3,12 +3,15 @@ var ChargeBee = {};
 var Q = require("q");
 var os = require("os");
 var Buffer = require("safer-buffer").Buffer;
+const IDEMPOTENCY_HEADER = "chargebee-idempotency-key";
+const IDEMPOTENCY_REPLAY_HEADER = 'chargebee-idempotency-replayed';
+
 ChargeBee._env = {
     protocol: 'https',
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: 80000,
-    clientVersion: 'v2.21.0',
+    clientVersion: 'v2.22.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000
@@ -24,6 +27,12 @@ ChargeBee.updateRequestTimeoutInMillis = function(timeout) {
 
 ChargeBee._endpoints = require('./resources/api_endpoints.js');
 
+RequestWrapper.prototype.setIdempotencyKey = function(idempotencyKey) {
+    this.headers({[IDEMPOTENCY_HEADER]: idempotencyKey});
+    return this;
+};
+
+
 
 ChargeBee._waitToProcessComplete = function(retrieveHandling){
     if(typeof retrieveHandling == 'undefined' || !ChargeBee._util.isFunction(retrieveHandling)){
@@ -131,6 +140,7 @@ RequestWrapper.prototype.headers = function(headers) {
     return this;
 };
 
+
 RequestWrapper.prototype.request = function(callBack, envOptions) {
     var env = {};
     var jsonConstructor =  {}.constructor;
@@ -147,11 +157,11 @@ RequestWrapper.prototype.request = function(callBack, envOptions) {
     if (typeof callBack !== 'undefined' && !ChargeBee._util.isFunction(callBack)) {
         throw new Error('The callback parameter passed is incorrect.');
     }
-    function callBackWrapper(err, response) {
+    function callBackWrapper(err, response, headers) {
         if (err) {
             deferred.reject(err);
         } else {
-            deferred.resolve(response);
+            deferred.resolve({'response': response, 'headers': headers});
         }
     };
     ChargeBee._core.makeApiRequest(env, callBackWrapper, this.apiCall.httpMethod, this.apiCall.urlPrefix, this.apiCall.urlSuffix, urlIdParam, params, this.httpHeaders, this.apiCall.isListReq);
@@ -224,9 +234,9 @@ ChargeBee._core = (function() {
                 }
                 if (res.statusCode < 200 || res.statusCode > 299) {
                     response.http_status_code = res.statusCode;
-                    callBack(response, null);
+                    callBack(response, null, res.headers);
                 } else {
-                    callBack(null, response);
+                    callBack(null, response, res.headers);
                 }
             });
         };
@@ -460,7 +470,11 @@ ChargeBee._util = (function() {
         if (callback) {
             deferred.promise.then(function(res) {
                 setTimeout(function() {
-                    callback(null, res);
+                    isIdempotencyReplayed = false
+                    if(typeof res.headers[IDEMPOTENCY_REPLAY_HEADER] !== 'undefined' && res.headers[IDEMPOTENCY_REPLAY_HEADER] !== ''){
+                        isIdempotencyReplayed = res.headers[IDEMPOTENCY_REPLAY_HEADER];
+                    }
+                    callback(null, res.response, res.headers);
                 }, 0);
             }, function(err) {
                 setTimeout(function() {

package/package.json

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