finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getratingsop.py

@@ -0,0 +1,164 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: b6bcd50acf16
+
+from __future__ import annotations
+from .getratingsresponse import GetRatingsResponse, GetRatingsResponseTypedDict
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from datetime import date
+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 GetRatingsRequestTypedDict(TypedDict):
+    tickers: NotRequired[str]
+    r"""Comma-separated list of ticker symbols to filter by"""
+    page: NotRequired[int]
+    r"""Page number for pagination (0-based)"""
+    page_size: NotRequired[int]
+    r"""Number of results per page. Use this to control pagination size in list views."""
+    date_: NotRequired[date]
+    r"""Filter by specific date (YYYY-MM-DD)"""
+    date_from: NotRequired[date]
+    r"""Start date for date range (YYYY-MM-DD)"""
+    date_to: NotRequired[date]
+    r"""End date for date range (YYYY-MM-DD)"""
+    importance: NotRequired[int]
+    r"""Minimum importance level to include. Use higher values to filter for more market-moving events or ratings."""
+    action: NotRequired[str]
+    r"""Rating action filter. Use it to return only upgrades, downgrades, initiations, or other supported action types."""
+    analyst_id: NotRequired[str]
+    r"""Comma-separated analyst IDs. Use this to limit insight results to specific analysts. to filter by"""
+    firm_id: NotRequired[str]
+    r"""Comma-separated firm IDs to filter by"""
+
+
+class GetRatingsRequest(BaseModel):
+    tickers: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of ticker symbols to filter by"""
+
+    page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Page number for pagination (0-based)"""
+
+    page_size: Annotated[
+        Optional[int],
+        pydantic.Field(alias="pageSize"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Number of results per page. Use this to control pagination size in list views."""
+
+    date_: Annotated[
+        Optional[date],
+        pydantic.Field(alias="date"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter by specific date (YYYY-MM-DD)"""
+
+    date_from: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Start date for date range (YYYY-MM-DD)"""
+
+    date_to: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""End date for date range (YYYY-MM-DD)"""
+
+    importance: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Minimum importance level to include. Use higher values to filter for more market-moving events or ratings."""
+
+    action: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Rating action filter. Use it to return only upgrades, downgrades, initiations, or other supported action types."""
+
+    analyst_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="analystId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated analyst IDs. Use this to limit insight results to specific analysts. to filter by"""
+
+    firm_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="firmId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated firm IDs to filter by"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "tickers",
+                "page",
+                "pageSize",
+                "date",
+                "dateFrom",
+                "dateTo",
+                "importance",
+                "action",
+                "analystId",
+                "firmId",
+            ]
+        )
+        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 GetRatingsResponseResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    get_ratings_response: NotRequired[GetRatingsResponseTypedDict]
+    r"""Analyst ratings. Response has a ratings array; each item may include id, date, time, ticker, exchange, name, currency, action_pt, action_company, rating_current, rating_prior, pt_current, pt_current_adjusted, pt_prior, pt_prior_adjusted, analyst, analyst_id, analyst_name, importance, updated. Some fields may be absent when empty."""
+
+
+class GetRatingsResponseResponse(BaseModel):
+    next: Callable[[], Optional[GetRatingsResponseResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    get_ratings_response: Optional[GetRatingsResponse] = None
+    r"""Analyst ratings. Response has a ratings array; each item may include id, date, time, ticker, exchange, name, currency, action_pt, action_company, rating_current, rating_prior, pt_current, pt_current_adjusted, pt_prior, pt_prior_adjusted, analyst, analyst_id, analyst_name, importance, updated. Some fields may be absent when empty."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["GetRatingsResponse"])
+        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/getratingsresponse.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 3d850711bfe7
+
+from __future__ import annotations
+from .rating import Rating, RatingTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class GetRatingsResponseTypedDict(TypedDict):
+    r"""Response for GET /v1/analytics/ratings. Only non-empty fields appear in each rating; notes and ratings_accuracy are omitted when empty."""
+
+    ratings: NotRequired[List[RatingTypedDict]]
+    r"""Array of analyst rating objects"""
+
+
+class GetRatingsResponse(BaseModel):
+    r"""Response for GET /v1/analytics/ratings. Only non-empty fields appear in each rating; notes and ratings_accuracy are omitted when empty."""
+
+    ratings: Optional[List[Rating]] = None
+    r"""Array of analyst rating objects"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ratings"])
+        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/getreportedfinancialsop.py

