crypticorn 2.11.6__py3-none-any.whl → 2.11.8__py3-none-any.whl

crypticorn/trade/client/models/{notification_model.py → notification.py}

@@ -3,7 +3,7 @@
 """
 Trading API
 
-API for automated trading and exchange interface
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -19,38 +19,53 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.trade.client.models.api_error_level import ApiErrorLevel
+from crypticorn.trade.client.models.api_error_type import ApiErrorType
 from typing import Optional, Set
 from typing_extensions import Self
 
 
-class NotificationModel(BaseModel):
+class Notification(BaseModel):
     """
-    NotificationModel
+    Notification model for read operations.
     """  # noqa: E501
 
-    created_at: Optional[StrictInt] = None
-    updated_at: Optional[StrictInt] = None
-    id: Optional[StrictStr] = None
-    identifier: StrictStr = Field(description="API error identifiers")
-    level: StrictStr = Field(description="API error levels")
-    type: StrictStr = Field(description="Type of API error")
-    user_id: Optional[StrictStr] = None
+    user_id: StrictStr = Field(description="UID for the user")
+    id: Optional[StrictStr] = Field(
+        default=None, description="Unique identifier for the resource"
+    )
+    created_at: Optional[StrictInt] = Field(
+        default=None, description="Timestamp of creation"
+    )
+    updated_at: Optional[StrictInt] = Field(
+        default=None, description="Timestamp of last update"
+    )
     viewed: Optional[StrictBool] = Field(
         default=False, description="Whether the notification has been marked as seen"
     )
     sent: Optional[StrictBool] = Field(
         default=False, description="Whether the notification has been sent as an email"
     )
+    identifier: ApiErrorIdentifier = Field(
+        description="Identifier string. Must match the mapping key in the frontend."
+    )
+    level: ApiErrorLevel = Field(
+        description="Level of the notification. Of type ApiErrorLevel"
+    )
+    type: ApiErrorType = Field(
+        description="Type of the notification. Of type ApiErrorType"
+    )
     __properties: ClassVar[List[str]] = [
+        "user_id",
+        "id",
         "created_at",
         "updated_at",
-        "id",
+        "viewed",
+        "sent",
         "identifier",
         "level",
         "type",
-        "user_id",
-        "viewed",
-        "sent",
     ]
 
     model_config = ConfigDict(
@@ -70,7 +85,7 @@ class NotificationModel(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of NotificationModel from a JSON string"""
+        """Create an instance of Notification from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -90,31 +105,11 @@ class NotificationModel(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # set to None if created_at (nullable) is None
-        # and model_fields_set contains the field
-        if self.created_at is None and "created_at" in self.model_fields_set:
-            _dict["created_at"] = None
-
-        # set to None if updated_at (nullable) is None
-        # and model_fields_set contains the field
-        if self.updated_at is None and "updated_at" in self.model_fields_set:
-            _dict["updated_at"] = None
-
-        # set to None if id (nullable) is None
-        # and model_fields_set contains the field
-        if self.id is None and "id" in self.model_fields_set:
-            _dict["id"] = None
-
-        # set to None if user_id (nullable) is None
-        # and model_fields_set contains the field
-        if self.user_id is None and "user_id" in self.model_fields_set:
-            _dict["user_id"] = None
-
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of NotificationModel from a dict"""
+        """Create an instance of Notification from a dict"""
         if obj is None:
             return None
 
@@ -123,15 +118,15 @@ class NotificationModel(BaseModel):
 
         _obj = cls.model_validate(
             {
+                "user_id": obj.get("user_id"),
+                "id": obj.get("id"),
                 "created_at": obj.get("created_at"),
                 "updated_at": obj.get("updated_at"),
-                "id": obj.get("id"),
+                "viewed": obj.get("viewed") if obj.get("viewed") is not None else False,
+                "sent": obj.get("sent") if obj.get("sent") is not None else False,
                 "identifier": obj.get("identifier"),
                 "level": obj.get("level"),
                 "type": obj.get("type"),
-                "user_id": obj.get("user_id"),
-                "viewed": obj.get("viewed") if obj.get("viewed") is not None else False,
-                "sent": obj.get("sent") if obj.get("sent") is not None else False,
             }
         )
         return _obj

