Merge pull request #37 from brand-dot-dev/release-please--branches--main--changes--next

release: 1.31.0

Author: YahiaBakour

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.30.0"
+  ".": "1.31.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 15
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-73562e26b663cf10185b9e98966accf5f151c6d3cf99b5e060ce5a847045e383.yml
-openapi_spec_hash: bf5994966b84f9dda998ad5059ff8318
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-10f7ae53f4fe4f2394c22788b648d9db742a178ed41a87beb39de741660e646b.yml
+openapi_spec_hash: 9885c47a02677471a38f16dddbad1823
 config_hash: 6f10592c7d0c3bafefc1271472283217

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.31.0 (2026-02-07)
+
+Full Changelog: [v1.30.0...v1.31.0](https://github.com/brand-dot-dev/python-sdk/compare/v1.30.0...v1.31.0)
+
+### Features
+
+* **api:** api update ([09fa73a](https://github.com/brand-dot-dev/python-sdk/commit/09fa73a99432c4a131bba9d924d38f12a9537e51))
+
 ## 1.30.0 (2026-02-07)
 
 Full Changelog: [v1.29.0...v1.30.0](https://github.com/brand-dot-dev/python-sdk/compare/v1.29.0...v1.30.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "brand.dev"
-version = "1.30.0"
+version = "1.31.0"
 description = "The official Python library for the brand.dev API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/brand/dev/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "brand.dev"
-__version__ = "1.30.0"  # x-release-please-version
+__version__ = "1.31.0"  # x-release-please-version

src/brand/dev/resources/brand.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from typing import Iterable
-from typing_extensions import Literal
+from typing_extensions import Literal, overload
 
 import httpx
 
@@ -25,7 +25,7 @@
     brand_identify_from_transaction_params,
 )
 from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
-from .._utils import maybe_transform, async_maybe_transform
+from .._utils import required_args, maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
 from .._response import (
@@ -189,11 +189,11 @@ def retrieve(
             cast_to=BrandRetrieveResponse,
         )
 
+    @overload
     def ai_products(
         self,
         *,
-        direct_url: str | Omit = omit,
-        domain: str | Omit = omit,
+        domain: str,
         max_products: int | Omit = omit,
         timeout_ms: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -210,19 +210,51 @@ def ai_products(
         description, image, pricing, features, and more.
 
         Args:
-          direct_url: A specific URL to use directly as the starting point for extraction without
-              domain resolution. Useful when you want to extract products from a specific page
-              rather than discovering the site's product pages automatically. Either 'domain'
-              or 'directUrl' must be provided, but not both.
+          domain: The domain name to analyze.
+
+          max_products: Maximum number of products to extract.
+
+          timeout_ms: Optional timeout in milliseconds for the request. Maximum allowed value is
+              300000ms (5 minutes).
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        ...
+
+    @overload
+    def ai_products(
+        self,
+        *,
+        direct_url: str,
+        max_products: int | Omit = omit,
+        timeout_ms: 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> BrandAIProductsResponse:
+        """Beta feature: Extract product information from a brand's website.
 
-          domain: The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
-              not both.
+        Brand.dev will
+        analyze the website and return a list of products with details such as name,
+        description, image, pricing, features, and more.
+
+        Args:
+          direct_url: A specific URL to use directly as the starting point for extraction without
+              domain resolution.
 
           max_products: Maximum number of products to extract.
 
-          timeout_ms: Optional timeout in milliseconds for the request. If the request takes longer
-              than this value, it will be aborted with a 408 status code. Maximum allowed
-              value is 300000ms (5 minutes).
+          timeout_ms: Optional timeout in milliseconds for the request. Maximum allowed value is
+              300000ms (5 minutes).
 
           extra_headers: Send extra headers
 
@@ -232,14 +264,31 @@ def ai_products(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
+        ...
+
+    @required_args(["domain"], ["direct_url"])
+    def ai_products(
+        self,
+        *,
+        domain: str | Omit = omit,
+        max_products: int | Omit = omit,
+        timeout_ms: int | Omit = omit,
+        direct_url: str | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> BrandAIProductsResponse:
         return self._post(
             "/brand/ai/products",
             body=maybe_transform(
                 {
-                    "direct_url": direct_url,
                     "domain": domain,
                     "max_products": max_products,
                     "timeout_ms": timeout_ms,
+                    "direct_url": direct_url,
                 },
                 brand_ai_products_params.BrandAIProductsParams,
             ),
@@ -1736,11 +1785,11 @@ async def retrieve(
             cast_to=BrandRetrieveResponse,
         )
 
+    @overload
     async def ai_products(
         self,
         *,
-        direct_url: str | Omit = omit,
-        domain: str | Omit = omit,
+        domain: str,
         max_products: int | Omit = omit,
         timeout_ms: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -1757,19 +1806,51 @@ async def ai_products(
         description, image, pricing, features, and more.
 
         Args:
-          direct_url: A specific URL to use directly as the starting point for extraction without
-              domain resolution. Useful when you want to extract products from a specific page
-              rather than discovering the site's product pages automatically. Either 'domain'
-              or 'directUrl' must be provided, but not both.
+          domain: The domain name to analyze.
+
+          max_products: Maximum number of products to extract.
+
+          timeout_ms: Optional timeout in milliseconds for the request. Maximum allowed value is
+              300000ms (5 minutes).
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        ...
+
+    @overload
+    async def ai_products(
+        self,
+        *,
+        direct_url: str,
+        max_products: int | Omit = omit,
+        timeout_ms: 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> BrandAIProductsResponse:
+        """Beta feature: Extract product information from a brand's website.
 
-          domain: The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
-              not both.
+        Brand.dev will
+        analyze the website and return a list of products with details such as name,
+        description, image, pricing, features, and more.
+
+        Args:
+          direct_url: A specific URL to use directly as the starting point for extraction without
+              domain resolution.
 
           max_products: Maximum number of products to extract.
 
-          timeout_ms: Optional timeout in milliseconds for the request. If the request takes longer
-              than this value, it will be aborted with a 408 status code. Maximum allowed
-              value is 300000ms (5 minutes).
+          timeout_ms: Optional timeout in milliseconds for the request. Maximum allowed value is
+              300000ms (5 minutes).
 
           extra_headers: Send extra headers
 
@@ -1779,14 +1860,31 @@ async def ai_products(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
+        ...
+
+    @required_args(["domain"], ["direct_url"])
+    async def ai_products(
+        self,
+        *,
+        domain: str | Omit = omit,
+        max_products: int | Omit = omit,
+        timeout_ms: int | Omit = omit,
+        direct_url: str | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> BrandAIProductsResponse:
         return await self._post(
             "/brand/ai/products",
             body=await async_maybe_transform(
                 {
-                    "direct_url": direct_url,
                     "domain": domain,
                     "max_products": max_products,
                     "timeout_ms": timeout_ms,
+                    "direct_url": direct_url,
                 },
                 brand_ai_products_params.BrandAIProductsParams,
             ),

src/brand/dev/types/brand_ai_products_params.py

@@ -2,26 +2,33 @@
 
 from __future__ import annotations
 
-from typing_extensions import Annotated, TypedDict
+from typing import Union
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
 
 from .._utils import PropertyInfo
 
-__all__ = ["BrandAIProductsParams"]
+__all__ = ["BrandAIProductsParams", "ByDomain", "ByDirectURL"]
 
 
-class BrandAIProductsParams(TypedDict, total=False):
-    direct_url: Annotated[str, PropertyInfo(alias="directUrl")]
-    """
-    A specific URL to use directly as the starting point for extraction without
-    domain resolution. Useful when you want to extract products from a specific page
-    rather than discovering the site's product pages automatically. Either 'domain'
-    or 'directUrl' must be provided, but not both.
+class ByDomain(TypedDict, total=False):
+    domain: Required[str]
+    """The domain name to analyze."""
+
+    max_products: Annotated[int, PropertyInfo(alias="maxProducts")]
+    """Maximum number of products to extract."""
+
+    timeout_ms: Annotated[int, PropertyInfo(alias="timeoutMS")]
+    """Optional timeout in milliseconds for the request.
+
+    Maximum allowed value is 300000ms (5 minutes).
     """
 
-    domain: str
-    """The domain name to analyze.
 
-    Either 'domain' or 'directUrl' must be provided, but not both.
+class ByDirectURL(TypedDict, total=False):
+    direct_url: Required[Annotated[str, PropertyInfo(alias="directUrl")]]
+    """
+    A specific URL to use directly as the starting point for extraction without
+    domain resolution.
     """
 
     max_products: Annotated[int, PropertyInfo(alias="maxProducts")]
@@ -30,6 +37,8 @@ class BrandAIProductsParams(TypedDict, total=False):
     timeout_ms: Annotated[int, PropertyInfo(alias="timeoutMS")]
     """Optional timeout in milliseconds for the request.
 
-    If the request takes longer than this value, it will be aborted with a 408
-    status code. Maximum allowed value is 300000ms (5 minutes).
+    Maximum allowed value is 300000ms (5 minutes).
     """
+
+
+BrandAIProductsParams: TypeAlias = Union[ByDomain, ByDirectURL]