chore(axon): add axon auto-pagination to stainless sdks (#8420)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 124
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-f32de1991bef7651f9b0970b503e2986c7a88708c4a408d54abe6d089795e9f9.yml
 openapi_spec_hash: d2005d48f75fba4a5368209cf49641dc
-config_hash: a759c23a5a04ad26f8740acc7e094c01
+config_hash: 5ffcc19219880e7d9ce43c1e6860568c

api.md

@@ -107,7 +107,7 @@ Methods:
 
 - <code title="post /v1/axons">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">create</a>(\*\*<a href="src/runloop_api_client/types/axon_create_params.py">params</a>) -> <a href="./src/runloop_api_client/types/axon_view.py">AxonView</a></code>
 - <code title="get /v1/axons/{id}">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">retrieve</a>(id) -> <a href="./src/runloop_api_client/types/axon_view.py">AxonView</a></code>
-- <code title="get /v1/axons">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">list</a>(\*\*<a href="src/runloop_api_client/types/axon_list_params.py">params</a>) -> <a href="./src/runloop_api_client/types/axon_list_view.py">AxonListView</a></code>
+- <code title="get /v1/axons">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">list</a>(\*\*<a href="src/runloop_api_client/types/axon_list_params.py">params</a>) -> <a href="./src/runloop_api_client/types/axon_view.py">SyncAxonsCursorIDPage[AxonView]</a></code>
 - <code title="post /v1/axons/{id}/publish">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">publish</a>(id, \*\*<a href="src/runloop_api_client/types/axon_publish_params.py">params</a>) -> <a href="./src/runloop_api_client/types/publish_result_view.py">PublishResultView</a></code>
 - <code title="get /v1/axons/{id}/subscribe/sse">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">subscribe_sse</a>(id) -> <a href="./src/runloop_api_client/types/axon_event_view.py">AxonEventView</a></code>
 

src/runloop_api_client/pagination.py

@@ -18,6 +18,8 @@
     "AsyncBenchmarksCursorIDPage",
     "SyncAgentsCursorIDPage",
     "AsyncAgentsCursorIDPage",
+    "SyncAxonsCursorIDPage",
+    "AsyncAxonsCursorIDPage",
     "SyncBenchmarkRunsCursorIDPage",
     "AsyncBenchmarkRunsCursorIDPage",
     "SyncScenariosCursorIDPage",
@@ -69,6 +71,11 @@ class AgentsCursorIDPageItem(Protocol):
     id: str
 
 
+@runtime_checkable
+class AxonsCursorIDPageItem(Protocol):
+    id: str
+
+
 @runtime_checkable
 class BenchmarkRunsCursorIDPageItem(Protocol):
     id: str
@@ -517,6 +524,74 @@ def next_page_info(self) -> Optional[PageInfo]:
         return PageInfo(params={"starting_after": item.id})
 
 
+class SyncAxonsCursorIDPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
+    axons: List[_T]
+    has_more: Optional[bool] = None
+    total_count: Optional[int] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        axons = self.axons
+        if not axons:
+            return []
+        return axons
+
+    @override
+    def has_next_page(self) -> bool:
+        has_more = self.has_more
+        if has_more is not None and has_more is False:
+            return False
+
+        return super().has_next_page()
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        axons = self.axons
+        if not axons:
+            return None
+
+        item = cast(Any, axons[-1])
+        if not isinstance(item, AxonsCursorIDPageItem) or item.id is None:  # pyright: ignore[reportUnnecessaryComparison]
+            # TODO emit warning log
+            return None
+
+        return PageInfo(params={"starting_after": item.id})
+
+
+class AsyncAxonsCursorIDPage(BaseAsyncPage[_T], BasePage[_T], Generic[_T]):
+    axons: List[_T]
+    has_more: Optional[bool] = None
+    total_count: Optional[int] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        axons = self.axons
+        if not axons:
+            return []
+        return axons
+
+    @override
+    def has_next_page(self) -> bool:
+        has_more = self.has_more
+        if has_more is not None and has_more is False:
+            return False
+
+        return super().has_next_page()
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        axons = self.axons
+        if not axons:
+            return None
+
+        item = cast(Any, axons[-1])
+        if not isinstance(item, AxonsCursorIDPageItem) or item.id is None:  # pyright: ignore[reportUnnecessaryComparison]
+            # TODO emit warning log
+            return None
+
+        return PageInfo(params={"starting_after": item.id})
+
+
 class SyncBenchmarkRunsCursorIDPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
     runs: List[_T]
     has_more: Optional[bool] = None

src/runloop_api_client/resources/axons/axons.py

@@ -27,9 +27,9 @@
     async_to_streamed_response_wrapper,
 )
 from ..._streaming import Stream, AsyncStream
-from ..._base_client import make_request_options
+from ...pagination import SyncAxonsCursorIDPage, AsyncAxonsCursorIDPage
+from ..._base_client import AsyncPaginator, make_request_options
 from ...types.axon_view import AxonView
