feat(api): OpenAPI spec update via Stainless API (#318)

api.md

@@ -1647,7 +1647,7 @@ from cloudflare.types.dns.analytics import Report
 
 Methods:
 
-- <code title="get /zones/{zone_id}/dns_analytics/report">client.dns.analytics.reports.<a href="./src/cloudflare/resources/dns/analytics/reports/reports.py">get</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/analytics/report_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/report.py">Report</a></code>
+- <code title="get /zones/{zone_id}/dns_analytics/report">client.dns.analytics.reports.<a href="./src/cloudflare/resources/dns/analytics/reports/reports.py">get</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/analytics/report_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/report.py">Optional</a></code>
 
 #### Bytimes
 
@@ -1659,7 +1659,7 @@ from cloudflare.types.dns.analytics.reports import ByTime
 
 Methods:
 
-- <code title="get /zones/{zone_id}/dns_analytics/report/bytime">client.dns.analytics.reports.bytimes.<a href="./src/cloudflare/resources/dns/analytics/reports/bytimes.py">get</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/analytics/reports/bytime_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/reports/by_time.py">ByTime</a></code>
+- <code title="get /zones/{zone_id}/dns_analytics/report/bytime">client.dns.analytics.reports.bytimes.<a href="./src/cloudflare/resources/dns/analytics/reports/bytimes.py">get</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/analytics/reports/bytime_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/reports/by_time.py">Optional</a></code>
 
 ## FirewallResource
 
@@ -1689,13 +1689,13 @@ Methods:
 
 Methods:
 
-- <code title="get /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report">client.dns.firewall.analytics.reports.<a href="./src/cloudflare/resources/dns/firewall/analytics/reports/reports.py">get</a>(dns_firewall_id, \*, account_id, \*\*<a href="src/cloudflare/types/dns/firewall/analytics/report_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/report.py">Report</a></code>
+- <code title="get /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report">client.dns.firewall.analytics.reports.<a href="./src/cloudflare/resources/dns/firewall/analytics/reports/reports.py">get</a>(dns_firewall_id, \*, account_id, \*\*<a href="src/cloudflare/types/dns/firewall/analytics/report_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/report.py">Optional</a></code>
 
 ##### Bytimes
 
 Methods:
 
-- <code title="get /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime">client.dns.firewall.analytics.reports.bytimes.<a href="./src/cloudflare/resources/dns/firewall/analytics/reports/bytimes.py">get</a>(dns_firewall_id, \*, account_id, \*\*<a href="src/cloudflare/types/dns/firewall/analytics/reports/bytime_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/reports/by_time.py">ByTime</a></code>
+- <code title="get /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime">client.dns.firewall.analytics.reports.bytimes.<a href="./src/cloudflare/resources/dns/firewall/analytics/reports/bytimes.py">get</a>(dns_firewall_id, \*, account_id, \*\*<a href="src/cloudflare/types/dns/firewall/analytics/reports/bytime_get_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/analytics/reports/by_time.py">Optional</a></code>
 
 # DNSSECResource
 

src/cloudflare/resources/dns/analytics/reports/bytimes.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Type, Union, cast
+from typing import Type, Union, Optional, cast
 from datetime import datetime
 from typing_extensions import Literal
 
@@ -58,7 +58,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ByTime:
+    ) -> Optional[ByTime]:
         """
         Retrieves a list of aggregate metrics grouped by time interval.
 
@@ -118,7 +118,7 @@ def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[ByTime], ResultWrapper[ByTime]),
+            cast_to=cast(Type[Optional[ByTime]], ResultWrapper[ByTime]),
         )
 
 
@@ -150,7 +150,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ByTime:
+    ) -> Optional[ByTime]:
         """
         Retrieves a list of aggregate metrics grouped by time interval.
 
@@ -210,7 +210,7 @@ async def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[ByTime], ResultWrapper[ByTime]),
+            cast_to=cast(Type[Optional[ByTime]], ResultWrapper[ByTime]),
         )
 
 

src/cloudflare/resources/dns/analytics/reports/reports.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Type, Union, cast
+from typing import Type, Union, Optional, cast
 from datetime import datetime
 
 import httpx
@@ -67,7 +67,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Report:
+    ) -> Optional[Report]:
         """
         Retrieves a list of summarised aggregate metrics over a given time period.
 
@@ -124,7 +124,7 @@ def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Report], ResultWrapper[Report]),
+            cast_to=cast(Type[Optional[Report]], ResultWrapper[Report]),
         )
 
 
@@ -158,7 +158,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Report:
+    ) -> Optional[Report]:
         """
         Retrieves a list of summarised aggregate metrics over a given time period.
 
@@ -215,7 +215,7 @@ async def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Report], ResultWrapper[Report]),
+            cast_to=cast(Type[Optional[Report]], ResultWrapper[Report]),
         )
 
 

src/cloudflare/resources/dns/firewall/analytics/reports/bytimes.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Type, Union, cast
+from typing import Type, Union, Optional, cast
 from datetime import datetime
 from typing_extensions import Literal
 
