CHANGELOG

v6.8.1 (2024-10-31)

Fixes HTTP query parameter serialization bug causing TrackingCodes to be ignored when listing trackers

v6.8.0 (2024-10-22)

Removes the deprecated CreateList Tracker function as it is no longer available via API
Adds TrackingCodes optional parameter to Tracker.All parameter set for listing trackers
Adds RestrictionComments optional parameter to CustomsInfo.Create parameter set and enforces usage if RestrictionType is not "none"

v6.7.3 (2024-09-17)

Corrects all API documentation link references to point to their new locations
Fix recursion during disposal causing stack overflow

v6.7.2 (2024-08-16)

Fix inclusion of Verify and VerifyStrict parameters when creating an Address as part of a larger object creation (e.g. Shipment, Order, etc.)

v6.7.1 (2024-08-09)

Fix pagination parameters for GetNextPageOfChildren function for User service

v6.7.0 (2024-07-24)

Add new Claim service for filing claims on EasyPost shipments and insurances

v6.6.0 (2024-07-16)

Add new SmartRate service for interacting with the SmartRate API
- New RecommendShipDateForShipment function to recommend ship date for a shipment based on a desired delivery date.
- New EstimateDeliveryDateForRoute function to estimate delivery date based on a list of carriers, to/from ZIP codes and a planned ship date (no existing shipment required).
- New RecommendShipDateForRoute function to to recommend ship date based on a list of carriers, to/from ZIP codes and a planned ship date (no existing shipment required).
- New model classes as needed for JSON response to new API functions
Enforce one-or-other for Shipment and Batch parameters in Pickup.Create parameter set
Add internal parameter dependency utility

v6.5.2 (2024-06-12)

Fix Shipment parameter requirement for Pickup.Create parameter set

v6.5.1 (2024-06-10)

Fix Batch object not allowed to be used in parameter sets due to missing IBatchParameter inheritance

v6.5.0 (2024-06-05)

Add missing parameters for CustomsItem.Create parameter set

v6.4.0 (2024-05-01)

Add missing parameters for Order.Create parameter set

v6.3.1 (2024-04-12)

Fix CarrierFields serialization bug causing carrier account operations to fail
Fix accessibility for CreateFedExSmartPost parameter set

v6.3.0 (2024-04-10)

Add Refund function in insurance service for requesting a refund for standalone insurance.
Fix payment method funding and deletion failures due to undetermined payment method type
Fix ToString method for EasyPostObject- and EphemeralEasyPostObject-based objects to return object type and optional ID

v6.2.1 (2024-03-18)

Fix serialization bug for carrier accounts parameter on RetrieveStatelessRates parameter set

v6.2.0 (2024-02-07)

Mark some unused parameters for various All functions as obsolete
- These will be removed in a later version. It is recommended to stop using these parameters immediately.

v6.1.0 (2024-01-08)

Add AllChildren and GetNextPageOfChildren functions to User service

v6.0.0 (2023-12-06)

No changes since v6.0.0-rc1, see below.

v6.0.0-rc1 (2023-12-06)

Drop support for .NET Core 3.1
Add support for .NET 8.0
Remove carbon_offset (CarbonOffset) parameter from shipment creation and purchase flows
- This parameter is no longer supported by the EasyPost API
Remove CarbonOffset model
Remove CreateAndBuy method in Batch service due to API deprecation
Add Options parameter for beta rates retrieval parameter set
Add ability to add custom options via AddAdditionalOption, in case an option is not explicitly supported
Beta CarrierMetadata service and classes removed. Please use the GA CarrierMetadata service and classes instead.

v5.8.0 (2023-10-11)

Add RetrieveApiKeysForUser to ApiKey service

v5.7.0 (2023-09-05)

Fix FedEx SmartPost carrier account creation not going to the correct endpoint
Add missing optional ReturnAddress and BuyerAddress parameters to Shipment creation parameter set

v5.6.0 (2023-08-31)

Add ability to compare an EasyPost object to a parameter set object via Matches function
- Users can define a custom Matches function on any parameter set class
Fix parameter set serialization that was causing issues when altering and reusing parameter sets

