finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getfinancialratiosop.py

@@ -0,0 +1,612 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 030d27e2567d
+
+from __future__ import annotations
+from .financialratiosresponse import (
+    FinancialRatiosResponse,
+    FinancialRatiosResponseTypedDict,
+)
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Callable, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetFinancialRatiosRequestTypedDict(TypedDict):
+    ticker: NotRequired[str]
+    r"""Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company."""
+    tickers_any_of: NotRequired[str]
+    r"""Comma-separated list of ticker symbols."""
+    ticker_after: NotRequired[str]
+    r"""Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself."""
+    ticker_from: NotRequired[str]
+    r"""Ticker greater than or equal (inclusive)"""
+    ticker_before: NotRequired[str]
+    r"""Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself."""
+    ticker_to: NotRequired[str]
+    r"""Ticker less than or equal (inclusive)"""
+    cik: NotRequired[str]
+    r"""CIK company identifier from the SEC. Use this when filtering by SEC registrant instead of ticker."""
+    ciks: NotRequired[str]
+    r"""Comma-separated SEC CIK identifiers. Use this to filter several registrants in one request."""
+    cik_after: NotRequired[str]
+    r"""CIK pagination lower bound. Returns records with CIK values greater than this value, excluding the value itself."""
+    cik_from: NotRequired[str]
+    r"""CIK greater than or equal (inclusive)"""
+    cik_before: NotRequired[str]
+    r"""CIK pagination upper bound. Returns records with CIK values less than this value, excluding the value itself."""
+    cik_to: NotRequired[str]
+    r"""CIK upper-bound filter. Returns records with CIK values less than or equal to this value."""
+    price: NotRequired[float]
+    r"""Exact price filter. Use it when you need records matching one specific price value."""
+    price_above: NotRequired[float]
+    r"""Price lower-bound filter. Returns records above this value, excluding the value itself."""
+    price_min: NotRequired[float]
+    r"""Price greater than or equal (inclusive)"""
+    price_below: NotRequired[float]
+    r"""Price upper-bound filter. Returns records below this value, excluding the value itself."""
+    price_max: NotRequired[float]
+    r"""Price less than or equal (inclusive)"""
+    average_volume: NotRequired[float]
+    r"""Exact average-volume filter. Use it when screening for one specific average volume value."""
+    average_volume_above: NotRequired[float]
+    r"""Average volume greater than (exclusive)"""
+    average_volume_min: NotRequired[float]
+    r"""Average volume greater than or equal (inclusive)"""
+    average_volume_below: NotRequired[float]
+    r"""Average volume less than (exclusive)"""
+    average_volume_max: NotRequired[float]
+    r"""Average volume less than or equal (inclusive)"""
+    market_cap: NotRequired[float]
+    r"""Exact market-cap filter. Use it when screening for one specific company size value."""
+    market_cap_above: NotRequired[float]
+    r"""Market cap greater than (exclusive)"""
+    market_cap_min: NotRequired[float]
+    r"""Market cap greater than or equal (inclusive)"""
+    market_cap_below: NotRequired[float]
+    r"""Market-cap upper-bound filter. Returns companies below this value, excluding the value itself."""
+    market_cap_max: NotRequired[float]
+    r"""Market cap less than or equal (inclusive)"""
+    eps: NotRequired[float]
+    r"""Exact earnings-per-share filter. Use it when screening for one EPS value."""
+    eps_above: NotRequired[float]
+    r"""EPS lower-bound filter. Returns companies with EPS above this value, excluding the value itself."""
+    eps_min: NotRequired[float]
+    r"""EPS greater than or equal (inclusive)"""
+    eps_below: NotRequired[float]
+    r"""EPS upper-bound filter. Returns companies with EPS below this value, excluding the value itself."""
+    eps_max: NotRequired[float]
+    r"""EPS upper-bound filter. Returns companies with EPS less than or equal to this value."""
+    pe_ratio: NotRequired[float]
+    r"""Exact price-to-earnings ratio filter. Use it when screening for one valuation value."""
+    pe_ratio_above: NotRequired[float]
+    r"""P/E ratio lower-bound filter. Returns companies above this valuation, excluding the value itself."""
+    pe_ratio_min: NotRequired[float]
+    r"""P/E ratio greater than or equal (inclusive)"""
+    pe_ratio_below: NotRequired[float]
+    r"""P/E ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+    pe_ratio_max: NotRequired[float]
+    r"""P/E ratio less than or equal (inclusive)"""
+    pb_ratio: NotRequired[float]
+    r"""Exact price-to-book ratio filter. Use it when screening for one valuation value."""
+    pb_ratio_above: NotRequired[float]
+    r"""P/B ratio lower-bound filter. Returns companies above this valuation, excluding the value itself."""
+    pb_ratio_min: NotRequired[float]
+    r"""P/B ratio greater than or equal (inclusive)"""
+    pb_ratio_below: NotRequired[float]
+    r"""P/B ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+    pb_ratio_max: NotRequired[float]
+    r"""P/B ratio less than or equal (inclusive)"""
+    ps_ratio: NotRequired[float]
+    r"""Exact price-to-sales ratio filter. Use it when screening for one valuation value."""
+    ps_ratio_above: NotRequired[float]
+    r"""P/S ratio lower-bound filter. Returns companies above this valuation, excluding the value itself."""
+    ps_ratio_min: NotRequired[float]
+    r"""P/S ratio greater than or equal (inclusive)"""
+    ps_ratio_below: NotRequired[float]
+    r"""P/S ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+    ps_ratio_max: NotRequired[float]
+    r"""P/S ratio less than or equal (inclusive)"""
+    pcf_ratio: NotRequired[float]
+    r"""Exact price-to-cash-flow ratio filter. Use it when screening for one valuation value."""
+    pcf_ratio_above: NotRequired[float]
+    r"""P/CF ratio greater than (exclusive)"""
+    pcf_ratio_min: NotRequired[float]
+    r"""P/CF ratio greater than or equal (inclusive)"""
+    pcf_ratio_below: NotRequired[float]
+    r"""P/CF ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+    pcf_ratio_max: NotRequired[float]
+    r"""P/CF ratio less than or equal (inclusive)"""
+    limit: NotRequired[int]
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits."""
+    sort: NotRequired[str]
+    r"""A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified."""
+    next: NotRequired[str]
+    r"""Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page."""
+
+
+class GetFinancialRatiosRequest(BaseModel):
+    ticker: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company."""
+
+    tickers_any_of: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickersAnyOf"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of ticker symbols."""
+
+    ticker_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself."""
+
+    ticker_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker greater than or equal (inclusive)"""
+
+    ticker_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself."""
+
+    ticker_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker less than or equal (inclusive)"""
+
+    cik: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK company identifier from the SEC. Use this when filtering by SEC registrant instead of ticker."""
+
+    ciks: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated SEC CIK identifiers. Use this to filter several registrants in one request."""
+
+    cik_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK pagination lower bound. Returns records with CIK values greater than this value, excluding the value itself."""
+
+    cik_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK greater than or equal (inclusive)"""
+
+    cik_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK pagination upper bound. Returns records with CIK values less than this value, excluding the value itself."""
+
+    cik_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="cikTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""CIK upper-bound filter. Returns records with CIK values less than or equal to this value."""
+
+    price: Annotated[
+        Optional[float],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact price filter. Use it when you need records matching one specific price value."""
+
+    price_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="priceAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Price lower-bound filter. Returns records above this value, excluding the value itself."""
+
+    price_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="priceMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Price greater than or equal (inclusive)"""
+
+    price_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="priceBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Price upper-bound filter. Returns records below this value, excluding the value itself."""
+
+    price_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="priceMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Price less than or equal (inclusive)"""
+
+    average_volume: Annotated[
+        Optional[float],
+        pydantic.Field(alias="averageVolume"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact average-volume filter. Use it when screening for one specific average volume value."""
+
+    average_volume_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="averageVolumeAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average volume greater than (exclusive)"""
+
+    average_volume_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="averageVolumeMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average volume greater than or equal (inclusive)"""
+
+    average_volume_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="averageVolumeBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average volume less than (exclusive)"""
+
+    average_volume_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="averageVolumeMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average volume less than or equal (inclusive)"""
+
+    market_cap: Annotated[
+        Optional[float],
+        pydantic.Field(alias="marketCap"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact market-cap filter. Use it when screening for one specific company size value."""
+
+    market_cap_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="marketCapAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Market cap greater than (exclusive)"""
+
+    market_cap_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="marketCapMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Market cap greater than or equal (inclusive)"""
+
+    market_cap_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="marketCapBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Market-cap upper-bound filter. Returns companies below this value, excluding the value itself."""
+
+    market_cap_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="marketCapMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Market cap less than or equal (inclusive)"""
+
+    eps: Annotated[
+        Optional[float],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact earnings-per-share filter. Use it when screening for one EPS value."""
+
+    eps_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="epsAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""EPS lower-bound filter. Returns companies with EPS above this value, excluding the value itself."""
+
+    eps_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="epsMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""EPS greater than or equal (inclusive)"""
+
+    eps_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="epsBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""EPS upper-bound filter. Returns companies with EPS below this value, excluding the value itself."""
+
+    eps_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="epsMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""EPS upper-bound filter. Returns companies with EPS less than or equal to this value."""
+
+    pe_ratio: Annotated[
+        Optional[float],
+        pydantic.Field(alias="peRatio"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact price-to-earnings ratio filter. Use it when screening for one valuation value."""
+
+    pe_ratio_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="peRatioAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/E ratio lower-bound filter. Returns companies above this valuation, excluding the value itself."""
+
+    pe_ratio_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="peRatioMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/E ratio greater than or equal (inclusive)"""
+
+    pe_ratio_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="peRatioBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/E ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+
+    pe_ratio_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="peRatioMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/E ratio less than or equal (inclusive)"""
+
+    pb_ratio: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pbRatio"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact price-to-book ratio filter. Use it when screening for one valuation value."""
+
+    pb_ratio_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pbRatioAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/B ratio lower-bound filter. Returns companies above this valuation, excluding the value itself."""
+
+    pb_ratio_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pbRatioMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/B ratio greater than or equal (inclusive)"""
+
+    pb_ratio_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pbRatioBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/B ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+
+    pb_ratio_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pbRatioMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/B ratio less than or equal (inclusive)"""
+
+    ps_ratio: Annotated[
+        Optional[float],
+        pydantic.Field(alias="psRatio"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact price-to-sales ratio filter. Use it when screening for one valuation value."""
+
+    ps_ratio_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="psRatioAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/S ratio lower-bound filter. Returns companies above this valuation, excluding the value itself."""
+
+    ps_ratio_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="psRatioMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/S ratio greater than or equal (inclusive)"""
+
+    ps_ratio_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="psRatioBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/S ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+
+    ps_ratio_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="psRatioMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/S ratio less than or equal (inclusive)"""
+
+    pcf_ratio: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pcfRatio"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact price-to-cash-flow ratio filter. Use it when screening for one valuation value."""
+
+    pcf_ratio_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pcfRatioAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/CF ratio greater than (exclusive)"""
+
+    pcf_ratio_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pcfRatioMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/CF ratio greater than or equal (inclusive)"""
+
+    pcf_ratio_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pcfRatioBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/CF ratio upper-bound filter. Returns companies below this valuation, excluding the value itself."""
+
+    pcf_ratio_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="pcfRatioMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""P/CF ratio less than or equal (inclusive)"""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits."""
+
+    sort: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified."""
+
+    next: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "ticker",
+                "tickersAnyOf",
+                "tickerAfter",
+                "tickerFrom",
+                "tickerBefore",
+                "tickerTo",
+                "cik",
+                "ciks",
+                "cikAfter",
+                "cikFrom",
+                "cikBefore",
+                "cikTo",
+                "price",
+                "priceAbove",
+                "priceMin",
+                "priceBelow",
+                "priceMax",
+                "averageVolume",
+                "averageVolumeAbove",
+                "averageVolumeMin",
+                "averageVolumeBelow",
+                "averageVolumeMax",
+                "marketCap",
+                "marketCapAbove",
+                "marketCapMin",
+                "marketCapBelow",
+                "marketCapMax",
+                "eps",
+                "epsAbove",
+                "epsMin",
+                "epsBelow",
+                "epsMax",
+                "peRatio",
+                "peRatioAbove",
+                "peRatioMin",
+                "peRatioBelow",
+                "peRatioMax",
+                "pbRatio",
+                "pbRatioAbove",
+                "pbRatioMin",
+                "pbRatioBelow",
+                "pbRatioMax",
+                "psRatio",
+                "psRatioAbove",
+                "psRatioMin",
+                "psRatioBelow",
+                "psRatioMax",
+                "pcfRatio",
+                "pcfRatioAbove",
+                "pcfRatioMin",
+                "pcfRatioBelow",
+                "pcfRatioMax",
+                "limit",
+                "sort",
+                "next",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class GetFinancialRatiosResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    financial_ratios_response: NotRequired[FinancialRatiosResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetFinancialRatiosResponse(BaseModel):
+    next: Callable[[], Optional[GetFinancialRatiosResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    financial_ratios_response: Optional[FinancialRatiosResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["FinancialRatiosResponse"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m