Add patch.estimates methods for GLEC-certified shipping estimates (#72)

* Add patch.estimates methods for GLEC-certified shipping estimates

* Add changelog update

* Remove all changes to orders

* Update constants and variable names

* Remove distance_m

* Lower threshold to ensure no flakes

Author: Brett Holt

CHANGELOG.md

@@ -5,11 +5,20 @@ 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.24.0] - 2022-07-22
+
+### Added
+
+- Adds `patch.estimates.create_air_shipping_estimate` method
+- Adds `patch.estimates.create_rail_shipping_estimate` method
+- Adds `patch.estimates.create_road_shipping_estimate` method
+- Adds `patch.estimates.create_sea_shipping_estimate` method
+
 ## [1.23.0] - 2022-06-03
 
 ### Added
 
-- Adds support for the `issuedTo` parameter on `orders`, to add support for creating and placing orders on behalf of another party.
+- Adds support for the `issued_to` parameter on `orders`, to add support for creating and placing orders on behalf of another party.
 
 ## [1.22.0] - 2022-05-16
 

README.md

@@ -77,11 +77,11 @@ const totalPrice = 500; // Pass in the total price in smallest currency unit (ie
 const currency = 'USD';
 patch.orders.createOrder({ total_price: totalPrice, currency: currency });
 
-// Create order with the issuedTo field (optional)
+// Create order with the issued_to field (optional)
 const amount = 1_000_000; // Pass in the amount in unit specified
 const unit = 'g';
-const issuedTo = { email: 'issuee@companya.com', name: 'Olivia Jones' };
-patch.orders.createOrder({ amount: amount, unit: unit, issuedTo: issuedTo });
+const issued_to = { email: 'issuee@companya.com', name: 'Olivia Jones' };
+patch.orders.createOrder({ amount: amount, unit: unit, issued_to: issued_to });
 
 // Retrieve an order
 orderId = 'ord_test_1234'; // Pass in the order's id
@@ -91,10 +91,10 @@ patch.orders.retrieveOrder(orderId);
 const orderId = 'ord_test_1234'; // Pass in the order's id
 patch.orders.placeOrder(orderId);
 
-// Place an order with the issuedTo field (optional)
+// Place an order with the issued_to field (optional)
 const orderId = 'ord_test_1234'; // Pass in the order's id
