comprodls-sdk 2.34.3 → 2.35.0

package/lib/config/index.js

@@ -206,8 +206,13 @@ exports.AUTH_API_URLS = {
     //Data-Sync-Manager related APIs
     createDataSyncManager: '/accounts/{accountid}/data-sync-managers',
     dataSyncManager: '/accounts/{accountid}/data-sync-managers/{dsmid}',
-    getAllDataSyncManagersOfAGroup: '/accounts/{accountid}/dsm-groups/{dsm_groupid}/data-sync-managers'
+    getAllDataSyncManagersOfAGroup: '/accounts/{accountid}/dsm-groups/{dsm_groupid}/data-sync-managers',
 
+    //Gradebooks related APIs
+    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}'
 };
 
 exports.ACTIVITY_API_URLS = {
@@ -242,8 +247,8 @@ exports.ANALYTICS_API_URLS = {
     getClassRecordUserAggregations: '/{orgId}/class/product/user-aggregations',
     getUserClassRecentSubmissions: '/{orgId}/user/product/class/recent-submissions',
     appState: '/{orgId}/user/product/progress/state',
-    getUserProductAllState: '/{orgid}/user/product/progress/state/all',
-    updateUserProductMultiState: '/{orgid}/user/product/progress/state/multi',
+    getUserProductAllState: '/{orgId}/user/product/progress/state/all',
+    updateUserProductMultiState: '/{orgId}/user/product/progress/state/multi',
 
     //AssignedPaths Related APIs
     getAllAssignedPathsOfClass: '/{orgId}/class/assigned-paths',

package/lib/services/auth/index.js

@@ -102,7 +102,19 @@ function auth() {
     deleteMultiUserGroupMembership: deleteMultiUserGroupMembership.bind(this),
     getMyAllMemberships: getMyAllMemberships.bind(this),
     archiveGroup: archiveGroup.bind(this),
-    unarchiveGroup: unarchiveGroup.bind(this)
+    unarchiveGroup: unarchiveGroup.bind(this),
+
+    //Gradeooks related APIs
+    createGradebookMeta: createGradebookMeta.bind(this),
+    updateGradebookMeta: updateGradebookMeta.bind(this),
+    deleteGradebookMeta: deleteGradebookMeta.bind(this),
+    getParticularGradebookMetaOfAClass: getParticularGradebookMetaOfAClass.bind(this),
+    getAllGradebooksMetaOfAClass: getAllGradebooksMetaOfAClass.bind(this),
+    addGradebookColumns: addGradebookColumns.bind(this),
+    updateGradebookColumn: updateGradebookColumn.bind(this),
+    removeGradebookColumns: removeGradebookColumns.bind(this),
+    getParticularColumnOfAGradebook: getParticularColumnOfAGradebook.bind(this),
+    getAllColumnsOfAGradebook: getAllColumnsOfAGradebook.bind(this)
   };
 }
 
@@ -1714,6 +1726,8 @@ function updateClass(options) {
 /** options =
  *{
   "space_title": "string",
+  "skip_email_to_actor": true/false,     // optional, default false
+  "ext_data": {},                        // optional,
   "classes": [
     {
       "title": "class tiltle",
@@ -2794,3 +2808,618 @@ function cloneClass(options) {
   }
   return dfd.promise;
 }
+
+/*
+  options = {
+    classid: "string", //mandatory
+    body : {
+      gradebook_id: "string", //mandatory
+      title: "string",  //mandatory
+      data: {}
+    }
+  }
+*/
+function createGradebookMeta(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.body) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.createOrGetGradebookMeta;
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId, classId: options.classid
+      });
+
+      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 or body' +
+                                      ' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+
+  return dfd.promise;
+}
+
+/*
+  options = {
+    classid: "string", //mandatory
+    gradebook_id: "string", //mandatory
+    body : {    //mandatory
+      title: "string",
+      data: {}
+    }
+  }
+*/
+function updateGradebookMeta(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.classid && options.gradebook_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.updateOrDeleteGradebookMeta;
+
+        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);
+
+        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 = 'Body of the request cannot be empty.';
+        error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+        deferred.reject(error);
+      }
+    } else {
+      error.message = error.description = 'Mandatory params: classid, gradebook_id 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 = {
+    classid: "string", //mandatory
+    gradebook_id: "string" //mandatory
+  }
+*/
+function deleteGradebookMeta(options) {
+  var self = this;
+  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.gradebook_id) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.updateOrDeleteGradebookMeta;
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId, classId: options.classid, gradebook_id: options.gradebook_id
+      });
+
+      // 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);
+            dfd.reject(err);
+          }
+          else { dfd.resolve(response.body); }
+      });
+    }
+    else {
+      var err = {};
+      err.message = err.description = 'Mandatory params - classid or gradebook_id' +
+                                      ' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+
+  return dfd.promise;
+}
+
+/*
+  options = {
+    classid: "string", //mandatory
+    gradebook_id: "string" //mandatory
+  }
+*/
+function getParticularGradebookMetaOfAClass(options) {
+  // Initializing promise
+  var deferred = q.defer();
+  var self = this;
+
+  //Validations
+  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(err) {
+    deferred.reject(err);
+  } else {
+    if (options && options.classid && options.gradebook_id) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH +
+        self.config.AUTH_API_URLS.createOrGetGradebookMeta;
+
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId, classId: options.classid
+      });
+
+      // Setup request with URL and Params
+      var params = {gradebook_id: options.gradebook_id};
+      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.entities[0]);
+          }
+      });
+    } else {
+      var error = {};
+      error.message = error.description = 'Mandatory params: classid or gradebook_id' +
+        ' not found in request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+
+  return deferred.promise;
+}
+
+/*
+  options = {
+    classid: "string", //mandatory
+    cursor: "string"
+  }
+*/
+function getAllGradebooksMetaOfAClass (options) {
+  // Initializing promise
+  var deferred = q.defer();
+  var self = this;
+
+  //Validations
+  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(err) {
+    deferred.reject(err);
+  } else {
+    if (options && options.classid) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.createOrGetGradebookMeta;
+
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId, classId: options.classid
+      });
+
+      // 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);
+          }
+        });
+    } else {
+      var error = {};
+      error.message = error.description = 'Mandatory params: classid not found in request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+  return deferred.promise;
+}
+
+/*
+  options = {
+    classid: "string", //mandatory
+    gradebook_id: "string", //mandatory
+    body : {
+      "columns": [
+        {
+          "column_id": "string",     // Mandatory
+          "title": "string",
+          "type": "product / custom",
+          "weightage": "string",
+          "bundle-codes": [],
+          "productcode": "string",
+          "custom_component_code": "string",
+          "items": [
+            {
+              "item-code": "string"
+            }
+          ],
+          "data": {...}
+        }
+      ]
+    }
+  }
+*/
+function addGradebookColumns(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.gradebook_id && options.body) {
+      // 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
+      });
+
+      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, gradebook_id or body' +
+                                      ' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+  return dfd.promise;
+}
+
+/*
+  options = {
+    classid: "string", //mandatory
+    gradebook_id: "string", //mandatory
+    column_id: "string",   //mandatory
+    body : {
+      "title": "string",
+      "weightage": "string",
+      "items": [
+        {
+          "item-code": "string"
+        }
+      ],
+      "data": {...}
+    }
+  }
+*/
+function updateGradebookColumn(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.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;
+
+        url = helpers.api.constructAPIUrl(url, {
+          orgId: self.orgId,
+          classId: options.classid,
+          gradebook_id: options.gradebook_id,
+          column_id: options.column_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);
+
+        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 = 'Body of the request input cannot be empty.';
+        error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+        deferred.reject(error);
+      }
+    } else {
+      error.message = error.description = 'Mandatory params: classid, gradebook_id, column_id 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 = {
+    classid: "string", //mandatory
+    gradebook_id: "string", //mandatory
+    body : {
+      "columns": [
+        {
+          "column_id": "string",     // Mandatory
+        }
+      ]
+    }
+  }
+*/
+function removeGradebookColumns(options) {
+  var self = this;
+  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.gradebook_id && options.body) {
+      // 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
+      });
+
+      // 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) {
+            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 params - classid, gradebook_id or body' +
+                                      ' not found in request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+  return dfd.promise;
+}
+
+/*
+  options = {
+    classid: "string", //mandatory
+    gradebook_id: "string", //mandatory
+    column_id: "string"   //mandatory
+  }
+*/
+function getParticularColumnOfAGradebook (options) {
+  // Initializing promise
+  var deferred = q.defer();
+  var self = this;
+
+  //Validations
+  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(err) {
+    deferred.reject(err);
+  } else {
+    if (options && options.classid && options.gradebook_id && options.column_id) {
+      // 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
+      });
+
+      // Setup request with URL and Params
+      var params = {column_id: options.column_id};
+      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.entities[0]);
+          }
+      });
+    } else {
+      var error = {};
+      error.message = error.description = 'Mandatory params: classid, gradebook_id or column_id' +
+        ' not found in request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+  return deferred.promise;
+}
+
+/*
+  options = {
+    classid: "string", //mandatory
+    gradebook_id: "string", //mandatory
+    cursor: "string"   //optional
+  }
+*/
+function getAllColumnsOfAGradebook (options) {
+  // Initializing promise
+  var deferred = q.defer();
+  var self = this;
+
+  //Validations
+  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(err) {
+    deferred.reject(err);
+  } else {
+    if (options && options.classid && options.gradebook_id) {
+      // 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
+      });
+
+      // 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);
+          }
+        });
+    } else {
+      var error = {};
+      error.message = error.description = 'Mandatory params: classid or gradebook_id' +
+        ' not found in request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+  return deferred.promise;
+}

package/package.json

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