comprodls-sdk 2.64.1 → 2.67.0

package/dist/comprodls-sdk.js

@@ -396,7 +396,11 @@ exports.AUTHEXTN_API_URLS = {
     userAssignedPaths: '/org/{orgid}/classes/{classid}/assigned-paths/{assignedpathid}/enroll-user/multi',
 
     // Class related APIs
-    particularClass: '/org/{orgId}/classes/{classId}'
+    particularClass: '/org/{orgId}/classes/{classId}',
+
+    // Org Entitlement related APIs
+    orgProductEntitlement: '/org/{orgid}/org-entitlements',
+    setupUser: '/accounts/{accountId}/user/setup'
 
 };
 
@@ -8714,8 +8718,10 @@ var keepaliveAgent = new Agent({
 });
 
 //AuthExtn Adaptor Contsructor
-function authextn() {
+function authextn(accountId) {
+  this.accountId = accountId;
   return {
+    // Gradeformat related APIs
     createGradeformat: createGradeformat.bind(this),
     updateGradeformat: updateGradeformat.bind(this),
     deleteGradeformat: deleteGradeformat.bind(this),
@@ -8727,9 +8733,21 @@ function authextn() {
     getParticularGradeformatOfAClass: getParticularGradeformatOfAClass.bind(this),
     getAllGradeformatsOfAClass: getAllGradeformatsOfAClass.bind(this),
     getClassesOfAGradeformat: getClassesOfAGradeformat.bind(this),
+
+    // Assigned-path related APIs
     createUserAssignedPathEnrollments: createUserAssignedPathEnrollments.bind(this),
     deleteUserAssignedPathEnrollments: deleteUserAssignedPathEnrollments.bind(this),
-    getParticularClassV2: getParticularClassV2.bind(this)
+
+    // Class related APIs
+    getParticularClassV2: getParticularClassV2.bind(this),
+
+    // Org Entitlement related APIs
+    createOrgProductEntitlement: createOrgProductEntitlement.bind(this),
+    updateOrgProductEntitlement: updateOrgProductEntitlement.bind(this),
+    getParticularOrgProductEntitlement: getParticularOrgProductEntitlement.bind(this),
+    getAllOrgProductEntitlements: getAllOrgProductEntitlements.bind(this),
+    setupUser: setupUser.bind(this)
+
   };
 }
 
@@ -9556,6 +9574,247 @@ function getParticularClassV2(options) {
 
   return deferred.promise;
 }
+
+/**
+ * @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
+ */
+function createOrgProductEntitlement(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+
+  if (options && options.productcode) {
+    // Passed all validations, Contruct 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);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+      .agent(keepaliveAgent)
+      .end(function(error, response) {
+        if (error) {
+          var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          dfd.reject(err);
+        }
+        else { dfd.resolve(response.body); }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'Mandatory param: productcode not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+
+  return dfd.promise;
+}
+
+/**
+ * @param {
+ *  *productcode: "string",
+ *  status: "string"             // ['active', 'revoked']
+ *  expired: <boolean>,
+ *  startdate: <epoch>,
+ *  enddate: <epoch>,
+ *  audit: <boolean>             // [true] - default: true
+ *  ext_data: {...},
+ * } options
+ */
+function updateOrgProductEntitlement(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+
+  if (options && options.productcode) {
+    // Passed all validations, Contruct 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.put(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+      .agent(keepaliveAgent)
+      .end(function(error, response) {
+        if (error) {
+          var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          dfd.reject(err);
+        }
+        else { dfd.resolve(response.body); }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'Mandatory param: productcode not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+
+  return dfd.promise;
+}
+
+/**
+ * @param {
+ *  *productcode: "string"
+ * } options
+ */
+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 {
+    // 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 };
+
+    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);
+        deferred.reject(error);
+      } else {
+        deferred.resolve(response.body);
+      }
+    });
+  }
+
+  return deferred.promise;
+}
+
+/**
+ * @param {
+*  ext_user_id: "string",        // mandatory
+*  workflow_type: "string",      // mandatory 
+*  <workflow_type>: {}           // mandatory
+* } options
+*/
+function setupUser(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 });
+
+    var requestAPI = request.post(url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .send(options);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    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;
+}
 
 },{"../../helpers":3,"agentkeepalive":36,"q":46,"superagent":49}],18:[function(require,module,exports){
 /*************************************************************************