v5.5.0 (2023-08-29)

Add custom parameter sets (CreateFedEx, CreateUps) for carrier account creation API calls
- Users required to use these parameter sets if creating a FedEx or UPS account

v5.4.1 (2023-08-17)

Fix incorrect JSON mapping for EasyPostEstimatedDeliveryDate
- EasyPostEstimatedDeliveryDate is now a DateTime object rather than a string

v5.4.0 (2023-08-14)

Make the Id property of any EasyPostObject-based object instance settable (previously, this was read-only)
- This will allow users to make temporary references to existing objects in Parameter sets without having to retrieve the object from the API first

v5.3.0 (2023-07-28)

Maps 400 status codes to new BadRequestError class

v5.2.0 (2023-07-12)

Adds Hooks to introspect HTTP requests and responses (see HTTP Hooks section of README for more details)
Adds TaxIdExpirationDate to EasyPost.Models.API.Options for Shipment creation

v5.1.0 (2023-06-06)

Carrier Metadata is now in GA, accessible via myClient.CarrierMetadata
- myClient.Beta.CarrierMetadata is now deprecated and will be removed in a future release
- Method to retrieve carrier metadata has been renamed: myClient.Beta.CarrierMetadata.RetrieveCarrierMetadata is now myClient.CarrierMetadata.Retrieve
Constructors for all response objects (e.g. EasyPost.Models.API.Address) are publicly available for end-users to construct their own objects for testing purposes.

v5.0.0 (2023-05-15)

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

v4.6.0 (2023-04-18)

Adds GetNextPage function to each service which retrieves the next page of a collection when the has_more key is present in the response (eg: Client.Address.GetNextPage(addressCollection))
Adds RetrieveCarrierMetadata via myClient.Beta.CarrierMetadata
Fixes the type of RequestBody from Dictionary to String in Payload class
Fixes a deserialization bug when an error.message from the API was returned as an object instead of a string

v4.5.0 (2023-03-22)

Adds new Parameters namespace and objects, allowing you to create the paramaters of any CRUD request without needing to build the dictionaries manually. See the README for more details
Adds missing StatusDetail property to Tracker and TrackingDetail classes
Adds missing Fee property to Insurance class
Removes the Client property of a Collection

v4.4.0 (2023-02-17)

Added new beta RateService, accessible via myClient.Beta.Rate
Added RetrieveStatelessRate function under beta RateService to pull stateless rates when shipment data is provided
Added GetLowestStatelessRate function under Utilities.Rate to filter the lowest stateless rate
Added new GetLowest instance functions, callable on List<Rate>, List<Smartrate> and List<StatelessRate>, to filter the lowest rate
Deprecated rate and smartrate filtering methods in ShipmentService, RateService and Calculation.Rates namespaces, moved to Utilities.Rate namespace
Fixes Strong-Name signing that was unintentionally removed in v4.1.0 (this package is now strong-name signed once again)

v4.3.0 (2023-01-18)

Added payload functions RetrieveAllPayloadsForEvent and RetrievePayloadForEvent methods, accessible via myClient.Event service.
Added function to retrieve all pickups via myClient.Pickup.All()

v4.2.0 (2023-01-11)

Added new beta billing functionality for referral customer users, accessible via myClient.Beta.Referral service
- AddPaymentMethod to add an existing Stripe bank account or credit card to your EasyPost account
- RefundByAmount refunds you wallet balance by a specified amount
- RefundByPaymentLog refunds you wallet balance by a specified payment log
Added new DeliveryMaxDatetime Shipment option

v4.1.0 (2022-12-07)

Routes requests for creating a carrier account with a custom workflow (eg: FedEx, UPS) to the correct endpoint when using the Create function
Constants are now stored in EasyPost.Constants instead of EasyPost.Exceptions.Constants
Fixed a typo in /charges endpoint that was causing bank and credit card charge requests to fail

v4.0.2 (2022-11-01)

