chore(api): update composite API spec

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 1993
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-b314e3a8f9f9c5701dfa55900eec3f80791f857921d1797f4d92056e110ea308.yml
-openapi_spec_hash: c15140fa93745b8b94b60ae1744098ae
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-3d0ffec9bed17f5a8c3518b79ad378cb759151b98cd5fb735a3c7d5a0e973628.yml
+openapi_spec_hash: 68032dd7cb7939a8787a2c6404619507
 config_hash: 316e765ff117ffcf8ecf5a3187c184b1

api.md

@@ -4877,14 +4877,18 @@ Methods:
 Types:
 
 ```python
-from cloudflare.types.stream import DownloadDeleteResponse
+from cloudflare.types.stream import (
+    DownloadCreateResponse,
+    DownloadDeleteResponse,
+    DownloadGetResponse,
+)
 ```
 
 Methods:
 
-- <code title="post /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/cloudflare/resources/stream/downloads.py">create</a>(identifier, \*, account_id, \*\*<a href="src/cloudflare/types/stream/download_create_params.py">params</a>) -> object</code>
+- <code title="post /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/cloudflare/resources/stream/downloads.py">create</a>(identifier, \*, account_id, \*\*<a href="src/cloudflare/types/stream/download_create_params.py">params</a>) -> <a href="./src/cloudflare/types/stream/download_create_response.py">Optional[DownloadCreateResponse]</a></code>
 - <code title="delete /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/cloudflare/resources/stream/downloads.py">delete</a>(identifier, \*, account_id) -> <a href="./src/cloudflare/types/stream/download_delete_response.py">str</a></code>
-- <code title="get /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/cloudflare/resources/stream/downloads.py">get</a>(identifier, \*, account_id) -> object</code>
+- <code title="get /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/cloudflare/resources/stream/downloads.py">get</a>(identifier, \*, account_id) -> <a href="./src/cloudflare/types/stream/download_get_response.py">Optional[DownloadGetResponse]</a></code>
 
 ## Embed
 

src/cloudflare/resources/stream/downloads.py

@@ -19,6 +19,8 @@
 from ..._wrappers import ResultWrapper
 from ..._base_client import make_request_options
 from ...types.stream import download_create_params
+from ...types.stream.download_get_response import DownloadGetResponse
+from ...types.stream.download_create_response import DownloadCreateResponse
 from ...types.stream.download_delete_response import DownloadDeleteResponse
 
 __all__ = ["DownloadsResource", "AsyncDownloadsResource"]
@@ -56,7 +58,7 @@ def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> Optional[DownloadCreateResponse]:
         """Creates a download for a video when a video is ready to view.
 
         Use
@@ -88,9 +90,9 @@ def create(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                post_parser=ResultWrapper[Optional[object]]._unwrapper,
+                post_parser=ResultWrapper[Optional[DownloadCreateResponse]]._unwrapper,
             ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
+            cast_to=cast(Type[Optional[DownloadCreateResponse]], ResultWrapper[DownloadCreateResponse]),
         )
 
     def delete(
@@ -150,7 +152,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> Optional[DownloadGetResponse]:
         """
         Lists the downloads created for a video.
 
@@ -178,9 +180,9 @@ def get(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                post_parser=ResultWrapper[Optional[object]]._unwrapper,
+                post_parser=ResultWrapper[Optional[DownloadGetResponse]]._unwrapper,
             ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
+            cast_to=cast(Type[Optional[DownloadGetResponse]], ResultWrapper[DownloadGetResponse]),
         )
 
 
@@ -216,7 +218,7 @@ async def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> Optional[DownloadCreateResponse]:
         """Creates a download for a video when a video is ready to view.
 
         Use
@@ -248,9 +250,9 @@ async def create(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                post_parser=ResultWrapper[Optional[object]]._unwrapper,
+                post_parser=ResultWrapper[Optional[DownloadCreateResponse]]._unwrapper,
             ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
+            cast_to=cast(Type[Optional[DownloadCreateResponse]], ResultWrapper[DownloadCreateResponse]),
         )
 
     async def delete(
@@ -310,7 +312,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> Optional[DownloadGetResponse]:
         """
         Lists the downloads created for a video.
 
