@stackfactor/client-api 1.1.133 → 1.1.135

package/src/lib/skillAssessmentTestingSession.ts

@@ -1,4 +1,5 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Add new entry skill assessment
@@ -6,7 +7,7 @@ import { client } from "./axiosClient.js";
  * @param {Object} data
  * @param {String} comments
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const addEntry = (
   id: string,
@@ -20,7 +21,7 @@ const addEntry = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/skillassessments/addentry",
       requestData,
       {
@@ -28,10 +29,10 @@ const addEntry = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -43,7 +44,7 @@ const addEntry = (
  * @param {String} comments
  * @param {String} userId
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const create = (
   data: object,
@@ -57,7 +58,7 @@ const create = (
       data: data,
       userId: userId,
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/skillassessments/",
       requestData,
       {
@@ -65,10 +66,10 @@ const create = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -79,7 +80,7 @@ const create = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const deleteSkillAssessment = (
   id: number,
@@ -96,10 +97,10 @@ const deleteSkillAssessment = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -109,18 +110,18 @@ const deleteSkillAssessment = (
  * Get skill assessment by id
  * @param {String} id
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getById = (id: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
+    const confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -131,7 +132,7 @@ const getById = (id: string, token: string): Promise<object> => {
  * @param {String} userId
  * @param {String} skillId
  * @param {String} token
- * @returns {Promise<Object>} The skill assessment
+ * @returns {Promise<object>} The skill assessment
  */
 const getByUserAndSkill = (
   userId: string,
@@ -139,17 +140,17 @@ const getByUserAndSkill = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skillassessments/getbyuserandskill/${userId}/${skillId}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -159,13 +160,13 @@ const getByUserAndSkill = (
  * Get list
  * @param {String} userId The user used to select the skill
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @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(
+    const confirmationRequest = client.post(
       `api/v1/skillassessments`,
       requestData,
       {
@@ -173,10 +174,10 @@ const getList = (userId: string, token: string): Promise<object> => {
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/skillAssessments.ts

@@ -1,4 +1,5 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Add new entry skill assessment
@@ -6,7 +7,7 @@ import { client } from "./axiosClient.js";
  * @param {Object} data
  * @param {String} comments
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const addEntry = (
   id: string,
@@ -20,7 +21,7 @@ const addEntry = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/skillassessments/addentry",
       requestData,
       {
@@ -28,10 +29,10 @@ const addEntry = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -43,7 +44,7 @@ const addEntry = (
  * @param {String} comments
  * @param {String} userId
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const create = (
   data: object,
@@ -57,7 +58,7 @@ const create = (
       data: data,
       userId: userId,
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/skillassessments/",
       requestData,
       {
@@ -65,10 +66,10 @@ const create = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -79,7 +80,7 @@ const create = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const deleteSkillAssessment = (
   id: number,
@@ -96,10 +97,10 @@ const deleteSkillAssessment = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -109,18 +110,18 @@ const deleteSkillAssessment = (
  * Get skill assessment by id
  * @param {String} id
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getById = (id: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
+    const confirmationRequest = client.get(`api/v1/skillassessments/${id}`, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -131,7 +132,7 @@ const getById = (id: string, token: string): Promise<object> => {
  * @param {String} userId
  * @param {String} skillId
  * @param {String} token
- * @returns {Promise<Object>} The skill assessment
+ * @returns {Promise<object>} The skill assessment
  */
 const getByUserAndSkill = (
   userId: string,
@@ -139,17 +140,17 @@ const getByUserAndSkill = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skillassessments/getbyuserandskill/${userId}/${skillId}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -159,13 +160,13 @@ const getByUserAndSkill = (
  * Get list
  * @param {String} userId The user used to select the skill
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @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(
+    const confirmationRequest = client.post(
       `api/v1/skillassessments`,
       requestData,
       {
@@ -173,10 +174,10 @@ const getList = (userId: string, token: string): Promise<object> => {
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/skillTemplate.ts

@@ -1,24 +1,25 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Create skill template and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createSkillTemplate = (data: object, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
-    let confirmationRequest = client.put("api/v1/skilltemplates", requestData, {
+    const confirmationRequest = client.put("api/v1/skilltemplates", requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -29,7 +30,7 @@ const createSkillTemplate = (data: object, token: string): Promise<object> => {
  * @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>}
+ * @returns {Promise<object>}
  */
 const deleteSkillTemplate = (
   id: number,
@@ -46,10 +47,10 @@ const deleteSkillTemplate = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -59,7 +60,7 @@ const deleteSkillTemplate = (
  * 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>}
+ * @returns {Promise<object>}
  */
 const discardSkillTemplateChanges = (
   id: string,
@@ -72,10 +73,10 @@ const discardSkillTemplateChanges = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -87,7 +88,7 @@ const discardSkillTemplateChanges = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const getSkillTemplateInformationById = (
   id: string,
@@ -96,17 +97,17 @@ const getSkillTemplateInformationById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/skilltemplates/${id}/${version}/${returnNullIfVersionNotFound}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -119,7 +120,7 @@ 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>}
+ * @returns {Promise<object>}
  */
 const getSkillTemplateList = (
   filter: string[],
@@ -135,7 +136,7 @@ const getSkillTemplateList = (
       version: version,
     };
     if (filter) requestData.filter = filter;
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skilltemplates`,
       requestData,
       {
@@ -143,10 +144,10 @@ const getSkillTemplateList = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -155,18 +156,18 @@ const getSkillTemplateList = (
 /**
  * Get skill technology stacks template list
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getTechnologyStacks = (token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(`api/v1/skilltemplates/stacks`, {
+    const confirmationRequest = client.get(`api/v1/skilltemplates/stacks`, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -177,7 +178,7 @@ const getTechnologyStacks = (token: string): Promise<object> => {
  * @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>}
+ * @returns {Promise<object>}
  */
 const publishTemplate = (
   id: number,
@@ -185,9 +186,9 @@ const publishTemplate = (
   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(
+    const confirmationRequest = client.post(
       `api/v1/skilltemplates/publish/${id}`,
       data,
       {
@@ -195,10 +196,10 @@ const publishTemplate = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -209,7 +210,7 @@ const publishTemplate = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const setTemplateInformation = (
   id: string,
@@ -221,7 +222,7 @@ const setTemplateInformation = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skilltemplates/update`,
       requestData,
       {
@@ -229,10 +230,10 @@ const setTemplateInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -243,7 +244,7 @@ const setTemplateInformation = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const setTemplateTags = (
   id: string,
@@ -255,7 +256,7 @@ const setTemplateTags = (
       tags: tags,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skilltemplates/updatetags/`,
       requestData,
       {
@@ -263,10 +264,10 @@ const setTemplateTags = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -276,14 +277,14 @@ const setTemplateTags = (
  * Validate skill template information
  * @param {String} id The id of the skill to be updated
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const validateTemplate = (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/skilltemplates/validate/`,
       requestData,
       {
@@ -291,10 +292,10 @@ const validateTemplate = (id: string, token: string): Promise<object> => {
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -305,7 +306,7 @@ const validateTemplate = (id: string, token: string): Promise<object> => {
  * @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>}
+ * @returns {Promise<object>}
  */
 const watchSkillTemplate = (
   id: string,
@@ -317,7 +318,7 @@ const watchSkillTemplate = (
       id: id,
       watch: watch,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/skilltemplates/watch`,
       requestData,
       {
@@ -325,10 +326,10 @@ const watchSkillTemplate = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });