refactor: deprecate and make Nullable total_count and remaining_count of ListViews (#7533)

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-c8d61a0c8b88fa30666ba021d1239eb0d549902354513c4741e9216bcbfa8e6d.yml
-openapi_spec_hash: 433e6fb4ce076012b696f69ae7596c67
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-8704a652545c3831c8b7e246ec17f1a626b59911eb5701ddc922ca6cae1c8d57.yml
+openapi_spec_hash: e609bc5ed3fdce498bc7d16921bbba5e
 config_hash: eb28692edd68a6ae95cf92af931c9976

api.md

@@ -144,7 +144,7 @@ Methods:
 - <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="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) -> DevboxView</code>
+- <code title="post /v1/devboxes/{id}/shutdown">client.devboxes.<a href="./src/resources/devboxes/devboxes.ts">shutdown</a>(id, { ...params }) -> 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>

src/index.ts

@@ -197,6 +197,7 @@ import {
   DevboxResourceUsageView,
   DevboxSendStdInRequest,
   DevboxSendStdInResult,
+  DevboxShutdownParams,
   DevboxSnapshotDiskAsyncParams,
   DevboxSnapshotDiskParams,
   DevboxSnapshotListView,
@@ -630,6 +631,7 @@ export declare namespace Runloop {
     type DevboxListDiskSnapshotsParams as DevboxListDiskSnapshotsParams,
     type DevboxReadFileContentsParams as DevboxReadFileContentsParams,
     type DevboxRemoveTunnelParams as DevboxRemoveTunnelParams,
+    type DevboxShutdownParams as DevboxShutdownParams,
     type DevboxSnapshotDiskParams as DevboxSnapshotDiskParams,
     type DevboxSnapshotDiskAsyncParams as DevboxSnapshotDiskAsyncParams,
     type DevboxUploadFileParams as DevboxUploadFileParams,

src/resources/agents.ts

@@ -78,14 +78,16 @@ export interface AgentListView {
   has_more: boolean;
 
   /**
-   * The count of remaining Agents.
+   * The count of remaining Agents. Deprecated: will be removed in a future breaking
+   * change.
    */
-  remaining_count: number;
+  remaining_count?: number | null;
 
   /**
-   * The total count of Agents.
+   * The total count of Agents. Deprecated: will be removed in a future breaking
+   * change.
    */
-  total_count: number;
+  total_count?: number | null;
 }
 
 /**

src/resources/benchmark-jobs.ts

@@ -308,9 +308,9 @@ export interface BenchmarkJobListView {
    */
   jobs: Array<BenchmarkJobView>;
 
-  remaining_count: number;
+  remaining_count?: number | null;
 
-  total_count: number;
+  total_count?: number | null;
 }
 
 /**

src/resources/benchmark-runs.ts

@@ -85,14 +85,14 @@ export class BenchmarkRunViewsBenchmarkRunsCursorIDPage extends BenchmarkRunsCur
 export interface BenchmarkRunListView {
   has_more: boolean;
 
-  remaining_count: number;
-
   /**
    * List of BenchmarkRuns matching filter.
    */
   runs: Array<BenchmarkRunView>;
 
-  total_count: number;
+  remaining_count?: number | null;
+
+  total_count?: number | null;
 }
 
 /**

src/resources/benchmarks.ts

@@ -299,14 +299,14 @@ export interface BenchmarkView {
 export interface ScenarioDefinitionListView {
   has_more: boolean;
 
-  remaining_count: number;
-
   /**
    * List of Scenarios matching filter.
    */
   scenarios: Array<ScenariosAPI.ScenarioView>;
 
-  total_count: number;
+  remaining_count?: number | null;
+
+  total_count?: number | null;
 }
 
 export interface StartBenchmarkRunParameters {

src/resources/blueprints.ts

@@ -456,9 +456,9 @@ export interface BlueprintListView {
 
   has_more: boolean;
 
-  remaining_count: number;
+  remaining_count?: number | null;
 
-  total_count: number;
+  total_count?: number | null;
 }
 
 export interface BlueprintPreviewView {

src/resources/devboxes/devboxes.ts

@@ -450,10 +450,26 @@ export class Devboxes extends APIResource {
   /**
    * 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
-   * should suspend the Devbox instead of shutting down.
+   * should suspend the Devbox instead of shutting down. If the Devbox has any
+   * in-progress snapshots, the shutdown will be rejected with a 409 Conflict unless
+   * force=true is specified.
    */
-  shutdown(id: string, options?: Core.RequestOptions): Core.APIPromise<DevboxView> {
-    return this._client.post(`/v1/devboxes/${id}/shutdown`, options);
+  shutdown(
+    id: string,
+    params?: DevboxShutdownParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DevboxView>;
+  shutdown(id: string, options?: Core.RequestOptions): Core.APIPromise<DevboxView>;
+  shutdown(
+    id: string,
+    params: DevboxShutdownParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DevboxView> {
+    if (isRequestOptions(params)) {
+      return this.shutdown(id, {}, params);
+    }
+    const { force } = params;
+    return this._client.post(`/v1/devboxes/${id}/shutdown`, { query: { force }, ...options });
   }
 
   /**
@@ -674,9 +690,9 @@ export interface DevboxListView {
 
   has_more: boolean;
 
-  remaining_count: number;
+  remaining_count?: number | null;
 
-  total_count: number;
+  total_count?: number | null;
 }
 
 export interface DevboxResourceUsageView {
@@ -762,14 +778,14 @@ export interface DevboxSendStdInResult {
 export interface DevboxSnapshotListView {
   has_more: boolean;
 
-  remaining_count: number;
-
   /**
    * List of snapshots matching filter.
    */
   snapshots: Array<DevboxSnapshotView>;
 
-  total_count: number;
+  remaining_count?: number | null;
+
+  total_count?: number | null;
 }
 
 /**
@@ -1380,6 +1396,13 @@ export interface DevboxRemoveTunnelParams {
   port: number;
 }
 
+export interface DevboxShutdownParams {
+  /**
+   * If true, force shutdown even if snapshots are in progress. Defaults to false.
+   */
+  force?: string;
+}
+
 export interface DevboxSnapshotDiskParams {
   /**
    * (Optional) Commit message associated with the snapshot (max 1000 characters)
@@ -1500,6 +1523,7 @@ export declare namespace Devboxes {
     type DevboxListDiskSnapshotsParams as DevboxListDiskSnapshotsParams,
     type DevboxReadFileContentsParams as DevboxReadFileContentsParams,
     type DevboxRemoveTunnelParams as DevboxRemoveTunnelParams,
+    type DevboxShutdownParams as DevboxShutdownParams,
     type DevboxSnapshotDiskParams as DevboxSnapshotDiskParams,
     type DevboxSnapshotDiskAsyncParams as DevboxSnapshotDiskAsyncParams,
     type DevboxUploadFileParams as DevboxUploadFileParams,

src/resources/devboxes/index.ts

@@ -46,6 +46,7 @@ export {
   type DevboxListDiskSnapshotsParams,
   type DevboxReadFileContentsParams,
   type DevboxRemoveTunnelParams,
+  type DevboxShutdownParams,
   type DevboxSnapshotDiskParams,
   type DevboxSnapshotDiskAsyncParams,
   type DevboxUploadFileParams,