@stackfactor/client-api 1.1.140 → 1.1.143

package/src/lib/role.ts

@@ -1,438 +0,0 @@
-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>}
- */
-export const createRole = (data: object, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.put(
-      "api/v1/roles",
-      { data: data },
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Create from from template
- * @param {String} templateId
- * @param {Object} data
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export 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,
-      includeDeleted: false,
-      includeDetailedInformation: false,
-      namesOnly: false,
-      returnDefaultIfVersionNotAvailable: false,
-      version: "1.0",
-    };
-    const confirmationRequest = client.put(
-      "api/v1/roles/createfromtemplate/",
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export 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
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export 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
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get the list of imported role templates
- * @param {String} token
- * @returns {Promise<object>}
- */
-export 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 : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export const getRoleInformationById = (
-  id: number,
-  version: string,
-  returnNullIfVersionNotFound: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.get(
-      `api/v1/roles/role/${id}/${version}/${returnNullIfVersionNotFound}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export const getRolesList = (
-  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,
-      returnDefaultIfVersionNotAvailable: returnDefaultIfVersionNotAvailable,
-      version: version,
-    };
-    if (filter) requestData.filter = filter;
-    const confirmationRequest = client.post(`api/v1/roles`, requestData, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get role template updates
- * @param {String} id The role id
- * @param {String} token
- * @returns {Promise<object>}
- */
-export const getRoleTemplateUpdates = (id: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.get(
-      `api/v1/roles/getroletemplateupdates/${id}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Import role templates
- * @param {Array<Object>} data The list of role templates to be imported
- * @param {String} token
- * @returns {Promise<object>}
- */
-export 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
-    };
-    const confirmationRequest = client.post(
-      `api/v1/roles/importRoleTemplates`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export const publishRole = (
-  id: number,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: { comments?: string } = {};
-    if (comments) data.comments = comments;
-    const confirmationRequest = client.post(`api/v1/roles/publish/${id}`, data, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export const setRoleInformation = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      data: data,
-      id: id,
-    };
-    const confirmationRequest = client.post(`api/v1/roles/update`, requestData, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export const setRoleInformationFromTemplate = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      data: data,
-      id: id,
-    };
-    const confirmationRequest = client.post(
-      `api/v1/roles/updatefromtemplate/`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export 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,
-    };
-    if (id) requestData.userid = id;
-    const request = client.post(`api/v1/roles/settouser/`, requestData, {
-      headers: { authorization: token },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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<object>}
- */
-export const watchRole = (
-  id: string,
-  watch: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      id: id,
-      watch: watch,
-    };
-    const confirmationRequest = client.post(`api/v1/roles/watch`, requestData, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};

package/src/lib/roleTemplate.ts

@@ -1,282 +0,0 @@
-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>}
- */
-export const createRoleTemplate = (data: object, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      data: data,
-    };
-    const confirmationRequest = client.put("api/v1/roletemplates", requestData, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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
- * @returns {Promise<object>}
- */
-export 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
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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
- * @returns {Promise<object>}
- */
-export 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
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * 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>}
- */
-export const getRoleTemplateInformationById = (
-  id: string,
-  version: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.get(
-      `api/v1/roletemplates/${id}/${version}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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
- * @returns {Promise<object>}
- */
-export const getRoleTemplateList = (
-  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,
-    };
-    if (filter) requestData.filter = filter;
-    const confirmationRequest = client.post(`api/v1/roletemplates`, requestData, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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
- * @returns {Promise<object>}
- */
-export const publishTemplate = (
-  id: number,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: { comments?: string } = {};
-    if (comments) data.comments = comments;
-    const confirmationRequest = client.post(
-      `api/v1/roletemplates/publish/${id}`,
-      data,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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
- * @returns {Promise<object>}
- */
-export const setTemplateInformation = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      data: data,
-      id: id,
-    };
-    const confirmationRequest = client.post(
-      `api/v1/roletemplates/update`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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
- * @returns {Promise<object>}
- */
-export const setTemplateTags = (
-  id: string,
-  tags: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      tags: tags,
-      id: id,
-    };
-    const confirmationRequest = client.post(
-      `api/v1/roletemplates/updatetags/`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        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
- * @returns {Promise<object>}
- */
-export const watchRoleTemplate = (
-  id: string,
-  watch: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      id: id,
-      watch: watch,
-    };
-    const confirmationRequest = client.post(
-      `api/v1/roletemplates/watch`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};