feat: Add DELETE /deployments/{id} API endpoint

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 100
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-a0f1d08e6f62a74de2aac5c25e592494abdd59f2cfca2842c5810927554faee0.yml
-openapi_spec_hash: ebd8bf67b7bb371cf4b4fa68b967cab5
-config_hash: 27c0ea01aeb797a1767af139851c5b66
+configured_endpoints: 101
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-bbc3dbdd0410eb315cfaeb21aad9f85e4a7f92ac55526ebb702a8bee343c2ab7.yml
+openapi_spec_hash: 60a5134c45a8f3a217e128d4e3335cae
+config_hash: 147340811dd6fbb9c2d80515a7e31f9a

api.md

@@ -27,6 +27,7 @@ Methods:
 - <code title="post /deployments">client.deployments.<a href="./src/resources/deployments.ts">create</a>({ ...params }) -> DeploymentCreateResponse</code>
 - <code title="get /deployments/{id}">client.deployments.<a href="./src/resources/deployments.ts">retrieve</a>(id) -> DeploymentRetrieveResponse</code>
 - <code title="get /deployments">client.deployments.<a href="./src/resources/deployments.ts">list</a>({ ...params }) -> DeploymentListResponsesOffsetPagination</code>
+- <code title="delete /deployments/{id}">client.deployments.<a href="./src/resources/deployments.ts">delete</a>(id) -> void</code>
 - <code title="get /deployments/{id}/events">client.deployments.<a href="./src/resources/deployments.ts">follow</a>(id, { ...params }) -> DeploymentFollowResponse</code>
 
 # Apps

src/resources/deployments.ts

@@ -63,6 +63,22 @@ export class Deployments extends APIResource {
     });
   }
 
+  /**
+   * Stops a running deployment and marks it for deletion. If the deployment is
+   * already in a terminal state (stopped or failed), returns immediately.
+   *
+   * @example
+   * ```ts
+   * await client.deployments.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/deployments/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Establishes a Server-Sent Events (SSE) stream that delivers real-time logs and
    * status updates for a deployment. The stream terminates automatically once the

tests/api-resources/deployments.test.ts

@@ -59,6 +59,18 @@ describe('resource deployments', () => {
     ).rejects.toThrow(Kernel.NotFoundError);
   });
 
+  // Mock server tests are disabled
+  test.skip('delete', async () => {
+    const responsePromise = client.deployments.delete('id');
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
   // Mock server tests are disabled
   test.skip('follow', async () => {
     const responsePromise = client.deployments.follow('id');