finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/predmdbaseeventhit.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 45847caa6537
+
+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 PredMdBaseEventHitTypedDict(TypedDict):
+    r"""One base event with at least one matching contract. The index carries no display name; read it through /base-events/{baseEventId}."""
+
+    base_event_id: str
+    contracts_found: int
+    r"""Every matching contract under this hit. Read them with type=contracts and eventId or baseEventId."""
+    underlying_spec: NotRequired[str]
+
+
+class PredMdBaseEventHit(BaseModel):
+    r"""One base event with at least one matching contract. The index carries no display name; read it through /base-events/{baseEventId}."""
+
+    base_event_id: Annotated[str, pydantic.Field(alias="baseEventId")]
+
+    contracts_found: Annotated[int, pydantic.Field(alias="contractsFound")]
+    r"""Every matching contract under this hit. Read them with type=contracts and eventId or baseEventId."""
+
+    underlying_spec: Annotated[
+        Optional[str], pydantic.Field(alias="underlyingSpec")
+    ] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["underlyingSpec"])
+        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:
+    PredMdBaseEventHit.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdbaseeventsearchresult.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ea3bd5e6cf4b
+
+from __future__ import annotations
+from .predmdbaseeventhit import PredMdBaseEventHit, PredMdBaseEventHitTypedDict
+from enum import Enum
+from finance_dev.types import BaseModel
+import pydantic
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+
+class PredMdBaseEventSearchResultType(str, Enum):
+    BASE_EVENTS = "base-events"
+
+
+class PredMdBaseEventSearchResultTypedDict(TypedDict):
+    r"""One page of base events. found, page and perPage count base events."""
+
+    found: int
+    r"""Every match, not just this page."""
+    hits: List[PredMdBaseEventHitTypedDict]
+    page: int
+    per_page: int
+    type: PredMdBaseEventSearchResultType
+
+
+class PredMdBaseEventSearchResult(BaseModel):
+    r"""One page of base events. found, page and perPage count base events."""
+
+    found: int
+    r"""Every match, not just this page."""
+
+    hits: List[PredMdBaseEventHit]
+
+    page: int
+
+    per_page: Annotated[int, pydantic.Field(alias="perPage")]
+
+    type: PredMdBaseEventSearchResultType
+
+
+try:
+    PredMdBaseEventSearchResult.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdbaseeventwithevents.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 6645bbef736c
+
+from __future__ import annotations
+from .predmdbaseevent import PredMdBaseEvent, PredMdBaseEventTypedDict
+from .predmdeventwithcontracts import (
+    PredMdEventWithContracts,
+    PredMdEventWithContractsTypedDict,
+)
+from finance_dev.types import BaseModel
+import pydantic
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+
+class PredMdBaseEventWithEventsTypedDict(TypedDict):
+    base_event: PredMdBaseEventTypedDict
+    r"""Top-level 4castex base event (e.g. UNR, HORC)."""
+    events: List[PredMdEventWithContractsTypedDict]
+
+
+class PredMdBaseEventWithEvents(BaseModel):
+    base_event: Annotated[PredMdBaseEvent, pydantic.Field(alias="baseEvent")]
+    r"""Top-level 4castex base event (e.g. UNR, HORC)."""
+
+    events: List[PredMdEventWithContracts]
+
+
+try:
+    PredMdBaseEventWithEvents.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdbatchhistoryrequest.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 5359e4af5704
+
+from __future__ import annotations
+from .predmdhistoryrequest import PredMdHistoryRequest, PredMdHistoryRequestTypedDict
+from finance_dev.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class PredMdBatchHistoryRequestTypedDict(TypedDict):
+    queries: List[PredMdHistoryRequestTypedDict]
+
+
+class PredMdBatchHistoryRequest(BaseModel):
+    queries: List[PredMdHistoryRequest]

finance_dev/models/predmdbatchhistoryresponse.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: c186400b2c86
+
+from __future__ import annotations
+from .predmdhistoryresponse import PredMdHistoryResponse, PredMdHistoryResponseTypedDict
+from finance_dev.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class PredMdBatchHistoryResponseTypedDict(TypedDict):
+    results: List[PredMdHistoryResponseTypedDict]
+
+
+class PredMdBatchHistoryResponse(BaseModel):
+    results: List[PredMdHistoryResponse]

