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

cloudflare · Apr 22, 2024 · 0c0db5b · 0c0db5b
1 parent dff460b
commit 0c0db5b
Show file tree

Hide file tree

Showing 9 changed files with 80 additions and 58 deletions.
diff --git a/api.md b/api.md
@@ -2050,7 +2050,7 @@ from cloudflare.types.logpush.datasets import JobGetResponse
 
 Methods:
 
-- <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/datasets/{dataset_id}/jobs">client.logpush.datasets.jobs.<a href="./src/cloudflare/resources/logpush/datasets/jobs.py">get</a>(dataset_id, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/logpush/datasets/job_get_response.py">Optional</a></code>
+- <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/datasets/{dataset_id}/jobs">client.logpush.datasets.jobs.<a href="./src/cloudflare/resources/logpush/datasets/jobs.py">get</a>(dataset_id, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/logpush/datasets/job_get_response.py">JobGetResponse</a></code>
 
 ## Edge
 
@@ -2063,7 +2063,7 @@ from cloudflare.types.logpush import InstantLogpushJob, EdgeGetResponse
 Methods:
 
 - <code title="post /zones/{zone_id}/logpush/edge">client.logpush.edge.<a href="./src/cloudflare/resources/logpush/edge.py">create</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/logpush/edge_create_params.py">params</a>) -> <a href="./src/cloudflare/types/logpush/instant_logpush_job.py">Optional</a></code>
-- <code title="get /zones/{zone_id}/logpush/edge">client.logpush.edge.<a href="./src/cloudflare/resources/logpush/edge.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/logpush/edge_get_response.py">Optional</a></code>
+- <code title="get /zones/{zone_id}/logpush/edge">client.logpush.edge.<a href="./src/cloudflare/resources/logpush/edge.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/logpush/edge_get_response.py">EdgeGetResponse</a></code>
 
 ## Jobs
 
@@ -2078,7 +2078,7 @@ Methods:
 - <code title="post /{account_or_zone}/{account_or_zone_id}/logpush/jobs">client.logpush.jobs.<a href="./src/cloudflare/resources/logpush/jobs.py">create</a>(\*, account_id, zone_id, \*\*<a href="src/cloudflare/types/logpush/job_create_params.py">params</a>) -> <a href="./src/cloudflare/types/logpush/logpush_job.py">Optional</a></code>
 - <code title="put /{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}">client.logpush.jobs.<a href="./src/cloudflare/resources/logpush/jobs.py">update</a>(job_id, \*, account_id, zone_id, \*\*<a href="src/cloudflare/types/logpush/job_update_params.py">params</a>) -> <a href="./src/cloudflare/types/logpush/logpush_job.py">Optional</a></code>
 - <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/jobs">client.logpush.jobs.<a href="./src/cloudflare/resources/logpush/jobs.py">list</a>(\*, account_id, zone_id) -> <a href="./src/cloudflare/types/logpush/logpush_job.py">SyncSinglePage[Optional]</a></code>
-- <code title="delete /{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}">client.logpush.jobs.<a href="./src/cloudflare/resources/logpush/jobs.py">delete</a>(job_id, \*, account_id, zone_id, \*\*<a href="src/cloudflare/types/logpush/job_delete_params.py">params</a>) -> <a href="./src/cloudflare/types/logpush/job_delete_response.py">object</a></code>
+- <code title="delete /{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}">client.logpush.jobs.<a href="./src/cloudflare/resources/logpush/jobs.py">delete</a>(job_id, \*, account_id, zone_id, \*\*<a href="src/cloudflare/types/logpush/job_delete_params.py">params</a>) -> <a href="./src/cloudflare/types/logpush/job_delete_response.py">Optional</a></code>
 - <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}">client.logpush.jobs.<a href="./src/cloudflare/resources/logpush/jobs.py">get</a>(job_id, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/logpush/logpush_job.py">Optional</a></code>
 
 ## Ownership

