From e6ec7801bb8450e0815b3dd89d5d56eb31917da3 Mon Sep 17 00:00:00 2001
From: Matthew R <matthew@staff.libraryofcode.org>
Date: Mon, 20 Jan 2020 23:41:24 -0500
Subject: [PATCH] Route constructor changed to protected

---
 src/class/Route.ts | 58 ++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 56 insertions(+), 2 deletions(-)

diff --git a/src/class/Route.ts b/src/class/Route.ts
index d15f936..d96e24b 100644
--- a/src/class/Route.ts
+++ b/src/class/Route.ts
@@ -9,7 +9,7 @@ export default class Route {
 
   public conf: { path: string, deprecated?: boolean, maintenance?: boolean };
 
-  constructor(server: Server, conf: { path: string, deprecated?: boolean, maintenance?: boolean }) {
+  protected constructor(server: Server, conf: { path: string, deprecated?: boolean, maintenance?: boolean }) {
     this.server = server;
     this.router = router();
     this.conf = conf;
@@ -61,22 +61,76 @@ export default class Route {
   get constants() {
     return {
       codes: {
+        /**
+         * SUCCESS 100
+         * Used if the request was processed successfully.
+         */
         SUCCESS: 100,
+        /**
+         * UNAUTHORIZED 101
+         * Used if the client calling the request couldn't be correctly authenticated.
+         */
         UNAUTHORIZED: 101,
-        PERMISSION_DENIED: 104,
+        /**
+         * PERMISSION DENIED 103
+         * Used if the client calling the request doesn't have access to the resource specified.
+         */
+        PERMISSION_DENIED: 103,
+        /**
+         * NOT FOUND 104
+         * Used if the resource the client requested doesn't exist.
+         */
         NOT_FOUND: 104,
+        /**
+         * ACCOUNT NOT FOUND 1041
+         * Used if the account specified by the client couldn't be found.
+         */
         ACCOUNT_NOT_FOUND: 1041,
+        /**
+         * CLIENT ERROR 1044
+         * Used in cases of user error. Examples are incorrect parameters, incorrect headers, or an invalid request.
+         */
         CLIENT_ERROR: 1044,
+        /**
+         * SERVER ERROR 105
+         * Used in cases of an internal error that caused the bind() function to throw.
+         */
         SERVER_ERROR: 105,
+        /**
+         * DEPRECATED 1051
+         * Returned back to the user if the resource requested is deprecated.
+         */
         DEPRECATED: 1051,
+        /**
+         * MAINTENANCE OR UNAVAILABLE 1053
+         * Used if the resource requested is currently in maintenance, not finished, or temporarily disabled.
+         */
         MAINTENANCE_OR_UNAVAILABLE: 1053,
       },
       messages: {
+        /**
+         * The credentials you supplied are invalid.
+         */
         UNAUTHORIZED: ['CREDENTIALS_INVALID', 'The credentials you supplied are invalid.'],
+        /**
+         * You do not have valid credentials to access this resource.
+         */
         PERMISSION_DENIED: ['PERMISSION_DENIED', 'You do not have valid credentials to access this resource.'],
+        /**
+         * The resource you requested cannot be located.
+         */
         NOT_FOUND: ['NOT_FOUND', 'The resource you requested cannot be located.'],
+        /**
+         * An internal error has occurred, Engineers have been notified.
+         */
         SERVER_ERROR: ['INTERNAL_ERROR', 'An internal error has occurred, Engineers have been notified.'],
+        /**
+         * The endpoint or resource you\'re trying to access has been deprecated.
+         */
         DEPRECATED: ['ENDPOINT_OR_RESOURCE_DEPRECATED', 'The endpoint or resource you\'re trying to access has been deprecated.'],
+        /**
+         * The endpoint or resource you\'re trying to access is either in maintenance or is not available.
+         */
         MAINTENANCE_OR_UNAVAILABLE: ['SERVICE_UNAVAILABLE', 'The endpoint or resource you\'re trying to access is either in maintenance or is not available.'],
       },
     };