|
2 | 2 |
|
3 | 3 | Use the following guide to assist in the upgrade process of the `easypost-ruby` library between major versions. |
4 | 4 |
|
| 5 | +- [Upgrading from 5.x to 6.0](#upgrading-from-5x-to-60) |
5 | 6 | - [Upgrading from 4.x to 5.0](#upgrading-from-4x-to-50) |
6 | 7 | - [Upgrading from 3.x to 4.0](#upgrading-from-3x-to-40) |
7 | 8 |
|
| 9 | +## Upgrading from 5.x to 6.0 |
| 10 | + |
| 11 | +### 6.0 High Impact Changes |
| 12 | + |
| 13 | +- [Carbon Offset Removed](#60-carbon-offset-removed) |
| 14 | + |
| 15 | +### 6.0 Low Impact Changes |
| 16 | + |
| 17 | +- [Create and Buy Batch Function Removed](#60-create-and-buy-batch-function-removed) |
| 18 | + |
| 19 | +## 6.0 Carbon Offset Removed |
| 20 | + |
| 21 | +*Likelihood of Impact: **High*** |
| 22 | + |
| 23 | +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. |
| 24 | + |
| 25 | +The `with_carbon_offset` parameter of the `create`, `buy`, and `regenerate_rates` shipment functions has been removed. |
| 26 | + |
| 27 | +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. |
| 28 | + |
| 29 | +## 6.0 Create and Buy Batch Function Removed |
| 30 | + |
| 31 | +*Likelihood of Impact: **Low*** |
| 32 | + |
| 33 | +The `create_and_buy` batch endpoint has been deprecated, and the `create_and_buy` Batch service function has been removed. |
| 34 | + |
| 35 | +The correct procedure is to first create a batch and then purchase it with two separate API calls. |
| 36 | + |
8 | 37 | ## Upgrading from 4.x to 5.0 |
9 | 38 |
|
| 39 | +**NOTICE:** v5 is deprecated. |
| 40 | + |
10 | 41 | ### 5.0 High Impact Changes |
11 | 42 |
|
12 | 43 | - [New Client object](#50-thread-safe-with-client-object) |
|
0 commit comments