@stackfactor/client-api 1.0.0 → 1.0.2

package/index.js

@@ -1,22 +1,47 @@
-export * from "./lib/actionNotifications";
-export * from "./lib/address";
-export * from "./lib/config";
-export * from "./lib/integration";
-export * from "./lib/integrationsConfiguration";
-export * from "./lib/departmentTraiingPlans";
-export * from "./lib/groups";
-export * from "./lib/role";
-export * from "./lib/roleTemplate";
-export * from "./lib/skill";
-export * from "./lib/skillAssessments";
-export * from "./lib/skillTemplate";
-export * from "./lib/teams";
-export * from "./lib/templateDocument";
-export * from "./lib/templatePhase";
-export * from "./lib/templateRelease";
-export * from "./lib/templates";
-export * from "./lib/tenants";
-export * from "./lib/trainingPlanTemplate";
-export * from "./lib/trainingPlans";
-export * from "./lib/userInformation";
-export * from "./lib/users";
+const actionNotifications = require("./lib/actionNotifications");
+const address = require("./lib/address");
+const config = require("./lib/config");
+const integration = require("./lib/integration");
+const integrationsConfiguration = require("./lib/integrationsConfiguration");
+const departmentTraiingPlans = require("./lib/departmentTraiingPlans");
+const groups = require("./lib/groups");
+const role = require("./lib/role");
+const roleTemplate = require("./lib/roleTemplate");
+const skill = require("./lib/skill");
+const skillAssessments = require("./lib/skillAssessments");
+const skillTemplate = require("./lib/skillTemplate");
+const teams = require("./lib/teams");
+const templateDocument = require("./lib/templateDocument");
+const templatePhase = require("./lib/templatePhase");
+const templateRelease = require("./lib/templateRelease");
+const templates = require("./lib/templates");
+const tenants = require("./lib/tenants");
+const trainingPlanTemplate = require("./lib/trainingPlanTemplate");
+const trainingPlans = require("./lib/trainingPlans");
+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,
+};

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();
 
