@stackfactor/client-api 1.1.127 → 1.1.129

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>}
  */
-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,16 +29,20 @@ 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>}
  */
-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,
     });
     request
@@ -54,13 +59,16 @@ 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>}
  */
-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 },
-
       data: data,
     });
     request
@@ -79,14 +87,15 @@ 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>}
  */
 const getSkillTemplateInformationById = (
-  id,
-  version,
-  returnNullIfVersionNotFound,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  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}`,
       {
@@ -110,16 +119,17 @@ 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>}
  */
 const getSkillTemplateList = (
-  filter,
-  version,
-  includeDeleted,
-  namesOnly,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+  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,
@@ -143,11 +153,12 @@ const getSkillTemplateList = (
 };
 
 /**
- * Get skill tecnology stacks template list
+ * Get skill technology stacks template list
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-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 },
     });
@@ -166,10 +177,15 @@ 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>}
  */
-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}`,
@@ -193,9 +209,14 @@ 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>}
  */
-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,
@@ -222,9 +243,14 @@ 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>}
  */
-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,
@@ -246,14 +272,14 @@ 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>}
  */
-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,
     };
@@ -279,9 +305,14 @@ 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>}
  */
-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,

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

@@ -2,11 +2,13 @@ import { client } from "./axiosClient.js";
 
 /**
  * Get talent transformation steps for the current user
- * @param {String} userId
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const getTalentTransformationStepsForCurrentUser = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTalentTransformationStepsForCurrentUser = (
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(
       `api/v1/talenttransformation/getforcurrentuser`,
       authToken
@@ -30,8 +32,8 @@ const getTalentTransformationStepsForCurrentUser = (authToken) => {
  * @param {String} authToken
  * @returns {Promise<Object>} The talent transformation summary
  */
