|
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 6.x to 7.0](#upgrading-from-6x-to-70) |
5 | 6 | - [Upgrading from 5.x to 6.0](#upgrading-from-5x-to-60)
|
6 | 7 | - [Upgrading from 4.x to 5.0](#upgrading-from-4x-to-50)
|
7 | 8 | - [Upgrading from 3.x to 4.0](#upgrading-from-3x-to-40)
|
8 | 9 |
|
| 10 | +## Upgrading from 6.x to 7.0 |
| 11 | + |
| 12 | +### 7.0 High Impact Changes |
| 13 | + |
| 14 | +- [Error Parsing](#70-error-parsing) |
| 15 | + |
| 16 | +### 7.0 Medium Impact Changes |
| 17 | + |
| 18 | +- [Deprecations](#70-deprecations) |
| 19 | + |
| 20 | +## 7.0 Error Parsing |
| 21 | + |
| 22 | +*Likelihood of Impact: **High*** |
| 23 | + |
| 24 | +The `errors` key of an error response can return either a list of `FieldError` objects or a list of strings. The error parsing has been expanded to include both formats. As such, you will now need to check for the format of the `errors` field and handle the errors appropriately for the type that is returned. |
| 25 | + |
| 26 | +The `Error` model has been removed since it is unused and we directly assign properties of an error response to the `ApiError` type. |
| 27 | + |
| 28 | +The `code` and `field` properties of an `EasyPostError` have been removed as they only belong to the `ApiError` type. |
| 29 | + |
| 30 | +## 7.0 Deprecations |
| 31 | + |
| 32 | +*Likelihood of Impact: **Medium*** |
| 33 | + |
| 34 | +The following deprecated functions have been removed: |
| 35 | + |
| 36 | +- `tracker.create_list` (trackers must be created individually moving forward) |
| 37 | +- `user.all_api_keys` (use `api_key.all`) |
| 38 | +- `user.api_keys` (use `api_key.retrieve_api_keys_for_user`) |
| 39 | + |
| 40 | +The `irb` has been removed from this library. |
| 41 | + |
9 | 42 | ## Upgrading from 5.x to 6.0
|
10 | 43 |
|
| 44 | +**NOTICE:** v6 is deprecated. |
| 45 | + |
11 | 46 | ### 6.0 High Impact Changes
|
12 | 47 |
|
13 | 48 | - [Carbon Offset Removed](#60-carbon-offset-removed)
|
@@ -156,18 +191,18 @@ Empty API response functions for `delete` return `true` instead of empty object
|
156 | 191 |
|
157 | 192 | ### 4.0 High Impact Changes
|
158 | 193 |
|
159 |
| -* [Updating Dependencies](#40-updating-dependencies) |
| 194 | +- [Updating Dependencies](#40-updating-dependencies) |
160 | 195 |
|
161 | 196 | ### 4.0 Medium Impact Changes
|
162 | 197 |
|
163 |
| -* [Removal of `get_rates` Shipment Method](#40-removal-of-getrates-shipment-method) |
| 198 | +- [Removal of `get_rates` Shipment Method](#40-removal-of-getrates-shipment-method) |
164 | 199 |
|
165 | 200 | ### 4.0 Low Impact Changes
|
166 | 201 |
|
167 |
| -* [Removal of `Print` and `PrintJob` Objects](#40-removal-of-print-and-printjob-objects) |
168 |
| -* [Removal of `stamp_and_barcode_by_reference` Batch Method](#40-removal-of-stampandbarcodebyreference-batch-method) |
169 |
| -* [Removal of `Address.verify` Parameters](#40-removal-of-addressverify-parameters) |
170 |
| -* [Removal of the `http_status` Property on EasyPost::Error](#40-removal-of-httpstatus-property-on-easyposterror) |
| 202 | +- [Removal of `Print` and `PrintJob` Objects](#40-removal-of-print-and-printjob-objects) |
| 203 | +- [Removal of `stamp_and_barcode_by_reference` Batch Method](#40-removal-of-stampandbarcodebyreference-batch-method) |
| 204 | +- [Removal of `Address.verify` Parameters](#40-removal-of-addressverify-parameters) |
| 205 | +- [Removal of the `http_status` Property on EasyPost::Error](#40-removal-of-httpstatus-property-on-easyposterror) |
171 | 206 |
|
172 | 207 | ## 4.0 Updating Dependencies
|
173 | 208 |
|
|
0 commit comments