comprodls-sdk 2.48.0 → 2.50.0

package/lib/config/index.js

@@ -131,6 +131,7 @@ exports.AUTH_API_URLS = {
     getSettingsField: '/org/{orgId}/settings/{field}',
     getClassUsersAPI: '/org/{orgId}/class/{classId}/users',
     getUserClassesAPI: '/org/{orgId}/users/{userId}/classes',
+    getUserClassesV2API: '/org/{orgid}/users/{userid}/class-enrollments',
     getAllJobs: '/accounts/{accountId}/ext-users/{extUserId}/jobs',
     getJob: '/accounts/{accountId}/ext-users/{extUserId}/jobs/{jobId}',
     getAllClassesAPI: '/org/{orgId}/classes',

package/lib/services/auth/index.js

@@ -53,6 +53,7 @@ function auth() {
     deleteUserProfile: deleteUserProfile.bind(this),
     updateUserRole: updateUserRole.bind(this),
     getUserClasses: getUserClasses.bind(this),
+    getUserClassesV2: getUserClassesV2.bind(this),
     getClassUsers: getClassUsers.bind(this),
     enrollUsertoClass: enrollUsertoClass.bind(this),
     enrollSelftoClass: enrollSelftoClass.bind(this),
@@ -692,6 +693,78 @@ function getUserClasses(options) {
   return dfd.promise;
 }
 
+/**
+ * @param {
+ *  userid: 'uuid or username', // Mandatory
+ *  shadow: true/false,         // Optional, filter shadow enrollments
+ *  status_active: true/false,  // Optional, filter for status_active enrollments
+ *  status_ended: true/false,   // Optional, filter for status_ended enrollments
+ *  status_expired: true/false, // Optional, filter for status_expired enrollments
+ *  details: true/false,        // Optional, includes products & meta information of classes
+ *  bundleDetails: true/false   // Optional, includes products, bundles & meta information of classes
+ *  limit: integer,             // Optional, Number of entities to be fetched
+ *  cursor: 'cursor'            // Optional, cursor to get next set of enrollments
+ * } options
+ */
+function getUserClassesV2(options) {
+  var self = this, orgId = self.orgId, token = self.token;
+
+  // Initializing promise
+  var deferred = q.defer();
+
+  // Validations
+  var error = helpers.validations.isAuthenticated(orgId, token);
+
+  if (error) {
+    deferred.reject(error);
+  } else if (options && options.userid) {
+    var userId = options.userid;
+
+    // Passed all validations, Construct API url
+    var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.getUserClassesV2API;
+    url = helpers.api.constructAPIUrl(url, { orgid: orgId, userid: userId });
+
+    // Contruct query parameters
+    var params = {};
+    if (options) {
+      if (options.shadow ) { params.shadow  = options.shadow ; }
+      if (options.status_active ) { params.status_active  = options.status_active ; }
+      if (options.status_ended ) { params.status_ended  = options.status_ended ; }
+      if (options.status_expired ) { params.status_expired  = options.status_expired ; }
+      if (options.details) { params.details = options.details; }
+      if (options.bundleDetails) { params.bundleDetails = options.bundleDetails; }
+      if (options.limit) { params.limit = options.limit; }
+      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); }
+
+    // Setup token in Authorization header
+    requestAPI = helpers.api.setupAPIToken(requestAPI, token);
+
+    // Call GET User Class-Enrollments API
+    requestAPI
+    .agent(keepaliveAgent)
+    .end(function(error, response) {
+      if (error) {
+        error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+        deferred.reject(error);
+      } else {
+        deferred.resolve(response.body);
+      }
+    });
+  } else {
+    error = {};
+    error.message = error.description = 'Required parameter \'userid\' is not found in request options.';
+    error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+    deferred.reject(error);
+  }
+
+  return deferred.promise;
+}
+
 /**
  * options = {
  *    classid: 'classid',

package/package.json

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