comprodls-sdk 2.34.1 → 2.34.3

package/dist/comprodls-sdk.js

@@ -397,6 +397,8 @@ exports.ANALYTICS_API_URLS = {
     getClassRecordUserAggregations: '/{orgId}/class/product/user-aggregations',
     getUserClassRecentSubmissions: '/{orgId}/user/product/class/recent-submissions',
     appState: '/{orgId}/user/product/progress/state',
+    getUserProductAllState: '/{orgid}/user/product/progress/state/all',
+    updateUserProductMultiState: '/{orgid}/user/product/progress/state/multi',
 
     //AssignedPaths Related APIs
     getAllAssignedPathsOfClass: '/{orgId}/class/assigned-paths',
@@ -1974,10 +1976,14 @@ function analytics() {
     getUserClassRecentSubmissions: getUserClassRecentSubmissions.bind(this),
     getStudentsWithEvaluatedOnce: getStudentsWithEvaluatedOnce.bind(this),
 
+    // user-state api
     getAppState: getAppState.bind(this),
     updateAppState: updateAppState.bind(this),
     deleteAppState: deleteAppState.bind(this),
 
+    getUserProductAllState: getUserProductAllState.bind(this),
+    updateUserProductMultiState: updateUserProductMultiState.bind(this),
+
     getQuestionProgressByLearningObjective: getQuestionProgressByLearningObjective.bind(this),
 
     //AssignedPaths Related APIs
@@ -2628,6 +2634,115 @@ function deleteAppState(options) {
 	return dfd.promise;
 }
 
+/** This function is used to get state of single item if itemcode is given, otherwise if the 
+    item code is not given then it will return state of all items and product state.
+options = {
+  userid: <userid>,
+  productcode: <productcode>,
+  classid: <classid>, // OPTIONAL
+  itemcode: <itemcode> // OPTIONAL
+  model: <string> // OPTIONAL
+  key: <string> // OPTIONAL
+}
+*/
+function getUserProductAllState(options) {
+  var self = this;
+  var dfd = q.defer();
+  // Validations
+  var err = {};
+  if(options && options.userid && options.productcode) {
+    err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err) { dfd.reject(err); }
+    else {
+      // Passed all validations, Construct API url
+      var url = self.config.DEFAULT_HOSTS.ANALYTICS + self.config.ANALYTICS_API_URLS.getUserProductAllState;
+      url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+
+      var params = { userid: options.userid, productcode: options.productcode };
+      if(options.classid) { params.classid = options.classid; }
+      if(options.itemcode) { params.itemcode = options.itemcode; }
+      if(options.model) { params.model = options.model; }
+      if(options.key) { params.key = options.key; }
+
+      // Setup request with URL and Params
+      var requestAPI = request.get(url).query(params);
+
+      // Setup token in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      // setting up traceid
+      if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+      // Call User State GET 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 = "Required parameters 'userid' or " +
+                                "'productcode' are not found in request options";
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+  }
+  return dfd.promise;
+}
+
+/*options = {
+  userid: <userid>,
+  productcode: <productcode>,
+  classid: <classid>, // OPTIONAL
+  data: <object>,
+}*/
+function updateUserProductMultiState(options) {
+  var self = this;
+  var dfd = q.defer();
+  // Validations
+  var err = {};
+  if(options && options.userid && options.productcode && options.data) {
+    err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err) { dfd.reject(err); }
+    else {
+      // Passed all validations, Construct API url
+      var url = self.config.DEFAULT_HOSTS.ANALYTICS +
+      self.config.ANALYTICS_API_URLS.updateUserProductMultiState;
+      url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+
+      var params = { userid: options.userid, productcode: options.productcode };
+      if(options.classid) { params.classid = options.classid; }
+
+      // Setup request with URL and Params
+      var requestAPI = request.put(url).query(params)
+                       .set('Content-Type', 'application/json')
+                       .set('Accept', 'application/json')
+                       .send(options.data);
+
+      // Setup token in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      // setting up traceid
+      if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+      // Call Product Timespent 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); }
+      });
+    }
+  } else {
+      err.message = err.description = "Required parameters 'userid' or 'data'" +
+                            " or 'productcode' are not found in request options";
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+  }
+  return dfd.promise;
+}
 
 /**
  * This function returns the recent pending submissions in a Class for a Product.
@@ -3560,7 +3675,8 @@ function postProgressTimeseries(options) {
     dfd.reject(err);
   }
   return dfd.promise;
-}
+}
+
 },{"../../helpers":3,"agentkeepalive":38,"q":90,"superagent":133}],15:[function(require,module,exports){
 /*************************************************************************
  *