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

crypticorn/trade/client/models/{action_model.py → spot_trading_action_create.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)
@@ -28,26 +28,22 @@ from pydantic import (
 )
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing_extensions import Annotated
-from crypticorn.trade.client.models.margin_mode import MarginMode
+from crypticorn.trade.client.models.market_type import MarketType
 from crypticorn.trade.client.models.tpsl import TPSL
 from crypticorn.trade.client.models.trading_action_type import TradingActionType
 from typing import Optional, Set
 from typing_extensions import Self
 
 
-class ActionModel(BaseModel):
+class SpotTradingActionCreate(BaseModel):
     """
-    ActionModel
+    Model for sending spot trading actions
     """  # noqa: E501
 
-    created_at: Optional[StrictInt] = None
-    updated_at: Optional[StrictInt] = None
-    id: Optional[StrictStr] = None
     execution_id: Optional[StrictStr] = None
     open_order_execution_id: Optional[StrictStr] = None
-    client_order_id: Optional[StrictStr] = None
     action_type: TradingActionType = Field(description="The type of action.")
-    market_type: StrictStr = Field(description="Market types")
+    market_type: MarketType = Field(description="The type of market the action is for.")
     strategy_id: StrictStr = Field(description="UID for the strategy.")
     symbol: StrictStr = Field(
         description="Trading symbol or asset pair in format: 'symbol/quote_currency' (see market service for valid symbols)"
@@ -66,16 +62,9 @@ class ActionModel(BaseModel):
     take_profit: Optional[List[TPSL]] = None
     stop_loss: Optional[List[TPSL]] = None
     expiry_timestamp: Optional[StrictInt] = None
-    position_id: Optional[StrictStr] = None
-    leverage: Optional[Annotated[int, Field(strict=True, ge=1)]]
-    margin_mode: Optional[MarginMode] = None
     __properties: ClassVar[List[str]] = [
-        "created_at",
-        "updated_at",
-        "id",
         "execution_id",
         "open_order_execution_id",
-        "client_order_id",
         "action_type",
         "market_type",
         "strategy_id",
@@ -86,9 +75,6 @@ class ActionModel(BaseModel):
         "take_profit",
         "stop_loss",
         "expiry_timestamp",
-        "position_id",
-        "leverage",
-        "margin_mode",
     ]
 
     model_config = ConfigDict(
@@ -108,7 +94,7 @@ class ActionModel(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of ActionModel from a JSON string"""
+        """Create an instance of SpotTradingActionCreate from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -142,21 +128,6 @@ class ActionModel(BaseModel):
                 if _item_stop_loss:
                     _items.append(_item_stop_loss.to_dict())
             _dict["stop_loss"] = _items
-        # 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 execution_id (nullable) is None
         # and model_fields_set contains the field
         if self.execution_id is None and "execution_id" in self.model_fields_set:
@@ -170,11 +141,6 @@ class ActionModel(BaseModel):
         ):
             _dict["open_order_execution_id"] = None
 
-        # set to None if client_order_id (nullable) is None
-        # and model_fields_set contains the field
-        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 is_limit (nullable) is None
         # and model_fields_set contains the field
         if self.is_limit is None and "is_limit" in self.model_fields_set:
@@ -203,26 +169,11 @@ class ActionModel(BaseModel):
         ):
             _dict["expiry_timestamp"] = None
 
-        # set to None if position_id (nullable) is None
-        # and model_fields_set contains the field
-        if self.position_id is None and "position_id" in self.model_fields_set:
-            _dict["position_id"] = 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:
-            _dict["leverage"] = 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
-
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ActionModel from a dict"""
+        """Create an instance of SpotTradingActionCreate from a dict"""
         if obj is None:
             return None
 
@@ -231,12 +182,8 @@ class ActionModel(BaseModel):
 
         _obj = cls.model_validate(
             {
-                "created_at": obj.get("created_at"),
-                "updated_at": obj.get("updated_at"),
-                "id": obj.get("id"),
                 "execution_id": obj.get("execution_id"),
                 "open_order_execution_id": obj.get("open_order_execution_id"),
-                "client_order_id": obj.get("client_order_id"),
                 "action_type": obj.get("action_type"),
                 "market_type": obj.get("market_type"),
                 "strategy_id": obj.get("strategy_id"),
@@ -255,11 +202,6 @@ class ActionModel(BaseModel):
                     else None
                 ),
                 "expiry_timestamp": obj.get("expiry_timestamp"),
-                "position_id": obj.get("position_id"),
-                "leverage": (
-                    obj.get("leverage") if obj.get("leverage") is not None else 1
-                ),
-                "margin_mode": obj.get("margin_mode"),
             }
         )
         return _obj

crypticorn/trade/client/models/{strategy_model_input.py → strategy.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)
@@ -20,21 +20,25 @@ import json
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing_extensions import Annotated
+from crypticorn.trade.client.models.market_type import MarketType
 from crypticorn.trade.client.models.strategy_exchange_info import StrategyExchangeInfo
 from typing import Optional, Set
 from typing_extensions import Self
 
 
-class StrategyModelInput(BaseModel):
+class Strategy(BaseModel):
     """
-    StrategyModelInput
+    Strategy model for read operations.
     """  # noqa: E501
 
-    created_at: Optional[StrictInt] = None
-    updated_at: Optional[StrictInt] = None
-    id: Optional[StrictStr] = None
-    identifier: StrictStr = Field(
-        description="Unique human readable identifier for the strategy e.g. 'daily_trend_momentum'"
+    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 strategy")
     description: StrictStr = Field(description="Description of the strategy")
@@ -44,23 +48,26 @@ class StrategyModelInput(BaseModel):
     enabled: StrictBool = Field(
         description="Whether the strategy is enabled. If false, no bots will be created or updated for this strategy, open trades will be rejected. Existing bots will be marked as stopping."
     )
-    leverage: StrictInt = Field(description="Leverage for the strategy")
     performance_fee: Union[
         Annotated[float, Field(le=1.0, strict=True)],
         Annotated[int, Field(le=1, strict=True)],
     ] = Field(description="Performance fee for the strategy")
-    market_type: StrictStr = Field(description="Market types")
+    identifier: StrictStr = Field(
+        description="Unique human readable identifier for the strategy e.g. 'daily_trend_momentum'"
+    )
+    leverage: StrictInt = Field(description="Leverage for the strategy")
+    market_type: MarketType = Field(description="Market of operation of the strategy")
     __properties: ClassVar[List[str]] = [
+        "id",
         "created_at",
         "updated_at",
-        "id",
-        "identifier",
         "name",
         "description",
         "exchanges",
         "enabled",
-        "leverage",
         "performance_fee",
+        "identifier",
+        "leverage",
         "market_type",
     ]
 
@@ -81,7 +88,7 @@ class StrategyModelInput(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of StrategyModelInput from a JSON string"""
+        """Create an instance of Strategy from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -108,26 +115,11 @@ class StrategyModelInput(BaseModel):
                 if _item_exchanges:
                     _items.append(_item_exchanges.to_dict())
             _dict["exchanges"] = _items
-        # 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
-
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of StrategyModelInput from a dict"""
+        """Create an instance of Strategy from a dict"""
         if obj is None:
             return None
 
@@ -136,10 +128,9 @@ class StrategyModelInput(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"),
-                "identifier": obj.get("identifier"),
                 "name": obj.get("name"),
                 "description": obj.get("description"),
                 "exchanges": (
@@ -151,8 +142,9 @@ class StrategyModelInput(BaseModel):
                     else None
                 ),
                 "enabled": obj.get("enabled"),
-                "leverage": obj.get("leverage"),
                 "performance_fee": obj.get("performance_fee"),
+                "identifier": obj.get("identifier"),
+                "leverage": obj.get("leverage"),
                 "market_type": obj.get("market_type"),
             }
         )

