feat: Allow skipping graceful shutdown on instance delete

Stainless-Generated-From: 948291d549091ca6bab9d0ac22a85aeeb90e22be

Author: kernel-internal[bot]

api.md

@@ -87,7 +87,7 @@ Methods:
 - <code title="post /instances">client.instances.<a href="./src/hypeman/resources/instances/instances.py">create</a>(\*\*<a href="src/hypeman/types/instance_create_params.py">params</a>) -> <a href="./src/hypeman/types/instance.py">Instance</a></code>
 - <code title="patch /instances/{id}">client.instances.<a href="./src/hypeman/resources/instances/instances.py">update</a>(id, \*\*<a href="src/hypeman/types/instance_update_params.py">params</a>) -> <a href="./src/hypeman/types/instance.py">Instance</a></code>
 - <code title="get /instances">client.instances.<a href="./src/hypeman/resources/instances/instances.py">list</a>(\*\*<a href="src/hypeman/types/instance_list_params.py">params</a>) -> <a href="./src/hypeman/types/instance_list_response.py">InstanceListResponse</a></code>
-- <code title="delete /instances/{id}">client.instances.<a href="./src/hypeman/resources/instances/instances.py">delete</a>(id) -> None</code>
+- <code title="delete /instances/{id}">client.instances.<a href="./src/hypeman/resources/instances/instances.py">delete</a>(id, \*\*<a href="src/hypeman/types/instance_delete_params.py">params</a>) -> None</code>
 - <code title="post /instances/{id}/fork">client.instances.<a href="./src/hypeman/resources/instances/instances.py">fork</a>(id, \*\*<a href="src/hypeman/types/instance_fork_params.py">params</a>) -> <a href="./src/hypeman/types/instance.py">Instance</a></code>
 - <code title="get /instances/{id}">client.instances.<a href="./src/hypeman/resources/instances/instances.py">get</a>(id) -> <a href="./src/hypeman/types/instance.py">Instance</a></code>
 - <code title="get /instances/{id}/logs">client.instances.<a href="./src/hypeman/resources/instances/instances.py">logs</a>(id, \*\*<a href="src/hypeman/types/instance_logs_params.py">params</a>) -> str</code>

src/hypeman/resources/instances/instances.py

@@ -16,6 +16,7 @@
     instance_wait_params,
     instance_start_params,
     instance_create_params,
+    instance_delete_params,
     instance_update_params,
     instance_standby_params,
 )
@@ -404,6 +405,7 @@ def delete(
         self,
         id: str,
         *,
+        graceful_shutdown: bool | Omit = omit,
         # 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,
@@ -415,6 +417,8 @@ def delete(
         Stop and delete instance
 
         Args:
+          graceful_shutdown: Whether to attempt graceful guest shutdown before deleting the instance
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -429,7 +433,13 @@ def delete(
         return self._delete(
             path_template("/instances/{id}", id=id),
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {"graceful_shutdown": graceful_shutdown}, instance_delete_params.InstanceDeleteParams
+                ),
             ),
             cast_to=NoneType,
         )
@@ -1217,6 +1227,7 @@ async def delete(
         self,
         id: str,
         *,
+        graceful_shutdown: bool | Omit = omit,
         # 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,
@@ -1228,6 +1239,8 @@ async def delete(
         Stop and delete instance
 
         Args:
+          graceful_shutdown: Whether to attempt graceful guest shutdown before deleting the instance
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1242,7 +1255,13 @@ async def delete(
         return await self._delete(
             path_template("/instances/{id}", id=id),
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"graceful_shutdown": graceful_shutdown}, instance_delete_params.InstanceDeleteParams
+                ),
             ),
             cast_to=NoneType,
         )

src/hypeman/types/__init__.py

@@ -90,6 +90,7 @@
 from .snapshot_policy_param import SnapshotPolicyParam as SnapshotPolicyParam
 from .health_check_tcp_param import HealthCheckTcpParam as HealthCheckTcpParam
 from .instance_create_params import InstanceCreateParams as InstanceCreateParams
+from .instance_delete_params import InstanceDeleteParams as InstanceDeleteParams
 from .instance_health_status import InstanceHealthStatus as InstanceHealthStatus
 from .instance_list_response import InstanceListResponse as InstanceListResponse
 from .instance_logs_response import InstanceLogsResponse as InstanceLogsResponse

src/hypeman/types/instance_delete_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 TypedDict
+
+__all__ = ["InstanceDeleteParams"]
+
+
+class InstanceDeleteParams(TypedDict, total=False):
+    graceful_shutdown: bool
+    """Whether to attempt graceful guest shutdown before deleting the instance"""

tests/api_resources/test_instances.py

@@ -292,15 +292,24 @@ def test_streaming_response_list(self, client: Hypeman) -> None:
     @parametrize
     def test_method_delete(self, client: Hypeman) -> None:
         instance = client.instances.delete(
-            "id",
+            id="id",
+        )
+        assert instance is None
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_method_delete_with_all_params(self, client: Hypeman) -> None:
+        instance = client.instances.delete(
+            id="id",
+            graceful_shutdown=True,
         )
         assert instance is None
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     def test_raw_response_delete(self, client: Hypeman) -> None:
         response = client.instances.with_raw_response.delete(
-            "id",
+            id="id",
         )
 
         assert response.is_closed is True
@@ -312,7 +321,7 @@ def test_raw_response_delete(self, client: Hypeman) -> None:
     @parametrize
     def test_streaming_response_delete(self, client: Hypeman) -> None:
         with client.instances.with_streaming_response.delete(
-            "id",
+            id="id",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -327,7 +336,7 @@ def test_streaming_response_delete(self, client: Hypeman) -> None:
     def test_path_params_delete(self, client: Hypeman) -> None:
         with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
             client.instances.with_raw_response.delete(
-                "",
+                id="",
             )
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
@@ -1101,15 +1110,24 @@ async def test_streaming_response_list(self, async_client: AsyncHypeman) -> None
     @parametrize
     async def test_method_delete(self, async_client: AsyncHypeman) -> None:
         instance = await async_client.instances.delete(
-            "id",
+            id="id",
+        )
+        assert instance is None
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_method_delete_with_all_params(self, async_client: AsyncHypeman) -> None:
+        instance = await async_client.instances.delete(
+            id="id",
+            graceful_shutdown=True,
         )
         assert instance is None
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     async def test_raw_response_delete(self, async_client: AsyncHypeman) -> None:
         response = await async_client.instances.with_raw_response.delete(
-            "id",
+            id="id",
         )
 
         assert response.is_closed is True
@@ -1121,7 +1139,7 @@ async def test_raw_response_delete(self, async_client: AsyncHypeman) -> None:
     @parametrize
     async def test_streaming_response_delete(self, async_client: AsyncHypeman) -> None:
         async with async_client.instances.with_streaming_response.delete(
-            "id",
+            id="id",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -1136,7 +1154,7 @@ async def test_streaming_response_delete(self, async_client: AsyncHypeman) -> No
     async def test_path_params_delete(self, async_client: AsyncHypeman) -> None:
         with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
             await async_client.instances.with_raw_response.delete(
-                "",
+                id="",
             )
 
     @pytest.mark.skip(reason="Mock server tests are disabled")