feat(api): allow setting a custom name on a browser session at create time

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 117
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e6c711f0d29a7d956cc8ca621440da966c1f1575b1205d01328b1099edf1c517.yml
-openapi_spec_hash: c06e7e36de1c6f9b29b54a6e3dc08ee5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e7925f5cb9626a47fd24470851ff4149c27bc89795f75e8641c618fff93a076c.yml
+openapi_spec_hash: 955d4bf81e9838b0732c0e52716a2030
 config_hash: 36159c262d293fbeacf513ab600a1729

src/resources/browser-pools.ts

@@ -355,6 +355,11 @@ export interface BrowserPoolAcquireResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */

src/resources/browsers/browsers.ts

@@ -389,6 +389,11 @@ export interface BrowserCreateResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -510,6 +515,11 @@ export interface BrowserRetrieveResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -631,6 +641,11 @@ export interface BrowserUpdateResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -752,6 +767,11 @@ export interface BrowserListResponse {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Human-readable name of the browser session, if one was set at creation.
+   */
+  name?: string;
+
   /**
    * Browser pool this session was acquired from, if any.
    */
@@ -865,6 +885,13 @@ export interface BrowserCreateParams {
    */
   kiosk_mode?: boolean;
 
+  /**
+   * Optional human-readable name for the browser session, used to find it later in
+   * the dashboard. Must be unique among active sessions within the project. Set at
+   * creation time only.
+   */
+  name?: string;
+
   /**
    * Profile selection for the browser session. Provide either id or name. If
    * specified, the matching profile will be loaded into the browser session.
@@ -1040,7 +1067,7 @@ export interface BrowserListParams extends OffsetPaginationParams {
   include_deleted?: boolean;
 
   /**
-   * Search browsers by session ID, profile ID, proxy ID, or pool name.
+   * Search browsers by name, session ID, profile ID, proxy ID, or pool name.
    */
   query?: string;
 

src/resources/invocations.ts

@@ -488,6 +488,11 @@ export namespace InvocationListBrowsersResponse {
      */
     kiosk_mode?: boolean;
 
+    /**
+     * Human-readable name of the browser session, if one was set at creation.
+     */
+    name?: string;
+
     /**
      * Browser pool this session was acquired from, if any.
      */

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

@@ -32,6 +32,7 @@ describe('resource browsers', () => {
           headless: false,
           invocation_id: 'rr33xuugxj9h0bkf1rdt2bet',
           kiosk_mode: true,
+          name: 'amazon-scrape-1',
           profile: {
             id: 'id',
             name: 'name',