comprodls-sdk 2.107.0 → 2.108.0-thor.1

package/dist/comprodls-sdk.js

@@ -289,6 +289,7 @@ exports.AUTH_API_URLS = {
   validateSpaceCode: '/accounts/{accountid}/space-code/validate',
   validateClassCode: '/accounts/{accountid}/class-code/validate',
   joinInstituteSpace: '/accounts/{accountid}/join-institute-space',
+  provisionStudentInInstitutionalSpace: '/accounts/{accountid}/student/join-institute-space',
   provisionSpacesToStudent: '/accounts/{accountId}/student/provision-spaces',
   provisionSpacesToTeacher: '/accounts/{accountId}/teacher/provision-spaces',
   shadowProvision: '/org/{orgId}/shadow-provision',
@@ -371,6 +372,7 @@ exports.AUTHEXTN_API_URLS = {
 
   //Space related API
   entitleBulkUsersToProducts: '/accounts/{accountid}/entitle-users/bulk',
+  deleteUserAccount : '/accounts/{accountid}/ext-users/{ext_user_id}',
 
   // Assigned Path APIs
   userAssignedPaths: '/org/{orgid}/classes/{classid}/assigned-paths/{assignedpathid}/enroll-user/multi',
@@ -731,7 +733,9 @@ function setupAPIToken(request, token) {
 var ERROR_TYPES = {
   API_ERROR: 'API_ERROR',
   SDK_ERROR: 'SDK_ERROR',
-  CHANNEL_SUBSCRIPTION: 'CHANNEL_SUBSCRIPTION'
+  CHANNEL_SUBSCRIPTION: 'CHANNEL_SUBSCRIPTION',
+  UNEXPECTED_ERROR: 'UNEXPECTED_ERROR',
+  POLLING_INITIATION: 'POLLING_INITIATION'
 };
 
 var ERROR_CATEGORY = {
@@ -11300,39 +11304,45 @@ function changeSpaceCode(options) {
  */
 function joinInstituteSpace(options) {
   var self = this;
-  // Initializing promise
-  var dfd = q.defer();
-
-  if(options && options.ext_user_id &&
-      options.ext_role && options.space_code)
-  {
-    // Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS.AUTH +
-                               self.config.AUTH_API_URLS.joinInstituteSpace;
-    url = helpers.api.constructAPIUrl(url, { accountid : self.accountId });
 
-    // Setup request with URL and Params
-    var requestAPI = request.post(url)
-                     .set('Content-Type', 'application/json')
-                     .set('Accept', 'application/json')
-                     .send(options);
-    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+  return new Promise(function(resolve, reject) {
+    if (options && options.ext_user_id && options.ext_role) {
+      // Passed all validations, Contruct API url
 
-    requestAPI.end(function(error, response) {
-      if(error) {
-        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
-        dfd.reject(err);
+      var url;
+      if (options.ext_role === 'student') {
+        url = self.config.DEFAULT_HOSTS.AUTH +
+          self.config.AUTH_API_URLS.provisionStudentInInstitutionalSpace;
       }
-      else { dfd.resolve(response.body); }
-    });
-  } else {
-    var err = {};
-    err.message = err.description = 'ext_user_id or ext_role or space_code not found in request options.';
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
+      else {
+        url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.joinInstituteSpace;
+      }
+      url = helpers.api.constructAPIUrl(url, { accountid : self.accountId });
 
-  return dfd.promise;
+      // Setup request with URL and Params
+      var requestAPI = request.post(url)
+                     .set('Content-Type', 'application/json')
+                     .set('Accept', 'application/json');
+      if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+      requestAPI
+      .send(options)
+      .agent(keepaliveAgent)
+      .end(function(error, response) {
+        if (error) {
+          var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          reject(err);
+        }
+        else { resolve(response.body); }
+      });
+    } else {
+      var err = {};
+      err.message = err.description = 'ext_user_id or ext_role not found' +
+        ' in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      reject(err);
+    }
+  });
 }
 
 /**
@@ -11872,6 +11882,7 @@ function updateUserInformation(options) {
     };
     if(options.ref_id) { bodyParams.ref_id = options.ref_id; }
     if(options.ext_email) { bodyParams.ext_email = options.ext_email; }
+    if(options.ext_username) { bodyParams.ext_username = options.ext_username; }
     if(options.ext_first_name) { bodyParams.ext_first_name = options.ext_first_name; }
     if(options.ext_last_name) { bodyParams.ext_last_name = options.ext_last_name; }
     if(options.address) { bodyParams.address = options.address; }
@@ -12066,7 +12077,8 @@ function spacesextn(accountId) {
   this.accountId = accountId;
   return {
     entitleBulkUsersToProducts: entitleBulkUsersToProducts.bind(this),
-    setupUser: setupUser.bind(this)
+    setupUser: setupUser.bind(this),
+    deleteUserAccount : deleteUserAccount.bind(this)
   };
 }
 
@@ -12153,6 +12165,50 @@ function setupUser(options) {
   }
   return deferred.promise;
 }
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/04_AUTH-Adapter#getuserprofileparams
+ */
+function deleteUserAccount(options) {
+  var self = this;
+  return new Promise(function(resolve, reject) {
+
+    if (options.ext_user_id && options.body) {
+      //Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+        self.config.AUTHEXTN_API_URLS.deleteUserAccount;
+      url = helpers.api.constructAPIUrl(url, {
+        accountid: self.accountId,
+        ext_user_id: options.ext_user_id,
+      });
+
+      // Setup request
+      var requestAPI = request.delete(url)
+        .set('Content-Type', 'application/json')
+        .set('Accept', 'application/json');
+      if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+      requestAPI
+        .send(options.body)
+        .agent(keepaliveAgent)
+        .end(function(error, response) {
+          if (error) {
+            var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+            reject(err);
+          } else {
+            resolve(response.body);
+          }
+        });
+    } else {
+      var err = {};
+      err.description = 'Mandatory field \'ext_user_id\' or \'body\' in request options.';
+      err.message = err.description;
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      reject(err);
+    }
+  });
+}
 
 },{"../../helpers":3,"agentkeepalive":31,"q":36,"superagent":39}],25:[function(require,module,exports){
 /*************************************************************************
@@ -12184,6 +12240,7 @@ var q = require('q');
 var request = require('superagent');
 
 var helpers = require('../../helpers');
+var requestLayer = require('../../helpers/lib/requestLayer');
 
 var DLSError = helpers.errors.DLSError;
 
@@ -12205,34 +12262,32 @@ function superuser(accountId) {
  */
 function getAllInstitutions(options) {
   var self = this;
-  // Initializing promise
-  var dfd = q.defer();
 
-  var url = self.config.DEFAULT_HOSTS.AUTH +
-            self.config.AUTH_API_URLS.getAllInstitutions;
-  url = helpers.api.constructAPIUrl(url, { accountid : self.accountId });
+  var url = helpers.api.constructAPIUrl(
+    self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.getAllInstitutions,
+    { accountid : self.accountId }
+  );
 
   var params = {};
-  if(options) {
-    if(options.lookup) { params.lookup = options.lookup; }
-    if(options.cursor) { params.cursor = options.cursor; }
-    if(options.limit) { params.limit = options.limit; }
+  if (options) {
+    if (options.lookup) { params.lookup = options.lookup; }
+    if (options.cursor) { params.cursor = options.cursor; }
+    if (options.start) { params.start = options.start; }
+    if (options.end) { params.end = options.end; }
   }
 
-  //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(err, response) {
-    if(err) {
-        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-        dfd.reject(err);
-    } else {
-        dfd.resolve(response.body);
-    }
+  // Prepare request parameters & execute request
+  var reqOptions = {
+    params: params,
+    headers: { traceid: self.traceid }
+  };
+  return requestLayer.get(url, reqOptions)
+  .then(function (response) {
+    return response.body;
+  })
+  .catch(function (err) {
+    throw new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
   });
-
-  return dfd.promise;
 }
 
 /**
@@ -12316,7 +12371,7 @@ function provisionSpacesToSuperAdmin(options) {
   return dfd.promise;
 }
 
-},{"../../helpers":3,"q":36,"superagent":39}],26:[function(require,module,exports){
+},{"../../helpers":3,"../../helpers/lib/requestLayer":7,"q":36,"superagent":39}],26:[function(require,module,exports){
 /*************************************************************************
  *
  * COMPRO CONFIDENTIAL