finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getanalystinsightsop.py

@@ -0,0 +1,164 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: a7efdd566463
+
+from __future__ import annotations
+from .analystinsightsresponse import (
+    AnalystInsightsResponse,
+    AnalystInsightsResponseTypedDict,
+)
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from enum import Enum
+from finance_dev import models, utils
+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 Callable, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAnalystInsightsSearchKeysType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Tells the API how to interpret the value you send in `searchKeys`. Allowed values:
+    - `firm_id` — the value is a firm/company internal ID.
+    - `firm` — the value is the firm/company name.
+    """
+
+    FIRM_ID = "firm_id"
+    FIRM = "firm"
+
+
+class GetAnalystInsightsRequestTypedDict(TypedDict):
+    page: NotRequired[int]
+    r"""Zero-based page number. Enter 0 for the first page, 1 for the second page, and so on."""
+    page_size: NotRequired[int]
+    r"""Number of results per page. Use this to control pagination size in list views. Use this to control page size; default is 10."""
+    symbols: NotRequired[str]
+    r"""Comma-separated ticker symbols, such as AAPL,MSFT. Use this to request or filter multiple companies in one call. (e.g. AAPL,MSFT)"""
+    analyst: NotRequired[str]
+    r"""Comma-separated analyst IDs. Use this to limit insight results to specific analysts."""
+    rating_id: NotRequired[str]
+    r"""Comma-separated rating IDs. Use this to limit insight results to specific rating records."""
+    search_keys_type: NotRequired[GetAnalystInsightsSearchKeysType]
+    r"""Tells the API how to interpret the value you send in `searchKeys`. Allowed values:
+    - `firm_id` — the value is a firm/company internal ID.
+    - `firm` — the value is the firm/company name.
+    """
+    search_keys: NotRequired[str]
+    r"""Search key value (based on searchKeysType)"""
+
+
+class GetAnalystInsightsRequest(BaseModel):
+    page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Zero-based page number. Enter 0 for the first page, 1 for the second page, and so on."""
+
+    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. Use this to control page size; default is 10."""
+
+    symbols: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated ticker symbols, such as AAPL,MSFT. Use this to request or filter multiple companies in one call. (e.g. AAPL,MSFT)"""
+
+    analyst: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated analyst IDs. Use this to limit insight results to specific analysts."""
+
+    rating_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="ratingId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated rating IDs. Use this to limit insight results to specific rating records."""
+
+    search_keys_type: Annotated[
+        Optional[GetAnalystInsightsSearchKeysType],
+        pydantic.Field(alias="searchKeysType"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Tells the API how to interpret the value you send in `searchKeys`. Allowed values:
+    - `firm_id` — the value is a firm/company internal ID.
+    - `firm` — the value is the firm/company name.
+    """
+
+    search_keys: Annotated[
+        Optional[str],
+        pydantic.Field(alias="searchKeys"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Search key value (based on searchKeysType)"""
+
+    @field_serializer("search_keys_type")
+    def serialize_search_keys_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.GetAnalystInsightsSearchKeysType(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "page",
+                "pageSize",
+                "symbols",
+                "analyst",
+                "ratingId",
+                "searchKeysType",
+                "searchKeys",
+            ]
+        )
+        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 GetAnalystInsightsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    analyst_insights_response: NotRequired[AnalystInsightsResponseTypedDict]
+    r"""Analyst insights. Each item may include id, date, updated, action, rating, ratingId, pt, firm, firmId, analystInsights, security (cik, exchange, isin, name, symbol)."""
+
+
+class GetAnalystInsightsResponse(BaseModel):
+    next: Callable[[], Optional[GetAnalystInsightsResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    analyst_insights_response: Optional[AnalystInsightsResponse] = None
+    r"""Analyst insights. Each item may include id, date, updated, action, rating, ratingId, pt, firm, firmId, analystInsights, security (cik, exchange, isin, name, symbol)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["AnalystInsightsResponse"])
+        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/getbankbranchesop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 9d81f3acb2dd
+
+from __future__ import annotations
+from .bankbranchesresponse import BankBranchesResponse, BankBranchesResponseTypedDict
+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 GetBankBranchesRequestTypedDict(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 GetBankBranchesRequest(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 GetBankBranchesResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    bank_branches_response: NotRequired[BankBranchesResponseTypedDict]
+    r"""Bank branch data."""
+
+
+class GetBankBranchesResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    bank_branches_response: Optional[BankBranchesResponse] = None
+    r"""Bank branch data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["BankBranchesResponse"])
+        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/getbaseeventop.py

@@ -0,0 +1,87 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 00e04e8d07ee
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .predmdbaseeventwithevents import (
+    PredMdBaseEventWithEvents,
+    PredMdBaseEventWithEventsTypedDict,
+)
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetBaseEventRequestTypedDict(TypedDict):
+    base_event_id: str
+
+
+class GetBaseEventRequest(BaseModel):
+    base_event_id: Annotated[
+        str,
+        pydantic.Field(alias="baseEventId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+
+
+class GetBaseEventResponseBodyTypedDict(TypedDict):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+    data: NotRequired[PredMdBaseEventWithEventsTypedDict]
+
+
+class GetBaseEventResponseBody(BaseModel):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+
+    data: Optional[PredMdBaseEventWithEvents] = 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 GetBaseEventResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    object: NotRequired[GetBaseEventResponseBodyTypedDict]
+    r"""Base event with nested events and contracts"""
+
+
+class GetBaseEventResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    object: Optional[GetBaseEventResponseBody] = None
+    r"""Base event with nested events and contracts"""
+
+    @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/getbullbearanalysisop.py

@@ -0,0 +1,91 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0f0cb77cfe5f
+
+from __future__ import annotations
+from .bullbearanalysisresponse import (
+    BullBearAnalysisResponse,
+    BullBearAnalysisResponseTypedDict,
+)
+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 GetBullBearAnalysisRequestTypedDict(TypedDict):
+    symbols: str
+    r"""Comma-separated list of ticker symbols"""
+    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. (1-200)"""
+
+
+class GetBullBearAnalysisRequest(BaseModel):
+    symbols: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Comma-separated list of ticker symbols"""
+
+    page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 0
+    r"""Page number for pagination (0-based)"""
+
+    page_size: Annotated[
+        Optional[int],
+        pydantic.Field(alias="pageSize"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 100
+    r"""Number of results per page. Use this to control pagination size in list views. (1-200)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["page", "pageSize"])
+        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 GetBullBearAnalysisResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    bull_bear_analysis_response: NotRequired[BullBearAnalysisResponseTypedDict]
+    r"""Bull and bear cases."""
+
+
+class GetBullBearAnalysisResponse(BaseModel):
+    next: Callable[[], Optional[GetBullBearAnalysisResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    bull_bear_analysis_response: Optional[BullBearAnalysisResponse] = None
+    r"""Bull and bear cases."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["BullBearAnalysisResponse"])
+        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