feat: api: paginate GET /extensions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 117
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e5524e6eeeedc614c05bf19896f1ce6c4f8a113de85c02952d6874d579651f70.yml
-openapi_spec_hash: 7815a189a50e6aa9e283213cc78d041c
-config_hash: 453b25a35834fd59a55a2315d1d50746
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-9a76e7a837ac9ffbe0e9557d618ce9b676e052249e364e516c28ddb33b912019.yml
+openapi_spec_hash: c0e5412cc95139f11a8b8635559bb985
+config_hash: 098a7f3fd134c8e4cbd3a44750892a18

api.md

@@ -338,7 +338,7 @@ from kernel.types import ExtensionListResponse, ExtensionUploadResponse
 
 Methods:
 
-- <code title="get /extensions">client.extensions.<a href="./src/kernel/resources/extensions.py">list</a>() -> <a href="./src/kernel/types/extension_list_response.py">ExtensionListResponse</a></code>
+- <code title="get /extensions">client.extensions.<a href="./src/kernel/resources/extensions.py">list</a>(\*\*<a href="src/kernel/types/extension_list_params.py">params</a>) -> <a href="./src/kernel/types/extension_list_response.py">SyncOffsetPagination[ExtensionListResponse]</a></code>
 - <code title="delete /extensions/{id_or_name}">client.extensions.<a href="./src/kernel/resources/extensions.py">delete</a>(id_or_name) -> None</code>
 - <code title="get /extensions/{id_or_name}">client.extensions.<a href="./src/kernel/resources/extensions.py">download</a>(id_or_name) -> BinaryAPIResponse</code>
 - <code title="get /extensions/from_chrome_store">client.extensions.<a href="./src/kernel/resources/extensions.py">download_from_chrome_store</a>(\*\*<a href="src/kernel/types/extension_download_from_chrome_store_params.py">params</a>) -> BinaryAPIResponse</code>

src/kernel/resources/extensions.py

@@ -7,7 +7,7 @@
 
 import httpx
 
-from ..types import extension_upload_params, extension_download_from_chrome_store_params
+from ..types import extension_list_params, extension_upload_params, extension_download_from_chrome_store_params
 from .._files import deepcopy_with_paths
 from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, FileTypes, omit, not_given
 from .._utils import extract_files, path_template, maybe_transform, async_maybe_transform
@@ -27,7 +27,8 @@
     async_to_custom_raw_response_wrapper,
     async_to_custom_streamed_response_wrapper,
 )
-from .._base_client import make_request_options
+from ..pagination import SyncOffsetPagination, AsyncOffsetPagination
+from .._base_client import AsyncPaginator, make_request_options
 from ..types.extension_list_response import ExtensionListResponse
 from ..types.extension_upload_response import ExtensionUploadResponse
 
@@ -59,20 +60,48 @@ def with_streaming_response(self) -> ExtensionsResourceWithStreamingResponse:
     def list(
         self,
         *,
+        limit: int | Omit = omit,
+        offset: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> ExtensionListResponse:
-        """List extensions owned by the caller's organization."""
-        return self._get(
+    ) -> SyncOffsetPagination[ExtensionListResponse]:
+        """
+        List extensions owned by the caller's organization.
+
+        Args:
+          limit: Limit the number of extensions to return.
+
+          offset: Offset the number of extensions to return.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
             "/extensions",
+            page=SyncOffsetPagination[ExtensionListResponse],
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "offset": offset,
+                    },
+                    extension_list_params.ExtensionListParams,
+                ),
             ),
-            cast_to=ExtensionListResponse,
+            model=ExtensionListResponse,
         )
 
     def delete(
@@ -266,23 +295,51 @@ def with_streaming_response(self) -> AsyncExtensionsResourceWithStreamingRespons
         """
         return AsyncExtensionsResourceWithStreamingResponse(self)
 
-    async def list(
+    def list(
         self,
         *,
+        limit: int | Omit = omit,
+        offset: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> ExtensionListResponse:
-        """List extensions owned by the caller's organization."""
-        return await self._get(
+    ) -> AsyncPaginator[ExtensionListResponse, AsyncOffsetPagination[ExtensionListResponse]]:
+        """
+        List extensions owned by the caller's organization.
+
+        Args:
+          limit: Limit the number of extensions to return.
+
+          offset: Offset the number of extensions to return.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
             "/extensions",
+            page=AsyncOffsetPagination[ExtensionListResponse],
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "offset": offset,
+                    },
+                    extension_list_params.ExtensionListParams,
+                ),
             ),
-            cast_to=ExtensionListResponse,
+            model=ExtensionListResponse,
         )
 
     async def delete(

src/kernel/types/__init__.py

@@ -42,6 +42,7 @@
 from .browser_curl_response import BrowserCurlResponse as BrowserCurlResponse
 from .browser_list_response import BrowserListResponse as BrowserListResponse
 from .browser_update_params import BrowserUpdateParams as BrowserUpdateParams
+from .extension_list_params import ExtensionListParams as ExtensionListParams
 from .profile_create_params import ProfileCreateParams as ProfileCreateParams
 from .project_create_params import ProjectCreateParams as ProjectCreateParams
 from .project_update_params import ProjectUpdateParams as ProjectUpdateParams

src/kernel/types/extension_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["ExtensionListParams"]
+
+
+class ExtensionListParams(TypedDict, total=False):
+    limit: int
+    """Limit the number of extensions to return."""
+
+    offset: int
+    """Offset the number of extensions to return."""

src/kernel/types/extension_list_response.py

@@ -1,15 +1,14 @@
 # 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 TypeAlias
 
 from .._models import BaseModel
 
-__all__ = ["ExtensionListResponse", "ExtensionListResponseItem"]
+__all__ = ["ExtensionListResponse"]
 
 
-class ExtensionListResponseItem(BaseModel):
+class ExtensionListResponse(BaseModel):
     """A browser extension uploaded to Kernel."""
 
     id: str
@@ -29,6 +28,3 @@ class ExtensionListResponseItem(BaseModel):
 
     Must be unique within the project.
     """
-
-
-ExtensionListResponse: TypeAlias = List[ExtensionListResponseItem]

tests/api_resources/test_extensions.py

@@ -21,6 +21,7 @@
     StreamedBinaryAPIResponse,
     AsyncStreamedBinaryAPIResponse,
 )
+from kernel.pagination import SyncOffsetPagination, AsyncOffsetPagination
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -32,7 +33,16 @@ class TestExtensions:
     @parametrize
     def test_method_list(self, client: Kernel) -> None:
         extension = client.extensions.list()
-        assert_matches_type(ExtensionListResponse, extension, path=["response"])
+        assert_matches_type(SyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_method_list_with_all_params(self, client: Kernel) -> None:
+        extension = client.extensions.list(
+            limit=1,
+            offset=0,
+        )
+        assert_matches_type(SyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -42,7 +52,7 @@ def test_raw_response_list(self, client: Kernel) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         extension = response.parse()
-        assert_matches_type(ExtensionListResponse, extension, path=["response"])
+        assert_matches_type(SyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -52,7 +62,7 @@ def test_streaming_response_list(self, client: Kernel) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             extension = response.parse()
-            assert_matches_type(ExtensionListResponse, extension, path=["response"])
+            assert_matches_type(SyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -256,7 +266,16 @@ class TestAsyncExtensions:
     @parametrize
     async def test_method_list(self, async_client: AsyncKernel) -> None:
         extension = await async_client.extensions.list()
-        assert_matches_type(ExtensionListResponse, extension, path=["response"])
+        assert_matches_type(AsyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_method_list_with_all_params(self, async_client: AsyncKernel) -> None:
+        extension = await async_client.extensions.list(
+            limit=1,
+            offset=0,
+        )
+        assert_matches_type(AsyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -266,7 +285,7 @@ async def test_raw_response_list(self, async_client: AsyncKernel) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         extension = await response.parse()
-        assert_matches_type(ExtensionListResponse, extension, path=["response"])
+        assert_matches_type(AsyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -276,7 +295,7 @@ async def test_streaming_response_list(self, async_client: AsyncKernel) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             extension = await response.parse()
-            assert_matches_type(ExtensionListResponse, extension, path=["response"])
+            assert_matches_type(AsyncOffsetPagination[ExtensionListResponse], extension, path=["response"])
 
         assert cast(Any, response.is_closed) is True