@stackfactor/client-api 1.1.128 → 1.1.130

package/lib/{role.js → role.ts}

@@ -4,10 +4,10 @@ import { client } from "./axiosClient.js";
  * Create role and set information
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const createRole = (data, token) => {
-  return new Promise(function (resolve, reject) {
+const createRole = (data: object, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.put(
       "api/v1/roles",
       { data: data },
@@ -30,13 +30,29 @@ const createRole = (data, token) => {
  * @param {String} templateId
  * @param {Object} data
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const createRoleFromTemplate = (templateId, data, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+const createRoleFromTemplate = (
+  templateId: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { 
+      includeDeleted: boolean; 
+      includeDetailedInformation: boolean; 
+      namesOnly: boolean; 
+      returnDefaultIfVersionNotAvailable: boolean; 
+      version: string; 
+      filter?: object;
+      templateId: string;
+    } = {
       templateId: templateId,
-      data: data,
+      includeDeleted: false,
+      includeDetailedInformation: false,
+      namesOnly: false,
+      returnDefaultIfVersionNotAvailable: false,
+      version: "1.0",
     };
     let confirmationRequest = client.put(
       "api/v1/roles/createfromtemplate/",
@@ -60,17 +76,20 @@ const createRoleFromTemplate = (templateId, data, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const deleteRole = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    const data = {
+const deleteRole = (
+  id: string,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const data: { id: string, comments?: string } = {
       id: id,
     };
     if (comments) data.comments = comments;
     const request = client.delete(`api/v1/roles/`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -87,14 +106,13 @@ const deleteRole = (id, comments, token) => {
  * Discard the role draft changes
  * @param {String} id The id of the role to be deleted
  * @param {String} token Authorization token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const discardRoleChanges = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const discardRoleChanges = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const data = {};
     const request = client.get(`api/v1/roles/discard/${id}`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -110,15 +128,14 @@ const discardRoleChanges = (id, token) => {
 /**
  * Get the list of imported role templates
  * @param {String} token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const getImportedRoleTemplates = (token) => {
-  return new Promise(function (resolve, reject) {
+const getImportedRoleTemplates = (token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const request = client.get(`api/v1/roles/getimportedroletemplates`, {
       headers: { authorization: token },
     });
     request
-
       .then((response) => {
         resolve(response.data);
       })
@@ -134,15 +151,15 @@ const getImportedRoleTemplates = (token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
 const getRoleInformationById = (
-  id,
-  version,
-  returnNullIfVersionNotFound,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+  id: number,
+  version: string,
+  returnNullIfVersionNotFound: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/roles/role/${id}/${version}/${returnNullIfVersionNotFound}`,
       {
@@ -168,19 +185,26 @@ 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}
+ * @returns {Promise<Object>}
  */
 const getRolesList = (
-  filter,
-  version,
-  includeDeleted,
-  includeDetailedInformation,
-  returnDefaultIfVersionNotAvailable,
-  namesOnly,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+  filter: object,
+  version: string,
+  includeDeleted: boolean,
+  includeDetailedInformation: boolean,
+  returnDefaultIfVersionNotAvailable: boolean,
+  namesOnly: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { 
+      includeDeleted: boolean; 
+      includeDetailedInformation: boolean; 
+      namesOnly: boolean; 
+      returnDefaultIfVersionNotAvailable: boolean; 
+      version: string; 
+      filter?: object;
+    } = {
       includeDeleted: includeDeleted,
       includeDetailedInformation: includeDetailedInformation,
       namesOnly: namesOnly,
@@ -205,10 +229,10 @@ const getRolesList = (
  * Get role template updates
  * @param {String} id The role id
  * @param {String} token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const getRoleTemplateUpdates = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const getRoleTemplateUpdates = (id: string, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/roles/getroletemplateupdates/${id}`,
       {
@@ -227,14 +251,18 @@ const getRoleTemplateUpdates = (id, token) => {
 
 /**
  * Import role templates
- * @param {Array<String>} data The list of role templates to be imported
+ * @param {Array<Object>} data The list of role templates to be imported
  * @param {String} token
- * @returns {Promise}
+ * @returns {Promise<Object>}
  */
-const importRoleTemplates = (data, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
-      data: data,
+const importRoleTemplates = (
+  data: object[],
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { roles: object[]; jobDescription: string; userid?: string } = {
+      roles: data,
+      jobDescription: "default job description", // Add a default job description or pass it as a parameter
     };
     let confirmationRequest = client.post(
       `api/v1/roles/importRoleTemplates`,
@@ -244,7 +272,6 @@ const importRoleTemplates = (data, token) => {
       }
     );
     confirmationRequest
-
       .then((response) => {
         resolve(response.data);
       })
@@ -259,11 +286,15 @@ const importRoleTemplates = (data, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const publishRole = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {};
+const publishRole = (
+  id: number,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data: { comments?: string } = {};
     if (comments) data.comments = comments;
     let confirmationRequest = client.post(`api/v1/roles/publish/${id}`, data, {
       headers: { authorization: token },
@@ -283,10 +314,14 @@ const publishRole = (id, comments, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const setRoleInformation = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setRoleInformation = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: id,
@@ -309,10 +344,14 @@ const setRoleInformation = (id, data, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const setRoleInformationFromTemplate = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setRoleInformationFromTemplate = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: id,
@@ -340,11 +379,16 @@ const setRoleInformationFromTemplate = (id, data, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const setUserRoles = (id, roles, jobDescription, token) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+const setUserRoles = (
+  id: string,
+  roles: object[],
+  jobDescription: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { roles: object[]; jobDescription: string; userid?: string } = {
       roles: roles,
       jobDescription: jobDescription,
     };
@@ -367,10 +411,14 @@ const setUserRoles = (id, roles, jobDescription, token) => {
  * @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}
+ * @returns {Promise<Object>}
  */
-const watchRole = (id, watch, token) => {
-  return new Promise(function (resolve, reject) {
+const watchRole = (
+  id: string,
+  watch: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
       watch: watch,

package/lib/{roleTemplate.js → roleTemplate.ts}

@@ -4,9 +4,10 @@ import { client } from "./axiosClient.js";
  * Create role template and set information
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const createRoleTemplate = (data, token) => {
-  return new Promise(function (resolve, reject) {
+const createRoleTemplate = (data: object, token: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
@@ -28,16 +29,20 @@ const createRoleTemplate = (data, token) => {
  * @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>}
  */
-const deleteRoleTemplate = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    const data = {
+const deleteRoleTemplate = (
+  id: string,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const data: { id: string, comments?: string } = {
       id: id,
     };
     if (comments) data.comments = comments;
     const request = client.delete(`api/v1/roletemplates/`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -54,13 +59,16 @@ const deleteRoleTemplate = (id, comments, token) => {
  * 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>}
  */
-const discardRoleTemplateChanges = (id, token) => {
-  return new Promise(function (resolve, reject) {
+const discardRoleTemplateChanges = (
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const data = {};
     const request = client.get(`api/v1/roletemplates/discard/${id}`, {
       headers: { authorization: token },
-
       data: data,
     });
     request
@@ -76,10 +84,16 @@ const discardRoleTemplateChanges = (id, token) => {
 /**
  * Get role template information
  * @param {String} id The id of the template
+ * @param {String} version The version of the template
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-const getRoleTemplateInformationById = (id, version, token) => {
-  return new Promise(function (resolve, reject) {
+const getRoleTemplateInformationById = (
+  id: string,
+  version: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     let confirmationRequest = client.get(
       `api/v1/roletemplates/${id}/${version}`,
       {
@@ -103,16 +117,17 @@ const getRoleTemplateInformationById = (id, version, token) => {
  * @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>}
  */
 const getRoleTemplateList = (
-  filter,
-  version,
-  includeDeleted,
-  namesOnly,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
-    const requestData = {
+  filter: string[],
+  version: string,
+  includeDeleted: boolean,
+  namesOnly: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData: { includeDeleted: boolean; namesOnly: boolean; version: string; filter?: string[] } = {
       includeDeleted: includeDeleted,
       namesOnly: namesOnly,
       version: version,
@@ -136,10 +151,15 @@ 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>}
  */
-const publishTemplate = (id, comments, token) => {
-  return new Promise(function (resolve, reject) {
-    let data = {};
+const publishTemplate = (
+  id: number,
+  comments: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let data: { comments?: string } = {};
     if (comments) data.comments = comments;
     let confirmationRequest = client.post(
       `api/v1/roletemplates/publish/${id}`,
@@ -163,9 +183,14 @@ const publishTemplate = (id, comments, token) => {
  * @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>}
  */
-const setTemplateInformation = (id, data, token) => {
-  return new Promise(function (resolve, reject) {
+const setTemplateInformation = (
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
       id: id,
@@ -192,9 +217,14 @@ const setTemplateInformation = (id, data, token) => {
  * @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>}
  */
-const setTemplateTags = (id, tags, token) => {
-  return new Promise(function (resolve, reject) {
+const setTemplateTags = (
+  id: string,
+  tags: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       tags: tags,
       id: id,
@@ -221,9 +251,14 @@ const setTemplateTags = (id, tags, token) => {
  * @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>}
  */
-const watchRoleTemplate = (id, watch, token) => {
-  return new Promise(function (resolve, reject) {
+const watchRoleTemplate = (
+  id: string,
+  watch: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       id: id,
       watch: watch,

package/lib/{security.js → security.ts}

@@ -5,8 +5,8 @@ import { client } from "./axiosClient.js";
  * @param {String} authToken - Authorization token
  * @returns {Promise<Object>}
  */
-const getAuthConnections = (authToken) => {
-  return new Promise(function (resolve, reject) {
+const getAuthConnections = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const getConfigInformationRequest = client.get(
       `api/v1/security/authconnections`,
       { headers: { authorization: authToken } }
@@ -25,9 +25,13 @@ const getAuthConnections = (authToken) => {
  * 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>}
  */
-const setAuthConnections = (data, authToken) => {
-  return new Promise(function (resolve, reject) {
+const setAuthConnections = (
+  data: object,
+  authToken: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const setConfigInformationRequest = client.post(
       `api/v1/security/authconnections`,
       { data: data },
@@ -49,8 +53,8 @@ const setAuthConnections = (data, authToken) => {
  * @param {String} authToken
  * @returns {Promise<Object>}
  */
-const resetMFA = (userId, authToken) => {
-  return new Promise(function (resolve, reject) {
+const resetMFA = (userId: string, authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const resetMFARequest = client.post(
       `api/v1/security/resetmfa`,
       userId ? {} : { userId: userId },
@@ -71,13 +75,13 @@ const resetMFA = (userId, authToken) => {
  * @param {String} authToken
  * @returns {Promise<Object>}
  */
-const synchronizeWithAuth0 = (authToken) => {
-  return new Promise(function (resolve, reject) {
-    const sunchronizeRequest = client.get(
+const synchronizeWithAuth0 = (authToken: string): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const synchronizeRequest = client.get(
       `api/v1/security/synchronizewithauth0`,
       { headers: { authorization: authToken } }
     );
-    sunchronizeRequest
+    synchronizeRequest
       .then((response) => {
         resolve(response.data);
       })