feat: add AgentsResource (messaging primitive identity surface)

cueapi/__init__.py

@@ -11,6 +11,7 @@
     RateLimitError,
 )
 from cueapi.payload import CuePayload
+from cueapi.resources.agents import AgentsResource
 from cueapi.resources.executions import ExecutionsResource
 from cueapi.resources.usage import UsageResource
 from cueapi.resources.workers import WorkersResource
@@ -19,6 +20,7 @@
 __version__ = "0.1.2"
 
 __all__ = [
+    "AgentsResource",
     "CueAPI",
     "CuePayload",
     "ExecutionsResource",

cueapi/client.py

@@ -15,6 +15,7 @@
     InvalidScheduleError,
     RateLimitError,
 )
+from cueapi.resources.agents import AgentsResource
 from cueapi.resources.cues import CuesResource
 from cueapi.resources.executions import ExecutionsResource
 from cueapi.resources.usage import UsageResource
@@ -73,6 +74,7 @@ def __init__(
         self.executions = ExecutionsResource(self)
         self.workers = WorkersResource(self)
         self.usage = UsageResource(self)
+        self.agents = AgentsResource(self)
 
     def close(self) -> None:
         """Close the underlying HTTP client."""
@@ -93,9 +95,19 @@ def _request(
         *,
         json: Optional[Dict[str, Any]] = None,
         params: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, str]] = None,
     ) -> Any:
-        """Make an HTTP request and handle errors."""
-        response = self._http.request(method, path, json=json, params=params)
+        """Make an HTTP request and handle errors.
+
+        ``headers`` extends (does not replace) the client's default
+        ``Authorization`` + ``Content-Type`` + ``User-Agent`` headers.
+        Used by per-call header semantics: messaging primitive's
+        ``X-Cueapi-From-Agent`` + ``Idempotency-Key``, and the
+        destructive-operation guard ``X-Confirm-Destructive``.
+        """
+        response = self._http.request(
+            method, path, json=json, params=params, headers=headers
+        )
         return self._handle_response(response)
 
     def _handle_response(self, response: httpx.Response) -> Any:

cueapi/resources/agents.py

