feat(api): allow setting a name and tags on a pool-acquired browser session

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-9d489e3e43edfa64a754d4281241718e01c85d9a82ef3687df12bbd3c4ff5b42.yml
-openapi_spec_hash: a953cafb7f40ec8495dbd7df8bab8bad
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-662a9d6352d842f37e06e0197a61fe10850483302650713345d45780b3128343.yml
+openapi_spec_hash: e65977d16d95d48c75d02a1133131149
 config_hash: bb7acce8576a50dd449b0c8f58ef0f1d

src/kernel/resources/browser_pools.py

@@ -26,6 +26,7 @@
 )
 from ..pagination import SyncOffsetPagination, AsyncOffsetPagination
 from .._base_client import AsyncPaginator, make_request_options
+from ..types.tags_param import TagsParam
 from ..types.browser_pool import BrowserPool
 from ..types.browser_pool_acquire_response import BrowserPoolAcquireResponse
 from ..types.shared_params.browser_profile import BrowserProfile
@@ -417,6 +418,8 @@ def acquire(
         id_or_name: str,
         *,
         acquire_timeout_seconds: int | Omit = omit,
+        name: str | Omit = omit,
+        tags: TagsParam | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -436,6 +439,15 @@ def acquire(
               calculated time it would take to fill the pool at the currently configured fill
               rate.
 
+          name: Optional human-readable name for the acquired browser session, used to find it
+              later in the dashboard. Must be unique among active sessions within the pool's
+              project. Applies to this lease only and is cleared when the browser is released
+              back to the pool.
+
+          tags: Optional user-defined key-value tags for the acquired browser session, used to
+              find and group sessions later. Applies to this lease only and are cleared when
+              the browser is released back to the pool. Up to 50 pairs.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -449,7 +461,11 @@ def acquire(
         return self._post(
             path_template("/browser_pools/{id_or_name}/acquire", id_or_name=id_or_name),
             body=maybe_transform(
-                {"acquire_timeout_seconds": acquire_timeout_seconds},
+                {
+                    "acquire_timeout_seconds": acquire_timeout_seconds,
+                    "name": name,
+                    "tags": tags,
+                },
                 browser_pool_acquire_params.BrowserPoolAcquireParams,
             ),
             options=make_request_options(
@@ -923,6 +939,8 @@ async def acquire(
         id_or_name: str,
         *,
         acquire_timeout_seconds: int | Omit = omit,
+        name: str | Omit = omit,
+        tags: TagsParam | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -942,6 +960,15 @@ async def acquire(
               calculated time it would take to fill the pool at the currently configured fill
               rate.
 
+          name: Optional human-readable name for the acquired browser session, used to find it
+              later in the dashboard. Must be unique among active sessions within the pool's
+              project. Applies to this lease only and is cleared when the browser is released
+              back to the pool.
+
+          tags: Optional user-defined key-value tags for the acquired browser session, used to
+              find and group sessions later. Applies to this lease only and are cleared when
+              the browser is released back to the pool. Up to 50 pairs.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -955,7 +982,11 @@ async def acquire(
         return await self._post(
             path_template("/browser_pools/{id_or_name}/acquire", id_or_name=id_or_name),
             body=await async_maybe_transform(
-                {"acquire_timeout_seconds": acquire_timeout_seconds},
+                {
+                    "acquire_timeout_seconds": acquire_timeout_seconds,
+                    "name": name,
+                    "tags": tags,
+                },
                 browser_pool_acquire_params.BrowserPoolAcquireParams,
             ),
             options=make_request_options(

src/kernel/types/browser_pool_acquire_params.py

@@ -4,6 +4,8 @@
 
 from typing_extensions import TypedDict
 
+from .tags_param import TagsParam
+
 __all__ = ["BrowserPoolAcquireParams"]
 
 
@@ -14,3 +16,18 @@ class BrowserPoolAcquireParams(TypedDict, total=False):
     Defaults to the calculated time it would take to fill the pool at the currently
     configured fill rate.
     """
+
+    name: str
+    """
+    Optional human-readable name for the acquired browser session, used to find it
+    later in the dashboard. Must be unique among active sessions within the pool's
+    project. Applies to this lease only and is cleared when the browser is released
+    back to the pool.
+    """
+
+    tags: TagsParam
+    """
+    Optional user-defined key-value tags for the acquired browser session, used to
+    find and group sessions later. Applies to this lease only and are cleared when
+    the browser is released back to the pool. Up to 50 pairs.
+    """

tests/api_resources/test_browser_pools.py

@@ -309,6 +309,11 @@ def test_method_acquire_with_all_params(self, client: Kernel) -> None:
         browser_pool = client.browser_pools.acquire(
             id_or_name="id_or_name",
             acquire_timeout_seconds=0,
+            name="checkout-flow-1",
+            tags={
+                "team": "backend",
+                "env": "staging",
+            },
         )
         assert_matches_type(BrowserPoolAcquireResponse, browser_pool, path=["response"])
 
@@ -738,6 +743,11 @@ async def test_method_acquire_with_all_params(self, async_client: AsyncKernel) -
         browser_pool = await async_client.browser_pools.acquire(
             id_or_name="id_or_name",
             acquire_timeout_seconds=0,
+            name="checkout-flow-1",
+            tags={
+                "team": "backend",
+                "env": "staging",
+            },
         )
         assert_matches_type(BrowserPoolAcquireResponse, browser_pool, path=["response"])