-const getTalentTransformationSummary = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTalentTransformationSummary = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(
       `api/v1/talenttransformation/summary`,
       authToken
@@ -51,12 +53,16 @@ const getTalentTransformationSummary = (authToken) => {
 };
 
 /**
- * Get the talent transformation summary for the whole organization
+ * Get the talent transformation summary for the team
+ * @param {String} teamId
  * @param {String} authToken
  * @returns {Promise<Object>} The talent transformation summary
  */
-const getTalentTransformationSummaryForTeam = (teamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTalentTransformationSummaryForTeam = (
+  teamId: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(
       `api/v1/talenttransformation/summaryforteam/${teamId}`,
       authToken
@@ -81,15 +87,15 @@ const getTalentTransformationSummaryForTeam = (teamId, authToken) => {
  * @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}
+ * @returns {Promise<Object>}
  */
 const setTalentTransformationStepData = (
-  id,
-  data,
-  returnAllStepsStatuses,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  id: string,
+  data: object,
+  returnAllStepsStatuses: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: id,

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

@@ -5,9 +5,14 @@ import { client } from "./axiosClient.js";
  * @param {String} teamId The team Id
  * @param {Array<String>} users The users to be added
  * @param {String} authToken - Authentication token
+ * @returns {Promise<Object>}
  */
-const addUsersToTeam = (teamId, users, authToken) => {
-  return new Promise(function (resolve, reject) {
+const addUsersToTeam = (
+  teamId: string,
+  users: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/users/add`,
       {
@@ -32,9 +37,15 @@ const addUsersToTeam = (teamId, users, authToken) => {
  * @param {String} managerId The id of the manager
  * @param {String} description The description of the team
  * @param {String} authToken The authorization token
+ * @returns {Promise<Object>}
  */
-const createTeam = (name, managerId, description, authToken) => {
-  return new Promise(function (resolve, reject) {
+const createTeam = (
+  name: string,
+  managerId: string,
+  description: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/team`,
       {
@@ -59,12 +70,16 @@ const createTeam = (name, managerId, description, authToken) => {
  * @param {String} teamId The team to be deleted
  * @param {String} defaultTeamId The default team all the users will be moved to
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const deleteTeam = (teamId, defaultTeamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const deleteTeam = (
+  teamId: string,
+  defaultTeamId: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.delete(`api/v1/teams/delete`, {
       headers: { authorization: authToken },
-
       data: {
         id: teamId,
         defaultTeamId: defaultTeamId,
@@ -85,9 +100,14 @@ const deleteTeam = (teamId, defaultTeamId, authToken) => {
  * @param {String} teamId The team Id
  * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const getTeamById = (teamId, includeUserSummaryInformation, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTeamById = (
+  teamId: string,
+  includeUserSummaryInformation: boolean,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/team/${teamId}`,
       {
@@ -109,9 +129,13 @@ const getTeamById = (teamId, includeUserSummaryInformation, authToken) => {
  * Get team roles
  * @param {String} teamId The team Id
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const getTeamByIdRoles = (teamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTeamByIdRoles = (
+  teamId: string,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/teams/getroles/${teamId}`, {
       headers: { authorization: authToken },
     });
@@ -127,11 +151,11 @@ const getTeamByIdRoles = (teamId, authToken) => {
 
 /**
  * Get teams for current tenant
- * @param {String} userId
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const getTeams = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTeams = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/teams/`, {
       headers: { authorization: authToken },
     });
@@ -150,9 +174,14 @@ const getTeams = (authToken) => {
  * @param {String} userId
  * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const getTeamByUserId = (userId, includeUserSummaryInformation, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTeamByUserId = (
+  userId: string,
+  includeUserSummaryInformation: boolean,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `/api/v1/teams/getuserteam/${userId || ""}`,
       {
@@ -174,9 +203,13 @@ const getTeamByUserId = (userId, includeUserSummaryInformation, authToken) => {
  * Get top team in the organization, usually the executive team
  * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const getTopTeam = (includeUserSummaryInformation, authToken) => {
-  return new Promise(function (resolve, reject) {
+const getTopTeam = (
+  includeUserSummaryInformation: boolean,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/gettopteam`,
       {
@@ -199,9 +232,14 @@ const getTopTeam = (includeUserSummaryInformation, authToken) => {
  * @param {String} teamId The team Id
  * @param {Array<String>} users The users to be removed from the team
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const removeUsersFromTeam = (teamId, users, authToken) => {
-  return new Promise(function (resolve, reject) {
+const removeUsersFromTeam = (
+  teamId: string,
+  users: string[],
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.post(
       `api/v1/teams/users/remove/`,
       {
@@ -220,13 +258,14 @@ const removeUsersFromTeam = (teamId, users, authToken) => {
   });
 };
 
-/*
- * Set team as defualt
+/**
+ * Set team as default
  * @param {String} teamId The team Id
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const setDefault = (teamId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const setDefault = (teamId: string, authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.put(
       `api/v1/teams/setDefault/`,
       {
@@ -247,11 +286,16 @@ const setDefault = (teamId, authToken) => {
 /**
  * Update team
  * @param {String} teamId The team Id
- * @param {String} data The updated name of the team
+ * @param {Object} data The updated data of the team
  * @param {String} authToken The authentication token
+ * @returns {Promise<Object>}
  */
-const updateTeam = (teamId, data, authToken) => {
-  return new Promise(function (resolve, reject) {
+const updateTeam = (
+  teamId: string,
+  data: object,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.patch(
       `api/v1/teams/team/`,
       {

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

@@ -4,11 +4,15 @@ import { client } from "./axiosClient.js";
  * Get tenant information
  * @param {String} category Tenant information category
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getTenantInformation = (categories, token) => {
-  return new Promise(function (resolve, reject) {
+const getTenantInformation = (
+  category: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
-      categories: categories,
+      categories: category,
     };
     let request = client.post("api/v1/tenants/tenant/get", requestData, {
       headers: { authorization: token },
@@ -26,11 +30,16 @@ const getTenantInformation = (categories, token) => {
 /**
  * Set tenant profile information
  * @param {String} category Tenant information category
- * @param {String} data New or updated tenant data information
- * @param {Object} token Authorization token
+ * @param {Object} data New or updated tenant data information
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const setTenantInformation = (category, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setTenantInformation = (
+  category: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       category: category,
       data: data,