Skip to content

Migrate SDK to new agent-stack API response format #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amalshaji-plivo wants to merge 3 commits into
base: main
Choose a base branch
from
+64 −24
Open

Migrate SDK to new agent-stack API response format #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
581bb62
Migrate SDK to new agent-stack Plivo-style API response format
amalshaji-plivo Mar 7, 2026
3fd2d02
Merge branch 'main' into fix/migrate-to-new-api-response-format
amalshaji-plivo Mar 9, 2026
2f746f6
docs: update pagination param names from page/per_page to limit/offset
amalshaji-plivo Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/plivo_agentstack/agent/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@ async def get(self, agent_uuid: str) -> dict:
async def list(self, **params: Any) -> dict:
"""GET /Agent -- paginated list.

Optional query params: page, per_page, sort_by, sort_order,
Optional query params: limit, offset, sort_by, sort_order,
agent_mode, participant_mode.

Returns ``{"data": [...], "meta": {"page", "per_page", "total", "total_pages"}}``.
Returns ``{"api_id": "...", "objects": [...],
"meta": {"limit", "offset", "total_count", "previous", "next"}}``.
"""
return await self._http.request("GET", f"{self._prefix}/Agent", params=params)

Expand Down Expand Up @@ -157,7 +158,7 @@ def __init__(self, http: HttpTransport, prefix: str) -> None:
async def list(self, agent_uuid: str, **params: Any) -> dict:
"""GET /Agent/{agent_uuid}/Session -- list sessions.

Optional query params: page, per_page, sort_by, sort_order, agent_mode.
Optional query params: limit, offset, sort_by, sort_order, agent_mode.
"""
return await self._http.request(
"GET", f"{self._prefix}/Agent/{agent_uuid}/Session", params=params
Expand Down
81 changes: 60 additions & 21 deletions tests/test_agent/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,13 @@ async def test_create_agent(mock_api, http_transport):
"""POST /v1/Account/TESTAUTH123/Agent creates an agent."""
mock_api.post("/v1/Account/TESTAUTH123/Agent").mock(
return_value=httpx.Response(
200,
json={"agent_uuid": AGENT_UUID, "agent_name": "My Agent"},
201,
json={
"api_id": "abc-123",
"message": "agent created",
"agent_uuid": AGENT_UUID,
"agent_name": "My Agent",
},
)
)
client = AgentClient(http_transport)
Expand All @@ -29,7 +34,7 @@ async def test_get_agent(mock_api, http_transport):
mock_api.get(f"/v1/Account/TESTAUTH123/Agent/{AGENT_UUID}").mock(
return_value=httpx.Response(
200,
json={"agent_uuid": AGENT_UUID, "agent_name": "My Agent"},
json={"api_id": "abc-123", "agent_uuid": AGENT_UUID, "agent_name": "My Agent"},
)
)
client = AgentClient(http_transport)
Expand All @@ -42,21 +47,31 @@ async def test_list_agents(mock_api, http_transport):
mock_api.get("/v1/Account/TESTAUTH123/Agent").mock(
return_value=httpx.Response(
200,
json={"data": [{"agent_uuid": AGENT_UUID}], "meta": {"total": 1}},
json={
"api_id": "abc-123",
"objects": [{"agent_uuid": AGENT_UUID}],
"meta": {
"limit": 10,
"offset": 0,
"total_count": 1,
"previous": None,
"next": None,
},
},
)
)
client = AgentClient(http_transport)
result = await client.agents.list(page=1, per_page=10)
assert result["meta"]["total"] == 1
assert len(result["data"]) == 1
result = await client.agents.list(limit=10, offset=0)
assert result["meta"]["total_count"] == 1
assert len(result["objects"]) == 1


async def test_update_agent(mock_api, http_transport):
"""PATCH /v1/Account/TESTAUTH123/Agent/{uuid} updates an agent."""
mock_api.patch(f"/v1/Account/TESTAUTH123/Agent/{AGENT_UUID}").mock(
return_value=httpx.Response(
200,
json={"agent_uuid": AGENT_UUID, "agent_name": "Updated Agent"},
json={"api_id": "abc-123", "agent_uuid": AGENT_UUID, "agent_name": "Updated Agent"},
)
)
client = AgentClient(http_transport)
Expand All @@ -78,8 +93,13 @@ async def test_call_initiate(mock_api, http_transport):
"""POST /v1/Account/TESTAUTH123/AgentCall initiates an outbound call."""
mock_api.post("/v1/Account/TESTAUTH123/AgentCall").mock(
return_value=httpx.Response(
200,
json={"call_uuid": CALL_UUID, "status": "initiated"},
201,
json={
"api_id": "abc-123",
"message": "call initiated",
"call_uuid": CALL_UUID,
"status": "initiated",
},
)
)
client = AgentClient(http_transport)
Expand All @@ -96,26 +116,37 @@ async def test_call_connect(mock_api, http_transport):
"""POST /v1/Account/TESTAUTH123/AgentCall/{uuid}/connect connects a call to an agent."""
mock_api.post(f"/v1/Account/TESTAUTH123/AgentCall/{CALL_UUID}/connect").mock(
return_value=httpx.Response(
200,
json={"status": "connected"},
201,
json={
"api_id": "abc-123",
"message": "call connected",
"agent_session_id": "sess-001",
"status": "connecting",
},
)
)
client = AgentClient(http_transport)
result = await client.calls.connect(CALL_UUID, AGENT_UUID)
assert result["status"] == "connected"
assert result["status"] == "connecting"
assert result["agent_session_id"] == "sess-001"


async def test_number_assign(mock_api, http_transport):
"""POST /v1/Account/TESTAUTH123/Agent/{uuid}/Number assigns a number to an agent."""
mock_api.post(f"/v1/Account/TESTAUTH123/Agent/{AGENT_UUID}/Number").mock(
return_value=httpx.Response(
200,
json={"status": "assigned", "number": "+14155551234"},
201,
json={
"api_id": "abc-123",
"message": "number assigned",
"agent_uuid": AGENT_UUID,
"number": "+14155551234",
},
)
)
client = AgentClient(http_transport)
result = await client.numbers.assign(AGENT_UUID, "+14155551234")
assert result["status"] == "assigned"
assert result["message"] == "number assigned"
assert result["number"] == "+14155551234"


Expand All @@ -139,17 +170,24 @@ async def test_session_list(mock_api, http_transport):
return_value=httpx.Response(
200,
json={
"data": [
"api_id": "abc-123",
"objects": [
{"agent_session_id": SESSION_ID, "duration_seconds": 120}
],
"meta": {"total": 1},
"meta": {
"limit": 10,
"offset": 0,
"total_count": 1,
"previous": None,
"next": None,
},
},
)
)
client = AgentClient(http_transport)
result = await client.sessions.list(AGENT_UUID, page=1, per_page=10)
assert result["meta"]["total"] == 1
assert result["data"][0]["agent_session_id"] == SESSION_ID
result = await client.sessions.list(AGENT_UUID, limit=10, offset=0)
assert result["meta"]["total_count"] == 1
assert result["objects"][0]["agent_session_id"] == SESSION_ID


async def test_session_get(mock_api, http_transport):
Expand All @@ -158,6 +196,7 @@ async def test_session_get(mock_api, http_transport):
return_value=httpx.Response(
200,
json={
"api_id": "abc-123",
"agent_session_id": SESSION_ID,
"agent_uuid": AGENT_UUID,
"duration_seconds": 120,
Expand Down