feat(mux): wait_for_eviction endpoint for flex eviction notifications (#10325)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 119
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai/runloop-d0efdaa19d8a5685def3947450df7f9bdaf9bad3243317d514add5d22129fc5f.yml
-openapi_spec_hash: 7e484ea9f60294503bf4691fe3efef3a
-config_hash: 218b8d25038e627faab98532392ee9a0
+configured_endpoints: 120
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai/runloop-f18b1bba718700c841b3904207cd8ba2c066421a691845d6283bbbb361cf161d.yml
+openapi_spec_hash: 6044f4a4da13881c5f82fcc394c1f43b
+config_hash: d9a5b7a4227236a55c89de56b56f4aec

api.md

@@ -214,6 +214,7 @@ from runloop_api_client.types import (
     TunnelView,
     DevboxCreateSSHKeyResponse,
     DevboxReadFileContentsResponse,
+    DevboxWatchEvictionsResponse,
 )
 ```
 
@@ -244,6 +245,7 @@ Methods:
 - <code title="post /v1/devboxes/{id}/suspend">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">suspend</a>(id) -> <a href="./src/runloop_api_client/types/devbox_view.py">DevboxView</a></code>
 - <code title="post /v1/devboxes/{id}/upload_file">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">upload_file</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_upload_file_params.py">params</a>) -> object</code>
 - <code title="post /v1/devboxes/{devbox_id}/executions/{execution_id}/wait_for_status">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">wait_for_command</a>(execution_id, \*, devbox_id, \*\*<a href="src/runloop_api_client/types/devbox_wait_for_command_params.py">params</a>) -> <a href="./src/runloop_api_client/types/devbox_async_execution_detail_view.py">DevboxAsyncExecutionDetailView</a></code>
+- <code title="get /v1/devboxes/watch_evictions">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">watch_evictions</a>() -> <a href="./src/runloop_api_client/types/devbox_watch_evictions_response.py">DevboxWatchEvictionsResponse</a></code>
 - <code title="post /v1/devboxes/{id}/write_file_contents">client.devboxes.<a href="./src/runloop_api_client/resources/devboxes/devboxes.py">write_file_contents</a>(id, \*\*<a href="src/runloop_api_client/types/devbox_write_file_contents_params.py">params</a>) -> <a href="./src/runloop_api_client/types/devbox_execution_detail_view.py">DevboxExecutionDetailView</a></code>
 
 

src/runloop_api_client/resources/devboxes/devboxes.py

@@ -97,6 +97,7 @@
 from ...types.devbox_resource_usage_view import DevboxResourceUsageView
 from ...types.devbox_execution_detail_view import DevboxExecutionDetailView
 from ...types.devbox_create_ssh_key_response import DevboxCreateSSHKeyResponse
+from ...types.devbox_watch_evictions_response import DevboxWatchEvictionsResponse
 from ...types.shared_params.launch_parameters import LaunchParameters
 from ...types.devbox_async_execution_detail_view import DevboxAsyncExecutionDetailView
 from ...types.shared_params.code_mount_parameters import CodeMountParameters
@@ -1742,6 +1743,31 @@ def wait_for_command(
             cast_to=DevboxAsyncExecutionDetailView,
         )
 
+    def watch_evictions(
+        self,
+        *,
+        # 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,
+    ) -> DevboxWatchEvictionsResponse:
+        """
+        Subscribe, via server-sent events, to pending infrastructure evictions for every
+        Devbox in the account. On connect the stream emits one event per Devbox that
+        currently has a pending eviction, then one event as each further eviction is
+        scheduled. Best-effort and advisory: a Devbox stays running until its deadline,
+        and delivery is not guaranteed.
+        """
+        return self._get(
+            "/v1/devboxes/watch_evictions",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=DevboxWatchEvictionsResponse,
+        )
+
     def write_file_contents(
         self,
         id: str,
@@ -3417,6 +3443,31 @@ async def wait_for_command(
             cast_to=DevboxAsyncExecutionDetailView,
         )
 
+    async def watch_evictions(
+        self,
+        *,
+        # 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,
+    ) -> DevboxWatchEvictionsResponse:
+        """
+        Subscribe, via server-sent events, to pending infrastructure evictions for every
+        Devbox in the account. On connect the stream emits one event per Devbox that
+        currently has a pending eviction, then one event as each further eviction is
+        scheduled. Best-effort and advisory: a Devbox stays running until its deadline,
+        and delivery is not guaranteed.
+        """
+        return await self._get(
+            "/v1/devboxes/watch_evictions",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=DevboxWatchEvictionsResponse,
+        )
+
     async def write_file_contents(
         self,
         id: str,
@@ -3555,6 +3606,9 @@ def __init__(self, devboxes: DevboxesResource) -> None:
         self.wait_for_command = to_raw_response_wrapper(
             devboxes.wait_for_command,
         )
+        self.watch_evictions = to_raw_response_wrapper(
+            devboxes.watch_evictions,
+        )
         self.write_file_contents = to_raw_response_wrapper(
             devboxes.write_file_contents,
         )
@@ -3651,6 +3705,9 @@ def __init__(self, devboxes: AsyncDevboxesResource) -> None:
         self.wait_for_command = async_to_raw_response_wrapper(
             devboxes.wait_for_command,
         )
+        self.watch_evictions = async_to_raw_response_wrapper(
+            devboxes.watch_evictions,
+        )
         self.write_file_contents = async_to_raw_response_wrapper(
             devboxes.write_file_contents,
         )
@@ -3747,6 +3804,9 @@ def __init__(self, devboxes: DevboxesResource) -> None:
         self.wait_for_command = to_streamed_response_wrapper(
             devboxes.wait_for_command,
         )
+        self.watch_evictions = to_streamed_response_wrapper(
+            devboxes.watch_evictions,
+        )
         self.write_file_contents = to_streamed_response_wrapper(
             devboxes.write_file_contents,
         )
@@ -3843,6 +3903,9 @@ def __init__(self, devboxes: AsyncDevboxesResource) -> None:
         self.wait_for_command = async_to_streamed_response_wrapper(
             devboxes.wait_for_command,
         )
+        self.watch_evictions = async_to_streamed_response_wrapper(
+            devboxes.watch_evictions,
+        )
         self.write_file_contents = async_to_streamed_response_wrapper(
             devboxes.write_file_contents,
         )

src/runloop_api_client/types/__init__.py

@@ -139,6 +139,7 @@
 from .blueprint_build_logs_list_view import BlueprintBuildLogsListView as BlueprintBuildLogsListView
 from .devbox_create_ssh_key_response import DevboxCreateSSHKeyResponse as DevboxCreateSSHKeyResponse
 from .devbox_wait_for_command_params import DevboxWaitForCommandParams as DevboxWaitForCommandParams
+from .devbox_watch_evictions_response import DevboxWatchEvictionsResponse as DevboxWatchEvictionsResponse
 from .devbox_read_file_contents_params import DevboxReadFileContentsParams as DevboxReadFileContentsParams
 from .benchmark_update_scenarios_params import BenchmarkUpdateScenariosParams as BenchmarkUpdateScenariosParams
 from .devbox_list_disk_snapshots_params import DevboxListDiskSnapshotsParams as DevboxListDiskSnapshotsParams

src/runloop_api_client/types/devbox_watch_evictions_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["DevboxWatchEvictionsResponse"]
+
+
+class DevboxWatchEvictionsResponse(BaseModel):
+    devbox_id: str
+    """The ID of the Devbox with a pending eviction."""
+
+    eviction_deadline_ms: int
+    """Unix timestamp (milliseconds) after which the Devbox will be suspended.
+
+    Advisory and best-effort.
+    """

tests/api_resources/test_devboxes.py

@@ -20,6 +20,7 @@
     DevboxResourceUsageView,
     DevboxExecutionDetailView,
     DevboxCreateSSHKeyResponse,
+    DevboxWatchEvictionsResponse,
     DevboxAsyncExecutionDetailView,
 )
 from runloop_api_client._response import (
@@ -1190,6 +1191,31 @@ def test_path_params_wait_for_command(self, client: Runloop) -> None:
                 statuses=["queued"],
             )
 
+    @parametrize
+    def test_method_watch_evictions(self, client: Runloop) -> None:
+        devbox = client.devboxes.watch_evictions()
+        assert_matches_type(DevboxWatchEvictionsResponse, devbox, path=["response"])
+
+    @parametrize
+    def test_raw_response_watch_evictions(self, client: Runloop) -> None:
+        response = client.devboxes.with_raw_response.watch_evictions()
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        devbox = response.parse()
+        assert_matches_type(DevboxWatchEvictionsResponse, devbox, path=["response"])
+
+    @parametrize
+    def test_streaming_response_watch_evictions(self, client: Runloop) -> None:
+        with client.devboxes.with_streaming_response.watch_evictions() as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            devbox = response.parse()
+            assert_matches_type(DevboxWatchEvictionsResponse, devbox, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @parametrize
     def test_method_write_file_contents(self, client: Runloop) -> None:
         devbox = client.devboxes.write_file_contents(
@@ -2859,6 +2885,31 @@ async def test_path_params_wait_for_command(self, async_client: AsyncRunloop) ->
                 statuses=["queued"],
             )
 
+    @parametrize
+    async def test_method_watch_evictions(self, async_client: AsyncRunloop) -> None:
+        devbox = await async_client.devboxes.watch_evictions()
+        assert_matches_type(DevboxWatchEvictionsResponse, devbox, path=["response"])
+
+    @parametrize
+    async def test_raw_response_watch_evictions(self, async_client: AsyncRunloop) -> None:
+        response = await async_client.devboxes.with_raw_response.watch_evictions()
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        devbox = await response.parse()
+        assert_matches_type(DevboxWatchEvictionsResponse, devbox, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_watch_evictions(self, async_client: AsyncRunloop) -> None:
+        async with async_client.devboxes.with_streaming_response.watch_evictions() as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            devbox = await response.parse()
+            assert_matches_type(DevboxWatchEvictionsResponse, devbox, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @parametrize
     async def test_method_write_file_contents(self, async_client: AsyncRunloop) -> None:
         devbox = await async_client.devboxes.write_file_contents(