feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 22
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-44904c513baa439f294b23964ea368ad52863e13328980f9cac5a8e78cbb58cb.yml
-openapi_spec_hash: 9bb50ca838166fb474d28009a7edbd49
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-d880c25aee159e1260e23dfa3685b1bb9e35b02a1927adecbff32664ba8e11a4.yml
+openapi_spec_hash: aa96a6030390bca0b4cdfa2363961807
 config_hash: 70354330f92ce169beabc98696ebb9a3

README.md

@@ -130,11 +130,10 @@ from context.dev import ContextDev
 
 client = ContextDev()
 
-response = client.web.web_scrape_images(
-    url="https://example.com",
-    enrichment={},
+response = client.web.screenshot(
+    viewport={},
 )
-print(response.enrichment)
+print(response.viewport)
 ```
 
 ## Handling errors

src/context/dev/resources/web.py

@@ -180,8 +180,10 @@ def screenshot(
         direct_url: str | Omit = omit,
         domain: str | Omit = omit,
         full_screenshot: Literal["true", "false"] | Omit = omit,
+        max_age_ms: int | Omit = omit,
         page: Literal["login", "signup", "blog", "careers", "pricing", "terms", "privacy", "contact"] | Omit = omit,
         prioritize: Literal["speed", "quality"] | Omit = omit,
+        viewport: web_screenshot_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,
@@ -205,6 +207,10 @@ def screenshot(
               screenshot capturing all content. If 'false' or not provided, takes a viewport
               screenshot (standard browser view).
 
+          max_age_ms: Return a cached screenshot if a prior screenshot for the same parameters exists
+              and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
+              omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
+
           page: Optional parameter to specify which page type to screenshot. If provided, the
               system will scrape the domain's links and use heuristics to find the most
               appropriate URL for the specified page type (30 supported languages). If not
@@ -215,6 +221,8 @@ def screenshot(
               faster capture with basic quality. If 'quality', optimizes for higher quality
               with longer wait times. Defaults to 'quality' if not provided.
 
+          viewport: Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -235,8 +243,10 @@ def screenshot(
                         "direct_url": direct_url,
                         "domain": domain,
                         "full_screenshot": full_screenshot,
+                        "max_age_ms": max_age_ms,
                         "page": page,
                         "prioritize": prioritize,
+                        "viewport": viewport,
                     },
                     web_screenshot_params.WebScreenshotParams,
                 ),
@@ -719,8 +729,10 @@ async def screenshot(
         direct_url: str | Omit = omit,
         domain: str | Omit = omit,
         full_screenshot: Literal["true", "false"] | Omit = omit,
+        max_age_ms: int | Omit = omit,
         page: Literal["login", "signup", "blog", "careers", "pricing", "terms", "privacy", "contact"] | Omit = omit,
         prioritize: Literal["speed", "quality"] | Omit = omit,
+        viewport: web_screenshot_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,
@@ -744,6 +756,10 @@ async def screenshot(
               screenshot capturing all content. If 'false' or not provided, takes a viewport
               screenshot (standard browser view).
 
+          max_age_ms: Return a cached screenshot if a prior screenshot for the same parameters exists
+              and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
+              omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
+
           page: Optional parameter to specify which page type to screenshot. If provided, the
               system will scrape the domain's links and use heuristics to find the most
               appropriate URL for the specified page type (30 supported languages). If not
@@ -754,6 +770,8 @@ async def screenshot(
               faster capture with basic quality. If 'quality', optimizes for higher quality
               with longer wait times. Defaults to 'quality' if not provided.
 
+          viewport: Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -774,8 +792,10 @@ async def screenshot(
                         "direct_url": direct_url,
                         "domain": domain,
                         "full_screenshot": full_screenshot,
+                        "max_age_ms": max_age_ms,
                         "page": page,
                         "prioritize": prioritize,
+                        "viewport": viewport,
                     },
                     web_screenshot_params.WebScreenshotParams,
                 ),

src/context/dev/types/web_screenshot_params.py

@@ -6,7 +6,7 @@
 
 from .._utils import PropertyInfo
 
-__all__ = ["WebScreenshotParams"]
+__all__ = ["WebScreenshotParams", "Viewport"]
 
 
 class WebScreenshotParams(TypedDict, total=False):
@@ -31,6 +31,13 @@ class WebScreenshotParams(TypedDict, total=False):
     provided, takes a viewport screenshot (standard browser view).
     """
 
+    max_age_ms: Annotated[int, PropertyInfo(alias="maxAgeMs")]
+    """
+    Return a cached screenshot if a prior screenshot for the same parameters exists
+    and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
+    omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
+    """
+
     page: Literal["login", "signup", "blog", "careers", "pricing", "terms", "privacy", "contact"]
     """Optional parameter to specify which page type to screenshot.
 
@@ -47,3 +54,16 @@ class WebScreenshotParams(TypedDict, total=False):
     optimizes for higher quality with longer wait times. Defaults to 'quality' if
     not provided.
     """
+
+    viewport: Viewport
+    """Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080."""
+
+
+class Viewport(TypedDict, total=False):
+    """Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080."""
+
+    height: int
+    """Viewport height in pixels."""
+
+    width: int
+    """Viewport width in pixels."""

src/context/dev/types/web_screenshot_response.py

@@ -17,6 +17,9 @@ class WebScreenshotResponse(BaseModel):
     domain: Optional[str] = None
     """The normalized domain that was processed"""
 
+    height: Optional[int] = None
+    """Height in pixels of the returned screenshot image"""
+
     screenshot: Optional[str] = None
     """Public URL of the uploaded screenshot image"""
 
@@ -25,3 +28,6 @@ class WebScreenshotResponse(BaseModel):
 
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""
+
+    width: Optional[int] = None
+    """Width in pixels of the returned screenshot image"""

tests/api_resources/test_web.py

@@ -115,8 +115,13 @@ def test_method_screenshot_with_all_params(self, client: ContextDev) -> None:
             direct_url="https://example.com",
             domain="domain",
             full_screenshot="true",
+            max_age_ms=0,
             page="login",
             prioritize="speed",
+            viewport={
+                "height": 240,
+                "width": 240,
+            },
         )
         assert_matches_type(WebScreenshotResponse, web, path=["response"])
 
@@ -477,8 +482,13 @@ async def test_method_screenshot_with_all_params(self, async_client: AsyncContex
             direct_url="https://example.com",
             domain="domain",
             full_screenshot="true",
+            max_age_ms=0,
             page="login",
             prioritize="speed",
+            viewport={
+                "height": 240,
+                "width": 240,
+            },
         )
         assert_matches_type(WebScreenshotResponse, web, path=["response"])