Merge pull request #44 from remnawave:development

Update SDK for Python compatibility and add IP control features

Author: sm1ky

.gitignore

@@ -99,7 +99,7 @@ ipython_config.py
 #   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
-#uv.lock
+uv.lock
 
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
@@ -178,7 +178,7 @@ test.py
 docs/
 openapi/
 .DS_Store
-requirements.txt 
+requirements.txt
 requirements.in
 test_raw.py
 tests/test_one_time.py

README.md

@@ -50,6 +50,7 @@ pip install git+https://github.com/remnawave/python-sdk.git@development
 
 | Contract Version | Remnawave Panel Version |
 | ---------------- | ----------------------- |
+| 2.6.2            | >=2.6.2                 |
 | 2.6.1            | >=2.6.0                 |
 | 2.4.4            | >=2.4.0                 |
 | 2.3.2            | >=2.3.0, <2.4.0         |
@@ -104,7 +105,7 @@ async def main():
     remnawave = RemnawaveSDK(base_url=base_url, token=token)
 
     # Fetch all users
-    response: UsersResponseDto = await remnawave.users.get_all_users_v2()
+    response: UsersResponseDto = await remnawave.users.get_all_users()
     total_users: int = response.total
     users: list[UserResponseDto] = response.users
     print("Total users: ", total_users)
