feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 20
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-f2509d0b758e88572e5a8145b8296cb330154727d9797e615ad19e44e050af26.yml
-openapi_spec_hash: 40640a033ee09bda79ec066ba3744206
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-905e35387d755a84a2e7cd711f31eeea130e08a83bb7b39d3fa5445a187ef62f.yml
+openapi_spec_hash: 205b2c17cb40ad54d76c2c06c9e5dda4
 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011

src/brand/dev/resources/brand.py

@@ -2244,7 +2244,8 @@ def retrieve_simplified(
     def screenshot(
         self,
         *,
-        domain: str,
+        direct_url: str | Omit = omit,
+        domain: str | Omit = omit,
         full_screenshot: Literal["true", "false"] | Omit = omit,
         page: Literal["login", "signup", "blog", "careers", "pricing", "terms", "privacy", "contact"] | Omit = omit,
         prioritize: Literal["speed", "quality"] | Omit = omit,
@@ -2259,10 +2260,15 @@ def screenshot(
 
         Supports both viewport (standard browser
         view) and full-page screenshots. Can also screenshot specific page types (login,
-        pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
-        the uploaded screenshot image hosted on our CDN.
+        pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain'
+        or 'directUrl' must be provided as a query parameter, but not both. Returns a
+        URL to the uploaded screenshot image hosted on our CDN.
 
         Args:
+          direct_url: A specific URL to screenshot directly, bypassing domain resolution (e.g.,
+              'https://example.com/pricing'). When provided, the screenshot is taken of this
+              exact URL.
+
           domain: Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
               domain will be automatically normalized and validated.
 
@@ -2273,7 +2279,8 @@ def screenshot(
           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
-              provided, screenshots the main domain landing page.
+              provided, screenshots the main domain landing page. Only applicable when using
+              'domain', not 'directUrl'.
 
           prioritize: Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
               faster capture with basic quality. If 'quality', optimizes for higher quality
@@ -2296,6 +2303,7 @@ def screenshot(
                 timeout=timeout,
                 query=maybe_transform(
                     {
+                        "direct_url": direct_url,
                         "domain": domain,
                         "full_screenshot": full_screenshot,
                         "page": page,
@@ -4733,7 +4741,8 @@ async def retrieve_simplified(
     async def screenshot(
         self,
         *,
-        domain: str,
+        direct_url: str | Omit = omit,
+        domain: str | Omit = omit,
         full_screenshot: Literal["true", "false"] | Omit = omit,
         page: Literal["login", "signup", "blog", "careers", "pricing", "terms", "privacy", "contact"] | Omit = omit,
         prioritize: Literal["speed", "quality"] | Omit = omit,
@@ -4748,10 +4757,15 @@ async def screenshot(
 
         Supports both viewport (standard browser
         view) and full-page screenshots. Can also screenshot specific page types (login,
-        pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
-        the uploaded screenshot image hosted on our CDN.
+        pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain'
+        or 'directUrl' must be provided as a query parameter, but not both. Returns a
+        URL to the uploaded screenshot image hosted on our CDN.
 
         Args:
+          direct_url: A specific URL to screenshot directly, bypassing domain resolution (e.g.,
+              'https://example.com/pricing'). When provided, the screenshot is taken of this
+              exact URL.
+
           domain: Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
               domain will be automatically normalized and validated.
 
@@ -4762,7 +4776,8 @@ async def screenshot(
           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
-              provided, screenshots the main domain landing page.
+              provided, screenshots the main domain landing page. Only applicable when using
+              'domain', not 'directUrl'.
 
           prioritize: Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
               faster capture with basic quality. If 'quality', optimizes for higher quality
@@ -4785,6 +4800,7 @@ async def screenshot(
                 timeout=timeout,
                 query=await async_maybe_transform(
                     {
+                        "direct_url": direct_url,
                         "domain": domain,
                         "full_screenshot": full_screenshot,
                         "page": page,

src/brand/dev/types/brand_screenshot_params.py

@@ -2,15 +2,22 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Annotated, TypedDict
 
 from .._utils import PropertyInfo
 
 __all__ = ["BrandScreenshotParams"]
 
 
 class BrandScreenshotParams(TypedDict, total=False):
-    domain: Required[str]
+    direct_url: Annotated[str, PropertyInfo(alias="directUrl")]
+    """
+    A specific URL to screenshot directly, bypassing domain resolution (e.g.,
+    'https://example.com/pricing'). When provided, the screenshot is taken of this
+    exact URL.
+    """
+
+    domain: str
     """Domain name to take screenshot of (e.g., 'example.com', 'google.com').
 
     The domain will be automatically normalized and validated.
@@ -28,7 +35,8 @@ class BrandScreenshotParams(TypedDict, total=False):
 
     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 provided, screenshots the main domain landing page.
+    languages). If not provided, screenshots the main domain landing page. Only
+    applicable when using 'domain', not 'directUrl'.
     """
 
     prioritize: Literal["speed", "quality"]

tests/api_resources/test_brand.py

@@ -757,15 +757,14 @@ def test_streaming_response_retrieve_simplified(self, client: BrandDev) -> None:
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     def test_method_screenshot(self, client: BrandDev) -> None:
-        brand = client.brand.screenshot(
-            domain="domain",
-        )
+        brand = client.brand.screenshot()
         assert_matches_type(BrandScreenshotResponse, brand, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     def test_method_screenshot_with_all_params(self, client: BrandDev) -> None:
         brand = client.brand.screenshot(
+            direct_url="https://example.com",
             domain="domain",
             full_screenshot="true",
             page="login",
@@ -776,9 +775,7 @@ def test_method_screenshot_with_all_params(self, client: BrandDev) -> None:
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     def test_raw_response_screenshot(self, client: BrandDev) -> None:
-        response = client.brand.with_raw_response.screenshot(
-            domain="domain",
-        )
+        response = client.brand.with_raw_response.screenshot()
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -788,9 +785,7 @@ def test_raw_response_screenshot(self, client: BrandDev) -> None:
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     def test_streaming_response_screenshot(self, client: BrandDev) -> None:
-        with client.brand.with_streaming_response.screenshot(
-            domain="domain",
-        ) as response:
+        with client.brand.with_streaming_response.screenshot() as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
@@ -1719,15 +1714,14 @@ async def test_streaming_response_retrieve_simplified(self, async_client: AsyncB
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     async def test_method_screenshot(self, async_client: AsyncBrandDev) -> None:
-        brand = await async_client.brand.screenshot(
-            domain="domain",
-        )
+        brand = await async_client.brand.screenshot()
         assert_matches_type(BrandScreenshotResponse, brand, path=["response"])
 
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     async def test_method_screenshot_with_all_params(self, async_client: AsyncBrandDev) -> None:
         brand = await async_client.brand.screenshot(
+            direct_url="https://example.com",
             domain="domain",
             full_screenshot="true",
             page="login",
@@ -1738,9 +1732,7 @@ async def test_method_screenshot_with_all_params(self, async_client: AsyncBrandD
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     async def test_raw_response_screenshot(self, async_client: AsyncBrandDev) -> None:
-        response = await async_client.brand.with_raw_response.screenshot(
-            domain="domain",
-        )
+        response = await async_client.brand.with_raw_response.screenshot()
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -1750,9 +1742,7 @@ async def test_raw_response_screenshot(self, async_client: AsyncBrandDev) -> Non
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     async def test_streaming_response_screenshot(self, async_client: AsyncBrandDev) -> None:
-        async with async_client.brand.with_streaming_response.screenshot(
-            domain="domain",
-        ) as response:
+        async with async_client.brand.with_streaming_response.screenshot() as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"