Merge pull request #11 from samudary/orders-api

Orders API

Author: samudary

README.md

@@ -77,12 +77,14 @@ The following methods are currently available on the client instance. You can fi
 | List all forms                       | `client.listForms(callback)`                                                 |
 | Fetch a form                         | `client.fetchForm(formId, callback)`                                         |
 
-### Purchases
+**Note:** The beta purchases endpoint has been deprecated and its methods have been removed from the package except `createPurchase`, which now sends requests to the Order creation endpoint [here](https://developer.drip.com/#orders).
+
+### Orders
 | Action                               | Method                                                                       |
 |--------------------------------------|------------------------------------------------------------------------------|
-| List all purchases                   | `client.listPurchases(idOrEmail, options = {}, callback)`                    |
-| Create a purchase                    | `client.createPurchase(idOrEmail, payload, callback)`                        |
-| Fetch a purchase                     | `client.fetchPurchase(idOrEmail, purchaseId, callback)`                      |
+| Record an order for a subscriber     | `client.createUpdateOrder(payload, callback)`                                |
+| Record a batch of orders             | `client.createUpdateBatchOrders(payload, callback)`                          |
+| Record a refund for an order         | `client.createUpdateRefund(payload, callback)`                               |
 
 ### Subscribers
 | Action                               | Method                                                                       |

lib/index.js

@@ -5,6 +5,7 @@ const Conversions = require('./conversions.js');
 const Events = require('./events');
 const Fields = require('./custom_fields');
 const Forms = require('./forms');
+const Orders = require('./orders');
 const Purchases = require('./purchases');
 const Subscribers = require('./subscribers');
 const Subscriptions = require('./subscriptions');
@@ -138,8 +139,11 @@ Client.prototype.fetchForm = Forms.fetchForm;
 
 // Purchases methods
 Client.prototype.createPurchase = Purchases.createPurchase;
-Client.prototype.listPurchases = Purchases.listPurchases;
-Client.prototype.fetchPurchase = Purchases.fetchPurchase;
+
+// Order methods
+Client.prototype.createUpdateOrder = Orders.createUpdateOrder;
+Client.prototype.createUpdateBatchOrders = Orders.createUpdateBatchOrders;
+Client.prototype.createUpdateRefund = Orders.createUpdateRefund;
 
 // Subscriber methods
 Client.prototype.listSubscribers = Subscribers.listSubscribers;

lib/orders.js

@@ -0,0 +1,35 @@
+module.exports = {
+  /**
+   * Record an order for a subscriber
+   * Docs: http://developer.drip.com/#create-or-update-an-order
+   *
+   * @param {object} payload - An object with order details
+   * @param {callback} callback - An optional callback
+   * @returns {promise}
+   */
+  createUpdateOrder(payload, callback) {
+    return this.post(`${this.accountId}/orders`, { payload }, callback);
+  },
+  /**
+   * Record a batch of orders
+   * Docs: http://developer.drip.com/#create-or-update-a-batch-of-orders
+   *
+   * @param {object} payload - An object of an array of multiple orders
+   * @param {callback} callback - An optional callback
+   * @returns {promise}
+   */
+  createUpdateBatchOrders(payload, callback) {
+    return this.post(`${this.accountId}/orders/batches`, { payload }, callback);
+  },
+  /**
+   * Record a refund for an order
+   * Docs: http://developer.drip.com/#create-or-update-a-refund
+   *
+   * @param {object} payload - Required. An object with refund details
+   * @param {callback} callback - An optional callback
+   * @returns {promise}
+   */
+  createUpdateRefund(payload, callback) {
+    return this.post(`${this.accountId}/refunds`, { payload }, callback);
+  }
+};

lib/purchases.js

@@ -1,40 +1,18 @@
-const helpers = require('./helpers');
-
 module.exports = {
   /**
    * Record purchases for a subscriber
    *
+   * @deprecated Deprecated since version 2.0.0. Will be deleted in version 3.0.0.
+   * The beta Purchase endpoint has been deprecated and this method now sends requests
+   * to the Order creation endpoint. Please use `createUpdateOrder` instead
+   *
    * @param {string} idOrEmail - The subscriber's email or id
    * @param {object} payload - An object with purchase details
    * @param {callback} callback - An optional callback
    * @returns {promise}
    */
   createPurchase(idOrEmail, payload, callback) {
-    const encodedIdOrEmail = helpers.escapeString(idOrEmail);
-    return this.post(`${this.accountId}/subscribers/${encodedIdOrEmail}/purchases`, { payload }, callback);
-  },
-  /**
-   * List purchases for a subscriber
-   *
-   * @param {string} idOrEmail - The subscriber's email or id
-   * @param {object} options - An object with `page` properties
-   * @param {callback} callback - An optional callback
-   * @returns {promise}
-   */
-  listPurchases(idOrEmail, options = {}, callback) {
-    const encodedIdOrEmail = helpers.escapeString(idOrEmail);
-    return this.get(`${this.accountId}/subscribers/${encodedIdOrEmail}/purchases`, { qs: options }, callback);
-  },
-  /**
-   * Fetch a purchase record
-   *
-   * @param {string} idOrEmail - The subscriber's email or id
-   * @param {number} purchaseId - Required. A purchase id
-   * @param {callback} callback - An optional callback
-   * @returns {promise}
-   */
-  fetchPurchase(idOrEmail, purchaseId, callback) {
-    const encodedIdOrEmail = helpers.escapeString(idOrEmail);
-    return this.get(`${this.accountId}/subscribers/${encodedIdOrEmail}/purchases/${purchaseId}`, {}, callback);
+    const options = Object.assign(payload, { email: idOrEmail });
+    return this.post(`${this.accountId}/orders`, { options }, callback);
   }
 };

lib/version.js

@@ -1 +1 @@
-module.exports = '0.2.1';
+module.exports = '2.0.0';