Skip to content

Commit

Permalink
Prep major release for v7.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jchen293 committed Dec 4, 2023
1 parent 76d1207 commit 5d01816
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add this to your project's POM:
<dependency>
<groupId>com.easypost</groupId>
<artifactId>easypost-api-client</artifactId>
<version>6.9.1</version>
<version>7.0.0</version>
</dependency>
```

Expand All @@ -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.
Expand Down
26 changes: 26 additions & 0 deletions UPGRADE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6.9.1
7.0.0
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<groupId>com.easypost</groupId>
<artifactId>easypost-api-client</artifactId>

<version>6.9.1</version>
<version>7.0.0</version>
<packaging>jar</packaging>

<name>com.easypost:easypost-api-client</name>
Expand Down

0 comments on commit 5d01816

Please sign in to comment.