@stackfactor/client-api 1.1.11 → 1.1.12-9.2

package/lib/skillAssessments.ts

@@ -0,0 +1,192 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Add new entry skill assessment
+ * @param {String} id
+ * @param {Object} data
+ * @param {String} comments
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
+ */
+const addEntry = (
+  id: string,
+  data: object,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData = {
+      comments: comments,
+      data: data,
+      id: id,
+    };
+    let confirmationRequest = client.put(
+      "api/v1/skillassessments/addentry",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Create skill assessment
+ * @param {Object} data
+ * @param {String} comments
+ * @param {String} userId
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
+ */
+const create = (
+  data: object,
+  comments: string,
+  userId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData = {
+      comments: comments,
+      data: data,
+      userId: userId,
+    };
+    let confirmationRequest = client.put(
+      "api/v1/skillassessments/",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Delete skill assessment
+ * @param {number} 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<Object>}
+ */
+const deleteSkillAssessment = (
+  id: number,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const data: { id: number, comments?: string } = {
+      id: id,
+    };
+    if (comments) data.comments = comments;
+    const request = client.delete(`api/v1/skillassessments`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get skill assessment by id
+ * @param {String} id
+ * @param {String} token
+ * @returns {Promise<Object>}
+ */
+const getById = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
+      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 {Promise<Object>} The skill assessment
+ */
+const getByUserAndSkill = (
+  userId: string,
+  skillId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let confirmationRequest = client.get(
+      `api/v1/skillassessments/getbyuserandskill/${userId}/${skillId}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get list
+ * @param {String} userId The user used to select the skill
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
+ */
+const getList = (userId: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { userId?: string } = {};
+    if (userId) requestData.userId = userId;
+    let confirmationRequest = client.post(
+      `api/v1/skillassessments`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+export default {
+  addEntry,
+  create,
+  deleteSkillAssessment,
+  getById,
+  getByUserAndSkill,
+  getList,
+};

package/lib/{skillTemplate.js → skillTemplate.ts}

@@ -4,9 +4,10 @@ import { client } from "./axiosClient.js";
  * Create skill template and set information
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const createSkillTemplate = (data, token) => {
-  return new Promise(function (resolve, reject) {
+const createSkillTemplate = (data: object, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
@@ -28,13 +29,18 @@ export const createSkillTemplate = (data, token) => {
  * @param {number} id The id of the template to be deleted
  * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const deleteSkillTemplate = (id, comments, token) => {
-  const data = {
+const deleteSkillTemplate = (
+  id: number,
+  comments: string,
+  token: string
+): Promise<object> => {
+  const data: { id: number; comments?: string } = {
     id: id,
   };
   if (comments) data.comments = comments;
-  return new Promise(function (resolve, reject) {
+  return new Promise((resolve, reject) => {
     const request = client.delete(`api/v1/skilltemplates/`, {
       headers: { authorization: token },
       data: data,
@@ -53,9 +59,13 @@ export const deleteSkillTemplate = (id, comments, token) => {
  * Discard the skill template draft changes
  * @param {String} id The id of the skill template to be deleted
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const discardSkillTemplateChanges = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const discardSkillTemplateChanges = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const data = {};
     const request = client.get(`api/v1/skilltemplates/discard/${id}`, {
       headers: { authorization: token },
@@ -77,14 +87,15 @@ export const discardSkillTemplateChanges = (id, token) => {
  * @param {String} version The version of the template
  * @param {Boolean} returnNullIfVersionNotFound When true it will return null if the version is not found
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const getSkillTemplateInformationById = (
-  id,
-  version,
-  returnNullIfVersionNotFound,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+const getSkillTemplateInformationById = (
+  id: string,
+  version: string,
+  returnNullIfVersionNotFound: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/skilltemplates/${id}/${version}/${returnNullIfVersionNotFound}`,
       {
@@ -108,16 +119,17 @@ export const getSkillTemplateInformationById = (
  * @param {Boolean} includeDeleted When true it will return the deleted records as well
  * @param {Boolean} namesOnly When true it will return only the names of the templates
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const getSkillTemplateList = (
-  filter,
-  version,
-  includeDeleted,
-  namesOnly,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+const getSkillTemplateList = (
+  filter: string[],
+  version: string,
+  includeDeleted: boolean,
+  namesOnly: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { includeDeleted: boolean; namesOnly: boolean; version: string; filter?: string[] } = {
       includeDeleted: includeDeleted,
       namesOnly: namesOnly,
       version: version,
@@ -141,11 +153,12 @@ export const getSkillTemplateList = (
 };
 
 /**
- * Get skill tecnology stacks template list
+ * Get skill technology stacks template list
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const getTechnologyStacks = (token) => {
-  return new Promise(function (resolve, reject) {
+const getTechnologyStacks = (token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(`api/v1/skilltemplates/stacks`, {
       headers: { authorization: token },
     });
@@ -164,10 +177,15 @@ export const getTechnologyStacks = (token) => {
  * @param {number} id The id of the template to be published
  * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const publishTemplate = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {};
+const publishTemplate = (
+  id: number,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data: { comments?: string } = {};
     if (comments) data.comments = comments;
     let confirmationRequest = client.post(
       `api/v1/skilltemplates/publish/${id}`,
@@ -191,9 +209,14 @@ export const publishTemplate = (id, comments, token) => {
  * @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
+ * @returns {Promise<Object>}
  */
-export const setTemplateInformation = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setTemplateInformation = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: id,
@@ -220,9 +243,14 @@ export const setTemplateInformation = (id, data, token) => {
  * @param {String} id The id of the template to be updated
  * @param {Object} tags Updated template tags
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const setTemplateTags = (id, tags, token) => {
-  return new Promise(function (resolve, reject) {
+const setTemplateTags = (
+  id: string,
+  tags: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       tags: tags,
       id: id,
@@ -244,14 +272,14 @@ export const setTemplateTags = (id, tags, token) => {
   });
 };
 
-/*
+/**
  * Validate skill template information
  * @param {String} id The id of the skill to be updated
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-export const validateTemplate = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const validateTemplate = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
     };
@@ -277,9 +305,14 @@ export const validateTemplate = (id, token) => {
  * @param {String} id The id of the skill template to be updated
  * @param {Boolean} watch Set to true or false
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const watchSkillTemplate = (id, watch, token) => {
-  return new Promise(function (resolve, reject) {
+const watchSkillTemplate = (
+  id: string,
+  watch: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
       watch: watch,
@@ -301,7 +334,7 @@ export const watchSkillTemplate = (id, watch, token) => {
   });
 };
 
-const skillTemplate = {
+export default {
   createSkillTemplate,
   deleteSkillTemplate,
   discardSkillTemplateChanges,
@@ -314,5 +347,3 @@ const skillTemplate = {
   validateTemplate,
   watchSkillTemplate,
 };
-
-export default skillTemplate;

package/lib/talentTransfromation.ts

@@ -0,0 +1,126 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Get talent transformation steps for the current user
+ * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
+ */
+const getTalentTransformationStepsForCurrentUser = (
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const request = client.get(
+      `api/v1/talenttransformation/getforcurrentuser`,
+      authToken
+        ? {
+            headers: { authorization: authToken },
+          }
+        : {}
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get the talent transformation summary for the whole organization
+ * @param {String} authToken
+ * @returns {Promise<Object>} The talent transformation summary
+ */
+const getTalentTransformationSummary = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const request = client.get(
+      `api/v1/talenttransformation/summary`,
+      authToken
+        ? {
+            headers: { authorization: authToken },
+          }
+        : {}
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get the talent transformation summary for the team
+ * @param {String} teamId
+ * @param {String} authToken
+ * @returns {Promise<Object>} The talent transformation summary
+ */
+const getTalentTransformationSummaryForTeam = (
+  teamId: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const request = client.get(
+      `api/v1/talenttransformation/summaryforteam/${teamId}`,
+      authToken
+        ? {
+            headers: { authorization: authToken },
+          }
+        : {}
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set talent transformation step data
+ * @param {String} id The id of the talent transformation step to be updated
+ * @param {Object} data Data used to update the talent transformation step
+ * @param {Boolean} returnAllStepsStatuses If true, return all steps statuses
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
+ */
+const setTalentTransformationStepData = (
+  id: string,
+  data: object,
+  returnAllStepsStatuses: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData = {
+      data: data,
+      id: id,
+      returnAllStepsStatuses: returnAllStepsStatuses,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/talenttransformation/setdata/`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+export default {
+  getTalentTransformationStepsForCurrentUser,
+  getTalentTransformationSummary,
+  getTalentTransformationSummaryForTeam,
+  setTalentTransformationStepData,
+};