@stackfactor/client-api 1.0.31 → 1.0.33

package/index.js

@@ -18,7 +18,6 @@ const skillAssessment = require("./lib/skillAssessments");
 const skillAssessmentTestingSession = require("./lib/skillAssessmentTestingSession");
 const skillTemplate = require("./lib/skillTemplate");
 const team = require("./lib/teams");
-const templates = require("./lib/templates");
 const tenant = require("./lib/tenants");
 const trainingPlanTemplate = require("./lib/trainingPlanTemplate");
 const trainingPlan = require("./lib/trainingPlans");
@@ -51,7 +50,6 @@ module.exports = {
   skillAssessmentTestingSession,
   skillTemplate,
   team,
-  templates,
   tenant,
   trainingPlanTemplate,
   trainingPlan,

package/lib/actionNotifications.js

@@ -1,240 +1,216 @@
-import { axios } from "./axiosClient";
+import axios from "./axiosClient";
 
-module.exports = {
-  axios: axios,
+/**
+ * Get all permissions
+ * @param {String} authToken The authentication token
+ */
+export const getAllUserNotifications = (authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = axios.get(`api/v1/actionnotifications`, {
+      headers: { authorization: authToken },
+    });
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
 
-  /**
-   * Get all permissions
-   * @param {String} authToken The authentication token
-   */
-  getAllUserNotifications: (authToken) => {
-    return new Promise(function (resolve, reject) {
-      const request = axios.get(`api/v1/actionnotifications`, {
-        headers: { authorization: authToken },
+/**
+ * Mark notifications as open or viewed
+ * @param {Array<String>} ids The id of the notifications to be marked
+ * @param {String} status The new status
+ * @param {String} authToken The authentication token
+ */
+export const markNotifications = (ids, status, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = axios.put(
+      `api/v1/actionnotifications/mark`,
+      {
+        ids: ids,
+        status: status,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
       });
-      request
-        .then((response) => {
-          resolve(response.data);
-        })
-        .catch((error) => {
-          reject(error);
-        });
-    });
-  },
+  });
+};
 
-  /**
-   * Mark notifications as open or viewed
-   * @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) => {
-    return new Promise(function (resolve, reject) {
-      const request = axios.put(
-        `api/v1/actionnotifications/mark`,
-        {
-          ids: ids,
-          status: status,
-        },
-        { headers: { authorization: authToken } }
-      );
-      request
-        .then((response) => {
-          resolve(response.data);
-        })
-        .catch((error) => {
-          reject(error);
-        });
-    });
-  },
+/**
+ * Process a notification
+ * @param {String} id The notification id
+ * @param {String} action The action to be executed
+ * @param {String} comment The comment to be saved in the notification
+ * @param {String} authToken The authentication token
+ */
+export const processNotification = (id, action, comment, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const request = axios.put(
+      `api/v1/actionnotifications/process`,
+      {
+        id: id,
+        action: action,
+        comment: comment,
+      },
+      { headers: { authorization: authToken } }
+    );
+    request
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
+};
 
-  /**
-   * Process a notification
-   * @param {String} id The notification id
-   * @param {String} action The action to be executed
-   * @param {String} comment The comment to be saved in the notification
-   * @param {String} authToken The authentication token
-   */
-  processNotification: (id, action, comment, authToken) => {
-    return new Promise(function (resolve, reject) {
-      const request = axios.put(
-        `api/v1/actionnotifications/process`,
-        {
-          id: id,
-          action: action,
-          comment: comment,
-        },
-        { headers: { authorization: authToken } }
-      );
-      request
-        .then((response) => {
-          resolve(response.data);
-        })
-        .catch((error) => {
-          reject(error);
-        });
+/**
+ * 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 },
     });
-  },
-
-  /**
-   * Get groups for current tenant
-   * @param {String} authToken The authentication token
-   */
-  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);
       });
-      request
-        .then((response) => {
-          resolve(response.data);
-        })
-        .catch((error) => {
-          reject(error);
-        });
-    });
-  },
+  });
+};
 