Fix bug where the temporary internal API key switch when adding a credit card to a referral user was not reverted after the request.
- After adding a credit card to a referral user, the existing Client would be misconfigured for following requests.

v4.0.1 (2022-10-24)

myInsurance.Refresh() function HTTP method fixed from PATCH to GET
- This function has been marked as obsolete and will be removed in a future release
Fix return type of order.Buy() when passing in a rate. Function will now return the updated order.
Fix bug where request time limits were not being copied to a cloned Client.
Fix bug where hashcode of any EasyPostObject or subtype was not consistent.
- Hashcode and equality now consider properties of the object, including Client. Different properties and/or different Clients will result in different hashcodes and objects will not be considered equal.
Fix bug where the wrong SmartrateAccuracy would be chosen
- Percentile75 might accidentally have been chosen rather than Percentile85 due to a bug in the SmartrateAccuracy enum ID.
Fix bug where some embedded elements (e.g. customs items) were not being created if included during a larger creation request (e.g. customs info create).
Prevent users from attempting to buy a shipment with a null rate, avoiding a NullReferenceException.

v4.0.0 (2022-10-12)

The v4.0.0 release includes all the changes from the release candidate (see v4.0.0-rc1 below) as well as the following items:

Improved API error parsing
- API error message may be an array rather than a string. Arrays will be concatenated (by comma) and returned as a string.
Capture 1xx and 3xx HTTP status codes as errors
- Any known 3xx status code from the EasyPost API will throw a RedirectError exception
- Any unknown 3xx status code will throw a UnexpectedHttpError exception
- Any 1xx status code (known or unknown) will throw a UnexpectedHttpError exception

v4.0.0-rc1 (2022-09-26)

Breaking Changes & New Features

Library is now thread-safe
- Initialize a Client object with an API key
- Static methods (i.e. create, retrieve, retrieve all of a resource) exist in services, accessed via property of the client (e.g. myClient.Address.Create())
- Instance methods (i.e. update, delete) accessed on instance of a resource (i.e. myShipment.Update())
All properties are now title-cased rather than snake-cased to match standard .NET naming conventions
- e.g. myShipment.id is now myShipment.Id, myAddress.federal_tax_id is now myAddress.FederalTaxId, myTrackerCollection.has_more is now myTrackerCollection.HasMore
- Some properties have been renamed to avoid naming conflicts:
  - Rate.rate is now Rate.Price
  - Message.message is now Message.Text
All properties are now nullable
- Almost all properties will be assigned a value during JSON deserialization. This is mostly to address compiler warnings
- Users can proceed with the assumption that any given property will not be null
Consistent exception handling
- All exceptions inherit from EasyPostError
- API-related and HTTP-related exceptions will throw an ApiError or inherited-type exception
- API exception types can be retrieved by HTTP status code via the EasyPost.Exceptions.Constants class (i.e. to anticipate what error will be thrown for a 404, etc.)
- Common exception messages and templates can be found in the EasyPost.Exceptions.Constants class (i.e. for log parsing)
Source code files have been organized
- Most EasyPost-related objects (i.e. Shipment, Address, Tracker, etc.) are now in the EasyPost.Model.API namespace
Dependencies updated to latest versions, including RestSharp v108

Misc

Under the hood improvements:
- Underlying Request-Client-ClientConfiguration relationship has been re-architected to allow for thread safety
- Process of generating an API request has been standardized and simplified
- Improved accessibility levels of internal functions, to prevent accidental use by end users
- Files have been organized into a more logical structure
- Methods and properties have been organized (e.g. methods ordered by CRUD, properties ordered alphabetically)

v3.6.1 (2022-09-22)

Adds missing dropoff_max_datetime and pickup_max_datetime Shipment options

v3.6.0 (2022-09-21)

Adds end_shipper_id shipment option
Adds support to pass an EndShipper ID when buying a shipment
Add Partner White Label support:
- Create a referral customer
- Update a referral customer's email address
- List all referral customers
- Add a credit card to a referral customer's account

v3.5.0 (2022-08-25)

Adds ValidateWebhook function
Adds duty_payment shipment option
Moves EndShipper out of beta to the general namespace

v3.4.0 (2022-08-02)

Adds Carbon Offset support
- Adds the ability to create a shipment with carbon offset
- Adds the ability to buy a shipment with carbon offset
- Adds the ability to one-call-buy a shipment with carbon offset
- Adds the ability to re-rate a shipment with carbon offset
Removes the unusable carrier param from the verify function on an Address

v3.3.0 (2022-07-18)

Adds ability to generate shipment forms via GenerateForm function

v3.2.0 (2022-07-11)

Adds DeletePaymentMethod, FundWallet, and RetrievePaymentMethods functions
Adds billing_type attribute in CarrierAccount and Rate classes
Adds support for webhook secrets
Collect OS details in User-Agent header
Update functions now use patch instead of put under the hood to better match the API behavior and documentation. Behavior of these functions should remain the same

v3.1.0 (2022-05-19)

Adds the EndShipper class with the ability to create, retrieve, and update EndShipper objects
Requests will now fail fast with an error if an API key is not provided instead of making a live API call with no key.

v3.0.0

Upgrading major versions of this project? Refer to the Upgrade Guide.

Breaking Changes

Dropped explicit support for .NET Framework, replaced with .NET Standard 2.0
Upgrades RestSharp from v106 to v107
Project was built with C# 8.0
Project is now entirely asynchronous which will require the addition of async/await on function calls
Renames methods from List() to All() to make our library consistent (previously we had methods calling the /all endpoint with both names)
Removes the unusable Rating class
Removes shipment.GetRates() method since the shipment object already has rates. If you need to get new rates for a shipment, please use the shipment.RegenerateRates() method.
Must use verify and verify_strict parameters to verify addresses during creation, per our API docs; verification and strict_verification will no longer work
Clarify XList vs XCollection distinction:
- ReportList, ScanFormList, ShipmentList and TrackerList renamed to ReportCollection, ScanFormCollection, ShipmentCollection and TrackerCollection to match the other names throughout the project
Functions previously called Destroy are now called Delete for consistency (eg: deleting a carrier account)
Removes non-static Create() functions on Address, Order, Pickup and Shipment classes for Visual Basic compatibility.

Features

Adds explicit support for .NET 5.0 & 6.0
Adds F# & Visual Basic compatibility
Adds RetrieveMe() which retrieves the authenticated user without the need to pass an ID
Adds missing billing_ref and dropoff_type Shipment options
Adds comprehensive test suite for .NET/.NET Core
Adds declaration attribute to CustomsInfo class
Adds missing id property to the Brand class
Adds option to pass in a custom HttpClient to the Client constructor (.NET/.NET Core only)
Adds CreateAndBuy function to the Batch class

Bug Fixes

Fixes bug where AddressCollection was storing Batch objects rather than Address objects
Fixes Address creation respecting verify and verify_strict parameters
Fixes a bug where Pickup error messages were not deserializing properly

v2.8.1 (2022-02-17)

Repackaged the project which contains all the changes made from 2.6.0 - 2.8.0 (see details below)
Added .NET Core 3.1 to the released package (was previously built but not included starting in 2.6.0)

This release includes changes intended for v2.8.0