@@ -60,7 +60,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ByTime:
+    ) -> Optional[ByTime]:
         """
         Retrieves a list of aggregate metrics grouped by time interval.
 
@@ -124,7 +124,7 @@ def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[ByTime], ResultWrapper[ByTime]),
+            cast_to=cast(Type[Optional[ByTime]], ResultWrapper[ByTime]),
         )
 
 
@@ -157,7 +157,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ByTime:
+    ) -> Optional[ByTime]:
         """
         Retrieves a list of aggregate metrics grouped by time interval.
 
@@ -221,7 +221,7 @@ async def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[ByTime], ResultWrapper[ByTime]),
+            cast_to=cast(Type[Optional[ByTime]], ResultWrapper[ByTime]),
         )
 
 

src/cloudflare/resources/dns/firewall/analytics/reports/reports.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Type, Union, cast
+from typing import Type, Union, Optional, cast
 from datetime import datetime
 
 import httpx
@@ -69,7 +69,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Report:
+    ) -> Optional[Report]:
         """
         Retrieves a list of summarised aggregate metrics over a given time period.
 
@@ -130,7 +130,7 @@ def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Report], ResultWrapper[Report]),
+            cast_to=cast(Type[Optional[Report]], ResultWrapper[Report]),
         )
 
 
@@ -165,7 +165,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Report:
+    ) -> Optional[Report]:
         """
         Retrieves a list of summarised aggregate metrics over a given time period.
 
@@ -226,7 +226,7 @@ async def get(
                 ),
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Report], ResultWrapper[Report]),
+            cast_to=cast(Type[Optional[Report]], ResultWrapper[Report]),
         )
 
 

tests/api_resources/dns/analytics/reports/test_bytimes.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import os
-from typing import Any, cast
+from typing import Any, Optional, cast
 
 import pytest
 
@@ -24,7 +24,7 @@ def test_method_get(self, client: Cloudflare) -> None:
         bytime = client.dns.analytics.reports.bytimes.get(
             zone_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(ByTime, bytime, path=["response"])
+        assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -40,7 +40,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None:
             time_delta="hour",
             until=parse_datetime("2023-11-11T13:00:00Z"),
         )
-        assert_matches_type(ByTime, bytime, path=["response"])
+        assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -52,7 +52,7 @@ def test_raw_response_get(self, client: Cloudflare) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         bytime = response.parse()
-        assert_matches_type(ByTime, bytime, path=["response"])
+        assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -64,7 +64,7 @@ def test_streaming_response_get(self, client: Cloudflare) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             bytime = response.parse()
-            assert_matches_type(ByTime, bytime, path=["response"])
+            assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -86,7 +86,7 @@ async def test_method_get(self, async_client: AsyncCloudflare) -> None:
         bytime = await async_client.dns.analytics.reports.bytimes.get(
             zone_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(ByTime, bytime, path=["response"])
+        assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -102,7 +102,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) -
             time_delta="hour",
             until=parse_datetime("2023-11-11T13:00:00Z"),
         )
-        assert_matches_type(ByTime, bytime, path=["response"])
+        assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -114,7 +114,7 @@ async def test_raw_response_get(self, async_client: AsyncCloudflare) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         bytime = await response.parse()
-        assert_matches_type(ByTime, bytime, path=["response"])
+        assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -126,7 +126,7 @@ async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> No
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             bytime = await response.parse()
-            assert_matches_type(ByTime, bytime, path=["response"])
+            assert_matches_type(Optional[ByTime], bytime, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 

tests/api_resources/dns/analytics/test_reports.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import os
-from typing import Any, cast
+from typing import Any, Optional, cast
 
 import pytest
 
@@ -24,7 +24,7 @@ def test_method_get(self, client: Cloudflare) -> None:
         report = client.dns.analytics.reports.get(
             zone_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(Report, report, path=["response"])
+        assert_matches_type(Optional[Report], report, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -39,7 +39,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None:
             sort="+responseCode,-queryName",
             until=parse_datetime("2023-11-11T13:00:00Z"),
         )
-        assert_matches_type(Report, report, path=["response"])
+        assert_matches_type(Optional[Report], report, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -51,7 +51,7 @@ def test_raw_response_get(self, client: Cloudflare) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         report = response.parse()
-        assert_matches_type(Report, report, path=["response"])
+        assert_matches_type(Optional[Report], report, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -63,7 +63,7 @@ def test_streaming_response_get(self, client: Cloudflare) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             report = response.parse()
-            assert_matches_type(Report, report, path=["response"])
+            assert_matches_type(Optional[Report], report, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -85,7 +85,7 @@ async def test_method_get(self, async_client: AsyncCloudflare) -> None:
         report = await async_client.dns.analytics.reports.get(
             zone_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(Report, report, path=["response"])
+        assert_matches_type(Optional[Report], report, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) -
             sort="+responseCode,-queryName",
             until=parse_datetime("2023-11-11T13:00:00Z"),
         )
-        assert_matches_type(Report, report, path=["response"])
+        assert_matches_type(Optional[Report], report, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -112,7 +112,7 @@ async def test_raw_response_get(self, async_client: AsyncCloudflare) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         report = await response.parse()
-        assert_matches_type(Report, report, path=["response"])
+        assert_matches_type(Optional[Report], report, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -124,7 +124,7 @@ async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> No
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             report = await response.parse()
-            assert_matches_type(Report, report, path=["response"])
+            assert_matches_type(Optional[Report], report, path=["response"])
 
         assert cast(Any, response.is_closed) is True