-const issuedTo = { email: 'issuee@companya.com', name: 'Olivia Jones' };
-patch.orders.placeOrder(orderId, { issuedTo: issuedTo });
+const issued_to = { email: 'issuee@companya.com', name: 'Olivia Jones' };
+patch.orders.placeOrder(orderId, { issued_to: issued_to });
 
 // Cancel an order
 const orderId = 'ord_test_1234'; // Pass in the order's id

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@patch-technology/patch",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "description": "Node.js wrapper for the Patch API",
   "license": "MIT",
   "repository": {

package.json

@@ -16,7 +16,7 @@ class ApiClient {
     };
 
     this.defaultHeaders = {
-      'User-Agent': 'patch-node/1.23.0'
+      'User-Agent': 'patch-node/1.24.0'
     };
 
     /**

src/ApiClient.js

@@ -6,11 +6,15 @@
  */
 
 import ApiClient from '../ApiClient';
+import CreateAirShippingEstimateRequest from '../model/CreateAirShippingEstimateRequest';
 import CreateBitcoinEstimateRequest from '../model/CreateBitcoinEstimateRequest';
 import CreateEthereumEstimateRequest from '../model/CreateEthereumEstimateRequest';
 import CreateFlightEstimateRequest from '../model/CreateFlightEstimateRequest';
 import CreateHotelEstimateRequest from '../model/CreateHotelEstimateRequest';
 import CreateMassEstimateRequest from '../model/CreateMassEstimateRequest';
+import CreateRailShippingEstimateRequest from '../model/CreateRailShippingEstimateRequest';
+import CreateRoadShippingEstimateRequest from '../model/CreateRoadShippingEstimateRequest';
+import CreateSeaShippingEstimateRequest from '../model/CreateSeaShippingEstimateRequest';
 import CreateShippingEstimateRequest from '../model/CreateShippingEstimateRequest';
 import CreateVehicleEstimateRequest from '../model/CreateVehicleEstimateRequest';
 import ErrorResponse from '../model/ErrorResponse';
@@ -22,6 +26,55 @@ export default class EstimatesApi {
     this.apiClient = apiClient || ApiClient.instance;
   }
 
+  createAirShippingEstimateWithHttpInfo(createAirShippingEstimateRequest) {
+    const _createAirShippingEstimateRequest =
+      CreateAirShippingEstimateRequest.constructFromObject(
+        createAirShippingEstimateRequest,
+        new CreateAirShippingEstimateRequest()
+      );
+    let postBody = _createAirShippingEstimateRequest;
+
+    // verify the required parameter 'createAirShippingEstimateRequest' is set
+    if (
+      _createAirShippingEstimateRequest === undefined ||
+      _createAirShippingEstimateRequest === null
+    ) {
+      throw new Error(
+        "Missing the required parameter 'createAirShippingEstimateRequest' when calling createAirShippingEstimate"
+      );
+    }
+
+    let pathParams = {};
+    let queryParams = {};
+    let headerParams = {};
+    let formParams = {};
+
+    let authNames = ['bearer_auth'];
+    let contentTypes = ['application/json'];
+    let accepts = ['application/json'];
+    let returnType = EstimateResponse;
+
+    return this.apiClient.callApi(
+      '/v1/estimates/shipping/air',
+      'POST',
+      pathParams,
+      queryParams,
+      headerParams,
+      formParams,
+      postBody,
+      authNames,
+      contentTypes,
+      accepts,
+      returnType
+    );
+  }
+
+  createAirShippingEstimate(createAirShippingEstimateRequest) {
+    return this.createAirShippingEstimateWithHttpInfo(
+      createAirShippingEstimateRequest
+    );
+  }
+
   createBitcoinEstimateWithHttpInfo(createBitcoinEstimateRequest) {
     const _createBitcoinEstimateRequest =
       CreateBitcoinEstimateRequest.constructFromObject(
@@ -259,6 +312,153 @@ export default class EstimatesApi {
     return this.createMassEstimateWithHttpInfo(createMassEstimateRequest);
   }
 
+  createRailShippingEstimateWithHttpInfo(createRailShippingEstimateRequest) {
+    const _createRailShippingEstimateRequest =
+      CreateRailShippingEstimateRequest.constructFromObject(
+        createRailShippingEstimateRequest,
+        new CreateRailShippingEstimateRequest()
+      );
+    let postBody = _createRailShippingEstimateRequest;
+
+    // verify the required parameter 'createRailShippingEstimateRequest' is set
+    if (
+      _createRailShippingEstimateRequest === undefined ||
+      _createRailShippingEstimateRequest === null
+    ) {
+      throw new Error(
+        "Missing the required parameter 'createRailShippingEstimateRequest' when calling createRailShippingEstimate"
+      );
+    }
+
+    let pathParams = {};
+    let queryParams = {};
+    let headerParams = {};
+    let formParams = {};
+
+    let authNames = ['bearer_auth'];
+    let contentTypes = ['application/json'];
+    let accepts = ['application/json'];
+    let returnType = EstimateResponse;
+
+    return this.apiClient.callApi(
+      '/v1/estimates/shipping/rail',
+      'POST',
+      pathParams,
+      queryParams,
+      headerParams,
+      formParams,
+      postBody,
+      authNames,
+      contentTypes,
+      accepts,
+      returnType
+    );
+  }
+
+  createRailShippingEstimate(createRailShippingEstimateRequest) {
+    return this.createRailShippingEstimateWithHttpInfo(
+      createRailShippingEstimateRequest
+    );
+  }
+
+  createRoadShippingEstimateWithHttpInfo(createRoadShippingEstimateRequest) {
+    const _createRoadShippingEstimateRequest =
+      CreateRoadShippingEstimateRequest.constructFromObject(
+        createRoadShippingEstimateRequest,
+        new CreateRoadShippingEstimateRequest()
+      );
+    let postBody = _createRoadShippingEstimateRequest;
+
+    // verify the required parameter 'createRoadShippingEstimateRequest' is set
+    if (
+      _createRoadShippingEstimateRequest === undefined ||
+      _createRoadShippingEstimateRequest === null
+    ) {
+      throw new Error(
+        "Missing the required parameter 'createRoadShippingEstimateRequest' when calling createRoadShippingEstimate"
+      );
+    }
+
+    let pathParams = {};
+    let queryParams = {};
+    let headerParams = {};
+    let formParams = {};
+
+    let authNames = ['bearer_auth'];
+    let contentTypes = ['application/json'];
+    let accepts = ['application/json'];
+    let returnType = EstimateResponse;
+
+    return this.apiClient.callApi(
+      '/v1/estimates/shipping/road',
+      'POST',
+      pathParams,
+      queryParams,
+      headerParams,
+      formParams,
+      postBody,
+      authNames,
+      contentTypes,
+      accepts,
+      returnType
+    );
+  }
+
+  createRoadShippingEstimate(createRoadShippingEstimateRequest) {
+    return this.createRoadShippingEstimateWithHttpInfo(
+      createRoadShippingEstimateRequest
+    );
+  }
+
+  createSeaShippingEstimateWithHttpInfo(createSeaShippingEstimateRequest) {
+    const _createSeaShippingEstimateRequest =
+      CreateSeaShippingEstimateRequest.constructFromObject(
+        createSeaShippingEstimateRequest,
+        new CreateSeaShippingEstimateRequest()
+      );
+    let postBody = _createSeaShippingEstimateRequest;
+
+    // verify the required parameter 'createSeaShippingEstimateRequest' is set
+    if (
+      _createSeaShippingEstimateRequest === undefined ||
+      _createSeaShippingEstimateRequest === null
+    ) {
+      throw new Error(
+        "Missing the required parameter 'createSeaShippingEstimateRequest' when calling createSeaShippingEstimate"
+      );
+    }
+
+    let pathParams = {};
+    let queryParams = {};
+    let headerParams = {};
+    let formParams = {};
+
+    let authNames = ['bearer_auth'];
+    let contentTypes = ['application/json'];
+    let accepts = ['application/json'];
+    let returnType = EstimateResponse;
+
+    return this.apiClient.callApi(
+      '/v1/estimates/shipping/sea',
+      'POST',
+      pathParams,
+      queryParams,
+      headerParams,
+      formParams,
+      postBody,
+      authNames,
+      contentTypes,
+      accepts,
+      returnType
+    );
+  }
+
+  createSeaShippingEstimate(createSeaShippingEstimateRequest) {
+    return this.createSeaShippingEstimateWithHttpInfo(
+      createSeaShippingEstimateRequest
+    );
+  }
+
   createShippingEstimateWithHttpInfo(createShippingEstimateRequest) {
     const _createShippingEstimateRequest =
       CreateShippingEstimateRequest.constructFromObject(