Adds the missing Insurance object and associated actions (closes #47)
Adds support for updating a user's brand
Adds support to one-call buy shipments and orders via the service key
Adds support for retrieving all Batch objects
Adds support for retrieving all Address objects
Adds support for retrieving all Event objects
Adds support to regenerate Shipment rates via the RegenerateRates method
Adds support for creating trackers in bulk via the CreateList Tracker method
Removes the unused orderBy parameter from the Batch object
Update the DefaultApiBase to include v2 and remove v2 from every request url string
Adds the .NET version in use to the User-Agent header
Add a 30 second connection timeout and a 60 second request timeout for all HTTP requests
Lints the entire project and adds/updates docstrings throughout
Fixes the test suite for the project making it runnable once again

This release includes changes intended for v2.7.0

Adds support for tax identifiers (PR #181)

This release includes changes intended for v2.6.0 & v2.6.1

Adds missing commercial_invoice_letterhead option (closes #142)
Adds missing license_number option
Adds missing receiver_liquor_license option
Adds missing VerificationDetails object (closes #140, #141, #162)
Changes the Client delegate constructor from internal to public
Updates various information in the README related to thread-safety, examples, releasing, etc
Adds all missing dates and versions to the CHANGELOG
Bumps RestSharp from 106.4.2 to 106.13.0
Adds support for .NET Core 3.1
Includes SmartRate handling.
Updated Code Signing Identity.

v2.8.0 (2022-02-16)

This release was mispackaged, please use v2.8.1 or newer.

v2.7.0 (2021-11-24)

This release was mispackaged, please use v2.8.1 or newer.

v2.6.0 & v2.6.1 (2021-11-03)

This release was mispackaged, please use v2.8.1 or newer.

v2.5.1.3 (2020-01-07)

Add restricted delivery shipment option
Correct certified mail type

v2.5.1.2 (2019-09-29)

Add certified mail, registered mail, and return receipt shipment options

v2.5.1.1 (2019-07-05)

Added suppress etd option

v2.5.1 (2018-10-09)

Added overlabel shipment options

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

CHANGELOG

v6.8.1 (2024-10-31)

v6.8.0 (2024-10-22)

v6.7.3 (2024-09-17)

v6.7.2 (2024-08-16)

v6.7.1 (2024-08-09)

v6.7.0 (2024-07-24)

v6.6.0 (2024-07-16)

v6.5.2 (2024-06-12)

v6.5.1 (2024-06-10)

v6.5.0 (2024-06-05)

v6.4.0 (2024-05-01)

v6.3.1 (2024-04-12)

v6.3.0 (2024-04-10)

v6.2.1 (2024-03-18)

v6.2.0 (2024-02-07)

v6.1.0 (2024-01-08)

v6.0.0 (2023-12-06)

v6.0.0-rc1 (2023-12-06)

v5.8.0 (2023-10-11)

v5.7.0 (2023-09-05)

v5.6.0 (2023-08-31)

v5.5.0 (2023-08-29)

v5.4.1 (2023-08-17)

v5.4.0 (2023-08-14)

v5.3.0 (2023-07-28)

v5.2.0 (2023-07-12)

v5.1.0 (2023-06-06)

v5.0.0 (2023-05-15)

Breaking Changes

New Features

Miscellaneous

v4.6.0 (2023-04-18)

v4.5.0 (2023-03-22)

v4.4.0 (2023-02-17)

v4.3.0 (2023-01-18)

v4.2.0 (2023-01-11)

v4.1.0 (2022-12-07)

v4.0.2 (2022-11-01)

v4.0.1 (2022-10-24)

v4.0.0 (2022-10-12)

v4.0.0-rc1 (2022-09-26)

Breaking Changes & New Features

Misc

v3.6.1 (2022-09-22)

v3.6.0 (2022-09-21)

v3.5.0 (2022-08-25)

v3.4.0 (2022-08-02)

v3.3.0 (2022-07-18)

v3.2.0 (2022-07-11)

v3.1.0 (2022-05-19)

v3.0.0

Breaking Changes

Features

Bug Fixes

v2.8.1 (2022-02-17)

v2.8.0 (2022-02-16)

v2.7.0 (2021-11-24)

v2.6.0 & v2.6.1 (2021-11-03)

v2.5.1.3 (2020-01-07)

v2.5.1.2 (2019-09-29)

v2.5.1.1 (2019-07-05)

v2.5.1 (2018-10-09)

v2.5.0.1 (2018-10-03)

v2.5.0 (2018-09-28)

v2.4.0 (2018-06-22)

v2.3.1.4 (2018-01-09)

v2.3.1.3 (2017-11-29)

v2.3.1.2 (2017-05-16)

v2.3.1.1 (2017-04-20)

v2.3.1 (2017-03-28)

v2.3.0 (2017-03-11)

v2.2.7 (2017-03-07)

v2.2.6 (2017-01-24)