finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/predmdevent.py

@@ -0,0 +1,136 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: dcd695b1e3d7
+
+from __future__ import annotations
+from datetime import datetime
+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 PredMdEventTypedDict(TypedDict):
+    r"""One real-world event under a base event (e.g. HORC_1126)."""
+
+    base_event_id: str
+    event_id: str
+    last_synced_at: datetime
+    calculation_method: NotRequired[str]
+    event_display_name: NotRequired[str]
+    event_question: NotRequired[str]
+    expected_last_trade_time: NotRequired[Nullable[datetime]]
+    r"""Venue wall-clock time; the feed carries no zone, so the Z is a label, not a conversion."""
+    expected_payout_time: NotRequired[Nullable[datetime]]
+    r"""Venue wall-clock time; the feed carries no zone, so the Z is a label, not a conversion."""
+    expected_resolution_time: NotRequired[Nullable[datetime]]
+    r"""Venue wall-clock time; the feed carries no zone, so the Z is a label, not a conversion."""
+    source_agency: NotRequired[str]
+    source_agency_url: NotRequired[str]
+    time_specifier: NotRequired[str]
+    r"""Published precision: YYYY, YYYY.MM or YYYY.MM.DD."""
+    underlying_spec: NotRequired[str]
+
+
+class PredMdEvent(BaseModel):
+    r"""One real-world event under a base event (e.g. HORC_1126)."""
+
+    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")]
+
+    calculation_method: Annotated[
+        Optional[str], pydantic.Field(alias="calculationMethod")
+    ] = None
+
+    event_display_name: Annotated[
+        Optional[str], pydantic.Field(alias="eventDisplayName")
+    ] = None
+
+    event_question: Annotated[Optional[str], pydantic.Field(alias="eventQuestion")] = (
+        None
+    )
+
+    expected_last_trade_time: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="expectedLastTradeTime")
+    ] = UNSET
+    r"""Venue wall-clock time; the feed carries no zone, so the Z is a label, not a conversion."""
+
+    expected_payout_time: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="expectedPayoutTime")
+    ] = UNSET
+    r"""Venue wall-clock time; the feed carries no zone, so the Z is a label, not a conversion."""
+
+    expected_resolution_time: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="expectedResolutionTime")
+    ] = UNSET
+    r"""Venue wall-clock time; the feed carries no zone, so the Z is a label, not a conversion."""
+
+    source_agency: Annotated[Optional[str], pydantic.Field(alias="sourceAgency")] = None
+
+    source_agency_url: Annotated[
+        Optional[str], pydantic.Field(alias="sourceAgencyUrl")
+    ] = 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(
+            [
+                "calculationMethod",
+                "eventDisplayName",
+                "eventQuestion",
+                "expectedLastTradeTime",
+                "expectedPayoutTime",
+                "expectedResolutionTime",
+                "sourceAgency",
+                "sourceAgencyUrl",
+                "timeSpecifier",
+                "underlyingSpec",
+            ]
+        )
+        nullable_fields = set(
+            ["expectedLastTradeTime", "expectedPayoutTime", "expectedResolutionTime"]
+        )
+        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:
+    PredMdEvent.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdeventhit.py

