API version 2.1.0 See https://docs.patch.io/#/changelog for changes (#85)

venalen · web-flow · commit b4c80856ae65 · 2023-04-04T15:06:09.000-07:00
* API version 2.1.0 See https://docs.patch.io/#/changelog for changes * Update expected test results for estimates
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,18 @@ 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).
 
+## [2.1.0] - 2023-04-04
+
+### Added
+
+- Adds optional `vintage_start_year` and `vintage_end_year` fields to `order` creation
+- Adds optional `vintage_start_year` and `vintage_end_year` fields to `order_line_item` create and update
+- Adds optional `vintage_start_year` and `vintage_end_year` fields to `inventory` creation
+- Adds `vintage_start_year` and `vintage_end_year` fields to `order` response
+- Adds `vintage_start_year` and `vintage_end_year` fields to `order_line_item` response
+- Adds optional `carrier_scac` field to `patch.estimates.createRoadShippingEstimate`
+- Deprecates `createShippingEstimate` in favor of `createEcommerceEstimate`
+
 ## [1.24.2] - 2022-08-10
 
 ### Added
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@patch-technology/patch",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Node.js wrapper for the Patch API",
   "license": "MIT",
   "repository": {
diff --git a/src/ApiClient.js b/src/ApiClient.js
@@ -16,7 +16,7 @@ class ApiClient {
     };
 
     this.defaultHeaders = {
-      'User-Agent': 'patch-node/2.0.1',
+      'User-Agent': 'patch-node/2.1.0',
       'Patch-Version': 2
     };
 
diff --git a/src/model/CreateOrderLineItemRequest.js b/src/model/CreateOrderLineItemRequest.js
@@ -32,6 +32,20 @@ class CreateOrderLineItemRequest {
         );
       }
 
+      if (data.hasOwnProperty('vintage_start_year')) {
+        obj['vintage_start_year'] = ApiClient.convertToType(
+          data['vintage_start_year'],
+          'Number'
+        );
+      }
+
+      if (data.hasOwnProperty('vintage_end_year')) {
+        obj['vintage_end_year'] = ApiClient.convertToType(
+          data['vintage_end_year'],
+          'Number'
+        );
+      }
+
       if (data.hasOwnProperty('price')) {
         obj['price'] = ApiClient.convertToType(data['price'], 'Number');
       }
@@ -56,6 +70,10 @@ CreateOrderLineItemRequest.prototype['project_id'] = undefined;
 
 CreateOrderLineItemRequest.prototype['vintage_year'] = undefined;
 
+CreateOrderLineItemRequest.prototype['vintage_start_year'] = undefined;
+
+CreateOrderLineItemRequest.prototype['vintage_end_year'] = undefined;
+
 CreateOrderLineItemRequest.prototype['price'] = undefined;
 
 CreateOrderLineItemRequest.prototype['currency'] = undefined;
diff --git a/src/model/CreateOrderRequest.js b/src/model/CreateOrderRequest.js
@@ -41,6 +41,20 @@ class CreateOrderRequest {
         );
       }
 
