comprodls-sdk 2.90.3-development → 2.92.0-thor

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({
@@ -44,27 +41,14 @@ var keepaliveAgent = new Agent({
 function spacesextn(accountId) {
   this.accountId = accountId;
   return {
-    entitleBulkUsersToProducts: entitleBulkUsersToProducts.bind(this)
+    entitleBulkUsersToProducts: entitleBulkUsersToProducts.bind(this),
+    setupUser: setupUser.bind(this)
   };
 }
 
 /**
- * @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;
@@ -105,3 +89,43 @@ function entitleBulkUsersToProducts(options) {
   return dfd.promise;
 }
 
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#setupuserparams
+ */
+function setupUser(options) {
+  var self = this;
+  //Initializing promise
+  var deferred = q.defer();
+
+  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 });
+
+    var requestAPI = request.post(url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .send(options);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    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 {
+    var 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/superuser/index.js

@@ -30,26 +30,22 @@ var helpers = require('../../helpers');
 
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = superuser;
 
 //Superuser Adaptor Contsructor
 function superuser(accountId) {
-    this.accountId = accountId;
-    return {
-      getAllInstitutions: getAllInstitutions.bind(this),
-      getInstitution: getInstitution.bind(this),
-      provisionSpacesToSuperAdmin: provisionSpacesToSuperAdmin.bind(this)
-    };
-  }
-  
-  /*options = {
-    "lookup": "string",
-    "limit": "integer",
-    "cursor": "object"
-  }*/
+  this.accountId = accountId;
+  return {
+    getAllInstitutions: getAllInstitutions.bind(this),
+    getInstitution: getInstitution.bind(this),
+    provisionSpacesToSuperAdmin: provisionSpacesToSuperAdmin.bind(this)
+  };
+}
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_Superuser-Adapter#getallinstitutionsparams
+ */
 function getAllInstitutions(options) {
   var self = this;
   // Initializing promise
@@ -81,15 +77,16 @@ function getAllInstitutions(options) {
 
   return dfd.promise;
 }
-  
-  /** This function gets a particular Instituion using the unique identifier (space_code)
-   *  options = { "spacecode" : "string" }
-   */
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_Superuser-Adapter#getinstitutionparams
+ */
 function getInstitution(options) {
   var self = this;
   // Initializing promise
   var dfd = q.defer();
-  
+
   // Validations
   if(options && options.spacecode) {
     // Passed all validations, Contruct API url
@@ -109,7 +106,7 @@ function getInstitution(options) {
       }
       else { dfd.resolve(response.body); }
     });
-  } 
+  }
   else {
     var err = {};
     err.message = err.description = 'spacecode not found in request options.';
@@ -120,20 +117,8 @@ function getInstitution(options) {
 }
 
 /**
- * This will provision space to the super admin in shared/institutional org.
- * Note: The super admin can only be provisioned in one (shared/institutional) org at a time.
- *
- * @param {Object} options {
-    "ext_user_id": "string",
-    "ext_role": "string",
-    "ext_email": "string",
-    "ext_first_name": "string",
-    "ext_last_name": "string",
-    "address": { "country": "string" }   // optional
-    "space_code": "string",              // optional, to provision the superadmin in institutional space.
-    "private_space": boolean             // optional, to provision the superadmin in shared space.
-  }
- * @return {Promise} Promise.resolve({ entities:[ { spaces object }], count: entities.length })
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/19_Superuser-Adapter#provisionspacestosuperadminparams
  */
 function provisionSpacesToSuperAdmin(options) {
   var self = this;

package/lib/services/taxonomy/index.js

@@ -29,10 +29,8 @@ var helpers = require('../../helpers');
 
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = taxonomy;
+
 //Taxonomy Adaptor Contsructor
 function taxonomy() {
   return {
@@ -51,10 +49,8 @@ function taxonomy() {
  **********************************/
 
 /**
- * options = {
- * entity_type: 'type of entity',
- * entity_id: 'id of the entity',
- * tags: 'array of tags for association with entity'
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/25_TAXONOMY-Adaptor#associatetagswithentityparams
  */
 function associateTagsWithEntity(options) {
   var self = this;
@@ -102,20 +98,10 @@ function associateTagsWithEntity(options) {
   return dfd.promise;
 }
 
-
-/*
-  options = {
-    context: "string", //mandatory
-    taxonomyid: "string", //mandatory
-    body: {
-      tags: [{
-        "tagid": "",
-        "tagname": "",
-        "tag_data": {} // optional
-      }]
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/25_TAXONOMY-Adaptor#createtagsparams
+ */
 function createTags(options) {
   var self = this;
   // Initializing promise
@@ -158,16 +144,10 @@ function createTags(options) {
   return dfd.promise;
 }
 
- /* options = {
-    "context": "string", //mandatory
-    "taxonomyid": "string" //mandatory
-    "body": {
-      "tagid": "string", //mandatory
-      "tagname": "string",
-      "tag_data": {}
-    }
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/25_TAXONOMY-Adaptor#updatetagsparams
+ */
 function updateTags(options) {
   var self = this;
   // Initializing promise
@@ -214,12 +194,10 @@ function updateTags(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "context": "string", // required
-    "taxonomyid" : "string", // required
-    "tagid" : "string"
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/25_TAXONOMY-Adaptor#deletetagsparams
+ */
 function deleteTags(options) {
   var self = this;
   // Initializing promise
@@ -268,13 +246,10 @@ function deleteTags(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    context: "string", //mandatory
-    taxonomyid: "string", //mandatory
-    tagid: "string" //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/25_TAXONOMY-Adaptor#gettagparams
+ */
 function getTag(options) {
   var self = this;
   // Initializing promise
@@ -324,13 +299,10 @@ function getTag(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    context: "string", //mandatory
-    taxonomyid: "string", //mandatory
-    tagid: "string" //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/25_TAXONOMY-Adaptor#gettaghierarchyparams
+ */
 function getTagHierarchy(options) {
   var self = this;
   // Initializing promise
@@ -380,12 +352,10 @@ function getTagHierarchy(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    context: "string", //mandatory
-    taxonomyid: "string" //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/25_TAXONOMY-Adaptor#getalltagsparams
+ */
 function getAllTags(options) {
   var self = this;
   // Initializing promise

package/lib/services/workflows/index.js

@@ -26,10 +26,6 @@ var request = require('superagent');
 var helpers = require('./../../helpers');
 var DLSError = helpers.errors.DLSError;
 
-/*************************************
- * Setting up Exports/Public functions
- *************************************/
-
 module.exports = workflows;
 
 //Workflows Adaptor Constructor
@@ -45,30 +41,16 @@ function workflows(accountId) {
     revokeAWorkflow: revokeAWorkflow.bind(this),
     completeAWorkflow: completeAWorkflow.bind(this),
     updateWorkflowRequest: updateWorkflowRequest.bind(this)
-  }
+  };
 }
 
 /*********************************
  * Public Function definitions
  **********************************/
+
 /**
- * options={
-    "ext_user_id": "string", //mandatory
-    "workflow_type": "institution_request", //mandatory
-    "institution_request": {
-      "address": {
-        "city": "string",
-        "country": "string",
-        "street1": "string",
-        "street2": "string",
-        "street3": "string",
-        "house_no": "string",
-        "post_code": "string"
-      },
-      "display_name": "string",
-      "school_key": "string"
-    }
-  }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#createworkflowparams
  */
 function createWorkflow(options) {
   var self = this;
@@ -88,7 +70,7 @@ function createWorkflow(options) {
     var requestAPI = request.post(url)
     .set('Content-Type', 'application/json')
     .set('Accept', 'application/json')
-    .send(options)
+    .send(options);
 
     if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
@@ -108,14 +90,10 @@ function createWorkflow(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "workflow_type": "string", // required
-    "status" : "string", // required
-    "start": "string" //epoch
-    "end": "string" //epoch
-    "cursor" : "string"
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#getallworkflowparams
+ */
 function getAllWorkflow(options) {
   var self = this;
   // Initializing promise
@@ -153,15 +131,10 @@ function getAllWorkflow(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "workflow_type": "string", // required
-    "status" : "string", // required
-    "ext_user_id": "string" //required
-    "start": "string" //epoch
-    "end": "string" //epoch
-    "cursor" : "string"
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#getallworkflowofauserparams
+ */
 function getAllWorkflowOfAUser(options) {
   var self = this;
   // Initializing promise
@@ -199,11 +172,10 @@ function getAllWorkflowOfAUser(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "workflowid": "string", // required
-    "context_id" : "string", // required
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#getaworkflowparams
+ */
 function getAWorkflow(options) {
   var self = this;
   // Initializing promise
@@ -239,13 +211,10 @@ function getAWorkflow(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "workflowid": "string", // required
-    "body" : {              // required
-      "context_id": "string"  // required
-    }
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#acceptaworkflowparams
+ */
 function acceptAWorkflow(options) {
   var self = this;
   // Initializing promise
@@ -278,14 +247,10 @@ function acceptAWorkflow(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "workflowid": "string", // required
-    "body" : {              // required
-      "context_id": "string",  // required
-      "org_id": "string",   // required
-    }
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#processaworkflowparams
+ */
 function processAWorkflow(options) {
   var self = this;
   // Initializing promise
@@ -312,7 +277,7 @@ function processAWorkflow(options) {
   }
   else {
     err = {};
-    err.message = err.description = 'Mandatory params - workflowid, body, body.context_id, body.org_id' + 
+    err.message = err.description = 'Mandatory params - workflowid, body, body.context_id, body.org_id' +
                                     ' in request options.';
     err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
     dfd.reject(err);
@@ -320,13 +285,10 @@ function processAWorkflow(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "workflowid": "string", // required
-    "body" : {              // required
-      "context_id": "string"  // required
-    }
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#revokeaworkflowparams
+ */
 function revokeAWorkflow(options) {
   var self = this;
   // Initializing promise
@@ -362,13 +324,10 @@ function revokeAWorkflow(options) {
   return dfd.promise;
 }
 
-/* options = {
-    "workflowid": "string", // required
-    "body" : {              // required
-      "context_id": "string"  // required
-    }
-  };
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#completeaworkflowparams
+ */
 function completeAWorkflow(options) {
   var self = this;
   // Initializing promise
@@ -405,26 +364,8 @@ function completeAWorkflow(options) {
 }
 
 /**
- * options={
- *  "context_id": "string", //mandatory
- *  "body": {
-      "ext_user_id": "string", //mandatory
-      "workflow_type": "institution_request", //mandatory
-      "institution_request": {
-        "address": {
-          "city": "string",
-          "country": "string",
-          "street1": "string",
-          "street2": "string",
-          "street3": "string",
-          "house_no": "string",
-          "post_code": "string"
-        },
-        "display_name": "string",
-        "school_key": "string"
-      }
-    } 
-  }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/21_Workflows-Adapter#updateworkflowrequestparams
  */
 function updateWorkflowRequest(options) {
   var self = this;
@@ -445,7 +386,7 @@ function updateWorkflowRequest(options) {
     var requestAPI = request.put(url)
     .set('Content-Type', 'application/json')
     .set('Accept', 'application/json').query(queryParams)
-    .send(options.body)
+    .send(options.body);
 
     if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
     requestAPI.end(function(error, response) {
@@ -462,4 +403,4 @@ function updateWorkflowRequest(options) {
     dfd.reject(err);
   }
   return dfd.promise;
-}
+}