crypticorn/trade/client/models/notification_create.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+Trading API
+
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.trade.client.models.api_error_level import ApiErrorLevel
+from crypticorn.trade.client.models.api_error_type import ApiErrorType
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class NotificationCreate(BaseModel):
+    """
+    Notification model for create operations.
+    """  # noqa: E501
+
+    viewed: Optional[StrictBool] = Field(
+        default=False, description="Whether the notification has been marked as seen"
+    )
+    sent: Optional[StrictBool] = Field(
+        default=False, description="Whether the notification has been sent as an email"
+    )
+    identifier: ApiErrorIdentifier = Field(
+        description="Identifier string. Must match the mapping key in the frontend."
+    )
+    level: ApiErrorLevel = Field(
+        description="Level of the notification. Of type ApiErrorLevel"
+    )
+    type: ApiErrorType = Field(
+        description="Type of the notification. Of type ApiErrorType"
+    )
+    __properties: ClassVar[List[str]] = [
+        "viewed",
+        "sent",
+        "identifier",
+        "level",
+        "type",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of NotificationCreate from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "viewed": obj.get("viewed") if obj.get("viewed") is not None else False,
+                "sent": obj.get("sent") if obj.get("sent") is not None else False,
+                "identifier": obj.get("identifier"),
+                "level": obj.get("level"),
+                "type": obj.get("type"),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/notification_update.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+Trading API
+
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class NotificationUpdate(BaseModel):
+    """
+    Notification model for API update operations.
+    """  # noqa: E501
+
+    viewed: Optional[StrictBool] = None
+    sent: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["viewed", "sent"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of NotificationUpdate from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if viewed (nullable) is None
+        # and model_fields_set contains the field
+        if self.viewed is None and "viewed" in self.model_fields_set:
+            _dict["viewed"] = None
+
+        # set to None if sent (nullable) is None
+        # and model_fields_set contains the field
+        if self.sent is None and "sent" in self.model_fields_set:
+            _dict["sent"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"viewed": obj.get("viewed"), "sent": obj.get("sent")}
+        )
+        return _obj

crypticorn/trade/client/models/{order_model.py → order.py}

@@ -3,7 +3,7 @@
 """
 Trading API
 
-API for automated trading and exchange interface
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -19,21 +19,31 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.trade.client.models.exchange import Exchange
 from crypticorn.trade.client.models.margin_mode import MarginMode
+from crypticorn.trade.client.models.market_type import MarketType
 from crypticorn.trade.client.models.order_status import OrderStatus
 from crypticorn.trade.client.models.trading_action_type import TradingActionType
 from typing import Optional, Set
 from typing_extensions import Self
 
 
-class OrderModel(BaseModel):
+class Order(BaseModel):
     """
     Response model for orders. All optional as the model is built step by step.
     """  # noqa: E501
 
-    created_at: Optional[StrictInt] = None
-    updated_at: Optional[StrictInt] = None
-    id: Optional[StrictStr] = None
+    id: Optional[StrictStr] = Field(
+        default=None, description="Unique identifier for the resource"
+    )
+    created_at: Optional[StrictInt] = Field(
+        default=None, description="Timestamp of creation"
+    )
+    updated_at: Optional[StrictInt] = Field(
+        default=None, description="Timestamp of last update"
+    )
     trading_action_id: Optional[StrictStr] = None
     execution_id: Optional[StrictStr] = None
     exchange_order_id: Optional[StrictStr] = None
@@ -42,32 +52,45 @@ class OrderModel(BaseModel):
     user_id: Optional[StrictStr] = None
     bot_id: Optional[StrictStr] = None
     client_order_id: Optional[StrictStr] = None
-    exchange: Optional[StrictStr] = Field(
-        default=None, description="Supported exchanges for trading"
-    )
+    exchange: Optional[Exchange] = None
     symbol: Optional[StrictStr] = None
     common_symbol: Optional[StrictStr] = None
     price: Optional[Union[StrictFloat, StrictInt]] = None
     action_type: Optional[TradingActionType] = None
-    market_type: Optional[StrictStr] = Field(default=None, description="Market types")
+    market_type: Optional[MarketType] = None
     margin_mode: Optional[MarginMode] = None
-    status_code: Optional[StrictStr] = Field(
-        default=None, description="API error identifiers"
-    )
+    status_code: Optional[ApiErrorIdentifier] = None
     status: Optional[OrderStatus] = None
-    filled_perc: Optional[Union[StrictFloat, StrictInt]] = None
-    filled_qty: Optional[Union[StrictFloat, StrictInt]] = None
-    fee: Optional[Union[StrictFloat, StrictInt]] = None
+    filled_perc: Optional[
+        Union[
+            Annotated[float, Field(le=1.0, strict=True, ge=0.0)],
+            Annotated[int, Field(le=1, strict=True, ge=0)],
+        ]
+    ] = Field(default=0, description="Percentage of the order filled")
+    filled_qty: Optional[
+        Union[
+            Annotated[float, Field(strict=True, ge=0.0)],
+            Annotated[int, Field(strict=True, ge=0)],
+        ]
+    ] = Field(
+        default=0,
+        description="Quantity filled. Needed for pnl calculation. In the symbol's base currency.",
+    )
+    fee: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=0, description="Fees for the order"
+    )
     leverage: Optional[Union[StrictFloat, StrictInt]] = None
     order_details: Optional[Any] = Field(
         default=None, description="Exchange specific details of the order"
     )
-    pnl: Optional[Union[StrictFloat, StrictInt]] = None
+    pnl: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=0, description="Profit and loss for the order"
+    )
     order_time: Optional[StrictInt] = None
     __properties: ClassVar[List[str]] = [
+        "id",
         "created_at",
         "updated_at",
-        "id",
         "trading_action_id",
         "execution_id",
         "exchange_order_id",
@@ -111,7 +134,7 @@ class OrderModel(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of OrderModel from a JSON string"""
+        """Create an instance of Order from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -134,21 +157,6 @@ class OrderModel(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of order_details
         if self.order_details:
             _dict["order_details"] = self.order_details.to_dict()
-        # set to None if created_at (nullable) is None
-        # and model_fields_set contains the field
-        if self.created_at is None and "created_at" in self.model_fields_set:
-            _dict["created_at"] = None
-
-        # set to None if updated_at (nullable) is None
-        # and model_fields_set contains the field
-        if self.updated_at is None and "updated_at" in self.model_fields_set:
-            _dict["updated_at"] = None
-
-        # set to None if id (nullable) is None
-        # and model_fields_set contains the field
-        if self.id is None and "id" in self.model_fields_set:
-            _dict["id"] = None
-
         # set to None if trading_action_id (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -195,6 +203,11 @@ class OrderModel(BaseModel):
         if self.client_order_id is None and "client_order_id" in self.model_fields_set:
             _dict["client_order_id"] = None
 
+        # set to None if exchange (nullable) is None
+        # and model_fields_set contains the field
+        if self.exchange is None and "exchange" in self.model_fields_set:
+            _dict["exchange"] = None
+
         # set to None if symbol (nullable) is None
         # and model_fields_set contains the field
         if self.symbol is None and "symbol" in self.model_fields_set:
@@ -215,31 +228,26 @@ class OrderModel(BaseModel):
         if self.action_type is None and "action_type" in self.model_fields_set:
             _dict["action_type"] = None
 
+        # set to None if market_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.market_type is None and "market_type" in self.model_fields_set:
+            _dict["market_type"] = None
+
         # set to None if margin_mode (nullable) is None
         # and model_fields_set contains the field
         if self.margin_mode is None and "margin_mode" in self.model_fields_set:
             _dict["margin_mode"] = None
 
+        # set to None if status_code (nullable) is None
+        # and model_fields_set contains the field
+        if self.status_code is None and "status_code" in self.model_fields_set:
+            _dict["status_code"] = None
+
         # set to None if status (nullable) is None
         # and model_fields_set contains the field
         if self.status is None and "status" in self.model_fields_set:
             _dict["status"] = None
 
-        # set to None if filled_perc (nullable) is None
-        # and model_fields_set contains the field
-        if self.filled_perc is None and "filled_perc" in self.model_fields_set:
-            _dict["filled_perc"] = None
-
-        # set to None if filled_qty (nullable) is None
-        # and model_fields_set contains the field
-        if self.filled_qty is None and "filled_qty" in self.model_fields_set:
-            _dict["filled_qty"] = None
-
-        # set to None if fee (nullable) is None
-        # and model_fields_set contains the field
-        if self.fee is None and "fee" in self.model_fields_set:
-            _dict["fee"] = None
-
         # set to None if leverage (nullable) is None
         # and model_fields_set contains the field
         if self.leverage is None and "leverage" in self.model_fields_set:
@@ -250,11 +258,6 @@ class OrderModel(BaseModel):
         if self.order_details is None and "order_details" in self.model_fields_set:
             _dict["order_details"] = None
 
-        # set to None if pnl (nullable) is None
-        # and model_fields_set contains the field
-        if self.pnl is None and "pnl" in self.model_fields_set:
-            _dict["pnl"] = None
-
         # set to None if order_time (nullable) is None
         # and model_fields_set contains the field
         if self.order_time is None and "order_time" in self.model_fields_set:
@@ -264,7 +267,7 @@ class OrderModel(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of OrderModel from a dict"""
+        """Create an instance of Order from a dict"""
         if obj is None:
             return None
 
@@ -273,9 +276,9 @@ class OrderModel(BaseModel):
 
         _obj = cls.model_validate(
             {
+                "id": obj.get("id"),
                 "created_at": obj.get("created_at"),
                 "updated_at": obj.get("updated_at"),
-                "id": obj.get("id"),
                 "trading_action_id": obj.get("trading_action_id"),
                 "execution_id": obj.get("execution_id"),
                 "exchange_order_id": obj.get("exchange_order_id"),
@@ -293,16 +296,20 @@ class OrderModel(BaseModel):
                 "margin_mode": obj.get("margin_mode"),
                 "status_code": obj.get("status_code"),
                 "status": obj.get("status"),
-                "filled_perc": obj.get("filled_perc"),
-                "filled_qty": obj.get("filled_qty"),
-                "fee": obj.get("fee"),
+                "filled_perc": (
+                    obj.get("filled_perc") if obj.get("filled_perc") is not None else 0
+                ),
+                "filled_qty": (
+                    obj.get("filled_qty") if obj.get("filled_qty") is not None else 0
+                ),
+                "fee": obj.get("fee") if obj.get("fee") is not None else 0,
                 "leverage": obj.get("leverage"),
                 "order_details": (
                     AnyOf.from_dict(obj["order_details"])
                     if obj.get("order_details") is not None
                     else None
                 ),
-                "pnl": obj.get("pnl"),
+                "pnl": obj.get("pnl") if obj.get("pnl") is not None else 0,
                 "order_time": obj.get("order_time"),
             }
         )

crypticorn/trade/client/models/order_status.py

@@ -3,7 +3,7 @@
 """
 Trading API
 
-API for automated trading and exchange interface
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)

crypticorn/trade/client/models/post_futures_action.py

@@ -3,7 +3,7 @@
 """
 Trading API
 
-API for automated trading and exchange interface
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)