@stackfactor/client-api 1.1.133 → 1.1.135

package/src/lib/learningPath.ts

@@ -1,4 +1,5 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 interface LearningPathData {
   data?: object;
@@ -14,11 +15,11 @@ interface LearningPathData {
  * Create learning path and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createLearningPath = (data: object, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/learningpaths",
       { data: data },
       {
@@ -26,10 +27,10 @@ const createLearningPath = (data: object, token: string): Promise<object> => {
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -40,7 +41,7 @@ const createLearningPath = (data: object, token: string): Promise<object> => {
  * @param {String} id The id of the template to be deleted
  * @param {String} comments The comments for approver
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const deleteLearningPath = (id: string, comments: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -53,10 +54,10 @@ const deleteLearningPath = (id: string, comments: string, token: string): Promis
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -66,7 +67,7 @@ const deleteLearningPath = (id: string, comments: string, token: string): Promis
  * Discard the training plan draft changes
  * @param {String} id The id of the training plan to be deleted
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const discardLearningPathChanges = (id: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -76,10 +77,10 @@ const discardLearningPathChanges = (id: string, token: string): Promise<object>
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -90,21 +91,21 @@ const discardLearningPathChanges = (id: string, token: string): Promise<object>
  * @param {String} id The id of the template
  * @param {String} version The version of the template
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getLearningPathInformationById = (id: string, version: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/learningpaths/${id}/${version}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -130,7 +131,7 @@ const getLearningPathsList = (
       includeDeleted: includeDeleted,
     };
     if (list) requestData.list = list;
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningpaths`,
       requestData,
       {
@@ -138,10 +139,10 @@ const getLearningPathsList = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -152,13 +153,13 @@ const getLearningPathsList = (
  * @param {String} 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 publishLearningPath = (id: string, comments: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data: LearningPathData = {};
+    const data: LearningPathData = {};
     if (comments) data.comments = comments;
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningpaths/publish/${id}`,
       data,
       {
@@ -166,10 +167,10 @@ const publishLearningPath = (id: string, comments: string, token: string): Promi
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -180,7 +181,7 @@ const publishLearningPath = (id: string, comments: string, token: string): Promi
  * @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 setLearningPathInformation = (id: string, data: object, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -188,7 +189,7 @@ const setLearningPathInformation = (id: string, data: object, token: string): Pr
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningpaths/update/`,
       requestData,
       {
@@ -196,10 +197,10 @@ const setLearningPathInformation = (id: string, data: object, token: string): Pr
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -210,7 +211,7 @@ const setLearningPathInformation = (id: string, data: object, token: string): Pr
  * @param {String} id The id of the template to be updated
  * @param {Object} tags The updated tags
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setLearningPathTags = (id: string, tags: object, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -218,7 +219,7 @@ const setLearningPathTags = (id: string, tags: object, token: string): Promise<o
       tags: tags,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningpaths/updatetags/`,
       requestData,
       {
@@ -226,10 +227,10 @@ const setLearningPathTags = (id: string, tags: object, token: string): Promise<o
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/logger.ts

@@ -1,4 +1,5 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Create comments for a specified element id
@@ -6,7 +7,7 @@ import { client } from "./axiosClient.js";
  * @param {String} elementType
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const comments = (
   elementId: string,
@@ -15,7 +16,7 @@ const comments = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       "api/v1/logger/comments/",
       {
         data: data,
@@ -27,10 +28,10 @@ const comments = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -42,7 +43,7 @@ const comments = (
  * @param {Number} page The results page
  * @param {Number} elementsPerPage The number of elements per page
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getListByElementId = (
   elementId: string,
@@ -51,7 +52,7 @@ const getListByElementId = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data: { elementsPerPage?: number, page?: number } = {};
+    const data: { elementsPerPage?: number, page?: number } = {};
     if (elementsPerPage !== null) data.elementsPerPage = elementsPerPage;
     if (page !== null) data.page = page;
     const getTokensRequest = client.post(`api/v1/logger/${elementId}`, data, {
@@ -61,7 +62,7 @@ const getListByElementId = (
       .then((result) => {
         resolve(result.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/microSkillsQuizes.ts

@@ -1,11 +1,12 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Get responses for a microskill quiz
  * @param {String} learningContentId
  * @param {String} microSkillId
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getResponses = (
   learningContentId: string,
@@ -13,17 +14,17 @@ const getResponses = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/microskillsresponses/${learningContentId}/${microSkillId}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -35,7 +36,7 @@ const getResponses = (
  * @param {String} microSkillId
  * @param {Array<Object>} responses
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const saveResponses = (
   learningContentId: string,
@@ -44,10 +45,10 @@ const saveResponses = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data = {
+    const data = {
       responses: responses,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/microskillsresponses/${learningContentId}/${microSkillId}`,
       data,
       {
@@ -55,10 +56,10 @@ const saveResponses = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/quotas.ts

@@ -1,20 +1,21 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Get the current quota for the user and tenant
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getAllQuota = (token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(`/api/v1/quotas/getallquota`, {
+    const confirmationRequest = client.get(`/api/v1/quotas/getallquota`, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -25,7 +26,7 @@ const getAllQuota = (token: string): Promise<object> => {
  * @param {String} quotaId
  * @param {Number} value
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const increaseQuotaUtilization = (
   quotaId: string,
@@ -33,7 +34,7 @@ const increaseQuotaUtilization = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `/api/v1/quotas/increaseutilization`,
       {
         id: quotaId,
@@ -44,10 +45,10 @@ const increaseQuotaUtilization = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });