feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 6
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-d5cf52f21333b8216b73e9659b4a1e8e0675404f0ae3d15bdd7ef368ccfa94cf.yml
-openapi_spec_hash: c70cbc2e38e7aeaf2173574a13e9ca55
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-c921d60adf854da13dbb83d547cbd8a32fd86d625fb12a325b7d305da7f3a93a.yml
+openapi_spec_hash: c02b88f26faaf9fd04177b77d34fd5c3
 config_hash: 372b187172495fc2f76f05ba016b4a45

README.md

@@ -77,6 +77,39 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from brand.dev import BrandDev
+
+client = BrandDev()
+
+response = client.brand.ai_query(
+    data_to_extract=[
+        {
+            "datapoint_description": "datapoint_description",
+            "datapoint_example": "datapoint_example",
+            "datapoint_name": "datapoint_name",
+            "datapoint_type": "text",
+        }
+    ],
+    domain="domain",
+    specific_pages={
+        "about_us": True,
+        "blog": True,
+        "careers": True,
+        "contact_us": True,
+        "faq": True,
+        "home_page": True,
+        "privacy_policy": True,
+        "terms_and_conditions": True,
+    },
+)
+print(response.specific_pages)
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `brand.dev.APIConnectionError` is raised.

src/brand/dev/resources/brand.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable
+from typing import Iterable
 from typing_extensions import Literal
 
 import httpx
@@ -161,7 +161,7 @@ def ai_query(
         *,
         data_to_extract: Iterable[brand_ai_query_params.DataToExtract],
         domain: str,
-        specific_pages: List[str] | NotGiven = NOT_GIVEN,
+        specific_pages: brand_ai_query_params.SpecificPages | NotGiven = NOT_GIVEN,
         # 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,
@@ -180,7 +180,7 @@ def ai_query(
 
           domain: The domain name to analyze
 
-          specific_pages: Optional array of specific pages to analyze
+          specific_pages: Optional object specifying which pages to analyze
 
           extra_headers: Send extra headers
 
@@ -487,7 +487,7 @@ async def ai_query(
         *,
         data_to_extract: Iterable[brand_ai_query_params.DataToExtract],
         domain: str,
-        specific_pages: List[str] | NotGiven = NOT_GIVEN,
+        specific_pages: brand_ai_query_params.SpecificPages | NotGiven = NOT_GIVEN,
         # 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,
@@ -506,7 +506,7 @@ async def ai_query(
 
           domain: The domain name to analyze
 
-          specific_pages: Optional array of specific pages to analyze
+          specific_pages: Optional object specifying which pages to analyze
 
           extra_headers: Send extra headers
 

src/brand/dev/types/brand_ai_query_params.py

@@ -2,10 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable
+from typing import Iterable
 from typing_extensions import Literal, Required, TypedDict
 
-__all__ = ["BrandAIQueryParams", "DataToExtract"]
+__all__ = ["BrandAIQueryParams", "DataToExtract", "SpecificPages"]
 
 
 class BrandAIQueryParams(TypedDict, total=False):
@@ -15,8 +15,8 @@ class BrandAIQueryParams(TypedDict, total=False):
     domain: Required[str]
     """The domain name to analyze"""
 
-    specific_pages: List[str]
-    """Optional array of specific pages to analyze"""
+    specific_pages: SpecificPages
+    """Optional object specifying which pages to analyze"""
 
 
 class DataToExtract(TypedDict, total=False):
@@ -31,3 +31,29 @@ class DataToExtract(TypedDict, total=False):
 
     datapoint_type: Required[Literal["text", "number", "date", "boolean", "list", "url"]]
     """Type of the data point"""
+
+
+class SpecificPages(TypedDict, total=False):
+    about_us: bool
+    """Whether to analyze the about us page"""
+
+    blog: bool
+    """Whether to analyze the blog"""
+
+    careers: bool
+    """Whether to analyze the careers page"""
+
+    contact_us: bool
+    """Whether to analyze the contact us page"""
+
+    faq: bool
+    """Whether to analyze the FAQ page"""
+
+    home_page: bool
+    """Whether to analyze the home page"""
+
+    privacy_policy: bool
+    """Whether to analyze the privacy policy page"""
+
+    terms_and_conditions: bool
+    """Whether to analyze the terms and conditions page"""

tests/api_resources/test_brand.py

@@ -96,7 +96,16 @@ def test_method_ai_query_with_all_params(self, client: BrandDev) -> None:
                 }
             ],
             domain="domain",
-            specific_pages=["string"],
+            specific_pages={
+                "about_us": True,
+                "blog": True,
+                "careers": True,
+                "contact_us": True,
+                "faq": True,
+                "home_page": True,
+                "privacy_policy": True,
+                "terms_and_conditions": True,
+            },
         )
         assert_matches_type(BrandAIQueryResponse, brand, path=["response"])
 
@@ -354,7 +363,16 @@ async def test_method_ai_query_with_all_params(self, async_client: AsyncBrandDev
                 }
             ],
             domain="domain",
-            specific_pages=["string"],
+            specific_pages={
+                "about_us": True,
+                "blog": True,
+                "careers": True,
+                "contact_us": True,
+                "faq": True,
+                "home_page": True,
+                "privacy_policy": True,
+                "terms_and_conditions": True,
+            },
         )
         assert_matches_type(BrandAIQueryResponse, brand, path=["response"])