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

crypticorn/trade/client/models/{bot_model.py → bot.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)
@@ -17,45 +17,67 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, 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.bot_status import BotStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
 
-class BotModel(BaseModel):
+class Bot(BaseModel):
     """
-    BotModel
+    Trading bot model for read operations.
     """  # noqa: E501
 
-    created_at: Optional[StrictInt] = None
-    updated_at: Optional[StrictInt] = None
-    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"
+    )
     name: StrictStr = Field(description="Name of the bot")
+    allocation: StrictInt = Field(description="Initial allocation for the bot")
+    status: BotStatus = Field(description="Status of the bot")
     strategy_id: StrictStr = Field(
         description="UID for the trading strategy used by the bot"
     )
     api_key_id: StrictStr = Field(description="UID for the API key")
-    allocation: StrictInt = Field(description="Initial allocation for the bot")
-    status: BotStatus = Field(description="Status of the bot")
-    status_code: Optional[StrictStr] = Field(
-        default=None, description="API error identifiers"
+    status_code: Optional[ApiErrorIdentifier] = None
+    current_allocation: Optional[
+        Union[
+            Annotated[float, Field(strict=True, ge=0.0)],
+            Annotated[int, Field(strict=True, ge=0)],
+        ]
+    ] = Field(
+        default=0,
+        description="Initial allocation for the bot + accumulated PnL of the orders after the last allocation change",
+    )
+    current_exposure: Optional[
+        Union[
+            Annotated[float, Field(strict=True, ge=0.0)],
+            Annotated[int, Field(strict=True, ge=0)],
+        ]
+    ] = Field(
+        default=0,
+        description="Current exposure of the bot, aka. the sum of the absolute values of the open positions",
     )
-    user_id: Optional[StrictStr] = None
-    current_allocation: Optional[Union[StrictFloat, StrictInt]] = None
-    current_exposure: Optional[Union[StrictFloat, StrictInt]] = None
     __properties: ClassVar[List[str]] = [
+        "user_id",
+        "id",
         "created_at",
         "updated_at",
-        "id",
         "name",
-        "strategy_id",
-        "api_key_id",
         "allocation",
         "status",
+        "strategy_id",
+        "api_key_id",
         "status_code",
-        "user_id",
         "current_allocation",
         "current_exposure",
     ]
@@ -77,7 +99,7 @@ class BotModel(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of BotModel from a JSON string"""
+        """Create an instance of Bot from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -97,47 +119,16 @@ class BotModel(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
-
-        # set to None if current_allocation (nullable) is None
-        # and model_fields_set contains the field
-        if (
-            self.current_allocation is None
-            and "current_allocation" in self.model_fields_set
-        ):
-            _dict["current_allocation"] = None
-
-        # set to None if current_exposure (nullable) is None
+        # set to None if status_code (nullable) is None
         # and model_fields_set contains the field
-        if (
-            self.current_exposure is None
-            and "current_exposure" in self.model_fields_set
-        ):
-            _dict["current_exposure"] = None
+        if self.status_code is None and "status_code" in self.model_fields_set:
+            _dict["status_code"] = None
 
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of BotModel from a dict"""
+        """Create an instance of Bot from a dict"""
         if obj is None:
             return None
 
@@ -146,18 +137,26 @@ class BotModel(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"),
                 "name": obj.get("name"),
-                "strategy_id": obj.get("strategy_id"),
-                "api_key_id": obj.get("api_key_id"),
                 "allocation": obj.get("allocation"),
                 "status": obj.get("status"),
+                "strategy_id": obj.get("strategy_id"),
+                "api_key_id": obj.get("api_key_id"),
                 "status_code": obj.get("status_code"),
-                "user_id": obj.get("user_id"),
-                "current_allocation": obj.get("current_allocation"),
-                "current_exposure": obj.get("current_exposure"),
+                "current_allocation": (
+                    obj.get("current_allocation")
+                    if obj.get("current_allocation") is not None
+                    else 0
+                ),
+                "current_exposure": (
+                    obj.get("current_exposure")
+                    if obj.get("current_exposure") is not None
+                    else 0
+                ),
             }
         )
         return _obj

crypticorn/trade/client/models/bot_create.py

@@ -0,0 +1,104 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from crypticorn.trade.client.models.bot_status import BotStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class BotCreate(BaseModel):
+    """
+    Trading bot model for API create operations.
+    """  # noqa: E501
+
+    name: StrictStr = Field(description="Name of the bot")
+    allocation: StrictInt = Field(description="Initial allocation for the bot")
+    status: BotStatus = Field(description="Status of the bot")
+    strategy_id: StrictStr = Field(
+        description="UID for the trading strategy used by the bot"
+    )
+    api_key_id: StrictStr = Field(description="UID for the API key")
+    __properties: ClassVar[List[str]] = [
+        "name",
+        "allocation",
+        "status",
+        "strategy_id",
+        "api_key_id",
+    ]
+
+    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 BotCreate 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 BotCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": obj.get("name"),
+                "allocation": obj.get("allocation"),
+                "status": obj.get("status"),
+                "strategy_id": obj.get("strategy_id"),
+                "api_key_id": obj.get("api_key_id"),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/bot_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/bot_update.py

@@ -0,0 +1,107 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.trade.client.models.bot_status import BotStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class BotUpdate(BaseModel):
+    """
+    Trading bot model for API update operations.
+    """  # noqa: E501
+
+    name: Optional[StrictStr] = None
+    allocation: Optional[StrictInt] = None
+    status: Optional[BotStatus] = None
+    __properties: ClassVar[List[str]] = ["name", "allocation", "status"]
+
+    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 BotUpdate 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 name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict["name"] = None
+
+        # set to None if allocation (nullable) is None
+        # and model_fields_set contains the field
+        if self.allocation is None and "allocation" in self.model_fields_set:
+            _dict["allocation"] = 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BotUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": obj.get("name"),
+                "allocation": obj.get("allocation"),
+                "status": obj.get("status"),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/exception_detail.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,19 +19,22 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, 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 ExceptionDetail(BaseModel):
     """
-    This is the detail of the exception. It is used to enrich the exception with additional information by unwrapping the ApiError into its components.
+    Exception details returned to the client.
     """  # noqa: E501
 
     message: Optional[StrictStr] = None
-    code: StrictStr = Field(description="API error identifiers")
-    type: StrictStr = Field(description="Type of API error")
-    level: StrictStr = Field(description="API error levels")
+    code: ApiErrorIdentifier = Field(description="The unique error code")
+    type: ApiErrorType = Field(description="The type of error")
+    level: ApiErrorLevel = Field(description="The level of the error")
     status_code: StrictInt = Field(description="The HTTP status code")
     details: Optional[Any] = None
     __properties: ClassVar[List[str]] = [

crypticorn/trade/client/models/exchange.py

@@ -0,0 +1,36 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class Exchange(str, Enum):
+    """
+    Supported exchanges for trading
+    """
+
+    """
+    allowed enum values
+    """
+    KUCOIN = "kucoin"
+    BINGX = "bingx"
+    HYPERLIQUID = "hyperliquid"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Exchange from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/trade/client/models/exchange_key.py

@@ -0,0 +1,111 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.trade.client.models.exchange import Exchange
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ExchangeKey(BaseModel):
+    """
+    Exchange key model not containing sensitive information for read operations.
+    """  # noqa: E501
+
+    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"
+    )
+    label: StrictStr = Field(description="Label for the API key")
+    exchange: Exchange = Field(description="The exchange the API key is for.")
+    __properties: ClassVar[List[str]] = [
+        "user_id",
+        "id",
+        "created_at",
+        "updated_at",
+        "label",
+        "exchange",
+    ]
+
+    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 ExchangeKey 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 ExchangeKey from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _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"),
+                "label": obj.get("label"),
+                "exchange": obj.get("exchange"),
+            }
+        )
+        return _obj