From 5d0181612ae9ad7a2d26173538b4a0ef9a45a82d Mon Sep 17 00:00:00 2001 From: jchen293 Date: Mon, 4 Dec 2023 14:24:43 -0500 Subject: [PATCH] Prep major release for v7.0.0 --- CHANGELOG.md | 2 +- README.md | 4 ++-- UPGRADE_GUIDE.md | 26 ++++++++++++++++++++++++++ VERSION | 2 +- pom.xml | 2 +- 5 files changed, 31 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d85b6e7d..1969ca307 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # CHANGELOG -## Next Major Release +## v7.0.0 (2023-12-06) - Removes `withCarbonOffset` parameter from `create`, `buy`, and `regenerateRates` functions of the Shipment service as EasyPost now offers Carbon Neutral shipments by default for free - Removes the undocumented `createAndBuy` function from the Batch service. The proper usage is to create a batch first and buy it separately diff --git a/README.md b/README.md index c49e3b57a..f942e29d4 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Add this to your project's POM: com.easypost easypost-api-client - 6.9.1 + 7.0.0 ``` @@ -25,7 +25,7 @@ Add this to your project's POM: Add this to your project's build file: ```groovy -implementation "com.easypost:easypost-api-client:6.9.1" +implementation "com.easypost:easypost-api-client:7.0.0" ``` **NOTE:** [Google Gson](http://code.google.com/p/google-gson/) is required. diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md index 78fa54ef7..b4a5a3703 100644 --- a/UPGRADE_GUIDE.md +++ b/UPGRADE_GUIDE.md @@ -2,11 +2,37 @@ Use the following guide to assist in the upgrade process of the `easypost-java` library between major versions. +- [Upgrading from 6.x to 7.x](#upgrading-from-6x-to-70) - [Upgrading from 5.x to 6.0](#upgrading-from-5x-to-60) - [Upgrading from 4.x to 5.0](#upgrading-from-4x-to-50) +## Upgrading from 6.x to 7.0 + +### 7.0 High Impact Changes + +- [Carbon Offset Removed](#70-carbon-offset-removed) + +### 7.0 Low Impact Changes + +- [createAndBuy() Batch Function Removed](#70-createandbuy-batch-function-removed) +- [Change return type of all() function in webhook service](#70-change-return-type-of-all-function-in-webhook-service) + +### 7.0 Carbon Offset Removed + +EasyPost now offers Carbon Neutral shipments by default for free! Because of this, there is no longer a need to specify if you want to offset the carbon footprint of a shipment. The `withCarbonOffset` parameter of the `create`, `buy`, and `regenerateRates` shipment functions have been removed as a result, as well as the overload functions that have `withCarbonOffset` parameter. This is a high-impact change for those using `EndShippers` as the function interfaces have changed. You will need to inspect the callsites to create and buy shipments to ensure that the EndShipper parameter is being passed in the correct place now that the `withCarbonOffset` parameter has been removed. + +### 7.0 createAndBuy Batch Function Removed + +The `createAndBuy` Batch endpoint has been deprecated and removed from the library. The correct procedure is to first create a batch and then purchase it with two separate API calls. + +### 7.0 Change return type of all function in webhook service + +The return type of `all` function in webhook service has been changed from `WebhookCollection` to `a list of webhooks`, the reason of this change is this endpoint returns a unpaginated list of webhooks. Therefore, there is no need to have `WebhookCollection` class which wraps the list of webhooks. + ## Upgrading from 5.x to 6.0 +**NOTICE:** v6 is deprecated. + ### 6.0 High Impact Changes - [Client Instance](#60-client-instance) diff --git a/VERSION b/VERSION index dc3829f5e..66ce77b7e 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -6.9.1 +7.0.0 diff --git a/pom.xml b/pom.xml index 13ef32f88..1fb4be0bd 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ com.easypost easypost-api-client - 6.9.1 + 7.0.0 jar com.easypost:easypost-api-client