Merge pull request #56 from remnawave/development

Upgrade SDK to Remnawave API v2.8.0

Author: sm1ky

README.md

@@ -50,6 +50,7 @@ pip install git+https://github.com/remnawave/python-sdk.git@development
 
 | Contract Version | Remnawave Panel Version |
 | ---------------- | ----------------------- |
+| 2.8.0            | >=2.8.0                 |
 | 2.7.0            | >=2.7.0                 |
 | 2.6.3            | >=2.6.3                 |
 | 2.6.2            | >=2.6.2                 |

poetry.lock

@@ -1,20 +1,18 @@
 [project]
 name = "remnawave"
-version = "2.7.1"
-description = "A Python SDK for interacting with the Remnawave API v2.7.1."
+version = "2.8.0"
+description = "A Python SDK for interacting with the Remnawave API v2.8.0."
 authors = [
     {name = "Artem",email = "dev@forestsnet.com"}
 ]
 license = { text = "MIT" }
 readme = "README.md"
-requires-python = ">=3.11,<3.14"
+requires-python = ">=3.11,<3.15"
 dependencies = [
     "rapid-api-client (==0.6.0)",
     "orjson (>=3.10.15,<4.0.0)",
     "httpx (>=0.27.2,<0.28.0)",
     "pydantic[email]>=2.9.2,<3.0.0",
-    "pydantic-core>=2.33.1,<2.34.0",
-    "pydantic>=2.9.2,<3.0.0",
     "cryptography (>=46.0.3,<47.0.0)",
 ]
 keywords = ["remnawave", "api", "sdk", "proxy", "httpx", "async", "xray"]
@@ -26,6 +24,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
     "Framework :: AsyncIO",

pyproject.toml

@@ -9,6 +9,7 @@
     CreateApiTokenResponseDto,
     DeleteApiTokenResponseDto,
     FindAllApiTokensResponseDto,
+    GetApiTokenScopesResponseDto,
 )
 from remnawave.rapid import BaseController, delete, get, post
 
@@ -36,3 +37,10 @@ async def find_all(
     ) -> FindAllApiTokensResponseDto:
         """Get all API tokens"""
         ...
+
+    @get("/tokens/scopes", response_class=GetApiTokenScopesResponseDto)
+    async def get_scopes(
+        self,
+    ) -> GetApiTokenScopesResponseDto:
+        """Get available API token scopes"""
+        ...

remnawave/controllers/api_tokens_management.py

@@ -1,6 +1,7 @@
 from typing import Annotated
 
 from rapid_api_client import Path, Query
+from rapid_api_client.annotations import PydanticBody
 
 from remnawave.models.bandwidthstats import (
     GetLegacyStatsNodesUsersUsageResponseDto,
@@ -11,10 +12,12 @@
     GetStatsNodesRealtimeUsageResponseDto,
     GetStatsNodesUsageResponseDto,
     GetStatsNodeUsersUsageResponseDto,
+    GetStatsNodesUsersUsageRequestDto,
+    GetStatsNodesUsersUsageResponseDto,
     GetStatsUserUsageResponseDto,
     GetUserUsageByRangeResponseDto,
 )
-from remnawave.rapid import BaseController, get
+from remnawave.rapid import BaseController, get, post
 
 
 class BandWidthStatsController(BaseController):
