crypticorn 2.16.0__py3-none-any.whl → 2.17.0__py3-none-any.whl

crypticorn/trade/client/models/notification_create.py

@@ -28,7 +28,7 @@ from typing_extensions import Self
 
 class NotificationCreate(BaseModel):
     """
-    Notification model for create operations.
+    Notification model for creating new system alerts and messages.
     """  # noqa: E501
 
     viewed: Optional[StrictBool] = Field(
@@ -46,6 +46,7 @@ class NotificationCreate(BaseModel):
     type: ApiErrorType = Field(
         description="Type of the notification. Of type ApiErrorType"
     )
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = [
         "viewed",
         "sent",
@@ -83,14 +84,24 @@ class NotificationCreate(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         return _dict
 
     @classmethod
@@ -111,4 +122,9 @@ class NotificationCreate(BaseModel):
                 "type": obj.get("type"),
             }
         )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj

crypticorn/trade/client/models/notification_update.py

@@ -30,6 +30,7 @@ class NotificationUpdate(BaseModel):
 
     viewed: Optional[StrictBool] = None
     sent: Optional[StrictBool] = None
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["viewed", "sent"]
 
     model_config = ConfigDict(
@@ -61,14 +62,24 @@ class NotificationUpdate(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         # 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:
@@ -93,4 +104,9 @@ class NotificationUpdate(BaseModel):
         _obj = cls.model_validate(
             {"viewed": obj.get("viewed"), "sent": obj.get("sent")}
         )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj

crypticorn/trade/client/models/orders_count.py

@@ -0,0 +1,88 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class OrdersCount(BaseModel):
+    """
+    The number of orders for a user by day
+    """  # noqa: E501
+
+    timestamp: StrictInt = Field(
+        description="Timestamp of the latest order for the day"
+    )
+    count: StrictInt = Field(description="The number of orders for the day")
+    __properties: ClassVar[List[str]] = ["timestamp", "count"]
+
+    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 OrdersCount 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 OrdersCount from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"timestamp": obj.get("timestamp"), "count": obj.get("count")}
+        )
+        return _obj

crypticorn/trade/client/models/paginated_response_futures_trading_action.py

@@ -0,0 +1,134 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.trade.client.models.futures_trading_action import FuturesTradingAction
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PaginatedResponseFuturesTradingAction(BaseModel):
+    """
+    PaginatedResponseFuturesTradingAction
+    """  # noqa: E501
+
+    data: List[FuturesTradingAction]
+    total: StrictInt = Field(description="The total number of items")
+    page: StrictInt = Field(description="The current page number")
+    page_size: StrictInt = Field(description="The number of items per page")
+    prev: Optional[StrictInt] = None
+    next: Optional[StrictInt] = None
+    last: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = [
+        "data",
+        "total",
+        "page",
+        "page_size",
+        "prev",
+        "next",
+        "last",
+    ]
+
+    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 PaginatedResponseFuturesTradingAction 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 data (list)
+        _items = []
+        if self.data:
+            for _item_data in self.data:
+                if _item_data:
+                    _items.append(_item_data.to_dict())
+            _dict["data"] = _items
+        # set to None if prev (nullable) is None
+        # and model_fields_set contains the field
+        if self.prev is None and "prev" in self.model_fields_set:
+            _dict["prev"] = None
+
+        # set to None if next (nullable) is None
+        # and model_fields_set contains the field
+        if self.next is None and "next" in self.model_fields_set:
+            _dict["next"] = None
+
+        # set to None if last (nullable) is None
+        # and model_fields_set contains the field
+        if self.last is None and "last" in self.model_fields_set:
+            _dict["last"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaginatedResponseFuturesTradingAction from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "data": (
+                    [FuturesTradingAction.from_dict(_item) for _item in obj["data"]]
+                    if obj.get("data") is not None
+                    else None
+                ),
+                "total": obj.get("total"),
+                "page": obj.get("page"),
+                "page_size": obj.get("page_size"),
+                "prev": obj.get("prev"),
+                "next": obj.get("next"),
+                "last": obj.get("last"),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/paginated_response_order.py

@@ -0,0 +1,134 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.trade.client.models.order import Order
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PaginatedResponseOrder(BaseModel):
+    """
+    PaginatedResponseOrder
+    """  # noqa: E501
+
+    data: List[Order]
+    total: StrictInt = Field(description="The total number of items")
+    page: StrictInt = Field(description="The current page number")
+    page_size: StrictInt = Field(description="The number of items per page")
+    prev: Optional[StrictInt] = None
+    next: Optional[StrictInt] = None
+    last: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = [
+        "data",
+        "total",
+        "page",
+        "page_size",
+        "prev",
+        "next",
+        "last",
+    ]
+
+    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 PaginatedResponseOrder 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 data (list)
+        _items = []
+        if self.data:
+            for _item_data in self.data:
+                if _item_data:
+                    _items.append(_item_data.to_dict())
+            _dict["data"] = _items
+        # set to None if prev (nullable) is None
+        # and model_fields_set contains the field
+        if self.prev is None and "prev" in self.model_fields_set:
+            _dict["prev"] = None
+
+        # set to None if next (nullable) is None
+        # and model_fields_set contains the field
+        if self.next is None and "next" in self.model_fields_set:
+            _dict["next"] = None
+
+        # set to None if last (nullable) is None
+        # and model_fields_set contains the field
+        if self.last is None and "last" in self.model_fields_set:
+            _dict["last"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaginatedResponseOrder from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "data": (
+                    [Order.from_dict(_item) for _item in obj["data"]]
+                    if obj.get("data") is not None
+                    else None
+                ),
+                "total": obj.get("total"),
+                "page": obj.get("page"),
+                "page_size": obj.get("page_size"),
+                "prev": obj.get("prev"),
+                "next": obj.get("next"),
+                "last": obj.get("last"),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/pn_l.py

@@ -0,0 +1,95 @@
+# 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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PnL(BaseModel):
+    """
+    The profit and loss of a bot by timestamp. In the case of sampling, the PnL is the sum of the PnLs between the prior timestamp and the current timestamp.
+    """  # noqa: E501
+
+    timestamp: StrictInt = Field(description="Timestamp of the order")
+    pnl: Union[StrictFloat, StrictInt] = Field(
+        description="The profit and loss of the order"
+    )
+    cum_pnl: Union[StrictFloat, StrictInt] = Field(
+        description="The cumulative profit and loss of the bot until the order (inclusive)"
+    )
+    __properties: ClassVar[List[str]] = ["timestamp", "pnl", "cum_pnl"]
+
+    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 PnL 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 PnL from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "timestamp": obj.get("timestamp"),
+                "pnl": obj.get("pnl"),
+                "cum_pnl": obj.get("cum_pnl"),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/post_futures_action.py

@@ -26,7 +26,7 @@ from typing_extensions import Self
 
 class PostFuturesAction(BaseModel):
     """
-    PostFuturesAction
+    The response when posting a futures action
     """  # noqa: E501
 
     id: StrictStr = Field(description="Action ID.")

crypticorn/trade/client/models/spot_balance.py

@@ -0,0 +1,109 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class SpotBalance(BaseModel):
+    """
+    Model for spot balance
+    """  # noqa: E501
+
+    asset: StrictStr = Field(description="Asset/Currency code")
+    balance: Union[StrictFloat, StrictInt] = Field(description="Balance of the asset")
+    available: Union[StrictFloat, StrictInt] = Field(
+        description="Available balance for trading/withdrawal"
+    )
+    frozen: Union[StrictFloat, StrictInt] = Field(
+        description="Frozen funds not available for use"
+    )
+    allocated: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=0, description="Allocated balance for bots. Added on runtime."
+    )
+    __properties: ClassVar[List[str]] = [
+        "asset",
+        "balance",
+        "available",
+        "frozen",
+        "allocated",
+    ]
+
+    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 SpotBalance 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 SpotBalance from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "asset": obj.get("asset"),
+                "balance": obj.get("balance"),
+                "available": obj.get("available"),
+                "frozen": obj.get("frozen"),
+                "allocated": (
+                    obj.get("allocated") if obj.get("allocated") is not None else 0
+                ),
+            }
+        )
+        return _obj