@stackfactor/client-api 1.1.133 → 1.1.135

package/src/lib/role.ts

@@ -1,14 +1,15 @@
-import { client } from "./axiosClient.js";
+import { AxiosError, AxiosResponse } from "axios";
+import { client } from "./axiosClient";
 
 /**
  * Create role and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createRole = (data: object, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/roles",
       { data: data },
       {
@@ -16,10 +17,10 @@ const createRole = (data: object, token: string): Promise<object> => {
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -30,7 +31,7 @@ const createRole = (data: object, token: string): Promise<object> => {
  * @param {String} templateId
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const createRoleFromTemplate = (
   templateId: string,
@@ -54,7 +55,7 @@ const createRoleFromTemplate = (
       returnDefaultIfVersionNotAvailable: false,
       version: "1.0",
     };
-    let confirmationRequest = client.put(
+    const confirmationRequest = client.put(
       "api/v1/roles/createfromtemplate/",
       requestData,
       {
@@ -62,10 +63,10 @@ const createRoleFromTemplate = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -76,7 +77,7 @@ const createRoleFromTemplate = (
  * @param {String} id The id of the role to be deleted
  * @param {String} comments The comments included with the deletion
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const deleteRole = (
   id: string,
@@ -93,10 +94,10 @@ const deleteRole = (
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -106,7 +107,7 @@ const deleteRole = (
  * Discard the role draft changes
  * @param {String} id The id of the role to be deleted
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const discardRoleChanges = (id: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -116,10 +117,10 @@ const discardRoleChanges = (id: string, token: string): Promise<object> => {
       data: data,
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -128,7 +129,7 @@ const discardRoleChanges = (id: string, token: string): Promise<object> => {
 /**
  * Get the list of imported role templates
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getImportedRoleTemplates = (token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
@@ -136,10 +137,10 @@ const getImportedRoleTemplates = (token: string): Promise<object> => {
       headers: { authorization: token },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -151,7 +152,7 @@ const getImportedRoleTemplates = (token: string): Promise<object> => {
  * @param {String} version The version to be retrieved
  * @param {Boolean} returnNullIfVersionNotFound Return null if the version is not found
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getRoleInformationById = (
   id: number,
@@ -160,17 +161,17 @@ const getRoleInformationById = (
   token: string
 ): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/roles/role/${id}/${version}/${returnNullIfVersionNotFound}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -185,7 +186,7 @@ const getRoleInformationById = (
  * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
  * @param {Boolean} namesOnly Return only the names of the roles
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getRolesList = (
   filter: object,
@@ -212,14 +213,14 @@ const getRolesList = (
       version: version,
     };
     if (filter) requestData.filter = filter;
-    let confirmationRequest = client.post(`api/v1/roles`, requestData, {
+    const confirmationRequest = client.post(`api/v1/roles`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -229,21 +230,21 @@ const getRolesList = (
  * Get role template updates
  * @param {String} id The role id
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const getRoleTemplateUpdates = (id: string, token: string): Promise<object> => {
   return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(
+    const confirmationRequest = client.get(
       `api/v1/roles/getroletemplateupdates/${id}`,
       {
         headers: { authorization: token },
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -253,7 +254,7 @@ const getRoleTemplateUpdates = (id: string, token: string): Promise<object> => {
  * Import role templates
  * @param {Array<Object>} data The list of role templates to be imported
  * @param {String} token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const importRoleTemplates = (
   data: object[],
@@ -264,7 +265,7 @@ const importRoleTemplates = (
       roles: data,
       jobDescription: "default job description", // Add a default job description or pass it as a parameter
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/roles/importRoleTemplates`,
       requestData,
       {
@@ -272,10 +273,10 @@ const importRoleTemplates = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -286,7 +287,7 @@ const importRoleTemplates = (
  * @param {number} id The id of the role 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 publishRole = (
   id: number,
@@ -294,16 +295,16 @@ const publishRole = (
   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(`api/v1/roles/publish/${id}`, data, {
+    const confirmationRequest = client.post(`api/v1/roles/publish/${id}`, data, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -314,7 +315,7 @@ const publishRole = (
  * @param {String} id The id of the role to be updated
  * @param {Object} data Data used to update the role
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setRoleInformation = (
   id: string,
@@ -326,14 +327,14 @@ const setRoleInformation = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(`api/v1/roles/update`, requestData, {
+    const confirmationRequest = client.post(`api/v1/roles/update`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -344,7 +345,7 @@ const setRoleInformation = (
  * @param {String} id The id of the role to be updated
  * @param {Object} data Data used to update the role
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setRoleInformationFromTemplate = (
   id: string,
@@ -356,7 +357,7 @@ const setRoleInformationFromTemplate = (
       data: data,
       id: id,
     };
-    let confirmationRequest = client.post(
+    const confirmationRequest = client.post(
       `api/v1/roles/updatefromtemplate/`,
       requestData,
       {
@@ -364,10 +365,10 @@ const setRoleInformationFromTemplate = (
       }
     );
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -379,7 +380,7 @@ const setRoleInformationFromTemplate = (
  * @param {Array<Object>} roles The list of roles to be assigned to the user
  * @param {String} jobDescription The job description to be assigned to the user
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const setUserRoles = (
   id: string,
@@ -393,14 +394,14 @@ const setUserRoles = (
       jobDescription: jobDescription,
     };
     if (id) requestData.userid = id;
-    let request = client.post(`api/v1/roles/settouser/`, requestData, {
+    const request = client.post(`api/v1/roles/settouser/`, requestData, {
       headers: { authorization: token },
     });
     request
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });
@@ -411,7 +412,7 @@ const setUserRoles = (
  * @param {String} id The id of the role to be updated
  * @param {Boolean} watch Set to true or false
  * @param {String} token Authorization token
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 const watchRole = (
   id: string,
@@ -423,14 +424,14 @@ const watchRole = (
       id: id,
       watch: watch,
     };
-    let confirmationRequest = client.post(`api/v1/roles/watch`, requestData, {
+    const confirmationRequest = client.post(`api/v1/roles/watch`, requestData, {
       headers: { authorization: token },
     });
     confirmationRequest
-      .then((response) => {
+      .then((response : AxiosResponse) => {
         resolve(response.data);
       })
-      .catch((error) => {
+      .catch((error : AxiosError) => {
         reject(error);
       });
   });

package/src/lib/roleTemplate.ts

@@ -1,24 +1,25 @@
-import { client } from "./axiosClient.js";
+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);
       });
   });