finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/newslistresponse.py

@@ -0,0 +1,128 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 38b9b29bd578
+
+from __future__ import annotations
+from .newstypeenum import NewsTypeEnum
+from datetime import datetime
+from finance_dev import models
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import field_serializer, model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class NewsTypedDict(TypedDict):
+    action: NotRequired[str]
+    r"""News action type (typically empty)"""
+    authors: NotRequired[List[str]]
+    r"""Authors of the news item"""
+    body: NotRequired[str]
+    r"""Full body of the news (typically empty with default display output)"""
+    id: NotRequired[int]
+    r"""Unique news item ID"""
+    news_type: NotRequired[NewsTypeEnum]
+    r"""Source category of the news item. Pick one:
+    - `news` — Editorial news articles from journalists and news services.
+    - `press_release` — Official press releases issued directly by companies.
+    """
+    symbols: NotRequired[List[str]]
+    r"""Related stock symbols"""
+    timestamp: NotRequired[datetime]
+    r"""Publication timestamp in ISO 8601 format"""
+    title: NotRequired[str]
+    r"""News headline"""
+
+
+class News(BaseModel):
+    action: Optional[str] = None
+    r"""News action type (typically empty)"""
+
+    authors: Optional[List[str]] = None
+    r"""Authors of the news item"""
+
+    body: Optional[str] = None
+    r"""Full body of the news (typically empty with default display output)"""
+
+    id: Optional[int] = None
+    r"""Unique news item ID"""
+
+    news_type: Optional[NewsTypeEnum] = None
+    r"""Source category of the news item. Pick one:
+    - `news` — Editorial news articles from journalists and news services.
+    - `press_release` — Official press releases issued directly by companies.
+    """
+
+    symbols: Optional[List[str]] = None
+    r"""Related stock symbols"""
+
+    timestamp: Optional[datetime] = None
+    r"""Publication timestamp in ISO 8601 format"""
+
+    title: Optional[str] = None
+    r"""News headline"""
+
+    @field_serializer("news_type")
+    def serialize_news_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.NewsTypeEnum(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "action",
+                "authors",
+                "body",
+                "id",
+                "news_type",
+                "symbols",
+                "timestamp",
+                "title",
+            ]
+        )
+        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 NewsListResponseTypedDict(TypedDict):
+    r"""Response containing a list of news items."""
+
+    news: NotRequired[List[NewsTypedDict]]
+    r"""Array of news items and press releases, sorted by timestamp (newest first)"""
+
+
+class NewsListResponse(BaseModel):
+    r"""Response containing a list of news items."""
+
+    news: Optional[List[News]] = None
+    r"""Array of news items and press releases, sorted by timestamp (newest first)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["news"])
+        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

finance_dev/models/newssentimentresponse.py

@@ -0,0 +1,176 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 703052ddd977
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class BuzzTypedDict(TypedDict):
+    r"""News buzz metrics for the company."""
+
+    articles_in_last_week: NotRequired[int]
+    r"""Number of news articles in the last week."""
+    buzz: NotRequired[float]
+    r"""Buzz score for the company."""
+    weekly_average: NotRequired[float]
+    r"""Weekly average number of news articles."""
+
+
+class Buzz(BaseModel):
+    r"""News buzz metrics for the company."""
+
+    articles_in_last_week: Annotated[
+        Optional[int], pydantic.Field(alias="articlesInLastWeek")
+    ] = None
+    r"""Number of news articles in the last week."""
+
+    buzz: Optional[float] = None
+    r"""Buzz score for the company."""
+
+    weekly_average: Annotated[
+        Optional[float], pydantic.Field(alias="weeklyAverage")
+    ] = None
+    r"""Weekly average number of news articles."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["articlesInLastWeek", "buzz", "weeklyAverage"])
+        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 SentimentTypedDict(TypedDict):
+    r"""News sentiment breakdown."""
+
+    bearish_percent: NotRequired[int]
+    r"""Bearish sentiment percent as reported by the provider."""
+    bullish_percent: NotRequired[int]
+    r"""Bullish sentiment percent as reported by the provider."""
+
+
+class Sentiment(BaseModel):
+    r"""News sentiment breakdown."""
+
+    bearish_percent: Annotated[
+        Optional[int], pydantic.Field(alias="bearishPercent")
+    ] = None
+    r"""Bearish sentiment percent as reported by the provider."""
+
+    bullish_percent: Annotated[
+        Optional[int], pydantic.Field(alias="bullishPercent")
+    ] = None
+    r"""Bullish sentiment percent as reported by the provider."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["bearishPercent", "bullishPercent"])
+        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 NewsSentimentResponseTypedDict(TypedDict):
+    r"""News sentiment and buzz metrics for a company from Finnhub."""
+
+    buzz: NotRequired[BuzzTypedDict]
+    r"""News buzz metrics for the company."""
+    company_news_score: NotRequired[float]
+    r"""News score for the company."""
+    sector_average_bullish_percent: NotRequired[float]
+    r"""Average bullish percent across the company's sector."""
+    sector_average_news_score: NotRequired[float]
+    r"""Average news score across the company's sector."""
+    sentiment: NotRequired[SentimentTypedDict]
+    r"""News sentiment breakdown."""
+    symbol: NotRequired[str]
+    r"""Ticker symbol the sentiment applies to."""
+
+
+class NewsSentimentResponse(BaseModel):
+    r"""News sentiment and buzz metrics for a company from Finnhub."""
+
+    buzz: Optional[Buzz] = None
+    r"""News buzz metrics for the company."""
+
+    company_news_score: Annotated[
+        Optional[float], pydantic.Field(alias="companyNewsScore")
+    ] = None
+    r"""News score for the company."""
+
+    sector_average_bullish_percent: Annotated[
+        Optional[float], pydantic.Field(alias="sectorAverageBullishPercent")
+    ] = None
+    r"""Average bullish percent across the company's sector."""
+
+    sector_average_news_score: Annotated[
+        Optional[float], pydantic.Field(alias="sectorAverageNewsScore")
+    ] = None
+    r"""Average news score across the company's sector."""
+
+    sentiment: Optional[Sentiment] = None
+    r"""News sentiment breakdown."""
+
+    symbol: Optional[str] = None
+    r"""Ticker symbol the sentiment applies to."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "buzz",
+                "companyNewsScore",
+                "sectorAverageBullishPercent",
+                "sectorAverageNewsScore",
+                "sentiment",
+                "symbol",
+            ]
+        )
+        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
+
+
+try:
+    Buzz.model_rebuild()
+except NameError:
+    pass
+try:
+    Sentiment.model_rebuild()
+except NameError:
+    pass
+try:
+    NewsSentimentResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/newstypeenum.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 731f9b736060
+
+from __future__ import annotations
+from enum import Enum
+from finance_dev import utils
+
+
+class NewsTypeEnum(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Source category of the news item. Pick one:
+    - `news` — Editorial news articles from journalists and news services.
+    - `press_release` — Official press releases issued directly by companies.
+    """
+
+    NEWS = "news"
+    PRESS_RELEASE = "press_release"