-  /**
-   * Get current user permissions
-   * @param {String} authToken The authentication token
-   */
-  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);
-        });
+/**
+ * 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);
+      });
+  });
+};
 
-  /**
-   * Build in permissions
-   */
-  permissions: {
-    ADMIN_PROMOTE_CONTENT: "5ea3d10bea252025c8ec351b",
-    ADMIN_AUTHOR_CONTENT: "5ea3d1152839450e16e72bba",
-    AUTHOR_CONTENT: "5fac210560e43de7c6b4a208",
-    MANAGE_BILLING: "5e1570cd03f676213bfdcd08",
-    MANAGE_CONTENT_PROVIDERS: "5f0fa12f16a720fde58ea820",
-    MANAGE_GROUPS: "5dd612fe59e518ac87b8cf8e",
-    MANAGE_OWN_PROFILE_INFORMATION_AUTO_APP: "5fac210e7e6539d37a897c94",
-    MANAGE_ORGANIZATION_INFORMATION: "5dd612d5338ea9a6ae6326da",
-    MANAGE_OWN_SKILL_SET_AUTO_APPROVE: "5fac21164351c6727a34cd4e",
-    MANAGE_SETTINGS: "5e1570e087d836dc77888a5f",
-    MANAGE_TEAM_INFORMATION_AUTO_APPROVE: "5fac211e6c8f874bd7137b98",
-    MANAGE_TEAMS: "5dd61314afc2455a89b1a37b",
-    MANAGE_USERS: "5dd612e40f0bc559c41a2b29",
-    PROMOTE_CONTENT: "5fac2126427ce31f8a92c0cb",
-    MANAGE_PLAN_TEMPLATES: "5dd61305a73c68b44c3f0827",
-  },
-  /**
-   * 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
-   */
-  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 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
-   */
-  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);
-        });
-    });
-  },
+/**
+ * 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
-   */
-  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);
-        });
-    });
-  },
+/*
+ * 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
-   */
-  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);
-        });
-    });
-  },
+/**
+ * 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);
+      });
+  });
 };

package/lib/address.js

@@ -1,29 +1,23 @@
-import { axios } from "./axiosClient";
+import axios from "./axiosClient";
 
-module.exports = {
-  axios: axios,
-
-  /**
-   * Validate Address
-   *
-   * @param {String} input - the address in raw format
-   * @param {String} authToken - Authorization token
-   *
-   */
-  autoComplete: (input, authToken) => {
-    return new Promise(function (resolve, reject) {
-      const getAddressesRequest = axios.post(
-        `api/v1/address/autocomplete/`,
-        { input: input },
-        { headers: { authorization: authToken } }
-      );
-      getAddressesRequest
-        .then((response) => {
-          resolve(response.data);
-        })
-        .catch((error) => {
-          reject(error);
-        });
-    });
-  },
+/**
+ * Validate Address
+ * @param {String} input - the address in raw format
+ * @param {String} authToken - Authorization token
+ */
+export const autoComplete = (input, authToken) => {
+  return new Promise(function (resolve, reject) {
+    const getAddressesRequest = axios.post(
+      `api/v1/address/autocomplete/`,
+      { input: input },
+      { headers: { authorization: authToken } }
+    );
+    getAddressesRequest
+      .then((response) => {
+        resolve(response.data);
+      })
+      .catch((error) => {
+        reject(error);
+      });
+  });
 };

package/lib/axiosClient.js

@@ -1,10 +1,10 @@
-const axios = require("axios");
-const https = require("https");
-const utils = require("./utils");
+import client from "axios";
+import https from "https";
+import utils from "./utils";
 
 const baseUrl = utils.getBaseUrl();
 
-let instance = axios.create({
+export default client.create({
   baseURL: baseUrl,
   httpsAgent: new https.Agent({
     rejectUnauthorized: false,
@@ -12,71 +12,65 @@ let instance = axios.create({
 });
 
 /**
- * Server response type
+ * Returns the error as a string
+ * @param {Object} error
  */
-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();
-        }
+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();
       } else {
-        return error.message ? error.message : "Unknown error";
+        return error.response.data.toString();
       }
+    } else {
+      return error.message ? error.message : "Unknown error";
     }
-  },
+  }
+};
 
-  /**
-   * 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;
-  },
+/**
+ * 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;
+};
 
-  /**
-   * Return the error information to include just the status and the message
-   * @param {Object} error
-   * @returns Object
-   */
-  getErrorInformation: (error) => {
-    return {
-      status: getErrorType(error),
-      message: errorToString(error),
-    };
-  },
+/**
+ * Return the error information to include just the status and the message
+ * @param {Object} error
+ * @returns Object
+ */
+export const getErrorInformation = (error) => {
+  return {
+    status: getErrorType(error),
+    message: errorToString(error),
+  };
+};
 
-  /**
-   * Returns true if an exception should be handled to the business and presentation layer
-   * @param {Boolean} returnAllExceptions - If set true all exceptions will be passed
-   * @param {Object} error - The error returned by the server
-   */
-  shouldReturnError: (returnAllExceptions, error) => {
-    if (getErrorType(error) === responseType.UNAUTHORIZED) {
-      return returnAllExceptions;
-    } else {
-      return true;
-    }
-  },
+/**
+ * Returns true if an exception should be handled to the business and presentation layer
+ * @param {Boolean} returnAllExceptions - If set true all exceptions will be passed
+ * @param {Object} error - The error returned by the server
+ */
+export const shouldReturnError = (returnAllExceptions, error) => {
+  if (getErrorType(error) === responseType.UNAUTHORIZED) {
+    return returnAllExceptions;
+  } else {
+    return true;
+  }
 };