feat: feat(registrar): add registrar registrations list method on main

* feat(registrar): add registrations list method on main

Add registrar.registrations.list to the main registrar resource so the new GET /accounts/{account_id}/registrar/registrations endpoint is exposed through the converged Registrar surface on main as well as staging.

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 2129
+configured_endpoints: 2130
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-83a81462699153d3f2d3c484d97cdc6877b7c73a664cae829661e89bc6130afc.yml
 openapi_spec_hash: 6b9d05215024e69850fed051e136ba7c
-config_hash: 61ff4afd70fa432affae760c7dedebad
+config_hash: fce4390351fe38ffbbe66f8b173ece0a

api.md

@@ -4852,6 +4852,7 @@ Methods:
 Methods:
 
 - <code title="post /accounts/{account_id}/registrar/registrations">client.registrar.registrations.<a href="./src/cloudflare/resources/registrar/registrations.py">create</a>(\*, account_id, \*\*<a href="src/cloudflare/types/registrar/registration_create_params.py">params</a>) -> <a href="./src/cloudflare/types/registrar/workflow_status.py">WorkflowStatus</a></code>
+- <code title="get /accounts/{account_id}/registrar/registrations">client.registrar.registrations.<a href="./src/cloudflare/resources/registrar/registrations.py">list</a>(\*, account_id, \*\*<a href="src/cloudflare/types/registrar/registration_list_params.py">params</a>) -> <a href="./src/cloudflare/types/registrar/registration.py">SyncCursorPagination[Registration]</a></code>
 - <code title="patch /accounts/{account_id}/registrar/registrations/{domain_name}">client.registrar.registrations.<a href="./src/cloudflare/resources/registrar/registrations.py">edit</a>(domain_name, \*, account_id, \*\*<a href="src/cloudflare/types/registrar/registration_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/registrar/workflow_status.py">WorkflowStatus</a></code>
 - <code title="get /accounts/{account_id}/registrar/registrations/{domain_name}">client.registrar.registrations.<a href="./src/cloudflare/resources/registrar/registrations.py">get</a>(domain_name, \*, account_id) -> <a href="./src/cloudflare/types/registrar/registration.py">Registration</a></code>
 

src/cloudflare/resources/registrar/registrations.py

@@ -18,8 +18,9 @@
     async_to_streamed_response_wrapper,
 )
 from ..._wrappers import ResultWrapper
-from ..._base_client import make_request_options
-from ...types.registrar import registration_edit_params, registration_create_params
+from ...pagination import SyncCursorPagination, AsyncCursorPagination
+from ..._base_client import AsyncPaginator, make_request_options
+from ...types.registrar import registration_edit_params, registration_list_params, registration_create_params
 from ...types.registrar.registration import Registration
 from ...types.registrar.workflow_status import WorkflowStatus
 
@@ -193,6 +194,74 @@ def create(
             cast_to=cast(Type[WorkflowStatus], ResultWrapper[WorkflowStatus]),
         )
 
