diff --git a/CHANGELOG.md b/CHANGELOG.md index ba9a175c..3279e0ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # CHANGELOG -## Next Release +## v8.0.0 (2025-04-28) + +See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-7x-to-80) for more details. - Drops support for PHP 8.0 - Adds `custom_headers` property to webhook model @@ -19,7 +21,7 @@ - Corrects the `param` references to `property` references on all error models - Adds new `AddressVerificationFieldError` for the `errors` property on a `Verification` model - Adds missing `suggestion` property to `FieldError` -- Removes deprecated `createList` tracker endpoint function as it is no longer available via API +- Removes deprecated `tracker.createList` endpoint function as it is no longer available via API - Removes deprecated `user.allApiKeys` and `user.apiKeys`, use `apiKey.all` and `apiKey.retrieveApiKeysForUser` respectively - Bump deps @@ -52,7 +54,7 @@ ## v7.0.0 (2023-12-01) -Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md). +See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-6x-to-70) for more details. - Drops support for PHP 7.4 - Adds support for PHP 8.3 @@ -127,7 +129,7 @@ Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_G ## v6.0.0 (2023-01-05) -Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md). +See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-5x-to-60) for more details. - Release final version of v6 that contains all the changes in the `v6.0.0-rc1` below @@ -224,7 +226,7 @@ Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_G ## v5.0.0 (2022-02-09) -Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md). +See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-4x-to-50) for more details. - Bumped minimum PHP version supported from `5.3` to `7.3` - Adds a full test suite, all functions are now tested for each object @@ -252,7 +254,7 @@ Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_G ## v4.0.0 (2021-10-06) -Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md). +See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-3x-to-40) for more details. - JSON encodes POST bodies instead of form encoding them - Adds TaxIdentifier support diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md index 493aad0d..6625fc91 100644 --- a/UPGRADE_GUIDE.md +++ b/UPGRADE_GUIDE.md @@ -2,13 +2,49 @@ Use the following guide to assist in the upgrade process of the `easypost-php` library between major versions. +- [Upgrading from 7.x to 8.0](#upgrading-from-7x-to-80) - [Upgrading from 6.x to 7.0](#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 3.x to 4.0](#upgrading-from-3x-to-40) +## Upgrading from 7.x to 8.0 + +### 8.0 High Impact Changes + +- [Drop Support for PHP 8.0](#80-drop-support-for-php-80) +- [Error Parsing](#80-error-parsing) + +### 8.0 Medium Impact Changes + +- [Deprecations](#80-deprecations) + +### 8.0 Drop Support for PHP 8.0 + +*Likelihood of Impact: **High*** + +This library now requires PHP 8.1 or greater. + +## 8.0 Error Parsing + +*Likelihood of Impact: **High*** + +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. + +## 8.0 Deprecations + +*Likelihood of Impact: **Medium*** + +The following deprecated functions have been removed: + +- `tracker.createList` (trackers must be created individually moving forward) +- `user.allApiKeys` (use `apiKey.all`) +- `user.apiKeys` (use `apiKey.retrieveApiKeysForUser`) + ## Upgrading from 6.x to 7.0 +**NOTICE:** v7 is deprecated. + ### 7.0 High Impact Changes - [Drop Support for PHP 7.4](#70-drop-support-for-php-74) diff --git a/composer.json b/composer.json index 1a02add0..b23829e5 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "easypost/easypost-php", "description": "EasyPost Shipping API Client Library for PHP", - "version": "7.4.2", + "version": "8.0.0", "keywords": [ "shipping", "api", diff --git a/lib/EasyPost/Constant/Constants.php b/lib/EasyPost/Constant/Constants.php index 67b39dd0..231e60e2 100644 --- a/lib/EasyPost/Constant/Constants.php +++ b/lib/EasyPost/Constant/Constants.php @@ -11,7 +11,7 @@ abstract class Constants const BETA_API_VERSION = 'beta'; // Library constants - const LIBRARY_VERSION = '7.4.2'; + const LIBRARY_VERSION = '8.0.0'; const SUPPORT_EMAIL = 'support@easypost.com'; // Validation