fix(tunnels): allow tunnel removal (#8257)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 117
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-3d441e9c2074aef7bd1e87b2ebfbe5c25e340084dbdfeed8a2e4dc9384561e3b.yml
-openapi_spec_hash: 250bfdf2c2270ade53c058419e23c5dc
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-64b2ded3d3cc58131c7ebf36c411f43c3d8dabae0b5b1edd65dd7dab307c54a1.yml
+openapi_spec_hash: 80fabb5e89a61299203113505a894dc2
 config_hash: de99cfce88e2d1f02246dc6c2f43bc6c

api.md

@@ -139,7 +139,7 @@ Methods:
 - <code title="post /v1/devboxes/{id}/keep_alive">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">keepAlive</a>(id) -> unknown</code>
 - <code title="get /v1/devboxes/disk_snapshots">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">listDiskSnapshots</a>({ ...params }) -> DevboxSnapshotViewsDiskSnapshotsCursorIDPage</code>
 - <code title="post /v1/devboxes/{id}/read_file_contents">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">readFileContents</a>(id, { ...params }) -> string</code>
-- <code title="post /v1/devboxes/{id}/remove_tunnel">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">removeTunnel</a>(id, { ...params }) -> unknown</code>
+- <code title="post /v1/devboxes/{id}/remove_tunnel">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">removeTunnel</a>(id) -> unknown</code>
 - <code title="post /v1/devboxes/{id}/resume">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">resume</a>(id) -> DevboxView</code>
 - <code title="get /v1/devboxes/{id}/usage">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">retrieveResourceUsage</a>(id) -> DevboxResourceUsageView</code>
 - <code title="post /v1/devboxes/{id}/shutdown">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">shutdown</a>(id, { ...params }) -> DevboxView</code>

src/index.ts

@@ -191,7 +191,6 @@ import {
   DevboxListView,
   DevboxReadFileContentsParams,
   DevboxReadFileContentsResponse,
-  DevboxRemoveTunnelParams,
   DevboxRemoveTunnelResponse,
   DevboxResourceUsageView,
   DevboxSendStdInRequest,
@@ -626,7 +625,6 @@ export declare namespace Runloop {
     type DevboxExecuteSyncParams as DevboxExecuteSyncParams,
     type DevboxListDiskSnapshotsParams as DevboxListDiskSnapshotsParams,
     type DevboxReadFileContentsParams as DevboxReadFileContentsParams,
-    type DevboxRemoveTunnelParams as DevboxRemoveTunnelParams,
     type DevboxShutdownParams as DevboxShutdownParams,
     type DevboxSnapshotDiskParams as DevboxSnapshotDiskParams,
     type DevboxSnapshotDiskAsyncParams as DevboxSnapshotDiskAsyncParams,

src/resources/devboxes/devboxes.ts

@@ -400,17 +400,10 @@ export class Devboxes extends APIResource {
   }
 
   /**
-   * @deprecated Only works with legacy tunnels created via {@link createTunnel}.
-   * V2 tunnels (from {@link enableTunnel}) remain active until devbox shutdown and cannot be removed.
-   *
-   * Remove a legacy tunnel from the devbox.
+   * Remove an existing V2 tunnel from the Devbox.
    */
-  removeTunnel(
-    id: string,
-    body: DevboxRemoveTunnelParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<unknown> {
-    return this._client.post(`/v1/devboxes/${id}/remove_tunnel`, { body, ...options });
+  removeTunnel(id: string, options?: Core.RequestOptions): Core.APIPromise<unknown> {
+    return this._client.post(`/v1/devboxes/${id}/remove_tunnel`, options);
   }
 
   /**
@@ -1396,13 +1389,6 @@ export interface DevboxReadFileContentsParams {
   file_path: string;
 }
 
-export interface DevboxRemoveTunnelParams {
-  /**
-   * Devbox port that tunnel will expose.
-   */
-  port: number;
-}
-
 export interface DevboxShutdownParams {
   /**
    * If true, force shutdown even if snapshots are in progress. Defaults to false.
@@ -1527,7 +1513,6 @@ export declare namespace Devboxes {
     type DevboxExecuteSyncParams as DevboxExecuteSyncParams,
     type DevboxListDiskSnapshotsParams as DevboxListDiskSnapshotsParams,
     type DevboxReadFileContentsParams as DevboxReadFileContentsParams,
-    type DevboxRemoveTunnelParams as DevboxRemoveTunnelParams,
     type DevboxShutdownParams as DevboxShutdownParams,
     type DevboxSnapshotDiskParams as DevboxSnapshotDiskParams,
     type DevboxSnapshotDiskAsyncParams as DevboxSnapshotDiskAsyncParams,

src/resources/devboxes/index.ts

@@ -43,7 +43,6 @@ export {
   type DevboxExecuteSyncParams,
   type DevboxListDiskSnapshotsParams,
   type DevboxReadFileContentsParams,
-  type DevboxRemoveTunnelParams,
   type DevboxShutdownParams,
   type DevboxSnapshotDiskParams,
   type DevboxSnapshotDiskAsyncParams,

src/resources/devboxes/tools.ts

@@ -164,12 +164,10 @@ export class DevboxTools {
       remove_tunnel: createTool({
         name: 'remove_tunnel',
         description: 'Delete a tunnel',
-        parameters: z.object({
-          port: z.number().describe('The port of the tunnel to delete'),
-        }),
-        execute: async (params) => {
+        parameters: z.object({}),
+        execute: async () => {
           try {
-            await this.devboxes.removeTunnel(devboxId, { port: params.port }, options);
+            await this.devboxes.removeTunnel(devboxId, options);
             return 'Tunnel deleted successfully';
           } catch (error) {
             return `Failed to delete tunnel: ${error}`;

src/resources/index.ts

@@ -92,7 +92,6 @@ export {
   type DevboxExecuteSyncParams,
   type DevboxListDiskSnapshotsParams,
   type DevboxReadFileContentsParams,
-  type DevboxRemoveTunnelParams,
   type DevboxShutdownParams,
   type DevboxSnapshotDiskParams,
   type DevboxSnapshotDiskAsyncParams,

src/sdk/devbox.ts

@@ -7,7 +7,6 @@ import type {
   DevboxAsyncExecutionDetailView,
   DevboxSnapshotDiskParams,
   DevboxEnableTunnelParams,
-  DevboxRemoveTunnelParams,
   DevboxReadFileContentsParams,
   DevboxWriteFileContentsParams,
   DevboxDownloadFileParams,
@@ -139,15 +138,14 @@ export class DevboxNetOps {
    * @example
    * ```typescript
    * // Deprecated - only for legacy tunnels
-   * await devbox.net.removeTunnel({ port: 8080 });
+   * await devbox.net.removeTunnel();
    * ```
    *
-   * @param {DevboxRemoveTunnelParams} params - Tunnel removal parameters including port
    * @param {Core.RequestOptions} [options] - Request options
    * @returns {Promise<DevboxRemoveTunnelResponse>} Tunnel removal result
    */
-  async removeTunnel(params: DevboxRemoveTunnelParams, options?: Core.RequestOptions) {
-    return this.client.devboxes.removeTunnel(this.devboxId, params, options);
+  async removeTunnel(options?: Core.RequestOptions) {
+    return this.client.devboxes.removeTunnel(this.devboxId, options);
   }
 }
 

tests/api-resources/devboxes/devboxes.test.ts

@@ -362,8 +362,8 @@ describe('resource devboxes', () => {
     const response = await client.devboxes.readFileContents('id', { file_path: 'file_path' });
   });
 
-  test('removeTunnel: only required params', async () => {
-    const responsePromise = client.devboxes.removeTunnel('id', { port: 0 });
+  test('removeTunnel', async () => {
+    const responsePromise = client.devboxes.removeTunnel('id');
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -373,8 +373,11 @@ describe('resource devboxes', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  test('removeTunnel: required and optional params', async () => {
-    const response = await client.devboxes.removeTunnel('id', { port: 0 });
+  test('removeTunnel: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(client.devboxes.removeTunnel('id', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Runloop.NotFoundError,
+    );
   });
 
   test('resume', async () => {

tests/objects/devbox.test.ts

@@ -381,13 +381,9 @@ describe('Devbox (New API)', () => {
       it('should remove legacy tunnel', async () => {
         mockClient.devboxes.removeTunnel.mockResolvedValue(undefined);
 
-        const result = await devbox.net.removeTunnel({ port: 8080 });
+        const result = await devbox.net.removeTunnel();
 
-        expect(mockClient.devboxes.removeTunnel).toHaveBeenCalledWith(
-          'devbox-123',
-          { port: 8080 },
-          undefined,
-        );
+        expect(mockClient.devboxes.removeTunnel).toHaveBeenCalledWith('devbox-123', undefined);
         expect(result).toBeUndefined();
       });
     });