crypticorn/trade/client/models/{strategy_model_output.py → strategy_create.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)
@@ -18,24 +18,19 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Any, ClassVar, Dict, List, Union
 from typing_extensions import Annotated
+from crypticorn.trade.client.models.market_type import MarketType
 from crypticorn.trade.client.models.strategy_exchange_info import StrategyExchangeInfo
 from typing import Optional, Set
 from typing_extensions import Self
 
 
-class StrategyModelOutput(BaseModel):
+class StrategyCreate(BaseModel):
     """
-    StrategyModelOutput
+    Strategy model for API create operations.
     """  # noqa: E501
 
-    created_at: Optional[StrictInt] = None
-    updated_at: Optional[StrictInt] = None
-    id: Optional[StrictStr] = None
-    identifier: StrictStr = Field(
-        description="Unique human readable identifier for the strategy e.g. 'daily_trend_momentum'"
-    )
     name: StrictStr = Field(description="Name of the strategy")
     description: StrictStr = Field(description="Description of the strategy")
     exchanges: List[StrategyExchangeInfo] = Field(
@@ -44,23 +39,23 @@ class StrategyModelOutput(BaseModel):
     enabled: StrictBool = Field(
         description="Whether the strategy is enabled. If false, no bots will be created or updated for this strategy, open trades will be rejected. Existing bots will be marked as stopping."
     )
-    leverage: StrictInt = Field(description="Leverage for the strategy")
     performance_fee: Union[
         Annotated[float, Field(le=1.0, strict=True)],
         Annotated[int, Field(le=1, strict=True)],
     ] = Field(description="Performance fee for the strategy")
-    market_type: StrictStr = Field(description="Market types")
+    identifier: StrictStr = Field(
+        description="Unique human readable identifier for the strategy e.g. 'daily_trend_momentum'"
+    )
+    leverage: StrictInt = Field(description="Leverage for the strategy")
+    market_type: MarketType = Field(description="Market of operation of the strategy")
     __properties: ClassVar[List[str]] = [
-        "created_at",
-        "updated_at",
-        "id",
-        "identifier",
         "name",
         "description",
         "exchanges",
         "enabled",
-        "leverage",
         "performance_fee",
+        "identifier",
+        "leverage",
         "market_type",
     ]
 
@@ -81,7 +76,7 @@ class StrategyModelOutput(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of StrategyModelOutput from a JSON string"""
+        """Create an instance of StrategyCreate from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -108,26 +103,11 @@ class StrategyModelOutput(BaseModel):
                 if _item_exchanges:
                     _items.append(_item_exchanges.to_dict())
             _dict["exchanges"] = _items
-        # 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
-
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of StrategyModelOutput from a dict"""
+        """Create an instance of StrategyCreate from a dict"""
         if obj is None:
             return None
 
@@ -136,10 +116,6 @@ class StrategyModelOutput(BaseModel):
 
         _obj = cls.model_validate(
             {
-                "created_at": obj.get("created_at"),
-                "updated_at": obj.get("updated_at"),
-                "id": obj.get("id"),
-                "identifier": obj.get("identifier"),
                 "name": obj.get("name"),
                 "description": obj.get("description"),
                 "exchanges": (
@@ -151,8 +127,9 @@ class StrategyModelOutput(BaseModel):
                     else None
                 ),
                 "enabled": obj.get("enabled"),
-                "leverage": obj.get("leverage"),
                 "performance_fee": obj.get("performance_fee"),
+                "identifier": obj.get("identifier"),
+                "leverage": obj.get("leverage"),
                 "market_type": obj.get("market_type"),
             }
         )

crypticorn/trade/client/models/strategy_exchange_info.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,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
 from typing import Any, ClassVar, Dict, List, Union
+from crypticorn.trade.client.models.exchange import Exchange
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +29,7 @@ class StrategyExchangeInfo(BaseModel):
     StrategyExchangeInfo
     """  # noqa: E501
 
-    exchange: StrictStr = Field(description="Supported exchanges for trading")
+    exchange: Exchange = Field(description="Exchange name. Of type Exchange")
     min_amount: Union[StrictFloat, StrictInt] = Field(
         description="Minimum amount for the strategy on the exchange"
     )

crypticorn/trade/client/models/strategy_update.py

@@ -0,0 +1,147 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from crypticorn.trade.client.models.strategy_exchange_info import StrategyExchangeInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class StrategyUpdate(BaseModel):
+    """
+    Strategy model for API update operations.
+    """  # noqa: E501
+
+    name: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    exchanges: Optional[List[StrategyExchangeInfo]] = None
+    enabled: Optional[StrictBool] = None
+    performance_fee: Optional[
+        Union[
+            Annotated[float, Field(le=1.0, strict=True)],
+            Annotated[int, Field(le=1, strict=True)],
+        ]
+    ] = None
+    __properties: ClassVar[List[str]] = [
+        "name",
+        "description",
+        "exchanges",
+        "enabled",
+        "performance_fee",
+    ]
+
+    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 StrategyUpdate 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in exchanges (list)
+        _items = []
+        if self.exchanges:
+            for _item_exchanges in self.exchanges:
+                if _item_exchanges:
+                    _items.append(_item_exchanges.to_dict())
+            _dict["exchanges"] = _items
+        # 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 description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict["description"] = None
+
+        # set to None if exchanges (nullable) is None
+        # and model_fields_set contains the field
+        if self.exchanges is None and "exchanges" in self.model_fields_set:
+            _dict["exchanges"] = None
+
+        # set to None if enabled (nullable) is None
+        # and model_fields_set contains the field
+        if self.enabled is None and "enabled" in self.model_fields_set:
+            _dict["enabled"] = None
+
+        # set to None if performance_fee (nullable) is None
+        # and model_fields_set contains the field
+        if self.performance_fee is None and "performance_fee" in self.model_fields_set:
+            _dict["performance_fee"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StrategyUpdate 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"),
+                "description": obj.get("description"),
+                "exchanges": (
+                    [
+                        StrategyExchangeInfo.from_dict(_item)
+                        for _item in obj["exchanges"]
+                    ]
+                    if obj.get("exchanges") is not None
+                    else None
+                ),
+                "enabled": obj.get("enabled"),
+                "performance_fee": obj.get("performance_fee"),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/tpsl.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/trading_action_type.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/rest.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-2.11.6.dist-info → crypticorn-2.11.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.11.6
+Version: 2.11.7
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT