finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/cancelordrequest_union.py

@@ -0,0 +1,287 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 127fcace2615
+
+from __future__ import annotations
+from .ordersideenum import OrderSideEnum
+from .securitytypeenum import SecurityTypeEnum
+from datetime import date
+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, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+class CancelOrdRequestPutCall2(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Option contract type for option cancels. Use `CALL` for calls and `PUT` for puts. Omit for equity cancels."""
+
+    PUT = "PUT"
+    CALL = "CALL"
+    P = "P"
+    C = "C"
+
+
+class CancelOrdRequest2TypedDict(TypedDict):
+    orig_cl_ord_id: str
+    r"""Client order ID of the original order you want to cancel. Use the `clOrdId` returned by Place Order or List active orders."""
+    side: OrderSideEnum
+    r"""Which direction to trade in. Pick one:
+    - `BUY` — buying shares or contracts (opens a long position or closes an existing short).
+    - `SELL` — selling shares or contracts you already hold (closes a long position).
+    - `SELL_SHORT` — selling shares you do not own (opens a short position). Subject to short-sale regulations.
+    - `BUY_TO_COVER` — buying shares to close an open short position.
+    """
+    symbol: str
+    r"""Symbol on the original order. Use the exact symbol from the order record."""
+    trading_account_id: str
+    r"""Trading account identifier that owns the order being canceled. It must match the account on the original order."""
+    account_id: NotRequired[str]
+    r"""Account identifier; provide accountId or tradingAccountId. Both may be supplied."""
+    maturity: NotRequired[date]
+    r"""Option expiration date in YYYY-MM-DD format. Send this for option cancels when the original order was an option order."""
+    put_call: NotRequired[CancelOrdRequestPutCall2]
+    r"""Option contract type for option cancels. Use `CALL` for calls and `PUT` for puts. Omit for equity cancels."""
+    security_type: NotRequired[SecurityTypeEnum]
+    r"""What kind of instrument the order is for. Pick one:
+    - `CS` — Common Stock (equity / ETF).
+    - `OPT` — Option contract (call or put).
+    """
+    strike_price: NotRequired[str]
+    r"""Option strike price as a decimal string. Send this for option cancels when the original order was an option order."""
+
+
+class CancelOrdRequest2(BaseModel):
+    orig_cl_ord_id: Annotated[str, pydantic.Field(alias="origClOrdId")]
+    r"""Client order ID of the original order you want to cancel. Use the `clOrdId` returned by Place Order or List active orders."""
+
+    side: OrderSideEnum
+    r"""Which direction to trade in. Pick one:
+    - `BUY` — buying shares or contracts (opens a long position or closes an existing short).
+    - `SELL` — selling shares or contracts you already hold (closes a long position).
+    - `SELL_SHORT` — selling shares you do not own (opens a short position). Subject to short-sale regulations.
+    - `BUY_TO_COVER` — buying shares to close an open short position.
+    """
+
+    symbol: str
+    r"""Symbol on the original order. Use the exact symbol from the order record."""
+
+    trading_account_id: Annotated[str, pydantic.Field(alias="tradingAccountId")]
+    r"""Trading account identifier that owns the order being canceled. It must match the account on the original order."""
+
+    account_id: Annotated[Optional[str], pydantic.Field(alias="accountId")] = None
+    r"""Account identifier; provide accountId or tradingAccountId. Both may be supplied."""
+
+    maturity: Optional[date] = None
+    r"""Option expiration date in YYYY-MM-DD format. Send this for option cancels when the original order was an option order."""
+
+    put_call: Annotated[
+        Optional[CancelOrdRequestPutCall2], pydantic.Field(alias="putCall")
+    ] = None
+    r"""Option contract type for option cancels. Use `CALL` for calls and `PUT` for puts. Omit for equity cancels."""
+
+    security_type: Annotated[
+        Optional[SecurityTypeEnum], pydantic.Field(alias="securityType")
+    ] = None
+    r"""What kind of instrument the order is for. Pick one:
+    - `CS` — Common Stock (equity / ETF).
+    - `OPT` — Option contract (call or put).
+    """
+
+    strike_price: Annotated[Optional[str], pydantic.Field(alias="strikePrice")] = None
+    r"""Option strike price as a decimal string. Send this for option cancels when the original order was an option order."""
+
+    @field_serializer("put_call")
+    def serialize_put_call(self, value):
+        if isinstance(value, str):
+            try:
+                return models.CancelOrdRequestPutCall2(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("security_type")
+    def serialize_security_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.SecurityTypeEnum(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("side")
+    def serialize_side(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OrderSideEnum(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["accountId", "maturity", "putCall", "securityType", "strikePrice"]
+        )
+        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 CancelOrdRequestPutCall1(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Option contract type for option cancels. Use `CALL` for calls and `PUT` for puts. Omit for equity cancels."""
+
+    PUT = "PUT"
+    CALL = "CALL"
+    P = "P"
+    C = "C"
+
+
+class CancelOrdRequest1TypedDict(TypedDict):
+    account_id: str
+    r"""Account identifier; provide accountId or tradingAccountId. Both may be supplied."""
+    orig_cl_ord_id: str
+    r"""Client order ID of the original order you want to cancel. Use the `clOrdId` returned by Place Order or List active orders."""
+    side: OrderSideEnum
+    r"""Which direction to trade in. Pick one:
+    - `BUY` — buying shares or contracts (opens a long position or closes an existing short).
+    - `SELL` — selling shares or contracts you already hold (closes a long position).
+    - `SELL_SHORT` — selling shares you do not own (opens a short position). Subject to short-sale regulations.
+    - `BUY_TO_COVER` — buying shares to close an open short position.
+    """
+    symbol: str
+    r"""Symbol on the original order. Use the exact symbol from the order record."""
+    maturity: NotRequired[date]
+    r"""Option expiration date in YYYY-MM-DD format. Send this for option cancels when the original order was an option order."""
+    put_call: NotRequired[CancelOrdRequestPutCall1]
+    r"""Option contract type for option cancels. Use `CALL` for calls and `PUT` for puts. Omit for equity cancels."""
+    security_type: NotRequired[SecurityTypeEnum]
+    r"""What kind of instrument the order is for. Pick one:
+    - `CS` — Common Stock (equity / ETF).
+    - `OPT` — Option contract (call or put).
+    """
+    strike_price: NotRequired[str]
+    r"""Option strike price as a decimal string. Send this for option cancels when the original order was an option order."""
+    trading_account_id: NotRequired[str]
+    r"""Trading account identifier that owns the order being canceled. It must match the account on the original order."""
+
+
+class CancelOrdRequest1(BaseModel):
+    account_id: Annotated[str, pydantic.Field(alias="accountId")]
+    r"""Account identifier; provide accountId or tradingAccountId. Both may be supplied."""
+
+    orig_cl_ord_id: Annotated[str, pydantic.Field(alias="origClOrdId")]
+    r"""Client order ID of the original order you want to cancel. Use the `clOrdId` returned by Place Order or List active orders."""
+
+    side: OrderSideEnum
+    r"""Which direction to trade in. Pick one:
+    - `BUY` — buying shares or contracts (opens a long position or closes an existing short).
+    - `SELL` — selling shares or contracts you already hold (closes a long position).
+    - `SELL_SHORT` — selling shares you do not own (opens a short position). Subject to short-sale regulations.
+    - `BUY_TO_COVER` — buying shares to close an open short position.
+    """
+
+    symbol: str
+    r"""Symbol on the original order. Use the exact symbol from the order record."""
+
+    maturity: Optional[date] = None
+    r"""Option expiration date in YYYY-MM-DD format. Send this for option cancels when the original order was an option order."""
+
+    put_call: Annotated[
+        Optional[CancelOrdRequestPutCall1], pydantic.Field(alias="putCall")
+    ] = None
+    r"""Option contract type for option cancels. Use `CALL` for calls and `PUT` for puts. Omit for equity cancels."""
+
+    security_type: Annotated[
+        Optional[SecurityTypeEnum], pydantic.Field(alias="securityType")
+    ] = None
+    r"""What kind of instrument the order is for. Pick one:
+    - `CS` — Common Stock (equity / ETF).
+    - `OPT` — Option contract (call or put).
+    """
+
+    strike_price: Annotated[Optional[str], pydantic.Field(alias="strikePrice")] = None
+    r"""Option strike price as a decimal string. Send this for option cancels when the original order was an option order."""
+
+    trading_account_id: Annotated[
+        Optional[str], pydantic.Field(alias="tradingAccountId")
+    ] = None
+    r"""Trading account identifier that owns the order being canceled. It must match the account on the original order."""
+
+    @field_serializer("put_call")
+    def serialize_put_call(self, value):
+        if isinstance(value, str):
+            try:
+                return models.CancelOrdRequestPutCall1(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("security_type")
+    def serialize_security_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.SecurityTypeEnum(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("side")
+    def serialize_side(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OrderSideEnum(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["maturity", "putCall", "securityType", "strikePrice", "tradingAccountId"]
+        )
+        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
+
+
+CancelOrdRequestUnionTypedDict = TypeAliasType(
+    "CancelOrdRequestUnionTypedDict",
+    Union[CancelOrdRequest1TypedDict, CancelOrdRequest2TypedDict],
+)
+r"""Request body for canceling an open order through the core trading API. Use this when the user wants to stop an order that has not fully filled."""
+
+
+CancelOrdRequestUnion = TypeAliasType(
+    "CancelOrdRequestUnion", Union[CancelOrdRequest1, CancelOrdRequest2]
+)
+r"""Request body for canceling an open order through the core trading API. Use this when the user wants to stop an order that has not fully filled."""
+
+
+try:
+    CancelOrdRequest2.model_rebuild()
+except NameError:
+    pass
+try:
+    CancelOrdRequest1.model_rebuild()
+except NameError:
+    pass

finance_dev/models/cancelordresponse.py

@@ -0,0 +1,115 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: c467684a3239
+
+from __future__ import annotations
+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 CancelOrdResponseStatus(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Order status after the cancel request. Typical values after a successful cancel:
+    - `PENDING_CANCEL` — cancel request accepted by the broker but not yet final. Keep monitoring; will move to `CANCELED` once confirmed.
+    - `CANCELED` — order is fully cancelled; no further fills will occur.
+    - `REJECTED` — the cancel was refused (e.g. the order had already fully filled). The original order is unchanged.
+
+    The full FIX OrdStatus enum is supported — see the Place Order response for the complete list of possible values.
+    """
+
+    NEW = "NEW"
+    PARTIALLY_FILLED = "PARTIALLY_FILLED"
+    FILLED = "FILLED"
+    DONE_FOR_DAY = "DONE_FOR_DAY"
+    CANCELED = "CANCELED"
+    REPLACED = "REPLACED"
+    PENDING_CANCEL = "PENDING_CANCEL"
+    STOPPED = "STOPPED"
+    REJECTED = "REJECTED"
+    SUSPENDED = "SUSPENDED"
+    PENDING_NEW = "PENDING_NEW"
+    CALCULATED = "CALCULATED"
+    EXPIRED = "EXPIRED"
+    ACCEPTED_FOR_BID = "ACCEPTED_FOR_BID"
+    PENDING_REPLACE = "PENDING_REPLACE"
+    SUPERSEDED = "SUPERSEDED"
+
+
+class CancelOrdResponseTypedDict(TypedDict):
+    r"""Response returned after requesting an order cancel. Treat it as the cancel result and continue monitoring if the status is pending."""
+
+    cl_ord_id: NotRequired[str]
+    r"""Client order ID associated with the cancel action. Store it for audit and status matching."""
+    orig_cl_ord_id: NotRequired[str]
+    r"""Client order ID of the original order being canceled. Use it to connect this cancel result to the user's order."""
+    status: NotRequired[CancelOrdResponseStatus]
+    r"""Order status after the cancel request. Typical values after a successful cancel:
+    - `PENDING_CANCEL` — cancel request accepted by the broker but not yet final. Keep monitoring; will move to `CANCELED` once confirmed.
+    - `CANCELED` — order is fully cancelled; no further fills will occur.
+    - `REJECTED` — the cancel was refused (e.g. the order had already fully filled). The original order is unchanged.
+
+    The full FIX OrdStatus enum is supported — see the Place Order response for the complete list of possible values.
+    """
+    success: NotRequired[bool]
+    r"""Whether Aries or the broker accepted the cancel request for processing."""
+    text: NotRequired[str]
+    r"""Broker or platform message about the cancel result. Show it when the cancel is rejected or needs explanation."""
+
+
+class CancelOrdResponse(BaseModel):
+    r"""Response returned after requesting an order cancel. Treat it as the cancel result and continue monitoring if the status is pending."""
+
+    cl_ord_id: Annotated[Optional[str], pydantic.Field(alias="clOrdId")] = None
+    r"""Client order ID associated with the cancel action. Store it for audit and status matching."""
+
+    orig_cl_ord_id: Annotated[Optional[str], pydantic.Field(alias="origClOrdId")] = None
+    r"""Client order ID of the original order being canceled. Use it to connect this cancel result to the user's order."""
+
+    status: Optional[CancelOrdResponseStatus] = None
+    r"""Order status after the cancel request. Typical values after a successful cancel:
+    - `PENDING_CANCEL` — cancel request accepted by the broker but not yet final. Keep monitoring; will move to `CANCELED` once confirmed.
+    - `CANCELED` — order is fully cancelled; no further fills will occur.
+    - `REJECTED` — the cancel was refused (e.g. the order had already fully filled). The original order is unchanged.
+
+    The full FIX OrdStatus enum is supported — see the Place Order response for the complete list of possible values.
+    """
+
+    success: Optional[bool] = None
+    r"""Whether Aries or the broker accepted the cancel request for processing."""
+
+    text: Optional[str] = None
+    r"""Broker or platform message about the cancel result. Show it when the cancel is rejected or needs explanation."""
+
+    @field_serializer("status")
+    def serialize_status(self, value):
+        if isinstance(value, str):
+            try:
+                return models.CancelOrdResponseStatus(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["clOrdId", "origClOrdId", "status", "success", "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:
+    CancelOrdResponse.model_rebuild()
+except NameError:
+    pass