feat: Support telemetry enabled request config

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 112
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-a0ad160eb0fb11e201e240de8487c12992a474076aeed1c1167ee54ade43edfb.yml
-openapi_spec_hash: 84a7075fddbe17b1446a759e8cc39047
-config_hash: 26beac3050665664d5d74d2bbfe9e808
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e9c99662d29710f105847d461f8919e06f6aa2e43b0e1a6285d0b137643a7907.yml
+openapi_spec_hash: 4415cb4790c7a5ec892f4e3521217cb4
+config_hash: 27b38657d9a3b33328be930eeb319628

api.md

@@ -119,6 +119,7 @@ Types:
 - <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryCategoryConfig</a></code>
 - <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryConfig</a></code>
 - <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryEvent</a></code>
+- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryRequestConfig</a></code>
 - <code><a href="./src/resources/browsers/telemetry.ts">TelemetryStreamResponse</a></code>
 
 Methods:

src/resources/browsers/browsers.ts

@@ -83,6 +83,7 @@ import {
   BrowserTelemetryCategoryConfig,
   BrowserTelemetryConfig,
   BrowserTelemetryEvent,
+  BrowserTelemetryRequestConfig,
   Telemetry,
   TelemetryStreamParams,
   TelemetryStreamResponse,
@@ -892,11 +893,13 @@ export interface BrowserCreateParams {
   stealth?: boolean;
 
   /**
-   * Telemetry configuration for the browser session. If provided, telemetry capture
-   * starts with the specified category filter when the session is created. If
-   * omitted, no telemetry capture is started.
+   * Telemetry configuration for the browser session. Set enabled to true to start
+   * capture using VM defaults, or provide browser category settings. If omitted,
+   * null, set to an empty object ({}), set to enabled: false without browser
+   * category settings, or all four categories are explicitly disabled, capture is
+   * not started.
    */
-  telemetry?: TelemetryAPI.BrowserTelemetryConfig | null;
+  telemetry?: TelemetryAPI.BrowserTelemetryRequestConfig | null;
 
   /**
    * The number of seconds of inactivity before the browser session is terminated.
@@ -952,11 +955,12 @@ export interface BrowserUpdateParams {
 
   /**
    * Telemetry configuration. Omit, set to null, or set to an empty object ({}) to
-   * leave the existing configuration unchanged (no-op). To enable capture for all
-   * categories using VM defaults, set browser to an empty object ({"browser": {}}).
-   * To stop capture, set every category's enabled to false.
+   * leave the existing configuration unchanged. Set enabled to true to enable
+   * capture using VM defaults. Set enabled to false to stop capture. Provide browser
+   * category settings for per-category updates. Explicitly disabling all four
+   * categories also stops capture.
    */
-  telemetry?: TelemetryAPI.BrowserTelemetryConfig | null;
+  telemetry?: TelemetryAPI.BrowserTelemetryRequestConfig | null;
 
   /**
    * Viewport configuration to apply to the browser session.
@@ -1111,6 +1115,7 @@ export declare namespace Browsers {
     type BrowserTelemetryCategoryConfig as BrowserTelemetryCategoryConfig,
     type BrowserTelemetryConfig as BrowserTelemetryConfig,
     type BrowserTelemetryEvent as BrowserTelemetryEvent,
+    type BrowserTelemetryRequestConfig as BrowserTelemetryRequestConfig,
     type TelemetryStreamResponse as TelemetryStreamResponse,
     type TelemetryStreamParams as TelemetryStreamParams,
   };

src/resources/browsers/index.ts

@@ -111,6 +111,7 @@ export {
   type BrowserTelemetryCategoryConfig,
   type BrowserTelemetryConfig,
   type BrowserTelemetryEvent,
+  type BrowserTelemetryRequestConfig,
   type TelemetryStreamResponse,
   type TelemetryStreamParams,
 } from './telemetry';

src/resources/browsers/telemetry.ts

@@ -1412,11 +1412,11 @@ export interface BrowserTelemetryCategoryConfig {
 }
 
 /**
- * Telemetry configuration for a browser session.
+ * Active telemetry configuration for a browser session.
  */
 export interface BrowserTelemetryConfig {
   /**
-   * Per-category enable/disable flags. If omitted, all categories are captured.
+   * Per-category enable/disable flags.
    */
   browser?: BrowserTelemetryCategoriesConfig;
 }
@@ -1452,6 +1452,25 @@ export type BrowserTelemetryEvent =
   | BrowserMonitorReconnectFailedEvent
   | BrowserMonitorInitFailedEvent;
 
+/**
+ * Telemetry request configuration for a browser session.
+ */
+export interface BrowserTelemetryRequestConfig {
+  /**
+   * Per-category enable/disable flags. If enabled is true and browser is omitted or
+   * empty, the VM default category set is used. Explicitly disabling all four
+   * categories stops capture on update and starts no capture on create.
+   */
+  browser?: BrowserTelemetryCategoriesConfig;
+
+  /**
+   * Request shortcut for browser telemetry capture. True enables capture using VM
+   * defaults. False stops capture on update and starts no capture on create. Cannot
+   * be combined with browser category settings.
+   */
+  enabled?: boolean;
+}
+
 /**
  * Envelope wrapping a browser telemetry event with its monotonic sequence number.
  * Each SSE data: frame carries one envelope as JSON. The seq value is also emitted
@@ -1515,6 +1534,7 @@ export declare namespace Telemetry {
     type BrowserTelemetryCategoryConfig as BrowserTelemetryCategoryConfig,
     type BrowserTelemetryConfig as BrowserTelemetryConfig,
     type BrowserTelemetryEvent as BrowserTelemetryEvent,
+    type BrowserTelemetryRequestConfig as BrowserTelemetryRequestConfig,
     type TelemetryStreamResponse as TelemetryStreamResponse,
     type TelemetryStreamParams as TelemetryStreamParams,
   };

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

@@ -47,6 +47,7 @@ describe('resource browsers', () => {
               network: { enabled: true },
               page: { enabled: true },
             },
+            enabled: true,
           },
           timeout_seconds: 10,
           viewport: {

yarn.lock

@@ -1215,9 +1215,9 @@ baseline-browser-mapping@^2.9.0:
   integrity sha512-B0xUquLkiGLgHhpPBqvl7GWegWBUNuujQ6kXd/r1U38ElPT6Ok8KZ8e+FpUGEc2ZoRQUzq/aUnaKFc/svWUGSg==
 
 brace-expansion@^2.0.2:
-  version "2.1.0"
-  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.0.tgz#4f41a41190216ee36067ec381526fe9539c4f0ae"
-  integrity sha512-TN1kCZAgdgweJhWWpgKYrQaMNHcDULHkWwQIspdtjV4Y5aurRdZpjAqn6yX3FPqTA9ngHCc4hJxMAMgGfve85w==
+  version "2.1.1"
+  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.1.tgz#c68b1c4111c76aae3a6fba55d496cee10c39dad8"
+  integrity sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==
   dependencies:
     balanced-match "^1.0.0"