fix(api): don't ignore devbox keep_alive, suspend and resume in api

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 94
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-c15740e10009ccfaf6cb6ae4463496618c05d033bdd779bf501f5afb0c05ffc9.yml
-openapi_spec_hash: a08d1a45d83ed2956ab643d1c6c07a40
+configured_endpoints: 97
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-d2463b4c27719ea7275c8f587fa2c90e333471fdede11e5f944faa92dfb417d1.yml
+openapi_spec_hash: 132c1d9f04583e997df5d7698e155fff
 config_hash: 2363f563f42501d2b1587a4f64bdccaf

api.md

@@ -97,6 +97,7 @@ Types:
 - <code><a href="./src/resources/devboxes/devboxes.ts">DevboxView</a></code>
 - <code><a href="./src/resources/devboxes/devboxes.ts">DevboxCreateSSHKeyResponse</a></code>
 - <code><a href="./src/resources/devboxes/devboxes.ts">DevboxDeleteDiskSnapshotResponse</a></code>
+- <code><a href="./src/resources/devboxes/devboxes.ts">DevboxKeepAliveResponse</a></code>
 - <code><a href="./src/resources/devboxes/devboxes.ts">DevboxReadFileContentsResponse</a></code>
 - <code><a href="./src/resources/devboxes/devboxes.ts">DevboxRemoveTunnelResponse</a></code>
 - <code><a href="./src/resources/devboxes/devboxes.ts">DevboxUploadFileResponse</a></code>
@@ -114,12 +115,15 @@ Methods:
 - <code title="post /v1/devboxes/{id}/execute">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">execute</a>(id, { ...params }) -> DevboxAsyncExecutionDetailView</code>
 - <code title="post /v1/devboxes/{id}/execute_async">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">executeAsync</a>(id, { ...params }) -> DevboxAsyncExecutionDetailView</code>
 - <code title="post /v1/devboxes/{id}/execute_sync">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">executeSync</a>(id, { ...params }) -> DevboxExecutionDetailView</code>
+- <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}/resume">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">resume</a>(id) -> DevboxView</code>
 - <code title="post /v1/devboxes/{id}/shutdown">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">shutdown</a>(id) -> DevboxView</code>
 - <code title="post /v1/devboxes/{id}/snapshot_disk">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">snapshotDisk</a>(id, { ...params }) -> DevboxSnapshotView</code>
 - <code title="post /v1/devboxes/{id}/snapshot_disk_async">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">snapshotDiskAsync</a>(id, { ...params }) -> DevboxSnapshotView</code>
+- <code title="post /v1/devboxes/{id}/suspend">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">suspend</a>(id) -> DevboxView</code>
 - <code title="post /v1/devboxes/{id}/upload_file">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">uploadFile</a>(id, { ...params }) -> unknown</code>
 - <code title="post /v1/devboxes/{devbox_id}/executions/{execution_id}/wait_for_status">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">waitForCommand</a>(devboxId, executionId, { ...params }) -> DevboxAsyncExecutionDetailView</code>
 - <code title="post /v1/devboxes/{id}/write_file_contents">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">writeFileContents</a>(id, { ...params }) -> DevboxExecutionDetailView</code>

src/index.ts

@@ -125,6 +125,7 @@ import {
   DevboxExecuteParams,
   DevboxExecuteSyncParams,
   DevboxExecutionDetailView,
+  DevboxKeepAliveResponse,
   DevboxKillExecutionRequest,
   DevboxListDiskSnapshotsParams,
   DevboxListParams,
@@ -496,6 +497,7 @@ export declare namespace Runloop {
     type DevboxView as DevboxView,
     type DevboxCreateSSHKeyResponse as DevboxCreateSSHKeyResponse,
     type DevboxDeleteDiskSnapshotResponse as DevboxDeleteDiskSnapshotResponse,
+    type DevboxKeepAliveResponse as DevboxKeepAliveResponse,
     type DevboxReadFileContentsResponse as DevboxReadFileContentsResponse,
     type DevboxRemoveTunnelResponse as DevboxRemoveTunnelResponse,
     type DevboxUploadFileResponse as DevboxUploadFileResponse,

src/resources/devboxes/devboxes.ts

@@ -395,6 +395,15 @@ export class Devboxes extends APIResource {
     return this._client.post(`/v1/devboxes/${id}/remove_tunnel`, { body, ...options });
   }
 
+  /**
+   * Resume a suspended Devbox with the disk state captured as suspend time. Note
+   * that any previously running processes or daemons will need to be restarted using
+   * the Devbox shell tools.
+   */
+  resume(id: string, options?: Core.RequestOptions): Core.APIPromise<DevboxView> {
+    return this._client.post(`/v1/devboxes/${id}/resume`, options);
+  }
+
   /**
    * Shutdown a running Devbox. This will permanently stop the Devbox. If you want to
    * save the state of the Devbox, you should take a snapshot before shutting down or
@@ -451,6 +460,15 @@ export class Devboxes extends APIResource {
     return this._client.post(`/v1/devboxes/${id}/snapshot_disk_async`, { body, ...options });
   }
 
+  /**
+   * Suspend a running Devbox and create a disk snapshot to enable resuming the
+   * Devbox later with the same disk. Note this will not snapshot memory state such
+   * as running processes.
+   */
+  suspend(id: string, options?: Core.RequestOptions): Core.APIPromise<DevboxView> {
+    return this._client.post(`/v1/devboxes/${id}/suspend`, options);
+  }
+
   /**
    * Upload file contents of any type (binary, text, etc) to a Devbox. Note this API
    * is suitable for large files (larger than 100MB) and efficiently uploads files

src/resources/index.ts

@@ -61,6 +61,7 @@ export {
   type DevboxView,
   type DevboxCreateSSHKeyResponse,
   type DevboxDeleteDiskSnapshotResponse,
+  type DevboxKeepAliveResponse,
   type DevboxReadFileContentsResponse,
   type DevboxRemoveTunnelResponse,
   type DevboxUploadFileResponse,

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

@@ -262,6 +262,24 @@ describe('resource devboxes', () => {
     });
   });
 
+  test('keepAlive', async () => {
+    const responsePromise = client.devboxes.keepAlive('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);
+  });
+
+  test('keepAlive: 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.keepAlive('id', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Runloop.NotFoundError,
+    );
+  });
+
   test('listDiskSnapshots', async () => {
     const responsePromise = client.devboxes.listDiskSnapshots();
     const rawResponse = await responsePromise.asResponse();
@@ -327,6 +345,24 @@ describe('resource devboxes', () => {
     const response = await client.devboxes.removeTunnel('id', { port: 0 });
   });
 
+  test('resume', async () => {
+    const responsePromise = client.devboxes.resume('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);
+  });
+
+  test('resume: 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.resume('id', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Runloop.NotFoundError,
+    );
+  });
+
   test('shutdown', async () => {
     const responsePromise = client.devboxes.shutdown('id');
     const rawResponse = await responsePromise.asResponse();
@@ -403,6 +439,24 @@ describe('resource devboxes', () => {
     ).rejects.toThrow(Runloop.NotFoundError);
   });
 
+  test('suspend', async () => {
+    const responsePromise = client.devboxes.suspend('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);
+  });
+
+  test('suspend: 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.suspend('id', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Runloop.NotFoundError,
+    );
+  });
+
   test('uploadFile: only required params', async () => {
     const responsePromise = client.devboxes.uploadFile('id', { path: 'path' });
     const rawResponse = await responsePromise.asResponse();