[v.1.3.0] Add support for Flight/Vehicle/Shipping estimates (#21)

Author: biglovisa

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,7 +9,7 @@
 ### SDK Release Checklist
 
 - [ ] Have you added an integration test for the changes?
-- [ ] Have you built the gem locally and made queries against it successfully?
+- [ ] Have you built the package locally and made queries against it successfully?
 - [ ] Did you update the changelog?
 - [ ] Did you bump the package version?
 - [ ] For breaking changes, did you plan for the release of the new SDK versions and deploy the API to production?

CHANGELOG.md

@@ -5,7 +5,11 @@ 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).
 
-## [Unreleased]
+## [1.3.0] - 2020-02-08
+
+### Added
+
+- Adds support for creating carbon emission estimates for flights, shipping, and vehicles. See the [docs](https://docs.usepatch.com/#/?id=estimates) for more information.
 
 ## [1.2.5] - 2020-01-07
 

README.md

@@ -101,10 +101,33 @@ Estimates allow API users to get a quote for the cost of compensating a certain
 #### Examples
 
 ```javascript
-// Create an estimate
+// Create a mass estimate
 const mass = 1000000; // Pass in the mass in grams (i.e. 1 metric tonne)
 patch.estimates.createMassEstimate({ mass_g: mass });
 
+// Create a flight estimate
+const distance_m = 9000000; // Pass in the distance traveled in meters
+patch.estimates.createFlightEstimate({ distance_m: 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.createFlightEstimate({
+  distance_m: distance_m,
+  transportation_method: 'air',
+  package_mass_g: 1000
+});
+
+// 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.createFlightEstimate({
+  distance_m: distance_m,
+  make: 'Toyota',
+  model: 'Corolla',
+  year: 1995
+});
+
 // Retrieve an estimate
 const estimateId = 'est_test_1234';
 patch.estimates.retrieveEstimate(estimate_id);