order price creation (#16)

Author: thdaraujo

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.4] - 2020-10-14
+
+### Added
+
+- `total_price_cents_usd` field to `orders`
+- allows users to create an order by total price
+
+### Changed
+
+- order creation requires either `mass_g` or `total_price_cents_usd`, but not both
+
 ## [1.2.3] - 2020-09-28
 
 ### Added

README.md

@@ -45,32 +45,43 @@ var patch = require('@patch-technology/patch').default('key_test_1234');
 
 ### Orders
 
-In Patch, orders represent a purchase of carbon offsets or negative emissions by mass. Place orders directly if you know the amount of carbon dioxide you would like to sequester. If you do not know how much to purchase, use an estimate.
+In Patch, orders represent a purchase of carbon offsets or negative emissions by mass.
+Place orders directly if you know the amount of carbon dioxide you would like to sequester.
+If you do not know how much to purchase, use an estimate.
+You can also create an order with a maximum desired price, and we'll allocate enough mass to
+fulfill the order for you.
 
 [API Reference](https://docs.usepatch.com/#/?id=orders)
 
 #### Examples
 
 ```javascript
-// Create an order
-const mass = 1000000 // Pass in the mass in grams (i.e. 1 metric tonne)
-patch.orders.createOrder({ mass_g: mass })
+// Create an order - you can create an order
+// providing either mass_g or total_price_cents_usd, but not both
 
-# Retrieve an order
-orderId = 'ord_test_1234' // Pass in the order's id
-patch.orders.retrieveOrder(orderId)
+// Create order with mass
+const mass = 1000000; // Pass in the mass in grams (i.e. 1 metric tonne)
+patch.orders.createOrder({ mass_g: mass });
+
+// Create an order with a maximum total price
+const totalPriceCentsUSD = 500; // Pass in the total price in cents (i.e. 5 dollars)
+patch.orders.createOrder({ total_price_cents_usd: totalPriceCentsUSD });
+
+// Retrieve an order
+orderId = 'ord_test_1234'; // Pass in the order's id
+patch.orders.retrieveOrder(orderId);
 
 // Place an order
-const orderId = 'ord_test_1234' // Pass in the order's id
-patch.orders.placeOrder(orderId)
+const orderId = 'ord_test_1234'; // Pass in the order's id
+patch.orders.placeOrder(orderId);
 
 // Cancel an order
-const orderId = 'ord_test_1234' // Pass in the order's id
-patch.orders.cancelOrder(orderId)
+const orderId = 'ord_test_1234'; // Pass in the order's id
+patch.orders.cancelOrder(orderId);
 
 // Retrieve a list of orders
-const page = 1 // Pass in which page of orders you'd like
-patch.orders.retrieveOrders({ page })
+const page = 1; // Pass in which page of orders you'd like
+patch.orders.retrieveOrders({ page });
 ```
 
 ### Estimates
@@ -176,7 +187,7 @@ This will create a `node_modules` directory in your test repository which will s
 ```
 $ node
 > const Patch = require('@patch-technology/patch')
-> Patch.default('<PATCH_API_KEY>').projects.retrieveProjects().then((response) => console.log(response))
+> Patch.default(process.env.SANDBOX_API_KEY).projects.retrieveProjects().then((response) => console.log(response))
 ```
 
 ### Run the specs

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patch-technology/patch",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Javascript wrapper for the Patch API",
   "license": "MIT",
   "repository": {

src/model/CreateOrderRequest.js

@@ -8,13 +8,11 @@
 import ApiClient from '../ApiClient';
 
 class CreateOrderRequest {
-  constructor(massG) {
-    CreateOrderRequest.initialize(this, massG);
+  constructor() {
+    CreateOrderRequest.initialize(this);
   }
 
-  static initialize(obj, massG) {
-    obj['mass_g'] = massG;
-  }
+  static initialize(obj) {}
 
   static constructFromObject(data, obj) {
     if (data) {
@@ -24,6 +22,13 @@ class CreateOrderRequest {
         obj['mass_g'] = ApiClient.convertToType(data['mass_g'], 'Number');
       }
 
+      if (data.hasOwnProperty('total_price_cents_usd')) {
+        obj['total_price_cents_usd'] = ApiClient.convertToType(
+          data['total_price_cents_usd'],
+          'Number'
+        );
+      }
+
       if (data.hasOwnProperty('project_id')) {
         obj['project_id'] = ApiClient.convertToType(
           data['project_id'],
@@ -41,6 +46,8 @@ class CreateOrderRequest {
 
 CreateOrderRequest.prototype['mass_g'] = undefined;
 
+CreateOrderRequest.prototype['total_price_cents_usd'] = undefined;
+
 CreateOrderRequest.prototype['project_id'] = undefined;
 
 CreateOrderRequest.prototype['metadata'] = undefined;

test/integration/orders.test.js

@@ -1,21 +1,33 @@
 import { expect } from 'chai';
 import Patch from '../../dist/index';
 const patch = Patch(process.env.SANDBOX_API_KEY);
+const biomass_test_project_id = 'pro_test_c3a9feba769fc7a8806377266ca9ff6a';
 
 describe('Orders Integration', function () {
   it('supports create, place, cancel, retrieve and list', async function () {
     const createOrderResponse = await patch.orders.createOrder({ mass_g: 100 });
     const orderId = createOrderResponse.data.id;
 
-    const retreiveOrderResponse = await patch.orders.retrieveOrder(orderId);
-    expect(retreiveOrderResponse.data.id).to.equal(orderId);
+    const retrieveOrderResponse = await patch.orders.retrieveOrder(orderId);
+    expect(retrieveOrderResponse.data.id).to.equal(orderId);
 
     const retrieveOrdersResponse = await patch.orders.retrieveOrders({
       page: 1
     });
     expect(retrieveOrdersResponse.data.length).to.be.above(0);
   });
 
+  it('supports create orders with a total price', async function () {
+    const createOrderResponse = await patch.orders.createOrder({
+      total_price_cents_usd: 500,
+      project_id: biomass_test_project_id
+    });
+
+    expect(createOrderResponse.data.price_cents_usd).to.equal('500.0');
+    expect(createOrderResponse.data.patch_fee_cents_usd).to.equal('0.0');
+    expect(createOrderResponse.data.mass_g).to.equal(5000000);
+  });
+
   it('supports placing orders in a `draft` state', async function () {
     const estimateResponse = await patch.estimates.createMassEstimate({
       mass_g: 100