Skip to content

Commit bb20176

Browse files
authored
Merge pull request #324 from EasyPost/v7.0.0
chore: prep v7.0.0 for release
2 parents 20f94a5 + 1a08ed9 commit bb20176

File tree

3 files changed

+47
-8
lines changed

3 files changed

+47
-8
lines changed

CHANGELOG.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# CHANGELOG
22

3-
## Next Release
3+
## v7.0.0 (2025-04-28)
4+
5+
See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-6x-to-70) for more details.
46

57
- Adds Ruby 3.4 support
68
- Adds the following functions to assist ReferralCustomers add credit cards and bank accounts:
@@ -50,6 +52,8 @@
5052

5153
## v6.0.0 (2023-12-06)
5254

55+
See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-5x-to-60) for more details.
56+
5357
- 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
5458
- 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
5559
- Removes the undocumented `create_and_buy` function from the Batch service. The proper usage is to create a batch first and buy it separately

UPGRADE_GUIDE.md

+41-6
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,47 @@
22

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

5+
- [Upgrading from 6.x to 7.0](#upgrading-from-6x-to-70)
56
- [Upgrading from 5.x to 6.0](#upgrading-from-5x-to-60)
67
- [Upgrading from 4.x to 5.0](#upgrading-from-4x-to-50)
78
- [Upgrading from 3.x to 4.0](#upgrading-from-3x-to-40)
89

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+
942
## Upgrading from 5.x to 6.0
1043

44+
**NOTICE:** v6 is deprecated.
45+
1146
### 6.0 High Impact Changes
1247

1348
- [Carbon Offset Removed](#60-carbon-offset-removed)
@@ -156,18 +191,18 @@ Empty API response functions for `delete` return `true` instead of empty object
156191

157192
### 4.0 High Impact Changes
158193

159-
* [Updating Dependencies](#40-updating-dependencies)
194+
- [Updating Dependencies](#40-updating-dependencies)
160195

161196
### 4.0 Medium Impact Changes
162197

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)
164199

165200
### 4.0 Low Impact Changes
166201

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)
171206

172207
## 4.0 Updating Dependencies
173208

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.4.1
1+
7.0.0

0 commit comments

Comments
 (0)