comprodls-sdk 2.89.0 → 2.90.0-qa

package/lib/services/authextn/index.js

@@ -30,9 +30,6 @@ var Agent = require('agentkeepalive');
 
 var DLSError = helpers.errors.DLSError;
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
 module.exports = authextn;
 
 var keepaliveAgent = new Agent({
@@ -75,21 +72,10 @@ function authextn() {
  * Public Function definitions
  **********************************/
 
-/*
-  options = {
-    body : {
-      gradeformat_id: "string", //mandatory
-      grades:[ {                //mandatory
-        id: "string",
-        title: "string",
-        min_threshold: "string",
-        max_threshold: "string",
-        target: boolean
-      }, ...]
-      data: {}
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#creategradeformatparams
+ */
 function createGradeformat(options) {
   var self = this;
   // Initializing promise
@@ -136,21 +122,10 @@ function createGradeformat(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    gradeformat_id: "string",    // Mandatory
-    body : {
-      grades: [ {
-        id: "string",
-        title: "string",
-        min_threshold: "string",
-        max_threshold: "string",
-        target: boolean
-      }, ...]
-      data: {...}
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#updategradeformatparams
+ */
 function updateGradeformat(options) {
   // Initializing promise
   var deferred = q.defer();
@@ -211,11 +186,10 @@ function updateGradeformat(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    gradeformat_id: "string" //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#deletegradeformatparams
+ */
 function deleteGradeformat(options) {
   var self = this;
   var dfd = q.defer();
@@ -261,11 +235,10 @@ function deleteGradeformat(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    gradeformat_id: "string" //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticulargradeformatparams
+ */
 function getParticularGradeformat (options) {
   // Initializing promise
   var deferred = q.defer();
@@ -313,11 +286,10 @@ function getParticularGradeformat (options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    cursor: "string"
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getallgradeformatsparams
+ */
 function getAllGradeformats (options) {
   // Initializing promise
   var deferred = q.defer();
@@ -363,20 +335,8 @@ function getAllGradeformats (options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string',
- *   *body: {
- *     *grades: [{
- *       id: 'string',
- *       title: 'string',
- *       min_threshold: 'string',
- *       max_threshold: 'string',
- *       target: <boolean>
- *     }],
- *     data: {}
- *   }
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#associategradeformattoclassparams
  */
 function associateGradeformatToClass(options) {
   var self = this;
@@ -432,10 +392,8 @@ function associateGradeformatToClass(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#unassociategradeformatfromclassparams
  */
 function unassociateGradeformatFromClass(options) {
   var self = this;
@@ -487,20 +445,8 @@ function unassociateGradeformatFromClass(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string',
- *   *body: {
- *     grades: [{
- *       id: 'string',
- *       title: 'string',
- *       min_threshold: 'string',
- *       max_threshold: 'string',
- *       target: <boolean>
- *     }],
- *     data: {}
- *   }
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#updateclassgradeformatassociationparams
  */
 function updateClassGradeformatAssociation(options) {
   var self = this;
@@ -556,10 +502,8 @@ function updateClassGradeformatAssociation(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   *gradeformat_id: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticulargradeformatofaclassparams
  */
 function getParticularGradeformatOfAClass(options) {
   var self = this;
@@ -610,10 +554,8 @@ function getParticularGradeformatOfAClass(options) {
 }
 
 /**
- * @param {
- *   *classid: 'string',
- *   cursor: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getallgradeformatsofaclassparams
  */
 function getAllGradeformatsOfAClass(options) {
   var self = this;
@@ -666,10 +608,8 @@ function getAllGradeformatsOfAClass(options) {
 }
 
 /**
- * @param {
- *   *gradeformat_id: 'string',
- *   cursor: 'string'
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getclassesofagradeformatparams
  */
 function getClassesOfAGradeformat(options) {
   var self = this;
@@ -722,21 +662,10 @@ function getClassesOfAGradeformat(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    assignedpathid: "string",  // Mandatory
-    classid: "string",         // Mandatory
-    body : {
-      "users":[                   // min:1 , max: 50
-        {
-          extUserId: "string",   // Mandatory
-        }
-          ....
-      ],
-      "context": {}          // Optional
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#createuserassignedpathenrollmentsparams
+ */
 function createUserAssignedPathEnrollments(options) {
   var self = this;
   // Initializing promise
@@ -786,18 +715,10 @@ function createUserAssignedPathEnrollments(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    assignedpathid: "string",  // Mandatory
-    classid: "string",         // Mandatory
-    body : [                   // min:1 , max: 50
-      {
-        extUserId: "string", //Mandatory
-      },
-      ...
-    ]
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#deleteuserassignedpathenrollmentsparams
+ */
 function deleteUserAssignedPathEnrollments(options) {
   var self = this;
   // Initializing promise
@@ -848,11 +769,8 @@ function deleteUserAssignedPathEnrollments(options) {
 }
 
 /**
- * @param {
- *  classid: <string>,         // mandatory
- *  productDetails: <Boolean>,  // optional
- *  bundleDetails: <Boolean>    // optional
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticularclassv2params
  */
 function getParticularClassV2(options) {
   var self = this;
@@ -899,15 +817,8 @@ function getParticularClassV2(options) {
 }
 
 /**
- * @param {
- *  *productcode: "string",
- *  status: "string"             // ['active', 'revoked'] - default: 'active'
- *  expired: <boolean>,          // default: false
- *  startdate: <epoch>,
- *  enddate: <epoch>,
- *  audit: <boolean>             // [true] - default: true
- *  ext_data: {...},
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#createorgproductentitlementparams
  */
 function createOrgProductEntitlement(options) {
   var self = this;
@@ -953,15 +864,8 @@ function createOrgProductEntitlement(options) {
 }
 
 /**
- * @param {
- *  *productcode: "string",
- *  status: "string"             // ['active', 'revoked']
- *  expired: <boolean>,
- *  startdate: <epoch>,
- *  enddate: <epoch>,
- *  audit: <boolean>             // [true] - default: true
- *  ext_data: {...},
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#updateorgproductentitlementparams
  */
 function updateOrgProductEntitlement(options) {
   var self = this;
@@ -1009,9 +913,8 @@ function updateOrgProductEntitlement(options) {
 }
 
 /**
- * @param {
- *  *productcode: "string"
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getparticularorgproductentitlementparams
  */
 function getParticularOrgProductEntitlement(options) {
   var self = this;
@@ -1051,11 +954,8 @@ function getParticularOrgProductEntitlement(options) {
 }
 
 /**
- * @param {
- *  status: "string"             // ['active', 'revoked']
- *  expired: <boolean>,
- *  cursor: <epoch>
- * } options
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/28_AUTHEXTN-Adapter#getallorgproductentitlementsparams
  */
 function getAllOrgProductEntitlements(options) {
   var self = this;

package/lib/services/datasyncmanager/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 = datasyncmanager;
 
 var keepaliveAgent = new Agent({
@@ -53,22 +50,8 @@ function datasyncmanager(accountId) {
 }
 
 /**
- * options = {
- * "*body": {
- *  "*dsmid": "string",
- *  "dsm_groupid": "string",
- *  "rules_orgs": [{"*id": "string"}, ...],
- *  "rules_products": [{
- *    "*productcode": "string",
- *    "*ext_entitlement_meta": { "start_date", "*end_date" },
- *    "*target_roles": [role]
- *  }],
- *  "*category": "entitlement_sync",
- *  "*type": "managed",
- *  "*ext_user_id": "string",
- *  "data": {},
- *  "*audit": true
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#createdatasyncmanagerparams
  */
 function createDataSyncManager(options) {
   var self = this;
@@ -109,20 +92,8 @@ function createDataSyncManager(options) {
  }
 
 /**
- * options = {
- *   "*dsmid": "datasyncmanagerid",
- *   "*body": {
- *     "rules_orgs": [{ "*id": "orgid" }, ...],
- *     "*rules_products": [{
- *       "*productcode": "<productcode-1>",
- *       "*ext_entitlement_meta": { "start_date", "*end_date" },
- *       "target_roles": ["role"],
- *     }],
- *     "*ext_user_id": "ext_actor_id",
- *     "data": {},
- *     "*audit": <boolean>
- *   }
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#updatedatasyncmanagerparams
  */
 function updateDataSyncManager(options) {
   // Initializing promise
@@ -171,12 +142,8 @@ function updateDataSyncManager(options) {
 }
 
 /**
- * options = {
- * "*dsmid": "string",
- * "*body": {
- *  "*ext_user_id": "string",
- *  "*audit": true
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#deletedatasyncmanagerparams
  */
 function deleteDataSyncManager(options) {
   var self = this;
@@ -216,9 +183,8 @@ function deleteDataSyncManager(options) {
 }
 
 /**
- * options = {
- *   "*dsmid": "datasyncmanagerid"
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#getparticulardatasyncmanagerparams
  */
 function getParticularDataSyncManager(options) {
   // Initializing promise
@@ -263,9 +229,8 @@ function getParticularDataSyncManager(options) {
 }
 
 /**
- * options = {
- *   "*dsm_groupid": "datasyncmanagergroupid"
- * }
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/27_DATASYNCMANAGER-Adapter#getalldatasyncmanagersofagroupparams
  */
 function getAllDataSyncManagersOfAGroup(options) {
   // Initializing promise

package/lib/services/drive/index.js

@@ -23,10 +23,6 @@
  * Functions for calling Drive-service API.
  ************************************************************/
 
-/*********************************
- * Setting Up Module Entry Point
- **********************************/
-
 var q = require('q');
 var request = require('superagent');
 var Agent = require('agentkeepalive');
@@ -54,14 +50,10 @@ function documents() {
   };
 }
 
-/*
-  options = {
-    accountid : 'string', //mandatory
-    extuserid : 'string', //mandatory
-    documentid : 'string', //mandatory
-    folderid: 'string',  //mandatory
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/24_DRIVE-Adapter#getaparticulardocumentparams
+ */
 function getAParticularDocument(options) {
   var self = this;
   var dfd = q.defer();
@@ -99,18 +91,10 @@ function getAParticularDocument(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    accountid: 'string', //mandatory
-    extuserid: 'string', //mandatory
-    folderid: 'string',  //mandatory
-    classid: 'string',
-    productcode: 'string',
-    assigned_path_id: 'string',
-    item-code: 'string',
-    cursor: 'string'
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/24_DRIVE-Adapter#getalldocumentsinafolderparams
+ */
 function getAllDocumentsInAFolder(options) {
   var self = this;
   var dfd = q.defer();
@@ -152,31 +136,10 @@ function getAllDocumentsInAFolder(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    accountid: 'string',          // mandatory
-    extuserid: 'string',          // mandatory
-    body: {                       // mandatory
-      orgid: 'string',            // mandatory
-      classid: 'string',
-      productcode: 'string',      // mandatory
-      dls_user_id: 'string',      // mandatory
-      collaborator_id: 'string'   // optional; mandatory if some OTHER user is updating this document.
-      entities: [                 // mandatory (Min length 1)
-        {
-          item_code: 'string',
-          folderid: 'string',     // mandatory
-          documentid: 'string',   // mandatory
-          tag: 'string',
-          timestamp: <epoch>,     // mandatory
-          ttl: <number>,          // optional, default - 3 months
-          data: {}                // mandatory, state JSON
-        },
-        ...
-      ]
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/24_DRIVE-Adapter#createmultipledocumentsparams
+ */
 function createMultipleDocuments(options) {
   var self = this;
   var dfd = q.defer();
@@ -216,25 +179,10 @@ function createMultipleDocuments(options) {
   return dfd.promise;
 }
 
-/*
-  options = {
-    accountid: 'string',          // mandatory
-    extuserid: 'string',          // mandatory
-    body: {                       // mandatory
-      collaborator_id: 'string'   // optional; mandatory if some OTHER user is updating this document.
-      entities: [                 // mandatory (Min length 1)
-        {
-          folderid: 'string',     // mandatory
-          documentid: 'string',   // mandatory
-          timestamp: <epoch>,     // mandatory
-          ttl: <number>,
-          data: {}
-        },
-        ...
-      ]
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/24_DRIVE-Adapter#updatemultipledocumentsparams
+ */
 function updateMultipleDocuments(options) {
   // Initializing promise
   var deferred = q.defer();
@@ -277,21 +225,10 @@ function updateMultipleDocuments(options) {
   return deferred.promise;
 }
 
-/*
-  options = {
-    accountid: 'string',        // mandatory
-    extuserid: 'string',        // mandatory
-    body: {                     // mandatory
-      entities: [               // mandatory (Min length 1)
-        {
-          folderid: 'string',   // mandatory
-          documentid: 'string', // mandatory
-        },
-        ...
-      ]
-    }
-  }
-*/
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/24_DRIVE-Adapter#deletemultipledocumentsparams
+ */
 function deleteMultipleDocuments(options) {
   var self = this;
   var dfd = q.defer();