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

@@ -35,7 +35,7 @@ client = Kernel(
 )
 
 browser = client.browsers.create(
-    persistence={"id": "browser-for-user-1234"},
+    stealth=True,
 )
 print(browser.session_id)
 ```
@@ -63,7 +63,7 @@ client = AsyncKernel(
 
 async def main() -> None:
     browser = await client.browsers.create(
-        persistence={"id": "browser-for-user-1234"},
+        stealth=True,
     )
     print(browser.session_id)
 
@@ -99,7 +99,7 @@ async def main() -> None:
         http_client=DefaultAioHttpClient(),
     ) as client:
         browser = await client.browsers.create(
-            persistence={"id": "browser-for-user-1234"},
+            stealth=True,
         )
         print(browser.session_id)
 
@@ -242,7 +242,7 @@ client = Kernel()
 
 try:
     client.browsers.create(
-        persistence={"id": "browser-for-user-1234"},
+        stealth=True,
     )
 except kernel.APIConnectionError as e:
     print("The server could not be reached")
@@ -287,7 +287,7 @@ client = Kernel(
 
 # Or, configure per-request:
 client.with_options(max_retries=5).browsers.create(
-    persistence={"id": "browser-for-user-1234"},
+    stealth=True,
 )
 ```
 
@@ -312,7 +312,7 @@ client = Kernel(
 
 # Override per-request:
 client.with_options(timeout=5.0).browsers.create(
-    persistence={"id": "browser-for-user-1234"},
+    stealth=True,
 )
 ```
 
@@ -355,9 +355,7 @@ from kernel import Kernel
 
 client = Kernel()
 response = client.browsers.with_raw_response.create(
-    persistence={
-        "id": "browser-for-user-1234"
-    },
+    stealth=True,
 )
 print(response.headers.get('X-My-Header'))
 
@@ -377,7 +375,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.browsers.with_streaming_response.create(
-    persistence={"id": "browser-for-user-1234"},
+    stealth=True,
 ) as response:
     print(response.headers.get("X-My-Header"))
 

src/kernel/resources/browsers/browsers.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import typing_extensions
 from typing import Mapping, Iterable, cast
 
 import httpx
@@ -161,7 +162,7 @@ def create(
           kiosk_mode: If true, launches the browser in kiosk mode to hide address bar and tabs in live
               view.
 
-          persistence: Optional persistence configuration for the browser session.
+          persistence: DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead.
 
           profile: Profile selection for the browser session. Provide either id or name. If
               specified, the matching profile will be loaded into the browser session.
@@ -174,11 +175,10 @@ def create(
               mechanisms.
 
           timeout_seconds: 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.
 
           viewport: Initial browser window size in pixels with optional refresh rate. If omitted,
               image defaults apply (commonly 1024x768@60). Only specific viewport
@@ -307,6 +307,7 @@ def list(
             model=BrowserListResponse,
         )
 
+    @typing_extensions.deprecated("deprecated")
     def delete(
         self,
         *,
@@ -318,8 +319,10 @@ def delete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
-        """
-        Delete a persistent browser session by its persistent_id.
+        """DEPRECATED: Use DELETE /browsers/{id} instead.
+
+        Delete a persistent browser
+        session by its persistent_id.
 
         Args:
           persistent_id: Persistent browser identifier
@@ -504,7 +507,7 @@ async def create(
           kiosk_mode: If true, launches the browser in kiosk mode to hide address bar and tabs in live
               view.
 
-          persistence: Optional persistence configuration for the browser session.
+          persistence: DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead.
 
           profile: Profile selection for the browser session. Provide either id or name. If
               specified, the matching profile will be loaded into the browser session.
@@ -517,11 +520,10 @@ async def create(
               mechanisms.
 
           timeout_seconds: 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.
 
           viewport: Initial browser window size in pixels with optional refresh rate. If omitted,
               image defaults apply (commonly 1024x768@60). Only specific viewport
@@ -650,6 +652,7 @@ def list(
             model=BrowserListResponse,
         )
 
+    @typing_extensions.deprecated("deprecated")
     async def delete(
         self,
         *,
@@ -661,8 +664,10 @@ async def delete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
-        """
-        Delete a persistent browser session by its persistent_id.
+        """DEPRECATED: Use DELETE /browsers/{id} instead.
+
+        Delete a persistent browser
+        session by its persistent_id.
 
         Args:
           persistent_id: Persistent browser identifier
@@ -784,8 +789,10 @@ def __init__(self, browsers: BrowsersResource) -> None:
         self.list = to_raw_response_wrapper(
             browsers.list,
         )
-        self.delete = to_raw_response_wrapper(
-            browsers.delete,
+        self.delete = (  # pyright: ignore[reportDeprecated]
+            to_raw_response_wrapper(
+                browsers.delete,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.delete_by_id = to_raw_response_wrapper(
             browsers.delete_by_id,
@@ -832,8 +839,10 @@ def __init__(self, browsers: AsyncBrowsersResource) -> None:
         self.list = async_to_raw_response_wrapper(
             browsers.list,
         )
-        self.delete = async_to_raw_response_wrapper(
-            browsers.delete,
+        self.delete = (  # pyright: ignore[reportDeprecated]
+            async_to_raw_response_wrapper(
+                browsers.delete,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.delete_by_id = async_to_raw_response_wrapper(
             browsers.delete_by_id,
@@ -880,8 +889,10 @@ def __init__(self, browsers: BrowsersResource) -> None:
         self.list = to_streamed_response_wrapper(
             browsers.list,
         )
-        self.delete = to_streamed_response_wrapper(
-            browsers.delete,
+        self.delete = (  # pyright: ignore[reportDeprecated]
+            to_streamed_response_wrapper(
+                browsers.delete,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.delete_by_id = to_streamed_response_wrapper(
             browsers.delete_by_id,
@@ -928,8 +939,10 @@ def __init__(self, browsers: AsyncBrowsersResource) -> None:
         self.list = async_to_streamed_response_wrapper(
             browsers.list,
         )
-        self.delete = async_to_streamed_response_wrapper(
-            browsers.delete,
+        self.delete = (  # pyright: ignore[reportDeprecated]
+            async_to_streamed_response_wrapper(
+                browsers.delete,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.delete_by_id = async_to_streamed_response_wrapper(
             browsers.delete_by_id,

src/kernel/types/browser_create_params.py

@@ -36,7 +36,7 @@ class BrowserCreateParams(TypedDict, total=False):
     """
 
     persistence: BrowserPersistenceParam
-    """Optional persistence configuration for the browser session."""
+    """DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead."""
 
     profile: BrowserProfile
     """Profile selection for the browser session.
@@ -60,11 +60,10 @@ class BrowserCreateParams(TypedDict, total=False):
     timeout_seconds: int
     """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.
     """
 
     viewport: BrowserViewport

src/kernel/types/browser_create_response.py

@@ -43,7 +43,7 @@ class BrowserCreateResponse(BaseModel):
     """Whether the browser session is running in kiosk mode."""
 
     persistence: Optional[BrowserPersistence] = None
-    """Optional persistence configuration for the browser session."""
+    """DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead."""
 
     profile: Optional[Profile] = None
     """Browser profile metadata."""

src/kernel/types/browser_list_response.py

@@ -43,7 +43,7 @@ class BrowserListResponse(BaseModel):
     """Whether the browser session is running in kiosk mode."""
 
     persistence: Optional[BrowserPersistence] = None
-    """Optional persistence configuration for the browser session."""
+    """DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead."""
 
     profile: Optional[Profile] = None
     """Browser profile metadata."""

src/kernel/types/browser_persistence.py

@@ -7,4 +7,4 @@
 
 class BrowserPersistence(BaseModel):
     id: str
-    """Unique identifier for the persistent browser session."""
+    """DEPRECATED: Unique identifier for the persistent browser session."""

src/kernel/types/browser_persistence_param.py

@@ -9,4 +9,4 @@
 
 class BrowserPersistenceParam(TypedDict, total=False):
     id: Required[str]
-    """Unique identifier for the persistent browser session."""
+    """DEPRECATED: Unique identifier for the persistent browser session."""

src/kernel/types/browser_pool_acquire_response.py

@@ -43,7 +43,7 @@ class BrowserPoolAcquireResponse(BaseModel):
     """Whether the browser session is running in kiosk mode."""
 
     persistence: Optional[BrowserPersistence] = None
-    """Optional persistence configuration for the browser session."""
+    """DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead."""
 
     profile: Optional[Profile] = None
     """Browser profile metadata."""

src/kernel/types/browser_retrieve_response.py

@@ -43,7 +43,7 @@ class BrowserRetrieveResponse(BaseModel):
     """Whether the browser session is running in kiosk mode."""
 
     persistence: Optional[BrowserPersistence] = None
-    """Optional persistence configuration for the browser session."""
+    """DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead."""
 
     profile: Optional[Profile] = None
     """Browser profile metadata."""