Add flowBadge, locationEmployees, employees, signInPage tests

lib/EnvoyAPI.js

@@ -229,20 +229,28 @@ class EnvoyAPI {
 
   /**
    * Import employee records to the Employee Directory. The file headers must be in the following order, Full Name, Email, Mobile Number, Assistants Email. 
-   * If your csv does not contain email entries, it will override the previous employee directory in full.
-   * Possibly deprecated? This route doesn't seem to exist anymore.
+   * Your .csv must list one employee per line, contain a unique email address for each employee, and match the format below. 
+   * Mobile numbers and assistant email are optional.
+   * Legacy API, this still works but will not be supported.
    * @param {file} file 
-   * @param {string} api_key 
    * @returns 
    */
-  async importEmployeeRecords(file, api_key) {
+  async importEmployeeRecords(file) {
     var options = {
-      'method': 'GET',
-      'url': `https://app.envoy.com/api/configuration/employee_list/${api_key}`,
+      'method': 'POST',
+      'url': `https://app.envoy.com/api/configuration/employee_list`,
       'headers': {
         'Authorization': 'Bearer ' + this.token
       },
-      body: file,
+      formData: {
+        'file': {
+          'value': file,
+          'options': {
+            'filename': '',
+            'contentType': null
+          }
+        }
+      },
       json: true,
     };
 
@@ -251,13 +259,14 @@ class EnvoyAPI {
       response.body;
     });
 
-    return EnvoyAPI.getDataFromBody(body);
+    return body;
   }
 
 
   /**
+   * Deprecated. Use employees() and filter by location Ids of employees returned.
+   * See employees() for list of optional params.
    * Fetches the employees for this location.
-   *
    * @param {string|number} locationId
    * @param {{}} params
    * @returns {Promise<EnvoyObject[]>}
@@ -273,8 +282,9 @@ class EnvoyAPI {
   }
 
   /**
+   * Deprecated. Use employees() instead.
    * Fetches an employee.
-   *
+   * 
    * @param {string|number} employeeId
    * @returns {Promise<EnvoyObject>}
    */
@@ -303,6 +313,7 @@ class EnvoyAPI {
   }
 
   /**
+   * Deprecated.
    * Fetches the sign-in page details for this flow.
    *
    * @param {string|number} flowId

lib/test/EnvoyAPI.test.js

@@ -1,5 +1,6 @@
 const EnvoyAPI = require('../EnvoyAPI');
 const request = require('request');
+const fs = require('fs');
 let envoy = null;
 let envoyNoScopes = null;
 
@@ -8,14 +9,22 @@ const TOKEN_SCOPE = [
     'locations.read',
     'companies.read',
     'flows.read',
+    'badges.read',
     'invites.read',
     'invites.write',
     'employees.read',
+    'employees.write',
+    'entries.read',
+    'entries.write',
+    'agreements.write',
     'reservations.read',
     'reservations.write',
     'spaces.read',
     'work-schedules.read',
     'work-schedules.write',
+    'sign-in-fields.read',
+    'sign-in-fields.write',
+    'sign-in-field-pages.read',
 ]
 
 /** 
@@ -296,5 +305,97 @@ describe('EnvoyAPI methods', () => {
     //     });
     // });
 
-    describe('')
+    /* Don't run this test as it will overwrite all employees with your uploaded csv file. This is also a deprecated API.
+    describe('(Deprecated) Employee Import', () => {
+        it('Should import employees from a csv file.', async () => {
+            let file = fs.createReadStream('./lib/test/resource/employees-export.csv');
+            let empImport = await envoy.importEmployeeRecords(file);
+
+            expect(empImport.message).toEqual('File uploaded successfully. Check /api/configuration/import_status for status.');
+        })
+    });
+    */
+
+    // describe('(Deprecated) locationEmployees', () => {
+    //     it('should return employees from a location.', async () => {
+    //         let employees = await envoy.locationEmployees(143497, {
+    //             //Optional params.
+    //             email: '[email protected]'
+    //         });
+    //         expect(employees[0].type).toEqual('employees');
+    //     })
+
+    //     it('should return status 404 if location can\'t be found.', async () => {
+    //         let errMsg = null;
+
+    //         try {
+    //             await envoy.locationEmployees(999999);
+    //         } catch(err) {
+    //             errMsg = err.statusCode;
+    //         }
+
+    //         expect(errMsg).toEqual(404);
+    //     })
+    // });
+
+    // describe('(Deprecated) flowBadge', () => {
+    //     it('should return badge for this flow.', async () => {
+    //         let flow = await envoy.flowBadge(295831);
+
+    //         expect(flow.id).toEqual('226107');
+    //     })
+
+    //     it('should return status 404 if flow can\'t be found.', async () => {
+    //         let errMsg = null;
+
+    //         try {
+    //             await envoy.flowBadge(999999);
+    //         } catch(err) {
+    //             errMsg = err.statusCode;
+    //         }
+
+    //         expect(errMsg).toEqual(404);
+    //     })
+
+    // });
+
+    // describe('(Deprecated) signInPage', () => {
+    //     it('should return sign-in page details for this flow', async () => {
+    //         let page = await envoy.signInPage(295831);
+    //         expect(page.type).toEqual('sign-in-field-pages');
+    //     })
+
+    //     it('should return status 404 if flow can\'t be found.', async () => {
+    //         let errMsg = null;
+
+    //         try {
+    //             await envoy.signInPage(999999);
+    //         } catch(err) {
+    //             errMsg = err.statusCode;
+    //         }
+
+    //         expect(errMsg).toEqual(404);
+    //     })
+
+    // });
+
+    describe('(Deprecated) signInFields', () => {
+        it('should return the sign-in fields for this page', async () => {
+            let page = await envoy.signInFields(1433967);
+            expect(page.type).toEqual('sign-in-field-pages');
+        })
+
+        it('should return status 404 if flow can\'t be found.', async () => {
+            let errMsg = null;
+
+            try {
+                await envoy.signInFields(999999);
+            } catch(err) {
+                errMsg = err.statusCode;
+            }
+
+            expect(errMsg).toEqual(404);
+        })
+
+    });
 })