feat: WIP: Configurable Viewport

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 57
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-592ab7a96084f7241d77b4cc1ce2a074795b0dc40d8247e1a0129fe3f89c1ed4.yml
-openapi_spec_hash: 3a23b4c9c05946251be45c5c4e7a415d
-config_hash: 15cd063f8e308686ac71bf9ee9634625
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-1cd328ccf61f0e888d6df27b091c30b38c392ab9ca8ce7fd0ead8f10aaf71ffa.yml
+openapi_spec_hash: af761c48d1955f11822f3b95f9c46750
+config_hash: deadfc4d2b0a947673bcf559b5db6e1b

api.md

@@ -82,7 +82,7 @@ Methods:
 - <code title="get /browsers">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">list</a>() -> <a href="./src/kernel/types/browser_list_response.py">BrowserListResponse</a></code>
 - <code title="delete /browsers">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">delete</a>(\*\*<a href="src/kernel/types/browser_delete_params.py">params</a>) -> None</code>
 - <code title="delete /browsers/{id}">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">delete_by_id</a>(id) -> None</code>
-- <code title="post /browsers/{id}/extensions">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">upload_extensions</a>(id, \*\*<a href="src/kernel/types/browser_upload_extensions_params.py">params</a>) -> None</code>
+- <code title="post /browsers/{id}/extensions">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">load_extensions</a>(id, \*\*<a href="src/kernel/types/browser_load_extensions_params.py">params</a>) -> None</code>
 
 ## Replays
 

src/kernel/resources/browsers/browsers.py

@@ -22,7 +22,7 @@
     FsResourceWithStreamingResponse,
     AsyncFsResourceWithStreamingResponse,
 )