@@ -0,0 +1,127 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 775ecb18def3
+
+from __future__ import annotations
+from .financialsreportedresponse import (
+    FinancialsReportedResponse,
+    FinancialsReportedResponseTypedDict,
+)
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .reportingfrequency import ReportingFrequency
+from datetime import date
+from finance_dev import models
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import field_serializer, model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetReportedFinancialsRequestTypedDict(TypedDict):
+    symbol: NotRequired[str]
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company. Required when both `cik` and `accessNumber` are omitted."""
+    cik: NotRequired[str]
+    r"""SEC CIK. Optional when `symbol` or `accessNumber` is provided."""
+    access_number: NotRequired[str]
+    r"""SEC access number. Optional when `symbol` or `cik` is provided."""
+    freq: NotRequired[ReportingFrequency]
+    r"""Optional reporting frequency filter. Use it to limit results to annual or quarterly reports."""
+    from_: NotRequired[date]
+    r"""Optional start date in YYYY-MM-DD format. Use it to begin the research window."""
+    to: NotRequired[date]
+    r"""Optional end date in YYYY-MM-DD format. Use it to end the research window."""
+
+
+class GetReportedFinancialsRequest(BaseModel):
+    symbol: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company. Required when both `cik` and `accessNumber` are omitted."""
+
+    cik: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""SEC CIK. Optional when `symbol` or `accessNumber` is provided."""
+
+    access_number: Annotated[
+        Optional[str],
+        pydantic.Field(alias="accessNumber"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""SEC access number. Optional when `symbol` or `cik` is provided."""
+
+    freq: Annotated[
+        Optional[ReportingFrequency],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional reporting frequency filter. Use it to limit results to annual or quarterly reports."""
+
+    from_: Annotated[
+        Optional[date],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional start date in YYYY-MM-DD format. Use it to begin the research window."""
+
+    to: Annotated[
+        Optional[date],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional end date in YYYY-MM-DD format. Use it to end the research window."""
+
+    @field_serializer("freq")
+    def serialize_freq(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ReportingFrequency(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["symbol", "cik", "accessNumber", "freq", "from", "to"])
+        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 GetReportedFinancialsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    financials_reported_response: NotRequired[FinancialsReportedResponseTypedDict]
+    r"""Reported financials."""
+
+
+class GetReportedFinancialsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    financials_reported_response: Optional[FinancialsReportedResponse] = None
+    r"""Reported financials."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["FinancialsReportedResponse"])
+        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/getrevenuebreakdownop.py

@@ -0,0 +1,85 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 84d32b0b9b75
+
+from __future__ import annotations
+from .financialsrevenuebreakdownresponse import (
+    FinancialsRevenueBreakdownResponse,
+    FinancialsRevenueBreakdownResponseTypedDict,
+)
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetRevenueBreakdownRequestTypedDict(TypedDict):
+    symbol: NotRequired[str]
+    r"""Stock ticker symbol to research, such as AAPL. Required when `cik` is omitted."""
+    cik: NotRequired[str]
+    r"""SEC CIK. Optional when `symbol` is provided."""
+
+
+class GetRevenueBreakdownRequest(BaseModel):
+    symbol: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Stock ticker symbol to research, such as AAPL. Required when `cik` is omitted."""
+
+    cik: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""SEC CIK. Optional when `symbol` is provided."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["symbol", "cik"])
+        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 GetRevenueBreakdownResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    financials_revenue_breakdown_response: NotRequired[
+        FinancialsRevenueBreakdownResponseTypedDict
+    ]
+    r"""Revenue breakdown data."""
+
+
+class GetRevenueBreakdownResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    financials_revenue_breakdown_response: Optional[
+        FinancialsRevenueBreakdownResponse
+    ] = None
+    r"""Revenue breakdown data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["FinancialsRevenueBreakdownResponse"])
+        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/getrevenueestimatesop.py

@@ -0,0 +1,91 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 4d7fc89b4158
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .reportingfrequency import ReportingFrequency
+from .revenueestimatesresponse import (
+    RevenueEstimatesResponse,
+    RevenueEstimatesResponseTypedDict,
+)
+from finance_dev import models
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import field_serializer, model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetRevenueEstimatesRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`."""
+    freq: NotRequired[ReportingFrequency]
+    r"""(Optional) Frequency: annual, quarterly"""
+
+
+class GetRevenueEstimatesRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`."""
+
+    freq: Annotated[
+        Optional[ReportingFrequency],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""(Optional) Frequency: annual, quarterly"""
+
+    @field_serializer("freq")
+    def serialize_freq(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ReportingFrequency(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["freq"])
+        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 GetRevenueEstimatesResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    revenue_estimates_response: NotRequired[RevenueEstimatesResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetRevenueEstimatesResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    revenue_estimates_response: Optional[RevenueEstimatesResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["RevenueEstimatesResponse"])
+        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/getsecfilingsop.py

@@ -0,0 +1,113 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0c33d2160755
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .secfilingsresponse import SecFilingsResponse, SecFilingsResponseTypedDict
+from datetime import date
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetSecFilingsRequestTypedDict(TypedDict):
+    symbol: NotRequired[str]
+    r"""Stock symbol (optional if cik provided)"""
+    cik: NotRequired[str]
+    r"""Central Index Key (optional if symbol provided)"""
+    access_number: NotRequired[str]
+    r"""SEC access number to filter by specific filing"""
+    form: NotRequired[str]
+    r"""Form type (e.g. 10-K, 10-Q, 8-K, DEF 14A)"""
+    from_: NotRequired[date]
+    r"""Start date in YYYY-MM-DD format. Enter the first date to include in the research window."""
+    to: NotRequired[date]
+    r"""End date in YYYY-MM-DD format. Enter the last date to include in the research window."""
+
+
+class GetSecFilingsRequest(BaseModel):
+    symbol: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Stock symbol (optional if cik provided)"""
+
+    cik: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Central Index Key (optional if symbol provided)"""
+
+    access_number: Annotated[
+        Optional[str],
+        pydantic.Field(alias="accessNumber"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""SEC access number to filter by specific filing"""
+
+    form: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Form type (e.g. 10-K, 10-Q, 8-K, DEF 14A)"""
+
+    from_: Annotated[
+        Optional[date],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Start date in YYYY-MM-DD format. Enter the first date to include in the research window."""
+
+    to: Annotated[
+        Optional[date],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""End date in YYYY-MM-DD format. Enter the last date to include in the research window."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["symbol", "cik", "accessNumber", "form", "from", "to"])
+        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 GetSecFilingsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    sec_filings_response: NotRequired[SecFilingsResponseTypedDict]
+    r"""SEC filings."""
+
+
+class GetSecFilingsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    sec_filings_response: Optional[SecFilingsResponse] = None
+    r"""SEC filings."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["SecFilingsResponse"])
+        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