@stackfactor/client-api 1.0.3 → 1.0.5

package/index.js

@@ -1,6 +1,7 @@
 const actionNotifications = require("./lib/actionNotifications");
 const address = require("./lib/address");
 const config = require("./lib/config");
+const constants = require("./lib/constants");
 const integration = require("./lib/integration");
 const integrationsConfiguration = require("./lib/integrationsConfiguration");
 const departmentTraiingPlans = require("./lib/departmentTraiingPlans");
@@ -25,10 +26,12 @@ module.exports = {
   actionNotifications,
   address,
   config,
+  DOCUMENT_VERSION: constants.DOCUMENT_VERSION,
   integration,
   integrationsConfiguration,
   departmentTraiingPlans,
   groups,
+  RESONSE_TYPE: constants.RESONSE_TYPE,
   role,
   roleTemplate,
   skill,

package/lib/axios.js

@@ -7,142 +7,79 @@ let instance = axios.create({
   baseURL: baseUrl,
 });
 
-const responseType = {
-  /**
-   * The requested resource corresponds to any one of a set of representations, each with its own specific location.
-   */
+const DOCUMENT_VERSION = {
+  DRAFT: "draft",
+  PUBLISHED: "published",
+};
+
+const RESPONSE_TYPE = {
+  //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.
-   */
+  //The resource has moved permanently. Please refer to the documentation.
   MOVED_PERMANENTLY: 301,
-  /**
-   * The resource has moved temporarily. Please refer to the documentation.
-   */
+  //The resource has moved temporarily. Please refer to the documentation.
   FOUND: 302,
-  /**
-   * The resource can be found under a different URI.
-   */
+  //The resource can be found under a different URI.
   SEE_OTHER: 303,
-  /**
-   * The resource is available and not modified.
-   */
+  //The resource is available and not modified.
   NOT_MODIFIED: 304,
-  /**
-   * The requested resource must be accessed through the proxy given by the Location field.
-   */
+  //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.
-   */
+  //The resource resides temporarily under a different URI.
   TEMPORARY_REDIRECT: 307,
-  /**
-   * Invalid syntax for this request was provided.
-   */
+  //Invalid syntax for this request was provided.
   BAD_REQUEST: 400,
-  /**
-   * You are unauthorized to access the requested resource. Please log in.
-   */
+  //You are unauthorized to access the requested resource. Please log in.
   UNAUTHORIZED: 401,
-  /**
-   * Your account is not authorized to access the requested resource.
-   */
+  //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.
-   */
+  //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.
-   */
+  //This method type is not currently supported.
   METHOD_NOT_ALLOWED: 405,
-  /**
-   * 	Acceptance header is invalid for this endpoint resource.
-   */
+  //Acceptance header is invalid for this endpoint resource.
   NOT_ACCEPTABLE: 406,
-  /**
-   * Authentication with proxy is required.
-   */
+  //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.
-   */
+  //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.
-   */
+  //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.
-   */
+  //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 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.
-   */
+  //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.
-   */
+  //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.
-   */
+  //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.
-   */
+  //The requested resource does not support the media type provided.
   UNSUPPORTED_MEDIA_TYPE: 415,
-  /**
-   * The requested range for the resource is not available.
-   */
+  //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.
-   */
+  //Unable to meet the expectation given in the Expect request header.
   EXPECTATION_FAILED: 417,
-  /**
-   * The requested resource is missing required arguments.
-   */
+  //The requested resource is missing required arguments.
   MISSING_ARGUMENTS: 419,
-  /**
-   * The requested resource does not support one or more of the given parameters.
-   */
+  //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.
-   */
+  //The request was well-formed but was unable to be followed due to semantic errors.
   UNPROCESSABLE_ENTITY: 422,
-  /**
-   * Unexpected internal server error.
-   */
+  //Unexpected internal server error.
   INTERNAL_SERVER_ERROR: 500,
-  /**
-   * The requested resource is recognized but not implemented.
-   */
+  //The requested resource is recognized but not implemented.
   NOT_IMPLEMENTED: 501,
-  /**
-   * Invalid response received when acting as a proxy or gateway.
-   */
+  //Invalid response received when acting as a proxy or gateway.
   BAD_GATEWAY: 502,
-  /**
-   * The server is currently unavailable.
-   */
+  //The server is currently unavailable.
   SERVICE_UNAVAILABLE: 503,
-  /**
-   * Did not receive a timely response from upstream server while acting as a gateway or proxy.
-   */
+  //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.
-   */
+  //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.
-   */
+  //A failure occurred during initialization of services. API will be unavailable.
   INITIALIZATION_FAILURE: 550,
 };
 
@@ -152,6 +89,8 @@ const responseType = {
 module.exports = {
   axios: instance,
 
+  DOCUMENT_VERSION: DOCUMENT_VERSION,
+
   /**
    * Returns the error as a string
    * @param {Object} error
@@ -203,7 +142,7 @@ module.exports = {
     };
   },
 
-  responseType: responseType,
+  RESPONSE_TYPE: RESPONSE_TYPE,
 
   /**
    * Returns true if an exception should be handled to the business and presentation layer

package/lib/constants.js

@@ -0,0 +1,80 @@
+const DOCUMENT_VERSION = {
+  DRAFT: "draft",
+  PUBLISHED: "published",
+};
+
+const RESPONSE_TYPE = {
+  //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,
+};
+
+module.exports = {
+  DOCUMENT_VERSION: DOCUMENT_VERSION,
+  RESPONSE_TYPE: RESPONSE_TYPE,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Node.js library for the StackFactor API",
   "main": "index.js",
   "exports": {