@@ -338,9 +340,9 @@ async def get(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                post_parser=ResultWrapper[Optional[object]]._unwrapper,
+                post_parser=ResultWrapper[Optional[DownloadGetResponse]]._unwrapper,
             ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
+            cast_to=cast(Type[Optional[DownloadGetResponse]], ResultWrapper[DownloadGetResponse]),
         )
 
 

src/cloudflare/types/stream/__init__.py

@@ -20,6 +20,7 @@
 from .key_delete_response import KeyDeleteResponse as KeyDeleteResponse
 from .token_create_params import TokenCreateParams as TokenCreateParams
 from .stream_create_params import StreamCreateParams as StreamCreateParams
+from .download_get_response import DownloadGetResponse as DownloadGetResponse
 from .token_create_response import TokenCreateResponse as TokenCreateResponse
 from .webhook_update_params import WebhookUpdateParams as WebhookUpdateParams
 from .download_create_params import DownloadCreateParams as DownloadCreateParams
@@ -28,6 +29,7 @@
 from .audio_track_edit_params import AudioTrackEditParams as AudioTrackEditParams
 from .watermark_create_params import WatermarkCreateParams as WatermarkCreateParams
 from .webhook_delete_response import WebhookDeleteResponse as WebhookDeleteResponse
+from .download_create_response import DownloadCreateResponse as DownloadCreateResponse
 from .download_delete_response import DownloadDeleteResponse as DownloadDeleteResponse
 from .live_input_create_params import LiveInputCreateParams as LiveInputCreateParams
 from .live_input_list_response import LiveInputListResponse as LiveInputListResponse

src/cloudflare/types/stream/download_create_response.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["DownloadCreateResponse"]
+
+
+class DownloadCreateResponse(BaseModel):
+    percent_complete: Optional[float] = FieldInfo(alias="percentComplete", default=None)
+    """Indicates the progress as a percentage between 0 and 100."""
+
+    status: Optional[Literal["ready", "inprogress", "error"]] = None
+    """The status of a generated download."""
+
+    url: Optional[str] = None
+    """The URL to access the generated download."""

src/cloudflare/types/stream/download_get_response.py

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["DownloadGetResponse", "Audio", "Default"]
+
+
+class Audio(BaseModel):
+    """The audio-only download. Only present if this download type has been created."""
+
+    percent_complete: Optional[float] = FieldInfo(alias="percentComplete", default=None)
+    """Indicates the progress as a percentage between 0 and 100."""
+
+    status: Optional[Literal["ready", "inprogress", "error"]] = None
+    """The status of a generated download."""
+
+    url: Optional[str] = None
+    """The URL to access the generated download."""
+
+
+class Default(BaseModel):
+    """The default video download.
+
+    Only present if this download type has been created.
+    """
+
+    percent_complete: Optional[float] = FieldInfo(alias="percentComplete", default=None)
+    """Indicates the progress as a percentage between 0 and 100."""
+
+    status: Optional[Literal["ready", "inprogress", "error"]] = None
+    """The status of a generated download."""
+
+    url: Optional[str] = None
+    """The URL to access the generated download."""
+
+
+class DownloadGetResponse(BaseModel):
+    """An object with download type keys.
+
+    Each key is optional and only present if that download type has been created.
+    """
+
+    audio: Optional[Audio] = None
+    """The audio-only download. Only present if this download type has been created."""
+
+    default: Optional[Default] = None
+    """The default video download.
+
+    Only present if this download type has been created.
+    """

src/cloudflare/types/stream/video.py