@@ -0,0 +1,73 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 3c77dcced425
+
+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 PredMdEventHitTypedDict(TypedDict):
+    r"""One event with at least one matching contract."""
+
+    base_event_id: str
+    contracts_found: int
+    r"""Every matching contract under this hit. Read them with type=contracts and eventId or baseEventId."""
+    event_id: str
+    event_display_name: NotRequired[str]
+    event_question: NotRequired[str]
+    time_specifier: NotRequired[str]
+    underlying_spec: NotRequired[str]
+
+
+class PredMdEventHit(BaseModel):
+    r"""One event with at least one matching contract."""
+
+    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."""
+
+    event_id: Annotated[str, pydantic.Field(alias="eventId")]
+
+    event_display_name: Annotated[
+        Optional[str], pydantic.Field(alias="eventDisplayName")
+    ] = None
+
+    event_question: Annotated[Optional[str], pydantic.Field(alias="eventQuestion")] = (
+        None
+    )
+
+    time_specifier: Annotated[Optional[str], pydantic.Field(alias="timeSpecifier")] = (
+        None
+    )
+
+    underlying_spec: Annotated[
+        Optional[str], pydantic.Field(alias="underlyingSpec")
+    ] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["eventDisplayName", "eventQuestion", "timeSpecifier", "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:
+    PredMdEventHit.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdeventsearchresult.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 3d8d63a77490
+
+from __future__ import annotations
+from .predmdeventhit import PredMdEventHit, PredMdEventHitTypedDict
+from enum import Enum
+from finance_dev.types import BaseModel
+import pydantic
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+
+class PredMdEventSearchResultType(str, Enum):
+    EVENTS = "events"
+
+
+class PredMdEventSearchResultTypedDict(TypedDict):
+    r"""One page of events. found, page and perPage count events."""
+
+    found: int
+    r"""Every match, not just this page."""
+    hits: List[PredMdEventHitTypedDict]
+    page: int
+    per_page: int
+    type: PredMdEventSearchResultType
+
+
+class PredMdEventSearchResult(BaseModel):
+    r"""One page of events. found, page and perPage count events."""
+
+    found: int
+    r"""Every match, not just this page."""
+
+    hits: List[PredMdEventHit]
+
+    page: int
+
+    per_page: Annotated[int, pydantic.Field(alias="perPage")]
+
+    type: PredMdEventSearchResultType
+
+
+try:
+    PredMdEventSearchResult.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdeventwithcontracts.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: e6d5a7cf495a
+
+from __future__ import annotations
+from .predmdcontract import PredMdContract, PredMdContractTypedDict
+from .predmdevent import PredMdEvent, PredMdEventTypedDict
+from finance_dev.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class PredMdEventWithContractsTypedDict(TypedDict):
+    contracts: List[PredMdContractTypedDict]
+    event: PredMdEventTypedDict
+    r"""One real-world event under a base event (e.g. HORC_1126)."""
+
+
+class PredMdEventWithContracts(BaseModel):
+    contracts: List[PredMdContract]
+
+    event: PredMdEvent
+    r"""One real-world event under a base event (e.g. HORC_1126)."""

finance_dev/models/predmdhistoryrequest.py

@@ -0,0 +1,59 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 6cad9408e342
+
+from __future__ import annotations
+from datetime import datetime
+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 PredMdHistoryRequestTypedDict(TypedDict):
+    r"""Single query within a batch historical-data request."""
+
+    symbol: str
+    from_: NotRequired[datetime]
+    r"""Inclusive lower bound. Zero/omitted means unbounded."""
+    limit: NotRequired[int]
+    r"""0 or omitted means 10000; values above 10000 are clamped to it."""
+    to: NotRequired[datetime]
+    r"""Inclusive upper bound. Zero/omitted means unbounded."""
+
+
+class PredMdHistoryRequest(BaseModel):
+    r"""Single query within a batch historical-data request."""
+
+    symbol: str
+
+    from_: Annotated[Optional[datetime], pydantic.Field(alias="from")] = None
+    r"""Inclusive lower bound. Zero/omitted means unbounded."""
+
+    limit: Optional[int] = None
+    r"""0 or omitted means 10000; values above 10000 are clamped to it."""
+
+    to: Optional[datetime] = None
+    r"""Inclusive upper bound. Zero/omitted means unbounded."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["from", "limit", "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
+
+
+try:
+    PredMdHistoryRequest.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdhistoryresponse.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 50fd4a633da8
+
+from __future__ import annotations
+from .predmdtick import PredMdTick, PredMdTickTypedDict
+from datetime import datetime
+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 PredMdHistoryResponseTypedDict(TypedDict):
+    count: int
+    symbol: str
+    ticks: List[PredMdTickTypedDict]
+    from_: NotRequired[datetime]
+    to: NotRequired[datetime]
+
+
+class PredMdHistoryResponse(BaseModel):
+    count: int
+
+    symbol: str
+
+    ticks: List[PredMdTick]
+
+    from_: Annotated[Optional[datetime], pydantic.Field(alias="from")] = None
+
+    to: Optional[datetime] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["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
+
+
+try:
+    PredMdHistoryResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predmdtick.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 32ce982b73f2
+
+from __future__ import annotations
+from datetime import datetime
+from decimal import Decimal
+from finance_dev.types import BaseModel
+from finance_dev.utils import serialize_decimal, validate_decimal
+import pydantic
+from pydantic.functional_serializers import PlainSerializer
+from pydantic.functional_validators import BeforeValidator
+from typing_extensions import Annotated, TypedDict
+
+
+class PredMdTickTypedDict(TypedDict):
+    no_price: Decimal
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+    quantity: int
+    timestamp: datetime
+    yes_price: Decimal
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+
+
+class PredMdTick(BaseModel):
+    no_price: Annotated[
+        Annotated[
+            Decimal,
+            BeforeValidator(validate_decimal),
+            PlainSerializer(serialize_decimal(True)),
+        ],
+        pydantic.Field(alias="noPrice"),
+    ]
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+
+    quantity: int
+
+    timestamp: datetime
+
+    yes_price: Annotated[
+        Annotated[
+            Decimal,
+            BeforeValidator(validate_decimal),
+            PlainSerializer(serialize_decimal(True)),
+        ],
+        pydantic.Field(alias="yesPrice"),
+    ]
+    r"""Exact decimal, serialized as a string so no client parses it through a float."""
+
+
+try:
+    PredMdTick.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predordersapperror.py

@@ -0,0 +1,78 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0473e4e109a9
+
+from __future__ import annotations
+from enum import Enum
+from finance_dev import models, utils
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import field_serializer, model_serializer
+from typing import Any, Dict, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class PredOrdersAppErrorType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Categorical error type, in lowercase."""
+
+    BAD_REQUEST = "bad_request"
+    AUTHENTICATION = "authentication"
+    NOT_FOUND = "not_found"
+    CONFLICT = "conflict"
+    RATE_LIMIT = "rate_limit"
+    UNAVAILABLE = "unavailable"
+    TIMEOUT = "timeout"
+    INTERNAL = "internal"
+
+
+class PredOrdersAppErrorTypedDict(TypedDict):
+    r"""Structured error returned by the prediction-market order endpoints."""
+
+    code: str
+    r"""Machine-readable code, e.g. `INVALID_ORDER`, `ORDER_OUTCOME_UNKNOWN`. Branch on this."""
+    message: str
+    r"""Human-readable detail. Exact text is not fixed and should not be matched on."""
+    type: PredOrdersAppErrorType
+    r"""Categorical error type, in lowercase."""
+    details: NotRequired[Dict[str, Any]]
+    request_id: NotRequired[str]
+
+
+class PredOrdersAppError(BaseModel):
+    r"""Structured error returned by the prediction-market order endpoints."""
+
+    code: str
+    r"""Machine-readable code, e.g. `INVALID_ORDER`, `ORDER_OUTCOME_UNKNOWN`. Branch on this."""
+
+    message: str
+    r"""Human-readable detail. Exact text is not fixed and should not be matched on."""
+
+    type: PredOrdersAppErrorType
+    r"""Categorical error type, in lowercase."""
+
+    details: Optional[Dict[str, Any]] = None
+
+    request_id: Optional[str] = None
+
+    @field_serializer("type")
+    def serialize_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PredOrdersAppErrorType(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["details", "request_id"])
+        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