feat: api: paginate GET /org/credential_providers

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-9a76e7a837ac9ffbe0e9557d618ce9b676e052249e364e516c28ddb33b912019.yml
-openapi_spec_hash: c0e5412cc95139f11a8b8635559bb985
-config_hash: 098a7f3fd134c8e4cbd3a44750892a18
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e6c711f0d29a7d956cc8ca621440da966c1f1575b1205d01328b1099edf1c517.yml
+openapi_spec_hash: c06e7e36de1c6f9b29b54a6e3dc08ee5
+config_hash: 36159c262d293fbeacf513ab600a1729

api.md

@@ -441,7 +441,6 @@ from kernel.types import (
     CredentialProviderItem,
     CredentialProviderTestResult,
     UpdateCredentialProviderRequest,
-    CredentialProviderListResponse,
     CredentialProviderListItemsResponse,
 )
 ```
@@ -451,7 +450,7 @@ Methods:
 - <code title="post /org/credential_providers">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">create</a>(\*\*<a href="src/kernel/types/credential_provider_create_params.py">params</a>) -> <a href="./src/kernel/types/credential_provider.py">CredentialProvider</a></code>
 - <code title="get /org/credential_providers/{id}">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">retrieve</a>(id) -> <a href="./src/kernel/types/credential_provider.py">CredentialProvider</a></code>
 - <code title="patch /org/credential_providers/{id}">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">update</a>(id, \*\*<a href="src/kernel/types/credential_provider_update_params.py">params</a>) -> <a href="./src/kernel/types/credential_provider.py">CredentialProvider</a></code>
-- <code title="get /org/credential_providers">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">list</a>() -> <a href="./src/kernel/types/credential_provider_list_response.py">CredentialProviderListResponse</a></code>
+- <code title="get /org/credential_providers">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">list</a>(\*\*<a href="src/kernel/types/credential_provider_list_params.py">params</a>) -> <a href="./src/kernel/types/credential_provider.py">SyncOffsetPagination[CredentialProvider]</a></code>
 - <code title="delete /org/credential_providers/{id}">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">delete</a>(id) -> None</code>
 - <code title="get /org/credential_providers/{id}/items">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">list_items</a>(id) -> <a href="./src/kernel/types/credential_provider_list_items_response.py">CredentialProviderListItemsResponse</a></code>
 - <code title="post /org/credential_providers/{id}/test">client.credential_providers.<a href="./src/kernel/resources/credential_providers.py">test</a>(id) -> <a href="./src/kernel/types/credential_provider_test_result.py">CredentialProviderTestResult</a></code>

src/kernel/resources/credential_providers.py

@@ -6,7 +6,11 @@
 
 import httpx
 
-from ..types import credential_provider_create_params, credential_provider_update_params
+from ..types import (
+    credential_provider_list_params,
+    credential_provider_create_params,
+    credential_provider_update_params,
+)
 from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
 from .._utils import path_template, maybe_transform, async_maybe_transform
 from .._compat import cached_property
@@ -17,10 +21,10 @@
     async_to_raw_response_wrapper,
     async_to_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.credential_provider import CredentialProvider
 from ..types.credential_provider_test_result import CredentialProviderTestResult
-from ..types.credential_provider_list_response import CredentialProviderListResponse
 from ..types.credential_provider_list_items_response import CredentialProviderListItemsResponse
 
 __all__ = ["CredentialProvidersResource", "AsyncCredentialProvidersResource"]
@@ -194,20 +198,48 @@ def update(
     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,
-    ) -> CredentialProviderListResponse:
-        """List external credential providers configured for the organization."""
-        return self._get(
+    ) -> SyncOffsetPagination[CredentialProvider]:
+        """
+        List external credential providers configured for the organization.
+
+        Args:
+          limit: Limit the number of credential providers to return.
+
+          offset: Offset the number of credential providers 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(
             "/org/credential_providers",
+            page=SyncOffsetPagination[CredentialProvider],
             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,
+                    },
+                    credential_provider_list_params.CredentialProviderListParams,
+                ),
             ),
-            cast_to=CredentialProviderListResponse,
+            model=CredentialProvider,
         )
 
     def delete(
@@ -477,23 +509,51 @@ async def update(
             cast_to=CredentialProvider,
         )
 
-    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,
-    ) -> CredentialProviderListResponse:
-        """List external credential providers configured for the organization."""
-        return await self._get(
+    ) -> AsyncPaginator[CredentialProvider, AsyncOffsetPagination[CredentialProvider]]:
+        """
+        List external credential providers configured for the organization.
+
+        Args:
+          limit: Limit the number of credential providers to return.
+
+          offset: Offset the number of credential providers 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(
             "/org/credential_providers",
+            page=AsyncOffsetPagination[CredentialProvider],
             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,
+                    },
+                    credential_provider_list_params.CredentialProviderListParams,
+                ),
             ),
-            cast_to=CredentialProviderListResponse,
+            model=CredentialProvider,
         )
 
     async def delete(

src/kernel/types/__init__.py

@@ -86,9 +86,9 @@
 from .browser_pool_acquire_response import BrowserPoolAcquireResponse as BrowserPoolAcquireResponse
 from .credential_totp_code_response import CredentialTotpCodeResponse as CredentialTotpCodeResponse
 from .browser_load_extensions_params import BrowserLoadExtensionsParams as BrowserLoadExtensionsParams
+from .credential_provider_list_params import CredentialProviderListParams as CredentialProviderListParams
 from .credential_provider_test_result import CredentialProviderTestResult as CredentialProviderTestResult
 from .credential_provider_create_params import CredentialProviderCreateParams as CredentialProviderCreateParams
-from .credential_provider_list_response import CredentialProviderListResponse as CredentialProviderListResponse
 from .credential_provider_update_params import CredentialProviderUpdateParams as CredentialProviderUpdateParams
 from .invocation_list_browsers_response import InvocationListBrowsersResponse as InvocationListBrowsersResponse
 from .credential_provider_list_items_response import (

src/kernel/types/credential_provider_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__ = ["CredentialProviderListParams"]
+
+
+class CredentialProviderListParams(TypedDict, total=False):
+    limit: int
+    """Limit the number of credential providers to return."""
+
+    offset: int
+    """Offset the number of credential providers to return."""

src/kernel/types/credential_provider_list_response.py

@@ -12,9 +12,9 @@
 from kernel.types import (
     CredentialProvider,
     CredentialProviderTestResult,
-    CredentialProviderListResponse,
     CredentialProviderListItemsResponse,
 )
+from kernel.pagination import SyncOffsetPagination, AsyncOffsetPagination
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -174,7 +174,16 @@ def test_path_params_update(self, client: Kernel) -> None:
     @parametrize
     def test_method_list(self, client: Kernel) -> None:
         credential_provider = client.credential_providers.list()
-        assert_matches_type(CredentialProviderListResponse, credential_provider, path=["response"])
+        assert_matches_type(SyncOffsetPagination[CredentialProvider], credential_provider, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_method_list_with_all_params(self, client: Kernel) -> None:
+        credential_provider = client.credential_providers.list(
+            limit=1,
+            offset=0,
+        )
+        assert_matches_type(SyncOffsetPagination[CredentialProvider], credential_provider, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -184,7 +193,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"
         credential_provider = response.parse()
-        assert_matches_type(CredentialProviderListResponse, credential_provider, path=["response"])
+        assert_matches_type(SyncOffsetPagination[CredentialProvider], credential_provider, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -194,7 +203,7 @@ def test_streaming_response_list(self, client: Kernel) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             credential_provider = response.parse()
-            assert_matches_type(CredentialProviderListResponse, credential_provider, path=["response"])
+            assert_matches_type(SyncOffsetPagination[CredentialProvider], credential_provider, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -482,7 +491,16 @@ async def test_path_params_update(self, async_client: AsyncKernel) -> None:
     @parametrize
     async def test_method_list(self, async_client: AsyncKernel) -> None:
         credential_provider = await async_client.credential_providers.list()
-        assert_matches_type(CredentialProviderListResponse, credential_provider, path=["response"])
+        assert_matches_type(AsyncOffsetPagination[CredentialProvider], credential_provider, 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:
+        credential_provider = await async_client.credential_providers.list(
+            limit=1,
+            offset=0,
+        )
+        assert_matches_type(AsyncOffsetPagination[CredentialProvider], credential_provider, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -492,7 +510,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"
         credential_provider = await response.parse()
-        assert_matches_type(CredentialProviderListResponse, credential_provider, path=["response"])
+        assert_matches_type(AsyncOffsetPagination[CredentialProvider], credential_provider, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
@@ -502,7 +520,7 @@ async def test_streaming_response_list(self, async_client: AsyncKernel) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             credential_provider = await response.parse()
-            assert_matches_type(CredentialProviderListResponse, credential_provider, path=["response"])
+            assert_matches_type(AsyncOffsetPagination[CredentialProvider], credential_provider, path=["response"])
 
         assert cast(Any, response.is_closed) is True