@stackfactor/client-api 1.1.134 → 1.1.136

package/src/lib/teams.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
@@ -5,7 +6,7 @@ import { client } from "./axiosClient";
  * @param {String} teamId The team Id
  * @param {Array<String>} users The users to be added
  * @param {String} authToken - Authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const addUsersToTeam = (
   teamId: string,
@@ -22,10 +23,10 @@ const addUsersToTeam = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -37,7 +38,7 @@ const addUsersToTeam = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const createTeam = (
   name: string,
@@ -56,10 +57,10 @@ const createTeam = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -70,7 +71,7 @@ const createTeam = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const deleteTeam = (
   teamId: string,
@@ -86,10 +87,10 @@ const deleteTeam = (
       },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -100,7 +101,7 @@ const deleteTeam = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const getTeamById = (
   teamId: string,
@@ -116,10 +117,10 @@ const getTeamById = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -129,7 +130,7 @@ const getTeamById = (
  * Get team roles
  * @param {String} teamId The team Id
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getTeamByIdRoles = (
   teamId: string,
@@ -140,10 +141,10 @@ const getTeamByIdRoles = (
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -152,7 +153,7 @@ const getTeamByIdRoles = (
 /**
  * Get teams for current tenant
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getTeams = (authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -160,10 +161,10 @@ const getTeams = (authToken: string): Promise<object> => {
       headers: { authorization: authToken },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -174,7 +175,7 @@ const getTeams = (authToken: string): Promise<object> => {
  * @param {String} userId
  * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getTeamByUserId = (
   userId: string,
@@ -190,10 +191,10 @@ const getTeamByUserId = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -203,7 +204,7 @@ const getTeamByUserId = (
  * 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>}
+ * @returns {Promise<object>}
  */
 const getTopTeam = (
   includeUserSummaryInformation: boolean,
@@ -218,10 +219,10 @@ const getTopTeam = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -232,7 +233,7 @@ const getTopTeam = (
  * @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>}
+ * @returns {Promise<object>}
  */
 const removeUsersFromTeam = (
   teamId: string,
@@ -249,10 +250,10 @@ const removeUsersFromTeam = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -262,7 +263,7 @@ const removeUsersFromTeam = (
  * Set team as default
  * @param {String} teamId The team Id
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setDefault = (teamId: string, authToken: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -274,10 +275,10 @@ const setDefault = (teamId: string, authToken: string): Promise<object> => {
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -288,7 +289,7 @@ const setDefault = (teamId: string, authToken: string): Promise<object> => {
  * @param {String} teamId The team Id
  * @param {Object} data The updated data of the team
  * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const updateTeam = (
   teamId: string,
@@ -305,10 +306,10 @@ const updateTeam = (
       { headers: { authorization: authToken } }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/tenants.ts

@@ -1,10 +1,11 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
  * Get tenant information
  * @param {String} category Tenant information category
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getTenantInformation = (
   category: string,
@@ -14,14 +15,14 @@ const getTenantInformation = (
     const requestData = {
       categories: category,
     };
-    let request = client.post("api/v1/tenants/tenant/get", requestData, {
+    const request = client.post("api/v1/tenants/tenant/get", requestData, {
       headers: { authorization: token },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data ? response.data : null);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -32,7 +33,7 @@ const getTenantInformation = (
  * @param {String} category Tenant information category
  * @param {Object} data New or updated tenant data information
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setTenantInformation = (
   category: string,
@@ -44,7 +45,7 @@ const setTenantInformation = (
       category: category,
       data: data,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "api/v1/tenants/tenant/set",
       requestData,
       {
@@ -52,10 +53,10 @@ const setTenantInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/trainingPlans.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
@@ -11,10 +12,10 @@ const archiveTrainingPlan = (id: string, token: string): Promise<object> => {
       headers: { authorization: token },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -41,14 +42,14 @@ const createTrainingPlan = (
       returnDefaultIfVersionNotAvailable: true,
       types: [type],
     };
-    let confirmationRequest = client.put("api/v1/trainingplans", requestData, {
+    const confirmationRequest = client.put("api/v1/trainingplans", requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -75,10 +76,10 @@ const deleteTrainingPlan = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -98,10 +99,10 @@ const discardTrainingPlanChanges = (
       headers: { authorization: token },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -129,7 +130,7 @@ const generateNewBaseline = (
       saveBaseline: saveBaseline,
     };
     if (id) requestData.id = id;
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "api/v1/trainingplans/generatenewbaseline",
       requestData,
       {
@@ -137,10 +138,10 @@ const generateNewBaseline = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -158,17 +159,17 @@ const getTrainingPlanById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/trainingplans/${id}/${version}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -182,14 +183,14 @@ const getAllTrainingPlansTasksSummary = (
   token: string | null = null
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(`api/v1/trainingplans/taskssummary`, {
+    const confirmationRequest = client.get(`api/v1/trainingplans/taskssummary`, {
       headers: token ? { authorization: token } : {},
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -226,14 +227,14 @@ const getListOfTrainingPlans = (
     if (fields) requestData.fields = fields;
     if (types) requestData.types = types;
     if (users) requestData.users = users;
-    let confirmationRequest = client.post(`api/v1/trainingplans`, requestData, {
+    const confirmationRequest = client.post(`api/v1/trainingplans`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -251,9 +252,9 @@ const publishTrainingPlan = (
   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/trainingplans/publish/${id}`,
       data,
       {
@@ -261,10 +262,10 @@ const publishTrainingPlan = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -289,7 +290,7 @@ const updateTrainingPlan = (
       id: planId,
       saveAsDraft,
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       `api/v1/trainingplans/update/${planId}`,
       requestData,
       {
@@ -297,10 +298,10 @@ const updateTrainingPlan = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -311,7 +312,7 @@ const updateTrainingPlan = (
  * @param {String} id The ID of the training plan
  * @param {Number} status
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const updateTrainingPlanTaskStatus = (
   id: string,
@@ -319,18 +320,18 @@ const updateTrainingPlanTaskStatus = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data = {
+    const data = {
       id: id,
       status: status,
     };
-    let confirmationRequest = client.post(`api/v1/trainingplans/task`, data, {
+    const confirmationRequest = client.post(`api/v1/trainingplans/task`, data, {
       headers: { authorization: token },
     });
     confirmationRequest
       .then(() => {
         resolve({});
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -341,7 +342,7 @@ const updateTrainingPlanTaskStatus = (
  * @param {String} planId
  * @param {Object} data Ordered array of objects containing the activity Id and the new status
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const updateActivities = (
   planId: string,
@@ -349,7 +350,7 @@ const updateActivities = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/trainingplans/${planId}/activities`,
       data,
       {
@@ -360,7 +361,7 @@ const updateActivities = (
       .then(() => {
         resolve({});
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/trainingPlansProficiencyLevels.ts

@@ -1,27 +1,28 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
  * Get training plan proficiency level
  * @param {String} proficiencyLevelId
  * @param {String} token
- * @returns {Promise<Object>} An object containing the proficiency level information
+ * @returns {Promise<object>} An object containing the proficiency level information
  */
 const getTrainingPlanProficiencyLevel = (
   proficiencyLevelId: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/trainingplans/proficiencylevels/${proficiencyLevelId}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -33,7 +34,7 @@ const getTrainingPlanProficiencyLevel = (
  * @param {Boolean} includeDetailedInformation If set to true it will return detailed information for each plan
  * @param {Boolean} includeArchived If set to true it will return all the closed items too
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getTrainingPlanProficiencyLevelList = (
   includeDeleted: boolean,
@@ -47,7 +48,7 @@ const getTrainingPlanProficiencyLevelList = (
       includeDeleted: includeDeleted,
       includeDetailedInformation: includeDetailedInformation,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/trainingplans/proficiencylevels`,
       requestData,
       {
@@ -55,10 +56,10 @@ const getTrainingPlanProficiencyLevelList = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -75,7 +76,7 @@ const reorderTrainingPlansProficiencyLevels = (
   token: string
 ): Promise<void> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/trainingplans/proficiencylevels/reorder`,
       { order: order },
       {
@@ -86,7 +87,7 @@ const reorderTrainingPlansProficiencyLevels = (
       .then(() => {
         resolve();
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -105,7 +106,7 @@ const updateTrainingPlanProficiencyLevel = (
   token: string
 ): Promise<void> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/trainingplans/proficiencylevel/${proficiencyLevelId}`,
       data,
       {
@@ -116,7 +117,7 @@ const updateTrainingPlanProficiencyLevel = (
       .then(() => {
         resolve();
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });