Merge pull request #23 from samudary/v3/shopper-activity

V3 Shopper Activity methods

Author: samudary

.travis.yml

@@ -1,7 +1,9 @@
 language: node_js
 node_js:
-  - "6"
-  - "7"
+  - "9"
+  - "10"
+  - "11"
+  - "12"
 before_script:
   - "npm i -g jasmine eslint eslint-config-airbnb-base eslint-plugin-import sinon"
 script:

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)`                              |
@@ -86,6 +128,13 @@ The following methods are currently available on the client instance. You can fi
 | Record a batch of orders             | `client.createUpdateBatchOrders(payload, callback)`                          |
 | Record a refund for an order         | `client.createUpdateRefund(payload, callback)`                               |
 
+### Shopper Activity
+| Action                               | Method                                                                       |
+|--------------------------------------|------------------------------------------------------------------------------|
+| Create or update a cart for a customer | `client.createUpdateCartActivity(payload, callback)`                       |
+| Create or update an order for a customer | `client.createUpdateOrderActivity(payload, callback)`                    |
+| Create or update a product | `client.createUpdateProductActivity(payload, callback)`                                |
+
 ### Subscribers
 | Action                               | Method                                                                       |
 |--------------------------------------|------------------------------------------------------------------------------|

lib/accounts.js

@@ -6,7 +6,7 @@ module.exports = {
    * @returns {promise}
    */
   listAccounts(callback) {
-    return this.get('accounts', {}, callback);
+    return this.get('v2/accounts', {}, callback);
   },
   /**
    * Fetch an account
@@ -16,6 +16,6 @@ module.exports = {
    * @returns {promise}
    */
   fetchAccount(accountId, callback) {
-    return this.get(`accounts/${accountId}`, {}, callback);
+    return this.get(`v2/accounts/${accountId}`, {}, callback);
   }
 };

lib/broadcasts.js

@@ -8,7 +8,7 @@ module.exports = {
    * @returns {promise}
    */
   listBroadcasts(options = {}, callback) {
-    return this.get(`${this.accountId}/broadcasts/`, { qs: options }, callback);
+    return this.get(`v2/${this.accountId}/broadcasts/`, { qs: options }, callback);
   },
   /**
    * Fetch a broadcast
@@ -18,6 +18,6 @@ module.exports = {
    * @returns {promise}
    */
   fetchBroadcast(broadcastId, callback) {
-    return this.get(`${this.accountId}/broadcasts/${broadcastId}`, {}, callback);
+    return this.get(`v2/${this.accountId}/broadcasts/${broadcastId}`, {}, callback);
   }
 };

lib/campaigns.js

@@ -8,7 +8,7 @@ module.exports = {
    * @returns {promise}
    */
   listCampaigns(options = {}, callback) {
-    return this.get(`${this.accountId}/campaigns/`, { qs: options }, callback);
+    return this.get(`v2/${this.accountId}/campaigns/`, { qs: options }, callback);
   },
   /**
    * Fetch a campaign
@@ -18,7 +18,7 @@ module.exports = {
    * @returns {promise}
    */
   fetchCampaign(campaignId, callback) {
-    return this.get(`${this.accountId}/campaigns/${campaignId}`, {}, callback);
+    return this.get(`v2/${this.accountId}/campaigns/${campaignId}`, {}, callback);
   },
   /**
    * Activate a campaign
@@ -28,7 +28,7 @@ module.exports = {
    * @returns {promise}
    */
   activateCampaign(campaignId, callback) {
-    return this.post(`${this.accountId}/campaigns/${campaignId}/activate`, {}, callback);
+    return this.post(`v2/${this.accountId}/campaigns/${campaignId}/activate`, {}, callback);
   },
   /**
    * Pause a campaign
@@ -38,7 +38,7 @@ module.exports = {
    * @returns {promise}
    */
   pauseCampaign(campaignId, callback) {
-    return this.post(`${this.accountId}/campaigns/${campaignId}/pause`, {}, callback);
+    return this.post(`v2/${this.accountId}/campaigns/${campaignId}/pause`, {}, callback);
   },
   /**
    * List all subscribers subscribed to a campaign
@@ -48,7 +48,7 @@ module.exports = {
    * @returns {promise}
    */
   listAllSubscribesToCampaign(campaignId, callback) {
-    return this.get(`${this.accountId}/campaigns/${campaignId}/subscribers`, {}, callback);
+    return this.get(`v2/${this.accountId}/campaigns/${campaignId}/subscribers`, {}, callback);
   },
   /**
    * Subscribe someone to a campaign
@@ -59,6 +59,6 @@ module.exports = {
    * @returns {promise}
    */
   subscribeToCampaign(campaignId, payload, callback) {
-    return this.post(`${this.accountId}/campaigns/${campaignId}/subscribers`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/campaigns/${campaignId}/subscribers`, this.generateResource('subscribers', payload), callback);
   }
 };

lib/conversions.js

@@ -8,7 +8,7 @@ module.exports = {
    * @returns {promise}
    */
   listConversions(options = {}, callback) {
-    return this.get(`${this.accountId}/goals/`, { qs: options }, callback);
+    return this.get(`v2/${this.accountId}/goals/`, { qs: options }, callback);
   },
   /**
    * Fetch a conversion
@@ -18,6 +18,6 @@ module.exports = {
    * @returns {promise}
    */
   fetchConversion(conversionId, callback) {
-    return this.get(`${this.accountId}/goals/${conversionId}`, {}, callback);
+    return this.get(`v2/${this.accountId}/goals/${conversionId}`, {}, callback);
   }
 };

lib/custom_fields.js

@@ -6,6 +6,6 @@ module.exports = {
    * @returns {promise}
    */
   listAllCustomFields(callback) {
-    return this.get(`${this.accountId}/custom_field_identifiers/`, {}, callback);
+    return this.get(`v2/${this.accountId}/custom_field_identifiers/`, {}, callback);
   }
 };

lib/errors.js

@@ -0,0 +1,9 @@
+class MissingAttributeError extends Error {
+  constructor(message) {
+    super(message);
+
+    this.name = this.constructor.name;
+  }
+}
+
+module.exports = MissingAttributeError;

lib/events.js

@@ -7,17 +7,18 @@ module.exports = {
    * @returns {promise}
    */
   recordEvent(payload, callback) {
-    return this.post(`${this.accountId}/events`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/events`, this.generateResource('events', payload), callback);
   },
   /**
    * 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(`${this.accountId}/events/batches`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/events/batches`, this.generateResource('batches', { events: payload }), callback);
   },
   /**
    * Fetch a list of all event actions
@@ -27,6 +28,6 @@ module.exports = {
    * @returns {promise}
    */
   listEventActions(options = {}, callback) {
-    return this.get(`${this.accountId}/event_actions/`, { qs: options }, callback);
+    return this.get(`v2/${this.accountId}/event_actions/`, { qs: options }, callback);
   }
 };

lib/forms.js

@@ -6,7 +6,7 @@ module.exports = {
    * @returns {promise}
    */
   listForms(callback) {
-    return this.get(`${this.accountId}/forms`, {}, callback);
+    return this.get(`v2/${this.accountId}/forms`, {}, callback);
   },
   /**
    * Fetch a form
@@ -16,6 +16,6 @@ module.exports = {
    * @returns {promise}
    */
   fetchForm(formId, callback) {
-    return this.get(`${this.accountId}/forms/${formId}`, {}, callback);
+    return this.get(`v2/${this.accountId}/forms/${formId}`, {}, callback);
   }
 };