@stackfactor/client-api 1.0.91 → 1.0.92

package/lib/actionNotifications.js

@@ -49,17 +49,17 @@ export const markNotifications = (ids, status, authToken) => {
  * Process a notification
  * @param {String} id The notification id
  * @param {String} action The action to be executed
- * @param {String} comment The comment to be saved in the notification
+ * @param {String} comments The comments to be saved in the notification
  * @param {String} authToken The authentication token
  */
-export const processNotification = (id, action, comment, authToken) => {
+export const processNotification = (id, action, comments, authToken) => {
   return new Promise(function (resolve, reject) {
     const request = client.put(
       `api/v1/actionnotifications/process`,
       {
         id: id,
         action: action,
-        comment: comment,
+        comments: comments,
       },
       { headers: { authorization: authToken } }
     );

package/lib/learningContent.js

@@ -31,15 +31,15 @@ const createLearningContent = (data, token) => {
 /**
  * Delete learning content
  * @param {String} id The id of the learning content to be deleted
- * @param {String} comment The comment included with the deletion
+ * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The response from the server
  */
-export const deleteLearningContent = (id, comment, token) => {
+export const deleteLearningContent = (id, comments, token) => {
   const data = {
     id: id,
   };
-  if (comment) data.comment = comment;
+  if (comments) data.comments = comments;
   return new Promise(function (resolve, reject) {
     const request = client.delete(`api/v1/learningcontent/`, {
       headers: { authorization: token },
@@ -143,14 +143,14 @@ export const getLearningContentList = (
 /**
  * Publish learning content
  * @param {String} id The id of the content to be published
- * @param {String} comment The comment to be include with the request
+ * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  * @returns {Promise<Object>} The response from the server
  */
-export const publishLearningContent = (id, comment, token) => {
+export const publishLearningContent = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     let data = {};
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
 
     let confirmationRequest = client.post(
       `api/v1/learningcontent/publish/${id}`,

package/lib/learningPath.js

@@ -27,15 +27,15 @@ export const createLearningPath = (data, token) => {
 /**
  * Delete learning path
  * @param {String} id The id of the template to be deleted
- * @param {String} comment The comment for approver
+ * @param {String} comments The comments for approver
  * @param {String} token Authorization token
  */
-export const deleteLearningPath = (id, comment, token) => {
+export const deleteLearningPath = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     const data = {
       id: id,
     };
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     const request = client.delete(`api/v1/learningpaths/`, {
       headers: { authorization: token },
       data: data,
@@ -124,13 +124,13 @@ export const getLearningPathsList = (list, version, includeDeleted, token) => {
 /**
  * Publish training pplan template
  * @param {String} id The id of the template to be published
- * @param {String} comment The comment to be include with the request
+ * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  */
-export const publishLearningPath = (id, comment, token) => {
+export const publishLearningPath = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     let data = {};
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     let confirmationRequest = client.post(
       `api/v1/learningpaths/publish/${id}`,
       data,

package/lib/logger.js

@@ -1,16 +1,16 @@
 import { client } from "./axiosClient.js";
 
 /**
- * Create a comment for a specified element id
+ * Create comments for a specified element id
  * @param {String} elementId
  * @param {String} elementType
  * @param {Object} data
  * @param {String} token Authorization token
  */
-export const comment = (elementId, elementType, data, token) => {
+export const comments = (elementId, elementType, data, token) => {
   return new Promise(function (resolve, reject) {
     let confirmationRequest = client.post(
-      "api/v1/logger/comment/",
+      "api/v1/logger/comments/",
       {
         data: data,
         elementId: elementId,
@@ -55,6 +55,6 @@ export const getListByElementId = (elementId, page, elementsPerPage, token) => {
   });
 };
 
-const logger = { comment, getListByElementId };
+const logger = { comments, getListByElementId };
 
 export default logger;

package/lib/role.js

@@ -58,16 +58,16 @@ export const createRoleFromTemplate = (templateId, data, token) => {
 /**
  * Delete role
  * @param {String} id The id of the role to be deleted
- * @param {String} comment The comment included with the deletion
+ * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
  * @returns {Promise}
  */
-export const deleteRole = (id, comment, token) => {
+export const deleteRole = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     const data = {
       id: id,
     };
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     const request = client.delete(`api/v1/roles/`, {
       headers: { authorization: token },
       data: data,
@@ -231,14 +231,14 @@ export const importRoleTemplates = (data, token) => {
 /**
  * Publish role
  * @param {number} id The id of the role to be published
- * @param {String} comment The comment to be include with the request
+ * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  * @returns {Promise}
  */
-export const publishRole = (id, comment, token) => {
+export const publishRole = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     let data = {};
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     let confirmationRequest = client.post(`api/v1/roles/publish/${id}`, data, {
       headers: { authorization: token },
     });

package/lib/roleTemplate.js

@@ -26,15 +26,15 @@ export const createRoleTemplate = (data, token) => {
 /**
  * Delete role template
  * @param {String} id The id of the template to be deleted
- * @param {String} comment The comment included with the deletion
+ * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
  */
-export const deleteRoleTemplate = (id, comment, token) => {
+export const deleteRoleTemplate = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     const data = {
       id: id,
     };
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     const request = client.delete(`api/v1/roletemplates/`, {
       headers: { authorization: token },
       data: data,
@@ -132,13 +132,13 @@ export const getRoleTemplateList = (
 /**
  * Publish template
  * @param {number} id The id of the template to be published
- * @param {String} comment The comment to be include with the request
+ * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  */
-export const publishTemplate = (id, comment, token) => {
+export const publishTemplate = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     let data = {};
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     let confirmationRequest = client.post(
       `api/v1/roletemplates/publish/${id}`,
       data,

package/lib/skill.js

@@ -56,16 +56,16 @@ export const createSkillsFromTemplates = (templateIds, token) => {
 /**
  * Delete skill
  * @param {String} id The id of the skill to be deleted
- * @param {String} comment The comment included with the deletion
+ * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
  * @returns {Promise}
  */
-export const deleteSkill = (id, comment, token) => {
+export const deleteSkill = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     const data = {
       id: id,
     };
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     const request = client.delete(`api/v1/skills/`, {
       headers: { authorization: token },
       data: data,
@@ -331,14 +331,14 @@ export const importSkillTemplates = (data, publish, token) => {
 /**
  * Publish skill
  * @param {String} id The id of the skill to be published
- * @param {String} comment The comment to be include with the request
+ * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  * @returns {Promise}
  */
-export const publishSkill = (id, comment, token) => {
+export const publishSkill = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     let data = {};
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     let confirmationRequest = client.post(`api/v1/skills/publish/${id}`, data, {
       headers: { authorization: token },
     });

package/lib/skillAssessments.js

@@ -65,7 +65,7 @@ export const create = (data, comments, userId, token) => {
 /**
  * Delete skill assessment
  * @param {number} id The id of the skill to be deleted
- * @param {String} comments The comment included with the deletion
+ * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
  */
 export const deleteSkillAssessment = (id, comments, token) => {

package/lib/skillTemplate.js

@@ -26,14 +26,14 @@ export const createSkillTemplate = (data, token) => {
 /**
  * Delete skill template
  * @param {number} id The id of the template to be deleted
- * @param {String} comment The comment included with the deletion
+ * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
  */
-export const deleteSkillTemplate = (id, comment, token) => {
+export const deleteSkillTemplate = (id, comments, token) => {
   const data = {
     id: id,
   };
-  if (comment) data.comment = comment;
+  if (comments) data.comments = comments;
   return new Promise(function (resolve, reject) {
     const request = client.delete(`api/v1/skilltemplates/`, {
       headers: { authorization: token },
@@ -162,14 +162,13 @@ export const getTechnologyStacks = (token) => {
 /**
  * Publish template
  * @param {number} id The id of the template to be published
- * @param {String} comment The comment to be include with the request
+ * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  */
-export const publishTemplate = (id, comment, token) => {
+export const publishTemplate = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     let data = {};
-    if (comment) data.comment = comment;
-
+    if (comments) data.comments = comments;
     let confirmationRequest = client.post(
       `api/v1/skilltemplates/publish/${id}`,
       data,

package/lib/trainingPlans.js

@@ -32,15 +32,15 @@ export const createTrainingPlan = (data, type, saveAsDraft, token) => {
 /**
  * Delete training plan
  * @param {String} id The id of the training plan to be deleted
- * @param {String} comment The comment for approver
+ * @param {String} comments The comments for approver
  * @param {String} token Authorization token
  */
-export const deleteTrainingPlan = (id, comment, token) => {
+export const deleteTrainingPlan = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     const data = {
       id: id,
     };
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     const request = client.delete(`api/v1/trainingplans/`, {
       headers: { authorization: token },
       data: data,
@@ -183,13 +183,13 @@ export const getListOfTrainingPlans = (
 /**
  * Publish training plan
  * @param {String} id The id of the template to be published
- * @param {String} comment The comment to be include with the request
+ * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  */
-export const publishTrainingPlan = (id, comment, token) => {
+export const publishTrainingPlan = (id, comments, token) => {
   return new Promise(function (resolve, reject) {
     let data = {};
-    if (comment) data.comment = comment;
+    if (comments) data.comments = comments;
     let confirmationRequest = client.post(
       `api/v1/trainingplans/publish/${id}`,
       data,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.0.91",
+  "version": "1.0.92",
   "description": "Node.js library for the StackFactor API",
   "main": "index.js",
   "exports": {