@stackfactor/client-api 1.0.63 → 1.0.64

package/lib/role.js

@@ -4,6 +4,7 @@ import { client } from "./axiosClient.js";
  * Create role and set information
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const createRole = (data, token) => {
   return new Promise(function (resolve, reject) {
@@ -29,6 +30,7 @@ export const createRole = (data, token) => {
  * @param {String} templateId
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const createRoleFromTemplate = (templateId, data, token) => {
   return new Promise(function (resolve, reject) {
@@ -58,6 +60,7 @@ export const createRoleFromTemplate = (templateId, data, token) => {
  * @param {String} id The id of the role to be deleted
  * @param {String} comment The comment included with the deletion
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const deleteRole = (id, comment, token) => {
   return new Promise(function (resolve, reject) {
@@ -83,6 +86,7 @@ export const deleteRole = (id, comment, token) => {
  * Discard the role draft changes
  * @param {String} id The id of the role to be deleted
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const discardRoleChanges = (id, token) => {
   return new Promise(function (resolve, reject) {
@@ -101,10 +105,32 @@ export const discardRoleChanges = (id, token) => {
   });
 };
 
+/**
+ * Get the list of imported role templates
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const getImportedRoleTemplates = (token) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.get(`api/v1/roles/getImportedRoleTemplates`, {
+      headers: { authorization: token },
+    });
+    request
+
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
 /**
  * Get role information
  * @param {number} id The id of the role
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const getRoleInformationById = (id, version, token) => {
   return new Promise(function (resolve, reject) {
@@ -129,6 +155,7 @@ export const getRoleInformationById = (id, version, token) => {
  * @param {boolean} includeDetailedInformation If true it will return detailed information
  * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const getRolesList = (
   filter,
@@ -164,6 +191,7 @@ export const getRolesList = (
  * @param {number} id The id of the role to be published
  * @param {String} comment The comment to be include with the request
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const publishRole = (id, comment, token) => {
   return new Promise(function (resolve, reject) {
@@ -187,6 +215,7 @@ export const publishRole = (id, comment, token) => {
  * @param {String} id The id of the role to be updated
  * @param {Object} data Data used to update the role
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const setRoleInformation = (id, data, token) => {
   return new Promise(function (resolve, reject) {
@@ -212,6 +241,7 @@ export const setRoleInformation = (id, data, token) => {
  * @param {String} id
  * @param {Array<Object>} roles
  * @param {String} token
+ * @returns {Promise}
  */
 export const setUserRoles = (id, roles, roleDescription, token) => {
   return new Promise(function (resolve, reject) {
@@ -238,6 +268,7 @@ export const setUserRoles = (id, roles, roleDescription, token) => {
  * @param {String} id The id of the skill to be updated
  * @param {Boolean} watch Set to true or false
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const watchRole = (id, watch, token) => {
   return new Promise(function (resolve, reject) {
@@ -263,6 +294,7 @@ const role = {
   createRoleFromTemplate,
   deleteRole,
   discardRoleChanges,
+  getImportedRoleTemplates,
   getRoleInformationById,
   getRolesList,
   publishRole,

package/lib/skill.js

@@ -4,6 +4,7 @@ import { client } from "./axiosClient.js";
  * Create skill and set information
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const createSkill = (data, token) => {
   return new Promise(function (resolve, reject) {
@@ -28,6 +29,7 @@ export const createSkill = (data, token) => {
  * Create skills from templates
  * @param {Array<String>} templateIds,
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const createSkillsFromTemplates = (templateIds, token) => {
   return new Promise(function (resolve, reject) {
@@ -56,6 +58,7 @@ export const createSkillsFromTemplates = (templateIds, token) => {
  * @param {String} id The id of the skill to be deleted
  * @param {String} comment The comment included with the deletion
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const deleteSkill = (id, comment, token) => {
   return new Promise(function (resolve, reject) {
@@ -81,6 +84,7 @@ export const deleteSkill = (id, comment, token) => {
  * Discard the skill draft changes
  * @param {String} id The id of the skill to be deleted
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const discardSkillChanges = (id, token) => {
   return new Promise(function (resolve, reject) {
@@ -99,11 +103,32 @@ export const discardSkillChanges = (id, token) => {
   });
 };
 
+/**
+ * Get the list of imported skill templates
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const getImportedRoleTemplates = (token) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.get(`api/v1/skills/getImportedSkillTemplates`, {
+      headers: { authorization: token },
+    });
+    request
+
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
 /**
  * Get the skill related roles
  * @param {String} id
  * @param {String} token
- * @returns
+ * @returns {Promise}
  */
 export const getSkillRelatedRoles = (id, token) => {
   return new Promise(function (resolve, reject) {
@@ -127,6 +152,7 @@ export const getSkillRelatedRoles = (id, token) => {
  * Get skill required assessment type
  * @param {String} id
  * @param {String} token
+ * @returns {Promise}
  */
 export const getSkillRequiredAssessmentType = (id, token) => {
   return new Promise(function (resolve, reject) {
@@ -150,6 +176,7 @@ export const getSkillRequiredAssessmentType = (id, token) => {
  * Get skill skill information
  * @param {String} id The id of the skill
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const getSkillInformationById = (id, version, token) => {
   return new Promise(function (resolve, reject) {
@@ -176,6 +203,7 @@ export const getSkillInformationById = (id, version, token) => {
  * @param {Boolean} includeDeleted If true it will return deleted records as well
  * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const getSkillList = (
   filter,
@@ -209,6 +237,7 @@ export const getSkillList = (
  * @param {String} teamId The ID of the team for which skills will be loaded
  * @param {Number} maxDepth How many levels down in the organization the skills will be loaded
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const getTeamSkillsById = (teamId, maxDepth, token) => {
   return new Promise(function (resolve, reject) {
@@ -232,6 +261,7 @@ export const getTeamSkillsById = (teamId, maxDepth, token) => {
  * Get current user team skills
  * @param {Number} maxDepth How many levels down in the organization the skills will be loaded
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const getCurrentUserTeamSkills = (maxDepth, token) => {
   return new Promise(function (resolve, reject) {
@@ -256,6 +286,7 @@ export const getCurrentUserTeamSkills = (maxDepth, token) => {
  * @param {String} id The id of the skill to be published
  * @param {String} comment The comment to be include with the request
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const publishSkill = (id, comment, token) => {
   return new Promise(function (resolve, reject) {
@@ -279,6 +310,7 @@ export const publishSkill = (id, comment, token) => {
  * @param {String} id The id of the skill to be updated
  * @param {Object} data Data used to update the skill
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const setSkillInformation = (id, data, token) => {
   return new Promise(function (resolve, reject) {
@@ -308,6 +340,7 @@ export const setSkillInformation = (id, data, token) => {
  * @param {String} id The id of the skill to be updated
  * @param {Boolean} watch Set to true or false
  * @param {String} token Authorization token
+ * @returns {Promise}
  */
 export const watchSkill = (id, watch, token) => {
   return new Promise(function (resolve, reject) {
@@ -333,6 +366,7 @@ const skill = {
   createSkillsFromTemplates,
   deleteSkill,
   discardSkillChanges,
+  getImportedSkillTemplates,
   getSkillRelatedRoles,
   getSkillRequiredAssessmentType,
   getSkillInformationById,

package/package.json

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