-from ...types.axon_list_view import AxonListView
 from ...types.axon_event_view import AxonEventView
 from ...types.publish_result_view import PublishResultView
 
@@ -148,7 +148,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AxonListView:
+    ) -> SyncAxonsCursorIDPage[AxonView]:
         """
         [Beta] List all active axons.
 
@@ -172,8 +172,9 @@ def list(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._get(
+        return self._get_api_list(
             "/v1/axons",
+            page=SyncAxonsCursorIDPage[AxonView],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -190,7 +191,7 @@ def list(
                     axon_list_params.AxonListParams,
                 ),
             ),
-            cast_to=AxonListView,
+            model=AxonView,
         )
 
     def publish(
@@ -390,7 +391,7 @@ async def retrieve(
             cast_to=AxonView,
         )
 
-    async def list(
+    def list(
         self,
         *,
         id: str | Omit = omit,
@@ -404,7 +405,7 @@ async def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AxonListView:
+    ) -> AsyncPaginator[AxonView, AsyncAxonsCursorIDPage[AxonView]]:
         """
         [Beta] List all active axons.
 
@@ -428,14 +429,15 @@ async def list(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return await self._get(
+        return self._get_api_list(
             "/v1/axons",
+            page=AsyncAxonsCursorIDPage[AxonView],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform(
+                query=maybe_transform(
                     {
                         "id": id,
                         "include_total_count": include_total_count,
@@ -446,7 +448,7 @@ async def list(
                     axon_list_params.AxonListParams,
                 ),
             ),
-            cast_to=AxonListView,
+            model=AxonView,
         )
 
     async def publish(

tests/api_resources/test_axons.py

@@ -11,9 +11,9 @@
 from runloop_api_client import Runloop, AsyncRunloop
 from runloop_api_client.types import (
     AxonView,
-    AxonListView,
     PublishResultView,
 )
+from runloop_api_client.pagination import SyncAxonsCursorIDPage, AsyncAxonsCursorIDPage
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -94,7 +94,7 @@ def test_path_params_retrieve(self, client: Runloop) -> None:
     @parametrize
     def test_method_list(self, client: Runloop) -> None:
         axon = client.axons.list()
-        assert_matches_type(AxonListView, axon, path=["response"])
+        assert_matches_type(SyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
     @parametrize
     def test_method_list_with_all_params(self, client: Runloop) -> None:
@@ -105,7 +105,7 @@ def test_method_list_with_all_params(self, client: Runloop) -> None:
             name="name",
             starting_after="starting_after",
         )
-        assert_matches_type(AxonListView, axon, path=["response"])
+        assert_matches_type(SyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
     @parametrize
     def test_raw_response_list(self, client: Runloop) -> None:
@@ -114,7 +114,7 @@ def test_raw_response_list(self, client: Runloop) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         axon = response.parse()
-        assert_matches_type(AxonListView, axon, path=["response"])
+        assert_matches_type(SyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
     @parametrize
     def test_streaming_response_list(self, client: Runloop) -> None:
@@ -123,7 +123,7 @@ def test_streaming_response_list(self, client: Runloop) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             axon = response.parse()
-            assert_matches_type(AxonListView, axon, path=["response"])
+            assert_matches_type(SyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -297,7 +297,7 @@ async def test_path_params_retrieve(self, async_client: AsyncRunloop) -> None:
     @parametrize
     async def test_method_list(self, async_client: AsyncRunloop) -> None:
         axon = await async_client.axons.list()
-        assert_matches_type(AxonListView, axon, path=["response"])
+        assert_matches_type(AsyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
     @parametrize
     async def test_method_list_with_all_params(self, async_client: AsyncRunloop) -> None:
@@ -308,7 +308,7 @@ async def test_method_list_with_all_params(self, async_client: AsyncRunloop) ->
             name="name",
             starting_after="starting_after",
         )
-        assert_matches_type(AxonListView, axon, path=["response"])
+        assert_matches_type(AsyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
     @parametrize
     async def test_raw_response_list(self, async_client: AsyncRunloop) -> None:
@@ -317,7 +317,7 @@ async def test_raw_response_list(self, async_client: AsyncRunloop) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         axon = await response.parse()
-        assert_matches_type(AxonListView, axon, path=["response"])
+        assert_matches_type(AsyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
     @parametrize
     async def test_streaming_response_list(self, async_client: AsyncRunloop) -> None:
@@ -326,7 +326,7 @@ async def test_streaming_response_list(self, async_client: AsyncRunloop) -> None
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             axon = await response.parse()
-            assert_matches_type(AxonListView, axon, path=["response"])
+            assert_matches_type(AsyncAxonsCursorIDPage[AxonView], axon, path=["response"])
 
         assert cast(Any, response.is_closed) is True