@stackfactor/client-api 1.1.134 → 1.1.136

package/src/lib/integrations/contentGenerator.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "../axiosClient";
 
 interface GenerateContentData {
@@ -21,7 +22,7 @@ interface GenerateContentAsyncData {
  * @param {String} contentType
  * @param {String} integrationId
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 export const generateContent = (
   data: string[],
@@ -30,7 +31,7 @@ export const generateContent = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data_: GenerateContentData = {
+    const data_: GenerateContentData = {
       data: data,
       contentType: contentType,
     };
@@ -39,10 +40,10 @@ export const generateContent = (
       headers: { authorization: token },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -57,7 +58,7 @@ export const generateContent = (
  * @param {String} integrationId
  * @param {String} comments
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 export const generateContentAsync = (
   id: string,
@@ -69,7 +70,7 @@ export const generateContentAsync = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data_: GenerateContentAsyncData = {
+    const data_: GenerateContentAsyncData = {
       id: id,
       data: data,
       comments: comments,
@@ -85,10 +86,10 @@ export const generateContentAsync = (
       }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/learningContent.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 interface LearningContentData {
@@ -22,7 +23,7 @@ interface GenerateLearningActivityContentData {
  * Create learning content and set information
  * @param {Object} data Learning content data
  * @param {String} token Authorization token
- * @returns {Promise<Object>} The created learning content
+ * @returns {Promise<object>} The created learning content
  */
 const createLearningContent = (
   data: object,
@@ -32,7 +33,7 @@ const createLearningContent = (
     const requestData: LearningContentData = {
       data: data,
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/learningcontent",
       requestData,
       {
@@ -40,10 +41,10 @@ const createLearningContent = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -54,7 +55,7 @@ const createLearningContent = (
  * @param {String} id The id of the learning content to be deleted
  * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
- * @returns {Promise<Object>} The response from the server
+ * @returns {Promise<object>} The response from the server
  */
 const deleteLearningContent = (
   id: string,
@@ -71,10 +72,10 @@ const deleteLearningContent = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -84,7 +85,7 @@ const deleteLearningContent = (
  * Discard the learning content draft changes
  * @param {String} id The id of the learning content to be deleted
  * @param {String} token Authorization token
- * @returns {Promise<Object>} The response from the server
+ * @returns {Promise<object>} The response from the server
  */
 const discardLearningContentChanges = (
   id: string,
@@ -97,10 +98,10 @@ const discardLearningContentChanges = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -143,10 +144,10 @@ const generateLearningActivityContent = (
       }
     );
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -156,17 +157,17 @@ const generateLearningActivityContent = (
  * Generate micro skill test knowledge
  * @param {String} microSkill
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const generateMicroSkillTestKnowledge = (
   microSkill: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data = {
+    const data = {
       microSkill: microSkill,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/generatemicroskilltestknowledge`,
       data,
       {
@@ -174,10 +175,10 @@ const generateMicroSkillTestKnowledge = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -188,7 +189,7 @@ const generateMicroSkillTestKnowledge = (
  * @param {String} id The id of the learning content
  * @param {String} version The version of the learning content
  * @param {String} token Authorization token
- * @returns {Promise<Object>} The response from the server
+ * @returns {Promise<object>} The response from the server
  */
 const getLearningContentInformationById = (
   id: string,
@@ -196,17 +197,17 @@ const getLearningContentInformationById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/learningcontent/${id}/${version}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -232,7 +233,7 @@ const getLearningContentList = (
       includeDeleted: includeDeleted,
     };
     if (filter) requestData.filter = filter;
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent`,
       requestData,
       {
@@ -240,10 +241,10 @@ const getLearningContentList = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -253,15 +254,15 @@ const getLearningContentList = (
  * Migrate learning content storage
  * @param {String} id The id of the content to be migrated
  * @param {String} token Authorization token
- * @returns {Promise<Object>} The response from the server
+ * @returns {Promise<object>} The response from the server
  */
 const migrateLearningContentStorageType = (
   id: string,
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data = {};
-    let confirmationRequest = client.post(
+    const data = {};
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/migratestorage/${id}`,
       data,
       {
@@ -269,10 +270,10 @@ const migrateLearningContentStorageType = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -283,7 +284,7 @@ const migrateLearningContentStorageType = (
  * @param {String} id The id of the content to be published
  * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
- * @returns {Promise<Object>} The response from the server
+ * @returns {Promise<object>} The response from the server
  */
 const publishLearningContent = (
   id: string,
@@ -291,10 +292,10 @@ const publishLearningContent = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let data: LearningContentData = {};
+    const data: LearningContentData = {};
     if (comments) data.comments = comments;
 
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/publish/${id}`,
       data,
       {
@@ -302,10 +303,10 @@ const publishLearningContent = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -316,7 +317,7 @@ const publishLearningContent = (
  * @param {String} id The id of the learning content to be updated
  * @param {Object} data Data used to update the learning content
  * @param {String} token Authorization token
- * @returns {Promise<Object>} The updated learning content
+ * @returns {Promise<object>} The updated learning content
  */
 const setLearningContentInformation = (
   id: string,
@@ -328,7 +329,7 @@ const setLearningContentInformation = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/update`,
       requestData,
       {
@@ -336,10 +337,10 @@ const setLearningContentInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -350,7 +351,7 @@ const setLearningContentInformation = (
  * @param {String} id
  * @param {Object} data
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setLearningContentPartialContentInformation = (
   id: string,
@@ -362,7 +363,7 @@ const setLearningContentPartialContentInformation = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/updatepartialcontent/${id}`,
       requestData,
       {
@@ -370,10 +371,10 @@ const setLearningContentPartialContentInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -402,7 +403,7 @@ const setLearningContentLearningContentInformation = (
       learningcontentid: learningcontentid,
       microSkillId: microSkillId,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/updatelearningcontent/`,
       requestData,
       {
@@ -410,10 +411,10 @@ const setLearningContentLearningContentInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -437,7 +438,7 @@ const setLearningContentLearningMicroSkillContentInformation = (
     const requestData: LearningContentData = {
       data: data,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/updatemicroskilllearningcontent/${id}/${microskillid}`,
       requestData,
       {
@@ -445,10 +446,10 @@ const setLearningContentLearningMicroSkillContentInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -470,7 +471,7 @@ const setLearningContentTags = (
       tags: tags,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/updatetags/`,
       requestData,
       {
@@ -478,10 +479,10 @@ const setLearningContentTags = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -503,7 +504,7 @@ const watchLearningContent = (
       id: id,
       watch: watch,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/learningcontent/watch`,
       requestData,
       {
@@ -511,10 +512,10 @@ const watchLearningContent = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/learningPath.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 interface LearningPathData {
@@ -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);
       });
   });