comprodls-sdk 2.89.0 → 2.90.3-development

package/lib/config/index.js

@@ -139,7 +139,6 @@ exports.AUTH_API_URLS = {
     getParticularShadowClassAPI: '/org/{orgId}/shadow/classes/{extClassId}',
     classProductAssociation: '/org/{orgId}/classes/{classId}/associate-product/{productcode}',
     multiClassProductAssociations: '/org/{orgId}/classes/{classId}/associate-product/multi',
-    classMaterialAssociation: '/org/{orgId}/classes/{classId}/associate-materials/multi',
     enrollUsertoClass: '/org/{orgId}/classes/{classId}/enroll-user/{userId}',
     enrollSelftoClass: '/org/{orgId}/classes/{classId}/enroll-self',
     enrollMultiUserstoClass: '/org/{orgId}/classes/{classId}/enroll-user/multi',
@@ -322,7 +321,8 @@ exports.PRODUCT_API_URLS = {
 
 exports.XAPI_API_URLS = {
     postMultiStatements: '/{orgId}/statements/multi',
-    postExternalMultiStatements: '/{orgId}/external/statements/multi'
+    postExternalMultiStatements: '/{orgId}/external/statements/multi',
+    resetUserProductProgress: '/accounts/{accountId}/progress/user/product/reset'
 };
 
 exports.ATTEMPTS_API_URLS = {
@@ -350,9 +350,7 @@ exports.PUB_API_URLS = {
 
 exports.PUSHX_API_URLS = {
     grantByUserOrgId: '/orgs/{orgId}/grants',
-    grantByAccountId: '/accounts/{accountId}/grants',
-    grantV2: '/ver/v2/grants',
-    getPushedEvents: '/accounts/{accountId}/pushed-events/channels'
+    grantByAccountId: '/accounts/{accountId}/grants'
 };
 
 exports.INTEGRATIONS_API_URLS = {

package/lib/helpers/lib/errors.js

@@ -117,7 +117,7 @@ function PUSHXError(category, error) {
 
     if (category === ERROR_CATEGORY.PUSHX) {
         this.category = ERROR_CATEGORY.PUSHX;
-        this.type = error.type || ERROR_TYPES.CHANNEL_SUBSCRIPTION;
+        this.type = ERROR_TYPES.CHANNEL_SUBSCRIPTION;
         this.status = ERROR_STATUS.ERROR;
         this.message = error.message;
         this.data = error;

package/lib/services/auth/index.js

@@ -79,8 +79,6 @@ function auth() {
     createClassProductAssociation: createClassProductAssociation.bind(this),
     removeClassProductAssociation: removeClassProductAssociation.bind(this),
     createMultiClassProductAssociations: createMultiClassProductAssociations.bind(this),
-    associateMaterialsWithClass: associateMaterialsWithClass.bind(this),
-    unassociateMaterialsWithClass: unassociateMaterialsWithClass.bind(this),
     addItemsToShowcaseOfAClass: addItemsToShowcaseOfAClass.bind(this),
     deleteItemsFromShowcaseOfAClass: deleteItemsFromShowcaseOfAClass.bind(this),
 
@@ -1399,111 +1397,6 @@ function createClassProductAssociation(options) {
   return dfd.promise;
 }
 
-/**
- * @param {
- *   *classId: 'string',
- *   *body: {
- *     productcodes: ['string'],
- *     bundlecodes: ['string'],
- *   }
- * } options
- */
-function associateMaterialsWithClass(options) {
-  var self = this;
-  // Initializing promise
-  var dfd = q.defer();
-  // Validations
-  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
-  if(err) { dfd.reject(err); }
-  else {
-    if(options && options.classId && options.body && (options.body.productcodes
-      || options.body.bundlecodes)) {
-      // Passed all validations, Contruct API url
-      var url = self.config.DEFAULT_HOSTS.AUTH +
-                self.config.AUTH_API_URLS.classMaterialAssociation;
-      url = helpers.api.constructAPIUrl(url, {
-        orgId: self.orgId, classId: options.classId
-      });
-      // 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); }
-
-      // Setup token in Authorization header
-      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-
-      requestAPI.agent(keepaliveAgent).end(function(err, response) {
-        if(err) {
-          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-          dfd.reject(err);
-        }
-        else { dfd.resolve(response.body); }
-      });
-    } else {
-      err = {};
-      err.message = err.description = 'classId or productcodes or bundlecodes not found in'
-        + 'request options.';
-      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-      dfd.reject(err);
-    }
-  }
-  return dfd.promise;
-}
-
-/**
- * @param {
- *   *classId: string,
- *   *body: {
- *    'productcodes' :['string'],
- *    'bundlecodes' : ['string']
- *    }
- * } options
- */
-function unassociateMaterialsWithClass(options) {
-  var self = this;
-  // Initializing promise
-  var dfd = q.defer();
-  // Validations
-  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
-  if(err) { dfd.reject(err); }
-  else {
-    if(options && options.classId && options.body &&
-      (options.body.productcodes || options.body.bundlecodes)) {
-      // Passed all validations, Contruct API url
-      var url= self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.classMaterialAssociation;
-      url = helpers.api.constructAPIUrl(url, {
-        orgId: self.orgId, classId: options.classId
-      });
-      // Setup request with URL and Params
-      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); }
-
-      // Setup token in Authorization header
-      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
-
-      requestAPI.agent(keepaliveAgent).end(function(err, response) {
-        if(err) {
-          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-          dfd.reject(err);
-        }
-        else { dfd.resolve(response.body); }
-      });
-    } else {
-      err = {};
-      const msg = 'classId or productcodes or bundlecodes not found in request options.';
-      err.message = msg;
-      err.description = msg;
-      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-      dfd.reject(err);
-    }
-  }
-  return dfd.promise;
-}
-
 //options = {
 //    classId: 'class uuid',
 //    productcode: 'product code'
@@ -2195,14 +2088,6 @@ function updateClass(options) {
           "productcode": "string",       //mandatory
           "title": ""
         }
-      ],
-      "bundles": [                      // optional
-        {
-          "bundlecode": "string",       //mandatory
-        },
-        {
-          "bundlecode": "string",       //mandatory
-        }
       ]
     }
   ],
@@ -2218,7 +2103,6 @@ function updateClass(options) {
         "students": true,
         "teachers": true,
         "products": true,
-        "bundles": true,
         "groups": true,
         "assigned_paths": true,
         "tags": true,
@@ -2226,7 +2110,6 @@ function updateClass(options) {
         "analytics_score_aggregation_type": true,
         "ext_data": true,
         "limits": true,
-        "skip_assigned_path_create_notification": true,
         "advanced": {
           "students": [
             {
@@ -2259,7 +2142,6 @@ function updateClass(options) {
             }
           ],
           "products": [ { "productcode": "string" } ],
-          "bundles": [ { "bundlecode": "string" } ],
           "analyticsharingmodel": "string"                 // Valid values: ['NOINHERIT_SYNCBACK']
           "analytics_score_aggregation_type": "string",     // Valid values: ['best', 'first', 'last']
           "limits": {los: number, students: number}   // Optional field
@@ -2486,12 +2368,7 @@ function deleteAssignedPath(options) {
           item_type: 'string',  //mandatory, ['dls-internal','external']
           dls_product_code: 'string' //mandatory only if item_type is 'dls-internal'
         }
-      ],
-      "rules": {},                // Optional
-      "context": {                // Optional (Needed for system event only)
-        "bundle-code": "string",
-        "space_key": "string"
-      }
+      ]
     }
   }
 */
@@ -3252,60 +3129,7 @@ function deleteItemsFromShowcaseOfAClass(options){
  * startdate: 'Epoch(Unix) timestamp in milliseconds',
  * enddate: 'Epoch(Unix) timestamp in milliseconds',
  * instructor: 'user who clones the class',
- * clone_setting: {                                     // optional field
- *  "students": true,
- *  "teachers": true,
- *  "products": true,
- *  "bundles": true,
- *  "groups": true,
- *  "assigned_paths": true,
- *  "skip_assigned_path_create_notification": true,
- *  "tags": true,
- *  "analyticsharingmodel": true,
- *  "analytics_score_aggregation_type": true,
- *  "ext_data": true,
- *  "limits": true,
- *  "advanced": {
- *  "students": [
- *      {
- *        "ext_user_id": "string"
- *      }
- *    ],
- *    "teachers": [
- *      {
- *        "ext_user_id": "string"
- *      }
- *    ],
- *    "groups": [
- *      {
- *        "groupid": "string"
- *      }
- *    ],
- *    "assigned_paths": [
- *      {
- *        "assigned_path_id": "string",
- *        "startdate": 0,
- *        "duedate": 0
- *      }
- *    ],
- *    "products": [
- *      {
- *        "productcode": "string"
- *      }
- *    ],
- *    "bundles": [
- *      {
- *        "bundlecode": "string"
- *      }
- *    ],
- *    "analyticsharingmodel": "NOINHERIT_SYNCBACK",
- *    "analytics_score_aggregation_type": "best",
- *    "limits": {
- *      "los": 0,
- *      "students": 0
- *    }
- *  }
- * },
+ * clone_setting: {},                          // Optional field
  * }
  */
 function cloneClass(options) {

package/lib/services/authextn/index.js

@@ -41,7 +41,8 @@ var keepaliveAgent = new Agent({
 });
 
 //AuthExtn Adaptor Contsructor
-function authextn() {
+function authextn(accountId) {
+  this.accountId = accountId;
   return {
     // Gradeformat related APIs
     createGradeformat: createGradeformat.bind(this),
@@ -67,7 +68,9 @@ function authextn() {
     createOrgProductEntitlement: createOrgProductEntitlement.bind(this),
     updateOrgProductEntitlement: updateOrgProductEntitlement.bind(this),
     getParticularOrgProductEntitlement: getParticularOrgProductEntitlement.bind(this),
-    getAllOrgProductEntitlements: getAllOrgProductEntitlements.bind(this)
+    getAllOrgProductEntitlements: getAllOrgProductEntitlements.bind(this),
+    setupUser: setupUser.bind(this)
+
   };
 }
 
@@ -724,17 +727,14 @@ function getClassesOfAGradeformat(options) {
 
 /*
   options = {
-    assignedpathid: "string",  // Mandatory
+    assignedpathid: "string",  //Mandatory
     classid: "string",         // Mandatory
-    body : {
-      "users":[                   // min:1 , max: 50
-        {
-          extUserId: "string",   // Mandatory
-        }
-          ....
-      ],
-      "context": {}          // Optional
-    }
+    body : [                   // min:1 , max: 50
+      {
+        extUserId: "string", //Mandatory
+      }.
+      ....
+    ]
   }
 */
 function createUserAssignedPathEnrollments(options) {
@@ -1018,7 +1018,64 @@ function getParticularOrgProductEntitlement(options) {
   //Initializing promise
   var deferred = q.defer();
 
-  if (options && options.productcode) {
+  //Validations
+  var error = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if (error) {
+    deferred.reject(error);
+  } else {
+    if (options && options.productcode) {
+      // Passed all validations, Contruct the API URL
+      var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
+        self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
+      url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
+
+      // Setup request with URL and Query Params
+      var params = { productcode: options.productcode };
+      var requestAPI = request.get(url).query(params);
+
+      // Setup 'traceid' in request header
+      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 field \'productcode\' not found '+
+        'in request options.';
+      error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+      deferred.reject(error);
+    }
+  }
+
+  return deferred.promise;
+}
+
+/**
+ * @param {
+ *  status: "string"             // ['active', 'revoked']
+ *  expired: <boolean>,
+ *  cursor: <epoch>
+ * } options
+ */
+function getAllOrgProductEntitlements(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 the API URL
     var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
       self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
@@ -1026,11 +1083,19 @@ function getParticularOrgProductEntitlement(options) {
 
     // Setup request with URL and Query Params
     var params = { productcode: options.productcode };
+
+    if (options.status) { params.status = options.status; }
+    if (options.hasOwnProperty('expired')) { params.expired = options.expired; }
+    if (options.cursor) { params.cursor = options.cursor; }
+
     var requestAPI = request.get(url).query(params);
 
     // Setup 'traceid' in request header
     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);
@@ -1039,12 +1104,6 @@ function getParticularOrgProductEntitlement(options) {
         deferred.resolve(response.body);
       }
     });
-  } else {
-    var error = {};
-    error.message = error.description = 'Mandatory field \'productcode\' not found '+
-      'in request options.';
-    error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
-    deferred.reject(error);
   }
 
   return deferred.promise;
@@ -1052,41 +1111,44 @@ function getParticularOrgProductEntitlement(options) {
 
 /**
  * @param {
- *  status: "string"             // ['active', 'revoked']
- *  expired: <boolean>,
- *  cursor: <epoch>
- * } options
- */
-function getAllOrgProductEntitlements(options) {
+*  ext_user_id: "string",        // mandatory
+*  workflow_type: "string",      // mandatory
+*  <workflow_type>: {}           // mandatory
+* } options
+*/
+function setupUser(options) {
   var self = this;
   //Initializing promise
   var deferred = q.defer();
 
-  // Contruct the API URL
-  var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
-    self.config.AUTHEXTN_API_URLS.orgProductEntitlement;
-  url = helpers.api.constructAPIUrl(url, { orgid: self.orgId });
-
-  // Setup request with URL and Query Params
-  var params = { productcode: options.productcode };
+  if(options && options.ext_user_id && options.workflow_type) {
+    //Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTHEXTN + self.config.AUTHEXTN_API_URLS.setupUser;
+    url = helpers.api.constructAPIUrl(url,  { accountId: self.accountId });
 
-  if (options.status) { params.status = options.status; }
-  if (options.hasOwnProperty('expired')) { params.expired = options.expired; }
-  if (options.cursor) { params.cursor = options.cursor; }
+    var requestAPI = request.post(url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .send(options);
 
-  var requestAPI = request.get(url).query(params);
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-  // Setup 'traceid' in request header
-  if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-  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;
+    requestAPI
+    .agent(keepaliveAgent)
+    .end(function(err, res) {
+      if(err) {
+          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+          deferred.reject(err);
+      } else {
+        deferred.resolve(res.body);
+      }
+    });
+  } else {
+    err = {};
+    err.message = err.description = 'Mandatory field \'ext_user_id\' or \'workflow_type\' not found '+
+      'in the request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    deferred.reject(err);
+  }
+return deferred.promise;
 }

package/lib/services/product/index.js

@@ -195,10 +195,9 @@ function getMicroEntitlementsForAUser(options) {
 
 }
 
-/* options= {
-  stage: "string",          //optional, stage number or version
-  target_role: "string"     // optional
-} */
+// options= {
+//  stage: "",          //stage number or version
+// }
 function getAllBundles(options) {
     var self = this;
     var dfd = q.defer();
@@ -209,14 +208,7 @@ function getAllBundles(options) {
   url = helpers.api.constructAPIUrl(url, { accountId : self.accountId });
   //Contruct parameters
   var params = {};
-  if(options) {
-    if(options.stage){
-      params.stage = options.stage;
-    }
-    if(options.target_role){
-      params.target_role = options.target_role;
-    }
-  }
+  if(options && options.stage) { params.stage = options.stage; }
 
   //Setup request with URL and Post data
   var requestAPI = request.get(url).query(params);

package/lib/services/pub/index.js

@@ -335,10 +335,10 @@ function updateBundle(options) {
   return dfd.promise;
 }
 
-/* options= {
-  stage: "string",          //optional, stage number or version
-  target_role: "string"     // optional
-} */
+// options= {
+//  stage: "",          //stage number or version
+// }
+
 function getAllBundles(options) {
   var self = this;
   //Initializing promise
@@ -350,14 +350,7 @@ function getAllBundles(options) {
   url = helpers.api.constructAPIUrl(url, { orgid: self.orgId, });
   //Contruct parameters
   var params = {};
-  if(options) {
-    if(options.stage){
-      params.stage = options.stage;
-    }
-    if(options.target_role){
-      params.target_role = options.target_role;
-    }
-  }
+  if(options && options.stage) { params.stage = options.stage; }
 
   //Setup request with URL and Post data
   var requestAPI = request.get(url).query(params);