feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 1777
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-9629020f23f4c564925a52c46cdf5a93581a3f6bf35bf8050b0792467f642d33.yml
-openapi_spec_hash: 58db5ad168eaa03ed1c9a028636c58f6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-d4d577be5bc8f4a0303c10df020efdc8823f02867d8f74e414c75e747c10e8e2.yml
+openapi_spec_hash: 523313d2ea7487505e7913769ecd7e53
 config_hash: bafeb7666d2b7868c9d4ab8f0cc686e1

api.md

@@ -3361,7 +3361,7 @@ from cloudflare.types.brand_protection import (
 Methods:
 
 - <code title="post /accounts/{account_id}/brand-protection/submit">client.brand_protection.<a href="./src/cloudflare/resources/brand_protection/brand_protection.py">submit</a>(\*, account_id) -> <a href="./src/cloudflare/types/brand_protection/brand_protection_submit_response.py">BrandProtectionSubmitResponse</a></code>
-- <code title="get /accounts/{account_id}/brand-protection/url-info">client.brand_protection.<a href="./src/cloudflare/resources/brand_protection/brand_protection.py">url_info</a>(\*, account_id) -> <a href="./src/cloudflare/types/brand_protection/brand_protection_url_info_response.py">BrandProtectionURLInfoResponse</a></code>
+- <code title="get /accounts/{account_id}/brand-protection/url-info">client.brand_protection.<a href="./src/cloudflare/resources/brand_protection/brand_protection.py">url_info</a>(\*, account_id) -> <a href="./src/cloudflare/types/brand_protection/brand_protection_url_info_response.py">SyncSinglePage[BrandProtectionURLInfoResponse]</a></code>
 
 ## Queries
 

src/cloudflare/resources/brand_protection/brand_protection.py

@@ -37,6 +37,7 @@
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
+from ...pagination import SyncSinglePage, AsyncSinglePage
 from .logo_matches import (
     LogoMatchesResource,
     AsyncLogoMatchesResource,
@@ -45,7 +46,7 @@
     LogoMatchesResourceWithStreamingResponse,
     AsyncLogoMatchesResourceWithStreamingResponse,
 )
-from ..._base_client import make_request_options
+from ..._base_client import AsyncPaginator, make_request_options
 from ...types.brand_protection.brand_protection_submit_response import BrandProtectionSubmitResponse
 from ...types.brand_protection.brand_protection_url_info_response import BrandProtectionURLInfoResponse
 
@@ -131,7 +132,7 @@ def url_info(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> BrandProtectionURLInfoResponse:
+    ) -> SyncSinglePage[BrandProtectionURLInfoResponse]:
         """
         Return submitted URLs based on ID
 
@@ -146,12 +147,13 @@ def url_info(
         """
         if not account_id:
             raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
-        return self._get(
+        return self._get_api_list(
             f"/accounts/{account_id}/brand-protection/url-info",
+            page=SyncSinglePage[BrandProtectionURLInfoResponse],
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=BrandProtectionURLInfoResponse,
+            model=BrandProtectionURLInfoResponse,
         )
 
 
@@ -224,7 +226,7 @@ async def submit(
             cast_to=BrandProtectionSubmitResponse,
         )
 
-    async def url_info(
+    def url_info(
         self,
         *,
         account_id: str,
@@ -234,7 +236,7 @@ async def url_info(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> BrandProtectionURLInfoResponse:
+    ) -> AsyncPaginator[BrandProtectionURLInfoResponse, AsyncSinglePage[BrandProtectionURLInfoResponse]]:
         """
         Return submitted URLs based on ID
 
@@ -249,12 +251,13 @@ async def url_info(
         """
         if not account_id:
             raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
-        return await self._get(
+        return self._get_api_list(
             f"/accounts/{account_id}/brand-protection/url-info",
+            page=AsyncSinglePage[BrandProtectionURLInfoResponse],
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=BrandProtectionURLInfoResponse,
+            model=BrandProtectionURLInfoResponse,
         )
 
 

src/cloudflare/types/brand_protection/brand_protection_submit_response.py

@@ -1,21 +1,13 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, Optional
+from typing import Dict, List, Optional
 
 from ..._models import BaseModel
 
 __all__ = ["BrandProtectionSubmitResponse"]
 
 
 class BrandProtectionSubmitResponse(BaseModel):
-    code: Optional[int] = None
-    """Error code"""
+    skipped_urls: Optional[List[Dict[str, object]]] = None
 
-    errors: Optional[Dict[str, object]] = None
-    """Errors"""
-
-    message: Optional[str] = None
-    """Error message"""
-
-    status: Optional[str] = None
-    """Error name"""
+    submitted_urls: Optional[List[Dict[str, object]]] = None

src/cloudflare/types/brand_protection/brand_protection_url_info_response.py

@@ -1,21 +1,8 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, Optional
-
-from ..._models import BaseModel
+from typing import Dict
+from typing_extensions import TypeAlias
 
 __all__ = ["BrandProtectionURLInfoResponse"]
 
-
-class BrandProtectionURLInfoResponse(BaseModel):
-    code: Optional[int] = None
-    """Error code"""
-
-    errors: Optional[Dict[str, object]] = None
-    """Errors"""
-
-    message: Optional[str] = None
-    """Error message"""
-
-    status: Optional[str] = None
-    """Error name"""
+BrandProtectionURLInfoResponse: TypeAlias = Dict[str, object]

tests/api_resources/test_brand_protection.py

@@ -9,6 +9,7 @@
 
 from cloudflare import Cloudflare, AsyncCloudflare
 from tests.utils import assert_matches_type
+from cloudflare.pagination import SyncSinglePage, AsyncSinglePage
 from cloudflare.types.brand_protection import BrandProtectionSubmitResponse, BrandProtectionURLInfoResponse
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
@@ -60,7 +61,7 @@ def test_method_url_info(self, client: Cloudflare) -> None:
         brand_protection = client.brand_protection.url_info(
             account_id="x",
         )
-        assert_matches_type(BrandProtectionURLInfoResponse, brand_protection, path=["response"])
+        assert_matches_type(SyncSinglePage[BrandProtectionURLInfoResponse], brand_protection, path=["response"])
 
     @parametrize
     def test_raw_response_url_info(self, client: Cloudflare) -> None:
@@ -71,7 +72,7 @@ def test_raw_response_url_info(self, client: Cloudflare) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         brand_protection = response.parse()
-        assert_matches_type(BrandProtectionURLInfoResponse, brand_protection, path=["response"])
+        assert_matches_type(SyncSinglePage[BrandProtectionURLInfoResponse], brand_protection, path=["response"])
 
     @parametrize
     def test_streaming_response_url_info(self, client: Cloudflare) -> None:
@@ -82,7 +83,7 @@ def test_streaming_response_url_info(self, client: Cloudflare) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             brand_protection = response.parse()
-            assert_matches_type(BrandProtectionURLInfoResponse, brand_protection, path=["response"])
+            assert_matches_type(SyncSinglePage[BrandProtectionURLInfoResponse], brand_protection, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -142,7 +143,7 @@ async def test_method_url_info(self, async_client: AsyncCloudflare) -> None:
         brand_protection = await async_client.brand_protection.url_info(
             account_id="x",
         )
-        assert_matches_type(BrandProtectionURLInfoResponse, brand_protection, path=["response"])
+        assert_matches_type(AsyncSinglePage[BrandProtectionURLInfoResponse], brand_protection, path=["response"])
 
     @parametrize
     async def test_raw_response_url_info(self, async_client: AsyncCloudflare) -> None:
@@ -153,7 +154,7 @@ async def test_raw_response_url_info(self, async_client: AsyncCloudflare) -> Non
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         brand_protection = await response.parse()
-        assert_matches_type(BrandProtectionURLInfoResponse, brand_protection, path=["response"])
+        assert_matches_type(AsyncSinglePage[BrandProtectionURLInfoResponse], brand_protection, path=["response"])
 
     @parametrize
     async def test_streaming_response_url_info(self, async_client: AsyncCloudflare) -> None:
@@ -164,7 +165,7 @@ async def test_streaming_response_url_info(self, async_client: AsyncCloudflare)
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             brand_protection = await response.parse()
-            assert_matches_type(BrandProtectionURLInfoResponse, brand_protection, path=["response"])
+            assert_matches_type(AsyncSinglePage[BrandProtectionURLInfoResponse], brand_protection, path=["response"])
 
         assert cast(Any, response.is_closed) is True