crypticorn 2.17.0rc4__py3-none-any.whl → 2.17.0rc6__py3-none-any.whl

crypticorn/trade/client/api/orders_api.py

@@ -16,9 +16,10 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import StrictInt
+from pydantic import Field, StrictStr, field_validator
 from typing import List, Optional
-from crypticorn.trade.client.models.order import Order
+from typing_extensions import Annotated
+from crypticorn.trade.client.models.orders_count import OrdersCount
 
 from crypticorn.trade.client.api_client import ApiClient, RequestSerialized
 from crypticorn.trade.client.api_response import ApiResponse
@@ -57,10 +58,20 @@ class OrdersApi:
         self.is_sync = is_sync
 
     @validate_call
-    def get_orders(
+    def get_orders_count(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -72,15 +83,13 @@ class OrdersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Order]:
-        """Get Orders
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+    ) -> List[OrdersCount]:
+        """Get Orders Count"""
         if self.is_sync:
-            return self._get_orders_sync(
-                limit=limit,
-                offset=offset,
+            return self._get_orders_count_sync(
+                sort_order=sort_order,
+                sort_by=sort_by,
+                group_by=group_by,
                 _request_timeout=_request_timeout,
                 _request_auth=_request_auth,
                 _content_type=_content_type,
@@ -89,9 +98,10 @@ class OrdersApi:
             )
 
         else:
-            return self._get_orders_async(
-                limit=limit,
-                offset=offset,
+            return self._get_orders_count_async(
+                sort_order=sort_order,
+                sort_by=sort_by,
+                group_by=group_by,
                 _request_timeout=_request_timeout,
                 _request_auth=_request_auth,
                 _content_type=_content_type,
@@ -100,10 +110,20 @@ class OrdersApi:
             )
 
     @validate_call
-    def get_orders_with_http_info(
+    def get_orders_count_with_http_info(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -115,15 +135,13 @@ class OrdersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Order]]:
-        """Get Orders with HTTP info
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+    ) -> ApiResponse[List[OrdersCount]]:
+        """Get Orders Count with HTTP info"""
         if self.is_sync:
