@stackfactor/client-api 1.0.1 → 1.0.3

package/index.js

@@ -22,26 +22,26 @@ const userInformation = require("./lib/userInformation");
 const users = require("./lib/users");
 
 module.exports = {
-  ...actionNotifications,
-  ...address,
-  ...config,
-  ...integration,
-  ...integrationsConfiguration,
-  ...departmentTraiingPlans,
-  ...groups,
-  ...role,
-  ...roleTemplate,
-  ...skill,
-  ...skillAssessments,
-  ...skillTemplate,
-  ...teams,
-  ...templateDocument,
-  ...templatePhase,
-  ...templateRelease,
-  ...templates,
-  ...tenants,
-  ...trainingPlanTemplate,
-  ...trainingPlans,
-  ...userInformation,
-  ...users,
+  actionNotifications,
+  address,
+  config,
+  integration,
+  integrationsConfiguration,
+  departmentTraiingPlans,
+  groups,
+  role,
+  roleTemplate,
+  skill,
+  skillAssessments,
+  skillTemplate,
+  teams,
+  templateDocument,
+  templatePhase,
+  templateRelease,
+  templates,
+  tenants,
+  trainingPlanTemplate,
+  trainingPlans,
+  userInformation,
+  users,
 };

package/lib/actionNotifications.js

@@ -1,16 +1,13 @@
-//
-// Notification sepcific requests
-//
-import axios from "./axios";
+const { axios } = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
    * Get all permissions
    * @param {String} authToken The authentication token
    */