finance_dev/models/predmdcategory.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ec689d15009d
+
+from __future__ import annotations
+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 PredMdCategoryTypedDict(TypedDict):
+    r"""One node of the category tree."""
+
+    name: str
+    r"""This level's name, for display."""
+    path: str
+    r"""Every level from the top down to this one, joined by \" > \". It identifies the category and is what search takes as category."""
+    children: NotRequired[List[PredMdCategoryTypedDict]]
+    r"""The categories one level down, ordered by name. Absent on a leaf."""
+
+
+class PredMdCategory(BaseModel):
+    r"""One node of the category tree."""
+
+    name: str
+    r"""This level's name, for display."""
+
+    path: str
+    r"""Every level from the top down to this one, joined by \" > \". It identifies the category and is what search takes as category."""
+
+    children: Optional[List[PredMdCategory]] = None
+    r"""The categories one level down, ordered by name. Absent on a leaf."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["children"])
+        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/predmdcontract.py

@@ -0,0 +1,177 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 669328dd6fe7
+
+from __future__ import annotations
+from datetime import datetime
+from decimal import Decimal
+from finance_dev.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from finance_dev.utils import serialize_decimal, validate_decimal
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_serializers import PlainSerializer
+from pydantic.functional_validators import BeforeValidator
+from typing import Any, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PredMdContractTypedDict(TypedDict):
+    r"""A single tradable event contract at a specific strike."""
+
+    base_event_id: str
+    event_id: str
+    last_synced_at: datetime
+    non_tradable: bool
+    state: str
+    symbol: str
+    symbol_sub_types: List[str]
+    tick_size: Decimal
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+    tradable: bool
+    base_currency: NotRequired[str]
+    description: NotRequired[str]
+    evaluation_type: NotRequired[str]
+    expiration_date: NotRequired[Nullable[datetime]]
+    last_trade_date: NotRequired[Nullable[datetime]]
+    min_trade_qty: NotRequired[str]
+    multiplier: NotRequired[int]
+    price_limit: NotRequired[Any]
+    r"""Venue JSON payload (passthrough)."""
+    price_scale: NotRequired[str]
+    question: NotRequired[str]
+    start_date: NotRequired[Nullable[datetime]]
+    strike_unit: NotRequired[str]
+    strike_value: NotRequired[str]
+    termination_date: NotRequired[Nullable[datetime]]
+    trading_schedule: NotRequired[Any]
+    r"""Venue JSON payload (passthrough)."""
+
+
+class PredMdContract(BaseModel):
+    r"""A single tradable event contract at a specific strike."""
+
+    base_event_id: Annotated[str, pydantic.Field(alias="baseEventId")]
+
+    event_id: Annotated[str, pydantic.Field(alias="eventId")]
+
+    last_synced_at: Annotated[datetime, pydantic.Field(alias="lastSyncedAt")]
+
+    non_tradable: Annotated[bool, pydantic.Field(alias="nonTradable")]
+
+    state: str
+
+    symbol: str
+
+    symbol_sub_types: Annotated[List[str], pydantic.Field(alias="symbolSubTypes")]
+
+    tick_size: Annotated[
+        Annotated[
+            Decimal,
+            BeforeValidator(validate_decimal),
+            PlainSerializer(serialize_decimal(True)),
+        ],
+        pydantic.Field(alias="tickSize"),
+    ]
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+
+    tradable: bool
+
+    base_currency: Annotated[Optional[str], pydantic.Field(alias="baseCurrency")] = None
+
+    description: Optional[str] = None
+
+    evaluation_type: Annotated[
+        Optional[str], pydantic.Field(alias="evaluationType")
+    ] = None
+
+    expiration_date: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="expirationDate")
+    ] = UNSET
+
+    last_trade_date: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="lastTradeDate")
+    ] = UNSET
+
+    min_trade_qty: Annotated[Optional[str], pydantic.Field(alias="minTradeQty")] = None
+
+    multiplier: Optional[int] = None
+
+    price_limit: Annotated[Optional[Any], pydantic.Field(alias="priceLimit")] = None
+    r"""Venue JSON payload (passthrough)."""
+
+    price_scale: Annotated[Optional[str], pydantic.Field(alias="priceScale")] = None
+
+    question: Optional[str] = None
+
+    start_date: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="startDate")
+    ] = UNSET
+
+    strike_unit: Annotated[Optional[str], pydantic.Field(alias="strikeUnit")] = None
+
+    strike_value: Annotated[Optional[str], pydantic.Field(alias="strikeValue")] = None
+
+    termination_date: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="terminationDate")
+    ] = UNSET
+
+    trading_schedule: Annotated[
+        Optional[Any], pydantic.Field(alias="tradingSchedule")
+    ] = None
+    r"""Venue JSON payload (passthrough)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "baseCurrency",
+                "description",
+                "evaluationType",
+                "expirationDate",
+                "lastTradeDate",
+                "minTradeQty",
+                "multiplier",
+                "priceLimit",
+                "priceScale",
+                "question",
+                "startDate",
+                "strikeUnit",
+                "strikeValue",
+                "terminationDate",
+                "tradingSchedule",
+            ]
+        )
+        nullable_fields = set(
+            ["expirationDate", "lastTradeDate", "startDate", "terminationDate"]
+        )
+        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:
+    PredMdContract.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdcontracthit.py