@@ -122,4 +123,4 @@ This SDK was originally developed by [@kesevone](https://github.com/kesevone) fo
 
 Previously maintained by [@sm1ky](https://github.com/sm1ky) at [`sm1ky/remnawave-api`](https://github.com/sm1ky/remnawave-api).
 
-Now officially maintained by the Remnawave Community at [`remnawave/python-sdk`](https://github.com/remnawave/python-sdk).
+Now officially maintained by the Remnawave Community at [`remnawave/python-sdk`](https://github.com/remnawave/python-sdk).

pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "remnawave"
-version = "2.6.1"
-description = "A Python SDK for interacting with the Remnawave API v2.6.1."
+version = "2.6.2"
+description = "A Python SDK for interacting with the Remnawave API v2.6.2."
 authors = [
     {name = "Artem",email = "dev@forestsnet.com"}
 ]
 license = { text = "MIT" }
 readme = "README.md"
-requires-python = ">=3.11,<4.0"
+requires-python = ">=3.11,<3.14"
 dependencies = [
     "rapid-api-client (==0.6.0)",
     "orjson (>=3.10.15,<4.0.0)",

remnawave/__init__.py

@@ -32,6 +32,7 @@
     SnippetsController,
     RemnawaveSettingsController,
     SubscriptionPageConfigController,
+    IpControlController,
 )
 
 
@@ -44,6 +45,7 @@ def __init__(
         caddy_token: Optional[str] = None,
         ssl_ignore: Optional[bool] = False,
         custom_headers: Optional[dict] = None,
+        cookies: Optional[dict] = None,
     ):
         """
         Remnawave SDK init
@@ -55,13 +57,15 @@ def __init__(
             caddy_token (Optional[str]): - Token for Caddy Auth (Headers). Defaults to None.
             ssl_ignore (Optional[bool]): - Whether to ignore SSL certificate errors. Defaults to False.
             custom_headers (Optional[dict]): - Custom headers to include in the requests. Defaults to None.
+            cookies (Optional[dict]): - Cookies for Reverse Proxy authorization. Defaults to None.
         """
         self._client = client
         self._token = token
         self.base_url = base_url
         self.caddy_token = caddy_token
         self.ssl_ignore = ssl_ignore
         self.custom_headers = custom_headers
+        self.cookies = cookies
 
         self._validate_params()
 
@@ -96,6 +100,7 @@ def __init__(
         self.snippets = SnippetsController(self._client)
         self.remnawave_settings = RemnawaveSettingsController(self._client)
         self.subscription_page_config = SubscriptionPageConfigController(self._client)
+        self.ip_control = IpControlController(self._client)
 
     def _validate_params(self) -> None:
         if self._client is None:
@@ -108,13 +113,21 @@ def _validate_params(self) -> None:
                 logging.warning(
                     "base_url and token will be ignored if client is provided"
                 )
+            if self.cookies is not None:
+                logging.warning(
+                    "cookies will be ignored if client is provided"
+                )
 
     def _prepare_client(self) -> httpx.AsyncClient:
-        return httpx.AsyncClient(
-            base_url=self._prepare_url(),
-            headers=self._prepare_headers(),
-            verify=not self.ssl_ignore,
-        )
+        client_kwargs = {
+            "base_url": self._prepare_url(),
+            "headers": self._prepare_headers(),
+            "verify": not self.ssl_ignore,
+        }
+        if self.cookies is not None:
+            client_kwargs["cookies"] = self.cookies
+        
+        return httpx.AsyncClient(**client_kwargs)
 
     def _prepare_headers(self) -> dict:
         headers = {}

remnawave/controllers/__init__.py

@@ -26,6 +26,7 @@
 from .snippets import SnippetsController
 from .remnawave_settings import RemnawaveSettingsController
 from .subscription_page import SubscriptionPageConfigController
+from .ip_control import IpControlController
 
 __all__ = [
     "APITokensManagementController",
@@ -55,5 +56,6 @@
     "ExternalSquadsController",
     "SnippetsController",
     "RemnawaveSettingsController",
-    "SubscriptionPageConfigController"
+    "SubscriptionPageConfigController",
+    "IpControlController",
 ]

remnawave/controllers/ip_control.py

@@ -0,0 +1,55 @@
+from typing import Annotated
+
+from rapid_api_client import Path
+from rapid_api_client.annotations import PydanticBody
+
+from remnawave.models import (
+    DropConnectionsRequestDto,
+    DropConnectionsResponseDto,
+    FetchIpsResponseDto,
+    FetchIpsResultResponseDto,
+)
+from remnawave.rapid import BaseController, get, post
+
+
+class IpControlController(BaseController):
+    @post("/ip-control/fetch-ips/{uuid}", response_class=FetchIpsResponseDto)
+    async def fetch_user_ips(
+        self,
+        uuid: Annotated[str, Path(description="UUID of the user")],
+    ) -> FetchIpsResponseDto:
+        """Request IP List for User.
+
+        Starts a background job that queries all connected nodes for the IPs
+        used by the given user.  The returned ``job_id`` must be passed to
+        :meth:`get_fetch_ips_result` to retrieve the actual list once the job
+        is complete.
+        """
+        ...
+
+    @get("/ip-control/fetch-ips/result/{jobId}", response_class=FetchIpsResultResponseDto)
+    async def get_fetch_ips_result(
+        self,
+        jobId: Annotated[str, Path(description="Job ID returned by fetch_user_ips")],
+    ) -> FetchIpsResultResponseDto:
+        """Get IP List Result by Job ID.
+
+        Poll this endpoint after calling :meth:`fetch_user_ips`.  When
+        ``is_completed`` is ``True`` the ``result`` field contains per-node
+        IP lists.  When ``is_failed`` is ``True`` the job encountered an
+        error.
+        """
+        ...
+
+    @post("/ip-control/drop-connections", response_class=DropConnectionsResponseDto)
+    async def drop_connections(
+        self,
+        body: Annotated[DropConnectionsRequestDto, PydanticBody()],
+    ) -> DropConnectionsResponseDto:
+        """Drop active connections.
+
+        Sends a drop-connections event to the target nodes.  You can specify
+        the connections to drop either by user UUIDs or by IP addresses, and
+        you can target all connected nodes or a specific subset.
+        """
+        ...

remnawave/models/__init__.py

@@ -382,6 +382,7 @@
     BaseUserDto,
     UserDto,
     NodeDto,
+    WebhookNodeConfigProfileDto,
     ConfigProfileInboundDto,
     InfraProviderDto,
     LoginAttemptDto,
@@ -467,6 +468,25 @@
     UpdateSubscriptionPageConfigRequestDto,
     UpdateSubscriptionPageConfigResponseDto,
 )
+from .ip_control import (
+    # Request DTOs
+    DropConnectionsRequestDto,
+    DropByUserUuids,
+    DropByIpAddresses,
+    TargetAllNodes,
+    TargetSpecificNodes,
+    # Response DTOs
+    FetchIpsResponseDto,
+    FetchIpsResultResponseDto,
+    DropConnectionsResponseDto,
+    # Data models
+    FetchIpsJobData,
+    FetchIpsProgressData,
+    FetchIpsNodeResult,
+    FetchIpsResult,
+    FetchIpsResultData,
+    DropConnectionsResponseData,
+)
 
 __all__ = [
     # Auth models
@@ -829,6 +849,7 @@
     "ConfigProfileInboundDto",
     "InfraProviderDto",
     "NodeDto",
+    "WebhookNodeConfigProfileDto",
     "NodeEventDto",
 
     # ERROR EVENTS
@@ -916,4 +937,20 @@
     "SubscriptionPageConfigDto",
     "UpdateSubscriptionPageConfigRequestDto",
     "UpdateSubscriptionPageConfigResponseDto",
+
+    # IP Control models
+    "DropConnectionsRequestDto",
+    "DropByUserUuids",
+    "DropByIpAddresses",
+    "TargetAllNodes",
+    "TargetSpecificNodes",
+    "FetchIpsResponseDto",
+    "FetchIpsResultResponseDto",
+    "DropConnectionsResponseDto",
+    "FetchIpsJobData",
+    "FetchIpsProgressData",
+    "FetchIpsNodeResult",
+    "FetchIpsResult",
+    "FetchIpsResultData",
+    "DropConnectionsResponseData",
 ]

remnawave/models/external_squads.py

@@ -30,15 +30,15 @@ class ExternalSquadTemplateDto(BaseModel):
 
 class ExternalSquadSubscriptionSettingsDto(BaseModel):
     """External squad subscription settings"""
-    profile_title: str = Field(alias="profileTitle")
-    support_link: str = Field(alias="supportLink")
-    profile_update_interval: int = Field(alias="profileUpdateInterval", ge=1)
-    is_profile_webpage_url_enabled: bool = Field(alias="isProfileWebpageUrlEnabled")
-    serve_json_at_base_subscription: bool = Field(alias="serveJsonAtBaseSubscription")
-    is_show_custom_remarks: bool = Field(alias="isShowCustomRemarks")
+    profile_title: Optional[str] = Field(None, alias="profileTitle")
+    support_link: Optional[str] = Field(None, alias="supportLink")
+    profile_update_interval: Optional[int] = Field(None, alias="profileUpdateInterval", ge=1)
+    is_profile_webpage_url_enabled: Optional[bool] = Field(None, alias="isProfileWebpageUrlEnabled")
+    serve_json_at_base_subscription: Optional[bool] = Field(None, alias="serveJsonAtBaseSubscription")
+    is_show_custom_remarks: Optional[bool] = Field(None, alias="isShowCustomRemarks")
     happ_announce: Optional[str] = Field(None, alias="happAnnounce")
     happ_routing: Optional[str] = Field(None, alias="happRouting")
-    randomize_hosts: bool = Field(alias="randomizeHosts")
+    randomize_hosts: Optional[bool] = Field(None, alias="randomizeHosts")
 
 class ExternalSquadHostOverridesDto(BaseModel):
     """External squad host overrides"""