@stackfactor/client-api 1.1.15-8.1 → 1.1.15

package/lib/teams.js

@@ -0,0 +1,294 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Add users to team
+ * @param {String} teamId The team Id
+ * @param {Array<String>} users The users to be added
+ * @param {String} authToken - Authentication token
+ */
+export const addUsersToTeam = (teamId, users, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.post(
+      `api/v1/teams/users/add`,
+      {
+        teamId: teamId,
+        users: users,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Create team
+ * @param {String} name The name of the team
+ * @param {String} managerId The id of the manager
+ * @param {String} description The description of the team
+ * @param {String} authToken The authorization token
+ */
+export const createTeam = (name, managerId, description, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.post(
+      `api/v1/teams/team`,
+      {
+        name: name,
+        managerId: managerId,
+        description: description,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Delete team
+ * @param {String} teamId The team to be deleted
+ * @param {String} defaultTeamId The default team all the users will be moved to
+ * @param {String} authToken The authentication token
+ */
+export const deleteTeam = (teamId, defaultTeamId, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.delete(`api/v1/teams/delete`, {
+      headers: { authorization: authToken },
+      data: {
+        id: teamId,
+        defaultTeamId: defaultTeamId,
+      },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get team by Id
+ * @param {String} teamId The team Id
+ * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
+ * @param {String} authToken The authentication token
+ */
+export const getTeamById = (
+  teamId,
+  includeUserSummaryInformation,
+  authToken
+) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.post(
+      `api/v1/teams/team/${teamId}`,
+      {
+        includeUserSummaryInformation: includeUserSummaryInformation,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get team roles
+ * @param {String} teamId The team Id
+ * @param {String} authToken The authentication token
+ */
+export const getTeamByIdRoles = (teamId, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.get(`api/v1/teams/getroles/${teamId}`, {
+      headers: { authorization: authToken },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get teams for current tenant
+ * @param {String} userId
+ * @param {String} authToken The authentication token
+ */
+export const getTeams = (authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.get(`api/v1/teams/`, {
+      headers: { authorization: authToken },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get the team for the selected user
+ * @param {String} userId
+ * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
+ * @param {String} authToken The authentication token
+ */
+export const getTeamByUserId = (
+  userId,
+  includeUserSummaryInformation,
+  authToken
+) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.post(
+      `/api/v1/teams/getuserteam/${userId ? userId : ""}`,
+      {
+        includeUserSummaryInformation: includeUserSummaryInformation,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get top team in the organization, usually the executive team
+ * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
+ * @param {String} authToken The authentication token
+ */
+export const getTopTeam = (includeUserSummaryInformation, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.post(
+      `api/v1/teams/gettopteam`,
+      {
+        includeUserSummaryInformation: includeUserSummaryInformation,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Remove users from team
+ * @param {String} teamId The team Id
+ * @param {Array<String>} users The users to be removed from the team
+ * @param {String} authToken The authentication token
+ */
+export const removeUsersFromTeam = (teamId, users, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.post(
+      `api/v1/teams/users/remove/`,
+      {
+        teamId: teamId,
+        users: users,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/*
+ * Set team as defualt
+ * @param {String} teamId The team Id
+ * @param {String} authToken The authentication token
+ */
+export const setDefault = (teamId, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.put(
+      `api/v1/teams/setDefault/`,
+      {
+        id: teamId,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Update team
+ * @param {String} teamId The team Id
+ * @param {String} data The updated name of the team
+ * @param {String} authToken The authentication token
+ */
+export const updateTeam = (teamId, data, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.patch(
+      `api/v1/teams/team/`,
+      {
+        id: teamId,
+        data: data,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const team = {
+  addUsersToTeam,
+  createTeam,
+  deleteTeam,
+  getTeamById,
+  getTeamByIdRoles,
+  getTeams,
+  getTeamByUserId,
+  getTopTeam,
+  removeUsersFromTeam,
+  setDefault,
+  updateTeam,
+};
+
+export default team;

package/lib/tenants.js

@@ -0,0 +1,57 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Get tenant information
+ * @param {String} category Tenant information category
+ * @param {String} token Authorization token
+ */
+export const getTenantInformation = (categories, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      categories: categories,
+    };
+    let request = client.post("api/v1/tenants/tenant/get", requestData, {
+      headers: { authorization: token },
+    });
+    request
+      .then((response) => {
+        resolve(response.data ? response.data : null);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Set tenant profile information
+ * @param {String} category Tenant information category
+ * @param {String} data New or updated tenant data information
+ * @param {Object} token Authorization token
+ */
+export const setTenantInformation = (category, data, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      category: category,
+      data: data,
+    };
+    let confirmationRequest = client.post(
+      "api/v1/tenants/tenant/set",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const tenant = { getTenantInformation, setTenantInformation };
+
+export default tenant;

package/lib/trainingPlans.js

@@ -0,0 +1,279 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Create training plan and set information
+ * @param {Object} data
+ * @param {Number} type
+ * @param {Boolean} saveAsDraft Save as draft flag
+ * @param {String} token Authorization token
+ */
+export const createTrainingPlan = (data, type, saveAsDraft, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: {
+        ...data,
+      },
+      saveAsDraft,
+      type,
+    };
+    let confirmationRequest = client.put("api/v1/trainingplans", requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Delete training plan
+ * @param {String} id The id of the training plan to be deleted
+ * @param {String} comments The comments for approver
+ * @param {String} token Authorization token
+ */
+export const deleteTrainingPlan = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
+      id: id,
+    };
+    if (comments) data.comments = comments;
+    const request = client.delete(`api/v1/trainingplans/`, {
+      headers: { authorization: token },
+      data: data,
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Discard the training plan draft changes
+ * @param {String} id The id of the training plan to be deleted
+ * @param {String} token Authorization token
+ */
+export const discardTrainingPlanChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
+    const request = client.get(`api/v1/trainingplans/discard/${id}`, {
+      headers: { authorization: token },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Create a new baselie
+ * @param {String} id The Id of the plan for which a new baseline is to be generated
+ * @param {Object} data The data
+ * @param {Boolean} returnMinimized If set to true just high level plan baseline information will be returned
+ * @param {Boolean} saveBaseline If set to true it will save the baseline
+ * @param {String} token Authorization token
+ */
+export const generateNewBaseline = (
+  id,
+  data,
+  returnMinimized,
+  saveBaseline,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      returnMinimized: returnMinimized,
+      saveBaseline: saveBaseline,
+    };
+    if (id) requestData.id = id;
+    let confirmationRequest = client.post(
+      "api/v1/trainingplans/generatenewbaseline",
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get traing plan information
+ * @param {String} id The id of the training plan
+ * @param {String} token Authorization token
+ */
+export const getTrainingPlanById = (id, version, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.get(
+      `api/v1/trainingplans/${id}/${version}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get training plans list
+ * @param {Array<ObjectId>} users The list of users for which the plans should be loaded
+ * @param {Array<Number>} types The types of plans to be loaded
+ * @param {String} version The version of the document to be retrieved
+ * @param {Array<String>} fields The fields to be selected
+ * @param {Boolean} includeDeleted If set true it will return deleted plans too
+ * @param {Boolean} returnDefaultIfVersionNotAvailable If set to true it will load the draft information if the plan was never published
+ * @param {String} token Authorization token
+ */
+export const getListOfTrainingPlans = (
+  users,
+  types,
+  version,
+  fields,
+  includeDeleted,
+  includeDetailedInformation,
+  returnDefaultIfVersionNotAvailable,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      version: version,
+      includeDeleted: includeDeleted,
+      includeDetailedInformation: includeDetailedInformation,
+      returnDefaultIfVersionNotAvailable: returnDefaultIfVersionNotAvailable,
+    };
+    if (fields) requestData.fields = fields;
+    if (types) requestData.types = types;
+    if (users) requestData.users = users;
+    let confirmationRequest = client.post(`api/v1/trainingplans`, requestData, {
+      headers: { authorization: token },
+    });
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Publish training plan
+ * @param {String} 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 publishTrainingPlan = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    let data = {};
+    if (comments) data.comments = comments;
+    let confirmationRequest = client.post(
+      `api/v1/trainingplans/publish/${id}`,
+      data,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Update training plan
+ * @param {String} id The ID of the training plan
+ * @param {Object} data The updated data
+ * @param {String} token Authorization token
+ */
+export const updateTrainingPlan = (planId, data, saveAsDraft, token) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
+      data: data,
+      id: planId,
+      saveAsDraft,
+    };
+    let confirmationRequest = client.put(
+      `api/v1/trainingplans/update/${planId}`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Update a task
+ * @param {String} planId
+ * @param {Object} data Ordered array of objects containing the activity Id and the new status
+ * @param {Function} successCallBack
+ * @param {Function} failCallBack
+ * @returns {Object} An object containing the task information
+ */
+export const updateActivities = (planId, data, token) => {
+  return new Promise(function (resolve, reject) {
+    let confirmationRequest = client.post(
+      `api/v1/trainingplans/${planId}/activities`,
+      data,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then(() => {
+        resolve();
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const trainingPlan = {
+  createTrainingPlan,
+  deleteTrainingPlan,
+  discardTrainingPlanChanges,
+  generateNewBaseline,
+  getTrainingPlanById,
+  getListOfTrainingPlans,
+  publishTrainingPlan,
+  updateTrainingPlan,
+  updateActivities,
+};
+
+export default trainingPlan;