@stackfactor/client-api 1.1.133 → 1.1.135

package/src/lib/security.ts

@@ -1,9 +1,10 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Get the enabled authentication connections for current organization.
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getAuthConnections = (authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -12,10 +13,10 @@ const getAuthConnections = (authToken: string): Promise<object> => {
       { headers: { authorization: authToken } }
     );
     getConfigInformationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -25,7 +26,7 @@ const getAuthConnections = (authToken: string): Promise<object> => {
  * Set the enabled authentication connections for current organization.
  * @param {Object} data - the object containing the updated configuration
  * @param {String} authToken - Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setAuthConnections = (
   data: object,
@@ -38,10 +39,10 @@ const setAuthConnections = (
       { headers: { authorization: authToken } }
     );
     setConfigInformationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -51,7 +52,7 @@ const setAuthConnections = (
  * Reset the MFA for the user.
  * @param {String} userId
  * @param {String} authToken
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const resetMFA = (userId: string, authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -61,10 +62,10 @@ const resetMFA = (userId: string, authToken: string): Promise<object> => {
       { headers: { authorization: authToken } }
     );
     resetMFARequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -73,7 +74,7 @@ const resetMFA = (userId: string, authToken: string): Promise<object> => {
 /**
  * Synchronize the authentication connections with Auth0.
  * @param {String} authToken
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const synchronizeWithAuth0 = (authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -82,10 +83,10 @@ const synchronizeWithAuth0 = (authToken: string): Promise<object> => {
       { headers: { authorization: authToken } }
     );
     synchronizeRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/skill.ts

@@ -1,14 +1,15 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Create skill and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createSkill = (data: object, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/skills",
       { data: data },
       {
@@ -16,10 +17,10 @@ const createSkill = (data: object, token: string): Promise<object> => {
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -29,7 +30,7 @@ const createSkill = (data: object, token: string): Promise<object> => {
  * Create skills from templates
  * @param {Array<String>} templateIds
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createSkillsFromTemplates = (
   templateIds: string[],
@@ -39,7 +40,7 @@ const createSkillsFromTemplates = (
     const requestData = {
       templateIds: templateIds,
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/skills/createfromtemplate/",
       requestData,
       {
@@ -47,10 +48,10 @@ const createSkillsFromTemplates = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -61,7 +62,7 @@ const createSkillsFromTemplates = (
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const deleteSkill = (
   id: string,
@@ -78,10 +79,10 @@ const deleteSkill = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -91,7 +92,7 @@ const deleteSkill = (
  * Discard the skill draft changes
  * @param {String} id The id of the skill to be discarded
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const discardSkillChanges = (id: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -101,10 +102,10 @@ const discardSkillChanges = (id: string, token: string): Promise<object> => {
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -113,7 +114,7 @@ const discardSkillChanges = (id: string, token: string): Promise<object> => {
 /**
  * Get the list of imported skill templates
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getImportedSkillTemplates = (token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -121,10 +122,10 @@ const getImportedSkillTemplates = (token: string): Promise<object> => {
       headers: { authorization: token },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -135,7 +136,7 @@ const getImportedSkillTemplates = (token: string): Promise<object> => {
  * @param {String} id
  * @param {String} token Authorization token
  * @param {Boolean} includeRoleInformation
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getSkillRelatedRoles = (
   id: string,
@@ -143,17 +144,17 @@ const getSkillRelatedRoles = (
   includeRoleInformation = false
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skills/getskillrelatedroles/${id}/${includeRoleInformation}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -163,24 +164,24 @@ const getSkillRelatedRoles = (
  * Get skill required assessment type
  * @param {String} id
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getSkillRequiredAssessmentType = (
   id: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skills/getrequiredassessmenttype/${id}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -192,7 +193,7 @@ const getSkillRequiredAssessmentType = (
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const getSkillInformationById = (
   id: string,
@@ -201,17 +202,17 @@ const getSkillInformationById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skills/skill/${id}/${version}/${returnNullIfVersionNotFound}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -225,7 +226,7 @@ const getSkillInformationById = (
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const getSkillList = (
   filter: string[],
@@ -244,14 +245,14 @@ const getSkillList = (
       filter: filter,
     };
     if (filter) requestData.filter = filter;
-    let confirmationRequest = client.post(`api/v1/skills`, requestData, {
+    const confirmationRequest = client.post(`api/v1/skills`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -263,7 +264,7 @@ const getSkillList = (
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const getTeamSkillsById = (
   teamId: string,
@@ -272,17 +273,17 @@ const getTeamSkillsById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skills/getteambyid/${teamId}/${maxDepth}/${returnNullIfVersionNotFound}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -292,24 +293,24 @@ const getTeamSkillsById = (
  * 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<Object>}
+ * @returns {Promise<object>}
  */
 const getCurrentUserTeamSkills = (
   maxDepth: number,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skills/getcurrentuserteam/${maxDepth}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -319,24 +320,24 @@ const getCurrentUserTeamSkills = (
  * Get skill template updates
  * @param {String} id The skill id
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getSkillTemplateUpdates = (
   id: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skills/getskilltemplateupdates/${id}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -347,7 +348,7 @@ const getSkillTemplateUpdates = (
  * @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 Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const importSkillTemplates = (
   data: string[],
@@ -359,7 +360,7 @@ const importSkillTemplates = (
       data: data,
       publish: publish,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skills/importtemplates`,
       requestData,
       {
@@ -367,10 +368,10 @@ const importSkillTemplates = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -381,7 +382,7 @@ const importSkillTemplates = (
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const publishSkill = (
   id: string,
@@ -389,16 +390,16 @@ const publishSkill = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data: { comments?: string } = {};
+    const data: { comments?: string } = {};
     if (comments) data.comments = comments;
-    let confirmationRequest = client.post(`api/v1/skills/publish/${id}`, data, {
+    const confirmationRequest = client.post(`api/v1/skills/publish/${id}`, data, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -409,7 +410,7 @@ const publishSkill = (
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const setSkillInformation = (
   id: string,
@@ -421,7 +422,7 @@ const setSkillInformation = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skills/update/`,
       requestData,
       {
@@ -429,10 +430,10 @@ const setSkillInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -443,7 +444,7 @@ const setSkillInformation = (
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const setSkillInformationFromTemplate = (
   id: string,
@@ -455,7 +456,7 @@ const setSkillInformationFromTemplate = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skills/updatefromtemplate/`,
       requestData,
       {
@@ -463,10 +464,10 @@ const setSkillInformationFromTemplate = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -476,14 +477,14 @@ const setSkillInformationFromTemplate = (
  * Validate skill information
  * @param {String} id The id of the skill to be updated
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const validateSkill = (id: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skills/validate/`,
       requestData,
       {
@@ -491,10 +492,10 @@ const validateSkill = (id: string, token: string): Promise<object> => {
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -505,7 +506,7 @@ const validateSkill = (id: string, token: string): Promise<object> => {
  * @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<Object>}
+ * @returns {Promise<object>}
  */
 const watchSkill = (
   id: string,
@@ -517,14 +518,14 @@ const watchSkill = (
       id: id,
       watch: watch,
     };
-    let confirmationRequest = client.post(`api/v1/skills/watch`, requestData, {
+    const confirmationRequest = client.post(`api/v1/skills/watch`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });