feat(api): update pagination configs (#25)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 27
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/replicate%2Freplicate-client-b45f922f6a041550870a96f5acec02aa6d8830046fc98b95a275c6486f7586fc.yml
 openapi_spec_hash: ef7fddfb49b4d9c440b0635d2c86f341
-config_hash: a97b3049608e3cfca813a523902d499b
+config_hash: 93f687135e6d45a0f0f83fbfdcb1d8c9

api.md

@@ -22,7 +22,7 @@ Methods:
 - <code title="post /deployments">client.deployments.<a href="./src/replicate/resources/deployments/deployments.py">create</a>(\*\*<a href="src/replicate/types/deployment_create_params.py">params</a>) -> <a href="./src/replicate/types/deployment_create_response.py">DeploymentCreateResponse</a></code>
 - <code title="get /deployments/{deployment_owner}/{deployment_name}">client.deployments.<a href="./src/replicate/resources/deployments/deployments.py">retrieve</a>(deployment_name, \*, deployment_owner) -> <a href="./src/replicate/types/deployment_retrieve_response.py">DeploymentRetrieveResponse</a></code>
 - <code title="patch /deployments/{deployment_owner}/{deployment_name}">client.deployments.<a href="./src/replicate/resources/deployments/deployments.py">update</a>(deployment_name, \*, deployment_owner, \*\*<a href="src/replicate/types/deployment_update_params.py">params</a>) -> <a href="./src/replicate/types/deployment_update_response.py">DeploymentUpdateResponse</a></code>
-- <code title="get /deployments">client.deployments.<a href="./src/replicate/resources/deployments/deployments.py">list</a>() -> <a href="./src/replicate/types/deployment_list_response.py">DeploymentListResponse</a></code>
+- <code title="get /deployments">client.deployments.<a href="./src/replicate/resources/deployments/deployments.py">list</a>() -> <a href="./src/replicate/types/deployment_list_response.py">SyncCursorURLPage[DeploymentListResponse]</a></code>
 - <code title="delete /deployments/{deployment_owner}/{deployment_name}">client.deployments.<a href="./src/replicate/resources/deployments/deployments.py">delete</a>(deployment_name, \*, deployment_owner) -> None</code>
 - <code title="get /collections">client.deployments.<a href="./src/replicate/resources/deployments/deployments.py">list_em_all</a>() -> None</code>
 
@@ -88,7 +88,7 @@ Methods:
 
 - <code title="post /predictions">client.predictions.<a href="./src/replicate/resources/predictions.py">create</a>(\*\*<a href="src/replicate/types/prediction_create_params.py">params</a>) -> <a href="./src/replicate/types/prediction.py">Prediction</a></code>
 - <code title="get /predictions/{prediction_id}">client.predictions.<a href="./src/replicate/resources/predictions.py">retrieve</a>(prediction_id) -> <a href="./src/replicate/types/prediction.py">Prediction</a></code>
-- <code title="get /predictions">client.predictions.<a href="./src/replicate/resources/predictions.py">list</a>(\*\*<a href="src/replicate/types/prediction_list_params.py">params</a>) -> <a href="./src/replicate/types/prediction.py">SyncCursorURLPage[Prediction]</a></code>
+- <code title="get /predictions">client.predictions.<a href="./src/replicate/resources/predictions.py">list</a>(\*\*<a href="src/replicate/types/prediction_list_params.py">params</a>) -> <a href="./src/replicate/types/prediction.py">SyncCursorURLPageWithCreatedFilters[Prediction]</a></code>
 - <code title="post /predictions/{prediction_id}/cancel">client.predictions.<a href="./src/replicate/resources/predictions.py">cancel</a>(prediction_id) -> None</code>
 
 # Trainings

src/replicate/pagination.py

@@ -7,11 +7,56 @@
 
 from ._base_client import BasePage, PageInfo, BaseSyncPage, BaseAsyncPage
 
-__all__ = ["SyncCursorURLPage", "AsyncCursorURLPage"]
+__all__ = [
+    "SyncCursorURLPageWithCreatedFilters",
+    "AsyncCursorURLPageWithCreatedFilters",
+    "SyncCursorURLPage",
+    "AsyncCursorURLPage",
+]
 
 _T = TypeVar("_T")
 
 
+class SyncCursorURLPageWithCreatedFilters(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
+    results: List[_T]
+    next: Optional[str] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        results = self.results
+        if not results:
+            return []
+        return results
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        url = self.next
+        if url is None:
+            return None
+
+        return PageInfo(url=httpx.URL(url))
+
+
+class AsyncCursorURLPageWithCreatedFilters(BaseAsyncPage[_T], BasePage[_T], Generic[_T]):
+    results: List[_T]
+    next: Optional[str] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        results = self.results
+        if not results:
+            return []
+        return results
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        url = self.next
+        if url is None:
+            return None
+
+        return PageInfo(url=httpx.URL(url))
+
+
 class SyncCursorURLPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
     results: List[_T]
     next: Optional[str] = None

src/replicate/resources/deployments/deployments.py

@@ -26,7 +26,8 @@
     PredictionsResourceWithStreamingResponse,
     AsyncPredictionsResourceWithStreamingResponse,
 )
-from ..._base_client import make_request_options
+from ...pagination import SyncCursorURLPage, AsyncCursorURLPage
+from ..._base_client import AsyncPaginator, make_request_options
 from ...types.deployment_list_response import DeploymentListResponse
 from ...types.deployment_create_response import DeploymentCreateResponse
 from ...types.deployment_update_response import DeploymentUpdateResponse
@@ -345,7 +346,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> DeploymentListResponse:
+    ) -> SyncCursorURLPage[DeploymentListResponse]:
         """
         Get a list of deployments associated with the current account, including the
         latest release configuration for each deployment.
@@ -392,12 +393,13 @@ def list(
         }
         ```
         """
-        return self._get(
+        return self._get_api_list(
             "/deployments",
+            page=SyncCursorURLPage[DeploymentListResponse],
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=DeploymentListResponse,
+            model=DeploymentListResponse,
         )
 
     def delete(
@@ -798,7 +800,7 @@ async def update(
             cast_to=DeploymentUpdateResponse,
         )
 
-    async def list(
+    def list(
         self,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -807,7 +809,7 @@ async def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> DeploymentListResponse:
+    ) -> AsyncPaginator[DeploymentListResponse, AsyncCursorURLPage[DeploymentListResponse]]:
         """
         Get a list of deployments associated with the current account, including the
         latest release configuration for each deployment.
@@ -854,12 +856,13 @@ async def list(
         }
         ```
         """
-        return await self._get(
+        return self._get_api_list(
             "/deployments",
+            page=AsyncCursorURLPage[DeploymentListResponse],
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=DeploymentListResponse,
+            model=DeploymentListResponse,
         )
 
     async def delete(

src/replicate/resources/predictions.py

@@ -23,7 +23,7 @@
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ..pagination import SyncCursorURLPage, AsyncCursorURLPage
+from ..pagination import SyncCursorURLPageWithCreatedFilters, AsyncCursorURLPageWithCreatedFilters
 from .._base_client import AsyncPaginator, make_request_options
 from ..types.prediction import Prediction
 
@@ -302,7 +302,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SyncCursorURLPage[Prediction]:
+    ) -> SyncCursorURLPageWithCreatedFilters[Prediction]:
         """
         Get a paginated list of all predictions created by the user or organization
         associated with the provided API token.
@@ -389,7 +389,7 @@ def list(
         """
         return self._get_api_list(
             "/predictions",
-            page=SyncCursorURLPage[Prediction],
+            page=SyncCursorURLPageWithCreatedFilters[Prediction],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -713,7 +713,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AsyncPaginator[Prediction, AsyncCursorURLPage[Prediction]]:
+    ) -> AsyncPaginator[Prediction, AsyncCursorURLPageWithCreatedFilters[Prediction]]:
         """
         Get a paginated list of all predictions created by the user or organization
         associated with the provided API token.
@@ -800,7 +800,7 @@ def list(
         """
         return self._get_api_list(
             "/predictions",
-            page=AsyncCursorURLPage[Prediction],
+            page=AsyncCursorURLPageWithCreatedFilters[Prediction],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,

src/replicate/types/deployment_list_response.py

@@ -1,21 +1,15 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import Optional
 from datetime import datetime
 from typing_extensions import Literal
 
 from .._models import BaseModel
 
-__all__ = [
-    "DeploymentListResponse",
-    "Result",
-    "ResultCurrentRelease",
-    "ResultCurrentReleaseConfiguration",
-    "ResultCurrentReleaseCreatedBy",
-]
+__all__ = ["DeploymentListResponse", "CurrentRelease", "CurrentReleaseConfiguration", "CurrentReleaseCreatedBy"]
 
 
-class ResultCurrentReleaseConfiguration(BaseModel):
+class CurrentReleaseConfiguration(BaseModel):
     hardware: Optional[str] = None
     """The SKU for the hardware used to run the model."""
 
@@ -26,7 +20,7 @@ class ResultCurrentReleaseConfiguration(BaseModel):
     """The minimum number of instances for scaling."""
 
 
-class ResultCurrentReleaseCreatedBy(BaseModel):
+class CurrentReleaseCreatedBy(BaseModel):
     type: Literal["organization", "user"]
     """The account type of the creator. Can be a user or an organization."""
 
@@ -43,13 +37,13 @@ class ResultCurrentReleaseCreatedBy(BaseModel):
     """The name of the account that created the release."""
 
 
-class ResultCurrentRelease(BaseModel):
-    configuration: Optional[ResultCurrentReleaseConfiguration] = None
+class CurrentRelease(BaseModel):
+    configuration: Optional[CurrentReleaseConfiguration] = None
 
     created_at: Optional[datetime] = None
     """The time the release was created."""
 
-    created_by: Optional[ResultCurrentReleaseCreatedBy] = None
+    created_by: Optional[CurrentReleaseCreatedBy] = None
 
     model: Optional[str] = None
     """The model identifier string in the format of `{model_owner}/{model_name}`."""
@@ -65,22 +59,11 @@ class ResultCurrentRelease(BaseModel):
     """The ID of the model version used in the release."""
 
 
-class Result(BaseModel):
-    current_release: Optional[ResultCurrentRelease] = None
+class DeploymentListResponse(BaseModel):
+    current_release: Optional[CurrentRelease] = None
 
     name: Optional[str] = None
     """The name of the deployment."""
 
     owner: Optional[str] = None
     """The owner of the deployment."""
-
-
-class DeploymentListResponse(BaseModel):
-    next: Optional[str] = None
-    """A URL pointing to the next page of deployment objects if any"""
-
-    previous: Optional[str] = None
-    """A URL pointing to the previous page of deployment objects if any"""
-
-    results: Optional[List[Result]] = None
-    """An array containing a page of deployment objects"""

tests/api_resources/test_deployments.py

@@ -15,6 +15,7 @@
     DeploymentUpdateResponse,
     DeploymentRetrieveResponse,
 )
+from replicate.pagination import SyncCursorURLPage, AsyncCursorURLPage
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -192,7 +193,7 @@ def test_path_params_update(self, client: ReplicateClient) -> None:
     @parametrize
     def test_method_list(self, client: ReplicateClient) -> None:
         deployment = client.deployments.list()
-        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+        assert_matches_type(SyncCursorURLPage[DeploymentListResponse], deployment, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -202,7 +203,7 @@ def test_raw_response_list(self, client: ReplicateClient) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         deployment = response.parse()
-        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+        assert_matches_type(SyncCursorURLPage[DeploymentListResponse], deployment, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -212,7 +213,7 @@ def test_streaming_response_list(self, client: ReplicateClient) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             deployment = response.parse()
-            assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+            assert_matches_type(SyncCursorURLPage[DeploymentListResponse], deployment, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -470,7 +471,7 @@ async def test_path_params_update(self, async_client: AsyncReplicateClient) -> N
     @parametrize
     async def test_method_list(self, async_client: AsyncReplicateClient) -> None:
         deployment = await async_client.deployments.list()
-        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+        assert_matches_type(AsyncCursorURLPage[DeploymentListResponse], deployment, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -480,7 +481,7 @@ async def test_raw_response_list(self, async_client: AsyncReplicateClient) -> No
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         deployment = await response.parse()
-        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+        assert_matches_type(AsyncCursorURLPage[DeploymentListResponse], deployment, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -490,7 +491,7 @@ async def test_streaming_response_list(self, async_client: AsyncReplicateClient)
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             deployment = await response.parse()
-            assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+            assert_matches_type(AsyncCursorURLPage[DeploymentListResponse], deployment, path=["response"])
 
         assert cast(Any, response.is_closed) is True