Skip to content

Commit

Permalink
- Prep for v6.0.0 release (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
nwithan8 committed Dec 4, 2023
1 parent ef38ca5 commit f2a98db
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 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 release
## v6.0.0 (2023-12-06)

- Removes `with_carbon_offset` parameter from `create`, `buy` and `regenerate_rates` methods in the shipment service since now EasyPost offers carbon neutral shipments by default for free
- Fixes a bug where the original filtering criteria of `all` calls wasn't passed along to `get_next_page` calls. Now, these are persisted via `_params` key on response objects
Expand Down
31 changes: 31 additions & 0 deletions UPGRADE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,42 @@

Use the following guide to assist in the upgrade process of the `easypost-ruby` library between major versions.

- [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 3.x to 4.0](#upgrading-from-3x-to-40)

## Upgrading from 5.x to 6.0

### 6.0 High Impact Changes

- [Carbon Offset Removed](#60-carbon-offset-removed)

### 6.0 Low Impact Changes

- [Create and Buy Batch Function Removed](#60-create-and-buy-batch-function-removed)

## 6.0 Carbon Offset Removed

*Likelihood of Impact: **High***

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 `with_carbon_offset` parameter of the `create`, `buy`, and `regenerate_rates` shipment functions has been removed.

This is a high-impact change for those using `EndShippers`, as the signature for the `create` and `buy` shipment function has changed. You will need to inspect these callsites to ensure that the EndShipper parameter is being passed in the correct place.

## 6.0 Create and Buy Batch Function Removed

*Likelihood of Impact: **Low***

The `create_and_buy` batch endpoint has been deprecated, and the `create_and_buy` Batch service function has been removed.

The correct procedure is to first create a batch and then purchase it with two separate API calls.

## Upgrading from 4.x to 5.0

**NOTICE:** v5 is deprecated.

### 5.0 High Impact Changes

- [New Client object](#50-thread-safe-with-client-object)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5.3.0
6.0.0

0 comments on commit f2a98db

Please sign in to comment.