comprodls-sdk 2.37.0 → 2.39.0

package/lib/config/index.js

@@ -212,7 +212,12 @@ exports.AUTH_API_URLS = {
     createOrGetGradebookMeta: '/org/{orgId}/classes/{classId}/gradebooks',
     updateOrDeleteGradebookMeta: '/org/{orgId}/classes/{classId}/gradebooks/{gradebook_id}',
     gradebookColumns: '/org/{orgId}/classes/{classId}/gradebooks/{gradebook_id}/columns',
-    updateGradebookColumn: '/org/{orgId}/classes/{classId}/gradebooks/{gradebook_id}/columns/{column_id}'
+    getAllClassesOfAComponent: '/org/{orgId}/components/{component_code}/classes',
+    removeAllGradebookColumnsOfAComponent: '/org/{orgId}/gradebook/columns/custom-components/{component_code}',
+
+    // Custom Components related APIs
+    customComponents: '/org/{orgid}/custom-components',
+    particularCustomComponent: '/org/{orgid}/custom-components/{custom_component_code}',
 };
 
 exports.ACTIVITY_API_URLS = {

package/lib/services/auth/index.js

@@ -112,10 +112,19 @@ function auth() {
     getParticularGradebookMetaOfAClass: getParticularGradebookMetaOfAClass.bind(this),
     getAllGradebooksMetaOfAClass: getAllGradebooksMetaOfAClass.bind(this),
     addGradebookColumns: addGradebookColumns.bind(this),
-    updateGradebookColumn: updateGradebookColumn.bind(this),
+    updateMultipleGradebookColumns: updateMultipleGradebookColumns.bind(this),
     removeGradebookColumns: removeGradebookColumns.bind(this),
     getParticularColumnOfAGradebook: getParticularColumnOfAGradebook.bind(this),
-    getAllColumnsOfAGradebook: getAllColumnsOfAGradebook.bind(this)
+    getAllColumnsOfAGradebook: getAllColumnsOfAGradebook.bind(this),
+    getAllClassesOfAComponent: getAllClassesOfAComponent.bind(this),
+    removeAllGradebookColumnsOfAComponent: removeAllGradebookColumnsOfAComponent.bind(this),
+
+    // Custom Components related APIs
+    createCustomComponent: createCustomComponent.bind(this),
+    updateCustomComponent: updateCustomComponent.bind(this),
+    deleteCustomComponent: deleteCustomComponent.bind(this),
+    getParticularCustomComponent: getParticularCustomComponent.bind(this),
+    getAllCustomComponents: getAllCustomComponents.bind(this)
   };
 }
 
@@ -3394,20 +3403,24 @@ function addGradebookColumns(options) {
   options = {
     classid: "string", //mandatory
     gradebook_id: "string", //mandatory
-    column_id: "string",   //mandatory
     body : {
-      "title": "string",
-      "weightage": "string",
-      "items": [
+      "columns": [
         {
-          "item-code": "string"
-        }
-      ],
-      "data": {...}
+          "title": "string",
+          "weightage": "string",
+          "items": [
+            {
+              "item-code": "string"
+            }
+          ],
+          "data": {...}
+        },
+        {...}
+      ]
     }
   }
 */
