feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 102
+configured_endpoints: 103
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-a8e2289b32b616e0bd7e15995a6553d0335bd21e30617a013d07450f8f5a7a20.yml
 openapi_spec_hash: cd13a7af1ffe64c7ce8753f87786e01f
-config_hash: 457068371129b47b67f0f2d6b8267368
+config_hash: b9de5d96e095a7e749a8c1fc3536c308

api.md

@@ -95,6 +95,7 @@ Methods:
 - <code title="post /v1/devboxes/{id}/create_tunnel">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">create_tunnel</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_create_tunnel_params.py">params</a>) -> <a href="./src/runloop_api_client/types/devbox_tunnel_view.py">DevboxTunnelView</a></code>
 - <code title="post /v1/devboxes/disk_snapshots/{id}/delete">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">delete_disk_snapshot</a>(id) -> object</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">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">execute</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_execute_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_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}/keep_alive">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">keep_alive</a>(id) -> object</code>

src/runloop_api_client/resources/devboxes/devboxes.py

@@ -27,6 +27,7 @@
     devbox_list_params,
     devbox_create_params,
     devbox_update_params,
+    devbox_execute_params,
     devbox_upload_file_params,
     devbox_execute_sync_params,
     devbox_create_tunnel_params,
@@ -719,6 +720,72 @@ def download_file(
             cast_to=BinaryAPIResponse,
         )
 
+    def execute(
+        self,
+        id: str,
+        *,
+        command: str,
+        command_id: str,
+        shell_name: Optional[str] | NotGiven = NOT_GIVEN,
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> DevboxAsyncExecutionDetailView:
+        """
+        Execute a command with a known command ID on a devbox, optimistically waiting
+        for it to complete within the specified timeout. If it completes in time, return
+        the result. If not, return a status indicating the command is still running.
+
+        Args:
+          command: The command to execute via the Devbox shell. By default, commands are run from
+              the user home directory unless shell_name is specified. If shell_name is
+              specified the command is run from the directory based on the recent state of the
+              persistent shell.
+
+          command_id: The command ID for idempotency and tracking
+
+          shell_name: The name of the persistent shell to create or use if already created. When using
+              a persistent shell, the command will run from the directory at the end of the
+              previous command and environment variables will be preserved.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not is_given(timeout) and self._client.timeout == DEFAULT_TIMEOUT:
+            timeout = 600
+        return self._post(
+            f"/v1/devboxes/{id}/execute",
+            body=maybe_transform(
+                {
+                    "command": command,
+                    "command_id": command_id,
+                    "shell_name": shell_name,
+                },
+                devbox_execute_params.DevboxExecuteParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=DevboxAsyncExecutionDetailView,
+        )
+
     def execute_async(
         self,
         id: str,
@@ -1981,6 +2048,72 @@ async def download_file(
             cast_to=AsyncBinaryAPIResponse,
         )
 
+    async def execute(
+        self,
+        id: str,
+        *,
+        command: str,
+        command_id: str,
+        shell_name: Optional[str] | NotGiven = NOT_GIVEN,
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> DevboxAsyncExecutionDetailView:
+        """
+        Execute a command with a known command ID on a devbox, optimistically waiting
+        for it to complete within the specified timeout. If it completes in time, return
+        the result. If not, return a status indicating the command is still running.
+
+        Args:
+          command: The command to execute via the Devbox shell. By default, commands are run from
+              the user home directory unless shell_name is specified. If shell_name is
+              specified the command is run from the directory based on the recent state of the
+              persistent shell.
+
+          command_id: The command ID for idempotency and tracking
+
+          shell_name: The name of the persistent shell to create or use if already created. When using
+              a persistent shell, the command will run from the directory at the end of the
+              previous command and environment variables will be preserved.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not is_given(timeout) and self._client.timeout == DEFAULT_TIMEOUT:
+            timeout = 600
+        return await self._post(
+            f"/v1/devboxes/{id}/execute",
+            body=await async_maybe_transform(
+                {
+                    "command": command,
+                    "command_id": command_id,
+                    "shell_name": shell_name,
+                },
+                devbox_execute_params.DevboxExecuteParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=DevboxAsyncExecutionDetailView,
+        )
+
     async def execute_async(
         self,
         id: str,
@@ -2690,6 +2823,9 @@ def __init__(self, devboxes: DevboxesResource) -> None:
             devboxes.download_file,
             BinaryAPIResponse,
         )
+        self.execute = to_raw_response_wrapper(
+            devboxes.execute,
+        )
         self.execute_async = to_raw_response_wrapper(
             devboxes.execute_async,
         )
@@ -2784,6 +2920,9 @@ def __init__(self, devboxes: AsyncDevboxesResource) -> None:
             devboxes.download_file,
             AsyncBinaryAPIResponse,
         )
+        self.execute = async_to_raw_response_wrapper(
+            devboxes.execute,
+        )
         self.execute_async = async_to_raw_response_wrapper(
             devboxes.execute_async,
         )
@@ -2878,6 +3017,9 @@ def __init__(self, devboxes: DevboxesResource) -> None:
             devboxes.download_file,
             StreamedBinaryAPIResponse,
         )
