comprodls-sdk 2.90.3-development → 2.91.0-thor

package/lib/services/product/index.js

@@ -17,6 +17,7 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS SDK Product API Adaptor
  * Functions for calling Product API.
@@ -27,81 +28,76 @@ var q = require('q');
 var helpers = require('../../helpers');
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = product;
 
 function product(accountId) {
-    this.accountId = accountId;
-    return {
-        getProduct: getProduct.bind(this),
-        getGlobalEntitlementsForAUser: getGlobalEntitlementsForAUser.bind(this),
-        getMicroEntitlementsForAUser: getMicroEntitlementsForAUser.bind(this),
-
-        getAllBundles: getAllBundles.bind(this),
-        getSingleBundle: getSingleBundle.bind(this),
-
-        getSingleProductFamily: getSingleProductFamily.bind(this),
-        getAllProductFamilies: getAllProductFamilies.bind(this)
-    };
+  this.accountId = accountId;
+  return {
+    getProduct: getProduct.bind(this),
+    getGlobalEntitlementsForAUser: getGlobalEntitlementsForAUser.bind(this),
+    getMicroEntitlementsForAUser: getMicroEntitlementsForAUser.bind(this),
+
+    getAllBundles: getAllBundles.bind(this),
+    getSingleBundle: getSingleBundle.bind(this),
+
+    getSingleProductFamily: getSingleProductFamily.bind(this),
+    getAllProductFamilies: getAllProductFamilies.bind(this)
+  };
 }
 
-/*********************************
- * Public Function definitions
- **********************************/
-
-//options = {
-//	productcode: '', //productcode of product
-//	details: boolean, // (optional)
-//  stage: string // (optional, ['1', '2', 'final']), default - final
-//}
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/05_PRODUCT-Adapter#getproductparams
+ */
 function getProduct(options) {
-    var dfd = q.defer();
+  var dfd = q.defer();
 	var self = this;
-    var err = {};
+  var err = {};
 
 	if(options && options.productcode) {
-        //Passed all validations, Construct API url
-        var url = self.config.DEFAULT_HOSTS['PRODUCT'] +
-            self.config.PRODUCT_API_URLS.getProductAPI;
-        url = helpers.api.constructAPIUrl(url, {
-            accountId: self.accountId,
-            productCode: options.productcode
-        });
-
-        //Construct parameters
-        var params = {};
-        if(options.details) {
-            params.details = options.details;
-        }
-        if(options.stage) {
-            params.stage = options.stage;
-        }
-        //Setup request with URL and Params
-        var requestAPI = request.get(url).query(params);
-        if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-        //Call GET All Products Source Api
-        requestAPI.end(function(err, response) {
-            if (err) {
-                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-                dfd.reject(err);
-            } else {
-                dfd.resolve(response.body);
-            }
-        });
+    //Passed all validations, Construct API url
+    var url = self.config.DEFAULT_HOSTS['PRODUCT'] +
+        self.config.PRODUCT_API_URLS.getProductAPI;
+    url = helpers.api.constructAPIUrl(url, {
+        accountId: self.accountId,
+        productCode: options.productcode
+    });
+
+    //Construct parameters
+    var params = {};
+    if(options.details) {
+      params.details = options.details;
+    }
+    if(options.stage) {
+      params.stage = options.stage;
     }
-    else {
+    //Setup request with URL and Params
+    var requestAPI = request.get(url).query(params);
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    //Call GET All Products Source Api
+    requestAPI.end(function(err, response) {
+      if (err) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      } else {
+        dfd.resolve(response.body);
+      }
+    });
+  }
+  else {
 		err.message = err.description = 'productcode not found in request options';
 		err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
 		dfd.reject(err);
 	}
 
-    return dfd.promise;
+  return dfd.promise;
 }
 
-// options : { extUserId, productDetails, bundleDetails }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/05_PRODUCT-Adapter#getglobalentitlementsforauserparams
+ */
 function getGlobalEntitlementsForAUser(options) {
   var self = this;
 
@@ -140,17 +136,12 @@ function getGlobalEntitlementsForAUser(options) {
     dfd.reject(err);
   }
   return dfd.promise;
-
 }
 
-/*options : {
-    extuserid,    //mandatory
-    productcode,  //mandatory
-    context,      //optional
-    feature_key,  //optional
-    cursor        //optional
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/05_PRODUCT-Adapter#getmicroentitlementsforauserparams
+ */
 function getMicroEntitlementsForAUser(options) {
   var self = this;
 
@@ -192,12 +183,12 @@ function getMicroEntitlementsForAUser(options) {
     dfd.reject(err);
   }
   return dfd.promise;
-
 }
 
-// options= {
-//  stage: "",          //stage number or version
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/05_PRODUCT-Adapter#getallbundlesparams
+ */
 function getAllBundles(options) {
     var self = this;
     var dfd = q.defer();
@@ -208,7 +199,14 @@ function getAllBundles(options) {
   url = helpers.api.constructAPIUrl(url, { accountId : self.accountId });
   //Contruct parameters
   var params = {};
-  if(options && options.stage) { params.stage = options.stage; }
+  if(options) {
+    if(options.stage){
+      params.stage = options.stage;
+    }
+    if(options.target_role){
+      params.target_role = options.target_role;
+    }
+  }
 
   //Setup request with URL and Post data
   var requestAPI = request.get(url).query(params);
@@ -226,16 +224,15 @@ function getAllBundles(options) {
   return dfd.promise;
 }
 
-// options = {
-//   'bundle-code': "",   //bundle identifier
-//   stage: "",           //stage number/version
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/05_PRODUCT-Adapter#getsinglebundleparams
+ */
 function getSingleBundle(options) {
   var self = this;
   var dfd = q.defer();
   var err;
 
-
   if(options && options['bundle-code']) {
 
     var url = self.config.DEFAULT_HOSTS.PRODUCT + self.config.PRODUCT_API_URLS.getSingleBundle;
@@ -265,13 +262,13 @@ function getSingleBundle(options) {
     dfd.reject(err);
   }
 
-
   return dfd.promise;
 }
 
-// options= {
-//  stage: "",          //stage number
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/05_PRODUCT-Adapter#getallproductfamiliesparams
+ */
 function getAllProductFamilies(options) {
   var self = this;
   var dfd = q.defer();
@@ -300,10 +297,10 @@ function getAllProductFamilies(options) {
   return dfd.promise;
 }
 
-// options = {
-//   'family-code': "",   //product-family identifier
-//    stage: "",          //stage number
-// }
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/05_PRODUCT-Adapter#getsingleproductfamilyparams
+ */
 function getSingleProductFamily(options) {
   var self = this;
   var dfd = q.defer();