@@ -0,0 +1,157 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 265a4adb5a1e
+
+from __future__ import annotations
+from datetime import datetime
+from decimal import Decimal
+from finance_dev.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from finance_dev.utils import serialize_decimal, validate_decimal
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_serializers import PlainSerializer
+from pydantic.functional_validators import BeforeValidator
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PredMdContractHitTypedDict(TypedDict):
+    r"""One matching contract, with its event's and base event's text flattened in. The index trails the catalogue by seconds; read the contract through /events/{eventId}/contracts when it must be current."""
+
+    base_event_id: str
+    event_id: str
+    state: str
+    symbol: str
+    symbol_sub_types: List[str]
+    tick_size: Decimal
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+    tradable: bool
+    evaluation_type: NotRequired[str]
+    event_display_name: NotRequired[str]
+    event_question: NotRequired[str]
+    expiration_date: NotRequired[Nullable[datetime]]
+    r"""Calendar date, at midnight UTC."""
+    last_trade_date: NotRequired[Nullable[datetime]]
+    r"""Calendar date, at midnight UTC."""
+    question: NotRequired[str]
+    start_date: NotRequired[Nullable[datetime]]
+    r"""Calendar date, at midnight UTC."""
+    strike_value: NotRequired[str]
+    time_specifier: NotRequired[str]
+    r"""Published precision: YYYY, YYYY.MM or YYYY.MM.DD."""
+    underlying_spec: NotRequired[str]
+
+
+class PredMdContractHit(BaseModel):
+    r"""One matching contract, with its event's and base event's text flattened in. The index trails the catalogue by seconds; read the contract through /events/{eventId}/contracts when it must be current."""
+
+    base_event_id: Annotated[str, pydantic.Field(alias="baseEventId")]
+
+    event_id: Annotated[str, pydantic.Field(alias="eventId")]
+
+    state: str
+
+    symbol: str
+
+    symbol_sub_types: Annotated[List[str], pydantic.Field(alias="symbolSubTypes")]
+
+    tick_size: Annotated[
+        Annotated[
+            Decimal,
+            BeforeValidator(validate_decimal),
+            PlainSerializer(serialize_decimal(True)),
+        ],
+        pydantic.Field(alias="tickSize"),
+    ]
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+
+    tradable: bool
+
+    evaluation_type: Annotated[
+        Optional[str], pydantic.Field(alias="evaluationType")
+    ] = None
+
+    event_display_name: Annotated[
+        Optional[str], pydantic.Field(alias="eventDisplayName")
+    ] = None
+
+    event_question: Annotated[Optional[str], pydantic.Field(alias="eventQuestion")] = (
+        None
+    )
+
+    expiration_date: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="expirationDate")
+    ] = UNSET
+    r"""Calendar date, at midnight UTC."""
+
+    last_trade_date: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="lastTradeDate")
+    ] = UNSET
+    r"""Calendar date, at midnight UTC."""
+
+    question: Optional[str] = None
+
+    start_date: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="startDate")
+    ] = UNSET
+    r"""Calendar date, at midnight UTC."""
+
+    strike_value: Annotated[Optional[str], pydantic.Field(alias="strikeValue")] = None
+
+    time_specifier: Annotated[Optional[str], pydantic.Field(alias="timeSpecifier")] = (
+        None
+    )
+    r"""Published precision: YYYY, YYYY.MM or YYYY.MM.DD."""
+
+    underlying_spec: Annotated[
+        Optional[str], pydantic.Field(alias="underlyingSpec")
+    ] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "evaluationType",
+                "eventDisplayName",
+                "eventQuestion",
+                "expirationDate",
+                "lastTradeDate",
+                "question",
+                "startDate",
+                "strikeValue",
+                "timeSpecifier",
+                "underlyingSpec",
+            ]
+        )
+        nullable_fields = set(["expirationDate", "lastTradeDate", "startDate"])
+        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:
+    PredMdContractHit.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdcontractsearchresult.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0e62d6e75865
+
+from __future__ import annotations
+from .predmdcontracthit import PredMdContractHit, PredMdContractHitTypedDict
+from enum import Enum
+from finance_dev.types import BaseModel
+import pydantic
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+
+class PredMdContractSearchResultType(str, Enum):
+    CONTRACTS = "contracts"
+
+
+class PredMdContractSearchResultTypedDict(TypedDict):
+    r"""One page of contracts."""
+
+    found: int
+    r"""Every match, not just this page."""
+    hits: List[PredMdContractHitTypedDict]
+    page: int
+    per_page: int
+    type: PredMdContractSearchResultType
+
+
+class PredMdContractSearchResult(BaseModel):
+    r"""One page of contracts."""
+
+    found: int
+    r"""Every match, not just this page."""
+
+    hits: List[PredMdContractHit]
+
+    page: int
+
+    per_page: Annotated[int, pydantic.Field(alias="perPage")]
+
+    type: PredMdContractSearchResultType
+
+
+try:
+    PredMdContractSearchResult.model_rebuild()
+except NameError:
+    pass