finance_dev/models/optionchainsnapshotresponse.py

@@ -0,0 +1,64 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 07272340d95c
+
+from __future__ import annotations
+from .optioncontractsnapshotrow import (
+    OptionContractSnapshotRow,
+    OptionContractSnapshotRowTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class OptionChainSnapshotResponseTypedDict(TypedDict):
+    r"""Paginated option chain snapshot for an underlying (`OptionChainSnapshotResponse`)."""
+
+    next_url: NotRequired[str]
+    r"""URL for the next page of results (masked to this API); omitted when there is no next page."""
+    request_id: NotRequired[str]
+    r"""Request identifier from upstream data."""
+    results: NotRequired[List[OptionContractSnapshotRowTypedDict]]
+    r"""Option contract rows for the underlying, subject to filters and pagination."""
+    status: NotRequired[str]
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+
+class OptionChainSnapshotResponse(BaseModel):
+    r"""Paginated option chain snapshot for an underlying (`OptionChainSnapshotResponse`)."""
+
+    next_url: Annotated[Optional[str], pydantic.Field(alias="nextUrl")] = None
+    r"""URL for the next page of results (masked to this API); omitted when there is no next page."""
+
+    request_id: Annotated[Optional[str], pydantic.Field(alias="requestId")] = None
+    r"""Request identifier from upstream data."""
+
+    results: Optional[List[OptionContractSnapshotRow]] = None
+    r"""Option contract rows for the underlying, subject to filters and pagination."""
+
+    status: Optional[str] = None
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["nextUrl", "requestId", "results", "status"])
+        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
+
+
+try:
+    OptionChainSnapshotResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/optioncontractsnapshotresponse.py