-from ...types import browser_create_params, browser_delete_params, browser_upload_extensions_params
+from ...types import browser_create_params, browser_delete_params, browser_load_extensions_params
 from .process import (
     ProcessResource,
     AsyncProcessResource,
@@ -105,6 +105,7 @@ def create(
         proxy_id: str | Omit = omit,
         stealth: bool | Omit = omit,
         timeout_seconds: int | Omit = omit,
+        viewport: browser_create_params.Viewport | 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,
@@ -142,6 +143,15 @@ def create(
               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
+              configurations are supported. The server will reject unsupported combinations.
+              Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+              1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+              automatically determined from the width and height if they match a supported
+              configuration exactly. Note: Higher resolutions may affect the responsiveness of
+              live view browser
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -162,6 +172,7 @@ def create(
                     "proxy_id": proxy_id,
                     "stealth": stealth,
                     "timeout_seconds": timeout_seconds,
+                    "viewport": viewport,
                 },
                 browser_create_params.BrowserCreateParams,
             ),
@@ -295,11 +306,11 @@ def delete_by_id(
             cast_to=NoneType,
         )
 
-    def upload_extensions(
+    def load_extensions(
         self,
         id: str,
         *,
-        extensions: Iterable[browser_upload_extensions_params.Extension],
+        extensions: Iterable[browser_load_extensions_params.Extension],
         # 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,
@@ -333,7 +344,7 @@ def upload_extensions(
         extra_headers["Content-Type"] = "multipart/form-data"
         return self._post(
             f"/browsers/{id}/extensions",
-            body=maybe_transform(body, browser_upload_extensions_params.BrowserUploadExtensionsParams),
+            body=maybe_transform(body, browser_load_extensions_params.BrowserLoadExtensionsParams),
             files=files,
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -389,6 +400,7 @@ async def create(
         proxy_id: str | Omit = omit,
         stealth: bool | Omit = omit,
         timeout_seconds: int | Omit = omit,
+        viewport: browser_create_params.Viewport | 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,
@@ -426,6 +438,15 @@ async def create(
               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
+              configurations are supported. The server will reject unsupported combinations.
+              Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+              1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+              automatically determined from the width and height if they match a supported
+              configuration exactly. Note: Higher resolutions may affect the responsiveness of
+              live view browser
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -446,6 +467,7 @@ async def create(
                     "proxy_id": proxy_id,
                     "stealth": stealth,
                     "timeout_seconds": timeout_seconds,
+                    "viewport": viewport,
                 },
                 browser_create_params.BrowserCreateParams,
             ),
@@ -581,11 +603,11 @@ async def delete_by_id(
             cast_to=NoneType,
         )
 
-    async def upload_extensions(
+    async def load_extensions(
         self,
         id: str,
         *,
-        extensions: Iterable[browser_upload_extensions_params.Extension],
+        extensions: Iterable[browser_load_extensions_params.Extension],
         # 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,
@@ -619,7 +641,7 @@ async def upload_extensions(
         extra_headers["Content-Type"] = "multipart/form-data"
         return await self._post(
             f"/browsers/{id}/extensions",
-            body=await async_maybe_transform(body, browser_upload_extensions_params.BrowserUploadExtensionsParams),
+            body=await async_maybe_transform(body, browser_load_extensions_params.BrowserLoadExtensionsParams),
             files=files,
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -647,8 +669,8 @@ def __init__(self, browsers: BrowsersResource) -> None:
         self.delete_by_id = to_raw_response_wrapper(
             browsers.delete_by_id,
         )
-        self.upload_extensions = to_raw_response_wrapper(
-            browsers.upload_extensions,
+        self.load_extensions = to_raw_response_wrapper(
+            browsers.load_extensions,
         )
 
     @cached_property
@@ -687,8 +709,8 @@ def __init__(self, browsers: AsyncBrowsersResource) -> None:
         self.delete_by_id = async_to_raw_response_wrapper(
             browsers.delete_by_id,
         )
-        self.upload_extensions = async_to_raw_response_wrapper(
-            browsers.upload_extensions,
+        self.load_extensions = async_to_raw_response_wrapper(
+            browsers.load_extensions,
         )
 
     @cached_property
@@ -727,8 +749,8 @@ def __init__(self, browsers: BrowsersResource) -> None:
         self.delete_by_id = to_streamed_response_wrapper(
             browsers.delete_by_id,
         )
-        self.upload_extensions = to_streamed_response_wrapper(
-            browsers.upload_extensions,
+        self.load_extensions = to_streamed_response_wrapper(
+            browsers.load_extensions,
         )
 
     @cached_property
@@ -767,8 +789,8 @@ def __init__(self, browsers: AsyncBrowsersResource) -> None:
         self.delete_by_id = async_to_streamed_response_wrapper(
             browsers.delete_by_id,
         )
-        self.upload_extensions = async_to_streamed_response_wrapper(
-            browsers.upload_extensions,
+        self.load_extensions = async_to_streamed_response_wrapper(
+            browsers.load_extensions,
         )
 
     @cached_property

src/kernel/types/__init__.py

@@ -47,7 +47,7 @@
 from .invocation_update_response import InvocationUpdateResponse as InvocationUpdateResponse
 from .deployment_retrieve_response import DeploymentRetrieveResponse as DeploymentRetrieveResponse
 from .invocation_retrieve_response import InvocationRetrieveResponse as InvocationRetrieveResponse
-from .browser_upload_extensions_params import BrowserUploadExtensionsParams as BrowserUploadExtensionsParams
+from .browser_load_extensions_params import BrowserLoadExtensionsParams as BrowserLoadExtensionsParams
 from .extension_download_from_chrome_store_params import (
     ExtensionDownloadFromChromeStoreParams as ExtensionDownloadFromChromeStoreParams,
 )

src/kernel/types/browser_create_params.py

@@ -3,11 +3,11 @@
 from __future__ import annotations
 
 from typing import Iterable
-from typing_extensions import TypedDict
+from typing_extensions import Required, TypedDict
 
 from .browser_persistence_param import BrowserPersistenceParam
 
-__all__ = ["BrowserCreateParams", "Extension", "Profile"]
+__all__ = ["BrowserCreateParams", "Extension", "Profile", "Viewport"]
 
 
 class BrowserCreateParams(TypedDict, total=False):
@@ -58,6 +58,18 @@ class BrowserCreateParams(TypedDict, total=False):
     specified value.
     """
 
+    viewport: Viewport
+    """Initial browser window size in pixels with optional refresh rate.
+
+    If omitted, image defaults apply (commonly 1024x768@60). Only specific viewport
+    configurations are supported. The server will reject unsupported combinations.
+    Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+    1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+    automatically determined from the width and height if they match a supported
+    configuration exactly. Note: Higher resolutions may affect the responsiveness of
+    live view browser
+    """
+
 
 class Extension(TypedDict, total=False):
     id: str
@@ -85,3 +97,17 @@ class Profile(TypedDict, total=False):
     If true, save changes made during the session back to the profile when the
     session ends.
     """
+
+
+class Viewport(TypedDict, total=False):
+    height: Required[int]
+    """Browser window height in pixels."""
+
+    width: Required[int]
+    """Browser window width in pixels."""
+
+    refresh_rate: int
+    """Display refresh rate in Hz.
+
+    If omitted, automatically determined from width and height.
+    """

src/kernel/types/browser_create_response.py

@@ -7,7 +7,21 @@
 from .._models import BaseModel
 from .browser_persistence import BrowserPersistence
 
-__all__ = ["BrowserCreateResponse"]
+__all__ = ["BrowserCreateResponse", "Viewport"]
+
+
+class Viewport(BaseModel):
+    height: int
+    """Browser window height in pixels."""
+
+    width: int
+    """Browser window width in pixels."""
+
+    refresh_rate: Optional[int] = None
+    """Display refresh rate in Hz.
+
+    If omitted, automatically determined from width and height.
+    """
 
 
 class BrowserCreateResponse(BaseModel):
@@ -43,3 +57,15 @@ class BrowserCreateResponse(BaseModel):
 
     proxy_id: Optional[str] = None
     """ID of the proxy associated with this browser session, if any."""
+
+    viewport: Optional[Viewport] = None
+    """Initial browser window size in pixels with optional refresh rate.
+
+    If omitted, image defaults apply (commonly 1024x768@60). Only specific viewport
+    configurations are supported. The server will reject unsupported combinations.
+    Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+    1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+    automatically determined from the width and height if they match a supported
+    configuration exactly. Note: Higher resolutions may affect the responsiveness of
+    live view browser
+    """

src/kernel/types/browser_list_response.py

@@ -8,7 +8,21 @@
 from .._models import BaseModel
 from .browser_persistence import BrowserPersistence
 
-__all__ = ["BrowserListResponse", "BrowserListResponseItem"]
+__all__ = ["BrowserListResponse", "BrowserListResponseItem", "BrowserListResponseItemViewport"]
+
+
+class BrowserListResponseItemViewport(BaseModel):
+    height: int
+    """Browser window height in pixels."""
+
+    width: int
+    """Browser window width in pixels."""
+
+    refresh_rate: Optional[int] = None
+    """Display refresh rate in Hz.
+
+    If omitted, automatically determined from width and height.
+    """
 
 
 class BrowserListResponseItem(BaseModel):
@@ -45,5 +59,17 @@ class BrowserListResponseItem(BaseModel):
     proxy_id: Optional[str] = None
     """ID of the proxy associated with this browser session, if any."""
 
+    viewport: Optional[BrowserListResponseItemViewport] = None
+    """Initial browser window size in pixels with optional refresh rate.
+
+    If omitted, image defaults apply (commonly 1024x768@60). Only specific viewport
+    configurations are supported. The server will reject unsupported combinations.
+    Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+    1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+    automatically determined from the width and height if they match a supported
+    configuration exactly. Note: Higher resolutions may affect the responsiveness of
+    live view browser
+    """
+
 
 BrowserListResponse: TypeAlias = List[BrowserListResponseItem]

src/kernel/types/browser_upload_extensions_params.py renamed to src/kernel/types/browser_load_extensions_params.py

@@ -7,10 +7,10 @@
 
 from .._types import FileTypes
 
-__all__ = ["BrowserUploadExtensionsParams", "Extension"]
+__all__ = ["BrowserLoadExtensionsParams", "Extension"]
 
 
-class BrowserUploadExtensionsParams(TypedDict, total=False):
+class BrowserLoadExtensionsParams(TypedDict, total=False):
     extensions: Required[Iterable[Extension]]
     """List of extensions to upload and activate"""
 

src/kernel/types/browser_retrieve_response.py

@@ -7,7 +7,21 @@
 from .._models import BaseModel
 from .browser_persistence import BrowserPersistence
 
-__all__ = ["BrowserRetrieveResponse"]
+__all__ = ["BrowserRetrieveResponse", "Viewport"]
+
+
+class Viewport(BaseModel):
+    height: int
+    """Browser window height in pixels."""
+
+    width: int
+    """Browser window width in pixels."""
+
+    refresh_rate: Optional[int] = None
+    """Display refresh rate in Hz.
+
+    If omitted, automatically determined from width and height.
+    """
 
 
 class BrowserRetrieveResponse(BaseModel):
@@ -43,3 +57,15 @@ class BrowserRetrieveResponse(BaseModel):
 
     proxy_id: Optional[str] = None
     """ID of the proxy associated with this browser session, if any."""
+
+    viewport: Optional[Viewport] = None
+    """Initial browser window size in pixels with optional refresh rate.
+
+    If omitted, image defaults apply (commonly 1024x768@60). Only specific viewport
+    configurations are supported. The server will reject unsupported combinations.
+    Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+    1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
+    automatically determined from the width and height if they match a supported
+    configuration exactly. Note: Higher resolutions may affect the responsiveness of
+    live view browser
+    """