comprodls-sdk 2.89.0 → 2.90.0-qa

package/lib/services/integrations/index.js

@@ -32,9 +32,6 @@ var converter = require('../../helpers/lib/api/converter');
 
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = integrations;
 
 var keepaliveAgent = new Agent({
@@ -44,22 +41,22 @@ var keepaliveAgent = new Agent({
 
 //Integrations Adaptor Constructor
 function integrations(accountId) {
-    this.accountId = accountId;
+  this.accountId = accountId;
   return {
-      getGetStreamCredentials: getGetStreamCredentials.bind(this),
-      queryDataFromSearch: queryDataFromSearch.bind(this),
-      getAuditTrailForAttempts: getAuditTrailForAttempts.bind(this),
-      getAuditTrailForEntitlements: getAuditTrailForEntitlements.bind(this),
-      getAuditTrailForMicroEntitlements: getAuditTrailForMicroEntitlements.bind(this),
-      publishCustomEvents: publishCustomEvents.bind(this),
-      createSchedule: createSchedule.bind(this),
-      getSchedule: getSchedule.bind(this),
-      updateSchedule: updateSchedule.bind(this),
-      deleteSchedule: deleteSchedule.bind(this)
+    getGetStreamCredentials: getGetStreamCredentials.bind(this),
+    queryDataFromSearch: queryDataFromSearch.bind(this),
+    getAuditTrailForAttempts: getAuditTrailForAttempts.bind(this),
+    getAuditTrailForEntitlements: getAuditTrailForEntitlements.bind(this),
+    getAuditTrailForMicroEntitlements: getAuditTrailForMicroEntitlements.bind(this),
+    publishCustomEvents: publishCustomEvents.bind(this),
+    createSchedule: createSchedule.bind(this),
+    getSchedule: getSchedule.bind(this),
+    updateSchedule: updateSchedule.bind(this),
+    deleteSchedule: deleteSchedule.bind(this)
   };
 }
 
-//params: NONE
+/** params: NONE */
 function getGetStreamCredentials() {
   var self = this;
   var dfd = q.defer(), err;
@@ -77,20 +74,18 @@ function getGetStreamCredentials() {
 
   requestAPI.end(function (error, response) {
     if(error) {
-        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
-        dfd.reject(err);
+      err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+      dfd.reject(err);
     }
     else {  dfd.resolve(response); }
   });
   return dfd.promise;
 }
 
-/*
-  options = {
-  index: 'string', //mandatory
-  query: 'string' //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#querydatafromsearchparams
+ */
 function queryDataFromSearch(options) {
   var self = this;
   var dfd = q.defer();
@@ -131,17 +126,10 @@ function queryDataFromSearch(options) {
   return dfd.promise;
 }
 
-/*
-options = {
-  accountid: 'string',
-  action: 'string',
-  userid: 'string',
-  productcode: 'string',
-  item-code: 'string',
-  sortOrder: 'asc/desc', // optional
-  cursor: 'string'
-}
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#getaudittrailforattemptsparams
+ */
 function getAuditTrailForAttempts(options) {
   var self = this;
   var dfd = q.defer();
@@ -186,16 +174,10 @@ function getAuditTrailForAttempts(options) {
   return dfd.promise;
 }
 
-/*
-options = {
-  accountid: 'string',
-  action: 'string',
-  userid: 'string',
-  productcode: 'string',
-  sortOrder: 'asc/desc', // optional
-  cursor: 'string'
-}
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#getaudittrailforentitlementsparams
+ */
 function getAuditTrailForEntitlements(options) {
   var self = this;
   var dfd = q.defer();
@@ -241,17 +223,10 @@ function getAuditTrailForEntitlements(options) {
   return dfd.promise;
 }
 
-/*
-options = {
-  accountid: 'string',
-  action: 'string',
-  userid: 'string',
-  productcode: 'string',
-  sortOrder: 'asc/desc', // optional
-  context: 'string',
-  cursor: 'string'
-}
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#getaudittrailformicroentitlementsparams
+ */
 function getAuditTrailForMicroEntitlements(options) {
   var self = this;
   var dfd = q.defer();
@@ -298,17 +273,8 @@ function getAuditTrailForMicroEntitlements(options) {
 }
 
 /**
- * Publish custom events and send push notifications
- * @param {
- *   *events: [{
- *     *ext_actor_id: 'string',
- *     *category: "string",
- *     *action: 'string',
- *     *data: {...},
- *     push: <boolean, default: false
- *     ref_id: 'string'
- *   }, ...]
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#publishcustomeventsparams
  */
 function publishCustomEvents(options) {
   var deferred = q.defer();
@@ -345,24 +311,10 @@ function publishCustomEvents(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    accountid: "string", //mandatory
-    context: "string", //mandatory
-    body: {
-        "scheduleid": "",  //mandatory
-        "orgid": "",  // optional
-        "actorid": "",  //mandatory
-        "classid": "",  // optional
-        "assigned_path_id": "",  // optional
-        "productcode": "",  // optional
-        "userid": "", // optional
-        "category": "", //mandatory
-        "data": {}, // optional
-        "schedule_time" : ""  //mandatory
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#createscheduleparams
+ */
 function createSchedule(options) {
   var deferred = q.defer();
   // Initializing promise
@@ -401,15 +353,10 @@ function createSchedule(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    accountid: "string", //mandatory
-    context: "string", //mandatory
-    category: "string", //optional
-    scheduleid: "string", //optional
-    cursor: "string"  //optional
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#getscheduleparams
+ */
 function getSchedule(options) {
   var deferred = q.defer();
   // Initializing promise
@@ -447,25 +394,10 @@ function getSchedule(options) {
   return deferred.promise;
 }
 
-
-/*
-  options = {
-    accountid: "string", //mandatory
-    context: "string", //mandatory
-    scheduleid: "string", //mandatory
-    body: {
-        "schedule_time" : "",  // optional
-        "category": "", //mandatory
-        "orgid": "",  // optional
-        "actorid": "",  //mandatory
-        "userid": "", // optional
-        "classid": "",  // optional
-        "assigned_path_id": "",  // optional
-        "productcode": "",  // optional
-        "data": {} // optional
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#updatescheduleparams
+ */
 function updateSchedule(options) {
   var deferred = q.defer();
   // Initializing promise
@@ -495,7 +427,7 @@ function updateSchedule(options) {
     });
   } else {
     err = {};
-    err.message = err.description = 'Mandatory param - accountid or context or scheduleid or ' + 
+    err.message = err.description = 'Mandatory param - accountid or context or scheduleid or ' +
                                     'body(category or actorid) not found in request options.';
     err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
     deferred.reject(err);
@@ -504,17 +436,10 @@ function updateSchedule(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    accountid: "string",  //mandatory
-    context: "string",    //mandatory
-    scheduleid: "string", //mandatory
-    body: {
-        "category": "",   //mandatory
-        "actorid": "",    //mandatory
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#deletescheduleparams
+ */
 function deleteSchedule(options) {
   var deferred = q.defer();
   // Initializing promise
@@ -534,7 +459,7 @@ function deleteSchedule(options) {
     if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
     requestAPI
-      .agent(keepaliveAgent)  
+      .agent(keepaliveAgent)
       .end(function (error, response) {
         if (error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
@@ -545,7 +470,7 @@ function deleteSchedule(options) {
       });
   } else {
     err = {};
-    err.message = err.description = 'Mandatory param - accountid or context or scheduleid or ' + 
+    err.message = err.description = 'Mandatory param - accountid or context or scheduleid or ' +
                                     'body not found in request options.';
     err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
     deferred.reject(err);

package/lib/services/invitations/index.js

@@ -25,19 +25,13 @@
 
 var q = require('q');
 var request = require('superagent');
-
 var helpers = require('../../helpers');
-
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = invitations;
 
 //Invitations Adaptor Constructor
 function invitations() {
-
   return {
     sendInvitations: sendInvitations.bind(this),
     getMultiInvitations: getMultiInvitations.bind(this),
@@ -47,35 +41,10 @@ function invitations() {
   };
 }
 
-/*options = {
-    context: 'string',  // required
-    created: 'string',  // required
-    space_title: 'string',
-    class_enrollment: {
-      classid: 'string',       // required. Correlated with context
-      class_role: 'string',    // optional
-      inviter_email: 'string'  // optional
-    },
-    invitation_data: [
-      {
-        class_enrollment  : {       // optional, will override the outer context
-          classid: 'string'         // required. Correlated with context
-          class_role: 'string',     // optional
-          inviter_email: 'string'   // optional
-        },
-        email: 'string',   // required
-        dls_account_status: 'string',
-        ext_account_status: 'string',
-        userid: 'string',
-        ext_user_id: 'string',
-        first_name: 'string',  // required
-        last_name: 'string',   // required
-        ext_data: {},
-        rowId: 'string',       // required
-        role: 'string'        /// required
-      },...
-    ]
-  }*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/20_Invitations-Adapter#sendInvitationsparams
+ */
 function sendInvitations(options) {
   var self = this;
   var dfd = q.defer();
@@ -118,13 +87,10 @@ function sendInvitations(options) {
   return dfd.promise;
 }
 
-/* options = {
-   "context_id": "string", // required
-    "context" : "string", //context for invitation e.g. class_enrollment -required
-    "status" : "string", // ['pending','complete','revoke'] -required
-    "cursor" : "string", // optional
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/20_Invitations-Adapter#getmultiinvitationsparams
+ */
 function getMultiInvitations(options) {
   var self = this;
   // Initializing promise
@@ -171,12 +137,10 @@ function getMultiInvitations(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "context_id": "string", //class id to be to be revoked invitation -required
-    "invitationid" : "string", //unique invitation id which is to be fetched -required
-    "context" : "string", //context for revoking invitation e.g. class_enrollment -required
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/20_Invitations-Adapter#revokesingleinvitationparams
+ */
 function revokeSingleInvitation(options) {
   var self = this;
   // Initializing promise
@@ -220,12 +184,10 @@ function revokeSingleInvitation(options) {
   return dfd.promise;
 }
 
-/* options= {
-   "context_id": "string", //class id tocomplete an invitation -required
-    "invitationid" : "string", //unique invitation id which is to be fetched -required
-    "context" : "string", //context of the invitation to be completed e.g. class_enrollment -required
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/20_Invitations-Adapter#completesingleinvitationparams
+ */
 function completeSingleInvitation(options) {
   var self = this;
   // Initializing promise
@@ -270,13 +232,10 @@ function completeSingleInvitation(options) {
   return dfd.promise;
 }
 
-/* options =  {
-    "context_id": "string", //class id to be resent invition -required
-    "invitationid" : "string", //unique invitation id which is to be fetched -required
-    "context" : "string", //context for the invitation to be resent e.g. class_enrollment -required
-    "space_title" : "string" //optional
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/20_Invitations-Adapter#resendsingleinvitationparams
+ */
 function resendSingleInvitation(options) {
   var self = this;
   // Initializing promise

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,13 +183,12 @@ function getMicroEntitlementsForAUser(options) {
     dfd.reject(err);
   }
   return dfd.promise;
-
 }
 
-/* options= {
-  stage: "string",          //optional, stage number or version
-  target_role: "string"     // optional
-} */
+/**
+ * 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();
@@ -234,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;
@@ -273,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();
@@ -308,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();