@stackfactor/client-api 1.0.40 → 1.0.42

package/index.js

@@ -1,32 +1,32 @@
-import actionNotifications from "./lib/actionNotifications";
+import actionNotifications from "./lib/actionNotifications.js";
 import axios, {
   errorToString,
   getErrorType,
   shouldReturnError,
-} from "./lib/axiosClient";
-import address from "./lib/address";
-import config from "./lib/config";
-import constants from "./lib/constants";
-import contentGenerator from "./lib/integrations/contentGenerator";
-import dashboard from "./lib/dashboard";
-import departmentTraingPlans from "./lib/departmentTrainingPlans";
-import integration from "./lib/integration";
-import integrationConfiguration from "./lib/integrationConfiguration";
-import groups from "./lib/groups";
-import learningContent from "./lib/learningContent";
-import logger from "./lib/logger";
-import role from "./lib/role";
-import roleTemplate from "./lib/roleTemplate";
-import skill from "./lib/skill";
-import skillAssessment from "./lib/skillAssessments";
-import skillAssessmentTestingSession from "./lib/skillAssessmentTestingSession";
-import skillTemplate from "./lib/skillTemplate";
-import team from "./lib/teams";
-import tenant from "./lib/tenants";
-import trainingPlanTemplate from "./lib/trainingPlanTemplate";
-import trainingPlan from "./lib/trainingPlans";
-import userInformation from "./lib/userInformation";
-import users from "./lib/users";
+} from "./lib/axiosClient.js";
+import address from "./lib/address.js";
+import config from "./lib/config.js";
+import constants from "./lib/constants.js";
+import contentGenerator from "./lib/integrations/contentGenerator.js";
+import dashboard from "./lib/dashboard.js";
+import departmentTraingPlans from "./lib/departmentTrainingPlans.js";
+import integration from "./lib/integration.js";
+import integrationConfiguration from "./lib/integrationConfiguration.js";
+import groups from "./lib/groups.js";
+import learningContent from "./lib/learningContent.js";
+import logger from "./lib/logger.js";
+import role from "./lib/role.js";
+import roleTemplate from "./lib/roleTemplate.js";
+import skill from "./lib/skill.js";
+import skillAssessment from "./lib/skillAssessments.js";
+import skillAssessmentTestingSession from "./lib/skillAssessmentTestingSession.js";
+import skillTemplate from "./lib/skillTemplate.js";
+import team from "./lib/teams.js";
+import tenant from "./lib/tenants.js";
+import trainingPlanTemplate from "./lib/trainingPlanTemplate.js";
+import trainingPlan from "./lib/trainingPlans.js";
+import userInformation from "./lib/userInformation.js";
+import users from "./lib/users.js";
 
 export default {
   actionNotifications: actionNotifications,

package/lib/actionNotifications.js

@@ -1,4 +1,4 @@
-import axios from "./axiosClient";
+import { client } from "./axiosClient";
 
 /**
  * Get all permissions
@@ -6,7 +6,7 @@ import axios from "./axiosClient";
  */
 export const getAllUserNotifications = (authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.get(`api/v1/actionnotifications`, {
+    const request = client.get(`api/v1/actionnotifications`, {
       headers: { authorization: authToken },
     });
     request
@@ -27,7 +27,7 @@ export const getAllUserNotifications = (authToken) => {
  */
 export const markNotifications = (ids, status, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.put(
+    const request = client.put(
       `api/v1/actionnotifications/mark`,
       {
         ids: ids,
@@ -54,7 +54,7 @@ export const markNotifications = (ids, status, authToken) => {
  */
 export const processNotification = (id, action, comment, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.put(
+    const request = client.put(
       `api/v1/actionnotifications/process`,
       {
         id: id,
@@ -73,144 +73,8 @@ export const processNotification = (id, action, comment, authToken) => {
   });
 };
 
-/**
- * Get groups for current tenant
- * @param {String} authToken The authentication token
- */
-export const getGroups = (authToken) => {
-  return new Promise(function (resolve, reject) {
-    const request = axios.get(`api/v1/groups/`, {
-      headers: { authorization: authToken },
-    });
-    request
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get current user permissions
- * @param {String} authToken The authentication token
- */
-export const getUserPermissions = (authToken) => {
-  return new Promise(function (resolve, reject) {
-    const request = axios.get(`api/v1/groups/users/getuserpermissions`, {
-      headers: { authorization: authToken },
-    });
-    request
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Remove permissions from group
- * @param {String} groupId The group Id
- * @param {Array<String>} permissions The permissions to be removed from the group
- * @param {String} authToken The authentication token
- */
-export const removePermissionsFromGroup = (groupId, permissions, authToken) => {
-  return new Promise(function (resolve, reject) {
-    const request = axios.post(
-      `api/v1/groups/permissions/remove/`,
-      {
-        groupId: groupId,
-        permissions: permissions,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Remove users from group
- * @param {String} groupId The group Id
- * @param {Array<String>} users The users to be removed from the group
- * @param {String} authToken The authentication token
- */
-export const removeUsersFromGroup = (groupId, users, authToken) => {
-  return new Promise(function (resolve, reject) {
-    const request = axios.post(
-      `api/v1/groups/users/remove/`,
-      {
-        groupId: groupId,
-        users: users,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/*
- * Set group as defualt
- * @param {String} groupId The group Id
- * @param {String} authToken The authentication token
- */
-export const setDefault = (groupId, authToken) => {
-  return new Promise(function (resolve, reject) {
-    const request = axios.put(
-      `api/v1/groups/setDefault/`,
-      {
-        id: groupId,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * 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} authToken The authentication token
- */
-export const updateGroup = (groupId, name, description, authToken) => {
-  return new Promise(function (resolve, reject) {
-    const request = axios.patch(
-      `api/v1/groups/group/`,
-      {
-        id: groupId,
-        name: name,
-        description: description,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response) => {
-        resolve(response.data);
-      })
-      .catch((error) => {
-        reject(error);
-      });
-  });
+export default {
+  getAllUserNotifications,
+  markNotifications,
+  processNotification,
 };

package/lib/address.js

@@ -1,4 +1,4 @@
-import axios from "./axiosClient";
+import { client } from "./axiosClient";
 
 /**
  * Validate Address
@@ -7,7 +7,7 @@ import axios from "./axiosClient";
  */
 export const autoComplete = (input, authToken) => {
   return new Promise(function (resolve, reject) {
-    const getAddressesRequest = axios.post(
+    const getAddressesRequest = client.post(
       `api/v1/address/autocomplete/`,
       { input: input },
       { headers: { authorization: authToken } }
@@ -21,3 +21,7 @@ export const autoComplete = (input, authToken) => {
       });
   });
 };
+
+export default {
+  autoComplete: autoComplete,
+};

package/lib/axiosClient.js

@@ -1,10 +1,10 @@
-import client from "axios";
+import axios from "axios";
 import https from "https";
 import utils from "./utils";
 
 const baseUrl = utils.getBaseUrl();
 
-export default client.create({
+export const client = axios.create({
   baseURL: baseUrl,
   httpsAgent: new https.Agent({
     rejectUnauthorized: false,
@@ -74,3 +74,11 @@ export const shouldReturnError = (returnAllExceptions, error) => {
     return true;
   }
 };
+
+export default {
+  client: client,
+  errorToString: errorToString,
+  getErrorType: getErrorType,
+  getErrorInformation: getErrorInformation,
+  shouldReturnError: shouldReturnError,
+};

package/lib/config.js

@@ -1,4 +1,4 @@
-import axios from "./axiosClient";
+import { client } from "./axiosClient";
 
 /**
  * Get the specified configuration by Id. It returns a promise
@@ -7,7 +7,7 @@ import axios from "./axiosClient";
  */
 export const getConfigurationById = (id, authToken) => {
   return new Promise(function (resolve, reject) {
-    const getConfigInformationRequest = axios.get(
+    const getConfigInformationRequest = client.get(
       `api/v1/configurations/configuration/id/${id}`,
       { headers: { authorization: authToken } }
     );
@@ -28,7 +28,7 @@ export const getConfigurationById = (id, authToken) => {
  */
 export const getConfigurationByType = (type, authToken) => {
   return new Promise(function (resolve, reject) {
-    const getConfigInformationRequest = axios.get(
+    const getConfigInformationRequest = client.get(
       `api/v1/configurations/configuration/type/${type}`,
       { headers: { authorization: authToken } }
     );
@@ -50,7 +50,7 @@ export const getConfigurationByType = (type, authToken) => {
  */
 export const setConfigurationById = (id, data, authToken) => {
   return new Promise(function (resolve, reject) {
-    const getConfigInformationRequest = axios.post(
+    const getConfigInformationRequest = client.post(
       `api/v1/configurations/configuration/${id}`,
       { data: data },
       { headers: { authorization: authToken } }
@@ -64,3 +64,9 @@ export const setConfigurationById = (id, data, authToken) => {
       });
   });
 };
+
+export default {
+  getConfigurationById: getConfigurationById,
+  getConfigurationByType: getConfigurationByType,
+  setConfigurationById: setConfigurationById,
+};

package/lib/constants.js

@@ -93,7 +93,7 @@ const PERMISSIONS = {
   MANAGE_PLAN_TEMPLATES: "5dd61305a73c68b44c3f0827",
 };
 
-module.exports = {
+export default {
   DOCUMENT_VERSION: DOCUMENT_VERSION,
   PERMISSIONS: PERMISSIONS,
   RESPONSE_TYPE: RESPONSE_TYPE,

package/lib/dashboard.js

@@ -1,4 +1,4 @@
-import axios from "./axiosClient";
+import { client } from "./axiosClient";
 
 /**
  * Add a card to the dashboard
@@ -9,7 +9,7 @@ import axios from "./axiosClient";
  */
 export const addCardToDashboard = (id, position, data, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.put(
+    const request = client.put(
       `/api/v1/dashboard/card`,
       {
         id: id,
@@ -34,7 +34,7 @@ export const addCardToDashboard = (id, position, data, authToken) => {
  */
 export const getDashboardCardsList = (authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.get(`/api/v1/dashboard/card`, {
+    const request = client.get(`/api/v1/dashboard/card`, {
       headers: { authorization: authToken },
     });
     request
@@ -54,7 +54,7 @@ export const getDashboardCardsList = (authToken) => {
  */
 export const removeCardFromDashboard = (id, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.delete(`/api/v1/dashboard/card`, {
+    const request = client.delete(`/api/v1/dashboard/card`, {
       headers: { authorization: authToken },
       data: {
         id: id,
@@ -69,3 +69,9 @@ export const removeCardFromDashboard = (id, authToken) => {
       });
   });
 };
+
+export default {
+  addCardToDashboard: addCardToDashboard,
+  getDashboardCardsList: getDashboardCardsList,
+  removeCardFromDashboard: removeCardFromDashboard,
+};

package/lib/departmentTrainingPlans.js

@@ -1,4 +1,4 @@
-import axios from "./axiosClient";
+import { client } from "./axiosClient";
 
 /**
  * Create training plan template and set information
@@ -21,7 +21,7 @@ export const createDepartmentTrainingPlan = (
       skill: skill ? skill : "",
       activities: activities ? activities : [],
     };
-    let confirmationRequest = axios.put(
+    let confirmationRequest = client.put(
       "api/v1/departmentTrainingPlans",
       requestData,
       {
@@ -45,7 +45,7 @@ export const createDepartmentTrainingPlan = (
  */
 export const deleteDepartmentTrainingPlan = (id, token) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.delete(`api/v1/departmenttrainingplans/`, {
+    const request = client.delete(`api/v1/departmenttrainingplans/`, {
       headers: { authorization: token },
       data: {
         id: id,
@@ -72,7 +72,7 @@ export const getDepartmentTrainingPlanInformationById = (
   token
 ) => {
   return new Promise(function (resolve, reject) {
-    let confirmationRequest = axios.get(
+    let confirmationRequest = client.get(
       `api/v1/departmenttrainingplans/${id}/${version}`,
       {
         headers: { authorization: token },
@@ -99,7 +99,7 @@ export const getDepartmentTrainingPlanList = (filter, version, token) => {
       filter: filter ? filter : "",
       version: version,
     };
-    let confirmationRequest = axios.post(
+    let confirmationRequest = client.post(
       `api/v1/departmenttrainingplans`,
       requestData,
       {
@@ -123,7 +123,7 @@ export const getDepartmentTrainingPlanList = (filter, version, token) => {
  */
 export const publishDepartmentTrainingPlan = (id, token) => {
   return new Promise(function (resolve, reject) {
-    let confirmationRequest = axios.post(
+    let confirmationRequest = client.post(
       `api/v1/departmenttrainingplans/publish/${id}`,
       {},
       {
@@ -151,7 +151,7 @@ export const setDepartmentTrainingPlanInformation = (id, data, token) => {
     const requestData = {
       data: data,
     };
-    let confirmationRequest = axios.post(
+    let confirmationRequest = client.post(
       `api/v1/departmenttrainingplans/${id}`,
       requestData,
       {
@@ -167,3 +167,13 @@ export const setDepartmentTrainingPlanInformation = (id, data, token) => {
       });
   });
 };
+
+export default {
+  createDepartmentTrainingPlan: createDepartmentTrainingPlan,
+  deleteDepartmentTrainingPlan: deleteDepartmentTrainingPlan,
+  getDepartmentTrainingPlanInformationById:
+    getDepartmentTrainingPlanInformationById,
+  getDepartmentTrainingPlanList: getDepartmentTrainingPlanList,
+  publishDepartmentTrainingPlan: publishDepartmentTrainingPlan,
+  setDepartmentTrainingPlanInformation: setDepartmentTrainingPlanInformation,
+};

package/lib/groups.js

@@ -1,4 +1,4 @@
-import axios from "./axiosClient";
+import { client } from "./axiosClient";
 
 /**
  * Add permissions to group
@@ -8,7 +8,7 @@ import axios from "./axiosClient";
  */
 export const addPermissionsToGroup = (groupId, permissions, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.post(
+    const request = client.post(
       `api/v1/groups/permissions/add`,
       {
         groupId: groupId,
@@ -34,7 +34,7 @@ export const addPermissionsToGroup = (groupId, permissions, authToken) => {
  */
 export const addUsersToGroup = (groupId, users, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.post(
+    const request = client.post(
       `api/v1/groups/users/add`,
       {
         groupId: groupId,
@@ -60,7 +60,7 @@ export const addUsersToGroup = (groupId, users, authToken) => {
  */
 export const createGroup = (name, description, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.post(
+    const request = client.post(
       `api/v1/groups/group`,
       {
         name: name,
@@ -86,7 +86,7 @@ export const createGroup = (name, description, authToken) => {
  */
 export const deleteGroup = (groupId, defaultGroupId, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.delete(`api/v1/groups/delete`, {
+    const request = client.delete(`api/v1/groups/delete`, {
       headers: { authorization: authToken },
       data: {
         id: groupId,
@@ -109,7 +109,7 @@ export const deleteGroup = (groupId, defaultGroupId, authToken) => {
  */
 export const getAllPermissions = (authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.get(`api/v1/groups/permissions/getAllPermissions`, {
+    const request = client.get(`api/v1/groups/permissions/getAllPermissions`, {
       headers: { authorization: authToken },
     });
     request
@@ -129,7 +129,7 @@ export const getAllPermissions = (authToken) => {
  */
 export const getGroupById = (groupId, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.get(`api/v1/groups/group/${groupId}`, {
+    const request = client.get(`api/v1/groups/group/${groupId}`, {
       headers: { authorization: authToken },
     });
     request
@@ -148,7 +148,7 @@ export const getGroupById = (groupId, authToken) => {
  */
 export const getGroups = (authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.get(`api/v1/groups/`, {
+    const request = client.get(`api/v1/groups/`, {
       headers: { authorization: authToken },
     });
     request
@@ -167,7 +167,7 @@ export const getGroups = (authToken) => {
  */
 export const getUserPermissions = (authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.get(`api/v1/groups/users/getuserpermissions`, {
+    const request = client.get(`api/v1/groups/users/getuserpermissions`, {
       headers: { authorization: authToken },
     });
     request
@@ -188,7 +188,7 @@ export const getUserPermissions = (authToken) => {
  */
 export const removePermissionsFromGroup = (groupId, permissions, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.post(
+    const request = client.post(
       `api/v1/groups/permissions/remove/`,
       {
         groupId: groupId,
@@ -214,7 +214,7 @@ export const removePermissionsFromGroup = (groupId, permissions, authToken) => {
  */
 export const removeUsersFromGroup = (groupId, users, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.post(
+    const request = client.post(
       `api/v1/groups/users/remove/`,
       {
         groupId: groupId,
@@ -239,7 +239,7 @@ export const removeUsersFromGroup = (groupId, users, authToken) => {
  */
 export const setDefault = (groupId, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.put(
+    const request = client.put(
       `api/v1/groups/setDefault/`,
       {
         id: groupId,
@@ -265,7 +265,7 @@ export const setDefault = (groupId, authToken) => {
  */
 export const updateGroup = (groupId, name, description, authToken) => {
   return new Promise(function (resolve, reject) {
-    const request = axios.patch(
+    const request = client.patch(
       `api/v1/groups/group/`,
       {
         id: groupId,
@@ -283,3 +283,18 @@ export const updateGroup = (groupId, name, description, authToken) => {
       });
   });
 };
+
+export default {
+  addPermissionsToGroup: addPermissionsToGroup,
+  addUsersToGroup: addUsersToGroup,
+  createGroup: createGroup,
+  deleteGroup: deleteGroup,
+  getAllPermissions: getAllPermissions,
+  getGroupById: getGroupById,
+  getGroups: getGroups,
+  getUserPermissions: getUserPermissions,
+  removePermissionsFromGroup: removePermissionsFromGroup,
+  removeUsersFromGroup: removeUsersFromGroup,
+  setDefault: setDefault,
+  updateGroup: updateGroup,
+};