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

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 26
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-fbdcac787258c36334017389efd318753b4e2eae259dc2ffc0cba579b24a1254.yml
+configured_endpoints: 27
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-d934c31884a197ffe8f114a062e2da781a4ea6e3df45b691d1f4dba30734a61b.yml

api.md

@@ -65,6 +65,7 @@ Methods:
 - <code title="get /v1/devboxes/{id}">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">retrieve</a>(id) -> <a href="./src/runloop_api_client/types/devbox_view.py">DevboxView</a></code>
 - <code title="get /v1/devboxes">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">list</a>(\*\*<a href="src/runloop_api_client/types/devbox_list_params.py">params</a>) -> <a href="./src/runloop_api_client/types/devbox_list_view.py">DevboxListView</a></code>
 - <code title="post /v1/devboxes/{id}/create_ssh_key">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">create_ssh_key</a>(id) -> <a href="./src/runloop_api_client/types/devbox_create_ssh_key_response.py">DevboxCreateSSHKeyResponse</a></code>
+- <code title="post /v1/devboxes/{id}/download_file">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">download_file</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_download_file_params.py">params</a>) -> BinaryAPIResponse</code>
 - <code title="post /v1/devboxes/{id}/execute_async">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">execute_async</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_execute_async_params.py">params</a>) -> <a href="./src/runloop_api_client/types/devbox_async_execution_detail_view.py">DevboxAsyncExecutionDetailView</a></code>
 - <code title="post /v1/devboxes/{id}/execute_sync">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">execute_sync</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_execute_sync_params.py">params</a>) -> <a href="./src/runloop_api_client/types/devbox_execution_detail_view.py">DevboxExecutionDetailView</a></code>
 - <code title="post /v1/devboxes/{id}/read_file_contents">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">read_file_contents</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_read_file_contents_params.py">params</a>) -> str</code>

src/runloop_api_client/resources/devboxes/devboxes.py

@@ -20,6 +20,7 @@
     devbox_write_file_params,
     devbox_upload_file_params,
     devbox_execute_sync_params,
+    devbox_download_file_params,
     devbox_execute_async_params,
     devbox_read_file_contents_params,
 )