@@ -70,6 +73,17 @@ async def get_stats_node_users_usage(
         """Get Node Users Usage by Node UUID"""
         ...
 
+    @post("/bandwidth-stats/nodes/users", response_class=GetStatsNodesUsersUsageResponseDto)
+    async def get_stats_nodes_users_usage(
+        self,
+        body: Annotated[GetStatsNodesUsersUsageRequestDto, PydanticBody()],
+        top_users_limit: Annotated[int, Query(description="Limit of top users to return", alias="topUsersLimit")],
+        start: Annotated[str, Query(description="Start date (YYYY-MM-DD)")],
+        end: Annotated[str, Query(description="End date (YYYY-MM-DD)")],
+    ) -> GetStatsNodesUsersUsageResponseDto:
+        """Get Nodes Users Usage by Nodes UUIDs"""
+        ...
+
     @get("/bandwidth-stats/users/{uuid}", response_class=GetStatsUserUsageResponseDto)
     async def get_stats_user_usage(
         self,

remnawave/controllers/bandwidthstats.py

@@ -7,12 +7,10 @@
     BulkDeleteHostsResponseDto,
     BulkDisableHostsResponseDto,
     BulkEnableHostsResponseDto,
-    SetInboundToManyHostsRequestDto,
-    SetInboundToManyHostsResponseDto,
-    SetPortToManyHostsResponseDto,
-    SetPortToManyHostsRequestDto
+    UpdateManyHostsRequestDto,
+    UpdateManyHostsResponseDto,
 )
-from remnawave.rapid import AttributeBody, BaseController, post
+from remnawave.rapid import AttributeBody, BaseController, patch, post
 
 
 class HostsBulkActionsController(BaseController):
@@ -40,21 +38,10 @@ async def enable_hosts(
         """Enable many hosts"""
         ...
 
-    @post(
-        "/hosts/bulk/set-inbound",
-        response_class=SetInboundToManyHostsResponseDto,
-    )
-    async def set_inbound_to_hosts(
+    @patch("/hosts/bulk/update", response_class=UpdateManyHostsResponseDto)
+    async def update_hosts(
         self,
-        body: Annotated[SetInboundToManyHostsRequestDto, PydanticBody()],
-    ) -> SetInboundToManyHostsResponseDto:
-        """Set inbound to many hosts"""
-        ...
-
-    @post("/hosts/bulk/set-port", response_class=SetPortToManyHostsResponseDto)
-    async def set_port_to_hosts(
-        self,
-        body: Annotated[SetPortToManyHostsRequestDto, PydanticBody()],
-    ) -> SetPortToManyHostsResponseDto:
-        """Set port to many hosts"""
+        body: Annotated[UpdateManyHostsRequestDto, PydanticBody()],
+    ) -> UpdateManyHostsResponseDto:
+        """Update many hosts"""
         ...

remnawave/controllers/hosts_bulk_actions.py

@@ -19,6 +19,7 @@
     UpdateNodeRequestDto,
     UpdateNodeResponseDto,
     RestartAllNodesRequestBodyDto,
+    RestartNodeRequestBodyDto,
     ResetNodeTrafficRequestDto,
     ResetNodeTrafficResponseDto,
     ProfileModificationRequestDto,
@@ -98,6 +99,7 @@ async def disable_node(
     async def restart_node(
         self,
         uuid: Annotated[str, Path(description="Node UUID")],
+        body: Annotated[RestartNodeRequestBodyDto | None, PydanticBody()] = None,
     ) -> RestartNodeResponseDto:
         """Restart Node"""
         ...

remnawave/controllers/nodes.py

@@ -7,8 +7,6 @@
     GetNodesMetricsResponseDto,
     GetRemnawaveHealthResponseDto,
     GetX25519KeyPairResponseDto,
-    EncryptHappCryptoLinkRequestDto,
-    EncryptHappCryptoLinkResponseDto,
     DebugSrrMatcherRequestDto,
     DebugSrrMatcherResponseDto,
     GetMetadataResponseDto,
@@ -67,14 +65,6 @@ async def get_x25519_key_pair(
         """Get X25519 Key Pair"""
         ...
 
-    @post("/system/tools/happ/encrypt", response_class=EncryptHappCryptoLinkResponseDto)
-    async def encrypt_happ_crypto_link(
-        self,
-        body: Annotated[EncryptHappCryptoLinkRequestDto, PydanticBody()],
-    ) -> EncryptHappCryptoLinkResponseDto:
-        """Encrypt Happ Crypto Link"""
-        ...
-
     @post("/system/testers/srr-matcher", response_class=DebugSrrMatcherResponseDto)
     async def debug_srr_matcher(
         self,

remnawave/controllers/system.py

@@ -15,6 +15,7 @@
     GetUserByUuidResponseDto,
     GetUserAccessibleNodesResponseDto,
     GetUserSubscriptionRequestHistoryResponseDto,
+    GetUsersStreamResponseDto,
     TelegramUserResponseDto,
     EmailUserResponseDto,
     TagUserResponseDto,
@@ -56,13 +57,31 @@ async def get_all_users(
             Query(default=None, description="Offset for pagination")
         ] = None,
         size: Annotated[
-            Optional[int], 
+            Optional[int],
             Query(default=None, description="Page size for pagination")
         ] = None,
     ) -> GetAllUsersResponseDto:
         """Get all users"""
         ...
 
+    @get("/users/stream", response_class=GetUsersStreamResponseDto)
+    async def get_users_stream(
+        self,
+        size: Annotated[
+            Optional[int],
+            Query(default=None, description="Page size, no more than 1000 (default 250)"),
+        ] = None,
+        cursor: Annotated[
+            Optional[str],
+            Query(
+                default=None,
+                description="Cursor from the previous response (nextCursor). Omit on the first request",
+            ),
+        ] = None,
+    ) -> GetUsersStreamResponseDto:
+        """Get all users using cursor-based (keyset) pagination"""
+        ...
+
     @delete("/users/{uuid}", response_class=DeleteUserResponseDto)
     async def delete_user(
         self,
@@ -75,7 +94,7 @@ async def delete_user(
     async def revoke_user_subscription(
         self,
         uuid: Annotated[str, Path(description="UUID of the user")],
-        body: Optional[Annotated[RevokeUserRequestDto, PydanticBody()]] = None,
+        body: Annotated[Optional[RevokeUserRequestDto], PydanticBody()] = None,
     ) -> RevokeUserSubscriptionResponseDto:
         """Revoke User Subscription"""
         ...

remnawave/controllers/users.py

@@ -2,6 +2,8 @@
 from .client_type import ClientType
 from .error_code import ErrorCode
 from .fingerprint import Fingerprint
+from .mihomo import MihomoIpVersion
+from .scopes import Scope
 from .security_layer import SecurityLayer
 from .template_type import TemplateType
 from .users import TrafficLimitStrategy, UserStatus
@@ -25,6 +27,8 @@
     "ClientType",
     "ALPN",
     "Fingerprint",
+    "MihomoIpVersion",
+    "Scope",
     "SecurityLayer",
     "TemplateType",
     "ResponseRuleConditionOperator",