feat: Merge branch 'mingwei/BGP-418' into 'main'

feat: add Radar AS-SET lookup endpoint API docs

Closes BGP-418

See merge request cloudflare/sdks/cloudflare-config!139

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 1811
+configured_endpoints: 1812
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-ccaf8367d55e99438b6a6f626a329882a58479d38acd63194e45d06a77451be1.yml
 openapi_spec_hash: 53e2bb09eb6d7a3e927d0ee63a28815e
-config_hash: 13d4a964ecc36ea611888df92272c3da
+config_hash: 08d1e85e3d6166780e91482de72fa93c

api.md

@@ -8205,6 +8205,7 @@ Types:
 ```python
 from cloudflare.types.radar.entities import (
     ASNListResponse,
+    ASNAsSetResponse,
     ASNGetResponse,
     ASNIPResponse,
     ASNRelResponse,
@@ -8214,6 +8215,7 @@ from cloudflare.types.radar.entities import (
 Methods:
 
 - <code title="get /radar/entities/asns">client.radar.entities.asns.<a href="./src/cloudflare/resources/radar/entities/asns.py">list</a>(\*\*<a href="src/cloudflare/types/radar/entities/asn_list_params.py">params</a>) -> <a href="./src/cloudflare/types/radar/entities/asn_list_response.py">ASNListResponse</a></code>
+- <code title="get /radar/entities/asns/{asn}/as_set">client.radar.entities.asns.<a href="./src/cloudflare/resources/radar/entities/asns.py">as_set</a>(asn, \*\*<a href="src/cloudflare/types/radar/entities/asn_as_set_params.py">params</a>) -> <a href="./src/cloudflare/types/radar/entities/asn_as_set_response.py">ASNAsSetResponse</a></code>
 - <code title="get /radar/entities/asns/{asn}">client.radar.entities.asns.<a href="./src/cloudflare/resources/radar/entities/asns.py">get</a>(asn, \*\*<a href="src/cloudflare/types/radar/entities/asn_get_params.py">params</a>) -> <a href="./src/cloudflare/types/radar/entities/asn_get_response.py">ASNGetResponse</a></code>
 - <code title="get /radar/entities/asns/ip">client.radar.entities.asns.<a href="./src/cloudflare/resources/radar/entities/asns.py">ip</a>(\*\*<a href="src/cloudflare/types/radar/entities/asn_ip_params.py">params</a>) -> <a href="./src/cloudflare/types/radar/entities/asn_ip_response.py">ASNIPResponse</a></code>
 - <code title="get /radar/entities/asns/{asn}/rel">client.radar.entities.asns.<a href="./src/cloudflare/resources/radar/entities/asns.py">rel</a>(asn, \*\*<a href="src/cloudflare/types/radar/entities/asn_rel_params.py">params</a>) -> <a href="./src/cloudflare/types/radar/entities/asn_rel_response.py">ASNRelResponse</a></code>

src/cloudflare/resources/radar/entities/asns.py

@@ -19,11 +19,12 @@
 )
 from ...._wrappers import ResultWrapper
 from ...._base_client import make_request_options
-from ....types.radar.entities import asn_ip_params, asn_get_params, asn_rel_params, asn_list_params
+from ....types.radar.entities import asn_ip_params, asn_get_params, asn_rel_params, asn_list_params, asn_as_set_params
 from ....types.radar.entities.asn_ip_response import ASNIPResponse
 from ....types.radar.entities.asn_get_response import ASNGetResponse
 from ....types.radar.entities.asn_rel_response import ASNRelResponse
 from ....types.radar.entities.asn_list_response import ASNListResponse
+from ....types.radar.entities.asn_as_set_response import ASNAsSetResponse
 
 __all__ = ["ASNsResource", "AsyncASNsResource"]
 
@@ -112,6 +113,47 @@ def list(
             cast_to=cast(Type[ASNListResponse], ResultWrapper[ASNListResponse]),
         )
 
+    def as_set(
+        self,
+        asn: int,
+        *,
+        format: Literal["JSON", "CSV"] | 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,
+    ) -> ASNAsSetResponse:
+        """
+        Retrieves Internet Routing Registry AS-SETs that an AS is a member of.
+
+        Args:
+          asn: Retrieves all AS-SETs that the given AS is a member of.
+
+          format: Format in which results will be returned.
+
+          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(
+            f"/radar/entities/asns/{asn}/as_set",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"format": format}, asn_as_set_params.ASNAsSetParams),
+                post_parser=ResultWrapper[ASNAsSetResponse]._unwrapper,
+            ),
+            cast_to=cast(Type[ASNAsSetResponse], ResultWrapper[ASNAsSetResponse]),
+        )
+
     def get(
         self,
         asn: int,
@@ -341,6 +383,47 @@ async def list(
             cast_to=cast(Type[ASNListResponse], ResultWrapper[ASNListResponse]),
         )
 
+    async def as_set(
+        self,
+        asn: int,
+        *,
+        format: Literal["JSON", "CSV"] | 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,
+    ) -> ASNAsSetResponse:
+        """
+        Retrieves Internet Routing Registry AS-SETs that an AS is a member of.
+
+        Args:
+          asn: Retrieves all AS-SETs that the given AS is a member of.
+
+          format: Format in which results will be returned.
+
+          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 await self._get(
+            f"/radar/entities/asns/{asn}/as_set",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform({"format": format}, asn_as_set_params.ASNAsSetParams),
+                post_parser=ResultWrapper[ASNAsSetResponse]._unwrapper,
+            ),
+            cast_to=cast(Type[ASNAsSetResponse], ResultWrapper[ASNAsSetResponse]),
+        )
+
     async def get(
         self,
         asn: int,
@@ -493,6 +576,9 @@ def __init__(self, asns: ASNsResource) -> None:
         self.list = to_raw_response_wrapper(
             asns.list,
         )
+        self.as_set = to_raw_response_wrapper(
+            asns.as_set,
+        )
         self.get = to_raw_response_wrapper(
             asns.get,
         )
@@ -511,6 +597,9 @@ def __init__(self, asns: AsyncASNsResource) -> None:
         self.list = async_to_raw_response_wrapper(
             asns.list,
         )
+        self.as_set = async_to_raw_response_wrapper(
+            asns.as_set,
+        )
         self.get = async_to_raw_response_wrapper(
             asns.get,
         )
@@ -529,6 +618,9 @@ def __init__(self, asns: ASNsResource) -> None:
         self.list = to_streamed_response_wrapper(
             asns.list,
         )
+        self.as_set = to_streamed_response_wrapper(
+            asns.as_set,
+        )
         self.get = to_streamed_response_wrapper(
             asns.get,
         )
@@ -547,6 +639,9 @@ def __init__(self, asns: AsyncASNsResource) -> None:
         self.list = async_to_streamed_response_wrapper(
             asns.list,
         )
+        self.as_set = async_to_streamed_response_wrapper(
+            asns.as_set,
+        )
         self.get = async_to_streamed_response_wrapper(
             asns.get,
         )

src/cloudflare/types/radar/entities/__init__.py

@@ -9,7 +9,9 @@
 from .asn_list_params import ASNListParams as ASNListParams
 from .asn_get_response import ASNGetResponse as ASNGetResponse
 from .asn_rel_response import ASNRelResponse as ASNRelResponse
+from .asn_as_set_params import ASNAsSetParams as ASNAsSetParams
 from .asn_list_response import ASNListResponse as ASNListResponse
+from .asn_as_set_response import ASNAsSetResponse as ASNAsSetResponse
 from .location_get_params import LocationGetParams as LocationGetParams
 from .location_list_params import LocationListParams as LocationListParams
 from .location_get_response import LocationGetResponse as LocationGetResponse

src/cloudflare/types/radar/entities/asn_as_set_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["ASNAsSetParams"]
+
+
+class ASNAsSetParams(TypedDict, total=False):
+    format: Literal["JSON", "CSV"]
+    """Format in which results will be returned."""

src/cloudflare/types/radar/entities/asn_as_set_response.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ...._models import BaseModel
+
+__all__ = ["ASNAsSetResponse", "AsSet"]
+
+
+class AsSet(BaseModel):
+    as_members_count: int
+    """The number of AS members in the AS-SET"""
+
+    as_set_members_count: int
+    """The number of AS-SET members in the AS-SET"""
+
+    as_set_upstreams_count: int
+    """The number of recursive upstream AS-SETs"""
+
+    asn_cone_size: int
+    """The number of unique ASNs in the AS-SETs recursive downstream"""
+
+    irr_sources: List[str]
+    """The IRR sources of the AS-SET"""
+
+    name: str
+    """The name of the AS-SET"""
+
+    asn: Optional[int] = None
+    """The inferred AS number of the AS-SET"""
+
+
+class ASNAsSetResponse(BaseModel):
+    as_sets: List[AsSet]
+
+    paths: List[List[str]]
+    """Paths from the AS-SET that include the given AS to its upstreams recursively"""

tests/api_resources/radar/entities/test_asns.py

@@ -14,6 +14,7 @@
     ASNGetResponse,
     ASNRelResponse,
     ASNListResponse,
+    ASNAsSetResponse,
 )
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
@@ -59,6 +60,45 @@ def test_streaming_response_list(self, client: Cloudflare) -> None:
 
         assert cast(Any, response.is_closed) is True
 
+    @parametrize
+    def test_method_as_set(self, client: Cloudflare) -> None:
+        asn = client.radar.entities.asns.as_set(
+            asn=3,
+        )
+        assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+    @parametrize
+    def test_method_as_set_with_all_params(self, client: Cloudflare) -> None:
+        asn = client.radar.entities.asns.as_set(
+            asn=3,
+            format="JSON",
+        )
+        assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+    @parametrize
+    def test_raw_response_as_set(self, client: Cloudflare) -> None:
+        response = client.radar.entities.asns.with_raw_response.as_set(
+            asn=3,
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        asn = response.parse()
+        assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+    @parametrize
+    def test_streaming_response_as_set(self, client: Cloudflare) -> None:
+        with client.radar.entities.asns.with_streaming_response.as_set(
+            asn=3,
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            asn = response.parse()
+            assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @parametrize
     def test_method_get(self, client: Cloudflare) -> None:
         asn = client.radar.entities.asns.get(
@@ -220,6 +260,45 @@ async def test_streaming_response_list(self, async_client: AsyncCloudflare) -> N
 
         assert cast(Any, response.is_closed) is True
 
+    @parametrize
+    async def test_method_as_set(self, async_client: AsyncCloudflare) -> None:
+        asn = await async_client.radar.entities.asns.as_set(
+            asn=3,
+        )
+        assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+    @parametrize
+    async def test_method_as_set_with_all_params(self, async_client: AsyncCloudflare) -> None:
+        asn = await async_client.radar.entities.asns.as_set(
+            asn=3,
+            format="JSON",
+        )
+        assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+    @parametrize
+    async def test_raw_response_as_set(self, async_client: AsyncCloudflare) -> None:
+        response = await async_client.radar.entities.asns.with_raw_response.as_set(
+            asn=3,
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        asn = await response.parse()
+        assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_as_set(self, async_client: AsyncCloudflare) -> None:
+        async with async_client.radar.entities.asns.with_streaming_response.as_set(
+            asn=3,
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            asn = await response.parse()
+            assert_matches_type(ASNAsSetResponse, asn, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @parametrize
     async def test_method_get(self, async_client: AsyncCloudflare) -> None:
         asn = await async_client.radar.entities.asns.get(