@stackfactor/client-api 1.1.15-8.1 → 1.1.15

package/lib/skill.js

@@ -0,0 +1,514 @@
+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) {
+    let confirmationRequest = client.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
+ * @returns {Promise}
+ */
+export const createSkillsFromTemplates = (templateIds, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      templateIds: templateIds,
+    };
+    let confirmationRequest = client.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} comments The comments included with the deletion
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const deleteSkill = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
+      id: id,
+    };
+    if (comments) data.comments = comments;
+    const request = client.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
+ * @returns {Promise}
+ */
+export const discardSkillChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {};
+    const request = client.get(`api/v1/skills/discard/${id}`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get the list of imported skill templates
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const getImportedSkillTemplates = (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 {Promise}
+ */
+export const getSkillRelatedRoles = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.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
+ * @returns {Promise}
+ */
+export const getSkillRequiredAssessmentType = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.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} version The version of the skill
+ * @param {Boolean} returnNullIfVersionNotFound When true it will return null if the version is not found
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const getSkillInformationById = (
+  id,
+  version,
+  returnNullIfVersionNotFound,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/skills/skill/${id}/${version}/${returnNullIfVersionNotFound}`,
+      {
+        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 {Boolean} namesOnly Return only the names of the skills
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const getSkillList = (
+  filter,
+  version,
+  includeDeleted,
+  returnDefaultIfVersionNotAvailable,
+  namesOnly,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      includeDeleted: includeDeleted,
+      namesOnly: namesOnly,
+      returnDefaultIfVersionNotAvailable: returnDefaultIfVersionNotAvailable,
+      version: version,
+    };
+    if (filter) requestData.filter = filter;
+    let confirmationRequest = client.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 {Number} maxDepth How many levels down in the organization the skills will be loaded
+ * @param {Boolean} returnNullIfVersionNotFound Return null if the version is not found
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const getTeamSkillsById = (
+  teamId,
+  maxDepth,
+  returnNullIfVersionNotFound,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/skills/getteambyid/${teamId}/${maxDepth}/${returnNullIfVersionNotFound}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * 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) {
+    let confirmationRequest = client.get(
+      `api/v1/skills/getcurrentuserteam/${maxDepth}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get skill template updates
+ * @param {String} id The skill id
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const getSkillTemplateUpdates = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/skills/getskilltemplateupdates/${id}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Import skill templates
+ * @param {Array<String>} data The list of role templates to be imported
+ * @param {Boolean} publish If true the imported templates will be published
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const importSkillTemplates = (data, publish, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      publish: publish,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/skills/importtemplates`,
+      requestData,
+      {
+        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} comments The comments to be include with the request
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const publishSkill = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
+    if (comments) data.comments = comments;
+    let confirmationRequest = client.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
+ * @returns {Promise}
+ */
+export const setSkillInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      id: id,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/skills/update/`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set the skill information from template
+ * @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 setSkillInformationFromTemplate = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      id: id,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/skills/updatefromtemplate/`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Validate skill information
+ * @param {String} id The id of the skill to be updated
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const validateSkill = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      id: id,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/skills/validate/`,
+      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
+ * @returns {Promise}
+ */
+export const watchSkill = (id, watch, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      id: id,
+      watch: watch,
+    };
+    let confirmationRequest = client.post(`api/v1/skills/watch`, requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const skill = {
+  createSkill,
+  createSkillsFromTemplates,
+  deleteSkill,
+  discardSkillChanges,
+  getImportedSkillTemplates,
+  getSkillRelatedRoles,
+  getSkillRequiredAssessmentType,
+  getSkillInformationById,
+  getSkillList,
+  getSkillTemplateUpdates,
+  getTeamSkillsById,
+  getCurrentUserTeamSkills,
+  importSkillTemplates,
+  publishSkill,
+  setSkillInformation,
+  setSkillInformationFromTemplate,
+  validateSkill,
+  watchSkill,
+};
+
+export default skill;

package/lib/skillAssessmentTestingSession.js

@@ -0,0 +1,148 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * End an existing testing session
+ * @param {String} testingSessionId
+ * @param {String} token Authorization token
+ */
+export const endSession = (testingSessionId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.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
+ */
+export const getNextStep = (testingSessionId, selectedAnswers, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {
+      id: testingSessionId,
+    };
+    if (selectedAnswers) data.selectedAnswers = selectedAnswers;
+    let confirmationRequest = client.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
+ */
+export const getSkillTestAssessment = (userId, skillId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.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
+ */
+export const pause = (testingSessionId, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.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
+ */
+export const startSession = (skillId, saveSession, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.post(
+      "api/v1/skillassessmenttestingsession/startsession",
+      {
+        saveSession: saveSession,
+        skillId: skillId,
+      },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const skillAessementTestingSession = {
+  endSession,
+  getNextStep,
+  getSkillTestAssessment,
+  pause,
+  startSession,
+};
+
+export default skillAessementTestingSession;