feat(dashboard): add browser replays support for past browsers

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 91
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-1e490dbef30dfa53ccba72524fcba4079f244f2530a4f770c00f8fee707eaa72.yml
-openapi_spec_hash: 1fd15429610959f19aed6d3cb170ab9e
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-68729f2ff40476377ead9019c18ea140fc4efbc2e68d7c4fc323bd61ae81f768.yml
+openapi_spec_hash: 9eec61481f9059b5fedc13abc3e39338
 config_hash: cc7fdd701d995d4b3456d77041c604cf

api.md

@@ -73,7 +73,7 @@ Types:
 Methods:
 
 - <code title="post /browsers">client.browsers.<a href="./src/resources/browsers/browsers.ts">create</a>({ ...params }) -> BrowserCreateResponse</code>
-- <code title="get /browsers/{id}">client.browsers.<a href="./src/resources/browsers/browsers.ts">retrieve</a>(id) -> BrowserRetrieveResponse</code>
+- <code title="get /browsers/{id}">client.browsers.<a href="./src/resources/browsers/browsers.ts">retrieve</a>(id, { ...params }) -> BrowserRetrieveResponse</code>
 - <code title="patch /browsers/{id}">client.browsers.<a href="./src/resources/browsers/browsers.ts">update</a>(id, { ...params }) -> BrowserUpdateResponse</code>
 - <code title="get /browsers">client.browsers.<a href="./src/resources/browsers/browsers.ts">list</a>({ ...params }) -> BrowserListResponsesOffsetPagination</code>
 - <code title="delete /browsers">client.browsers.<a href="./src/resources/browsers/browsers.ts">delete</a>({ ...params }) -> void</code>

src/client.ts

@@ -94,6 +94,7 @@ import {
   BrowserListResponsesOffsetPagination,
   BrowserLoadExtensionsParams,
   BrowserPersistence,
+  BrowserRetrieveParams,
   BrowserRetrieveResponse,
   BrowserUpdateParams,
   BrowserUpdateResponse,
@@ -939,6 +940,7 @@ export declare namespace Kernel {
     type BrowserListResponse as BrowserListResponse,
     type BrowserListResponsesOffsetPagination as BrowserListResponsesOffsetPagination,
     type BrowserCreateParams as BrowserCreateParams,
+    type BrowserRetrieveParams as BrowserRetrieveParams,
     type BrowserUpdateParams as BrowserUpdateParams,
     type BrowserListParams as BrowserListParams,
     type BrowserDeleteParams as BrowserDeleteParams,

src/resources/browsers/browsers.ts

@@ -105,8 +105,12 @@ export class Browsers extends APIResource {
    * );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<BrowserRetrieveResponse> {
-    return this._client.get(path`/browsers/${id}`, options);
+  retrieve(
+    id: string,
+    query: BrowserRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BrowserRetrieveResponse> {
+    return this._client.get(path`/browsers/${id}`, { query, ...options });
   }
 
   /**
@@ -124,8 +128,8 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * List all browser sessions with pagination support. Use include_deleted=true to
-   * include soft-deleted sessions in the results.
+   * List all browser sessions with pagination support. Use status parameter to
+   * filter by session state.
    *
    * @example
    * ```ts
@@ -618,6 +622,13 @@ export interface BrowserCreateParams {
   viewport?: Shared.BrowserViewport;
 }
 
+export interface BrowserRetrieveParams {
+  /**
+   * When true, includes soft-deleted browser sessions in the lookup.
+   */
+  include_deleted?: boolean;
+}
+
 export interface BrowserUpdateParams {
   /**
    * ID of the proxy to use. Omit to leave unchanged, set to empty string to remove
@@ -628,10 +639,16 @@ export interface BrowserUpdateParams {
 
 export interface BrowserListParams extends OffsetPaginationParams {
   /**
-   * When true, includes soft-deleted browser sessions in the results alongside
-   * active sessions.
+   * Deprecated: Use status=all instead. When true, includes soft-deleted browser
+   * sessions in the results alongside active sessions.
    */
   include_deleted?: boolean;
+
+  /**
+   * Filter sessions by status. "active" returns only active sessions (default),
+   * "deleted" returns only soft-deleted sessions, "all" returns both.
+   */
+  status?: 'active' | 'deleted' | 'all';
 }
 
 export interface BrowserDeleteParams {
@@ -680,6 +697,7 @@ export declare namespace Browsers {
     type BrowserListResponse as BrowserListResponse,
     type BrowserListResponsesOffsetPagination as BrowserListResponsesOffsetPagination,
     type BrowserCreateParams as BrowserCreateParams,
+    type BrowserRetrieveParams as BrowserRetrieveParams,
     type BrowserUpdateParams as BrowserUpdateParams,
     type BrowserListParams as BrowserListParams,
     type BrowserDeleteParams as BrowserDeleteParams,

src/resources/browsers/index.ts

@@ -9,6 +9,7 @@ export {
   type BrowserUpdateResponse,
   type BrowserListResponse,
   type BrowserCreateParams,
+  type BrowserRetrieveParams,
   type BrowserUpdateParams,
   type BrowserListParams,
   type BrowserDeleteParams,

src/resources/index.ts

@@ -28,6 +28,7 @@ export {
   type BrowserUpdateResponse,
   type BrowserListResponse,
   type BrowserCreateParams,
+  type BrowserRetrieveParams,
   type BrowserUpdateParams,
   type BrowserListParams,
   type BrowserDeleteParams,

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

@@ -62,6 +62,18 @@ describe('resource browsers', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
+  // Prism tests are disabled
+  test.skip('retrieve: request options and 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.browsers.retrieve(
+        'htzv5orfit78e1m2biiifpbv',
+        { include_deleted: true },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(Kernel.NotFoundError);
+  });
+
   // Prism tests are disabled
   test.skip('update', async () => {
     const responsePromise = client.browsers.update('htzv5orfit78e1m2biiifpbv', {});
@@ -95,6 +107,7 @@ describe('resource browsers', () => {
           include_deleted: true,
           limit: 1,
           offset: 0,
+          status: 'active',
         },
         { path: '/_stainless_unknown_path' },
       ),