@stackfactor/client-api 1.0.0

package/lib/trainingPlanTemplate.js

@@ -0,0 +1,215 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Create training plan template and set information
+   * @param {Object} data
+   * @param {String} token Authorization token
+   */
+  createTrainingPlanTemplate(data, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.put(
+        "api/v1/trainingplantemplates",
+        { data: data },
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete training plan template
+   * @param {String} id The id of the template to be deleted
+   * @param {String} comment The comment for approver
+   * @param {String} token Authorization token
+   */
+  deleteTrainingPlanTemplate(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {
+        id: id,
+      };
+      if (comment) data.comment = comment;
+      const request = axios.delete(`api/v1/trainingplantemplates/`, {
+        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
+   */
+  discardTrainingPlanChanges(id, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {};
+      const request = axios.get(`api/v1/trainingplantemplates/discard/${id}`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get traing plan template information
+   * @param {String} id The id of the template
+   * @param {String} token Authorization token
+   */
+  getTrainingPlanTemplateInformationById(id, version, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/trainingplantemplates/${id}/${version}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get training plan template list
+   * @param {Array<String>} list The filter used to select the skill
+   * @param {String} version The version to be retrieved
+   * @param {String} token Authorization token
+   */
+  getTrainingPlanTemplatesList(list, version, includeDeleted, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        version: version,
+        includeDeleted: includeDeleted,
+      };
+      if (list) requestData.list = list;
+      let confirmationRequest = axios.post(
+        `api/v1/trainingplantemplates`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Publish training pplan template
+   * @param {String} id The id of the template to be published
+   * @param {String} comment The comment to be include with the request
+   * @param {String} token Authorization token
+   */
+  publishTrainingPlanTemplate(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      let data = {};
+      if (comment) data.comment = comment;
+      let confirmationRequest = axios.post(
+        `api/v1/trainingplantemplates/publish/${id}`,
+        data,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Set training plan 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
+   */
+  setTrainingPlanTemplateInformation(id, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+        id: id,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/trainingplantemplates/update/`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update training plan template tags
+   * @param {String} id The id of the template to be updated
+   * @param {Object} tags The updated tags
+   * @param {String} token Authorization token
+   */
+  setTrainingPlanTemplateTags(id, tags, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        tags: tags,
+        id: id,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/trainingplantemplates/updatetags/`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/trainingPlans.js

@@ -0,0 +1,267 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Create training plan and set information
+   * @param {Object} data
+   * @param {Number} type
+   * @param {Boolean} saveAsDraft Save as draft flag
+   * @param {String} token Authorization token
+   */
+  createTrainingPlan(data, type, saveAsDraft, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: {
+          ...data,
+        },
+        saveAsDraft,
+        type,
+      };
+      let confirmationRequest = axios.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} comment The comment for approver
+   * @param {String} token Authorization token
+   */
+  deleteTrainingPlan(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {
+        id: id,
+      };
+      if (comment) data.comment = comment;
+      const request = axios.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
+   */
+  discardTrainingPlanChanges(id, token) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.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
+   */
+  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 = axios.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
+   */
+  getTrainingPlanById(id, version, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.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
+   */
+  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 = axios.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} comment The comment to be include with the request
+   * @param {String} token Authorization token
+   */
+  publishTrainingPlan(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      let data = {};
+      if (comment) data.comment = comment;
+      let confirmationRequest = axios.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
+   */
+  updateTrainingPlan(planId, data, saveAsDraft, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+        id: planId,
+        saveAsDraft,
+      };
+      let confirmationRequest = axios.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
+   */
+  updateActivities(planId, data, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.post(
+        `api/v1/trainingplans/${planId}/activities`,
+        data,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then(() => {
+          resolve();
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/userInformation.js

@@ -0,0 +1,89 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Add an entry to an array type business property such as experience, education or certifications
+   * @param {String} userId
+   * @param {String} property
+   * @param {Object} data
+   * @param {String} token Authorization token
+   */
+  addEntryToArrayBusinessProperty(userId, property, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/user/arrayproperty/${userId}/${property}`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update an entry from an array type business property such as experience, education or certifications
+   * @param {String} userId
+   * @param {String} property
+   * @param {String} id
+   * @param {String} token Authorization token
+   */
+  removeEntryFromArrayBusinessProperty(userId, property, id, token) {
+    return new Promise(function (resolve, reject) {
+      const confirmationRequest = axios.delete(
+        `api/v1/user/arrayproperty/${userId}/${property}/${id}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update an entry from an array type business property such as experience, education or certifications
+   * @param {String} userId
+   * @param {String} property
+   * @param {String} id
+   * @param {Object} data
+   * @param {String} token Authorization token
+   */
+  updateEntryfromArrayBusinessProperty(userId, property, id, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+      };
+      let confirmationRequest = axios.patch(
+        `api/v1/user/arrayproperty/${userId}/${property}/${id}`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};