Feature: Keep the raw PayWay response on parsed models - #10
Merged
Conversation
Parsing is lossy: from_dict only reads declared fields, so keys PayWay sends but the dataclass does not model are dropped (a real transaction loses creditCard.cardScheme and cardType), absent keys come back as explicit None, and aliases rename them — maskedCardNumber is parsed into card_number, a key PayWay never sent. to_dict() is therefore a projection of the response, not the response, which is not enough for callers who persist it for auditing, reconciliation or dispute resolution. Models built by from_dict now keep that body verbatim on `raw`. It is annotated on the PayWayModel mixin, which is not a dataclass, so it never becomes a field: fields() ignores it and to_dict(), equality and repr are unchanged. PayWayCard reassigns it after parsing so the nested card keeps PayWay's own body rather than the copy rewritten for the cardNumber alias. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Parsing is lossy: from_dict only reads declared fields, so keys PayWay sends but the dataclass does not model are dropped (a real transaction loses creditCard.cardScheme and cardType), absent keys come back as explicit None, and aliases rename them — maskedCardNumber is parsed into card_number, a key PayWay never sent. to_dict() is therefore a projection of the response, not the response, which is not enough for callers who persist it for auditing, reconciliation or dispute resolution.
Models built by from_dict now keep that body verbatim on
raw. It is annotated on the PayWayModel mixin, which is not a dataclass, so it never becomes a field: fields() ignores it and to_dict(), equality and repr are unchanged. PayWayCard reassigns it after parsing so the nested card keeps PayWay's own body rather than the copy rewritten for the cardNumber alias.