-function updateGradebookColumn(options) {
+function updateMultipleGradebookColumns(options) {
   // Initializing promise
   var deferred = q.defer();
   var self = this;
@@ -3418,49 +3431,42 @@ function updateGradebookColumn(options) {
   if(err) {
     deferred.reject(err);
   } else {
-    if (options && options.classid && options.gradebook_id && options.column_id && options.body) {
-      if (Object.keys(options.body).length !== 0) {
-        // Passed all validations, Contruct API url
-        var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.updateGradebookColumn;
+    if (options && options.classid && options.gradebook_id && options.body && options.body.columns) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.gradebookColumns;
 
-        url = helpers.api.constructAPIUrl(url, {
-          orgId: self.orgId,
-          classId: options.classid,
-          gradebook_id: options.gradebook_id,
-          column_id: options.column_id
-        });
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId,
+        classId: options.classid,
+        gradebook_id: options.gradebook_id
+      });
 
-        var params = options.body;
-        // Setup request with URL and Params
-        var requestAPI = request.put(url)
-          .set('Content-Type', 'application/json')
-          .set('Accept', 'application/json')
-          .send(params);
+      var params = options.body;
+      // Setup request with URL and Params
+      var requestAPI = request.put(url)
+        .set('Content-Type', 'application/json')
+        .set('Accept', 'application/json')
+        .send(params);
 
-        if (self.traceid) {
-          requestAPI.set('X-Amzn-Trace-Id', self.traceid);
-        }
+      if (self.traceid) {
+        requestAPI.set('X-Amzn-Trace-Id', self.traceid);
+      }
 
-        //Setup token in Authorization header
-        requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+      //Setup token in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
-        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.message = error.description = 'Body of the request input cannot be empty.';
-        error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
-        deferred.reject(error);
-      }
+      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.message = error.description = 'Mandatory params: classid, gradebook_id, column_id or body' +
+      error.message = error.description = 'Mandatory params: classid, gradebook_id, body or body.columns' +
         ' not found in the request options.';
       error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
       deferred.reject(error);
@@ -3643,3 +3649,395 @@ function getAllColumnsOfAGradebook (options) {
   }
   return deferred.promise;
 }
+
+/*
+  options = {
+    component_code: "string", //mandatory
+    cursor: "string"   //optional
+  }
+*/
+function getAllClassesOfAComponent (options) {
+    // Initializing promise
+    var deferred = q.defer();
+    var self = this;
+    var error = {};
+
+    //Validations
+    var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err) {
+      deferred.reject(err);
+    } else {
+      if (options && options.component_code) {
+        // Passed all validations, Contruct API url
+        var url = self.config.DEFAULT_HOSTS.AUTH +
+          self.config.AUTH_API_URLS.getAllClassesOfAComponent;
+
+        url = helpers.api.constructAPIUrl(url, {
+          orgId: self.orgId,
+          component_code: options.component_code
+        });
+
+        var params = {};
+        if(options.cursor){ params.cursor = options.cursor; }
+
+        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, self.token);
+
+        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.message = error.description = 'Mandatory params: component_code' +
+          ' not found in the request options.';
+        error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+        deferred.reject(error);
+      }
+    }
+    return deferred.promise;
+}
+
+/*
+  options = {
+    component_code: "string" //mandatory
+  }
+*/
+function removeAllGradebookColumnsOfAComponent (options) {
+    // Initializing promise
+    var deferred = q.defer();
+    var self = this;
+    var error = {};
+
+    //Validations
+    var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err) {
+      deferred.reject(err);
+    } else {
+      if (options && options.component_code) {
+        // Passed all validations, Contruct API url
+        var url = self.config.DEFAULT_HOSTS.AUTH +
+          self.config.AUTH_API_URLS.removeAllGradebookColumnsOfAComponent;
+
+        url = helpers.api.constructAPIUrl(url, {
+          orgId: self.orgId,
+          component_code: options.component_code
+        });
+
+        // Setup request with URL and Params
+        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) {
+              error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+              deferred.reject(error);
+            } else {
+              deferred.resolve(response.body);
+            }
+          });
+      } else {
+        error.message = error.description = 'Mandatory params: component_code' +
+          ' not found in the request options.';
+        error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+        deferred.reject(error);
+      }
+    }
+    return deferred.promise;
+}
+
+/*
+  options = {
+    body : {
+      custom_component_code: "string",  // Mandatory
+      title: "string",                  // Mandatory
+      custom_component_type: "string",  // Mandatory
+      scoring_type: "string",
+      items: [{...}],
+      data: {...}
+    }
+  }
+*/
+function createCustomComponent(options) {
+  var self = this;
+
+  // Initializing promise
+  var deferred = q.defer();
+
+  // Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (error) {
+      deferred.reject(error);
+  } else {
+    if (options && options.body) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.customComponents;
+      url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
+
+      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);
+            deferred.reject(err);
+          } else {
+            deferred.resolve(response.body);
+          }
+      });
+    } else {
+      var err = {};
+      err.message = err.description = 'Mandatory param - \'body\' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      deferred.reject(err);
+    }
+  }
+
+  return deferred.promise;
+}
+
+/*
+  options = {
+    custom_component_code: "string",    // Mandatory
+    body : {
+      title: "string",
+      custom_component_type: "string",
+      items: [{...}],
+      data: {...}
+    }
+  }
+*/
+function updateCustomComponent(options) {
+  var self = this;
+
+  // Initializing promise
+  var deferred = q.defer();
+
+  // Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (error) {
+    deferred.reject(error);
+  } else {
+    if (options && options.custom_component_code && options.body) {
+      if (Object.keys(options.body).length === 0) {
+        error.message = error.description = 'Mandatory params: \'custom_component_code\' or \'body\' not found in the request options.';
+        error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+        deferred.reject(error);
+      } else {
+        // Passed all validations, Contruct API url
+        var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.particularCustomComponent;
+        url = helpers.api.constructAPIUrl(url, {
+          orgid: self.orgId, custom_component_code: options.custom_component_code
+        });
+
+        // Setup request with URL and Params
+        var params = options.body;
+        var requestAPI = request.put(url)
+          .set('Content-Type', 'application/json')
+          .set('Accept', 'application/json')
+          .send(params);
+        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) {
+              error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+              deferred.reject(error);
+            } else {
+              deferred.resolve(response.body);
+            }
+          });
+      }
+    } else {
+      error = {};
+      error.message = error.description = 'Mandatory params: \'custom_component_code\' or \'body\' not found in the request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+
+  return deferred.promise;
+}
+
+/*
+  options = {
+    custom_component_code: "string", // Mandatory
+  }
+*/
+function deleteCustomComponent(options) {
+  var self = this;
+
+  // Initializing promise
+  var deferred = q.defer();
+
+  // Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (error) {
+      deferred.reject(error);
+  } else {
+    if (options && options.custom_component_code) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.particularCustomComponent;
+      url = helpers.api.constructAPIUrl(url, {
+        orgid: self.orgId, custom_component_code: options.custom_component_code
+      });
+
+      // Setup request with URL and Params
+      var requestAPI = request.delete(url);
+      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);
+            deferred.reject(err);
+          } else {
+            deferred.resolve(response.body);
+          }
+      });
+    } else {
+      var err = {};
+      err.message = err.description = 'Mandatory params - \'custom_component_code\' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      deferred.reject(err);
+    }
+  }
+
+  return deferred.promise;
+}
+
+/*
+  options = {
+    custom_component_code: "string", // Mandatory
+  }
+*/
+function getParticularCustomComponent(options) {
+  var self = this;
+
+  // Initializing promise
+  var deferred = q.defer();
+
+  // Validations
+  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (err) {
+    deferred.reject(err);
+  } else {
+    if (options && options.custom_component_code) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.particularCustomComponent;
+
+      url = helpers.api.constructAPIUrl(url, {
+        orgid: self.orgId, custom_component_code: options.custom_component_code
+      });
+
+      // Setup request with URL and Params
+      var requestAPI = request.get(url);
+      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) {
+            error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+            deferred.reject(error);
+          } else {
+            deferred.resolve(response.body);
+          }
+      });
+    } else {
+      var error = {};
+      error.message = error.description = 'Mandatory params: \'custom_component_code\' not found in request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+
+  return deferred.promise;
+}
+
+/*
+  options = {
+    cursor: "string"
+  }
+*/
+function getAllCustomComponents(options) {
+  var self = this;
+
+  // Initializing promise
+  var deferred = q.defer();
+
+  // Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (error) {
+    deferred.reject(error);
+  } else {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.customComponents;
+    url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
+
+    // Setup request with URL and Params
+    var params = {};
+    if (options.cursor) { params.cursor = options.cursor; }
+
+    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, self.token);
+
+    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);
+        }
+      });
+  }
+
+  return deferred.promise;
+}

package/package.json

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