@stackfactor/client-api 1.1.15-8.1 → 1.1.15

package/lib/role.js

@@ -0,0 +1,406 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Create role and set information
+ * @param {Object} data
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const createRole = (data, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.put(
+      "api/v1/roles",
+      { data: data },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Create from from template
+ * @param {String} templateId
+ * @param {Object} data
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const createRoleFromTemplate = (templateId, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      templateId: templateId,
+      data: data,
+    };
+    let confirmationRequest = client.put(
+      "api/v1/roles/createfromtemplate/",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Delete role
+ * @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}
+ */
+export const deleteRole = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
+      id: id,
+    };
+    if (comments) data.comments = comments;
+    const request = client.delete(`api/v1/roles/`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Discard the role draft changes
+ * @param {String} id The id of the role to be deleted
+ * @param {String} token Authorization token
+ * @returns {Promise}
+ */
+export const discardRoleChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {};
+    const request = client.get(`api/v1/roles/discard/${id}`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get the list of imported role templates
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const getImportedRoleTemplates = (token) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.get(`api/v1/roles/getimportedroletemplates`, {
+      headers: { authorization: token },
+    });
+    request
+
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get role information
+ * @param {number} id The id of the role
+ * @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}
+ */
+export const getRoleInformationById = (
+  id,
+  version,
+  returnNullIfVersionNotFound,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/roles/role/${id}/${version}/${returnNullIfVersionNotFound}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get roles list
+ * @param {Object} filter The filter used to select the roles
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeDeleted If true it will return deleted records as well
+ * @param {boolean} includeDetailedInformation If true it will return detailed information
+ * @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}
+ */
+export const getRolesList = (
+  filter,
+  version,
+  includeDeleted,
+  includeDetailedInformation,
+  returnDefaultIfVersionNotAvailable,
+  namesOnly,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      includeDeleted: includeDeleted,
+      includeDetailedInformation: includeDetailedInformation,
+      namesOnly: namesOnly,
+      returnDefaultIfVersionNotAvailable: returnDefaultIfVersionNotAvailable,
+      version: version,
+    };
+    if (filter) requestData.filter = filter;
+    let confirmationRequest = client.post(`api/v1/roles`, requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get role template updates
+ * @param {String} id The role id
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const getRoleTemplateUpdates = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/roles/getroletemplateupdates/${id}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Import role templates
+ * @param {Array<String>} data The list of role templates to be imported
+ * @param {String} token
+ * @returns {Promise}
+ */
+export const importRoleTemplates = (data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/roles/importRoleTemplates`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Publish role
+ * @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}
+ */
+export const publishRole = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
+    if (comments) data.comments = comments;
+    let confirmationRequest = client.post(`api/v1/roles/publish/${id}`, data, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set role profile information
+ * @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}
+ */
+export const setRoleInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      id: id,
+    };
+    let confirmationRequest = client.post(`api/v1/roles/update`, requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set the role information from template
+ * @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}
+ */
+export const setRoleInformationFromTemplate = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      id: id,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/roles/updatefromtemplate/`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set user roles
+ * @param {String} id The id of the user to be updated
+ * @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}
+ */
+export const setUserRoles = (id, roles, jobDescription, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      roles: roles,
+      jobDescription: jobDescription,
+    };
+    if (id) requestData.userid = id;
+    let request = client.post(`api/v1/roles/settouser/`, requestData, {
+      headers: { authorization: token },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Watch role
+ * @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}
+ */
+export const watchRole = (id, watch, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      id: id,
+      watch: watch,
+    };
+    let confirmationRequest = client.post(`api/v1/roles/watch`, requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const role = {
+  createRole,
+  createRoleFromTemplate,
+  deleteRole,
+  discardRoleChanges,
+  getImportedRoleTemplates,
+  getRoleInformationById,
+  getRolesList,
+  getRoleTemplateUpdates,
+  importRoleTemplates,
+  publishRole,
+  setRoleInformation,
+  setRoleInformationFromTemplate,
+  setUserRoles,
+  watchRole,
+};
+
+export default role;

package/lib/roleTemplate.js

@@ -0,0 +1,258 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Create role template and set information
+ * @param {Object} data
+ * @param {String} token Authorization token
+ */
+export const createRoleTemplate = (data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+    };
+    let confirmationRequest = client.put("api/v1/roletemplates", requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Delete role template
+ * @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
+ */
+export const deleteRoleTemplate = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
+      id: id,
+    };
+    if (comments) data.comments = comments;
+    const request = client.delete(`api/v1/roletemplates/`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Discard the role template draft changes
+ * @param {String} id The id of the role template to be deleted
+ * @param {String} token Authorization token
+ */
+export const discardRoleTemplateChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {};
+    const request = client.get(`api/v1/roletemplates/discard/${id}`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get role template information
+ * @param {String} id The id of the template
+ * @param {String} token Authorization token
+ */
+export const getRoleTemplateInformationById = (id, version, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/roletemplates/${id}/${version}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get role template list
+ * @param {Array<String>} filter The list of integrations to be received
+ * @param {String} version The version of the template
+ * @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
+ */
+export const getRoleTemplateList = (
+  filter,
+  version,
+  includeDeleted,
+  namesOnly,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      includeDeleted: includeDeleted,
+      namesOnly: namesOnly,
+      version: version,
+    };
+    if (filter) requestData.filter = filter;
+    let confirmationRequest = client.post(`api/v1/roletemplates`, requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Publish template
+ * @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
+ */
+export const publishTemplate = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
+    if (comments) data.comments = comments;
+    let confirmationRequest = client.post(
+      `api/v1/roletemplates/publish/${id}`,
+      data,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set template profile information
+ * @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
+ */
+export const setTemplateInformation = (id, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      id: id,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/roletemplates/update`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Update the role template tags
+ * @param {String} id The id of the template to be updated
+ * @param {Object} tags Updated template tags
+ * @param {String} token Authorization token
+ */
+export const setTemplateTags = (id, tags, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      tags: tags,
+      id: id,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/roletemplates/updatetags/`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Watch role template
+ * @param {String} id The id of the skill to be updated
+ * @param {Boolean} watch Set to true or false
+ * @param {String} token Authorization token
+ */
+export const watchRoleTemplate = (id, watch, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      id: id,
+      watch: watch,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/roletemplates/watch`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const roleTemplate = {
+  createRoleTemplate,
+  deleteRoleTemplate,
+  discardRoleTemplateChanges,
+  getRoleTemplateInformationById,
+  getRoleTemplateList,
+  publishTemplate,
+  setTemplateInformation,
+  setTemplateTags,
+  watchRoleTemplate,
+};
+
+export default roleTemplate;