@@ -0,0 +1,64 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 60e00dbfd057
+
+from __future__ import annotations
+from .optioncontractsnapshotrow import (
+    OptionContractSnapshotRow,
+    OptionContractSnapshotRowTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class OptionContractSnapshotResponseTypedDict(TypedDict):
+    r"""Single option contract snapshot (`OptionContractSnapshotResponse`). Responses may be cached for about five minutes."""
+
+    next_url: NotRequired[str]
+    r"""Pagination URL when applicable; omitted when not used."""
+    request_id: NotRequired[str]
+    r"""Request identifier from upstream data."""
+    results: NotRequired[OptionContractSnapshotRowTypedDict]
+    r"""One option contract row in a snapshot response (`OptionContractSnapshotDataDTO`). Optional fields are omitted when absent."""
+    status: NotRequired[str]
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+
+class OptionContractSnapshotResponse(BaseModel):
+    r"""Single option contract snapshot (`OptionContractSnapshotResponse`). Responses may be cached for about five minutes."""
+
+    next_url: Annotated[Optional[str], pydantic.Field(alias="nextUrl")] = None
+    r"""Pagination URL when applicable; omitted when not used."""
+
+    request_id: Annotated[Optional[str], pydantic.Field(alias="requestId")] = None
+    r"""Request identifier from upstream data."""
+
+    results: Optional[OptionContractSnapshotRow] = None
+    r"""One option contract row in a snapshot response (`OptionContractSnapshotDataDTO`). Optional fields are omitted when absent."""
+
+    status: Optional[str] = None
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["nextUrl", "requestId", "results", "status"])
+        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
+
+
+try:
+    OptionContractSnapshotResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/optioncontractsnapshotrow.py