-  getAllUserNotifications(authToken) {
+  getAllUserNotifications: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/actionnotifications`, {
         headers: { authorization: authToken },
@@ -27,11 +24,11 @@ export default {
 
   /**
    * Mark notifications as open or viewed
-   * @param {*} ids The id of the notifications to be marked
-   * @param {*} status The new status
-   * @param {*} authToken The authentication token
+   * @param {Array<String>} ids The id of the notifications to be marked
+   * @param {String} status The new status
+   * @param {String} authToken The authentication token
    */
-  markNotifications(ids, status, authToken) {
+  markNotifications: (ids, status, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.put(
         `api/v1/actionnotifications/mark`,
@@ -58,7 +55,7 @@ export default {
    * @param {String} comment The comment to be saved in the notification
    * @param {String} authToken The authentication token
    */
-  processNotification(id, action, comment, authToken) {
+  processNotification: (id, action, comment, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.put(
         `api/v1/actionnotifications/process`,
@@ -81,9 +78,9 @@ export default {
 
   /**
    * Get groups for current tenant
-   * @param {*} authToken The authentication token
+   * @param {String} authToken The authentication token
    */
-  getGroups(authToken) {
+  getGroups: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/`, {
         headers: { authorization: authToken },
@@ -100,9 +97,9 @@ export default {
 
   /**
    * Get current user permissions
-   * @param {*} authToken The authentication token
+   * @param {String} authToken The authentication token
    */
-  getUserPermissions(authToken) {
+  getUserPermissions: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/users/getuserpermissions`, {
         headers: { authorization: authToken },
@@ -143,7 +140,7 @@ export default {
    * @param {Array<String>} permissions The permissions to be removed from the group
    * @param {String} authToken The authentication token
    */
-  removePermissionsFromGroup(groupId, permissions, authToken) {
+  removePermissionsFromGroup: (groupId, permissions, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/permissions/remove/`,
@@ -169,7 +166,7 @@ export default {
    * @param {Array<String>} users The users to be removed from the group
    * @param {String} authToken The authentication token
    */
-  removeUsersFromGroup(groupId, users, authToken) {
+  removeUsersFromGroup: (groupId, users, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/users/remove/`,
@@ -194,7 +191,7 @@ export default {
    * @param {String} groupId The group Id
    * @param {String} authToken The authentication token
    */
-  setDefault(groupId, authToken) {
+  setDefault: (groupId, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.put(
         `api/v1/groups/setDefault/`,
@@ -220,7 +217,7 @@ export default {
    * @param {string} description The updated description of the group
    * @param {String} authToken The authentication token
    */
-  updateGroup(groupId, name, description, authToken) {
+  updateGroup: (groupId, name, description, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.patch(
         `api/v1/groups/group/`,

package/lib/address.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const { axios } = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -10,7 +10,7 @@ export default {
    * @param {String} authToken - Authorization token
    *
    */
-  autoComplete(input, authToken) {
+  autoComplete: (input, authToken) => {
     return new Promise(function (resolve, reject) {
       const getAddressesRequest = axios.post(
         `api/v1/address/autocomplete/`,

package/lib/axios.js

@@ -1,5 +1,5 @@
-import axios from "axios";
-import utils from "./utils";
+const axios = require("axios");
+const utils = require("./utils");
 
 const baseUrl = utils.getBaseUrl();
 
@@ -7,10 +7,7 @@ let instance = axios.create({
   baseURL: baseUrl,
 });
 
-/**
- * Server response type
- */
-export const responseType = {
+const responseType = {
   /**
    * The requested resource corresponds to any one of a set of representations, each with its own specific location.
    */
@@ -150,67 +147,74 @@ export const responseType = {
 };
 
 /**
- * Returns the error as a string
- * @param {Object} error
+ * Server response type
  */
-export const errorToString = (error) => {
-  if (error != null) {
-    if (error?.response?.data) {
-      let asString = "";
-      if (Array.isArray(error.response.data.errors)) {
-        error.response.data.errors.forEach((item, index) => {
-          asString += `${index > 0 ? ", " : ""} ${item.msg} param ${
-            item.param
-          } ${item.value ? `value ${item.value.toString()}` : ""}`;
-        });
-        return asString;
-      } else if (error.response.data.error) {
-        return error.response.data.error.toString();
-      } else if (error.response.statusText) {
-        return error.response.statusText.toString();
+module.exports = {
+  axios: instance,
+
+  /**
+   * Returns the error as a string
+   * @param {Object} error
+   */
+  errorToString: (error) => {
+    if (error != null) {
+      if (error?.response?.data) {
+        let asString = "";
+        if (Array.isArray(error.response.data.errors)) {
+          error.response.data.errors.forEach((item, index) => {
+            asString += `${index > 0 ? ", " : ""} ${item.msg} param ${
+              item.param
+            } ${item.value ? `value ${item.value.toString()}` : ""}`;
+          });
+          return asString;
+        } else if (error.response.data.error) {
+          return error.response.data.error.toString();
+        } else if (error.response.statusText) {
+          return error.response.statusText.toString();
+        } else {
+          return error.response.data.toString();
+        }
       } else {
-        return error.response.data.toString();
+        return error.message ? error.message : JSON.stringify(error.toString());
       }
-    } else {
-      return error.message ? error.message : error.toString();
     }
-  }
-};
+  },
 
-/**
- * Returns the code of the error as a number
- * @param {Object} error
- * @returns {Number} The error code
- */
-export const getErrorType = (error) => {
-  if (error?.response?.status) {
-    return error.response.status;
-  } else return responseType.SERVICE_UNAVAILABLE;
-};
+  /**
+   * Returns the code of the error as a number
+   * @param {Object} error
+   * @returns {Number} The error code
+   */
+  getErrorType: (error) => {
+    if (error?.response?.status) {
+      return error.response.status;
+    } else return responseType.SERVICE_UNAVAILABLE;
+  },
 
-/**
- * Return the error information to include just the status and the message
- * @param {*} error
- * @returns Object
- */
-export const getErrorInformation = (error) => {
-  return {
-    status: getErrorType(error),
-    message: errorToString(error),
-  };
-};
+  /**
+   * Return the error information to include just the status and the message
+   * @param {*} error
+   * @returns Object
+   */
+  getErrorInformation: (error) => {
+    return {
+      status: getErrorType(error),
+      message: errorToString(error),
+    };
+  },
 
-/**
- * Returns true if an exception should be handled to the business and presentation layer
- * @param {*} returnAllExceptions - If set true all exceptions will be passed
- * @param {*} error - The error returned by the server
- */
-export const shouldReturnError = (returnAllExceptions, error) => {
-  if (getErrorType(error) === responseType.UNAUTHORIZED) {
-    return returnAllExceptions;
-  } else {
-    return true;
-  }
-};
+  responseType: responseType,
 
-export default instance;
+  /**
+   * Returns true if an exception should be handled to the business and presentation layer
+   * @param {*} returnAllExceptions - If set true all exceptions will be passed
+   * @param {*} error - The error returned by the server
+   */
+  shouldReturnError: (returnAllExceptions, error) => {
+    if (getErrorType(error) === responseType.UNAUTHORIZED) {
+      return returnAllExceptions;
+    } else {
+      return true;
+    }
+  },
+};

package/lib/config.js

@@ -1,16 +1,14 @@
-import axios from "./axios";
+const { axios } = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
    * Get the specified configuration by Id. It returns a promise
-   *
    * @param {String} id - the id of the configuration element
    * @param {String} authToken - Authorization token
-   *
    */
-  getConfigurationById(id, authToken) {
+  getConfigurationById: (id, authToken) => {
     return new Promise(function (resolve, reject) {
       const getConfigInformationRequest = axios.get(
         `api/v1/configurations/configuration/id/${id}`,
@@ -28,12 +26,10 @@ export default {
 
   /**
    * Get the specified configuration by type. It returns a promise
-   *
    * @param {String} type - the id of the configuration element
    * @param {String} authToken - Authorization token
-   *
    */
-  getConfigurationByType(type, authToken) {
+  getConfigurationByType: (type, authToken) => {
     return new Promise(function (resolve, reject) {
       const getConfigInformationRequest = axios.get(
         `api/v1/configurations/configuration/type/${type}`,
@@ -50,15 +46,12 @@ export default {
   },
 
   /**
-   *
    * Set the specified configuration by Id. It returns a promise
-   *
    * @param {String} id - the id of the configuration element
    * @param {Object} data - the object containing the updated configuration element
    * @param {String} authToken - Authorization token
-   *
    */
-  setConfigurationById(id, data, authToken) {
+  setConfigurationById: (id, data, authToken) => {
     return new Promise(function (resolve, reject) {
       const getConfigInformationRequest = axios.post(
         `api/v1/configurations/configuration/${id}`,

package/lib/dashboard.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const { axios } = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -10,7 +10,7 @@ export default {
    * @param {Object} data - The card settings data
    * @param {String} authToken - Authorization token
    */
-  addCardToDashboard(id, position, data, authToken) {
+  addCardToDashboard: (id, position, data, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.put(
         `/api/v1/dashboard/card`,
@@ -35,7 +35,7 @@ export default {
    * Get the list of the cards from the dashboard
    * @param {String} authToken - Authorization token
    */
-  getDashboardCardsList(authToken) {
+  getDashboardCardsList: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`/api/v1/dashboard/card`, {
         headers: { authorization: authToken },
@@ -55,7 +55,7 @@ export default {
    * @param {String} id - the id of the configuration element
    * @param {String} authToken - Authorization token
    */
-  removeCardFromDashboard(id, authToken) {
+  removeCardFromDashboard: (id, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.delete(`/api/v1/dashboard/card`, {
         headers: { authorization: authToken },

package/lib/departmentTrainingPlans.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const { axios } = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -10,7 +10,7 @@ export default {
    * @param {Array<Object>} activities
    * @param {String} token Authorization token
    */
-  createDepartmentTrainingPlan(name, summary, skill, activities, token) {
+  createDepartmentTrainingPlan: (name, summary, skill, activities, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         name: name ? name : "",
@@ -40,7 +40,7 @@ export default {
    * @param {String} id The id of the template to be deleted
    * @param {String} token Authorization token
    */
-  deleteDepartmentTrainingPlan(id, token) {
+  deleteDepartmentTrainingPlan: (id, token) => {
     return new Promise(function (resolve, reject) {
       const request = axios.delete(`api/v1/departmenttrainingplans/`, {
         headers: { authorization: token },
@@ -60,10 +60,10 @@ export default {
 
   /**
    * Get department traing plan information
-   * @param {number} id The id of the plan
+   * @param {Number} id The id of the plan
    * @param {String} token Authorization token
    */
-  getDepartmentTrainingPlanInformationById(id, version, token) {
+  getDepartmentTrainingPlanInformationById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/departmenttrainingplans/${id}/${version}`,
@@ -86,7 +86,7 @@ export default {
    * @param {Object} filter The filter used to select the plan
    * @param {String} token Authorization token
    */
-  getDepartmentTrainingPlanList(filter, version, token) {
+  getDepartmentTrainingPlanList: (filter, version, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         filter: filter ? filter : "",
@@ -114,7 +114,7 @@ export default {
    * @param {number} id The id of the plan to be published
    * @param {String} token Authorization token
    */
-  publishDepartmentTrainingPlan(id, token) {
+  publishDepartmentTrainingPlan: (id, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.post(
         `api/v1/departmenttrainingplans/publish/${id}`,
@@ -139,7 +139,7 @@ export default {
    * @param {Object} data Data used to update the plan
    * @param {String} token Authorization token
    */
-  setDepartmentTrainingPlanInformation(id, data, token) {
+  setDepartmentTrainingPlanInformation: (id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,

package/lib/groups.js

@@ -1,9 +1,6 @@
-//
-// Group sepcific requests
-//
-import axios from "./axios";
+const { axios } = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -12,7 +9,7 @@ export default {
    * @param {Array<String>} permissions The permissions to be added
    * @param {String} authToken - Authentication token
    */
-  addPermissionsToGroup(groupId, permissions, authToken) {
+  addPermissionsToGroup: (groupId, permissions, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/permissions/add`,
@@ -38,7 +35,7 @@ export default {
    * @param {Array<String>} users The users to be added
    * @param {String} authToken - Authentication token
    */
-  addUsersToGroup(groupId, users, authToken) {
+  addUsersToGroup: (groupId, users, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/users/add`,
@@ -64,7 +61,7 @@ export default {
    * @param {String} description The description of the group
    * @param {String} authToken The authorization token
    */
-  createGroup(name, description, authToken) {
+  createGroup: (name, description, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/group`,
@@ -90,7 +87,7 @@ export default {
    * @param {String} defaultGroupId The default group all the users will be moved to
    * @param {String} authToken The authentication token
    */
-  deleteGroup(groupId, defaultGroupId, authToken) {
+  deleteGroup: (groupId, defaultGroupId, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.delete(`api/v1/groups/delete`, {
         headers: { authorization: authToken },
@@ -111,10 +108,9 @@ export default {
 
   /**
    * Get all permissions
-   *
    * @param {String} authToken The authentication token
    */
-  getAllPermissions(authToken) {
+  getAllPermissions: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/permissions/getAllPermissions`, {
         headers: { authorization: authToken },
@@ -131,10 +127,10 @@ export default {
 
   /**
    * Get group by Id
-   * @param {*} groupId The group Id
+   * @param {String} groupId The group Id
    * @param {String} authToken The authentication token
    */
-  getGroupById(groupId, authToken) {
+  getGroupById: (groupId, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/group/${groupId}`, {
         headers: { authorization: authToken },
@@ -151,9 +147,9 @@ export default {
 
   /**
    * Get groups for current tenant
-   * @param {*} authToken The authentication token
+   * @param {String} authToken The authentication token
    */
-  getGroups(authToken) {
+  getGroups: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/`, {
         headers: { authorization: authToken },
@@ -170,9 +166,9 @@ export default {
 
   /**
    * Get current user permissions
-   * @param {*} authToken The authentication token
+   * @param {String} authToken The authentication token
    */
-  getUserPermissions(authToken) {
+  getUserPermissions: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/users/getuserpermissions`, {
         headers: { authorization: authToken },
@@ -214,7 +210,7 @@ export default {
    * @param {Array<String>} permissions The permissions to be removed from the group
    * @param {String} authToken The authentication token
    */
-  removePermissionsFromGroup(groupId, permissions, authToken) {
+  removePermissionsFromGroup: (groupId, permissions, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/permissions/remove/`,
@@ -240,7 +236,7 @@ export default {
    * @param {Array<String>} users The users to be removed from the group
    * @param {String} authToken The authentication token
    */
-  removeUsersFromGroup(groupId, users, authToken) {
+  removeUsersFromGroup: (groupId, users, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/users/remove/`,
@@ -265,7 +261,7 @@ export default {
    * @param {String} groupId The group Id
    * @param {String} authToken The authentication token
    */
-  setDefault(groupId, authToken) {
+  setDefault: (groupId, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.put(
         `api/v1/groups/setDefault/`,
@@ -287,11 +283,11 @@ export default {
   /**
    * Update group
    * @param {String} groupId The group Id
-   * @param {string} name The updated name of the group
-   * @param {string} description The updated description of the group
+   * @param {String} name The updated name of the group
+   * @param {String} description The updated description of the group
    * @param {String} authToken The authentication token
    */
-  updateGroup(groupId, name, description, authToken) {
+  updateGroup: (groupId, name, description, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.patch(
         `api/v1/groups/group/`,