comprodls-sdk 2.89.0 → 2.90.0-qa

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,31 +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",
-        "line1": "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;
@@ -89,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); }
 
@@ -109,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
@@ -154,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
@@ -200,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
@@ -240,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
@@ -279,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
@@ -313,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);
@@ -321,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
@@ -363,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
@@ -406,27 +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",
-          "line1": "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;
@@ -447,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) {

package/lib/services/xapi/index.js

@@ -23,10 +23,6 @@
  * Functions for calling xAPI.
  ************************************************************/
 
-/*********************************
- * Setting Up Module Entry Point  
- **********************************/
-
 var q = require('q');
 var request = require('superagent');
 
@@ -46,69 +42,9 @@ function xapi(accountId) {
   };
 }
 
-/*
-options = {
-  actor: {
-    uuid: 'string', // userid of user posting statement / 'me'
-    group: 'string' // (optional)
-  },
-  product: { // optional
-    code: 'string',
-    title: 'string' // (optional)
-    ext-item: boolean  // (optional, all items in entities will be treated as external items, hence no progress JSON update for them)
-  },
-  classid: 'string', // (optional) Specify if posting via class,
-  space_key: 'string'// (optional)
-
-  entities: [{
-    assigned_path_id: 'string' //optional, assigned-path of a class
-    timestamp: 0,
-    verb: 'string', // [redo | evaluated | launched | interacted | completed | answered | attempted | scored | submitted']
-          //('redo' verb can only be sent by teacher, admin and superadmin )
-    model: 'string', // (optional) model hierarchy of resource if available
-    item-code: 'string', // item-code of resource(optional)
-    user_data: {
-        documentid: 'string',
-        folderid: 'string',
-        action: 'create/update/delete',
-        type: 'string',
-        payload: 'string'
-    },
-    timespent: 0, // (optional)
-    activity_status: 'string', // (optional) ['in_process', 'timed_out', 'completed']
-    result: { // (optional)
-      response: {
-          audioPath: 'string',
-          text: 'string',
-          link: [
-            {
-              url: 'string',
-              title: 'string',
-              description: 'string'
-            }
-          ],
-          attribs: {}
-      },
-      score: { // optional
-        min: 0,
-        scaled: 0,
-        max: 0,
-        raw: 0
-      },
-      comment: 'string', // optional
-      questions: [{ // optional
-        question-code: 'string',
-        status-progress: 'string',  // [not_attempted | in_progress]
-        status-evaluation: 'string' // [not_applicable | partially_correct | correct | incorrect]
-      }]
-    },
-    link-statementid: 'string' // required in case of verb = evaluated
-  }],
-  platform: {
-    ua: 'string',
-    sessionid: 'string'
-  }
-};
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/08_XAPI-Adapter#poststatementsparams
 */
 function postStatements(options) {
   var self = this;
@@ -148,64 +84,9 @@ function postStatements(options) {
   return dfd.promise;
 }
 
-/*
-options = {
-  actor: {
-    ext_user_id: 'string', // (optional) who triggered the action - EXTERNAL_SYSTEM in case of verb = evaluated_external
-    uuid: 'string' // who triggered the action - EXTERNAL_SYSTEM in case of verb = evaluated_external
-  },
-  product: {
-    code: 'string',
-    title: 'string' // (optional)
-    ext-item: boolean  // (optional, all items in entities will be treated as external items, hence no progress JSON update for them)
-  },
-  student_userid: "string", // (optional when verb = submitted_external) ON whom is the action taking place
-  student_ext_user_id: "string", // (optional when verb = submitted_external) ON whom is the action taking place
-  classid: 'string', // (optional) Specify if posting via class
-  space_key: 'string', // (optional)
-  platform: {
-    ua: "string"
-  },
-  group: {           // (optional)
-    id: "string"
-  }
-  entities: [{
-    assigned_path_id: 'string' //(optional) assigned-path of a class
-    timestamp: 0,
-    verb: 'string', // [evaluated_external, submitted_external]
-    model: 'string', // (optional) model hierarchy of resource if available
-    item-code: 'string', // item-code of resource
-    timespent: 0, // (optional)
-    part: integer, // (mandatory only for verb = evaluated_external)
-    submission_order: integer, //  [1, 2, 3]
-    result: { // (optional)
-      "response": {
-        "text": "string",
-        "audioPath": "string",
-        "link": [
-          {
-            "url": "string",
-            "title": "string",
-            "description": "string"
-          }
-        ]
-      },
-      "score": {
-        "min": 0,
-        "scaled": 0,
-        "max": 0,
-        "raw": 0
-      },
-      "comment": "string",  // (optional)
-      "ext_data": "string", // (optional)
-      questions: [{         // (optional)
-        question-code: 'string',
-        status-progress: 'string',  // [not_attempted | in_progress]
-        status-evaluation: 'string' // [not_applicable | partially_correct | correct | incorrect]
-      }]
-    }
-  }]
-}
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/08_XAPI-Adapter#postexternalstatementsparams
 */
 function postExternalStatements(options) {
   var self = this;