feat: Add profiles to browser pool acquire

Stainless-Generated-From: 5176ec1d8f90acc70434a055166d8e9366218443

Author: kernel-internal[bot]

src/kernel/resources/browser_pools.py

@@ -31,6 +31,7 @@
 from ..types.browser_pool import BrowserPool
 from ..types.browser_network_config_param import BrowserNetworkConfigParam
 from ..types.browser_pool_acquire_response import BrowserPoolAcquireResponse
+from ..types.shared_params.browser_profile import BrowserProfile
 from ..types.shared_params.browser_viewport import BrowserViewport
 from ..types.shared_params.browser_extension import BrowserExtension
 
@@ -509,6 +510,7 @@ def acquire(
         *,
         acquire_timeout_seconds: int | Omit = omit,
         name: str | Omit = omit,
+        profile: BrowserProfile | Omit = omit,
         start_url: str | Omit = omit,
         tags: TagsParam | Omit = omit,
         telemetry: Optional[browser_pool_acquire_params.Telemetry] | Omit = omit,
@@ -536,6 +538,10 @@ def acquire(
               project. Applies to this lease only and is cleared when the browser is released
               back to the pool.
 
+          profile: Profile selection for the browser session. Provide either id or name. If
+              specified, the matching profile will be loaded into the browser session.
+              Profiles must be created beforehand.
+
           start_url: Optional URL to navigate the acquired browser to. Overrides the pool's start_url
               for this acquire only. Best-effort: failures to navigate do not fail the
               acquire.
@@ -569,6 +575,7 @@ def acquire(
                 {
                     "acquire_timeout_seconds": acquire_timeout_seconds,
                     "name": name,
+                    "profile": profile,
                     "start_url": start_url,
                     "tags": tags,
                     "telemetry": telemetry,
@@ -638,7 +645,8 @@ def release(
               Defaults to true. A reused browser keeps the configuration it was created with,
               so it does not pick up pool configuration changes made while it was in use.
               Release with `reuse: false`, or flush the pool afterward, to rebuild it with the
-              current configuration.
+              current configuration. Browsers loaded with an acquire-time profile are always
+              destroyed and replaced, even when reuse is true.
 
           extra_headers: Send extra headers
 
@@ -1139,6 +1147,7 @@ async def acquire(
         *,
         acquire_timeout_seconds: int | Omit = omit,
         name: str | Omit = omit,
+        profile: BrowserProfile | Omit = omit,
         start_url: str | Omit = omit,
         tags: TagsParam | Omit = omit,
         telemetry: Optional[browser_pool_acquire_params.Telemetry] | Omit = omit,
@@ -1166,6 +1175,10 @@ async def acquire(
               project. Applies to this lease only and is cleared when the browser is released
               back to the pool.
 
+          profile: Profile selection for the browser session. Provide either id or name. If
+              specified, the matching profile will be loaded into the browser session.
+              Profiles must be created beforehand.
+
           start_url: Optional URL to navigate the acquired browser to. Overrides the pool's start_url
               for this acquire only. Best-effort: failures to navigate do not fail the
               acquire.
@@ -1199,6 +1212,7 @@ async def acquire(
                 {
                     "acquire_timeout_seconds": acquire_timeout_seconds,
                     "name": name,
+                    "profile": profile,
                     "start_url": start_url,
                     "tags": tags,
                     "telemetry": telemetry,
@@ -1268,7 +1282,8 @@ async def release(
               Defaults to true. A reused browser keeps the configuration it was created with,
               so it does not pick up pool configuration changes made while it was in use.
               Release with `reuse: false`, or flush the pool afterward, to rebuild it with the
-              current configuration.
+              current configuration. Browsers loaded with an acquire-time profile are always
+              destroyed and replaced, even when reuse is true.
 
           extra_headers: Send extra headers
 

src/kernel/types/browser_pool_acquire_params.py

@@ -6,6 +6,7 @@
 from typing_extensions import TypedDict
 
 from .tags_param import TagsParam
+from .shared_params.browser_profile import BrowserProfile
 from .browsers.browser_telemetry_categories_config_param import BrowserTelemetryCategoriesConfigParam
 
 __all__ = [
@@ -33,6 +34,13 @@ class BrowserPoolAcquireParams(TypedDict, total=False):
     back to the pool.
     """
 
+    profile: BrowserProfile
+    """Profile selection for the browser session.
+
+    Provide either id or name. If specified, the matching profile will be loaded
+    into the browser session. Profiles must be created beforehand.
+    """
+
     start_url: str
     """Optional URL to navigate the acquired browser to.
 

src/kernel/types/browser_pool_release_params.py

@@ -17,5 +17,6 @@ class BrowserPoolReleaseParams(TypedDict, total=False):
     Defaults to true. A reused browser keeps the configuration it was created with,
     so it does not pick up pool configuration changes made while it was in use.
     Release with `reuse: false`, or flush the pool afterward, to rebuild it with the
-    current configuration.
+    current configuration. Browsers loaded with an acquire-time profile are always
+    destroyed and replaced, even when reuse is true.
     """

tests/api_resources/test_browser_pools.py

@@ -370,6 +370,11 @@ def test_method_acquire_with_all_params(self, client: Kernel) -> None:
             id_or_name="id_or_name",
             acquire_timeout_seconds=0,
             name="checkout-flow-1",
+            profile={
+                "id": "id",
+                "name": "name",
+                "save_changes": True,
+            },
             start_url="https://example.com",
             tags={
                 "team": "backend",
@@ -892,6 +897,11 @@ async def test_method_acquire_with_all_params(self, async_client: AsyncKernel) -
             id_or_name="id_or_name",
             acquire_timeout_seconds=0,
             name="checkout-flow-1",
+            profile={
+                "id": "id",
+                "name": "name",
+                "save_changes": True,
+            },
             start_url="https://example.com",
             tags={
                 "team": "backend",