chore(api): update composite API spec

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 2400
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-dc45d49df27d76c4dac5f9050d933875dfd3c15e0c410ca91343d425d2ad7aeb.yml
-openapi_spec_hash: 5fd14ff0d2fe35b4cbc5b423d12e4f0b
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-7deeb9a4fdf922c923fc5b0148e7ca74ee56b8e9845a654d1f7f98de0b942c12.yml
+openapi_spec_hash: fdb8c462be6b2a6354e8d4f9e2340110
 config_hash: 2f529580a17438fc62cd0b47db41b6f1

src/cloudflare/resources/intel/domains/bulks.py

@@ -49,6 +49,8 @@ def get(
         *,
         account_id: str,
         domain: SequenceNotStr[str] | Omit = omit,
+        include_ranking: bool | Omit = omit,
+        skip_ranking: bool | 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,
@@ -57,13 +59,32 @@ def get(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Optional[BulkGetResponse]:
         """
-        Same as summary.
+        Returns security details and statistics about multiple domains in a single
+        request.
+
+        **Behavior change — domain ranking is becoming opt-in.** This endpoint
+        previously included domain ranking data in every response and accepted a
+        `skip_ranking=true` query parameter to opt out. That parameter is being
+        deprecated and ranking will no longer be returned by default. Callers that want
+        ranking data must pass `include_ranking=true`. The `skip_ranking` parameter will
+        be silently ignored once the change ships.
 
         Args:
           account_id: Identifier.
 
           domain: Accepts multiple values like `?domain=cloudflare.com&domain=example.com`.
 
+          include_ranking: Whether to include domain ranking data in the response. Defaults to `false` —
+              ranking lookups are expensive at bulk scale and most callers do not need them.
+              Set to `true` to opt in. This parameter replaces the deprecated `skip_ranking`
+              (see below).
+
+          skip_ranking: **Deprecated.** Previously controlled whether the ranking lookup was skipped
+              (defaulted to `false`, meaning ranking ran). The endpoint's default behavior is
+              being flipped — ranking is now opt-in via `include_ranking=true` — and this
+              parameter will be silently ignored. Remove it from your callers and use
+              `include_ranking` instead.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -81,7 +102,14 @@ def get(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=maybe_transform({"domain": domain}, bulk_get_params.BulkGetParams),
+                query=maybe_transform(
+                    {
+                        "domain": domain,
+                        "include_ranking": include_ranking,
+                        "skip_ranking": skip_ranking,
+                    },
+                    bulk_get_params.BulkGetParams,
+                ),
                 post_parser=ResultWrapper[Optional[BulkGetResponse]]._unwrapper,
             ),
             cast_to=cast(Type[Optional[BulkGetResponse]], ResultWrapper[BulkGetResponse]),
@@ -113,6 +141,8 @@ async def get(
         *,
         account_id: str,
         domain: SequenceNotStr[str] | Omit = omit,
+        include_ranking: bool | Omit = omit,
+        skip_ranking: bool | 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,
@@ -121,13 +151,32 @@ async def get(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Optional[BulkGetResponse]:
         """
-        Same as summary.
+        Returns security details and statistics about multiple domains in a single
+        request.
+
+        **Behavior change — domain ranking is becoming opt-in.** This endpoint
+        previously included domain ranking data in every response and accepted a
+        `skip_ranking=true` query parameter to opt out. That parameter is being
+        deprecated and ranking will no longer be returned by default. Callers that want
+        ranking data must pass `include_ranking=true`. The `skip_ranking` parameter will
+        be silently ignored once the change ships.
 
         Args:
           account_id: Identifier.
 
           domain: Accepts multiple values like `?domain=cloudflare.com&domain=example.com`.
 
+          include_ranking: Whether to include domain ranking data in the response. Defaults to `false` —
+              ranking lookups are expensive at bulk scale and most callers do not need them.
+              Set to `true` to opt in. This parameter replaces the deprecated `skip_ranking`
+              (see below).
+
+          skip_ranking: **Deprecated.** Previously controlled whether the ranking lookup was skipped
+              (defaulted to `false`, meaning ranking ran). The endpoint's default behavior is
+              being flipped — ranking is now opt-in via `include_ranking=true` — and this
+              parameter will be silently ignored. Remove it from your callers and use
+              `include_ranking` instead.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -145,7 +194,14 @@ async def get(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform({"domain": domain}, bulk_get_params.BulkGetParams),
+                query=await async_maybe_transform(
+                    {
+                        "domain": domain,
+                        "include_ranking": include_ranking,
+                        "skip_ranking": skip_ranking,
+                    },
+                    bulk_get_params.BulkGetParams,
+                ),
                 post_parser=ResultWrapper[Optional[BulkGetResponse]]._unwrapper,
             ),
             cast_to=cast(Type[Optional[BulkGetResponse]], ResultWrapper[BulkGetResponse]),

src/cloudflare/types/intel/domains/bulk_get_params.py

@@ -15,3 +15,20 @@ class BulkGetParams(TypedDict, total=False):
 
     domain: SequenceNotStr[str]
     """Accepts multiple values like `?domain=cloudflare.com&domain=example.com`."""
+
+    include_ranking: bool
+    """Whether to include domain ranking data in the response.
+
+    Defaults to `false` — ranking lookups are expensive at bulk scale and most
+    callers do not need them. Set to `true` to opt in. This parameter replaces the
+    deprecated `skip_ranking` (see below).
+    """
+
+    skip_ranking: bool
+    """
+    **Deprecated.** Previously controlled whether the ranking lookup was skipped
+    (defaulted to `false`, meaning ranking ran). The endpoint's default behavior is
+    being flipped — ranking is now opt-in via `include_ranking=true` — and this
+    parameter will be silently ignored. Remove it from your callers and use
+    `include_ranking` instead.
+    """

tests/api_resources/intel/domains/test_bulks.py

@@ -29,6 +29,8 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None:
         bulk = client.intel.domains.bulks.get(
             account_id="023e105f4ecef8ad9ca31a8372d0c353",
             domain=["string"],
+            include_ranking=True,
+            skip_ranking=True,
         )
         assert_matches_type(Optional[BulkGetResponse], bulk, path=["response"])
 
@@ -81,6 +83,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) -
         bulk = await async_client.intel.domains.bulks.get(
             account_id="023e105f4ecef8ad9ca31a8372d0c353",
             domain=["string"],
+            include_ranking=True,
+            skip_ranking=True,
         )
         assert_matches_type(Optional[BulkGetResponse], bulk, path=["response"])