Repository navigation
feat(statements): make FMP-omittable statement members optional - #393
Merged
Merged
Conversation
Fields that FMP can send as null are now decoded as optional across the Rust responses, the PyO3 models and stubs, and the Go SDK. This covers IncomeStatement's filing_date, accepted_date and interest_income; KeyMetrics and KeyMetricsTtm graham_number; FinancialScore's altman_z_score; AsReportedFinancialStatement's reported_currency; and FinancialEstimate's EBIT and EBITDA low/high/avg members. Each nullable member deserializes null to None (Option / pointer / Optional) and re-encodes back to null, while a missing key still fails as a required member. Tests across libfmp, fmp-py and the Go SDK assert the decode-as-none, reencode-as-null and still-required behaviour. BREAKING CHANGE: IncomeStatement, KeyMetrics, KeyMetricsTtm, FinancialScore, AsReportedFinancialStatement and FinancialEstimate members FMP can omit are now optional (Option / pointer / Optional); handle None.
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
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.
Fields that FMP can send as null are now decoded as optional across the
Rust responses, the PyO3 models and stubs, and the Go SDK. This covers
IncomeStatement's filing_date, accepted_date and interest_income;
KeyMetrics and KeyMetricsTtm graham_number; FinancialScore's
altman_z_score; AsReportedFinancialStatement's reported_currency; and
FinancialEstimate's EBIT and EBITDA low/high/avg members.
Each nullable member deserializes null to None (Option / pointer /
Optional) and re-encodes back to null, while a missing key still fails
as a required member. Tests across libfmp, fmp-py and the Go SDK assert
the decode-as-none, reencode-as-null and still-required behaviour.
BREAKING CHANGE: IncomeStatement, KeyMetrics, KeyMetricsTtm, FinancialScore, AsReportedFinancialStatement and FinancialEstimate members FMP can omit are now optional (Option / pointer / Optional); handle None.