comprodls-sdk 2.90.2 → 2.91.0-thor

package/lib/open_access/index.js

@@ -17,6 +17,7 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS SDK Open Access Manager Module
  * Provides Open Access functions for the SDK
@@ -26,13 +27,12 @@ var request = require('superagent');
 var helpers = require('../helpers');
 var DLSError = helpers.errors.DLSError;
 
-/*************************************
- * Setting up Exports/Public functions
- *************************************/
-
-// These functions need to be moved to the corresponding adapter
-// They were created here since these functions requires the orgid but not token, But the initialiation function required both token and orgid to be initialized, Now we have improved the initialization function for orgid.
-
+/**
+ * These functions need to be moved to the corresponding adapter
+ * They were created here since these functions requires the orgid but not token,
+ * But the initialiation function required both token and orgid to be initialized,
+ * Now we have improved the initialization function for orgid.
+ */
 exports.getClassEnrolmentsStat = getClassEnrolmentsStat;
 exports.getSingleInvitation = getSingleInvitation;
 
@@ -41,11 +41,9 @@ exports.getSingleInvitation = getSingleInvitation;
  **********************************/
 
 /**
- * options = {
- *  classid: 'string',
- *  role: 'string
- * }
- **/
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/17_Open-Access-SDK-Functions#getclassenrolmentsstatorganizationid-options
+ */
 function getClassEnrolmentsStat(organizationId, options) {
   var self = this;
   //Initializing promise
@@ -76,46 +74,43 @@ function getClassEnrolmentsStat(organizationId, options) {
   return dfd.promise;
 }
 
-/* options =  {
-    "context_id": "string", //class id to be invited -required
-    "invitationid" : "string", //unique invitation id which is to be fetched -required
-    "context" : "string", //context for invitation e.g. class_enrollment -required
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/17_Open-Access-SDK-Functions#getsingleinvitationorganizationid-params
+ */
 function getSingleInvitation(organizationId, options) {
-    var self = this;
-    var err = {};
-    // Initializing promise
-    var dfd = q.defer();
-    if (organizationId && options && options.context_id && options.context && 
-        options.invitationid) {
-      // Passed all validations, Contruct API url
-      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.getSingleInvitation;
-      //Contruct path parameters
-      url = helpers.api.constructAPIUrl(url, 
-            { orgId: organizationId, invitationId: options.invitationid });
-      var queryParam = { context: options.context, context_id: options.context_id };
-  
-      // Setup request with URL and Params
-      var requestAPI = request.get(url).query(queryParam);
-      if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-  
-      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 = 'organizationId or context_id or context '+
-                                      'or invitationid not found in request options.';
-      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-      dfd.reject(err);
-    }
-    return dfd.promise;
-  }
+  var self = this;
+  var err = {};
+  // Initializing promise
+  var dfd = q.defer();
+  if (organizationId && options && options.context_id && options.context &&
+      options.invitationid) {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.getSingleInvitation;
+    //Contruct path parameters
+    url = helpers.api.constructAPIUrl(url,
+          { orgId: organizationId, invitationId: options.invitationid });
+    var queryParam = { context: options.context, context_id: options.context_id };
 
+    // Setup request with URL and Params
+    var requestAPI = request.get(url).query(queryParam);
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    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 = 'organizationId or context_id or context '+
+                                    'or invitationid not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+  return dfd.promise;
+}