waapi 0.1.0__py3-none-any.whl

waapi/__init__.py

@@ -0,0 +1,33 @@
+"""Official Python SDK for the WaAPI REST API.
+
+    from waapi import WaAPI
+
+    client = WaAPI(token="YOUR_TOKEN", instance_id=123)
+    client.send_message(chat_id="4915112345678@c.us", message="Hello")
+"""
+
+__version__ = "0.1.0"
+
+from .client import AsyncWaAPI, WaAPI
+from .exceptions import (
+    AuthenticationError,
+    FailedActionError,
+    NotFoundError,
+    RateLimitError,
+    ServerError,
+    ValidationError,
+    WaAPIError,
+)
+
+__all__ = [
+    "AsyncWaAPI",
+    "AuthenticationError",
+    "FailedActionError",
+    "NotFoundError",
+    "RateLimitError",
+    "ServerError",
+    "ValidationError",
+    "WaAPI",
+    "WaAPIError",
+    "__version__",
+]

waapi/_actions.py

@@ -0,0 +1,152 @@
+"""Hand-written client methods.
+
+Everything under ``/client/action/`` is generated into :mod:`waapi._generated`
+from the OpenAPI specification and composed in below. This module holds only
+what the generator does not cover: the instance endpoints, which are ordinary
+REST routes rather than actions, and the generic escape hatch every generated
+method is built on.
+
+Add a method here only if it cannot come from the spec. Anything added here by
+hand is one more place a future API change has to reach.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from ._generated import GeneratedActions, GeneratedAsyncActions
+from ._http import prune
+
+
+class _Shared:
+    """Path construction, and the client contract the mixins rely on.
+
+    ``request`` and ``_resolve_instance`` live on the client. Declaring them
+    under TYPE_CHECKING states the contract for the type checker without
+    creating runtime attributes that could shadow the real ones through the
+    MRO.
+    """
+
+    if TYPE_CHECKING:
+
+        def _resolve_instance(self, instance_id: int | str | None) -> int | str: ...
+
+    @staticmethod
+    def _action_path(instance_id: int | str, name: str) -> str:
+        return f"/instances/{instance_id}/client/action/{name}"
+
+
+class ActionsMixin(_Shared, GeneratedActions):
+    if TYPE_CHECKING:
+
+        def request(
+            self,
+            method: str,
+            path: str,
+            *,
+            json: Any = None,
+            params: Any = None,
+            check_body_status: bool = True,
+        ) -> Any: ...
+
+    # -- the call every generated method goes through -------------------------
+
+    def action(
+        self,
+        name: str,
+        payload: dict[str, Any] | None = None,
+        *,
+        instance_id: int | str | None = None,
+    ) -> Any:
+        """Call any client action by its API name.
+
+        Every generated method is a typed wrapper around this. Use it directly
+        for an action added to the API since the last release:
+
+        >>> client.action("send-seen", {"chatId": "4915112345678@c.us"})
+        """
+        target = self._resolve_instance(instance_id)
+        return self.request("POST", self._action_path(target, name), json=prune(payload or {}))
+
+    # -- instances (REST routes, not actions) ---------------------------------
+
+    def get_instances(self) -> Any:
+        """List the instances on your account."""
+        return self.request("GET", "/instances")
+
+    def create_instance(self) -> Any:
+        """Create a new instance."""
+        return self.request("POST", "/instances")
+
+    def get_instance(self, instance_id: int | str | None = None) -> Any:
+        """Retrieve one instance."""
+        return self.request("GET", f"/instances/{self._resolve_instance(instance_id)}")
+
+    def delete_instance(self, instance_id: int | str | None = None) -> Any:
+        """Delete an instance."""
+        return self.request("DELETE", f"/instances/{self._resolve_instance(instance_id)}")
+
+    def get_status(self, instance_id: int | str | None = None) -> Any:
+        """Connection status of the instance's client."""
+        return self.request("GET", f"/instances/{self._resolve_instance(instance_id)}/client/status")
+
+    def get_qr_code(self, instance_id: int | str | None = None) -> Any:
+        """QR code to connect a number to the instance."""
+        return self.request("GET", f"/instances/{self._resolve_instance(instance_id)}/client/qr")
+
+
+class AsyncActionsMixin(_Shared, GeneratedAsyncActions):
+    """The same surface, awaited."""
+
+    if TYPE_CHECKING:
+
+        async def request(
+            self,
+            method: str,
+            path: str,
+            *,
+            json: Any = None,
+            params: Any = None,
+            check_body_status: bool = True,
+        ) -> Any: ...
+
+    async def action(
+        self,
+        name: str,
+        payload: dict[str, Any] | None = None,
+        *,
+        instance_id: int | str | None = None,
+    ) -> Any:
+        """Call any client action by its API name."""
+        target = self._resolve_instance(instance_id)
+        return await self.request(
+            "POST", self._action_path(target, name), json=prune(payload or {})
+        )
+
+    async def get_instances(self) -> Any:
+        """List the instances on your account."""
+        return await self.request("GET", "/instances")
+
+    async def create_instance(self) -> Any:
+        """Create a new instance."""
+        return await self.request("POST", "/instances")
+
+    async def get_instance(self, instance_id: int | str | None = None) -> Any:
+        """Retrieve one instance."""
+        return await self.request("GET", f"/instances/{self._resolve_instance(instance_id)}")
+
+    async def delete_instance(self, instance_id: int | str | None = None) -> Any:
+        """Delete an instance."""
+        return await self.request("DELETE", f"/instances/{self._resolve_instance(instance_id)}")
+
+    async def get_status(self, instance_id: int | str | None = None) -> Any:
+        """Connection status of the instance's client."""
+        return await self.request(
+            "GET", f"/instances/{self._resolve_instance(instance_id)}/client/status"
+        )
+
+    async def get_qr_code(self, instance_id: int | str | None = None) -> Any:
+        """QR code to connect a number to the instance."""
+        return await self.request(
+            "GET", f"/instances/{self._resolve_instance(instance_id)}/client/qr"
+        )