comprodls-sdk 2.89.0 → 2.90.0-qa

package/lib/services/spaces/index.js

@@ -31,9 +31,6 @@ var helpers = require('../../helpers');
 
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = spaces;
 
 var keepaliveAgent = new Agent({
@@ -70,14 +67,10 @@ function spaces(accountId) {
   };
 }
 
-/*options = {
-  extuserid: 'string',
-  spaceRole: 'string',   //optional
-  spaceType: 'string',   //optional
-  spaceOrgContext: 'string',  //optional
-  details: boolean, //optional
-  cursor: 'string'   //optional
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#getuserspacesparams
+ */
 function getUserSpaces(options) {
   var self = this;
   // Initializing promise
@@ -119,11 +112,10 @@ function getUserSpaces(options) {
   return dfd.promise;
 }
 
-/*options = {
-  spaceCodeBody : {
-      space_code: 'string'
-  }
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#validatespacecodeparams
+ */
 function validateSpaceCode(options) {
   var self = this;
   // Initializing promise
@@ -159,12 +151,10 @@ function validateSpaceCode(options) {
   return dfd.promise;
 }
 
-/*options = {
-  classCodeBody : {
-      class_code: 'string'
-  },
-  details: boolean    // optional
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#validateclasscodeparams
+ */
 function validateClassCode(options) {
   var self = this;
   // Initializing promise
@@ -205,9 +195,11 @@ function validateClassCode(options) {
 
   return dfd.promise;
 }
-/* options = {
-  "ignore_words": ["string"] //optional, This is the array of all bad words to be ignored.
-}*/
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#generatespacecodeparams
+ */
 function generateSpaceCode(options) {
   var self = this;
 
@@ -220,7 +212,7 @@ function generateSpaceCode(options) {
   url = helpers.api.constructAPIUrl(url, { accountid : self.accountId });
 
   var bodyParams = {};
-  if(options.ignore_words) { bodyParams.ignore_words = options.ignore_words }
+  if(options.ignore_words) { bodyParams.ignore_words = options.ignore_words; }
   // Setup request with URL and Params
   var requestAPI = request.post(url)
                     .set('Content-Type', 'application/json')
@@ -239,11 +231,10 @@ function generateSpaceCode(options) {
   return dfd.promise;
 }
 
-/* options = {
-  "ext_user_id": "string", //mandatory, This is the actor to change the spacecode.
-  "ignore_words": ["string"] //optional, This is the array of all bad words to be ignored.
-  "spacecode": "string" //mandatory, This is the spacecode that needs to be changed.
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#changespacecodeparams
+ */
 function changeSpaceCode(options) {
   var self = this;
   // Initializing promise
@@ -255,7 +246,7 @@ function changeSpaceCode(options) {
                                self.config.AUTH_API_URLS.changeSpaceCode;
     url = helpers.api.constructAPIUrl(url, { accountid : self.accountId, spacecode: options.spacecode });
     var bodyParams = { ext_user_id: options.ext_user_id };
-    if(options.ignore_words) { bodyParams.ignore_words = options.ignore_words }
+    if(options.ignore_words) { bodyParams.ignore_words = options.ignore_words; }
     // Setup request with URL and Params
     var requestAPI = request.put(url)
                      .set('Content-Type', 'application/json')
@@ -280,15 +271,10 @@ function changeSpaceCode(options) {
   return dfd.promise;
 }
 
-/*
-  ext_user_id: 'string',
-  ext_role: 'string',
-  space_code: 'string',
-  ext_email: 'string',       //optional
-  ext_first_name: 'string',  //optional
-  ext_last_name: 'string,    //optional
-  ref_id: 'string'           //optional
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#joininstitutespaceparams
+ */
 function joinInstituteSpace(options) {
   var self = this;
   // Initializing promise
@@ -326,26 +312,10 @@ function joinInstituteSpace(options) {
   return dfd.promise;
 }
 
-/*options = {
-    ext_user_id: 'string',
-    ext_actor_id: 'string', (optional)
-    ext_role: 'string',
-    ext_first_name: 'string',
-    ext_last_name: 'string',
-    ext_email: 'string',
-    ref_id: 'string', (optional)
-    class_code: 'string' (optional)
-    products: [{
-      productcode: 'string',
-      ext_product_id: 'string',
-      ext_product_meta: {
-        startdate: 'string',
-        enddate: 'string',
-        ...
-      },
-      ext_data: {}
-    }]
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#provisionspacestostudentparams
+ */
 function provisionSpacesToStudent(options) {
   var self = this;
   // Initializing promise
@@ -383,15 +353,8 @@ function provisionSpacesToStudent(options) {
 }
 
 /**
- * This function is used to provision spaces to a user with ext_role as teacher.
- * options = {
- *    ext_user_id: "string",
- *    ext_role: "string",
- *    ext_first_name: "string",
- *    ext_last_name: "string",
- *    ext_email: "string",
- *    ref_id: "string"
- * };
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#provisionspacestoteacherparams
  */
 function provisionSpacesToTeacher(options) {
   var self = this;
@@ -430,40 +393,8 @@ function provisionSpacesToTeacher(options) {
 }
 
 /**
- * options = {
-    "space_title": "string",          // mandatory
-    "ext_data": {}                    //optional, external data(e.g. jobdata etc.)
-		"users": [												// mandatory, min: 1, max: 200
-			{
-				"ext_user_id": "string",			// mandatory (it must be unique within users array)
-				"ext_parent_id": "string",
-				"ext_username": "string",
-				"ext_role": "student",				// mandatory
-				"ext_email": "string",
-				"ext_first_name": "string",   // mandatory
-				"ext_last_name": "string",    // mandatory
-				"address": "string",
-				"rowId": "string",						// mandatory (it must be unique within users array)
-				"classes": [									// optional, min: 1, max: 3
-					{
-						"classid": "string",      // either of classid or class_code them must be
-						"class_code": "string"    // present, classid is preferred
-					}
-        ],
-        "products": [									// optional, min: 1
-					{
-						"productcode": "string",  // mandatory
-						"ext_product_meta": {
-              "startdate": "epoch",
-              "enddate": "epoch"      // mandatory
-            }
-            "ext_data" : {}           // optional, external data (e.g., ref_id, ...)
-					}
-				]
-			}
-		]
-	}
- *
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#provisionbulkspacesparams
  */
 function provisionBulkSpaces(options) {
   var self = this;
@@ -508,57 +439,8 @@ function provisionBulkSpaces(options) {
 }
 
 /**
- * @param {
- *   *ext_user_id: 'string',
- *   *ext_role": 'string',
- *   ext_first_name: 'string',
- *   ext_last_name: 'string',
- *   ext_email: 'string',
- *   address: {
- *     country:'string'
- *   },
- *   ref_id: 'string',
- *   ext_classid : 'string',
- *   ext_class_meta : {
- *     *title: 'string',
- *     *startdate: <epoch>,
- *     *enddate: <epoch>,
- *     description: 'string',
- *     ext_class_title : 'string',
- *     ext_data: {},
- *     limits: {
- *       *los: 0,
- *       *students: 0
- *     }
- *   },
- *   checkLimits: {
- *     student: 0,
- *     teacher: 0
- *   },
- *   clone_settings: {
- *     *src_ext_classid: 'string',
- *     products: boolean,
- *     bundles: boolean,
- *     assigned_paths: boolean,
- *     ext_assigned_path_id_rule: 'string'  //enum: ['SRC_ID']
- *     advanced: {
- *       assigned_paths: [                  //length > 0 if assigned_paths flag is true
- *         {
- *           *ext_assignedpathid: 'string',
- *           *assigned_path_id: 'string',
- *           startdate: 0,
- *           *duedate: 0
- *         },
- *       ],
- *       products: [
- *         { *productcode: 'string' },
- *       ],
- *       bundles: [
- *         { *bundlecode: 'string' },
- *       ]
- *     }
- *   }
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#shadowprovisionparams
  */
 function shadowProvision(options) {
   var self = this;
@@ -596,21 +478,10 @@ function shadowProvision(options) {
   return dfd.promise;
 }
 
-/*options = {
-    ext_user_id: 'string',
-    ext_actor_id: 'string',
-    ext_role: 'string',
-    ref_id: 'string', (optional)
-    productcode: 'string',
-    ext_product_id: 'string',
-    ext_product_meta: {
-      startdate: 'string',
-      enddate: 'string',
-      ...
-    },
-    ext_data: {},
-    audit: boolean
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#entitleusertoproductparams
+ */
 function entitleUserToProduct(options) {
   var self = this;
   // Initializing promise
@@ -641,7 +512,7 @@ function entitleUserToProduct(options) {
   } else {
     var err = {};
     err.description = 'Missing mandatory keys in request options. \'ext_user_id\', \'ext_role\' and ' +
-                      'either of \'ext_product_id\' or \'productcode\' must be present.'
+                      'either of \'ext_product_id\' or \'productcode\' must be present.';
     err.message = err.description;
     err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
     dfd.reject(err);
@@ -650,12 +521,10 @@ function entitleUserToProduct(options) {
   return dfd.promise;
 }
 
-/*options = {
-    ext_user_id: 'string',
-    ext_actor_id: 'string',
-    productcode: 'string',
-    audit: 'boolean'
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#unentitleusertoproductparams
+ */
 function unentitleUserToProduct(options) {
   var self = this;
   var dfd = q.defer();
@@ -698,22 +567,10 @@ function unentitleUserToProduct(options) {
   return dfd.promise;
 }
 
-/* This function calls the ComproDLS API to micro entitle user to a product.
-options = {
-    "ext_user_id": "string",    // Mandatory
-    "ext_actor_id": "string",   // Optional
-    "feature_key": "string",    // Mandatory
-    "feature_id": "string",     // Mandatory
-    "context": "string",        // Mandatory
-    "data": {},                 // Optional
-    "productcode": "string",    // one of productcode and ext_product_id is mandatory
-    "ext_product_id": "string",
-    "ext_entitlement_meta": {    //Optional
-      "startdate": "epoch",
-      "enddate": "epoch"       //mandatory, if ext_entitlement_meta provided.
-    },
-    "audit": boolean            // Optional
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#microentitleusertoproductparams
+ */
 function microEntitleUserToProduct(options) {
   var self = this;
   // Initializing promise
@@ -764,30 +621,10 @@ function microEntitleUserToProduct(options) {
   return dfd.promise;
 }
 
-/* This function calls the ComproDLS API to micro entitle user to product.
-options = {
-    "micro-entitlements": [{    // Mandatory, Min: 1
-    "ext_user_id": "string",    // Mandatory
-
-    "productcode": "string",
-    "ext_product_id": "string",
-
-    "context": "string",
-    "feature_key": "string",
-    "feature_id": "string",,
-    "data": {},
-    "ext_entitlement_meta": {
-      "startdate": 0,
-      "enddate": 0
-    },
-
-    "ext_actor_id": "string",        // Mandatory if 'audit' is true
-    "audit": true
-    },
-  …
-  ]
-}
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#bulkmicroentitleproducttouserparams
+ */
 function bulkMicroEntitleProductToUser(options) {
   var self = this;
   // Initializing promise
@@ -817,7 +654,7 @@ function bulkMicroEntitleProductToUser(options) {
   } else {
     var err = {};
     err.description = 'Missing mandatory keys in request options.' +
-      ' \'micro-entitlements\' must be present.'
+      ' \'micro-entitlements\' must be present.';
     err.message = err.description;
     err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
     dfd.reject(err);
@@ -826,16 +663,10 @@ function bulkMicroEntitleProductToUser(options) {
   return dfd.promise;
 }
 
-/* This function calls the ComproDLS API to revoke micro entitlement of a user.
-options = {
-    "ext_user_id": "string",    // Mandatory
-    "ext_actor_id": "string",   // Mandatory
-    "feature_key": "string",    // Mandatory
-    "context": "string",        // Mandatory
-    "productcode": "string",    // one of productcode and ext_product_id is mandatory
-    "ext_product_id": "string",
-    "audit": boolean            // Mandatory
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#revokemicroentitlementofauserparams
+ */
 function revokeMicroEntitlementOfAUser(options) {
   var self = this;
   // Initializing promise
@@ -880,9 +711,10 @@ function revokeMicroEntitlementOfAUser(options) {
   return dfd.promise;
 }
 
-/*options = {
-    ext_product_id: 'string'
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#getextproductparams
+ */
 function getExtProduct(options) {
   var self = this;
   // Initializing promise
@@ -916,9 +748,10 @@ function getExtProduct(options) {
   return dfd.promise;
 }
 
-/*options = {
-    spacekey: 'string'
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#getspacedetailsparams
+ */
 function getSpaceDetails(options) {
   var self = this;
   // Initializing promise
@@ -955,15 +788,10 @@ function getSpaceDetails(options) {
   return dfd.promise;
 }
 
-/*options = {
-    ext_user_id: 'string',
-    ext_role: 'string',
-    ext_first_name: 'string',
-    ext_last_name: 'string',
-    ext_email: 'string',
-    ref_id: 'string', (optional)
-    class_code: 'string'
-}*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#enrolluserinclassparams
+ */
 function enrollUserInClass(options) {
   var self = this;
   // Initializing promise
@@ -1002,14 +830,8 @@ function enrollUserInClass(options) {
 }
 
 /**
- * This function calls the ComproDLS API to update user information.
- * options = {
- *    "ext_user_id": "string",
- *    "ref_id": "string",           // optional
- *    "ext_email": "string",        // optional
- *    "ext_first_name": "string",   // optional
- *    "ext_last_name": "string"     // optional
- * };
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#updateuserinformationparams
  */
 function updateUserInformation(options) {
   var self = this;
@@ -1055,9 +877,8 @@ function updateUserInformation(options) {
 }
 
 /**
- * This function is used to update the visibility (hide/unhide) a particular user-space of a user.
- * @param {*extuserid, *spacekey, *body: { *visibility }} options
- * @returns {promise}
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#updateuserspaceparams
  */
 function updateUserSpace(options) {
   var self = this;
@@ -1101,56 +922,47 @@ function updateUserSpace(options) {
   return deferred.promise;
 }
 
-/* options = {
-   "email": "string", // required
-   "status " : "string", // optional
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#getinvitationsbyemailparams
+ */
 function getInvitationsByEmail(options) {
-	var self = this;
-	// Initializing promise
-	var dfd = q.defer();
-	var err = {};
-	if (options && options.email) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+  var err = {};
+  if (options && options.email) {
 
-	  // Passed all validations, Contruct API url
-	  var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.getInvitationsByEmail;
-	  url = helpers.api.constructAPIUrl(url, { accountid: self.accountId });
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.getInvitationsByEmail;
+    url = helpers.api.constructAPIUrl(url, { accountid: self.accountId });
 
-	  var queryParam = { email: options.email };
-	  if (options.status) { queryParam.status = options.status; }
+    var queryParam = { email: options.email };
+    if (options.status) { queryParam.status = options.status; }
 
-	  // Setup request with URL and Params
+    // 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 = 'email not found in request options.';
-	  err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-	  dfd.reject(err);
-	}
-	return dfd.promise;
+    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 = 'email not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+  return dfd.promise;
 }
 
 /**
- * This API is used to update an institute's space title
- * options = {
- *   space_code: "",       // Mandatory, space code of institute whose title is to be updated
- *   body : {
- *     ext_actor_id: "",   // Mandatory
- *     data: {
- *       space_title: ""
- *     }
- *   }
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/18_Spaces-Adapter#updateinstitutetitleparams
  */
 function updateInstituteTitle(options){
   var self = this;

package/lib/services/spacesextn/index.js

@@ -30,9 +30,6 @@ var Agent = require('agentkeepalive');
 var helpers = require('../../helpers');
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = spacesextn;
 
 var keepaliveAgent = new Agent({
@@ -50,22 +47,8 @@ function spacesextn(accountId) {
 }
 
 /**
- * @param {
- *   *users: [{
- *      *ext_user_id: 'string',
- *      ext_role: 'string',
- *      *products: [{
- *        *productcode: 'string',
- *        ext_entitlement_meta: {
- *          start_date: <epoch>,
- *          *end_date: <epoch>
- *        },
- *        ext_data : {},
- *        *action: 'string'
- *      }]
- *   }],
- *   *ext_actor_id: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#entitlebulkuserstoproductsparams
  */
 function entitleBulkUsersToProducts(options) {
   var self = this;
@@ -107,11 +90,8 @@ function entitleBulkUsersToProducts(options) {
 }
 
 /**
- * @param {
- *  *ext_user_id: "string",
- *  *workflow_type: "string",
- *  *<workflow_type>: {}
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#setupuserparams
  */
 function setupUser(options) {
   var self = this;