@@ -57,10 +57,7 @@ class Status(BaseModel):
     """
 
     pct_complete: Optional[str] = FieldInfo(alias="pctComplete", default=None)
-    """Indicates the size of the entire upload in bytes.
-
-    The value must be a non-negative integer.
-    """
+    """Indicates the progress as a percentage between 0 and 100."""
 
     state: Optional[
         Literal["pendingupload", "downloading", "queued", "inprogress", "ready", "error", "live-inprogress"]

tests/api_resources/stream/test_downloads.py

@@ -3,12 +3,16 @@
 from __future__ import annotations
 
 import os
-from typing import Any, cast
+from typing import Any, Optional, cast
 
 import pytest
 
 from cloudflare import Cloudflare, AsyncCloudflare
 from tests.utils import assert_matches_type
+from cloudflare.types.stream import (
+    DownloadGetResponse,
+    DownloadCreateResponse,
+)
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -23,7 +27,7 @@ def test_method_create(self, client: Cloudflare) -> None:
             account_id="023e105f4ecef8ad9ca31a8372d0c353",
             body={},
         )
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadCreateResponse], download, path=["response"])
 
     @parametrize
     def test_raw_response_create(self, client: Cloudflare) -> None:
@@ -36,7 +40,7 @@ def test_raw_response_create(self, client: Cloudflare) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         download = response.parse()
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadCreateResponse], download, path=["response"])
 
     @parametrize
     def test_streaming_response_create(self, client: Cloudflare) -> None:
@@ -49,7 +53,7 @@ def test_streaming_response_create(self, client: Cloudflare) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             download = response.parse()
-            assert_matches_type(object, download, path=["response"])
+            assert_matches_type(Optional[DownloadCreateResponse], download, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -123,7 +127,7 @@ def test_method_get(self, client: Cloudflare) -> None:
             identifier="ea95132c15732412d22c1476fa83f27a",
             account_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadGetResponse], download, path=["response"])
 
     @parametrize
     def test_raw_response_get(self, client: Cloudflare) -> None:
@@ -135,7 +139,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"
         download = response.parse()
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadGetResponse], download, path=["response"])
 
     @parametrize
     def test_streaming_response_get(self, client: Cloudflare) -> None:
@@ -147,7 +151,7 @@ def test_streaming_response_get(self, client: Cloudflare) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             download = response.parse()
-            assert_matches_type(object, download, path=["response"])
+            assert_matches_type(Optional[DownloadGetResponse], download, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -178,7 +182,7 @@ async def test_method_create(self, async_client: AsyncCloudflare) -> None:
             account_id="023e105f4ecef8ad9ca31a8372d0c353",
             body={},
         )
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadCreateResponse], download, path=["response"])
 
     @parametrize
     async def test_raw_response_create(self, async_client: AsyncCloudflare) -> None:
@@ -191,7 +195,7 @@ async def test_raw_response_create(self, async_client: AsyncCloudflare) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         download = await response.parse()
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadCreateResponse], download, path=["response"])
 
     @parametrize
     async def test_streaming_response_create(self, async_client: AsyncCloudflare) -> None:
@@ -204,7 +208,7 @@ async def test_streaming_response_create(self, async_client: AsyncCloudflare) ->
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             download = await response.parse()
-            assert_matches_type(object, download, path=["response"])
+            assert_matches_type(Optional[DownloadCreateResponse], download, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -278,7 +282,7 @@ async def test_method_get(self, async_client: AsyncCloudflare) -> None:
             identifier="ea95132c15732412d22c1476fa83f27a",
             account_id="023e105f4ecef8ad9ca31a8372d0c353",
         )
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadGetResponse], download, path=["response"])
 
     @parametrize
     async def test_raw_response_get(self, async_client: AsyncCloudflare) -> None:
@@ -290,7 +294,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"
         download = await response.parse()
-        assert_matches_type(object, download, path=["response"])
+        assert_matches_type(Optional[DownloadGetResponse], download, path=["response"])
 
     @parametrize
     async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> None:
@@ -302,7 +306,7 @@ async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> No
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             download = await response.parse()
-            assert_matches_type(object, download, path=["response"])
+            assert_matches_type(Optional[DownloadGetResponse], download, path=["response"])
 
         assert cast(Any, response.is_closed) is True