-            return self._get_orders_sync_with_http_info(
-                limit=limit,
-                offset=offset,
+            return self._get_orders_count_sync_with_http_info(
+                sort_order=sort_order,
+                sort_by=sort_by,
+                group_by=group_by,
                 _request_timeout=_request_timeout,
                 _request_auth=_request_auth,
                 _content_type=_content_type,
@@ -132,9 +150,10 @@ class OrdersApi:
             )
 
         else:
-            return self._get_orders_async_with_http_info(
-                limit=limit,
-                offset=offset,
+            return self._get_orders_count_async_with_http_info(
+                sort_order=sort_order,
+                sort_by=sort_by,
+                group_by=group_by,
                 _request_timeout=_request_timeout,
                 _request_auth=_request_auth,
                 _content_type=_content_type,
@@ -143,10 +162,20 @@ class OrdersApi:
             )
 
     @validate_call
-    def get_orders_without_preload_content(
+    def get_orders_count_without_preload_content(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -159,14 +188,12 @@ class OrdersApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get Orders without preloading content
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+        """Get Orders Count without preloading content"""
         if self.is_sync:
-            return self._get_orders_sync_without_preload_content(
-                limit=limit,
-                offset=offset,
+            return self._get_orders_count_sync_without_preload_content(
+                sort_order=sort_order,
+                sort_by=sort_by,
+                group_by=group_by,
                 _request_timeout=_request_timeout,
                 _request_auth=_request_auth,
                 _content_type=_content_type,
@@ -175,9 +202,10 @@ class OrdersApi:
             )
 
         else:
-            return self._get_orders_async_without_preload_content(
-                limit=limit,
-                offset=offset,
+            return self._get_orders_count_async_without_preload_content(
+                sort_order=sort_order,
+                sort_by=sort_by,
+                group_by=group_by,
                 _request_timeout=_request_timeout,
                 _request_auth=_request_auth,
                 _content_type=_content_type,
@@ -187,10 +215,20 @@ class OrdersApi:
 
     # Private async implementation methods
     @validate_call
-    async def _get_orders_async(
+    async def _get_orders_count_async(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -202,15 +240,17 @@ class OrdersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Order]:
-        """Get Orders
+    ) -> List[OrdersCount]:
+        """Get Orders Count
 
-        Get all orders for a user
+        Get the number of orders for all users by day, week, month, or year. The default sort is `timestamp` and the default order is `asc`..
 
-        :param limit:
-        :type limit: int
-        :param offset:
-        :type offset: int
+        :param sort_order: The order to sort by
+        :type sort_order: str
+        :param sort_by: The field to sort by
+        :type sort_by: str
+        :param group_by: The group by period for the orders count. Defaults to day.
+        :type group_by: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -233,9 +273,10 @@ class OrdersApi:
         :return: Returns the result object.
         """  # noqa: E501
 
-        _param = self._get_orders_serialize(
-            limit=limit,
-            offset=offset,
+        _param = self._get_orders_count_serialize(
+            sort_order=sort_order,
+            sort_by=sort_by,
+            group_by=group_by,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -243,7 +284,7 @@ class OrdersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Order]",
+            "200": "List[OrdersCount]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -255,10 +296,20 @@ class OrdersApi:
         ).data
 
     @validate_call
-    async def _get_orders_async_with_http_info(
+    async def _get_orders_count_async_with_http_info(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -270,15 +321,17 @@ class OrdersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Order]]:
-        """Get Orders
+    ) -> ApiResponse[List[OrdersCount]]:
+        """Get Orders Count
 
-        Get all orders for a user
+        Get the number of orders for all users by day, week, month, or year. The default sort is `timestamp` and the default order is `asc`..
 
-        :param limit:
-        :type limit: int
-        :param offset:
-        :type offset: int
+        :param sort_order: The order to sort by
+        :type sort_order: str
+        :param sort_by: The field to sort by
+        :type sort_by: str
+        :param group_by: The group by period for the orders count. Defaults to day.
+        :type group_by: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -301,9 +354,10 @@ class OrdersApi:
         :return: Returns the result object.
         """  # noqa: E501
 
-        _param = self._get_orders_serialize(
-            limit=limit,
-            offset=offset,
+        _param = self._get_orders_count_serialize(
+            sort_order=sort_order,
+            sort_by=sort_by,
+            group_by=group_by,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -311,7 +365,7 @@ class OrdersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Order]",
+            "200": "List[OrdersCount]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -322,10 +376,20 @@ class OrdersApi:
         )
 
     @validate_call
-    async def _get_orders_async_without_preload_content(
+    async def _get_orders_count_async_without_preload_content(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -338,14 +402,16 @@ class OrdersApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get Orders
+        """Get Orders Count
 
-        Get all orders for a user
+        Get the number of orders for all users by day, week, month, or year. The default sort is `timestamp` and the default order is `asc`..
 
-        :param limit:
-        :type limit: int
-        :param offset:
-        :type offset: int
+        :param sort_order: The order to sort by
+        :type sort_order: str
+        :param sort_by: The field to sort by
+        :type sort_by: str
+        :param group_by: The group by period for the orders count. Defaults to day.
+        :type group_by: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -368,9 +434,10 @@ class OrdersApi:
         :return: Returns the result object.
         """  # noqa: E501
 
-        _param = self._get_orders_serialize(
-            limit=limit,
-            offset=offset,
+        _param = self._get_orders_count_serialize(
+            sort_order=sort_order,
+            sort_by=sort_by,
+            group_by=group_by,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -378,7 +445,7 @@ class OrdersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Order]",
+            "200": "List[OrdersCount]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -387,10 +454,20 @@ class OrdersApi:
 
     # Private sync implementation methods
     @validate_call
-    def _get_orders_sync(
+    def _get_orders_count_sync(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -402,11 +479,12 @@ class OrdersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Order]:
-        """Synchronous version of get_orders"""
-        return async_to_sync(self._get_orders_async)(
-            limit=limit,
-            offset=offset,
+    ) -> List[OrdersCount]:
+        """Synchronous version of get_orders_count"""
+        return async_to_sync(self._get_orders_count_async)(
+            sort_order=sort_order,
+            sort_by=sort_by,
+            group_by=group_by,
             _request_timeout=_request_timeout,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -415,10 +493,20 @@ class OrdersApi:
         )
 
     @validate_call
-    def _get_orders_sync_with_http_info(
+    def _get_orders_count_sync_with_http_info(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -430,11 +518,12 @@ class OrdersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Order]]:
-        """Synchronous version of get_orders_with_http_info"""
-        return async_to_sync(self._get_orders_async_with_http_info)(
-            limit=limit,
-            offset=offset,
+    ) -> ApiResponse[List[OrdersCount]]:
+        """Synchronous version of get_orders_count_with_http_info"""
+        return async_to_sync(self._get_orders_count_async_with_http_info)(
+            sort_order=sort_order,
+            sort_by=sort_by,
+            group_by=group_by,
             _request_timeout=_request_timeout,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -443,10 +532,20 @@ class OrdersApi:
         )
 
     @validate_call
-    def _get_orders_sync_without_preload_content(
+    def _get_orders_count_sync_without_preload_content(
         self,
-        limit: Optional[StrictInt] = None,
-        offset: Optional[StrictInt] = None,
+        sort_order: Annotated[
+            Optional[StrictStr], Field(description="The order to sort by")
+        ] = None,
+        sort_by: Annotated[
+            Optional[StrictStr], Field(description="The field to sort by")
+        ] = None,
+        group_by: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The group by period for the orders count. Defaults to day."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -459,10 +558,11 @@ class OrdersApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Synchronous version of get_orders_without_preload_content"""
-        return async_to_sync(self._get_orders_async_without_preload_content)(
-            limit=limit,
-            offset=offset,
+        """Synchronous version of get_orders_count_without_preload_content"""
+        return async_to_sync(self._get_orders_count_async_without_preload_content)(
+            sort_order=sort_order,
+            sort_by=sort_by,
+            group_by=group_by,
             _request_timeout=_request_timeout,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -470,10 +570,11 @@ class OrdersApi:
             _host_index=_host_index,
         )
 
-    def _get_orders_serialize(
+    def _get_orders_count_serialize(
         self,
-        limit,
-        offset,
+        sort_order,
+        sort_by,
+        group_by,
         _request_auth,
         _content_type,
         _headers,
@@ -495,13 +596,17 @@ class OrdersApi:
 
         # process the path parameters
         # process the query parameters
-        if limit is not None:
+        if sort_order is not None:
+
+            _query_params.append(("sort_order", sort_order))
+
+        if sort_by is not None:
 
-            _query_params.append(("limit", limit))
+            _query_params.append(("sort_by", sort_by))
 
-        if offset is not None:
+        if group_by is not None:
 
-            _query_params.append(("offset", offset))
+            _query_params.append(("group_by", group_by))
 
         # process the header parameters
         # process the form parameters
@@ -518,7 +623,7 @@ class OrdersApi:
 
         return self.api_client.param_serialize(
             method="GET",
-            resource_path="/orders",
+            resource_path="/orders/count",
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,

crypticorn/trade/client/api/status_api.py

@@ -71,10 +71,7 @@ class StatusApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> str:
-        """Time
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+        """Time"""
         if self.is_sync:
             return self._get_time_sync(
                 type=type,
@@ -111,10 +108,7 @@ class StatusApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[str]:
-        """Time with HTTP info
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+        """Time with HTTP info"""
         if self.is_sync:
             return self._get_time_sync_with_http_info(
                 type=type,
@@ -151,10 +145,7 @@ class StatusApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Time without preloading content
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+        """Time without preloading content"""
         if self.is_sync:
             return self._get_time_sync_without_preload_content(
                 type=type,
@@ -513,10 +504,7 @@ class StatusApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> str:
-        """Ping
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+        """Ping"""
         if self.is_sync:
             return self._ping_sync(
                 _request_timeout=_request_timeout,
@@ -550,10 +538,7 @@ class StatusApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[str]:
-        """Ping with HTTP info
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+        """Ping with HTTP info"""
         if self.is_sync:
             return self._ping_sync_with_http_info(
                 _request_timeout=_request_timeout,
@@ -587,10 +572,7 @@ class StatusApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Ping without preloading content
-
-        This method can work in both sync and async modes based on the is_sync flag.
-        """
+        """Ping without preloading content"""
         if self.is_sync:
             return self._ping_sync_without_preload_content(
                 _request_timeout=_request_timeout,