@@ -0,0 +1,164 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 3d2cb4bcc082
+
+from __future__ import annotations
+from .optionsnapshotcontractdetails import (
+    OptionSnapshotContractDetails,
+    OptionSnapshotContractDetailsTypedDict,
+)
+from .optionsnapshotdaybar import OptionSnapshotDayBar, OptionSnapshotDayBarTypedDict
+from .optionsnapshotgreeks import OptionSnapshotGreeks, OptionSnapshotGreeksTypedDict
+from .optionsnapshotlastquote import (
+    OptionSnapshotLastQuote,
+    OptionSnapshotLastQuoteTypedDict,
+)
+from .optionsnapshotlasttrade import (
+    OptionSnapshotLastTrade,
+    OptionSnapshotLastTradeTypedDict,
+)
+from .optionsnapshotunderlying import (
+    OptionSnapshotUnderlying,
+    OptionSnapshotUnderlyingTypedDict,
+)
+from finance_dev.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class OptionContractSnapshotRowTypedDict(TypedDict):
+    r"""One option contract row in a snapshot response (`OptionContractSnapshotDataDTO`). Optional fields are omitted when absent."""
+
+    break_even_price: NotRequired[Nullable[float]]
+    r"""Underlying price at which the contract breaks even"""
+    day: NotRequired[OptionSnapshotDayBarTypedDict]
+    r"""Most recent daily OHLCV bar for the contract (`OptionSnapshotDayBarDTO`)."""
+    details: NotRequired[OptionSnapshotContractDetailsTypedDict]
+    r"""Static contract metadata (`OptionSnapshotDetailsDTO`)."""
+    fmv: NotRequired[Nullable[float]]
+    r"""Fair market value of the contract, when provided"""
+    fmv_last_updated: NotRequired[Nullable[int]]
+    r"""Timestamp of the last fair market value update, as supplied by the market data provider"""
+    greeks: NotRequired[OptionSnapshotGreeksTypedDict]
+    r"""Greeks when available (`OptionSnapshotGreeksDTO`)."""
+    implied_volatility: NotRequired[Nullable[float]]
+    r"""Implied volatility of the contract"""
+    last_quote: NotRequired[OptionSnapshotLastQuoteTypedDict]
+    r"""Latest NBBO quote when included (`OptionSnapshotLastQuoteDTO`)."""
+    last_trade: NotRequired[OptionSnapshotLastTradeTypedDict]
+    r"""Latest trade when included (`OptionSnapshotLastTradeDTO`)."""
+    open_interest: NotRequired[Nullable[float]]
+    r"""Open interest for the contract"""
+    underlying_asset: NotRequired[OptionSnapshotUnderlyingTypedDict]
+    r"""Underlying equity snapshot (`OptionSnapshotUnderlyingDTO`)."""
+
+
+class OptionContractSnapshotRow(BaseModel):
+    r"""One option contract row in a snapshot response (`OptionContractSnapshotDataDTO`). Optional fields are omitted when absent."""
+
+    break_even_price: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="breakEvenPrice")
+    ] = UNSET
+    r"""Underlying price at which the contract breaks even"""
+
+    day: Optional[OptionSnapshotDayBar] = None
+    r"""Most recent daily OHLCV bar for the contract (`OptionSnapshotDayBarDTO`)."""
+
+    details: Optional[OptionSnapshotContractDetails] = None
+    r"""Static contract metadata (`OptionSnapshotDetailsDTO`)."""
+
+    fmv: OptionalNullable[float] = UNSET
+    r"""Fair market value of the contract, when provided"""
+
+    fmv_last_updated: Annotated[
+        OptionalNullable[int], pydantic.Field(alias="fmvLastUpdated")
+    ] = UNSET
+    r"""Timestamp of the last fair market value update, as supplied by the market data provider"""
+
+    greeks: Optional[OptionSnapshotGreeks] = None
+    r"""Greeks when available (`OptionSnapshotGreeksDTO`)."""
+
+    implied_volatility: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="impliedVolatility")
+    ] = UNSET
+    r"""Implied volatility of the contract"""
+
+    last_quote: Annotated[
+        Optional[OptionSnapshotLastQuote], pydantic.Field(alias="lastQuote")
+    ] = None
+    r"""Latest NBBO quote when included (`OptionSnapshotLastQuoteDTO`)."""
+
+    last_trade: Annotated[
+        Optional[OptionSnapshotLastTrade], pydantic.Field(alias="lastTrade")
+    ] = None
+    r"""Latest trade when included (`OptionSnapshotLastTradeDTO`)."""
+
+    open_interest: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="openInterest")
+    ] = UNSET
+    r"""Open interest for the contract"""
+
+    underlying_asset: Annotated[
+        Optional[OptionSnapshotUnderlying], pydantic.Field(alias="underlyingAsset")
+    ] = None
+    r"""Underlying equity snapshot (`OptionSnapshotUnderlyingDTO`)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "breakEvenPrice",
+                "day",
+                "details",
+                "fmv",
+                "fmvLastUpdated",
+                "greeks",
+                "impliedVolatility",
+                "lastQuote",
+                "lastTrade",
+                "openInterest",
+                "underlyingAsset",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "breakEvenPrice",
+                "fmv",
+                "fmvLastUpdated",
+                "impliedVolatility",
+                "openInterest",
+            ]
+        )
+        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))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+try:
+    OptionContractSnapshotRow.model_rebuild()
+except NameError:
+    pass