Correct payload structure, tests and update README

Author: samudary

README.md

@@ -8,6 +8,48 @@ A complete Nodejs wrapper for the Drip REST API.
 
 `npm install drip-nodejs --save`
 
+## NOTE: Potential Breaking Changes for Version 3.0.0
+
+Drip's documentation doesn't explicitly describe the required schema for each endpoint. In versions prior to 3 you would need to explicitly pass payloads with the required schema, which aren't obvious. In version 3 and later, I've attempted to make this a bit simpler. For example, batch endpoints will now only need you to pass an array of objects as:
+
+```js
+payload = [
+  {
+    email: 'user@example.com',
+    action: 'Purchased'
+  },
+  {
+    email: 'user@example.com',
+    action: 'Purchased'
+  }
+]
+// client.recordBatchEvents(payload, ...)
+```
+
+Prior to v3 changes you would need to do something like the following where the entire payload structure is defined:
+
+```js
+payload = {
+  batches: [
+    {
+      events: [
+        {
+          email: 'user@example.com',
+          action: 'Purchased'
+        },
+        {
+          email: 'user@example.com',
+          action: 'Purchased'
+        }
+      ]
+    }
+  ]
+}
+// client.recordBatchEvents(payload, ...)
+```
+
+This should help to get up and running simpler without much knowledge of the required schema. **However, existing users will need to take special note of these changes**.
+
 ## Authentication
 
 For private use and integrations, use your API Token found [here](https://www.getdrip.com/user/edit). Create a new instance of the client library with:
@@ -32,7 +74,7 @@ The following methods are currently available on the client instance. You can fi
 | List all accounts                    | `client.listAccounts(callback)`                                              |
 | Fetch an account                     | `client.fetchAccount(accountId, callback)`                                   |
 
-### Broadcats
+### Broadcasts
 | Action                               | Method                                                                       |
 |--------------------------------------|------------------------------------------------------------------------------|
 | List broadcasts                      | `client.listBroadcasts(options = {}, callback)`                              |

lib/events.js

@@ -12,12 +12,13 @@ module.exports = {
   /**
    * Record a batch of events
    *
-   * @param {object} payload - An object with event name and subscriber emails
+   * @param {object} payload - An array of event objects with at least
+   *                           an action and subscriber emails
    * @param {callback} callback - An optional callback
    * @returns {promise}
    */
   recordBatchEvents(payload, callback) {
-    return this.post(`v2/${this.accountId}/events/batches`, this.generateResource('events', payload), callback);
+    return this.post(`v2/${this.accountId}/events/batches`, this.generateResource('batches', { events: payload }), callback);
   },
   /**
    * Fetch a list of all event actions

spec/lib/events_spec.js

@@ -81,15 +81,15 @@ describe('Events with Promise', () => {
   it('should record a batch of events', (done) => {
     expect(typeof client.recordBatchEvents).toEqual('function');
 
-    client.recordBatchEvents({ email: 'test@example.com', action: 'Purchased' })
+    client.recordBatchEvents([{ email: 'test@example.com', action: 'Purchased' }])
       .then((response) => {
         expect(response.statusCode).toBe(200);
         expect(client.request.callCount).toBe(1);
       })
       .catch(failTest);
     done();
 
-    expect(client.post).toHaveBeenCalledWith('v2/9999999/events/batches', { events: [{ email: 'test@example.com', action: 'Purchased' }] }, undefined);
+    expect(client.post).toHaveBeenCalledWith('v2/9999999/events/batches', { batches: [{ events: [{ email: 'test@example.com', action: 'Purchased' }] }] }, undefined);
   });
 
   it('should fetch a list of event actions', (done) => {

spec/lib/shopper_activity_spec.js

@@ -150,7 +150,7 @@ describe('Shopper Activity with Promise', () => {
       .catch(failTest);
     done();
 
-    expect(client.post).toHaveBeenCalledWith('v3/9999999/shopper_activity/cart', { payload }, undefined);
+    expect(client.post).toHaveBeenCalledWith('v3/9999999/shopper_activity/cart', payload, undefined);
   });
 
   it('should create an order activity and call request with POST', (done) => {
@@ -165,7 +165,7 @@ describe('Shopper Activity with Promise', () => {
       .catch(failTest);
     done();
 
-    expect(client.post).toHaveBeenCalledWith('v3/9999999/shopper_activity/order', { payload }, undefined);
+    expect(client.post).toHaveBeenCalledWith('v3/9999999/shopper_activity/order', payload, undefined);
   });
 
   it('should create a product activity and call request with POST', (done) => {
@@ -184,6 +184,6 @@ describe('Shopper Activity with Promise', () => {
       .catch(failTest);
     done();
 
-    expect(client.post).toHaveBeenCalledWith('v3/9999999/shopper_activity/product', { payload }, undefined);
+    expect(client.post).toHaveBeenCalledWith('v3/9999999/shopper_activity/product', payload, undefined);
   });
 });