comprodls-sdk 2.83.0-alpha → 2.86.0-alpha

package/lib/config/index.js

@@ -139,6 +139,7 @@ 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',
@@ -321,8 +322,7 @@ exports.PRODUCT_API_URLS = {
 
 exports.XAPI_API_URLS = {
     postMultiStatements: '/{orgId}/statements/multi',
-    postExternalMultiStatements: '/{orgId}/external/statements/multi',
-    resetUserProductProgress: '/accounts/{accountId}/progress/user/product/reset'
+    postExternalMultiStatements: '/{orgId}/external/statements/multi'
 };
 
 exports.ATTEMPTS_API_URLS = {

package/lib/services/auth/index.js

@@ -79,6 +79,8 @@ 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),
 
@@ -1397,6 +1399,111 @@ 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'
@@ -2088,6 +2195,14 @@ function updateClass(options) {
           "productcode": "string",       //mandatory
           "title": ""
         }
+      ],
+      "bundles": [                      // optional
+        {
+          "bundlecode": "string",       //mandatory
+        },
+        {
+          "bundlecode": "string",       //mandatory
+        }
       ]
     }
   ],
@@ -2103,6 +2218,7 @@ function updateClass(options) {
         "students": true,
         "teachers": true,
         "products": true,
+        "bundles": true,
         "groups": true,
         "assigned_paths": true,
         "tags": true,
@@ -2143,6 +2259,7 @@ 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
@@ -2369,7 +2486,12 @@ 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"
+      }
     }
   }
 */
@@ -3134,6 +3256,7 @@ function deleteItemsFromShowcaseOfAClass(options){
  *  "students": true,
  *  "teachers": true,
  *  "products": true,
+ *  "bundles": true,
  *  "groups": true,
  *  "assigned_paths": true,
  *  "skip_assigned_path_create_notification": true,
@@ -3170,6 +3293,11 @@ function deleteItemsFromShowcaseOfAClass(options){
  *        "productcode": "string"
  *      }
  *    ],
+ *    "bundles": [
+ *      {
+ *        "bundlecode": "string"
+ *      }
+ *    ],
  *    "analyticsharingmodel": "NOINHERIT_SYNCBACK",
  *    "analytics_score_aggregation_type": "best",
  *    "limits": {

package/lib/services/authextn/index.js

@@ -724,14 +724,17 @@ function getClassesOfAGradeformat(options) {
 
 /*
   options = {
-    assignedpathid: "string",  //Mandatory
+    assignedpathid: "string",  // Mandatory
     classid: "string",         // Mandatory
-    body : [                   // min:1 , max: 50
-      {
-        extUserId: "string", //Mandatory
-      }.
-      ....
-    ]
+    body : {
+      "users":[                   // min:1 , max: 50
+        {
+          extUserId: "string",   // Mandatory
+        }
+          ....
+      ],
+      "context": {}          // Optional
+    }
   }
 */
 function createUserAssignedPathEnrollments(options) {

package/lib/services/pushX/index.js

@@ -79,12 +79,13 @@ function _connect(pubnubCW, options) {
     'pubnub': {
       'publishKey': options.publishKey,
       'subscribeKey': options.subscribeKey,
-      'ssl': true
+      'ssl': true,
+      'suppressLeaveEvents': true
     },
     'pollingEndpoint': options.pollingEndpoint,
     'pollingIterations': options.pollingIterations || 10, // Default polling iterations is 10
     'pollingInterval': options.pollingInterval, // Default polling interval is exponential backoff
-});
+  });
 }
 
 function _cleanup(pubnubCW) { pubnubCW.cleanup(); }

package/lib/services/spaces/index.js

@@ -538,6 +538,7 @@ function provisionBulkSpaces(options) {
  *   clone_settings: {
  *     *src_ext_classid: 'string',
  *     products: boolean,
+ *     bundles: boolean,
  *     assigned_paths: boolean,
  *     ext_assigned_path_id_rule: 'string'  //enum: ['SRC_ID']
  *     advanced: {
@@ -551,6 +552,9 @@ function provisionBulkSpaces(options) {
  *       ],
  *       products: [
  *         { *productcode: 'string' },
+ *       ],
+ *       bundles: [
+ *         { *bundlecode: 'string' },
  *       ]
  *     }
  *   }

package/lib/services/xapi/index.js

@@ -42,8 +42,7 @@ function xapi(accountId) {
   this.accountId = accountId;
   return {
     postStatement: postStatements.bind(this),
-    postExternalStatements: postExternalStatements.bind(this),
-    resetUserProductProgress: resetUserProductProgress.bind(this)
+    postExternalStatements: postExternalStatements.bind(this)
   };
 }
 
@@ -232,44 +231,3 @@ function postExternalStatements(options) {
   });
   return dfd.promise;
 }
-
-/*options = {
-    userid: 'string',
-    productcode: 'string',
-    actorid: 'string'
-}*/
-function resetUserProductProgress(options) {
-  var self = this;
-  // Initializing promise
-  var dfd = q.defer();
-  var err = {};
-  if(options && options.userid && options.productcode && options.actorid) {
-
-    // Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS.XAPI + self.config.XAPI_API_URLS.resetUserProductProgress;
-    url = helpers.api.constructAPIUrl(url, { accountId : self.accountId });
-
-    // Setup request with URL and Params
-    var requestAPI = request.delete(url)
-                    .set('Content-Type', 'application/json')
-                    .set('Accept', 'application/json')
-                    .send(options);
-
-    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 = 'userid, productcode or actorid not found in request options.';
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-
-  return dfd.promise;
-}

package/package.json

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