comprodls-sdk 2.111.0-thor.1 → 2.112.0-thor.1

package/dist/comprodls-sdk.js

@@ -416,7 +416,11 @@ exports.ANALYTICS_API_URLS = {
   getClassCustomComponentUserSubmission: '/{orgId}/class/custom-component/class-record/evaluations',
 
   //CrossProductAggregation Related APIs
-  getCrossProductAggregation: '/{orgId}/class/cross-product-aggregation'
+  getCrossProductAggregation: '/{orgId}/class/cross-product-aggregation',
+
+  // MAP Aggregation Related APIs
+  getStudentAggregation: '/{orgId}/student/aggregation',
+  getTeacherAggregation: '/{orgId}/teacher/aggregation'
 };
 
 exports.PRODUCT_API_URLS = {
@@ -470,7 +474,8 @@ exports.INTEGRATIONS_API_URLS = {
   auditTrail: '/accounts/{accountId}/audit-trail',
   customEvents: '/accounts/{accountId}/custom-events',
   schedules: '/accounts/{accountId}/context/{context}/schedule',
-  particularSchedule: '/accounts/{accountId}/context/{context}/schedule/{scheduleId}'
+  particularSchedule: '/accounts/{accountId}/context/{context}/schedule/{scheduleId}',
+  lifecycleEvents: '/accounts/{accountId}/lifecycle-events'
 };
 
 exports.DRIVE_API_URLS = {
@@ -1327,6 +1332,7 @@ var q = require('q');
 var request = require('superagent');
 var Agent = require('agentkeepalive');
 
+var requestLayer = require('../../helpers/lib/requestLayer');
 var helpers = require('../../helpers');
 var DLSError = helpers.errors.DLSError;
 
@@ -1373,7 +1379,11 @@ function analytics() {
     getClassCustomComponentUserSubmission: getClassCustomComponentUserSubmission.bind(this),
 
     //CrossProductAggregation Related APIs
-    getCrossProductAggregation: getCrossProductAggregation.bind(this)
+    getCrossProductAggregation: getCrossProductAggregation.bind(this),
+
+    //MAP Aggregation Related APIs
+    getStudentAggregation: getStudentAggregation.bind(this),
+    getTeacherAggregation: getTeacherAggregation.bind(this)
   };
 }
 
@@ -2663,8 +2673,85 @@ function getCrossProductAggregation(options) {
   }
   return dfd.promise;
 }
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/06_ANALYTICS-Adapter#getstudentaggregationparams
+ */
+function getStudentAggregation(options) {
+  var self = this;
+
+  let err = {};
+
+  // Validations
+  if(!(options && options.studentid && options.courseid)) {
+    err.message = err.description = 'Mandatory params: studentid/courseid' +
+      ' not found in request options.';
+    return Promise.reject(new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err));
+  } else {
+    // Passed all validations, Constructing URL
+    var url = self.config.DEFAULT_HOSTS.ANALYTICS + 
+              self.config.ANALYTICS_API_URLS.getStudentAggregation;
+    url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+
+    // Setup Query Params
+    var queryParams = { courseId: options.courseid, studentId: options.studentid };
+
+    // Prepare request parameters & execute request
+    let reqOptions = {
+      params: queryParams,
+      headers: { traceid: self.traceid, token: self.token }
+    };
+    return requestLayer.get(url, reqOptions)
+    .then(function (response) {
+      return response.body;
+    })
+    .catch(function (err) {
+      throw new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+    });
+  }
+
+}
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/06_ANALYTICS-Adapter#getteacheraggregationparams
+ */
+function getTeacherAggregation(options) {
+  var self = this;
+
+  let err = {};
+
+  // Validations
+  if(!(options && options.teacherid)) {
+    err.message = err.description = 'Mandatory params: teacherid not found in request options.';
+    return Promise.reject(new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err));
+  } else {
+    // Passed all validations, Constructing URL
+    var url = self.config.DEFAULT_HOSTS.ANALYTICS +
+              self.config.ANALYTICS_API_URLS.getTeacherAggregation;
+    url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+
+    // Setup Query Params
+    var queryParams = { teacherId: options.teacherid, studentId: options.studentid };
+
+    // Prepare request parameters & execute request
+    let reqOptions = {
+      params: queryParams,
+      headers: { traceid: self.traceid, token: self.token }
+    };
+    return requestLayer.get(url, reqOptions)
+    .then(function (response) {
+      return response.body;
+    })
+    .catch(function (err) {
+      throw new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+    });
+  }
+
+}
 
-},{"../../helpers":3,"agentkeepalive":31,"q":36,"superagent":39}],11:[function(require,module,exports){
+},{"../../helpers":3,"../../helpers/lib/requestLayer":7,"agentkeepalive":31,"q":36,"superagent":39}],11:[function(require,module,exports){
 /*************************************************************************
  *
  * COMPRO CONFIDENTIAL
@@ -8378,6 +8465,7 @@ var q = require('q');
 var request = require('superagent');
 var Agent = require('agentkeepalive');
 
+var requestLayer = require('../../helpers/lib/requestLayer');
 var helpers = require('../../helpers');
 var converter = require('../../helpers/lib/api/converter');
 
@@ -8403,7 +8491,8 @@ function integrations(accountId) {
     createSchedule: createSchedule.bind(this),
     getSchedule: getSchedule.bind(this),
     updateSchedule: updateSchedule.bind(this),
-    deleteSchedule: deleteSchedule.bind(this)
+    deleteSchedule: deleteSchedule.bind(this),
+    publishLifecycleEvent: publishLifecycleEvent.bind(this)
   };
 }
 
@@ -8829,8 +8918,44 @@ function deleteSchedule(options) {
 
   return deferred.promise;
 }
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#publishlifecycleeventparams
+ */
+function publishLifecycleEvent(options) {
+  let self = this;
+
+  // Validate productcode
+  if (!(options && options.category && options.action && options.timestamp &&
+      options.data && options.ext_actor_id)) {
+    let err = {};
+    err.message = err.description = 'Mandatory params: category/action/timestamp' +
+      '/data/ext_actor_id not found in request options.';
+    return Promise.reject(new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err));
+  }
+
+  // Construct API URL
+  let url = helpers.api.constructAPIUrl(
+    self.config.DEFAULT_HOSTS.INTEGRATION + self.config.INTEGRATIONS_API_URLS.lifecycleEvents,
+    { accountId: self.accountId }
+  );
+
+  // Prepare request parameters & execute request
+  let reqOptions = {
+    params: options,
+    headers: { traceid: self.traceid }
+  };
+  return requestLayer.post(url, reqOptions)
+  .then(function (response) {
+    return response.body;
+  })
+  .catch(function (err) {
+    throw new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+  });
+}
 
-},{"../../helpers":3,"../../helpers/lib/api/converter":4,"agentkeepalive":31,"q":36,"superagent":39}],17:[function(require,module,exports){
+},{"../../helpers":3,"../../helpers/lib/api/converter":4,"../../helpers/lib/requestLayer":7,"agentkeepalive":31,"q":36,"superagent":39}],17:[function(require,module,exports){
 /*************************************************************************
  *
  * COMPRO CONFIDENTIAL