@stackfactor/client-api 1.0.0

package/lib/roleTemplate.js

@@ -0,0 +1,243 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Create role template and set information
+   * @param {Object} data
+   * @param {String} token Authorization token
+   */
+  createRoleTemplate(data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+      };
+      let confirmationRequest = axios.put("api/v1/roletemplates", requestData, {
+        headers: { authorization: token },
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * 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} token Authorization token
+   */
+  deleteRoleTemplate(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {
+        id: id,
+      };
+      if (comment) data.comment = comment;
+      const request = axios.delete(`api/v1/roletemplates/`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Discard the role template draft changes
+   * @param {String} id The id of the role template to be deleted
+   * @param {String} token Authorization token
+   */
+  discardRoleTemplateChanges(id, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {};
+      const request = axios.get(`api/v1/roletemplates/discard/${id}`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get role template information
+   * @param {String} id The id of the template
+   * @param {String} token Authorization token
+   */
+  getRoleTemplateInformationById(id, version, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/roletemplates/${id}/${version}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get role template list
+   * @param {Array<String>} filter The list of integrations to be received
+   * @param {boolean} includeDeleted When true it will return the deleted records as well
+   * @param {String} token Authorization token
+   */
+  getRoleTemplateList(filter, version, includeDeleted, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        version: version,
+        includeDeleted: includeDeleted,
+      };
+      if (filter) requestData.filter = filter;
+      let confirmationRequest = axios.post(
+        `api/v1/roletemplates`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * 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} token Authorization token
+   */
+  publishTemplate(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      let data = {};
+      if (comment) data.comment = comment;
+      let confirmationRequest = axios.post(
+        `api/v1/roletemplates/publish/${id}`,
+        data,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Set template profile information
+   * @param {String} id The id of the template to be updated
+   * @param {Object} data Data used to update the template
+   * @param {String} token Authorization token
+   */
+  setTemplateInformation(id, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+        id: id,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/roletemplates/update`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update the role template tags
+   * @param {String} id The id of the template to be updated
+   * @param {Object} tags Updated template tags
+   * @param {String} token Authorization token
+   */
+  setTemplateTags(id, tags, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        tags: tags,
+        id: id,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/roletemplates/updatetags/`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Watch role template
+   * @param {String} id The id of the skill to be updated
+   * @param {Boolean} watch Set to true or false
+   * @param {String} token Authorization token
+   */
+  watchRoleTemplate(id, watch, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        id: id,
+        watch: watch,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/roletemplates/watch`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/skill.js

@@ -0,0 +1,338 @@
+import axios from "./axios";
+
+// eslint-disable-next-line no-undef
+export default {
+  axios: axios,
+
+  /**
+   * Create skill and set information
+   * @param {Object} data
+   * @param {String} token Authorization token
+   */
+  createSkill(data, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.put(
+        "api/v1/skills",
+        { data: data },
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Create skills from templates
+   * @param {Array<String>} templateIds,
+   * @param {String} token Authorization token
+   */
+  createSkillsFromTemplates(templateIds, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateIds: templateIds,
+      };
+      let confirmationRequest = axios.put(
+        "api/v1/skills/createfromtemplate/",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete skill
+   * @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
+   */
+  deleteSkill(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {
+        id: id,
+      };
+      if (comment) data.comment = comment;
+      const request = axios.delete(`api/v1/skills/`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Discard the skill draft changes
+   * @param {String} id The id of the skill to be deleted
+   * @param {String} token Authorization token
+   */
+  discardSkillChanges(id, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {};
+      const request = axios.get(`api/v1/skills/discard/${id}`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get the skill related roles
+   * @param {String} id
+   * @param {String} token
+   * @returns
+   */
+  getSkillRelatedRoles(id, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/skills/getskillrelatedroles/${id}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skill required assessment type
+   * @param {String} id
+   * @param {String} token
+   */
+  getSkillRequiredAssessmentType(id, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/skills/getrequiredassessmenttype/${id}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skill skill information
+   * @param {String} id The id of the skill
+   * @param {String} token Authorization token
+   */
+  getSkillInformationById(id, version, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/skills/skill/${id}/${version}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skill list
+   * @param {Array<String>} filter The filter used to select the skill
+   * @param {String} version The version to be retrieved
+   * @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
+   */
+  getSkillList(
+    filter,
+    version,
+    includeDeleted,
+    returnDefaultIfVersionNotAvailable,
+    token
+  ) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        version: version,
+        includeDeleted: includeDeleted,
+        returnDefaultIfVersionNotAvailable: returnDefaultIfVersionNotAvailable,
+      };
+      if (filter) requestData.filter = filter;
+      let confirmationRequest = axios.post(`api/v1/skills`, requestData, {
+        headers: { authorization: token },
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skills for team by id
+   * @param {String} teamId The ID of the team for which skills will be loaded
+   * @param {*} maxDepth How many levels down in the organization the skills will be loaded
+   * @param {*} token Authorization token
+   */
+  getTeamSkillsById(teamId, maxDepth, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/skills/getteambyid/${teamId}/${maxDepth}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get current user team skills
+   * @param {*} maxDepth How many levels down in the organization the skills will be loaded
+   * @param {*} token Authorization token
+   */
+  getCurrentUserTeamSkills(maxDepth, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/skills/getcurrentuserteam/${maxDepth}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * 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} token Authorization token
+   */
+  publishSkill(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      let data = {};
+      if (comment) data.comment = comment;
+      let confirmationRequest = axios.post(
+        `api/v1/skills/publish/${id}`,
+        data,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Set skill information
+   * @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
+   */
+  setSkillInformation(id, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+        id: id,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/skills/update/`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Watch skill
+   * @param {String} id The id of the skill to be updated
+   * @param {Boolean} watch Set to true or false
+   * @param {String} token Authorization token
+   */
+  watchSkill(id, watch, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        id: id,
+        watch: watch,
+      };
+      let confirmationRequest = axios.post(`api/v1/skills/watch`, requestData, {
+        headers: { authorization: token },
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/skillAssessmentTestingSession.js

@@ -0,0 +1,143 @@
+import axios from "./axios";
+
+// eslint-disable-next-line no-undef
+export default {
+  axios: axios,
+
+  /**
+   * End an existing testing session
+   * @param {String} testingSessionId
+   * @param {String} token Authorization token
+   */
+  endSession(testingSessionId, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.put(
+        "api/v1/skillassessmenttestingsession/endsession",
+        { id: testingSessionId },
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * End an existing testing session
+   * @param {String} testingSessionId
+   * @param {Array<String>} selectedAnswers
+   * @param {String} token Authorization token
+   */
+  getNextStep(testingSessionId, selectedAnswers, token) {
+    return new Promise(function (resolve, reject) {
+      let data = {
+        id: testingSessionId,
+      };
+      if (selectedAnswers) data.selectedAnswers = selectedAnswers;
+      let confirmationRequest = axios.post(
+        `api/v1/skillassessmenttestingsession/getnextstep`,
+        data,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skill assessment by user and skill
+   * @param {String} userId
+   * @param {String} skillId
+   * @param {String} token
+   * @returns
+   */
+  getSkillTestAssessment(userId, skillId, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.post(
+        `api/v1/skillassessmenttestingsession/getbyuserandskill`,
+        {
+          userId: userId,
+          skillId: skillId,
+        },
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Pause skill assessment
+   * @param {String} testingSessionId
+   * @param {String} token
+   * @returns
+   */
+  pause(testingSessionId, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.post(
+        `api/v1/skillassessmenttestingsession/pausesession`,
+        {
+          id: testingSessionId,
+        },
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Start a new test skill test assessment session
+   * @param {String} skillId
+   * @param {Boolean} saveSession
+   * @param {String} token
+   */
+  startSession(skillId, saveSession, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.post(
+        "api/v1/skillassessmenttestingsession/startsession",
+        {
+          saveSession: saveSession,
+          skillId: skillId,
+        },
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};