@stackfactor/client-api 1.1.12-9.2 → 1.1.12

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

@@ -1,25 +1,5 @@
 import { client } from "./axiosClient.js";
 
-/**
- * Archive the training plan
- * @param {String} id The id of the training plan to be deleted
- * @param {String} token Authorization token
- */
-const archiveTrainingPlan = (id: string, token: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.get(`api/v1/trainingplans/archive/${id}`, {
-      headers: { authorization: token },
-    });
-    request
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
 /**
  * Create training plan and set information
  * @param {Object} data
@@ -27,19 +7,14 @@ const archiveTrainingPlan = (id: string, token: string): Promise<object> => {
  * @param {Boolean} saveAsDraft Save as draft flag
  * @param {String} token Authorization token
  */
-const createTrainingPlan = (
-  data: object,
-  type: number,
-  saveAsDraft: boolean,
-  token: string
-): Promise<void> => {
-  return new Promise((resolve, reject) => {
-    const requestData: { version: string; includeDeleted: boolean; includeDetailedInformation: boolean; returnDefaultIfVersionNotAvailable: boolean; fields?: string[]; types?: number[]; users?: string[] } = {
-      version: "1.0",
-      includeDeleted: false,
-      includeDetailedInformation: true,
-      returnDefaultIfVersionNotAvailable: true,
-      types: [type],
+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 },
@@ -60,13 +35,9 @@ const createTrainingPlan = (
  * @param {String} comments The comments for approver
  * @param {String} token Authorization token
  */
-const deleteTrainingPlan = (
-  id: string,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const data: { id: string; comments?: string } = {
+export const deleteTrainingPlan = (id, comments, token) => {
+  return new Promise(function (resolve, reject) {
+    const data = {
       id: id,
     };
     if (comments) data.comments = comments;
@@ -89,11 +60,8 @@ const deleteTrainingPlan = (
  * @param {String} id The id of the training plan to be deleted
  * @param {String} token Authorization token
  */
-const discardTrainingPlanChanges = (
-  id: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const discardTrainingPlanChanges = (id, token) => {
+  return new Promise(function (resolve, reject) {
     const request = client.get(`api/v1/trainingplans/discard/${id}`, {
       headers: { authorization: token },
     });
@@ -108,22 +76,22 @@ const discardTrainingPlanChanges = (
 };
 
 /**
- * Create a new baseline
+ * 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
  */
-const generateNewBaseline = (
-  id: string,
-  data: object,
-  returnMinimized: boolean,
-  saveBaseline: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: { data: object; returnMinimized: boolean; saveBaseline: boolean; id?: string } = {
+export const generateNewBaseline = (
+  id,
+  data,
+  returnMinimized,
+  saveBaseline,
+  token
+) => {
+  return new Promise(function (resolve, reject) {
+    const requestData = {
       data: data,
       returnMinimized: returnMinimized,
       saveBaseline: saveBaseline,
@@ -147,17 +115,12 @@ const generateNewBaseline = (
 };
 
 /**
- * Get training plan information
+ * Get traing plan information
  * @param {String} id The id of the training plan
- * @param {String} version The version of the training plan
  * @param {String} token Authorization token
  */
-const getTrainingPlanById = (
-  id: string,
-  version: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const getTrainingPlanById = (id, version, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.get(
       `api/v1/trainingplans/${id}/${version}`,
       {
@@ -174,50 +137,28 @@ const getTrainingPlanById = (
   });
 };
 
-/**
- * Get tasks summary for a recipient across all of the training plans
- * @param {String} token Authorization token
- */
-const getAllTrainingPlansTasksSummary = (
-  token: string | null = null
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let confirmationRequest = client.get(`api/v1/trainingplans/taskssummary`, {
-      headers: token ? { authorization: token } : {},
-    });
-    confirmationRequest
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
 /**
  * Get training plans list
- * @param {Array<string>} users The list of users for which the plans should be loaded
- * @param {Array<number>} types The types of plans to be loaded
+ * @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 {Array<String>} fields The fields to be selected
  * @param {Boolean} includeDeleted If set true it will return deleted plans too
- * @param {Boolean} includeDetailedInformation If set true it will return detailed information
  * @param {Boolean} returnDefaultIfVersionNotAvailable If set to true it will load the draft information if the plan was never published
  * @param {String} token Authorization token
  */
-const getListOfTrainingPlans = (
-  users: string[],
-  types: number[],
-  version: string,
-  fields: string[],
-  includeDeleted: boolean,
-  includeDetailedInformation: boolean,
-  returnDefaultIfVersionNotAvailable: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData: { version: string; includeDeleted: boolean; includeDetailedInformation: boolean; returnDefaultIfVersionNotAvailable: boolean; fields?: string[]; types?: number[]; users?: string[] } = {
+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,
@@ -245,13 +186,9 @@ const getListOfTrainingPlans = (
  * @param {String} comments The comments to be include with the request
  * @param {String} token Authorization token
  */
-const publishTrainingPlan = (
-  id: string,
-  comments: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data: { comments?: string } = {};
+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}`,
@@ -272,18 +209,12 @@ const publishTrainingPlan = (
 
 /**
  * Update training plan
- * @param {String} planId The ID of the training plan
+ * @param {String} id The ID of the training plan
  * @param {Object} data The updated data
- * @param {Boolean} saveAsDraft Save as draft flag
  * @param {String} token Authorization token
  */
-const updateTrainingPlan = (
-  planId: string,
-  data: object,
-  saveAsDraft: boolean,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const updateTrainingPlan = (planId, data, saveAsDraft, token) => {
+  return new Promise(function (resolve, reject) {
     const requestData = {
       data: data,
       id: planId,
@@ -306,49 +237,16 @@ const updateTrainingPlan = (
   });
 };
 
-/**
- * Update training plan task status
- * @param {String} id The ID of the training plan
- * @param {Number} status
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const updateTrainingPlanTaskStatus = (
-  id: string,
-  status: number,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    let data = {
-      id: id,
-      status: status,
-    };
-    let confirmationRequest = client.post(`api/v1/trainingplans/task`, data, {
-      headers: { authorization: token },
-    });
-    confirmationRequest
-      .then(() => {
-        resolve({});
-      })
-      .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 {String} token Authorization token
- * @returns {Promise<Object>}
+ * @param {Function} successCallBack
+ * @param {Function} failCallBack
+ * @returns {Object} An object containing the task information
  */
-const updateActivities = (
-  planId: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
+export const updateActivities = (planId, data, token) => {
+  return new Promise(function (resolve, reject) {
     let confirmationRequest = client.post(
       `api/v1/trainingplans/${planId}/activities`,
       data,
@@ -358,7 +256,7 @@ const updateActivities = (
     );
     confirmationRequest
       .then(() => {
-        resolve({});
+        resolve();
       })
       .catch((error) => {
         reject(error);
@@ -366,17 +264,16 @@ const updateActivities = (
   });
 };
 
-export default {
-  archiveTrainingPlan,
+const trainingPlan = {
   createTrainingPlan,
   deleteTrainingPlan,
   discardTrainingPlanChanges,
   generateNewBaseline,
-  getAllTrainingPlansTasksSummary,
   getTrainingPlanById,
   getListOfTrainingPlans,
   publishTrainingPlan,
   updateTrainingPlan,
-  updateTrainingPlanTaskStatus,
   updateActivities,
 };
+
+export default trainingPlan;

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

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