From f6f65502f14fc0a15e04ca08978f60491a2d9722 Mon Sep 17 00:00:00 2001 From: jchen293 Date: Mon, 4 Dec 2023 15:56:17 -0500 Subject: [PATCH 1/2] prep v7 major release --- CHANGELOG.md | 2 +- UPGRADE_GUIDE.md | 19 +++++++++++++++++++ package-lock.json | 4 ++-- package.json | 2 +- 4 files changed, 23 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dbe24fc91..9c7ee99fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # CHANGELOG -## Next Release (Major Version) +## v7.0.0 (2023-12-06) - Remove `withCarbonOffset` parameter from shipment create and buy functions - Remove `carbon_offset` property of `Rate` object diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md index ca5d6b471..9049231aa 100644 --- a/UPGRADE_GUIDE.md +++ b/UPGRADE_GUIDE.md @@ -2,10 +2,29 @@ Use the following guide to assist in the upgrade process of the `easypost-node` library between major versions. +- [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 6.x to 7.0 + +### 7.0 High Impact Changes + +- [Carbon Offset Removed](#70-carbon-offset-removed) + +### 7.0 Low Impact Changes + +- [createAndBuy() Batch Function Removed](#70-createandbuy-batch-function-removed) + +### 7.0 Carbon Offset Removed + +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 `withCarbonOffset` parameter of the `create`, `buy`, and `regenerateRates` shipment functions have been removed as a result, as well as the overload functions that have `withCarbonOffset` parameter. This is a high-impact change for those using `EndShippers` as the function interfaces have changed. You will need to inspect the callsites to create and buy shipments to ensure that the EndShipper parameter is being passed in the correct place now that the `withCarbonOffset` parameter has been removed. + +### 7.0 createAndBuy Batch Function Removed + +The `createAndBuy` Batch endpoint has been deprecated and removed from the library. The correct procedure is to first create a batch and then purchase it with two separate API calls. + ## Upgrading from 5.x to 6.0 ### 6.0 High Impact Changes diff --git a/package-lock.json b/package-lock.json index a200fa794..4ed4b4026 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@easypost/api", - "version": "6.8.2", + "version": "7.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@easypost/api", - "version": "6.8.2", + "version": "7.0.0", "license": "MIT", "dependencies": { "core-js": "~3.30.2", diff --git a/package.json b/package.json index 212166669..36318849c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@easypost/api", "description": "EasyPost Node Client Library", - "version": "6.8.2", + "version": "7.0.0", "author": "Easypost Engineering ", "homepage": "https://easypost.com", "bin": { From 933c422f0241dc408024b33003a298e098708062 Mon Sep 17 00:00:00 2001 From: jchen293 Date: Mon, 4 Dec 2023 15:59:33 -0500 Subject: [PATCH 2/2] updated upgrade guide --- UPGRADE_GUIDE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md index 9049231aa..36a15c09b 100644 --- a/UPGRADE_GUIDE.md +++ b/UPGRADE_GUIDE.md @@ -27,6 +27,8 @@ The `createAndBuy` Batch endpoint has been deprecated and removed from the libra ## Upgrading from 5.x to 6.0 +**NOTICE:** v6 is deprecated. + ### 6.0 High Impact Changes - [Updating Dependencies](#60-updating-dependencies)