+      if (data.hasOwnProperty('vintage_start_year')) {
+        obj['vintage_start_year'] = ApiClient.convertToType(
+          data['vintage_start_year'],
+          'Number'
+        );
+      }
+
+      if (data.hasOwnProperty('vintage_end_year')) {
+        obj['vintage_end_year'] = ApiClient.convertToType(
+          data['vintage_end_year'],
+          'Number'
+        );
+      }
+
       if (data.hasOwnProperty('total_price')) {
         obj['total_price'] = ApiClient.convertToType(
           data['total_price'],
@@ -76,6 +90,10 @@ CreateOrderRequest.prototype['state'] = undefined;
 
 CreateOrderRequest.prototype['vintage_year'] = undefined;
 
+CreateOrderRequest.prototype['vintage_start_year'] = undefined;
+
+CreateOrderRequest.prototype['vintage_end_year'] = undefined;
+
 CreateOrderRequest.prototype['total_price'] = undefined;
 
 CreateOrderRequest.prototype['currency'] = undefined;
diff --git a/src/model/CreateRoadShippingEstimateRequest.js b/src/model/CreateRoadShippingEstimateRequest.js
@@ -106,6 +106,13 @@ class CreateRoadShippingEstimateRequest {
         );
       }
 
+      if (data.hasOwnProperty('carrier_scac')) {
+        obj['carrier_scac'] = ApiClient.convertToType(
+          data['carrier_scac'],
+          'String'
+        );
+      }
+
       if (data.hasOwnProperty('project_id')) {
         obj['project_id'] = ApiClient.convertToType(
           data['project_id'],
@@ -152,6 +159,8 @@ CreateRoadShippingEstimateRequest.prototype['number_of_containers'] = undefined;
 
 CreateRoadShippingEstimateRequest.prototype['truck_weight_t'] = undefined;
 
+CreateRoadShippingEstimateRequest.prototype['carrier_scac'] = undefined;
+
 CreateRoadShippingEstimateRequest.prototype['project_id'] = undefined;
 
 CreateRoadShippingEstimateRequest.prototype['create_order'] = false;
diff --git a/src/model/Inventory.js b/src/model/Inventory.js
@@ -8,19 +8,40 @@
 import ApiClient from '../ApiClient';
 
 class Inventory {
-  constructor(vintageYear, amountAvailable, price, currency, unit) {
+  constructor(
+    vintageYear,
+    vintageStartYear,
+    vintageEndYear,
+    amountAvailable,
+    price,
+    currency,
+    unit
+  ) {
     Inventory.initialize(
       this,
       vintageYear,
+      vintageStartYear,
+      vintageEndYear,
       amountAvailable,
       price,
       currency,
       unit
     );
   }
 
-  static initialize(obj, vintageYear, amountAvailable, price, currency, unit) {
+  static initialize(
+    obj,
+    vintageYear,
+    vintageStartYear,
+    vintageEndYear,
+    amountAvailable,
+    price,
+    currency,
+    unit
+  ) {
     obj['vintage_year'] = vintageYear;
+    obj['vintage_start_year'] = vintageStartYear;
+    obj['vintage_end_year'] = vintageEndYear;
     obj['amount_available'] = amountAvailable;
     obj['price'] = price;
     obj['currency'] = currency;
@@ -38,6 +59,20 @@ class Inventory {
         );
       }
 
+      if (data.hasOwnProperty('vintage_start_year')) {
+        obj['vintage_start_year'] = ApiClient.convertToType(
+          data['vintage_start_year'],
+          'Number'
+        );
+      }
+
+      if (data.hasOwnProperty('vintage_end_year')) {
+        obj['vintage_end_year'] = ApiClient.convertToType(
+          data['vintage_end_year'],
+          'Number'
+        );
+      }
+
       if (data.hasOwnProperty('amount_available')) {
         obj['amount_available'] = ApiClient.convertToType(
           data['amount_available'],
@@ -63,6 +98,10 @@ class Inventory {
 
 Inventory.prototype['vintage_year'] = undefined;
 
+Inventory.prototype['vintage_start_year'] = undefined;
+
+Inventory.prototype['vintage_end_year'] = undefined;
+
 Inventory.prototype['amount_available'] = undefined;
 
 Inventory.prototype['price'] = undefined;
diff --git a/src/model/OrderLineItem.js b/src/model/OrderLineItem.js
@@ -9,21 +9,44 @@ import ApiClient from '../ApiClient';
 import OrderLineItemProject from './OrderLineItemProject';
 
 class OrderLineItem {
-  constructor(project, vintageYear, amount, unit, price, currency) {
+  constructor(
+    project,
+    vintageYear,
+    vintageStartYear,
+    vintageEndYear,
+    amount,
+    unit,
+    price,
+    currency
+  ) {
     OrderLineItem.initialize(
       this,
       project,
       vintageYear,
+      vintageStartYear,
+      vintageEndYear,
       amount,
       unit,
       price,
       currency
     );
   }
 
-  static initialize(obj, project, vintageYear, amount, unit, price, currency) {
+  static initialize(
+    obj,
+    project,
+    vintageYear,
+    vintageStartYear,
+    vintageEndYear,
+    amount,
+    unit,
+    price,
+    currency
+  ) {
     obj['project'] = project;
     obj['vintage_year'] = vintageYear;
+    obj['vintage_start_year'] = vintageStartYear;
+    obj['vintage_end_year'] = vintageEndYear;
     obj['amount'] = amount;
     obj['unit'] = unit;
     obj['price'] = price;
@@ -52,6 +75,20 @@ class OrderLineItem {
         );
       }
 
+      if (data.hasOwnProperty('vintage_start_year')) {
+        obj['vintage_start_year'] = ApiClient.convertToType(
+          data['vintage_start_year'],
+          'Number'
+        );
+      }
+
+      if (data.hasOwnProperty('vintage_end_year')) {
+        obj['vintage_end_year'] = ApiClient.convertToType(
+          data['vintage_end_year'],
+          'Number'
+        );
+      }
+
       if (data.hasOwnProperty('amount')) {
         obj['amount'] = ApiClient.convertToType(data['amount'], 'Number');
       }
@@ -78,6 +115,10 @@ OrderLineItem.prototype['project'] = undefined;
 
 OrderLineItem.prototype['vintage_year'] = undefined;
 
+OrderLineItem.prototype['vintage_start_year'] = undefined;
+
+OrderLineItem.prototype['vintage_end_year'] = undefined;
+
 OrderLineItem.prototype['amount'] = undefined;
 
 OrderLineItem.prototype['unit'] = undefined;
diff --git a/src/model/UpdateOrderLineItemRequest.js b/src/model/UpdateOrderLineItemRequest.js
@@ -25,6 +25,20 @@ class UpdateOrderLineItemRequest {
         );
       }
 
+      if (data.hasOwnProperty('vintage_start_year')) {
+        obj['vintage_start_year'] = ApiClient.convertToType(
+          data['vintage_start_year'],
+          'Number'
+        );
+      }
+
+      if (data.hasOwnProperty('vintage_end_year')) {
+        obj['vintage_end_year'] = ApiClient.convertToType(
+          data['vintage_end_year'],
+          'Number'
+        );
+      }
+
       if (data.hasOwnProperty('price')) {
         obj['price'] = ApiClient.convertToType(data['price'], 'Number');
       }
@@ -47,6 +61,10 @@ class UpdateOrderLineItemRequest {
 
 UpdateOrderLineItemRequest.prototype['vintage_year'] = undefined;
 
+UpdateOrderLineItemRequest.prototype['vintage_start_year'] = undefined;
+
+UpdateOrderLineItemRequest.prototype['vintage_end_year'] = undefined;
+
 UpdateOrderLineItemRequest.prototype['price'] = undefined;
 
 UpdateOrderLineItemRequest.prototype['currency'] = undefined;
diff --git a/test/integration/estimates.test.js b/test/integration/estimates.test.js
@@ -46,7 +46,7 @@ describe('Estimates Integration', function () {
     );
     const estimate = createEstimateResponse.data;
 
-    expect(estimate.type).to.be.eq('shipping');
+    expect(estimate.type).to.be.eq('ecommerce');
     expect(estimate.mass_g).to.be.above(0);
     expect(estimate.production).to.be.eq(false);
     expect(estimate.order).to.be.eq(null);
diff --git a/test/integration/orders.test.js b/test/integration/orders.test.js
diff --git a/test/integration/projects.test.js b/test/integration/projects.test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@patch-technology/patch",`
`3`		`- "version": "2.0.1",`
	`3`	`+ "version": "2.1.0",`
`4`	`4`	`"description": "Node.js wrapper for the Patch API",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"repository": {`