@stackfactor/client-api 1.1.134 → 1.1.135

package/src/lib/roleTemplate.ts

@@ -1,24 +1,25 @@
+import { AxiosError, AxiosResponse } from "axios";
 import { client } from "./axiosClient";
 
 /**
  * Create role template and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createRoleTemplate = (data: object, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
-    let confirmationRequest = client.put("api/v1/roletemplates", requestData, {
+    const confirmationRequest = client.put("api/v1/roletemplates", 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 createRoleTemplate = (data: object, token: string): Promise<object> => {
  * @param {String} 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 deleteRoleTemplate = (
   id: string,
@@ -46,10 +47,10 @@ const deleteRoleTemplate = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -59,7 +60,7 @@ const deleteRoleTemplate = (
  * Discard the role template draft changes
  * @param {String} id The id of the role template to be deleted
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const discardRoleTemplateChanges = (
   id: string,
@@ -72,10 +73,10 @@ const discardRoleTemplateChanges = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -86,7 +87,7 @@ const discardRoleTemplateChanges = (
  * @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 getRoleTemplateInformationById = (
   id: string,
@@ -94,17 +95,17 @@ const getRoleTemplateInformationById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/roletemplates/${id}/${version}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -117,7 +118,7 @@ const getRoleTemplateInformationById = (
  * @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 getRoleTemplateList = (
   filter: string[],
@@ -133,14 +134,14 @@ const getRoleTemplateList = (
       version: version,
     };
     if (filter) requestData.filter = filter;
-    let confirmationRequest = client.post(`api/v1/roletemplates`, requestData, {
+    const confirmationRequest = client.post(`api/v1/roletemplates`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -151,7 +152,7 @@ const getRoleTemplateList = (
  * @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,
@@ -159,9 +160,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/roletemplates/publish/${id}`,
       data,
       {
@@ -169,10 +170,10 @@ const publishTemplate = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -183,7 +184,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,
@@ -195,7 +196,7 @@ const setTemplateInformation = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/roletemplates/update`,
       requestData,
       {
@@ -203,10 +204,10 @@ const setTemplateInformation = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -217,7 +218,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,
@@ -229,7 +230,7 @@ const setTemplateTags = (
       tags: tags,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/roletemplates/updatetags/`,
       requestData,
       {
@@ -237,10 +238,10 @@ const setTemplateTags = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -251,7 +252,7 @@ const setTemplateTags = (
  * @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 watchRoleTemplate = (
   id: string,
@@ -263,7 +264,7 @@ const watchRoleTemplate = (
       id: id,
       watch: watch,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/roletemplates/watch`,
       requestData,
       {
@@ -271,10 +272,10 @@ const watchRoleTemplate = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/security.ts

@@ -1,9 +1,10 @@
+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);
       });
   });