refactor(browser): remove persistence option UI

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 74
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-003e9afa15f0765009d2c7d34e8eb62268d818e628e3c84361b21138e30cc423.yml
-openapi_spec_hash: c1b8309f60385bf2b02d245363ca47c1
-config_hash: a4124701ae0a474e580d7416adbcfb00
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-cbef7e4fef29ad40af5c767aceb762ee68811c2287f255c05d2ee44a9a9247a2.yml
+openapi_spec_hash: 467e61e072773ec9f2d49c7dd3de8c2f
+config_hash: 6dbe88d2ba9df1ec46cedbfdb7d00000

README.md

@@ -27,7 +27,7 @@ const client = new Kernel({
   environment: 'development', // defaults to 'production'
 });
 
-const browser = await client.browsers.create({ persistence: { id: 'browser-for-user-1234' } });
+const browser = await client.browsers.create({ stealth: true });
 
 console.log(browser.session_id);
 ```
@@ -45,7 +45,7 @@ const client = new Kernel({
   environment: 'development', // defaults to 'production'
 });
 
-const params: Kernel.BrowserCreateParams = { persistence: { id: 'browser-for-user-1234' } };
+const params: Kernel.BrowserCreateParams = { stealth: true };
 const browser: Kernel.BrowserCreateResponse = await client.browsers.create(params);
 ```
 
@@ -88,17 +88,15 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const browser = await client.browsers
-  .create({ persistence: { id: 'browser-for-user-1234' } })
-  .catch(async (err) => {
-    if (err instanceof Kernel.APIError) {
-      console.log(err.status); // 400
-      console.log(err.name); // BadRequestError
-      console.log(err.headers); // {server: 'nginx', ...}
-    } else {
-      throw err;
-    }
-  });
+const browser = await client.browsers.create({ stealth: true }).catch(async (err) => {
+  if (err instanceof Kernel.APIError) {
+    console.log(err.status); // 400
+    console.log(err.name); // BadRequestError
+    console.log(err.headers); // {server: 'nginx', ...}
+  } else {
+    throw err;
+  }
+});
 ```
 
 Error codes are as follows:
@@ -130,7 +128,7 @@ const client = new Kernel({
 });
 
 // Or, configure per-request:
-await client.browsers.create({ persistence: { id: 'browser-for-user-1234' } }, {
+await client.browsers.create({ stealth: true }, {
   maxRetries: 5,
 });
 ```
@@ -147,7 +145,7 @@ const client = new Kernel({
 });
 
 // Override per-request:
-await client.browsers.create({ persistence: { id: 'browser-for-user-1234' } }, {
+await client.browsers.create({ stealth: true }, {
   timeout: 5 * 1000,
 });
 ```
@@ -201,13 +199,11 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new Kernel();
 
-const response = await client.browsers.create({ persistence: { id: 'browser-for-user-1234' } }).asResponse();
+const response = await client.browsers.create({ stealth: true }).asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: browser, response: raw } = await client.browsers
-  .create({ persistence: { id: 'browser-for-user-1234' } })
-  .withResponse();
+const { data: browser, response: raw } = await client.browsers.create({ stealth: true }).withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(browser.session_id);
 ```

src/resources/browser-pools.ts

@@ -339,7 +339,8 @@ export interface BrowserPoolAcquireResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowsersAPI.BrowserPersistence;
 

src/resources/browsers/browsers.ts

@@ -127,14 +127,10 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * Delete a persistent browser session by its persistent_id.
+   * DEPRECATED: Use DELETE /browsers/{id} instead. Delete a persistent browser
+   * session by its persistent_id.
    *
-   * @example
-   * ```ts
-   * await client.browsers.delete({
-   *   persistent_id: 'persistent_id',
-   * });
-   * ```
+   * @deprecated
    */
   delete(params: BrowserDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { persistent_id } = params;
@@ -192,11 +188,12 @@ export class Browsers extends APIResource {
 export type BrowserListResponsesOffsetPagination = OffsetPagination<BrowserListResponse>;
 
 /**
- * Optional persistence configuration for the browser session.
+ * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+ * instead.
  */
 export interface BrowserPersistence {
   /**
-   * Unique identifier for the persistent browser session.
+   * DEPRECATED: Unique identifier for the persistent browser session.
    */
   id: string;
 }
@@ -279,7 +276,8 @@ export interface BrowserCreateResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -354,7 +352,8 @@ export interface BrowserRetrieveResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -429,7 +428,8 @@ export interface BrowserListResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -480,7 +480,8 @@ export interface BrowserCreateParams {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -505,11 +506,10 @@ export interface BrowserCreateParams {
 
   /**
    * The number of seconds of inactivity before the browser session is terminated.
-   * Only applicable to non-persistent browsers. Activity includes CDP connections
-   * and live view connections. Defaults to 60 seconds. Minimum allowed is 10
-   * seconds. Maximum allowed is 259200 (72 hours). We check for inactivity every 5
-   * seconds, so the actual timeout behavior you will see is +/- 5 seconds around the
-   * specified value.
+   * Activity includes CDP connections and live view connections. Defaults to 60
+   * seconds. Minimum allowed is 10 seconds. Maximum allowed is 259200 (72 hours). We
+   * check for inactivity every 5 seconds, so the actual timeout behavior you will
+   * see is +/- 5 seconds around the specified value.
    */
   timeout_seconds?: number;