@@ -10,207 +10,207 @@ let instance = axios.create({
 /**
  * Server response type
  */
-export const responseType = {
-  /**
-   * The requested resource corresponds to any one of a set of representations, each with its own specific location.
-   */
-  MULTIPLE_CHOICES: 300,
-  /**
-   * The resource has moved permanently. Please refer to the documentation.
-   */
-  MOVED_PERMANENTLY: 301,
-  /**
-   * The resource has moved temporarily. Please refer to the documentation.
-   */
-  FOUND: 302,
-  /**
-   * The resource can be found under a different URI.
-   */
-  SEE_OTHER: 303,
-  /**
-   * The resource is available and not modified.
-   */
-  NOT_MODIFIED: 304,
-  /**
-   * The requested resource must be accessed through the proxy given by the Location field.
-   */
-  USE_PROXY: 305,
-  /**
-   * The resource resides temporarily under a different URI.
-   */
-  TEMPORARY_REDIRECT: 307,
-  /**
-   * Invalid syntax for this request was provided.
-   */
-  BAD_REQUEST: 400,
-  /**
-   * You are unauthorized to access the requested resource. Please log in.
-   */
-  UNAUTHORIZED: 401,
-  /**
-   * Your account is not authorized to access the requested resource.
-   */
-  FORBIDDEN: 403,
-  /**
-   * We could not find the resource you requested. Please refer to the documentation for the list of resources.
-   */
-  NOT_FOUND: 404,
-  /**
-   * 	This method type is not currently supported.
-   */
-  METHOD_NOT_ALLOWED: 405,
-  /**
-   * 	Acceptance header is invalid for this endpoint resource.
-   */
-  NOT_ACCEPTABLE: 406,
-  /**
-   * Authentication with proxy is required.
-   */
-  PROXY_AUTHENTICATION_REQUIRED: 407,
-  /**
-   * Client did not produce a request within the time that the server was prepared to wait.
-   */
-  REQUEST_TIMEOUT: 408,
-  /**
-   * The request could not be completed due to a conflict with the current state of the resource.
-   */
-  CONFLICT: 409,
-  /**
-   * The requested resource is no longer available and has been permanently removed.
-   */
-  GONE: 410,
-  /**
-   * 	Length of the content is required, please include it with the request.
-   */
-  LENGTH_REQUIRED: 411,
-  /**
-   * The request did not match the pre-conditions of the requested resource.
-   */
-  PRECONDITION_FAILED: 412,
-  /**
-   * The request entity is larger than the server is willing or able to process.
-   */
-  REQUEST_ENTITY_TOO_LARGE: 413,
-  /**
-   * The request URI is longer than the server is willing to interpret.
-   */
-  REQUEST_URI_TOO_LONG: 414,
-  /**
-   * The requested resource does not support the media type provided.
-   */
-  UNSUPPORTED_MEDIA_TYPE: 415,
-  /**
-   * The requested range for the resource is not available.
-   */
-  REQUESTED_RANGE_NOT_SATISFIABLE: 416,
-  /**
-   * Unable to meet the expectation given in the Expect request header.
-   */
-  EXPECTATION_FAILED: 417,
-  /**
-   * The requested resource is missing required arguments.
-   */
-  MISSING_ARGUMENTS: 419,
-  /**
-   * The requested resource does not support one or more of the given parameters.
-   */
-  INVALID_ARGUMENTS: 420,
-  /**
-   * The request was well-formed but was unable to be followed due to semantic errors.
-   */
-  UNPROCESSABLE_ENTITY: 422,
-  /**
-   * Unexpected internal server error.
-   */
-  INTERNAL_SERVER_ERROR: 500,
-  /**
-   * The requested resource is recognized but not implemented.
-   */
-  NOT_IMPLEMENTED: 501,
-  /**
-   * Invalid response received when acting as a proxy or gateway.
-   */
-  BAD_GATEWAY: 502,
+module.exports = {
+  responseType: {
+    /**
+     * The requested resource corresponds to any one of a set of representations, each with its own specific location.
+     */
+    MULTIPLE_CHOICES: 300,
+    /**
+     * The resource has moved permanently. Please refer to the documentation.
+     */
+    MOVED_PERMANENTLY: 301,
+    /**
+     * The resource has moved temporarily. Please refer to the documentation.
+     */
+    FOUND: 302,
+    /**
+     * The resource can be found under a different URI.
+     */
+    SEE_OTHER: 303,
+    /**
+     * The resource is available and not modified.
+     */
+    NOT_MODIFIED: 304,
+    /**
+     * The requested resource must be accessed through the proxy given by the Location field.
+     */
+    USE_PROXY: 305,
+    /**
+     * The resource resides temporarily under a different URI.
+     */
+    TEMPORARY_REDIRECT: 307,
+    /**
+     * Invalid syntax for this request was provided.
+     */
+    BAD_REQUEST: 400,
+    /**
+     * You are unauthorized to access the requested resource. Please log in.
+     */
+    UNAUTHORIZED: 401,
+    /**
+     * Your account is not authorized to access the requested resource.
+     */
+    FORBIDDEN: 403,
+    /**
+     * We could not find the resource you requested. Please refer to the documentation for the list of resources.
+     */
+    NOT_FOUND: 404,
+    /**
+     * 	This method type is not currently supported.
+     */
+    METHOD_NOT_ALLOWED: 405,
+    /**
+     * 	Acceptance header is invalid for this endpoint resource.
+     */
+    NOT_ACCEPTABLE: 406,
+    /**
+     * Authentication with proxy is required.
+     */
+    PROXY_AUTHENTICATION_REQUIRED: 407,
+    /**
+     * Client did not produce a request within the time that the server was prepared to wait.
+     */
+    REQUEST_TIMEOUT: 408,
+    /**
+     * The request could not be completed due to a conflict with the current state of the resource.
+     */
+    CONFLICT: 409,
+    /**
+     * The requested resource is no longer available and has been permanently removed.
+     */
+    GONE: 410,
+    /**
+     * 	Length of the content is required, please include it with the request.
+     */
+    LENGTH_REQUIRED: 411,
+    /**
+     * The request did not match the pre-conditions of the requested resource.
+     */
+    PRECONDITION_FAILED: 412,
+    /**
+     * The request entity is larger than the server is willing or able to process.
+     */
+    REQUEST_ENTITY_TOO_LARGE: 413,
+    /**
+     * The request URI is longer than the server is willing to interpret.
+     */
+    REQUEST_URI_TOO_LONG: 414,
+    /**
+     * The requested resource does not support the media type provided.
+     */
+    UNSUPPORTED_MEDIA_TYPE: 415,
+    /**
+     * The requested range for the resource is not available.
+     */
+    REQUESTED_RANGE_NOT_SATISFIABLE: 416,
+    /**
+     * Unable to meet the expectation given in the Expect request header.
+     */
+    EXPECTATION_FAILED: 417,
+    /**
+     * The requested resource is missing required arguments.
+     */
+    MISSING_ARGUMENTS: 419,
+    /**
+     * The requested resource does not support one or more of the given parameters.
+     */
+    INVALID_ARGUMENTS: 420,
+    /**
+     * The request was well-formed but was unable to be followed due to semantic errors.
+     */
+    UNPROCESSABLE_ENTITY: 422,
+    /**
+     * Unexpected internal server error.
+     */
+    INTERNAL_SERVER_ERROR: 500,
+    /**
+     * The requested resource is recognized but not implemented.
+     */
+    NOT_IMPLEMENTED: 501,
+    /**
+     * Invalid response received when acting as a proxy or gateway.
+     */
+    BAD_GATEWAY: 502,
+    /**
+     * The server is currently unavailable.
+     */
+    SERVICE_UNAVAILABLE: 503,
+    /**
+     * Did not receive a timely response from upstream server while acting as a gateway or proxy.
+     */
+    GATEWAY_TIMEOUT: 504,
+    /**
+     * 	The HTTP protocol version used in the request message is not supported.
+     */
+    HTTP_VERSION_NOT_SUPPORTED: 505,
+    /**
+     * 	A failure occurred during initialization of services. API will be unavailable.
+     */
+    INITIALIZATION_FAILURE: 550,
+  },
+
   /**
-   * The server is currently unavailable.
-   */
-  SERVICE_UNAVAILABLE: 503,
+   * 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.message ? error.message : JSON.stringify(error.toString());
+      }
+    }
+  },
+
   /**
-   * Did not receive a timely response from upstream server while acting as a gateway or proxy.
+   * Returns the code of the error as a number
+   * @param {Object} error
+   * @returns {Number} The error code
    */
-  GATEWAY_TIMEOUT: 504,
+  getErrorType: (error) => {
+    if (error?.response?.status) {
+      return error.response.status;
+    } else return responseType.SERVICE_UNAVAILABLE;
+  },
+
   /**
-   * 	The HTTP protocol version used in the request message is not supported.
+   * Return the error information to include just the status and the message
+   * @param {*} error
+   * @returns Object
    */
-  HTTP_VERSION_NOT_SUPPORTED: 505,
+  getErrorInformation: (error) => {
+    return {
+      status: getErrorType(error),
+      message: errorToString(error),
+    };
+  },
+
   /**
-   * 	A failure occurred during initialization of services. API will be unavailable.
+   * 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
    */
-  INITIALIZATION_FAILURE: 550,
-};
-
-/**
- * Returns the error as a string
- * @param {Object} error
- */
-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.response.data.toString();
-      }
+  shouldReturnError: (returnAllExceptions, error) => {
+    if (getErrorType(error) === responseType.UNAUTHORIZED) {
+      return returnAllExceptions;
     } else {
-      return error.message ? error.message : error.toString();
+      return true;
     }
-  }
+  },
 };
-
-/**
- * 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 {*} 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 {*} 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;
-  }
-};
-
-export default instance;

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}`,