Add bitcoin estimates and registry_url (#32)

* Update SDK

* Fix existing spec

* Re-add +1

* Add node 16

* Make package compatible with node 10

* Add test for bitcoin estimates

* Shorten timeout

* Bump version

* Clarify testing instructions

* Make tests less flaky

Author: pcothenet

.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ['10', '12', '14']
+        node: ['10', '12', '14', '16']
     name: Node ${{ matrix.node }} Test
     steps:
       - name: Check out code

.mocharc.yml

@@ -0,0 +1,2 @@
+require: '@babel/register'
+recursive: true

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.6.0] - 2021-07-14
+
+### Added
+
+- Order responses return a `registry_url` field
+- Add support for Bitcoin estimates
+
 ## [1.5.2] - 2021-03-30
 
 ### Changed

README.md

@@ -102,27 +102,33 @@ Estimates allow API users to get a quote for the cost of compensating a certain
 
 ```javascript
 // Create a mass estimate
-const mass = 1000000; // Pass in the mass in grams (i.e. 1 metric tonne)
-patch.estimates.createMassEstimate({ mass_g: mass });
+const mass_g = 1000000; // Pass in the mass in grams (i.e. 1 metric tonne)
+patch.estimates.createMassEstimate({ mass_g });
 
 // Create a flight estimate
 const distance_m = 9000000; // Pass in the distance traveled in meters
-patch.estimates.createFlightEstimate({ distance_m: distance_m });
+patch.estimates.createFlightEstimate({ distance_m });
 
 // Create a shipping estimate
 const distance_m = 9000000;
 // Pass in the shipping distance in meters, the transportation method, and the package mass
 patch.estimates.createShippingEstimate({
-  distance_m: distance_m,
+  distance_m,
   transportation_method: 'air',
   package_mass_g: 1000
 });
 
+// Create a bitcoin estimate
+const transaction_value_btc_sats = 1000; // [Optional] Pass in the transaction value in satoshis
+patch.estimates.createBitcoinEstimate({
+  transaction_value_btc_sats
+});
+
 // Create a vehicle estimate
 const distance_m = 9000000;
 // Pass in the shipping distance in meters and the model/make/year of the vehicle
 patch.estimates.createVehicleEstimate({
-  distance_m: distance_m,
+  distance_m,
   make: 'Toyota',
   model: 'Corolla',
   year: 1995
@@ -184,7 +190,7 @@ Preferences are how you route your orders in Patch. If you don't have a preferen
 ```javascript
 // Create a preference
 const projectId = 'pro_test_1234'; // Pass in the project_id for your preference
-patch.preferences.createPreference((project_id: projectId));
+patch.preferences.createPreference({ project_id: projectId });
 
 // Retrieve a preference
 const preferenceId = 'pre_test_1234'; // Pass in the preferences's id
@@ -234,9 +240,13 @@ $ npm link @patch-technology/patch
 This will create a `node_modules` directory in your test repository which will symlink to your locally built package. To test out the package, open a node REPL and import the package and run some queries.
 
 ```sh
-$ node
-> const Patch = require('@patch-technology/patch')
-> Patch.default(process.env.SANDBOX_API_KEY).projects.retrieveProjects().then((response) => console.log(response))
+SANDBOX_API_KEY=xxx node
+```
+
+```node
+const Patch = require('@patch-technology/patch');
+const patch = Patch.default(process.env.SANDBOX_API_KEY);
+patch.projects.retrieveProjects().then((response) => console.log(response));
 ```
 
 ### Run the specs