diff --git a/src/cloudflare/resources/logpush/datasets/jobs.py b/src/cloudflare/resources/logpush/datasets/jobs.py
@@ -45,7 +45,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Optional[JobGetResponse]:
+    ) -> JobGetResponse:
         """
         Lists Logpush jobs for an account or zone for a dataset.
 
@@ -87,7 +87,7 @@ def get(
                 timeout=timeout,
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Optional[JobGetResponse]], ResultWrapper[JobGetResponse]),
+            cast_to=cast(Type[JobGetResponse], ResultWrapper[JobGetResponse]),
         )
 
 
@@ -112,7 +112,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Optional[JobGetResponse]:
+    ) -> JobGetResponse:
         """
         Lists Logpush jobs for an account or zone for a dataset.
 
@@ -154,7 +154,7 @@ async def get(
                 timeout=timeout,
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Optional[JobGetResponse]], ResultWrapper[JobGetResponse]),
+            cast_to=cast(Type[JobGetResponse], ResultWrapper[JobGetResponse]),
         )
 
 

diff --git a/src/cloudflare/resources/logpush/edge.py b/src/cloudflare/resources/logpush/edge.py
@@ -105,7 +105,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Optional[EdgeGetResponse]:
+    ) -> EdgeGetResponse:
         """
         Lists Instant Logs jobs for a zone.
 
@@ -131,7 +131,7 @@ def get(
                 timeout=timeout,
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Optional[EdgeGetResponse]], ResultWrapper[EdgeGetResponse]),
+            cast_to=cast(Type[EdgeGetResponse], ResultWrapper[EdgeGetResponse]),
         )
 
 
@@ -212,7 +212,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Optional[EdgeGetResponse]:
+    ) -> EdgeGetResponse:
         """
         Lists Instant Logs jobs for a zone.
 
@@ -238,7 +238,7 @@ async def get(
                 timeout=timeout,
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[Optional[EdgeGetResponse]], ResultWrapper[EdgeGetResponse]),
+            cast_to=cast(Type[EdgeGetResponse], ResultWrapper[EdgeGetResponse]),
         )
 
 

diff --git a/src/cloudflare/resources/logpush/jobs.py b/src/cloudflare/resources/logpush/jobs.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Type, Optional, cast
+from typing import Any, Type, Optional, cast
 from typing_extensions import Literal
 
 import httpx
