finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/predordersorder.py

@@ -0,0 +1,267 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ff04981da167
+
+from __future__ import annotations
+from datetime import datetime
+from enum import Enum
+from finance_dev import models, utils
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import field_serializer, model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class Certainty(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How sure order entry is of `state`. Anything other than `certain` means the order's state could not be confirmed; `certaintyReason` says why."""
+
+    CERTAIN = "certain"
+    UNKNOWN_UNACKED = "unknown_unacked"
+    UNKNOWN_GAP = "unknown_gap"
+    UNKNOWN_STORE_LOST = "unknown_store_lost"
+
+
+class PredOrdersOrderOutcome(str, Enum, metaclass=utils.OpenEnumMeta):
+    YES = "YES"
+    NO = "NO"
+
+
+class PendingAction(str, Enum, metaclass=utils.OpenEnumMeta):
+    NONE = "none"
+    REPLACE = "replace"
+    CANCEL = "cancel"
+
+
+class State(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Order lifecycle state. `unknown` means order entry lost track of the order and says so rather than guessing; see `certainty`."""
+
+    PENDING_NEW = "pending_new"
+    NEW = "new"
+    PARTIALLY_FILLED = "partially_filled"
+    FILLED = "filled"
+    CANCELED = "canceled"
+    REJECTED = "rejected"
+    EXPIRED = "expired"
+    DONE_FOR_DAY = "done_for_day"
+    UNKNOWN = "unknown"
+
+
+class PredOrdersOrderTypedDict(TypedDict):
+    r"""An order as recorded by order entry. Submitted terms (`quantity`, `price`, …) never change; working terms (`workingQuantity`, `workingPrice`, …) are the venue's answer. Optional decimals and timestamps are omitted when absent, never zero."""
+
+    account_id: str
+    avg_px: str
+    r"""Average fill price. Exact decimal as a string."""
+    created_at: datetime
+    cum_qty: str
+    r"""Quantity filled so far. Exact decimal as a string."""
+    leaves_qty: str
+    r"""Quantity still working. Exact decimal as a string."""
+    order_id: str
+    order_type: str
+    outcome: PredOrdersOrderOutcome
+    quantity: str
+    r"""Exact decimal as a string."""
+    side: str
+    state: State
+    r"""Order lifecycle state. `unknown` means order entry lost track of the order and says so rather than guessing; see `certainty`."""
+    symbol: str
+    time_in_force: str
+    updated_at: datetime
+    working_quantity: str
+    r"""Exact decimal as a string."""
+    certainty: NotRequired[Certainty]
+    r"""How sure order entry is of `state`. Anything other than `certain` means the order's state could not be confirmed; `certaintyReason` says why."""
+    certainty_reason: NotRequired[str]
+    cl_ord_id: NotRequired[str]
+    r"""Client order ID sent to the venue."""
+    client_order_ref: NotRequired[str]
+    closed_at: NotRequired[datetime]
+    expire_time: NotRequired[datetime]
+    first_ack_at: NotRequired[datetime]
+    r"""When the venue first acknowledged the order."""
+    pending_action: NotRequired[PendingAction]
+    price: NotRequired[str]
+    r"""Exact decimal as a string."""
+    reject_reason: NotRequired[str]
+    reject_text: NotRequired[str]
+    r"""The venue's own rejection text. Most rejections carry their useful detail only here."""
+    sent_at: NotRequired[datetime]
+    stop_px: NotRequired[str]
+    r"""Exact decimal as a string."""
+    venue_order_id: NotRequired[str]
+    r"""Assigned by the venue on acknowledgement."""
+    working_order_type: NotRequired[str]
+    working_price: NotRequired[str]
+    r"""Exact decimal as a string."""
+
+
+class PredOrdersOrder(BaseModel):
+    r"""An order as recorded by order entry. Submitted terms (`quantity`, `price`, …) never change; working terms (`workingQuantity`, `workingPrice`, …) are the venue's answer. Optional decimals and timestamps are omitted when absent, never zero."""
+
+    account_id: Annotated[str, pydantic.Field(alias="accountId")]
+
+    avg_px: Annotated[str, pydantic.Field(alias="avgPx")]
+    r"""Average fill price. Exact decimal as a string."""
+
+    created_at: Annotated[datetime, pydantic.Field(alias="createdAt")]
+
+    cum_qty: Annotated[str, pydantic.Field(alias="cumQty")]
+    r"""Quantity filled so far. Exact decimal as a string."""
+
+    leaves_qty: Annotated[str, pydantic.Field(alias="leavesQty")]
+    r"""Quantity still working. Exact decimal as a string."""
+
+    order_id: Annotated[str, pydantic.Field(alias="orderId")]
+
+    order_type: Annotated[str, pydantic.Field(alias="orderType")]
+
+    outcome: PredOrdersOrderOutcome
+
+    quantity: str
+    r"""Exact decimal as a string."""
+
+    side: str
+
+    state: State
+    r"""Order lifecycle state. `unknown` means order entry lost track of the order and says so rather than guessing; see `certainty`."""
+
+    symbol: str
+
+    time_in_force: Annotated[str, pydantic.Field(alias="timeInForce")]
+
+    updated_at: Annotated[datetime, pydantic.Field(alias="updatedAt")]
+
+    working_quantity: Annotated[str, pydantic.Field(alias="workingQuantity")]
+    r"""Exact decimal as a string."""
+
+    certainty: Optional[Certainty] = None
+    r"""How sure order entry is of `state`. Anything other than `certain` means the order's state could not be confirmed; `certaintyReason` says why."""
+
+    certainty_reason: Annotated[
+        Optional[str], pydantic.Field(alias="certaintyReason")
+    ] = None
+
+    cl_ord_id: Annotated[Optional[str], pydantic.Field(alias="clOrdId")] = None
+    r"""Client order ID sent to the venue."""
+
+    client_order_ref: Annotated[
+        Optional[str], pydantic.Field(alias="clientOrderRef")
+    ] = None
+
+    closed_at: Annotated[Optional[datetime], pydantic.Field(alias="closedAt")] = None
+
+    expire_time: Annotated[Optional[datetime], pydantic.Field(alias="expireTime")] = (
+        None
+    )
+
+    first_ack_at: Annotated[Optional[datetime], pydantic.Field(alias="firstAckAt")] = (
+        None
+    )
+    r"""When the venue first acknowledged the order."""
+
+    pending_action: Annotated[
+        Optional[PendingAction], pydantic.Field(alias="pendingAction")
+    ] = None
+
+    price: Optional[str] = None
+    r"""Exact decimal as a string."""
+
+    reject_reason: Annotated[Optional[str], pydantic.Field(alias="rejectReason")] = None
+
+    reject_text: Annotated[Optional[str], pydantic.Field(alias="rejectText")] = None
+    r"""The venue's own rejection text. Most rejections carry their useful detail only here."""
+
+    sent_at: Annotated[Optional[datetime], pydantic.Field(alias="sentAt")] = None
+
+    stop_px: Annotated[Optional[str], pydantic.Field(alias="stopPx")] = None
+    r"""Exact decimal as a string."""
+
+    venue_order_id: Annotated[Optional[str], pydantic.Field(alias="venueOrderId")] = (
+        None
+    )
+    r"""Assigned by the venue on acknowledgement."""
+
+    working_order_type: Annotated[
+        Optional[str], pydantic.Field(alias="workingOrderType")
+    ] = None
+
+    working_price: Annotated[Optional[str], pydantic.Field(alias="workingPrice")] = None
+    r"""Exact decimal as a string."""
+
+    @field_serializer("certainty")
+    def serialize_certainty(self, value):
+        if isinstance(value, str):
+            try:
+                return models.Certainty(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("outcome")
+    def serialize_outcome(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PredOrdersOrderOutcome(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pending_action")
+    def serialize_pending_action(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PendingAction(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("state")
+    def serialize_state(self, value):
+        if isinstance(value, str):
+            try:
+                return models.State(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "certainty",
+                "certaintyReason",
+                "clOrdId",
+                "clientOrderRef",
+                "closedAt",
+                "expireTime",
+                "firstAckAt",
+                "pendingAction",
+                "price",
+                "rejectReason",
+                "rejectText",
+                "sentAt",
+                "stopPx",
+                "venueOrderId",
+                "workingOrderType",
+                "workingPrice",
+            ]
+        )
+        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:
+    PredOrdersOrder.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predordersorderdetail.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ac314e6c2d0c
+
+from __future__ import annotations
+from .predordersorder import PredOrdersOrder, PredOrdersOrderTypedDict
+from .predordersorderreport import PredOrdersOrderReport, PredOrdersOrderReportTypedDict
+from finance_dev.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class PredOrdersOrderDetailTypedDict(TypedDict):
+    r"""An order and every venue report against it, read from one snapshot."""
+
+    order: PredOrdersOrderTypedDict
+    r"""An order as recorded by order entry. Submitted terms (`quantity`, `price`, …) never change; working terms (`workingQuantity`, `workingPrice`, …) are the venue's answer. Optional decimals and timestamps are omitted when absent, never zero."""
+    reports: List[PredOrdersOrderReportTypedDict]
+
+
+class PredOrdersOrderDetail(BaseModel):
+    r"""An order and every venue report against it, read from one snapshot."""
+
+    order: PredOrdersOrder
+    r"""An order as recorded by order entry. Submitted terms (`quantity`, `price`, …) never change; working terms (`workingQuantity`, `workingPrice`, …) are the venue's answer. Optional decimals and timestamps are omitted when absent, never zero."""
+
+    reports: List[PredOrdersOrderReport]

finance_dev/models/predordersorderpage.py

@@ -0,0 +1,45 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 09dd9c68840e
+
+from __future__ import annotations
+from .predordersorder import PredOrdersOrder, PredOrdersOrderTypedDict
+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 PredOrdersOrderPageTypedDict(TypedDict):
+    orders: List[PredOrdersOrderTypedDict]
+    next_cursor: NotRequired[str]
+    r"""Pass as `cursor` to fetch the next page. Absent on the last page."""
+
+
+class PredOrdersOrderPage(BaseModel):
+    orders: List[PredOrdersOrder]
+
+    next_cursor: Annotated[Optional[str], pydantic.Field(alias="nextCursor")] = None
+    r"""Pass as `cursor` to fetch the next page. Absent on the last page."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["nextCursor"])
+        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:
+    PredOrdersOrderPage.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predordersorderreport.py

@@ -0,0 +1,88 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 8a68437ae16f
+
+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 PredOrdersOrderReportTypedDict(TypedDict):
+    r"""One venue execution report against the order. Quantities and prices are omitted when the venue did not send them for that report type."""
+
+    exec_id: str
+    exec_type: str
+    status: str
+    transact_time: datetime
+    avg_px: NotRequired[str]
+    r"""Exact decimal as a string."""
+    busted_at: NotRequired[datetime]
+    r"""Set when the venue later cancelled this trade."""
+    cum_qty: NotRequired[str]
+    r"""Exact decimal as a string."""
+    last_px: NotRequired[str]
+    r"""Exact decimal as a string."""
+    last_qty: NotRequired[str]
+    r"""Exact decimal as a string."""
+    leaves_qty: NotRequired[str]
+    r"""Exact decimal as a string."""
+    text: NotRequired[str]
+
+
+class PredOrdersOrderReport(BaseModel):
+    r"""One venue execution report against the order. Quantities and prices are omitted when the venue did not send them for that report type."""
+
+    exec_id: Annotated[str, pydantic.Field(alias="execId")]
+
+    exec_type: Annotated[str, pydantic.Field(alias="execType")]
+
+    status: str
+
+    transact_time: Annotated[datetime, pydantic.Field(alias="transactTime")]
+
+    avg_px: Annotated[Optional[str], pydantic.Field(alias="avgPx")] = None
+    r"""Exact decimal as a string."""
+
+    busted_at: Annotated[Optional[datetime], pydantic.Field(alias="bustedAt")] = None
+    r"""Set when the venue later cancelled this trade."""
+
+    cum_qty: Annotated[Optional[str], pydantic.Field(alias="cumQty")] = None
+    r"""Exact decimal as a string."""
+
+    last_px: Annotated[Optional[str], pydantic.Field(alias="lastPx")] = None
+    r"""Exact decimal as a string."""
+
+    last_qty: Annotated[Optional[str], pydantic.Field(alias="lastQty")] = None
+    r"""Exact decimal as a string."""
+
+    leaves_qty: Annotated[Optional[str], pydantic.Field(alias="leavesQty")] = None
+    r"""Exact decimal as a string."""
+
+    text: Optional[str] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["avgPx", "bustedAt", "cumQty", "lastPx", "lastQty", "leavesQty", "text"]
+        )
+        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:
+    PredOrdersOrderReport.model_rebuild()
+except NameError:
+    pass

finance_dev/models/predordersplaceorderrequest.py

@@ -0,0 +1,159 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 5fdf0f801821
+
+from __future__ import annotations
+from datetime import datetime
+from enum import Enum
+from finance_dev import models, utils
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import field_serializer, model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class OrderType(str, Enum, metaclass=utils.OpenEnumMeta):
+    LIMIT = "limit"
+    STOP = "stop"
+    STOP_LIMIT = "stop_limit"
+    MARKET_TO_LIMIT = "market_to_limit"
+
+
+class PredOrdersPlaceOrderRequestOutcome(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The binary outcome the order trades. It is never inferred from `side`."""
+
+    YES = "YES"
+    NO = "NO"
+
+
+class PredOrdersPlaceOrderRequestSide(str, Enum, metaclass=utils.OpenEnumMeta):
+    BUY = "buy"
+    SELL = "sell"
+
+
+class TimeInForce(str, Enum, metaclass=utils.OpenEnumMeta):
+    DAY = "day"
+    GTC = "gtc"
+    IOC = "ioc"
+    FOK = "fok"
+    GTD = "gtd"
+
+
+class PredOrdersPlaceOrderRequestTypedDict(TypedDict):
+    r"""Unknown fields are rejected with `400`. The user is always the authenticated caller and cannot be named in the body."""
+
+    account_id: str
+    r"""The account to place the order on."""
+    order_type: OrderType
+    outcome: PredOrdersPlaceOrderRequestOutcome
+    r"""The binary outcome the order trades. It is never inferred from `side`."""
+    quantity: str
+    r"""Number of contracts as an exact decimal string. Must be greater than zero."""
+    side: PredOrdersPlaceOrderRequestSide
+    symbol: str
+    r"""Prediction-market contract symbol, as returned by search or Get Event Contracts."""
+    time_in_force: TimeInForce
+    client_order_ref: NotRequired[str]
+    r"""Your own reference for the order, unique per account. Reusing one returns `409` `CLIENT_ORDER_REF_IN_USE`; it is not a retry key. To retry safely, use the `Idempotency-Key` header."""
+    expire_time: NotRequired[datetime]
+    r"""Required when `timeInForce` is `gtd`."""
+    price: NotRequired[str]
+    r"""Limit price as an exact decimal string. Required for `limit` and `stop_limit`."""
+    stop_px: NotRequired[str]
+    r"""Stop price as an exact decimal string. Required for `stop` and `stop_limit`."""
+
+
+class PredOrdersPlaceOrderRequest(BaseModel):
+    r"""Unknown fields are rejected with `400`. The user is always the authenticated caller and cannot be named in the body."""
+
+    account_id: Annotated[str, pydantic.Field(alias="accountId")]
+    r"""The account to place the order on."""
+
+    order_type: Annotated[OrderType, pydantic.Field(alias="orderType")]
+
+    outcome: PredOrdersPlaceOrderRequestOutcome
+    r"""The binary outcome the order trades. It is never inferred from `side`."""
+
+    quantity: str
+    r"""Number of contracts as an exact decimal string. Must be greater than zero."""
+
+    side: PredOrdersPlaceOrderRequestSide
+
+    symbol: str
+    r"""Prediction-market contract symbol, as returned by search or Get Event Contracts."""
+
+    time_in_force: Annotated[TimeInForce, pydantic.Field(alias="timeInForce")]
+
+    client_order_ref: Annotated[
+        Optional[str], pydantic.Field(alias="clientOrderRef")
+    ] = None
+    r"""Your own reference for the order, unique per account. Reusing one returns `409` `CLIENT_ORDER_REF_IN_USE`; it is not a retry key. To retry safely, use the `Idempotency-Key` header."""
+
+    expire_time: Annotated[Optional[datetime], pydantic.Field(alias="expireTime")] = (
+        None
+    )
+    r"""Required when `timeInForce` is `gtd`."""
+
+    price: Optional[str] = None
+    r"""Limit price as an exact decimal string. Required for `limit` and `stop_limit`."""
+
+    stop_px: Annotated[Optional[str], pydantic.Field(alias="stopPx")] = None
+    r"""Stop price as an exact decimal string. Required for `stop` and `stop_limit`."""
+
+    @field_serializer("order_type")
+    def serialize_order_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OrderType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("outcome")
+    def serialize_outcome(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PredOrdersPlaceOrderRequestOutcome(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("side")
+    def serialize_side(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PredOrdersPlaceOrderRequestSide(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("time_in_force")
+    def serialize_time_in_force(self, value):
+        if isinstance(value, str):
+            try:
+                return models.TimeInForce(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["clientOrderRef", "expireTime", "price", "stopPx"])
+        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:
+    PredOrdersPlaceOrderRequest.model_rebuild()
+except NameError:
+    pass

finance_dev/models/previeworderop.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 1c67bed9b926
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .previeworderresponse import PreviewOrderResponse, PreviewOrderResponseTypedDict
+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 PreviewOrderResponseResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    preview_order_response: NotRequired[PreviewOrderResponseTypedDict]
+    r"""Order preview calculated successfully"""
+
+
+class PreviewOrderResponseResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    preview_order_response: Optional[PreviewOrderResponse] = None
+    r"""Order preview calculated successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["PreviewOrderResponse"])
+        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