comprodls-sdk 2.55.1 → 2.56.0

package/dist/comprodls-sdk.js

@@ -437,7 +437,10 @@ exports.ANALYTICS_API_URLS = {
 
     //ClassCustomComponentRecord Related APIs
     getClassCustomComponentRecord: '/{orgId}/class/custom-component/class-record',
-    getClassCustomComponentUserSubmission: '/{orgId}/class/custom-component/class-record/evaluations'
+    getClassCustomComponentUserSubmission: '/{orgId}/class/custom-component/class-record/evaluations',
+
+    //CrossProductAggregation Related APIs
+    getCrossProductAggregation: '/{orgId}/class/cross-product-aggregation'
 };
 
 exports.COLLAB_API_URLS = {
@@ -2026,7 +2029,10 @@ function analytics() {
 
     //ClassCustomComponentRecord Related APIs
     getClassCustomComponentRecord: getClassCustomComponentRecord.bind(this),
-    getClassCustomComponentUserSubmission: getClassCustomComponentUserSubmission.bind(this)
+    getClassCustomComponentUserSubmission: getClassCustomComponentUserSubmission.bind(this),
+
+    //CrossProductAggregation Related APIs
+    getCrossProductAggregation: getCrossProductAggregation.bind(this)
   };
 }
 
@@ -3420,6 +3426,9 @@ function getQuestionProgressByLearningObjective(questionsArray) {
 
 /* options = {
     "classid": "string", // required
+    "status_active": <boolean>,
+    "status_not_started": <boolean>,
+    "status_expired": <boolean>
   };
 */
 function getAllAssignedPathsOfClass(options) {
@@ -3435,7 +3444,12 @@ function getAllAssignedPathsOfClass(options) {
       var url = self.config.DEFAULT_HOSTS.ANALYTICS + self.config.ANALYTICS_API_URLS.getAllAssignedPathsOfClass;
       url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
 
-      var queryParams = { classid: options.classid };
+      var queryParams = {
+        classid: options.classid,
+        status_not_started: options.status_not_started,
+        status_active: options.status_active,
+        status_expired: options.status_expired
+      };
 
       // Setup request with URL and Params
       var requestAPI = request.get(url).query(queryParams);
@@ -3519,6 +3533,9 @@ function getAssignedPathAnalytics(options) {
 /* options = {
     "classid": "string", // required
     "userid" : "string", // required
+    "status_active": <boolean>,
+    "status_not_started": <boolean>,
+    "status_expired": <boolean>,
     "progress" : "true/false",
     "group" : "true/false"
   };
@@ -3539,6 +3556,9 @@ function getMyAssignedPathsOfClass(options) {
       if(options.progress) { queryParams.progress =  options.progress; }
       if(options.group) { queryParams.group =  options.group; }
       if(options.expiredView) { queryParams.expiredView =  options.expiredView; }
+      if(options.status_not_started) { queryParams.status_not_started =  options.status_not_started; }
+      if(options.status_active) { queryParams.status_active =  options.status_active; }
+      if(options.status_expired) { queryParams.status_expired =  options.status_expired; }
 
       // Setup request with URL and Params
       var requestAPI = request.get(url).query(queryParams);
@@ -3833,6 +3853,57 @@ function postProgressTimeseries(options) {
   }
   return dfd.promise;
 }
+
+/*  This function will get cross product aggregation record for a class. This function can also return cross product
+ *  aggregation record for a particular userid(optional).
+ * options = {
+ *  classid: 'string',             // class uuid(mandatory)
+ *  userid:  'string'              // user uuid (optional)
+ *}
+ */
+ function getCrossProductAggregation(options) {
+  var self = this;
+
+  //Initializing DFD
+  var dfd = q.defer(), err = {};
+
+  // Validations
+  if(options && options.classid) {
+    err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err){ dfd.reject(err); }
+    else {
+      // Passed all validations, Constructing URL
+      var url = self.config.DEFAULT_HOSTS['ANALYTICS'] +  self.config.ANALYTICS_API_URLS.getCrossProductAggregation;
+      url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+
+      // Setup Query Params
+      var queryParams = { classid: options.classid };
+
+      if(options.userid) { queryParams.userid = options.userid };
+
+      // Setup Request with url and params
+      var requestAPI = request.get(url).query(queryParams);
+      // 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 GET CROSS PRODUCT AGGREGATION RECORD FOR A CLASS
+      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 = 'Required parameter classid not found in request options.';
+		err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+		dfd.reject(err);
+  }
+  return dfd.promise;
+}
 
 },{"../../helpers":3,"agentkeepalive":36,"q":46,"superagent":49}],15:[function(require,module,exports){
 /*************************************************************************
@@ -10082,6 +10153,7 @@ function getAllDocumentsInAFolder(options) {
       classid: 'string',
       productcode: 'string',      // mandatory
       dls_user_id: 'string',      // mandatory
+      collaborator_id: 'string'   // optional; mandatory if some OTHER user is updating this document.
       entities: [                 // mandatory (Min length 1)
         {
           item_code: 'string',
@@ -10141,6 +10213,7 @@ function createMultipleDocuments(options) {
     accountid: 'string',          // mandatory
     extuserid: 'string',          // mandatory
     body: {                       // mandatory
+      collaborator_id: 'string'   // optional; mandatory if some OTHER user is updating this document.
       entities: [                 // mandatory (Min length 1)
         {
           folderid: 'string',     // mandatory
@@ -13472,27 +13545,44 @@ function provisionBulkSpaces(options) {
 }
 
 /**
- * options = {
- *  ext_user_id: 'string',      // mandatory
- * "ext_role": "string",        // mandatory
- * "ext_first_name": "string",
- * "ext_last_name": "string",
- * "ext_email": "string",
- * "address": {
- *  "country": "string"
- * },
- * "ref_id": "string",
- * "ext_classid" : "string",
- * "ext_class_meta" :
- *  {
- *    "description": "string",
- *    "ext_data": {},
- *    "title": "string",       // mandatory
- *    "startdate": <epoch>,   // mandatory
- *    "enddate": <epoch>      // mandatory
+ * @param {
+ *   *ext_user_id: 'string',
+ *   *ext_role": 'string',
+ *   ext_first_name: 'string',
+ *   ext_last_name: 'string',
+ *   ext_email: 'string',
+ *   address: {
+ *     country:'string'
+ *   },
+ *   ref_id: 'string',
+ *   ext_classid : 'string',
+ *   ext_class_meta : {
+ *     *title: 'string',
+ *     *startdate: <epoch>,
+ *     *enddate: <epoch>,
+ *     description: 'string',
+ *     ext_data: {}
+ *   }
+ *  clone_settings: {
+ *    *src_ext_classid: 'string',
+ *    products: boolean,
+ *    assigned_paths: boolean,
+ *    advanced: {
+ *      assigned_paths: [                  //length > 0 if assigned_paths flag is true
+ *        {
+ *          *ext_assignedpathid: 'string',
+ *          *assigned_path_id: 'string',
+ *          startdate: 0,
+ *          *duedate: 0
+ *        },
+ *      ],
+ *      products: [
+ *        { *productcode: 'string' },
+ *      ]
+ *    }
  *  }
  * }
- **/
+ */
 function shadowProvision(options) {
   var self = this;
   //Initializing promise
@@ -13510,12 +13600,14 @@ function shadowProvision(options) {
     .send(options);
     if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-    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); }
+    requestAPI
+      .agent(keepaliveAgent)
+      .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 {