finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getfinancialstatementsop.py

@@ -0,0 +1,117 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0d1b2429de39
+
+from __future__ import annotations
+from .financialsstatementsresponse import (
+    FinancialsStatementsResponse,
+    FinancialsStatementsResponseTypedDict,
+)
+from .financialstatementtype import FinancialStatementType
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .reportingfrequency import ReportingFrequency
+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 GetFinancialStatementsRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Stock symbol, such as AAPL. Use it to choose the company you want to research."""
+    statement: FinancialStatementType
+    r"""Financial statement type to return. Choose the statement category your analysis needs."""
+    freq: ReportingFrequency
+    r"""Reporting frequency to return. Use annual or quarterly based on your analysis view."""
+    preliminary: NotRequired[bool]
+    r"""Include preliminary data (optional boolean)."""
+
+
+class GetFinancialStatementsRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Stock symbol, such as AAPL. Use it to choose the company you want to research."""
+
+    statement: Annotated[
+        FinancialStatementType,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Financial statement type to return. Choose the statement category your analysis needs."""
+
+    freq: Annotated[
+        ReportingFrequency,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Reporting frequency to return. Use annual or quarterly based on your analysis view."""
+
+    preliminary: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Include preliminary data (optional boolean)."""
+
+    @field_serializer("statement")
+    def serialize_statement(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FinancialStatementType(value)
+            except ValueError:
+                return value
+        return value
+
+    @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(["preliminary"])
+        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 GetFinancialStatementsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    financials_statements_response: NotRequired[FinancialsStatementsResponseTypedDict]
+    r"""Financial statements data."""
+
+
+class GetFinancialStatementsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    financials_statements_response: Optional[FinancialsStatementsResponse] = None
+    r"""Financial statements data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["FinancialsStatementsResponse"])
+        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/getfundownershipop.py

@@ -0,0 +1,77 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 9e8d106d9a92
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .ownershipdataresponse import OwnershipDataResponse, OwnershipDataResponseTypedDict
+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 GetFundOwnershipRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company."""
+    limit: NotRequired[int]
+    r"""Optional maximum number of results to return. Use it to keep ownership lists small for UI views."""
+
+
+class GetFundOwnershipRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company."""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional maximum number of results to return. Use it to keep ownership lists small for UI views."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["limit"])
+        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 GetFundOwnershipResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    ownership_data_response: NotRequired[OwnershipDataResponseTypedDict]
+    r"""Fund ownership data."""
+
+
+class GetFundOwnershipResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    ownership_data_response: Optional[OwnershipDataResponse] = None
+    r"""Fund ownership data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OwnershipDataResponse"])
+        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/gethistoricaldataop.py

@@ -0,0 +1,61 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 094a1edab51a
+
+from __future__ import annotations
+from .economicsindicator import EconomicsIndicator, EconomicsIndicatorTypedDict
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, PathParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetHistoricalDataRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Economic indicator code from the upstream calendar provider. These codes are not a fixed enum on our side — fetch [GET /v1/calendars/economics](/api-reference/calendars/economics) to see the codes attached to recent calendar entries, then use that code here for the historical series. Common examples:
+    - `USURTOT` — United States Unemployment Rate (total).
+    - `UNITEDSTACONJOBCLA` — U.S. Continuing Jobless Claims.
+    - `UNITEDSTACONCRE` — U.S. Consumer Credit.
+    """
+
+
+class GetHistoricalDataRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Economic indicator code from the upstream calendar provider. These codes are not a fixed enum on our side — fetch [GET /v1/calendars/economics](/api-reference/calendars/economics) to see the codes attached to recent calendar entries, then use that code here for the historical series. Common examples:
+    - `USURTOT` — United States Unemployment Rate (total).
+    - `UNITEDSTACONJOBCLA` — U.S. Continuing Jobless Claims.
+    - `UNITEDSTACONCRE` — U.S. Consumer Credit.
+    """
+
+
+class GetHistoricalDataResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    get_historical_data_response: NotRequired[List[EconomicsIndicatorTypedDict]]
+    r"""Economic indicator historical data retrieved successfully"""
+
+
+class GetHistoricalDataResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    get_historical_data_response: Optional[List[EconomicsIndicator]] = None
+    r"""Economic indicator historical data retrieved successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["GetHistoricalDataResponse"])
+        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/gethistoricalesgop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 553519d5ed6e
+
+from __future__ import annotations
+from .historicalesgresponse import HistoricalEsgResponse, HistoricalEsgResponseTypedDict
+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 GetHistoricalEsgRequestTypedDict(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`."""
+
+
+class GetHistoricalEsgRequest(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`."""
+
+
+class GetHistoricalEsgResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    historical_esg_response: NotRequired[HistoricalEsgResponseTypedDict]
+    r"""Historical ESG data."""
+
+
+class GetHistoricalEsgResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    historical_esg_response: Optional[HistoricalEsgResponse] = None
+    r"""Historical ESG data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["HistoricalEsgResponse"])
+        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/gethistorybatchop.py

@@ -0,0 +1,74 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 3202316b7eb9
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .predmdbatchhistoryresponse import (
+    PredMdBatchHistoryResponse,
+    PredMdBatchHistoryResponseTypedDict,
+)
+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 GetHistoryBatchResponseBodyTypedDict(TypedDict):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+    data: NotRequired[PredMdBatchHistoryResponseTypedDict]
+
+
+class GetHistoryBatchResponseBody(BaseModel):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+
+    data: Optional[PredMdBatchHistoryResponse] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["data"])
+        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 GetHistoryBatchResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    object: NotRequired[GetHistoryBatchResponseBodyTypedDict]
+    r"""Batch history results"""
+
+
+class GetHistoryBatchResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    object: Optional[GetHistoryBatchResponseBody] = None
+    r"""Batch history results"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["object"])
+        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/gethistoryop.py

@@ -0,0 +1,123 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ecf6fc354324
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .predmdhistoryresponse import PredMdHistoryResponse, PredMdHistoryResponseTypedDict
+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 GetHistoryRequestTypedDict(TypedDict):
+    symbol: str
+    from_: NotRequired[str]
+    r"""RFC3339 timestamp or Unix seconds/milliseconds."""
+    to: NotRequired[str]
+    r"""RFC3339 timestamp or Unix seconds/milliseconds."""
+    limit: NotRequired[int]
+    r"""0 or omitted means 10000; values above 10000 are clamped to it."""
+
+
+class GetHistoryRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+
+    from_: Annotated[
+        Optional[str],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""RFC3339 timestamp or Unix seconds/milliseconds."""
+
+    to: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""RFC3339 timestamp or Unix seconds/milliseconds."""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""0 or omitted means 10000; values above 10000 are clamped to it."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["from", "to", "limit"])
+        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 GetHistoryResponseBodyTypedDict(TypedDict):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+    data: NotRequired[PredMdHistoryResponseTypedDict]
+
+
+class GetHistoryResponseBody(BaseModel):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+
+    data: Optional[PredMdHistoryResponse] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["data"])
+        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 GetHistoryResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    object: NotRequired[GetHistoryResponseBodyTypedDict]
+    r"""Historical ticks"""
+
+
+class GetHistoryResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    object: Optional[GetHistoryResponseBody] = None
+    r"""Historical ticks"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["object"])
+        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