feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 40
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-c99300223257d60d7614e76585c62cfea40f43df0547db63c952b20c52f209f4.yml
-openapi_spec_hash: 1d4e473f3c566b7a1c3def11b6d84fe0
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-4f279e7b1f0a52f5c917d4256e17188dfe330ddf7495146e2b1611e812605fdc.yml
+openapi_spec_hash: 53a74c4cccbdec8590db38183840a446
 config_hash: 920678668dd2da6f8966fbf1b8fde4e2

src/context/dev/resources/brand.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Union, Optional
+from typing import List, Union, Optional
 from typing_extensions import Literal, overload
 
 import httpx
@@ -1278,7 +1278,10 @@ def search(
         self,
         *,
         query: str,
+        autocomplete: bool | Omit = omit,
+        query_by: List[Literal["name", "domain"]] | Omit = omit,
         tags: SequenceNotStr[str] | Omit = omit,
+        typo_tolerance: int | 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,
@@ -1287,23 +1290,25 @@ def search(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> BrandSearchResponse:
         """
-        Search brands by name or domain and get back up to 10 lightweight matches
-        (domain, name, logo). Name matches rank ahead of domain matches; within each
-        group the most popular brands come first: by Tranco rank, then market cap for
-        brands outside the Tranco list, with text relevance breaking ties. Matching is
-        prefix-based with no typo tolerance, so it is suited to autocomplete. Only
-        brands already in the Context.dev index are returned — use /brand/retrieve to
-        fetch (and index) a specific domain. Free on Pro and Scale plans; costs 1 credit
-        per request on the Free and Starter plans.
+        Search indexed brands by name or domain
 
         Args:
-          query: Search term, matched against brand names and domains by prefix (e.g. 'nike',
+          query: Search term, matched against the fields selected by queryBy (e.g. 'nike',
               'nike.com', 'nik').
 
+          autocomplete: Whether the search term matches by prefix, so partial words match as they are
+              typed (e.g. 'nik' matches Nike). Set to false to match whole words only.
+
+          query_by: Fields to match the search term against, as a comma-separated list or repeated
+              parameter: 'name', 'domain', or both. Defaults to both.
+
           tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
               recorded on the request's usage log and can be used to filter usage on the
               dashboard usage page. Up to 20 tags, each 1-50 characters.
 
+          typo_tolerance: Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
+              typo tolerance).
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1322,7 +1327,10 @@ def search(
                 query=maybe_transform(
                     {
                         "query": query,
+                        "autocomplete": autocomplete,
+                        "query_by": query_by,
                         "tags": tags,
+                        "typo_tolerance": typo_tolerance,
                     },
                     brand_search_params.BrandSearchParams,
                 ),
@@ -2583,7 +2591,10 @@ async def search(
         self,
         *,
         query: str,
+        autocomplete: bool | Omit = omit,
+        query_by: List[Literal["name", "domain"]] | Omit = omit,
         tags: SequenceNotStr[str] | Omit = omit,
+        typo_tolerance: int | 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,
@@ -2592,23 +2603,25 @@ async def search(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> BrandSearchResponse:
         """
-        Search brands by name or domain and get back up to 10 lightweight matches
-        (domain, name, logo). Name matches rank ahead of domain matches; within each
-        group the most popular brands come first: by Tranco rank, then market cap for
-        brands outside the Tranco list, with text relevance breaking ties. Matching is
-        prefix-based with no typo tolerance, so it is suited to autocomplete. Only
-        brands already in the Context.dev index are returned — use /brand/retrieve to
-        fetch (and index) a specific domain. Free on Pro and Scale plans; costs 1 credit
-        per request on the Free and Starter plans.
+        Search indexed brands by name or domain
 
         Args:
-          query: Search term, matched against brand names and domains by prefix (e.g. 'nike',
+          query: Search term, matched against the fields selected by queryBy (e.g. 'nike',
               'nike.com', 'nik').
 
+          autocomplete: Whether the search term matches by prefix, so partial words match as they are
+              typed (e.g. 'nik' matches Nike). Set to false to match whole words only.
+
+          query_by: Fields to match the search term against, as a comma-separated list or repeated
+              parameter: 'name', 'domain', or both. Defaults to both.
+
           tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
               recorded on the request's usage log and can be used to filter usage on the
               dashboard usage page. Up to 20 tags, each 1-50 characters.
 
+          typo_tolerance: Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
+              typo tolerance).
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -2627,7 +2640,10 @@ async def search(
                 query=await async_maybe_transform(
                     {
                         "query": query,
+                        "autocomplete": autocomplete,
+                        "query_by": query_by,
                         "tags": tags,
+                        "typo_tolerance": typo_tolerance,
                     },
                     brand_search_params.BrandSearchParams,
                 ),

src/context/dev/types/brand_search_params.py

@@ -2,23 +2,43 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import List
+from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._types import SequenceNotStr
+from .._utils import PropertyInfo
 
 __all__ = ["BrandSearchParams"]
 
 
 class BrandSearchParams(TypedDict, total=False):
     query: Required[str]
-    """Search term, matched against brand names and domains by prefix (e.g.
+    """Search term, matched against the fields selected by queryBy (e.g.
 
     'nike', 'nike.com', 'nik').
     """
 
+    autocomplete: bool
+    """
+    Whether the search term matches by prefix, so partial words match as they are
+    typed (e.g. 'nik' matches Nike). Set to false to match whole words only.
+    """
+
+    query_by: Annotated[List[Literal["name", "domain"]], PropertyInfo(alias="queryBy")]
+    """
+    Fields to match the search term against, as a comma-separated list or repeated
+    parameter: 'name', 'domain', or both. Defaults to both.
+    """
+
     tags: SequenceNotStr[str]
     """Optional comma-separated caller-defined tags for tracking this request.
 
     Tags are recorded on the request's usage log and can be used to filter usage on
     the dashboard usage page. Up to 20 tags, each 1-50 characters.
     """
+
+    typo_tolerance: Annotated[int, PropertyInfo(alias="typoTolerance")]
+    """Maximum number of typos tolerated when matching, from 0 to 2.
+
+    Defaults to 0 (no typo tolerance).
+    """

tests/api_resources/test_brand.py

@@ -389,7 +389,10 @@ def test_method_search(self, client: ContextDev) -> None:
     def test_method_search_with_all_params(self, client: ContextDev) -> None:
         brand = client.brand.search(
             query="x",
+            autocomplete=True,
+            query_by=["name"],
             tags=["production", "team-alpha"],
+            typo_tolerance=0,
         )
         assert_matches_type(BrandSearchResponse, brand, path=["response"])
 
@@ -793,7 +796,10 @@ async def test_method_search(self, async_client: AsyncContextDev) -> None:
     async def test_method_search_with_all_params(self, async_client: AsyncContextDev) -> None:
         brand = await async_client.brand.search(
             query="x",
+            autocomplete=True,
+            query_by=["name"],
             tags=["production", "team-alpha"],
+            typo_tolerance=0,
         )
         assert_matches_type(BrandSearchResponse, brand, path=["response"])