@stackfactor/client-api 1.1.11 → 1.1.12-9.2

package/lib/trainingPlansProficiencyLevels.ts

@@ -0,0 +1,132 @@
+import { client } from "./axiosClient.js";
+
+/**
+ * Get training plan proficiency level
+ * @param {String} proficiencyLevelId
+ * @param {String} token
+ * @returns {Promise<Object>} An object containing the proficiency level information
+ */
+const getTrainingPlanProficiencyLevel = (
+  proficiencyLevelId: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    let confirmationRequest = client.get(
+      `api/v1/trainingplans/proficiencylevels/${proficiencyLevelId}`,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Get training plan proficiency level list
+ * @param {Boolean} includeDeleted If set true it will return deleted plans too
+ * @param {Boolean} includeDetailedInformation If set to true it will return detailed information for each plan
+ * @param {Boolean} includeArchived If set to true it will return all the closed items too
+ * @param {String} token Authorization token
+ * @returns {Promise<Object>}
+ */
+const getTrainingPlanProficiencyLevelList = (
+  includeDeleted: boolean,
+  includeDetailedInformation: boolean,
+  includeArchived: boolean,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
+    const requestData = {
+      includeArchived: includeArchived,
+      includeDeleted: includeDeleted,
+      includeDetailedInformation: includeDetailedInformation,
+    };
+    let confirmationRequest = client.post(
+      `api/v1/trainingplans/proficiencylevels`,
+      requestData,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Reorder training plan proficiency levels
+ * @param {Array<Object>} order
+ * @param {String} token
+ * @returns {Promise<void>}
+ */
+const reorderTrainingPlansProficiencyLevels = (
+  order: object[],
+  token: string
+): Promise<void> => {
+  return new Promise((resolve, reject) => {
+    let confirmationRequest = client.post(
+      `api/v1/trainingplans/proficiencylevels/reorder`,
+      { order: order },
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then(() => {
+        resolve();
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+/**
+ * Update a training plan proficiency level
+ * @param {String} proficiencyLevelId
+ * @param {Object} data Ordered array of objects containing the activity Id and the new status
+ * @param {String} token
+ * @returns {Promise<void>}
+ */
+const updateTrainingPlanProficiencyLevel = (
+  proficiencyLevelId: string,
+  data: object,
+  token: string
+): Promise<void> => {
+  return new Promise((resolve, reject) => {
+    let confirmationRequest = client.post(
+      `api/v1/trainingplans/proficiencylevel/${proficiencyLevelId}`,
+      data,
+      {
+        headers: { authorization: token },
+      }
+    );
+    confirmationRequest
+      .then(() => {
+        resolve();
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
+
+const trainingPlanProficiencyLevel = {
+  getTrainingPlanProficiencyLevel,
+  getTrainingPlanProficiencyLevelList,
+  reorderTrainingPlansProficiencyLevels,
+  updateTrainingPlanProficiencyLevel,
+};
+
+export default trainingPlanProficiencyLevel;

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

@@ -6,14 +6,15 @@ import { client } from "./axiosClient.js";
  * @param {String} property
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const addEntryToArrayBusinessProperty = (
-  userId,
-  property,
-  data,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+const addEntryToArrayBusinessProperty = (
+  userId: string,
+  property: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
@@ -35,19 +36,20 @@ export const addEntryToArrayBusinessProperty = (
 };
 
 /**
- * Update an entry from an array type business property such as experience, education or certifications
+ * Remove 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
+ * @returns {Promise<Object>}
  */
-export const removeEntryFromArrayBusinessProperty = (
-  userId,
-  property,
-  id,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+const removeEntryFromArrayBusinessProperty = (
+  userId: string,
+  property: string,
+  id: string,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const confirmationRequest = client.delete(
       `api/v1/user/arrayproperty/${userId}/${property}/${id}`,
       {
@@ -71,15 +73,16 @@ export const removeEntryFromArrayBusinessProperty = (
  * @param {String} id
  * @param {Object} data
  * @param {String} token Authorization token
+ * @returns {Promise<Object>}
  */
-export const updateEntryfromArrayBusinessProperty = (
-  userId,
-  property,
-  id,
-  data,
-  token
-) => {
-  return new Promise(function (resolve, reject) {
+const updateEntryfromArrayBusinessProperty = (
+  userId: string,
+  property: string,
+  id: string,
+  data: object,
+  token: string
+): Promise<object> => {
+  return new Promise((resolve, reject) => {
     const requestData = {
       data: data,
     };
@@ -100,10 +103,8 @@ export const updateEntryfromArrayBusinessProperty = (
   });
 };
 
-export const userInformation = {
+export default {
   addEntryToArrayBusinessProperty,
   removeEntryFromArrayBusinessProperty,
   updateEntryfromArrayBusinessProperty,
 };
-
-export default userInformation;