comprodls-sdk 2.14.0 → 2.18.0

package/dist/comprodls-sdk.js

@@ -316,6 +316,7 @@ exports.AUTH_API_URLS = {
     getParticularClassAPI: '/org/{orgId}/classes/{classId}',
     getParticularShadowClassAPI: '/org/{orgId}/shadow/classes/{extClassId}',
     classProductAssociation: '/org/{orgId}/classes/{classId}/associate-product/{productcode}',
+    multiClassProductAssociations: '/org/{orgId}/classes/{classId}/associate-product/multi',
     enrollUsertoClass: '/org/{orgId}/classes/{classId}/enroll-user/{userId}',
     enrollSelftoClass: '/org/{orgId}/classes/{classId}/enroll-self',
     enrollMultiUserstoClass: '/org/{orgId}/classes/{classId}/enroll-user/multi',
@@ -345,6 +346,7 @@ exports.AUTH_API_URLS = {
     getInvitationsByEmail: '/accounts/{accountid}/invitations-by-email',
     generateSpaceCode: '/accounts/{accountid}/space-code/generate',
     changeSpaceCode: '/accounts/{accountid}/space-code/{spacecode}/change',
+    updateInstituteTitle: '/accounts/{accountId}/institute-spaces/{instituteSpaceCode}',
 
     //Superuser related API
     getAllInstitutions: '/su/accounts/{accountid}/spaces',
@@ -422,7 +424,9 @@ exports.ANALYTICS_API_URLS = {
     //AssignedPaths Related APIs
     getAllAssignedPathsOfClass: '/{orgId}/class/assigned-paths',
     getMyAssignedPathsOfClass: '/{orgId}/user/class/assigned-paths',
-    getAssignedPathAnalytics: '/{orgId}/class/assigned-paths/aggregations'
+    getAssignedPathAnalytics: '/{orgId}/class/assigned-paths/aggregations',
+
+    getTimeseriesAnalytics: '/progress/timeseries'
 };
 
 exports.SISEVENTS_API_URLS = {
@@ -450,7 +454,8 @@ exports.PRODUCT_API_URLS = {
 
 exports.XAPI_API_URLS = {
     postMultiStatements: '/{orgId}/statements/multi',
-    postExternalMultiStatements: '/{orgId}/external/statements/multi'
+    postExternalMultiStatements: '/{orgId}/external/statements/multi',
+    resetUserProductProgress: '/accounts/{accountId}/progress/user/product/reset'
 };
 
 exports.ATTEMPTS_API_URLS = {
@@ -1982,7 +1987,9 @@ function analytics() {
     getAllAssignedPathsOfClass: getAllAssignedPathsOfClass.bind(this),
     getMyAssignedPathsOfClass: getMyAssignedPathsOfClass.bind(this),
     getAssignedPathAnalytics: getAssignedPathAnalytics.bind(this),
-    getMyParticularAssignedPathOfClass: getMyParticularAssignedPathOfClass.bind(this)
+    getMyParticularAssignedPathOfClass: getMyParticularAssignedPathOfClass.bind(this),
+    
+    getTimeseriesAnalytics: getTimeseriesAnalytics.bind(this)
   };
 }
 
@@ -3462,7 +3469,49 @@ function getMyParticularAssignedPathOfClass(options) {
   }
   return dfd.promise;
 }
-
+
+/*
+  options = {
+    query: 'string', //mandatory
+    cursor: 'string' //optional
+  }
+*/
+function getTimeseriesAnalytics(options) {
+  var self = this;
+  var dfd = q.defer();
+  var err;
+
+  if(options && options.query) {
+    //Passed all validations, Construct API url
+    var url = self.config.DEFAULT_HOSTS.ANALYTICS + self.config.ANALYTICS_API_URLS.getTimeseriesAnalytics;
+
+    // Contruct parameters
+    var params = {
+      query: options.query
+    };
+
+    if(options.cursor) { params.cursor =  options.cursor; }
+    //Setup request with URL and Params
+    var requestAPI = request.get(url).query(params);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI.end(function (error, response) {
+      if(error) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+        dfd.reject(err);
+      }
+      else { dfd.resolve(response.body); }
+    });
+  }
+  else {
+    err = {};
+    err.message = err.description = 'Mandatory params query not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+  return dfd.promise;
+}
 },{"../../helpers":3,"q":89,"superagent":132}],15:[function(require,module,exports){
 /*************************************************************************
  *
@@ -3877,6 +3926,7 @@ function auth() {
     getParticularShadowClass: getParticularShadowClass.bind(this),
     createClassProductAssociation: createClassProductAssociation.bind(this),
     removeClassProductAssociation: removeClassProductAssociation.bind(this),
+    createMultiClassProductAssociations: createMultiClassProductAssociations.bind(this),
     addItemsToShowcaseOfAClass: addItemsToShowcaseOfAClass.bind(this),
     deleteItemsFromShowcaseOfAClass: deleteItemsFromShowcaseOfAClass.bind(this),
 
@@ -4874,6 +4924,62 @@ function removeClassProductAssociation(options) {
   return dfd.promise;
 }
 
+/**
+ * This function creates multiple class-product associations.
+ * @param options {
+ *  *classId      : <string>,
+ *  *productcodes : [<string>] // Min: 1, Max: 50
+ * }
+ * Note: Fields marked with '*' are mandatory.
+ */
+function createMultiClassProductAssociations(options) {
+  var deferred = q.defer();
+  var self = this;
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+
+  if (error) {
+    deferred.reject(error);
+  } else if (options && options.classId && options.productcodes) {
+    // Passed all validations, Contruct API url
+    var defaultHostPath = self.config.DEFAULT_HOSTS.AUTH;
+    var bulkCPAssociationAPIPath = self.config.AUTH_API_URLS.multiClassProductAssociations;
+
+    var url = defaultHostPath + bulkCPAssociationAPIPath;
+    var bodyParams = { productcodes: options.productcodes };
+
+    url = helpers.api.constructAPIUrl(url, { orgId: self.orgId, classId: options.classId });
+
+    // Setup request with URL and Params
+    var requestAPI = request.post(url)
+                      .set('Content-Type', 'application/json')
+                      .set('Accept', 'application/json')
+                      .send(bodyParams);
+
+    if (self.traceid) {
+      requestAPI.set('X-Amzn-Trace-Id', self.traceid);
+    }
+
+    // Setup token in Authorization header
+    requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+    requestAPI.end(function(err, response) {
+      if (err) {
+        error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        deferred.reject(error);
+      } else {
+        deferred.resolve(response.body);
+      }
+    });
+  } else {
+    error = {};
+    error.message = error.description = 'Missing mandaotry fields \'classId\' or \'productcodes\' in request.';
+    error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+    deferred.reject(error);
+  }
+
+  return deferred.promise;
+}
+
 /*options = {
   classid: 'string'
 }*/
@@ -5291,8 +5397,9 @@ function encodeURLParameter(options) {
  * title: 'class title',
  * startdate: 'Epoch(Unix) timestamp in milliseconds',
  * enddate: 'Epoch(Unix) timestamp in milliseconds',
- * description: ''                          // Optional field
- * class_ownership: 'STRICT' / 'NO_OWNER'   // Default - STRICT, Optional field
+ * description: '',                          // Optional field
+ * class_ownership: 'STRICT' / 'NO_OWNER',   // Default - STRICT, Optional field
+ * ext_data: {}                              // Optional
  * }
  */
 function createClass(options) {
@@ -5352,7 +5459,8 @@ function createClass(options) {
 //    title: 'class title', //Optional field
 //    startdate: 'Epoch(Unix) timestamp in milliseconds', //Optional field
 //    enddate: 'Epoch(Unix) timestamp in milliseconds', //Optional field
-//    description: ''    //Optional field
+//    description: '',    //Optional field
+//    ext_data: ''        //Optional field
 //}
 function updateClass(options) {
     var self = this;
@@ -5403,13 +5511,14 @@ function updateClass(options) {
 /** options =
  *{
   "space_title": "string",
-  "classes": [ 
+  "classes": [
     {
       "title": "class tiltle",
       "startdate": 'Epoch(Unix) timestamp in milliseconds',
       "enddate": 'Epoch(Unix) timestamp in milliseconds',
       "rowId": 'string with max limit 3 characters,
       "description": "string",
+      "ext_data": {},                    // optional
       "model": "STRICT",
       "owner": {
         "userid": "string" //Mandatory if model is 'STRICT'
@@ -7370,6 +7479,7 @@ function invitations() {
         ext_user_id: 'string',
         first_name: 'string',  // required
         last_name: 'string',   // required
+        ext_data: {},
         rowId: 'string',       // required
         role: 'string'        /// required
       },...
@@ -9791,7 +9901,8 @@ function spaces(accountId) {
     getExtProduct: getExtProduct.bind(this),
     getSpaceDetails: getSpaceDetails.bind(this),
     updateUserInformation: updateUserInformation.bind(this),
-    getInvitationsByEmail: getInvitationsByEmail.bind(this)
+    getInvitationsByEmail: getInvitationsByEmail.bind(this),
+    updateInstituteTitle: updateInstituteTitle.bind(this)
   };
 }
 
@@ -10246,6 +10357,7 @@ function provisionBulkSpaces(options) {
  * "ext_class_meta" :
  *  {
  *    "description": "string",
+ *    "ext_data": {},
  *    "title": "string",       // mandatory
  *    "startdate": <epoch>,   // mandatory
  *    "enddate": <epoch>      // mandatory
@@ -10719,6 +10831,52 @@ function getInvitationsByEmail(options) {
 	}
 	return dfd.promise;
 }
+
+/**
+ * This API is used to update an institute's space title
+ * options = {
+ *   space_code: "",       // Mandatory, space code of institute whose title is to be updated
+ *   body : {
+ *     ext_actor_id: "",   // Mandatory
+ *     data: {
+ *       space_title: ""
+ *     }
+ *   }
+ * }
+ */
+function updateInstituteTitle(options){
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+  var err = {};
+  if (options && options.space_code && options.body && options.body.ext_actor_id ) {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.updateInstituteTitle;
+    url = helpers.api.constructAPIUrl(url,
+      { accountId: self.accountId, instituteSpaceCode: options.space_code });
+
+    // Setup request with URL and Params
+    var requestAPI = request.put(url)
+                    .set('Content-Type', 'application/json')
+                    .set('Accept', 'application/json')
+                    .send(options.body);
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI.end(function (error, response) {
+      if (error) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+        dfd.reject(err);
+      }
+      else { dfd.resolve(response.body); }
+    });
+  }
+  else {
+    err.message = err.description = 'space_code or ext_actor_id not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+  return dfd.promise;
+}
 
 },{"../../helpers":3,"q":89,"superagent":132}],29:[function(require,module,exports){
 /*************************************************************************
@@ -11404,10 +11562,12 @@ module.exports = xapi;
 /*********************************
  * Public Function definitions
  **********************************/
-function xapi() {
+function xapi(accountId) {
+  this.accountId = accountId;
   return {
     postStatement: postStatements.bind(this),
-    postExternalStatements: postExternalStatements.bind(this)
+    postExternalStatements: postExternalStatements.bind(this),
+    resetUserProductProgress: resetUserProductProgress.bind(this)
   };
 }
 
@@ -11596,6 +11756,47 @@ function postExternalStatements(options) {
   });
   return dfd.promise;
 }
+
+/*options = {
+    userid: 'string',
+    productcode: 'string',
+    actorid: 'string'
+}*/
+function resetUserProductProgress(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+  var err = {};
+  if(options && options.userid && options.productcode && options.actorid) {
+
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.XAPI + self.config.XAPI_API_URLS.resetUserProductProgress;
+    url = helpers.api.constructAPIUrl(url, { accountId : self.accountId });
+
+    // Setup request with URL and Params
+    var requestAPI = request.delete(url)
+                    .set('Content-Type', 'application/json')
+                    .set('Accept', 'application/json')
+                    .send(options);
+
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI.end(function(error, response) {
+      if(error) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+        dfd.reject(err);
+      }
+      else { dfd.resolve(response.body); }
+    });
+  }
+  else {
+    err.message = err.description = 'userid, productcode or actorid not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+
+  return dfd.promise;
+}
 
 },{"../../helpers":3,"q":89,"superagent":132}],32:[function(require,module,exports){
 /*************************************************************************