@@ -28,6 +28,7 @@
 )
 from ...types.logpush import (
     LogpushJob,
+    JobDeleteResponse,
     OutputOptionsParam,
     job_create_params,
     job_delete_params,
@@ -301,7 +302,7 @@ def delete(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> object:
+    ) -> Optional[JobDeleteResponse]:
         """
         Deletes a Logpush job.
 
@@ -332,17 +333,22 @@ def delete(
 
             account_or_zone = "zones"
             account_or_zone_id = zone_id
-        return self._delete(
-            f"/{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}",
-            body=maybe_transform(body, job_delete_params.JobDeleteParams),
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                post_parser=ResultWrapper._unwrapper,
+        return cast(
+            Optional[JobDeleteResponse],
+            self._delete(
+                f"/{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}",
+                body=maybe_transform(body, job_delete_params.JobDeleteParams),
+                options=make_request_options(
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                    post_parser=ResultWrapper._unwrapper,
+                ),
+                cast_to=cast(
+                    Any, ResultWrapper[JobDeleteResponse]
+                ),  # Union types cannot be passed in as arguments in the type system
             ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
         )
 
     def get(
@@ -665,7 +671,7 @@ async def delete(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> object:
+    ) -> Optional[JobDeleteResponse]:
         """
         Deletes a Logpush job.
 
@@ -696,17 +702,22 @@ async def delete(
 
             account_or_zone = "zones"
             account_or_zone_id = zone_id
-        return await self._delete(
-            f"/{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}",
-            body=await async_maybe_transform(body, job_delete_params.JobDeleteParams),
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                post_parser=ResultWrapper._unwrapper,
+        return cast(
+            Optional[JobDeleteResponse],
+            await self._delete(
+                f"/{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}",
+                body=await async_maybe_transform(body, job_delete_params.JobDeleteParams),
+                options=make_request_options(
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                    post_parser=ResultWrapper._unwrapper,
+                ),
+                cast_to=cast(
+                    Any, ResultWrapper[JobDeleteResponse]
+                ),  # Union types cannot be passed in as arguments in the type system
             ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
         )
 
     async def get(

diff --git a/src/cloudflare/types/logpush/__init__.py b/src/cloudflare/types/logpush/__init__.py
@@ -10,6 +10,7 @@
 from .job_update_params import JobUpdateParams as JobUpdateParams
 from .edge_create_params import EdgeCreateParams as EdgeCreateParams
 from .instant_logpush_job import InstantLogpushJob as InstantLogpushJob
+from .job_delete_response import JobDeleteResponse as JobDeleteResponse
 from .output_options_param import OutputOptionsParam as OutputOptionsParam
 from .ownership_validation import OwnershipValidation as OwnershipValidation
 from .validate_origin_params import ValidateOriginParams as ValidateOriginParams

diff --git a/src/cloudflare/types/logpush/job_delete_response.py b/src/cloudflare/types/logpush/job_delete_response.py
@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union
+
+__all__ = ["JobDeleteResponse"]
+
+JobDeleteResponse = Union[List[object], str, object, None]
diff --git a/tests/api_resources/logpush/datasets/test_jobs.py b/tests/api_resources/logpush/datasets/test_jobs.py
@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import os
-from typing import Any, Optional, cast
+from typing import Any, cast
 
 import pytest
 
@@ -25,7 +25,7 @@ def test_method_get(self, client: Cloudflare) -> None:
             account_id="string",
             zone_id="string",
         )
-        assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+        assert_matches_type(JobGetResponse, job, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -35,7 +35,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None:
             account_id="string",
             zone_id="string",
         )
-        assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+        assert_matches_type(JobGetResponse, job, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -49,7 +49,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"
         job = response.parse()
-        assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+        assert_matches_type(JobGetResponse, job, 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"
 
             job = response.parse()
-            assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+            assert_matches_type(JobGetResponse, job, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -103,7 +103,7 @@ async def test_method_get(self, async_client: AsyncCloudflare) -> None:
             account_id="string",
             zone_id="string",
         )
-        assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+        assert_matches_type(JobGetResponse, job, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -113,7 +113,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) -
             account_id="string",
             zone_id="string",
         )
-        assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+        assert_matches_type(JobGetResponse, job, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -127,7 +127,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"
         job = await response.parse()
-        assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+        assert_matches_type(JobGetResponse, job, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -141,7 +141,7 @@ async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> No
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             job = await response.parse()
-            assert_matches_type(Optional[JobGetResponse], job, path=["response"])
+            assert_matches_type(JobGetResponse, job, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 

diff --git a/tests/api_resources/logpush/test_edge.py b/tests/api_resources/logpush/test_edge.py
@@ -76,7 +76,7 @@ def test_method_get(self, client: Cloudflare) -> None:
         edge = client.logpush.edge.get(
             zone_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(Optional[EdgeGetResponse], edge, path=["response"])
+        assert_matches_type(EdgeGetResponse, edge, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -88,7 +88,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"
         edge = response.parse()
-        assert_matches_type(Optional[EdgeGetResponse], edge, path=["response"])
+        assert_matches_type(EdgeGetResponse, edge, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -100,7 +100,7 @@ def test_streaming_response_get(self, client: Cloudflare) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             edge = response.parse()
-            assert_matches_type(Optional[EdgeGetResponse], edge, path=["response"])
+            assert_matches_type(EdgeGetResponse, edge, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -175,7 +175,7 @@ async def test_method_get(self, async_client: AsyncCloudflare) -> None:
         edge = await async_client.logpush.edge.get(
             zone_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(Optional[EdgeGetResponse], edge, path=["response"])
+        assert_matches_type(EdgeGetResponse, edge, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -187,7 +187,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"
         edge = await response.parse()
-        assert_matches_type(Optional[EdgeGetResponse], edge, path=["response"])
+        assert_matches_type(EdgeGetResponse, edge, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -199,7 +199,7 @@ async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> No
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             edge = await response.parse()
-            assert_matches_type(Optional[EdgeGetResponse], edge, path=["response"])
+            assert_matches_type(EdgeGetResponse, edge, path=["response"])
 
         assert cast(Any, response.is_closed) is True