Skip to content

v5.0.0
Compare
Choose a tag to compare
@Justintime50 Justintime50 released this 15 May 21:10
· 152 commits to master since this release
v5.0.0
5e2919c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

This is a major version bump with a significant number of breaking changes. Please reference our Upgrade Guide for details about the changes.

With this release, v4 of the client library is now deprecated.

Breaking Changes

  • All API-calling functions on models have been moved to their respective services. For example, myPickup.Buy() is now myClient.Pickup.Buy(myPickup.Id).
  • Client constructor now takes a ClientConfiguration object rather than a list of parameters.
    • Client myClient = new Client("my_api_key"); is now Client myClient = new Client(new ClientConfiguration("my_api_key"));
  • Smartrate is now SmartRate
  • myClient.Clone functionality has been removed. Please construct a new Client object instead.
  • RestSharp dependency has been dropped entirely.
  • Renamed UnexpectedHttpError exception type to UnknownHttpError to better reflect its purpose.
  • Removed UnknownApiError exception type, consolidated into UnknownHttpError exception type.
  • ExternalApiError no longer inherits from ApiError (ApiError reserved for EasyPost API errors only).
  • All EasyPostError exceptions and subclasses now have a PrettyPrint getter that returns a human-readable string representation of the error.
    • Previously, only ApiError exceptions had this. Now, all exceptions thrown by the library should have this.
  • Logic for calculating exception type to throw based on API error
    • EasyPost API failures can trigger a variety of specific exceptions, all inheriting from ApiError.
    • Non-EasyPost API/HTTP failures will trigger an ExternalApiError exception.

New Features

  • Parameter sets are out of beta. Users can use access them via EasyPost.Parameters namespace.
    • Previous plural namespaces are now singular (eg: Parameters.Addresses is now Parameters.Address)
  • All API-calling functions accept an optional CancellationToken parameter that can be used to cancel the request.
  • Reintroduce GenerateForm function for shipments that was accidentally removed in v4.
  • All EasyPostClient-based classes, all EasyPostService-based classes, ClientConfiguration and internal request classes are now explicitly disposable.

Miscellaneous

  • Add missing Declaration parameter to Customs Info creation parameter set
  • Handle API timeout errors more gracefully (produce proper TimeoutError exception with readable messages)
  • myClient.Webhook.Update function now has an optional Parameters.Webhook.Update parameter (rather than required)
  • All aspects of the library have been documented with XML comments
Assets 3
Loading