+    def list(
+        self,
+        *,
+        account_id: str,
+        cursor: str | Omit = omit,
+        direction: Literal["asc", "desc"] | Omit = omit,
+        per_page: int | Omit = omit,
+        sort_by: Literal["registry_created_at", "registry_expires_at", "name"] | 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,
+    ) -> SyncCursorPagination[Registration]:
+        """
+        Returns a paginated list of domain registrations owned by the account.
+
+        This endpoint uses cursor-based pagination. Results are ordered by registration
+        date by default. To fetch the next page, pass the `cursor` value from the
+        `result_info` object in the response as the `cursor` query parameter in your
+        next request. An empty `cursor` string indicates there are no more pages.
+
+        Args:
+          account_id: Identifier
+
+          cursor: Opaque token from a previous response's `result_info.cursor`. Pass this value to
+              fetch the next page of results. Omit (or pass an empty string) for the first
+              page.
+
+          direction: Sort direction for results. Defaults to ascending order.
+
+          per_page: Number of items to return per page.
+
+          sort_by: Column to sort results by. Defaults to registration date (`registry_created_at`)
+              when omitted.
+
+          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
+        """
+        if not account_id:
+            raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
+        return self._get_api_list(
+            f"/accounts/{account_id}/registrar/registrations",
+            page=SyncCursorPagination[Registration],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "direction": direction,
+                        "per_page": per_page,
+                        "sort_by": sort_by,
+                    },
+                    registration_list_params.RegistrationListParams,
+                ),
+            ),
+            model=Registration,
+        )
+
     def edit(
         self,
         domain_name: str,
@@ -483,6 +552,74 @@ async def create(
             cast_to=cast(Type[WorkflowStatus], ResultWrapper[WorkflowStatus]),
         )
 
+    def list(
+        self,
+        *,
+        account_id: str,
+        cursor: str | Omit = omit,
+        direction: Literal["asc", "desc"] | Omit = omit,
+        per_page: int | Omit = omit,
+        sort_by: Literal["registry_created_at", "registry_expires_at", "name"] | 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,
+    ) -> AsyncPaginator[Registration, AsyncCursorPagination[Registration]]:
+        """
+        Returns a paginated list of domain registrations owned by the account.
+
+        This endpoint uses cursor-based pagination. Results are ordered by registration
+        date by default. To fetch the next page, pass the `cursor` value from the
+        `result_info` object in the response as the `cursor` query parameter in your
+        next request. An empty `cursor` string indicates there are no more pages.
+
+        Args:
+          account_id: Identifier
+
+          cursor: Opaque token from a previous response's `result_info.cursor`. Pass this value to
+              fetch the next page of results. Omit (or pass an empty string) for the first
+              page.
+
+          direction: Sort direction for results. Defaults to ascending order.
+
+          per_page: Number of items to return per page.
+
+          sort_by: Column to sort results by. Defaults to registration date (`registry_created_at`)
+              when omitted.
+
+          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
+        """
+        if not account_id:
+            raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
+        return self._get_api_list(
+            f"/accounts/{account_id}/registrar/registrations",
+            page=AsyncCursorPagination[Registration],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "direction": direction,
+                        "per_page": per_page,
+                        "sort_by": sort_by,
+                    },
+                    registration_list_params.RegistrationListParams,
+                ),
+            ),
+            model=Registration,
+        )
+
     async def edit(
         self,
         domain_name: str,
@@ -615,6 +752,9 @@ def __init__(self, registrations: RegistrationsResource) -> None:
         self.create = to_raw_response_wrapper(
             registrations.create,
         )
+        self.list = to_raw_response_wrapper(
+            registrations.list,
+        )
         self.edit = to_raw_response_wrapper(
             registrations.edit,
         )
@@ -630,6 +770,9 @@ def __init__(self, registrations: AsyncRegistrationsResource) -> None:
         self.create = async_to_raw_response_wrapper(
             registrations.create,
         )
+        self.list = async_to_raw_response_wrapper(
+            registrations.list,
+        )
         self.edit = async_to_raw_response_wrapper(
             registrations.edit,
         )
@@ -645,6 +788,9 @@ def __init__(self, registrations: RegistrationsResource) -> None:
         self.create = to_streamed_response_wrapper(
             registrations.create,
         )
+        self.list = to_streamed_response_wrapper(
+            registrations.list,
+        )
         self.edit = to_streamed_response_wrapper(
             registrations.edit,
         )
@@ -660,6 +806,9 @@ def __init__(self, registrations: AsyncRegistrationsResource) -> None:
         self.create = async_to_streamed_response_wrapper(
             registrations.create,
         )
+        self.list = async_to_streamed_response_wrapper(
+            registrations.list,
+        )
         self.edit = async_to_streamed_response_wrapper(
             registrations.edit,
         )

src/cloudflare/types/registrar/__init__.py

@@ -10,5 +10,6 @@
 from .registrar_search_params import RegistrarSearchParams as RegistrarSearchParams
 from .registrar_check_response import RegistrarCheckResponse as RegistrarCheckResponse
 from .registration_edit_params import RegistrationEditParams as RegistrationEditParams
+from .registration_list_params import RegistrationListParams as RegistrationListParams
 from .registrar_search_response import RegistrarSearchResponse as RegistrarSearchResponse
 from .registration_create_params import RegistrationCreateParams as RegistrationCreateParams

src/cloudflare/types/registrar/registration_list_params.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["RegistrationListParams"]
+
+
+class RegistrationListParams(TypedDict, total=False):
+    account_id: Required[str]
+    """Identifier"""
+
+    cursor: str
+    """
+    Opaque token from a previous response's `result_info.cursor`. Pass this value to
+    fetch the next page of results. Omit (or pass an empty string) for the first
+    page.
+    """
+
+    direction: Literal["asc", "desc"]
+    """Sort direction for results. Defaults to ascending order."""
+
+    per_page: int
+    """Number of items to return per page."""
+
+    sort_by: Literal["registry_created_at", "registry_expires_at", "name"]
+    """Column to sort results by.
+
+    Defaults to registration date (`registry_created_at`) when omitted.
+    """

tests/api_resources/registrar/test_registrations.py

@@ -9,6 +9,7 @@
 
 from cloudflare import Cloudflare, AsyncCloudflare
 from tests.utils import assert_matches_type
+from cloudflare.pagination import SyncCursorPagination, AsyncCursorPagination
 from cloudflare.types.registrar import (
     Registration,
     WorkflowStatus,
@@ -92,6 +93,55 @@ def test_path_params_create(self, client: Cloudflare) -> None:
                 domain_name="my-new-startup.com",
             )
 
+    @parametrize
+    def test_method_list(self, client: Cloudflare) -> None:
+        registration = client.registrar.registrations.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+        )
+        assert_matches_type(SyncCursorPagination[Registration], registration, path=["response"])
+
+    @parametrize
+    def test_method_list_with_all_params(self, client: Cloudflare) -> None:
+        registration = client.registrar.registrations.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            cursor="cursor",
+            direction="asc",
+            per_page=1,
+            sort_by="registry_created_at",
+        )
+        assert_matches_type(SyncCursorPagination[Registration], registration, path=["response"])
+
+    @parametrize
+    def test_raw_response_list(self, client: Cloudflare) -> None:
+        response = client.registrar.registrations.with_raw_response.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        registration = response.parse()
+        assert_matches_type(SyncCursorPagination[Registration], registration, path=["response"])
+
+    @parametrize
+    def test_streaming_response_list(self, client: Cloudflare) -> None:
+        with client.registrar.registrations.with_streaming_response.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            registration = response.parse()
+            assert_matches_type(SyncCursorPagination[Registration], registration, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    def test_path_params_list(self, client: Cloudflare) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"):
+            client.registrar.registrations.with_raw_response.list(
+                account_id="",
+            )
+
     @parametrize
     def test_method_edit(self, client: Cloudflare) -> None:
         registration = client.registrar.registrations.edit(
@@ -276,6 +326,55 @@ async def test_path_params_create(self, async_client: AsyncCloudflare) -> None:
                 domain_name="my-new-startup.com",
             )
 
+    @parametrize
+    async def test_method_list(self, async_client: AsyncCloudflare) -> None:
+        registration = await async_client.registrar.registrations.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+        )
+        assert_matches_type(AsyncCursorPagination[Registration], registration, path=["response"])
+
+    @parametrize
+    async def test_method_list_with_all_params(self, async_client: AsyncCloudflare) -> None:
+        registration = await async_client.registrar.registrations.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+            cursor="cursor",
+            direction="asc",
+            per_page=1,
+            sort_by="registry_created_at",
+        )
+        assert_matches_type(AsyncCursorPagination[Registration], registration, path=["response"])
+
+    @parametrize
+    async def test_raw_response_list(self, async_client: AsyncCloudflare) -> None:
+        response = await async_client.registrar.registrations.with_raw_response.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        registration = await response.parse()
+        assert_matches_type(AsyncCursorPagination[Registration], registration, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_list(self, async_client: AsyncCloudflare) -> None:
+        async with async_client.registrar.registrations.with_streaming_response.list(
+            account_id="023e105f4ecef8ad9ca31a8372d0c353",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            registration = await response.parse()
+            assert_matches_type(AsyncCursorPagination[Registration], registration, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    async def test_path_params_list(self, async_client: AsyncCloudflare) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `account_id` but received ''"):
+            await async_client.registrar.registrations.with_raw_response.list(
+                account_id="",
+            )
+
     @parametrize
     async def test_method_edit(self, async_client: AsyncCloudflare) -> None:
         registration = await async_client.registrar.registrations.edit(