@@ -0,0 +1,192 @@
+"""Agents resource — messaging primitive identity surface (Phase 12.1.5)."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Dict, Optional
+
+if TYPE_CHECKING:
+    from cueapi.client import CueAPI
+
+
+class AgentsResource:
+    """Agents API resource.
+
+    Wraps the ``/v1/agents`` surface from the messaging primitive
+    (Phase 12.1.5). Covers identity CRUD, webhook-secret rotation, and
+    the inbox/sent message lists keyed by agent ref.
+
+    The send/get/read/ack message lifecycle lives on a sibling
+    ``client.messages`` resource — this class only handles identity.
+    """
+
+    def __init__(self, client: "CueAPI") -> None:
+        self._client = client
+
+    def create(
+        self,
+        *,
+        display_name: str,
+        slug: Optional[str] = None,
+        webhook_url: Optional[str] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> dict:
+        """Create an agent.
+
+        The ``webhook_secret`` field is populated in the 201 response
+        ONLY when ``webhook_url`` is supplied. Subsequent reads omit
+        the secret. Save it now or use ``webhook_secret_regenerate()``
+        to mint a fresh one (which revokes the old one).
+
+        Args:
+            display_name: Human-readable name (1-255 chars).
+            slug: Optional per-user unique slug. If omitted, the server
+                derives one from ``display_name``.
+            webhook_url: Push-delivery target. SSRF-validated. Omit for
+                poll-only.
+            metadata: Optional JSON metadata blob.
+
+        Returns:
+            Dict matching the server's ``AgentResponse`` shape, including
+            ``webhook_secret`` ONCE on this response if ``webhook_url``
+            was given.
+        """
+        body: Dict[str, Any] = {"display_name": display_name}
+        if slug is not None:
+            body["slug"] = slug
+        if webhook_url is not None:
+            body["webhook_url"] = webhook_url
+        if metadata is not None:
+            body["metadata"] = metadata
+        return self._client._post("/v1/agents", json=body)
+
+    def list(
+        self,
+        *,
+        status: Optional[str] = None,
+        include_deleted: bool = False,
+        limit: int = 50,
+        offset: int = 0,
+    ) -> dict:
+        """List your agents.
+
+        Args:
+            status: Optional filter — ``online`` / ``offline`` / ``away``.
+            include_deleted: Whether to include soft-deleted agents.
+                Defaults to False; only sent on the wire when True
+                (omit-when-default keeps URLs clean and matches the
+                server's ``include_deleted=false`` default).
+            limit: Page size (default 50, max 100).
+            offset: Pagination offset.
+        """
+        params: Dict[str, Any] = {"limit": limit, "offset": offset}
+        if status is not None:
+            params["status"] = status
+        if include_deleted:
+            params["include_deleted"] = "true"
+        return self._client._get("/v1/agents", params=params)
+
+    def get(
+        self,
+        ref: str,
+        *,
+        include_deleted: bool = False,
+    ) -> dict:
+        """Get an agent by opaque ID or slug-form (``agent@user``)."""
+        params: Dict[str, Any] = {}
+        if include_deleted:
+            params["include_deleted"] = "true"
+        return self._client._get(f"/v1/agents/{ref}", params=params)
+
+    def update(
+        self,
+        ref: str,
+        *,
+        display_name: Optional[str] = None,
+        webhook_url: Optional[str] = None,
+        clear_webhook_url: bool = False,
+        status: Optional[str] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> dict:
+        """Update an agent (PATCH semantics).
+
+        ``webhook_url`` and ``clear_webhook_url`` are mutually exclusive.
+        Pass ``clear_webhook_url=True`` to send literal JSON ``null`` and
+        revert the agent to poll-only — the server uses
+        ``model_fields_set`` to disambiguate "field omitted = no change"
+        from "field explicitly null = clear", so the SDK MUST send the
+        key with explicit None rather than omit.
+        """
+        if webhook_url is not None and clear_webhook_url:
+            raise ValueError(
+                "webhook_url and clear_webhook_url are mutually exclusive"
+            )
+        body: Dict[str, Any] = {}
+        if display_name is not None:
+            body["display_name"] = display_name
+        if webhook_url is not None:
+            body["webhook_url"] = webhook_url
+        elif clear_webhook_url:
+            body["webhook_url"] = None
+        if status is not None:
+            body["status"] = status
+        if metadata is not None:
+            body["metadata"] = metadata
+        return self._client._patch(f"/v1/agents/{ref}", json=body)
+
+    def delete(self, ref: str) -> None:
+        """Soft-delete an agent. Returns ``None`` on success (204)."""
+        return self._client._delete(f"/v1/agents/{ref}")
+
+    def webhook_secret_get(self, ref: str) -> dict:
+        """Reveal the agent's current webhook signing secret.
+
+        404 path commonly means the agent has no ``webhook_url`` set
+        (poll-only agents have no webhook secret).
+        """
+        return self._client._get(f"/v1/agents/{ref}/webhook-secret")
+
+    def webhook_secret_regenerate(self, ref: str) -> dict:
+        """Mint a fresh webhook secret. Old secret revoked immediately.
+
+        Sends ``X-Confirm-Destructive: true`` header, which the server
+        requires for this destructive op. Returns the new secret one-time
+        in the response — save it now.
+        """
+        return self._client._post(
+            f"/v1/agents/{ref}/webhook-secret/regenerate",
+            json={},
+            headers={"X-Confirm-Destructive": "true"},
+        )
+
+    def inbox(
+        self,
+        ref: str,
+        *,
+        state: Optional[str] = None,
+        limit: int = 50,
+        offset: int = 0,
+    ) -> dict:
+        """Poll the agent's inbox (incoming messages).
+
+        Args:
+            ref: Agent opaque ID or slug-form.
+            state: Optional filter (e.g. ``queued`` / ``delivered`` /
+                ``read`` / ``acked`` / ``failed``).
+            limit: Page size (default 50).
+            offset: Pagination offset.
+        """
+        params: Dict[str, Any] = {"limit": limit, "offset": offset}
+        if state is not None:
+            params["state"] = state
+        return self._client._get(f"/v1/agents/{ref}/inbox", params=params)
+
+    def sent(
+        self,
+        ref: str,
+        *,
+        limit: int = 50,
+        offset: int = 0,
+    ) -> dict:
+        """List messages sent by this agent."""
+        params: Dict[str, Any] = {"limit": limit, "offset": offset}
+        return self._client._get(f"/v1/agents/{ref}/sent", params=params)