@@ -41,10 +42,18 @@
 )
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import (
+    BinaryAPIResponse,
+    AsyncBinaryAPIResponse,
+    StreamedBinaryAPIResponse,
+    AsyncStreamedBinaryAPIResponse,
     to_raw_response_wrapper,
     to_streamed_response_wrapper,
     async_to_raw_response_wrapper,
+    to_custom_raw_response_wrapper,
     async_to_streamed_response_wrapper,
+    to_custom_streamed_response_wrapper,
+    async_to_custom_raw_response_wrapper,
+    async_to_custom_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
 from ...types.devbox_view import DevboxView
@@ -291,6 +300,44 @@ def create_ssh_key(
             cast_to=DevboxCreateSSHKeyResponse,
         )
 
+    def download_file(
+        self,
+        id: str,
+        *,
+        path: str,
+        # 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,
+    ) -> BinaryAPIResponse:
+        """
+        Download file contents to a file at path on the Devbox.
+
+        Args:
+          path: The path on the devbox to read the file
+
+          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
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "application/octet-stream", **(extra_headers or {})}
+        return self._post(
+            f"/v1/devboxes/{id}/download_file",
+            body=maybe_transform({"path": path}, devbox_download_file_params.DevboxDownloadFileParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=BinaryAPIResponse,
+        )
+
     def execute_async(
         self,
         id: str,
@@ -786,6 +833,44 @@ async def create_ssh_key(
             cast_to=DevboxCreateSSHKeyResponse,
         )
 
+    async def download_file(
+        self,
+        id: str,
+        *,
+        path: str,
+        # 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,
+    ) -> AsyncBinaryAPIResponse:
+        """
+        Download file contents to a file at path on the Devbox.
+
+        Args:
+          path: The path on the devbox to read the file
+
+          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
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "application/octet-stream", **(extra_headers or {})}
+        return await self._post(
+            f"/v1/devboxes/{id}/download_file",
+            body=await async_maybe_transform({"path": path}, devbox_download_file_params.DevboxDownloadFileParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=AsyncBinaryAPIResponse,
+        )
+
     async def execute_async(
         self,
         id: str,
@@ -1063,6 +1148,10 @@ def __init__(self, devboxes: DevboxesResource) -> None:
         self.create_ssh_key = to_raw_response_wrapper(
             devboxes.create_ssh_key,
         )
+        self.download_file = to_custom_raw_response_wrapper(
+            devboxes.download_file,
+            BinaryAPIResponse,
+        )
         self.execute_async = to_raw_response_wrapper(
             devboxes.execute_async,
         )
@@ -1107,6 +1196,10 @@ def __init__(self, devboxes: AsyncDevboxesResource) -> None:
         self.create_ssh_key = async_to_raw_response_wrapper(
             devboxes.create_ssh_key,
         )
+        self.download_file = async_to_custom_raw_response_wrapper(
+            devboxes.download_file,
+            AsyncBinaryAPIResponse,
+        )
         self.execute_async = async_to_raw_response_wrapper(
             devboxes.execute_async,
         )
@@ -1151,6 +1244,10 @@ def __init__(self, devboxes: DevboxesResource) -> None:
         self.create_ssh_key = to_streamed_response_wrapper(
             devboxes.create_ssh_key,
         )
+        self.download_file = to_custom_streamed_response_wrapper(
+            devboxes.download_file,
+            StreamedBinaryAPIResponse,
+        )
         self.execute_async = to_streamed_response_wrapper(
             devboxes.execute_async,
         )
@@ -1195,6 +1292,10 @@ def __init__(self, devboxes: AsyncDevboxesResource) -> None:
         self.create_ssh_key = async_to_streamed_response_wrapper(
             devboxes.create_ssh_key,
         )
+        self.download_file = async_to_custom_streamed_response_wrapper(
+            devboxes.download_file,
+            AsyncStreamedBinaryAPIResponse,
+        )
         self.execute_async = async_to_streamed_response_wrapper(
             devboxes.execute_async,
         )

src/runloop_api_client/types/__init__.py

@@ -26,6 +26,7 @@
 from .blueprint_build_parameters import BlueprintBuildParameters as BlueprintBuildParameters
 from .devbox_execute_sync_params import DevboxExecuteSyncParams as DevboxExecuteSyncParams
 from .code_mount_parameters_param import CodeMountParametersParam as CodeMountParametersParam
+from .devbox_download_file_params import DevboxDownloadFileParams as DevboxDownloadFileParams
 from .devbox_execute_async_params import DevboxExecuteAsyncParams as DevboxExecuteAsyncParams
 from .function_invoke_sync_params import FunctionInvokeSyncParams as FunctionInvokeSyncParams
 from .devbox_execution_detail_view import DevboxExecutionDetailView as DevboxExecutionDetailView

src/runloop_api_client/types/devbox_download_file_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 Required, TypedDict
+
+__all__ = ["DevboxDownloadFileParams"]
+
+
+class DevboxDownloadFileParams(TypedDict, total=False):
+    path: Required[str]
+    """The path on the devbox to read the file"""

tests/api_resources/test_devboxes.py

@@ -5,7 +5,9 @@
 import os
 from typing import Any, cast
 
+import httpx
 import pytest
+from respx import MockRouter
 
 from tests.utils import assert_matches_type
 from runloop_api_client import Runloop, AsyncRunloop
@@ -16,6 +18,12 @@
     DevboxCreateSSHKeyResponse,
     DevboxAsyncExecutionDetailView,
 )
+from runloop_api_client._response import (
+    BinaryAPIResponse,
+    AsyncBinaryAPIResponse,
+    StreamedBinaryAPIResponse,
+    AsyncStreamedBinaryAPIResponse,
+)
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -198,6 +206,60 @@ def test_path_params_create_ssh_key(self, client: Runloop) -> None:
                 "",
             )
 
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    def test_method_download_file(self, client: Runloop, respx_mock: MockRouter) -> None:
+        respx_mock.post("/v1/devboxes/id/download_file").mock(return_value=httpx.Response(200, json={"foo": "bar"}))
+        devbox = client.devboxes.download_file(
+            id="id",
+            path="path",
+        )
+        assert devbox.is_closed
+        assert devbox.json() == {"foo": "bar"}
+        assert cast(Any, devbox.is_closed) is True
+        assert isinstance(devbox, BinaryAPIResponse)
+
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    def test_raw_response_download_file(self, client: Runloop, respx_mock: MockRouter) -> None:
+        respx_mock.post("/v1/devboxes/id/download_file").mock(return_value=httpx.Response(200, json={"foo": "bar"}))
+
+        devbox = client.devboxes.with_raw_response.download_file(
+            id="id",
+            path="path",
+        )
+
+        assert devbox.is_closed is True
+        assert devbox.http_request.headers.get("X-Stainless-Lang") == "python"
+        assert devbox.json() == {"foo": "bar"}
+        assert isinstance(devbox, BinaryAPIResponse)
+
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    def test_streaming_response_download_file(self, client: Runloop, respx_mock: MockRouter) -> None:
+        respx_mock.post("/v1/devboxes/id/download_file").mock(return_value=httpx.Response(200, json={"foo": "bar"}))
+        with client.devboxes.with_streaming_response.download_file(
+            id="id",
+            path="path",
+        ) as devbox:
+            assert not devbox.is_closed
+            assert devbox.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            assert devbox.json() == {"foo": "bar"}
+            assert cast(Any, devbox.is_closed) is True
+            assert isinstance(devbox, StreamedBinaryAPIResponse)
+
+        assert cast(Any, devbox.is_closed) is True
+
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    def test_path_params_download_file(self, client: Runloop) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            client.devboxes.with_raw_response.download_file(
+                id="",
+                path="path",
+            )
+
     @parametrize
     def test_method_execute_async(self, client: Runloop) -> None:
         devbox = client.devboxes.execute_async(
@@ -652,6 +714,60 @@ async def test_path_params_create_ssh_key(self, async_client: AsyncRunloop) -> N
                 "",
             )
 
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    async def test_method_download_file(self, async_client: AsyncRunloop, respx_mock: MockRouter) -> None:
+        respx_mock.post("/v1/devboxes/id/download_file").mock(return_value=httpx.Response(200, json={"foo": "bar"}))
+        devbox = await async_client.devboxes.download_file(
+            id="id",
+            path="path",
+        )
+        assert devbox.is_closed
+        assert await devbox.json() == {"foo": "bar"}
+        assert cast(Any, devbox.is_closed) is True
+        assert isinstance(devbox, AsyncBinaryAPIResponse)
+
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    async def test_raw_response_download_file(self, async_client: AsyncRunloop, respx_mock: MockRouter) -> None:
+        respx_mock.post("/v1/devboxes/id/download_file").mock(return_value=httpx.Response(200, json={"foo": "bar"}))
+
+        devbox = await async_client.devboxes.with_raw_response.download_file(
+            id="id",
+            path="path",
+        )
+
+        assert devbox.is_closed is True
+        assert devbox.http_request.headers.get("X-Stainless-Lang") == "python"
+        assert await devbox.json() == {"foo": "bar"}
+        assert isinstance(devbox, AsyncBinaryAPIResponse)
+
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    async def test_streaming_response_download_file(self, async_client: AsyncRunloop, respx_mock: MockRouter) -> None:
+        respx_mock.post("/v1/devboxes/id/download_file").mock(return_value=httpx.Response(200, json={"foo": "bar"}))
+        async with async_client.devboxes.with_streaming_response.download_file(
+            id="id",
+            path="path",
+        ) as devbox:
+            assert not devbox.is_closed
+            assert devbox.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            assert await devbox.json() == {"foo": "bar"}
+            assert cast(Any, devbox.is_closed) is True
+            assert isinstance(devbox, AsyncStreamedBinaryAPIResponse)
+
+        assert cast(Any, devbox.is_closed) is True
+
+    @parametrize
+    @pytest.mark.respx(base_url=base_url)
+    async def test_path_params_download_file(self, async_client: AsyncRunloop) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            await async_client.devboxes.with_raw_response.download_file(
+                id="",
+                path="path",
+            )
+
     @parametrize
     async def test_method_execute_async(self, async_client: AsyncRunloop) -> None:
         devbox = await async_client.devboxes.execute_async(