Enhance FieldError with code and suggestion properties#545
Merged
Justintime50 merged 6 commits intoEasyPost:masterfrom Mar 3, 2026
Merged
Enhance FieldError with code and suggestion properties#545Justintime50 merged 6 commits intoEasyPost:masterfrom
Justintime50 merged 6 commits intoEasyPost:masterfrom
Conversation
Added optional 'code' and 'suggestion' properties to FieldError.
Justintime50
requested changes
Mar 2, 2026
Member
Justintime50
left a comment
Justintime50
left a comment
There was a problem hiding this comment.
Thanks for the PR!
I think what I'd like to see here instead is the introduction of the AddressVerificationFieldError class (which has a code) since FieldError does not.
See https://docs.easypost.com/docs/errors and another related PR EasyPost/easypost-php@e9ed0f6 for more details. Ultimately it looks like we didn't properly port those changes here when we did them so thanks for helping fill this gap!
Introduce IAddressVerificationFieldError and Update IVerification to use the new address-specific error type. Simplify IFieldError
Update the JSDoc for IAddressVerificationFieldError.field to correctly state it's description
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
IAddressVerificationFieldErrorinterface and replaces theerrorskey ofVerificationwith it as it's the proper type. Adds missingsuggestiontoIFieldErrorTesting
Just added optional types
Pull Request Type
Please select the option(s) that are relevant to this PR.