comprodls-sdk 2.90.3-development → 2.91.0-thor

package/lib/services/authextn/index.js

@@ -30,9 +30,6 @@ var Agent = require('agentkeepalive');
 
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = authextn;
 
 var keepaliveAgent = new Agent({
@@ -41,8 +38,7 @@ var keepaliveAgent = new Agent({
 });
 
 //AuthExtn Adaptor Contsructor
-function authextn(accountId) {
-  this.accountId = accountId;
+function authextn() {
   return {
     // Gradeformat related APIs
     createGradeformat: createGradeformat.bind(this),
@@ -68,9 +64,7 @@ function authextn(accountId) {
     createOrgProductEntitlement: createOrgProductEntitlement.bind(this),
     updateOrgProductEntitlement: updateOrgProductEntitlement.bind(this),
     getParticularOrgProductEntitlement: getParticularOrgProductEntitlement.bind(this),
-    getAllOrgProductEntitlements: getAllOrgProductEntitlements.bind(this),
-    setupUser: setupUser.bind(this)
-
+    getAllOrgProductEntitlements: getAllOrgProductEntitlements.bind(this)
   };
 }
 
@@ -78,21 +72,10 @@ function authextn(accountId) {
  * Public Function definitions
  **********************************/
 
-/*
-  options = {
-    body : {
-      gradeformat_id: "string", //mandatory
-      grades:[ {                //mandatory
-        id: "string",
-        title: "string",
-        min_threshold: "string",
-        max_threshold: "string",
-        target: boolean
-      }, ...]
-      data: {}
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#creategradeformatparams
+ */
 function createGradeformat(options) {
   var self = this;
   // Initializing promise
@@ -139,21 +122,10 @@ function createGradeformat(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    gradeformat_id: "string",    // Mandatory
-    body : {
-      grades: [ {
-        id: "string",
-        title: "string",
-        min_threshold: "string",
-        max_threshold: "string",
-        target: boolean
-      }, ...]
-      data: {...}
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#updategradeformatparams
+ */
 function updateGradeformat(options) {
   // Initializing promise
   var deferred = q.defer();
@@ -214,11 +186,10 @@ function updateGradeformat(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    gradeformat_id: "string" //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#deletegradeformatparams
+ */
 function deleteGradeformat(options) {
   var self = this;
   var dfd = q.defer();
@@ -264,11 +235,10 @@ function deleteGradeformat(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    gradeformat_id: "string" //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticulargradeformatparams
+ */
 function getParticularGradeformat (options) {
   // Initializing promise
   var deferred = q.defer();
@@ -316,11 +286,10 @@ function getParticularGradeformat (options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    cursor: "string"
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getallgradeformatsparams
+ */
 function getAllGradeformats (options) {
   // Initializing promise
   var deferred = q.defer();
@@ -366,20 +335,8 @@ function getAllGradeformats (options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string',
- *   *body: {
- *     *grades: [{
- *       id: 'string',
- *       title: 'string',
- *       min_threshold: 'string',
- *       max_threshold: 'string',
- *       target: <boolean>
- *     }],
- *     data: {}
- *   }
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#associategradeformattoclassparams
  */
 function associateGradeformatToClass(options) {
   var self = this;
@@ -435,10 +392,8 @@ function associateGradeformatToClass(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#unassociategradeformatfromclassparams
  */
 function unassociateGradeformatFromClass(options) {
   var self = this;
@@ -490,20 +445,8 @@ function unassociateGradeformatFromClass(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string',
- *   *body: {
- *     grades: [{
- *       id: 'string',
- *       title: 'string',
- *       min_threshold: 'string',
- *       max_threshold: 'string',
- *       target: <boolean>
- *     }],
- *     data: {}
- *   }
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#updateclassgradeformatassociationparams
  */
 function updateClassGradeformatAssociation(options) {
   var self = this;
@@ -559,10 +502,8 @@ function updateClassGradeformatAssociation(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticulargradeformatofaclassparams
  */
 function getParticularGradeformatOfAClass(options) {
   var self = this;
@@ -613,10 +554,8 @@ function getParticularGradeformatOfAClass(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   cursor: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getallgradeformatsofaclassparams
  */
 function getAllGradeformatsOfAClass(options) {
   var self = this;
@@ -669,10 +608,8 @@ function getAllGradeformatsOfAClass(options) {
 }
 
 /**
- * @param {
- *   *gradeformat_id: 'string',
- *   cursor: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getclassesofagradeformatparams
  */
 function getClassesOfAGradeformat(options) {
   var self = this;
@@ -725,18 +662,10 @@ function getClassesOfAGradeformat(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    assignedpathid: "string",  //Mandatory
-    classid: "string",         // Mandatory
-    body : [                   // min:1 , max: 50
-      {
-        extUserId: "string", //Mandatory
-      }.
-      ....
-    ]
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#createuserassignedpathenrollmentsparams
+ */
 function createUserAssignedPathEnrollments(options) {
   var self = this;
   // Initializing promise
@@ -786,18 +715,10 @@ function createUserAssignedPathEnrollments(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    assignedpathid: "string",  // Mandatory
-    classid: "string",         // Mandatory
-    body : [                   // min:1 , max: 50
-      {
-        extUserId: "string", //Mandatory
-      },
-      ...
-    ]
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#deleteuserassignedpathenrollmentsparams
+ */
 function deleteUserAssignedPathEnrollments(options) {
   var self = this;
   // Initializing promise
@@ -848,11 +769,8 @@ function deleteUserAssignedPathEnrollments(options) {
 }
 
 /**
- * @param {
- *  classid: <string>,         // mandatory
- *  productDetails: <Boolean>,  // optional
- *  bundleDetails: <Boolean>    // optional
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticularclassv2params
  */
 function getParticularClassV2(options) {
   var self = this;
@@ -899,15 +817,8 @@ function getParticularClassV2(options) {
 }
 
 /**
- * @param {
- *  *productcode: "string",
- *  status: "string"             // ['active', 'revoked'] - default: 'active'
- *  expired: <boolean>,          // default: false
- *  startdate: <epoch>,
- *  enddate: <epoch>,
- *  audit: <boolean>             // [true] - default: true
- *  ext_data: {...},
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#createorgproductentitlementparams
  */
 function createOrgProductEntitlement(options) {
   var self = this;
@@ -953,15 +864,8 @@ function createOrgProductEntitlement(options) {
 }
 
 /**
- * @param {
- *  *productcode: "string",
- *  status: "string"             // ['active', 'revoked']
- *  expired: <boolean>,
- *  startdate: <epoch>,
- *  enddate: <epoch>,
- *  audit: <boolean>             // [true] - default: true
- *  ext_data: {...},
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#updateorgproductentitlementparams
  */
 function updateOrgProductEntitlement(options) {
   var self = this;
@@ -1009,73 +913,15 @@ function updateOrgProductEntitlement(options) {
 }
 
 /**
- * @param {
- *  *productcode: "string"
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticularorgproductentitlementparams
  */
 function getParticularOrgProductEntitlement(options) {
   var self = this;
   //Initializing promise
   var deferred = q.defer();
 
-  //Validations
-  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
-  if (error) {
-    deferred.reject(error);
-  } else {
-    if (options && options.productcode) {
-      // Passed all validations, Contruct the API URL
-      var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
-        self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
-      url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
-
-      // Setup request with URL and Query Params
-      var params = { productcode: options.productcode };
-      var requestAPI = request.get(url).query(params);
-
-      // Setup 'traceid' in request header
-      if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-      // Setup 'token' in Authorization header
-      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-
-      requestAPI.agent(keepaliveAgent).end(function (error, response) {
-        if (error) {
-          error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
-          deferred.reject(error);
-        } else {
-          deferred.resolve(response.body);
-        }
-      });
-    } else {
-      error = {};
-      error.message = error.description = 'Mandatory field \'productcode\' not found '+
-        'in request options.';
-      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
-      deferred.reject(error);
-    }
-  }
-
-  return deferred.promise;
-}
-
-/**
- * @param {
- *  status: "string"             // ['active', 'revoked']
- *  expired: <boolean>,
- *  cursor: <epoch>
- * } options
- */
-function getAllOrgProductEntitlements(options) {
-  var self = this;
-  //Initializing promise
-  var deferred = q.defer();
-
-  //Validations
-  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
-  if (error) {
-    deferred.reject(error);
-  } else {
+  if (options && options.productcode) {
     // Passed all validations, Contruct the API URL
     var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
       self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
@@ -1083,19 +929,11 @@ function getAllOrgProductEntitlements(options) {
 
     // Setup request with URL and Query Params
     var params = { productcode: options.productcode };
-
-    if (options.status) { params.status = options.status; }
-    if (options.hasOwnProperty('expired')) { params.expired = options.expired; }
-    if (options.cursor) { params.cursor = options.cursor; }
-
     var requestAPI = request.get(url).query(params);
 
     // Setup 'traceid' in request header
     if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-    // Setup 'token' in Authorization header
-    requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-
     requestAPI.agent(keepaliveAgent).end(function (error, response) {
       if (error) {
         error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
@@ -1104,51 +942,51 @@ function getAllOrgProductEntitlements(options) {
         deferred.resolve(response.body);
       }
     });
+  } else {
+    var error = {};
+    error.message = error.description = 'Mandatory field \'productcode\' not found '+
+      'in request options.';
+    error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+    deferred.reject(error);
   }
 
   return deferred.promise;
 }
 
 /**
- * @param {
-*  ext_user_id: "string",        // mandatory
-*  workflow_type: "string",      // mandatory
-*  <workflow_type>: {}           // mandatory
-* } options
-*/
-function setupUser(options) {
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getallorgproductentitlementsparams
+ */
+function getAllOrgProductEntitlements(options) {
   var self = this;
   //Initializing promise
   var deferred = q.defer();
 
-  if(options && options.ext_user_id && options.workflow_type) {
-    //Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS.AUTHEXTN + self.config.AUTHEXTN_API_URLS.setupUser;
-    url = helpers.api.constructAPIUrl(url,  { accountId: self.accountId });
+  // Contruct the API URL
+  var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+    self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
+  url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
 
-    var requestAPI = request.post(url)
-    .set('Content-Type', 'application/json')
-    .set('Accept', 'application/json')
-    .send(options);
+  // Setup request with URL and Query Params
+  var params = { productcode: options.productcode };
 
-    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+  if (options.status) { params.status = options.status; }
+  if (options.hasOwnProperty('expired')) { params.expired = options.expired; }
+  if (options.cursor) { params.cursor = options.cursor; }
 
-    requestAPI
-    .agent(keepaliveAgent)
-    .end(function(err, res) {
-      if(err) {
-          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-          deferred.reject(err);
-      } else {
-        deferred.resolve(res.body);
-      }
-    });
-  } else {
-    err = {};
-    err.message = err.description = 'Mandatory field \'ext_user_id\' or \'workflow_type\' not found '+
-      'in the request options.';
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    deferred.reject(err);
-  }
-return deferred.promise;
+  var requestAPI = request.get(url).query(params);
+
+  // Setup 'traceid' in request header
+  if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+  requestAPI.agent(keepaliveAgent).end(function (error, response) {
+    if (error) {
+      error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+      deferred.reject(error);
+    } else {
+      deferred.resolve(response.body);
+    }
+  });
+
+  return deferred.promise;
 }

package/lib/services/datasyncmanager/index.js

@@ -30,9 +30,6 @@ var Agent = require('agentkeepalive');
 var helpers = require('../../helpers');
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = datasyncmanager;
 
 var keepaliveAgent = new Agent({
@@ -53,22 +50,8 @@ function datasyncmanager(accountId) {
 }
 
 /**
- * options = {
- * "*body": {
- *  "*dsmid": "string",
- *  "dsm_groupid": "string",
- *  "rules_orgs": [{"*id": "string"}, ...],
- *  "rules_products": [{
- *    "*productcode": "string",
- *    "*ext_entitlement_meta": { "start_date", "*end_date" },
- *    "*target_roles": [role]
- *  }],
- *  "*category": "entitlement_sync",
- *  "*type": "managed",
- *  "*ext_user_id": "string",
- *  "data": {},
- *  "*audit": true
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#createdatasyncmanagerparams
  */
 function createDataSyncManager(options) {
   var self = this;
@@ -109,20 +92,8 @@ function createDataSyncManager(options) {
  }
 
 /**
- * options = {
- *   "*dsmid": "datasyncmanagerid",
- *   "*body": {
- *     "rules_orgs": [{ "*id": "orgid" }, ...],
- *     "*rules_products": [{
- *       "*productcode": "<productcode-1>",
- *       "*ext_entitlement_meta": { "start_date", "*end_date" },
- *       "target_roles": ["role"],
- *     }],
- *     "*ext_user_id": "ext_actor_id",
- *     "data": {},
- *     "*audit": <boolean>
- *   }
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#updatedatasyncmanagerparams
  */
 function updateDataSyncManager(options) {
   // Initializing promise
@@ -171,12 +142,8 @@ function updateDataSyncManager(options) {
 }
 
 /**
- * options = {
- * "*dsmid": "string",
- * "*body": {
- *  "*ext_user_id": "string",
- *  "*audit": true
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#deletedatasyncmanagerparams
  */
 function deleteDataSyncManager(options) {
   var self = this;
@@ -216,9 +183,8 @@ function deleteDataSyncManager(options) {
 }
 
 /**
- * options = {
- *   "*dsmid": "datasyncmanagerid"
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#getparticulardatasyncmanagerparams
  */
 function getParticularDataSyncManager(options) {
   // Initializing promise
@@ -263,9 +229,8 @@ function getParticularDataSyncManager(options) {
 }
 
 /**
- * options = {
- *   "*dsm_groupid": "datasyncmanagergroupid"
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#getalldatasyncmanagersofagroupparams
  */
 function getAllDataSyncManagersOfAGroup(options) {
   // Initializing promise