+        self.execute = to_streamed_response_wrapper(
+            devboxes.execute,
+        )
         self.execute_async = to_streamed_response_wrapper(
             devboxes.execute_async,
         )
@@ -2972,6 +3114,9 @@ def __init__(self, devboxes: AsyncDevboxesResource) -> None:
             devboxes.download_file,
             AsyncStreamedBinaryAPIResponse,
         )
+        self.execute = async_to_streamed_response_wrapper(
+            devboxes.execute,
+        )
         self.execute_async = async_to_streamed_response_wrapper(
             devboxes.execute_async,
         )

src/runloop_api_client/types/__init__.py

@@ -41,6 +41,7 @@
 from .secret_update_params import SecretUpdateParams as SecretUpdateParams
 from .benchmark_list_params import BenchmarkListParams as BenchmarkListParams
 from .blueprint_list_params import BlueprintListParams as BlueprintListParams
+from .devbox_execute_params import DevboxExecuteParams as DevboxExecuteParams
 from .blueprint_preview_view import BlueprintPreviewView as BlueprintPreviewView
 from .object_download_params import ObjectDownloadParams as ObjectDownloadParams
 from .repository_list_params import RepositoryListParams as RepositoryListParams

src/runloop_api_client/types/devbox_execute_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["DevboxExecuteParams"]
+
+
+class DevboxExecuteParams(TypedDict, total=False):
+    command: Required[str]
+    """The command to execute via the Devbox shell.
+
+    By default, commands are run from the user home directory unless shell_name is
+    specified. If shell_name is specified the command is run from the directory
+    based on the recent state of the persistent shell.
+    """
+
+    command_id: Required[str]
+    """The command ID for idempotency and tracking"""
+
+    shell_name: Optional[str]
+    """The name of the persistent shell to create or use if already created.
+
+    When using a persistent shell, the command will run from the directory at the
+    end of the previous command and environment variables will be preserved.
+    """

tests/api_resources/test_devboxes.py

@@ -405,6 +405,62 @@ def test_path_params_download_file(self, client: Runloop) -> None:
                 path="path",
             )
 
+    @parametrize
+    def test_method_execute(self, client: Runloop) -> None:
+        devbox = client.devboxes.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+        )
+        assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+    @parametrize
+    def test_method_execute_with_all_params(self, client: Runloop) -> None:
+        devbox = client.devboxes.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+            shell_name="shell_name",
+        )
+        assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+    @parametrize
+    def test_raw_response_execute(self, client: Runloop) -> None:
+        response = client.devboxes.with_raw_response.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        devbox = response.parse()
+        assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+    @parametrize
+    def test_streaming_response_execute(self, client: Runloop) -> None:
+        with client.devboxes.with_streaming_response.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            devbox = response.parse()
+            assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    def test_path_params_execute(self, client: Runloop) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            client.devboxes.with_raw_response.execute(
+                id="",
+                command="command",
+                command_id="command_id",
+            )
+
     @parametrize
     def test_method_execute_async(self, client: Runloop) -> None:
         devbox = client.devboxes.execute_async(
@@ -1625,6 +1681,62 @@ async def test_path_params_download_file(self, async_client: AsyncRunloop) -> No
                 path="path",
             )
 
+    @parametrize
+    async def test_method_execute(self, async_client: AsyncRunloop) -> None:
+        devbox = await async_client.devboxes.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+        )
+        assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+    @parametrize
+    async def test_method_execute_with_all_params(self, async_client: AsyncRunloop) -> None:
+        devbox = await async_client.devboxes.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+            shell_name="shell_name",
+        )
+        assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+    @parametrize
+    async def test_raw_response_execute(self, async_client: AsyncRunloop) -> None:
+        response = await async_client.devboxes.with_raw_response.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        devbox = await response.parse()
+        assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_execute(self, async_client: AsyncRunloop) -> None:
+        async with async_client.devboxes.with_streaming_response.execute(
+            id="id",
+            command="command",
+            command_id="command_id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            devbox = await response.parse()
+            assert_matches_type(DevboxAsyncExecutionDetailView, devbox, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    async def test_path_params_execute(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.execute(
+                id="",
+                command="command",
+                command_id="command_id",
+            )
+
     @parametrize
     async def test_method_execute_async(self, async_client: AsyncRunloop) -> None:
         devbox = await async_client.devboxes.execute_async(