comprodls-sdk 2.58.0 → 2.59.0

package/lib/config/index.js

@@ -40,9 +40,6 @@ exports.REALM_HOSTS = {
       ANALYTICS: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-analytics',
       INTEGRATION: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-integrations',
       DRIVE: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-drive'
-    },
-    DEVELOPMENT: {
-      ANALYTICS: 'http://localhost:4000'
     }
   },
   ASGARD: {
@@ -240,7 +237,11 @@ exports.AUTHEXTN_API_URLS = {
     gradeformatClasses: '/org/{orgid}/gradeformats/{gradeformat_id}/classes',
 
     //Space related API
-    entitleBulkUsersToProducts: '/accounts/{accountid}/entitle-users/bulk'
+    entitleBulkUsersToProducts: '/accounts/{accountid}/entitle-users/bulk',
+
+    // Assigned Path APIs
+    userAssignedPaths: '/org/{orgid}/classes/{classid}/assigned-paths/{assignedpathid}/enroll-user/multi'
+
 };
 
 exports.ACTIVITY_API_URLS = {

package/lib/services/analytics/index.js

@@ -1604,9 +1604,7 @@ function getAssignedPathAnalytics(options) {
     "status_not_started": <boolean>,
     "status_expired": <boolean>,
     "progress" : "true/false",
-    "group" : "true/false",
-    "limit": integer,    // Number of entities to be fetched
-    "cursor": "string"   // cursor to get next set of assignments
+    "group" : "true/false"
   };
 */
 function getMyAssignedPathsOfClass(options) {
@@ -1628,8 +1626,6 @@ function getMyAssignedPathsOfClass(options) {
       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; }
-      if(options.limit) { queryParams.limit =  options.limit; }
-      if(options.cursor) { queryParams.cursor =  options.cursor; }
 
       // Setup request with URL and Params
       var requestAPI = request.get(url).query(queryParams);

package/lib/services/auth/index.js

@@ -1961,6 +1961,7 @@ function createClass(options) {
             if(options.class_ownership){ params.class_ownership = options.class_ownership; }
             if(options.ext_data){ params.ext_data = options.ext_data; }
             if(options.analyticsharingmodel){ params.analyticsharingmodel = options.analyticsharingmodel; }
+            if(options.limits){ params.limits = options.limits; }
 
             //Setup request with URL and Params
             var requestAPI = request.post(url).send(params);
@@ -2242,6 +2243,7 @@ options = {
   "classid": "classid", //mandatory
   "data": {
     "title": "assigned path title", //mandatory
+    "scope": "string", //optional, default=global , ['global', 'users']
     "ext_assignedpathid": 'string', //optional
     "duedate": "epoch due date", //mandatory
     "startdate": "epoch start date", //optional
@@ -2354,6 +2356,7 @@ function deleteAssignedPath(options) {
     assignedpathid: 'string' //mandatory
     data: {
       title: 'string' //optional
+      scope: 'string' //optional, ['global', 'users']
       startdate: 'string' //optional
       duedate: 'string' //optional
       items: [  //optional

package/lib/services/authextn/index.js

@@ -53,7 +53,9 @@ function authextn() {
     updateClassGradeformatAssociation: updateClassGradeformatAssociation.bind(this),
     getParticularGradeformatOfAClass: getParticularGradeformatOfAClass.bind(this),
     getAllGradeformatsOfAClass: getAllGradeformatsOfAClass.bind(this),
-    getClassesOfAGradeformat: getClassesOfAGradeformat.bind(this)
+    getClassesOfAGradeformat: getClassesOfAGradeformat.bind(this),
+    createUserAssignedPathEnrollments: createUserAssignedPathEnrollments.bind(this),
+    deleteUserAssignedPathEnrollments: deleteUserAssignedPathEnrollments.bind(this)
   };
 }
 
@@ -707,3 +709,125 @@ function getClassesOfAGradeformat(options) {
 
   return deferred.promise;
 }
+
+/*
+  options = {
+    assignedpathid: "string",  //Mandatory
+    classid: "string",         // Mandatory
+    body : [                   // min:1 , max: 50
+      {
+        extUserId: "string", //Mandatory
+      }.
+      ....
+    ]
+  }
+*/
+function createUserAssignedPathEnrollments(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+
+  //Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(error) {
+      dfd.reject(error);
+  } else {
+    if(options && options.classid && options.assignedpathid && options.body) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+        self.config.AUTHEXTN_API_URLS.userAssignedPaths;
+      url = helpers.api.constructAPIUrl(url, {
+        orgid: self.orgId,
+        classid: options.classid,
+        assignedpathid: options.assignedpathid,
+      });
+
+      var requestAPI = request.post(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options.body);
+      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) {
+            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: classid, assignedpathid, body' +
+        ' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+  return dfd.promise;
+}
+
+/*
+  options = {
+    assignedpathid: "string",  // Mandatory
+    classid: "string",         // Mandatory
+    body : [                   // min:1 , max: 50
+      {
+        extUserId: "string", //Mandatory
+      },
+      ...
+    ]
+  }
+*/
+function deleteUserAssignedPathEnrollments(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+
+  //Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(error) {
+      dfd.reject(error);
+  } else {
+    if(options && options.classid && options.assignedpathid && options.body) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+        self.config.AUTHEXTN_API_URLS.userAssignedPaths;
+      url = helpers.api.constructAPIUrl(url, {
+        orgid: self.orgId,
+        classid: options.classid,
+        assignedpathid: options.assignedpathid,
+      });
+
+      var requestAPI = request.delete(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options.body);
+      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) {
+            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: classid, assignedpathid, body' +
+        ' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+  return dfd.promise;
+}

package/lib/services/spaces/index.js

@@ -538,6 +538,7 @@ function provisionBulkSpaces(options) {
  *     *src_ext_classid: 'string',
  *     products: boolean,
  *     assigned_paths: boolean,
+ *     ext_assigned_path_id_rule: 'string'  //enum: ['SRC_ID']
  *     advanced: {
  *       assigned_paths: [                  //length > 0 if assigned_paths flag is true
  *         {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.58.0",
+  "version": "2.59.0",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"