Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.

- Drop support for Node 12, 13, 14, and 15
- Adds `webhook_secret` and `custom_headers` properties to Typescript definitions of a Webhook
Expand Down Expand Up @@ -73,6 +75,8 @@

## v7.0.0 (2023-12-06)

See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-6x-to-70) for more details.

- Removes `withCarbonOffset` parameter from shipment create and buy functions
- Removes `carbon_offset` property of `Rate` object
- Fixes a pagination issue by passing along additional params used when fetching first page
Expand Down Expand Up @@ -154,6 +158,8 @@

## v6.0.0 (2023-03-22)

See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-5x-to-60) for more details.

Includes all of the changes made in v6.0.0-rc1 below plus the following:

- Adds class properties to each model for autocomplete and explicit deserialization
Expand All @@ -168,7 +174,7 @@ Includes all of the changes made in v6.0.0-rc1 below plus the following:
- Overhauled the data flow of the library
- Instead of creating a local object and then calling `.save()` on it to create/update it at the API level, you will pass in the same data as before but to one of either `create()` or `update()` functions on the service in question
- The base service no longer implements all functions and instead each individual service implements its own functions. This means the library namespace won't be cluttered with various `notImplemented` functions
- All instance functions (excluding `lowestRate`) previously called on an object are instead called on a service. (eg: `shipment.buy(shipment.lowest_rate())` is now `client.Shipment.buy(shipment.id, shipment.lowest_rate())`))
- All instance functions (excluding `lowestRate`) previously called on an object are instead called on a service. (eg: `shipment.buy(shipment.lowest_rate())` is now `client.Shipment.buy(shipment.id, shipment.lowest_rate())`)
- All functions attached to a service are now async and must be awaited
- Moved library structure around
- Introduced `/models` that contain the EasyPost objects
Expand Down Expand Up @@ -274,6 +280,8 @@ Includes all of the changes made in v6.0.0-rc1 below plus the following:

## v5.0.0 (2022-04-13)

See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-4x-to-50) for more details.

### Breaking Changes

- Bumps the minimum version of Node to `v10`
Expand Down Expand Up @@ -312,6 +320,8 @@ Includes all of the changes made in v6.0.0-rc1 below plus the following:

## v4.0.0 (2021-10-06)

See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-3x-to-40) for more details.

- JSON encodes POST bodies instead of form encoding them by default
- Adds support for `tax_identifiers`
- The `regenerateRates` method now makes a post request to re-rate a shipment. The new `retrieveRates` will simply retrieve the rates of a shipment without re-rating
Expand Down
27 changes: 27 additions & 0 deletions UPGRADE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,40 @@

Use the following guide to assist in the upgrade process of the `easypost-node` 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

- [Updated Dependencies](#80-updated-dependencies)

### 8.0 Low Impact Changes

- [Removed repl](#80-removed-repl)

### 8.0 Updated Dependencies

Likelihood of Impact: **High**

Node 16+ is now required.

All dependencies had major version bumps.

### 8.0 Removed repl

Likelihood of Impact: **Low**

The undocumented and unmaintained `repl` has been removed.

## Upgrading from 6.x to 7.0

**NOTICE:** v7 is deprecated.

### 7.0 High Impact Changes

- [Carbon Offset Removed](#70-carbon-offset-removed)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@easypost/api",
"description": "EasyPost Node Client Library",
"version": "7.5.5",
"version": "8.0.0",
"author": "Easypost Engineering <[email protected]>",
"homepage": "https://easypost.com",
"exports": {
Expand Down