feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 13
+configured_endpoints: 14
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-1391c1e69bcdce517f71265a2f22f4e8d35c3f12a224899e64f85e25897b743a.yml
 openapi_spec_hash: f8a2917cc425300d272ae943f88d7bb7
-config_hash: 6aaf0fe6f8877c9c5d9af95597123cb4
+config_hash: 7f48d078645cb8331328bcd6f6ab3281

api.md

@@ -9,6 +9,7 @@ from brand.dev.types import (
     BrandFontsResponse,
     BrandIdentifyFromTransactionResponse,
     BrandPrefetchResponse,
+    BrandPrefetchByEmailResponse,
     BrandRetrieveByEmailResponse,
     BrandRetrieveByIsinResponse,
     BrandRetrieveByNameResponse,
@@ -27,6 +28,7 @@ Methods:
 - <code title="get /brand/fonts">client.brand.<a href="./src/brand/dev/resources/brand.py">fonts</a>(\*\*<a href="src/brand/dev/types/brand_fonts_params.py">params</a>) -> <a href="./src/brand/dev/types/brand_fonts_response.py">BrandFontsResponse</a></code>
 - <code title="get /brand/transaction_identifier">client.brand.<a href="./src/brand/dev/resources/brand.py">identify_from_transaction</a>(\*\*<a href="src/brand/dev/types/brand_identify_from_transaction_params.py">params</a>) -> <a href="./src/brand/dev/types/brand_identify_from_transaction_response.py">BrandIdentifyFromTransactionResponse</a></code>
 - <code title="post /brand/prefetch">client.brand.<a href="./src/brand/dev/resources/brand.py">prefetch</a>(\*\*<a href="src/brand/dev/types/brand_prefetch_params.py">params</a>) -> <a href="./src/brand/dev/types/brand_prefetch_response.py">BrandPrefetchResponse</a></code>
+- <code title="post /brand/prefetch-by-email">client.brand.<a href="./src/brand/dev/resources/brand.py">prefetch_by_email</a>(\*\*<a href="src/brand/dev/types/brand_prefetch_by_email_params.py">params</a>) -> <a href="./src/brand/dev/types/brand_prefetch_by_email_response.py">BrandPrefetchByEmailResponse</a></code>
 - <code title="get /brand/retrieve-by-email">client.brand.<a href="./src/brand/dev/resources/brand.py">retrieve_by_email</a>(\*\*<a href="src/brand/dev/types/brand_retrieve_by_email_params.py">params</a>) -> <a href="./src/brand/dev/types/brand_retrieve_by_email_response.py">BrandRetrieveByEmailResponse</a></code>
 - <code title="get /brand/retrieve-by-isin">client.brand.<a href="./src/brand/dev/resources/brand.py">retrieve_by_isin</a>(\*\*<a href="src/brand/dev/types/brand_retrieve_by_isin_params.py">params</a>) -> <a href="./src/brand/dev/types/brand_retrieve_by_isin_response.py">BrandRetrieveByIsinResponse</a></code>
 - <code title="get /brand/retrieve-by-name">client.brand.<a href="./src/brand/dev/resources/brand.py">retrieve_by_name</a>(\*\*<a href="src/brand/dev/types/brand_retrieve_by_name_params.py">params</a>) -> <a href="./src/brand/dev/types/brand_retrieve_by_name_response.py">BrandRetrieveByNameResponse</a></code>

src/brand/dev/resources/brand.py

@@ -17,6 +17,7 @@
     brand_retrieve_naics_params,
     brand_retrieve_by_isin_params,
     brand_retrieve_by_name_params,
+    brand_prefetch_by_email_params,
     brand_retrieve_by_email_params,
     brand_retrieve_by_ticker_params,
     brand_retrieve_simplified_params,
@@ -42,6 +43,7 @@
 from ..types.brand_retrieve_naics_response import BrandRetrieveNaicsResponse
 from ..types.brand_retrieve_by_isin_response import BrandRetrieveByIsinResponse
 from ..types.brand_retrieve_by_name_response import BrandRetrieveByNameResponse
+from ..types.brand_prefetch_by_email_response import BrandPrefetchByEmailResponse
 from ..types.brand_retrieve_by_email_response import BrandRetrieveByEmailResponse
 from ..types.brand_retrieve_by_ticker_response import BrandRetrieveByTickerResponse
 from ..types.brand_retrieve_simplified_response import BrandRetrieveSimplifiedResponse
@@ -711,6 +713,58 @@ def prefetch(
             cast_to=BrandPrefetchResponse,
         )
 
+    def prefetch_by_email(
+        self,
+        *,
+        email: str,
+        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,
+    ) -> BrandPrefetchByEmailResponse:
+        """
+        Signal that you may fetch brand data for a particular domain soon to improve
+        latency. This endpoint accepts an email address, extracts the domain from it,
+        validates that it's not a disposable or free email provider, and queues the
+        domain for prefetching. This endpoint does not charge credits and is available
+        for paid customers to optimize future requests. [You must be on a paid plan to
+        use this endpoint]
+
+        Args:
+          email: Email address to prefetch brand data for. The domain will be extracted from the
+              email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+              addresses are not allowed.
+
+          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).
+
+          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
+        """
+        return self._post(
+            "/brand/prefetch-by-email",
+            body=maybe_transform(
+                {
+                    "email": email,
+                    "timeout_ms": timeout_ms,
+                },
+                brand_prefetch_by_email_params.BrandPrefetchByEmailParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=BrandPrefetchByEmailResponse,
+        )
+
     def retrieve_by_email(
         self,
         *,
@@ -2147,6 +2201,58 @@ async def prefetch(
             cast_to=BrandPrefetchResponse,
         )
 
+    async def prefetch_by_email(
+        self,
+        *,
+        email: str,
+        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,
+    ) -> BrandPrefetchByEmailResponse:
+        """
+        Signal that you may fetch brand data for a particular domain soon to improve
+        latency. This endpoint accepts an email address, extracts the domain from it,
+        validates that it's not a disposable or free email provider, and queues the
+        domain for prefetching. This endpoint does not charge credits and is available
+        for paid customers to optimize future requests. [You must be on a paid plan to
+        use this endpoint]
+
+        Args:
+          email: Email address to prefetch brand data for. The domain will be extracted from the
+              email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+              addresses are not allowed.
+
+          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).
+
+          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
+        """
+        return await self._post(
+            "/brand/prefetch-by-email",
+            body=await async_maybe_transform(
+                {
+                    "email": email,
+                    "timeout_ms": timeout_ms,
+                },
+                brand_prefetch_by_email_params.BrandPrefetchByEmailParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=BrandPrefetchByEmailResponse,
+        )
+
     async def retrieve_by_email(
         self,
         *,
@@ -2941,6 +3047,9 @@ def __init__(self, brand: BrandResource) -> None:
         self.prefetch = to_raw_response_wrapper(
             brand.prefetch,
         )
+        self.prefetch_by_email = to_raw_response_wrapper(
+            brand.prefetch_by_email,
+        )
         self.retrieve_by_email = to_raw_response_wrapper(
             brand.retrieve_by_email,
         )
@@ -2986,6 +3095,9 @@ def __init__(self, brand: AsyncBrandResource) -> None:
         self.prefetch = async_to_raw_response_wrapper(
             brand.prefetch,
         )
+        self.prefetch_by_email = async_to_raw_response_wrapper(
+            brand.prefetch_by_email,
+        )
         self.retrieve_by_email = async_to_raw_response_wrapper(
             brand.retrieve_by_email,
         )
@@ -3031,6 +3143,9 @@ def __init__(self, brand: BrandResource) -> None:
         self.prefetch = to_streamed_response_wrapper(
             brand.prefetch,
         )
+        self.prefetch_by_email = to_streamed_response_wrapper(
+            brand.prefetch_by_email,
+        )
         self.retrieve_by_email = to_streamed_response_wrapper(
             brand.retrieve_by_email,
         )
@@ -3076,6 +3191,9 @@ def __init__(self, brand: AsyncBrandResource) -> None:
         self.prefetch = async_to_streamed_response_wrapper(
             brand.prefetch,
         )
+        self.prefetch_by_email = async_to_streamed_response_wrapper(
+            brand.prefetch_by_email,
+        )
         self.retrieve_by_email = async_to_streamed_response_wrapper(
             brand.retrieve_by_email,
         )

src/brand/dev/types/__init__.py

@@ -18,10 +18,12 @@
 from .brand_retrieve_by_isin_params import BrandRetrieveByIsinParams as BrandRetrieveByIsinParams
 from .brand_retrieve_by_name_params import BrandRetrieveByNameParams as BrandRetrieveByNameParams
 from .brand_retrieve_naics_response import BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse
+from .brand_prefetch_by_email_params import BrandPrefetchByEmailParams as BrandPrefetchByEmailParams
 from .brand_retrieve_by_email_params import BrandRetrieveByEmailParams as BrandRetrieveByEmailParams
 from .brand_retrieve_by_isin_response import BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse
 from .brand_retrieve_by_name_response import BrandRetrieveByNameResponse as BrandRetrieveByNameResponse
 from .brand_retrieve_by_ticker_params import BrandRetrieveByTickerParams as BrandRetrieveByTickerParams
+from .brand_prefetch_by_email_response import BrandPrefetchByEmailResponse as BrandPrefetchByEmailResponse
 from .brand_retrieve_by_email_response import BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse
 from .brand_retrieve_simplified_params import BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams
 from .brand_retrieve_by_ticker_response import BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse

src/brand/dev/types/brand_prefetch_by_email_params.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["BrandPrefetchByEmailParams"]
+
+
+class BrandPrefetchByEmailParams(TypedDict, total=False):
+    email: Required[str]
+    """Email address to prefetch brand data for.
+
+    The domain will be extracted from the email. Free email providers (gmail.com,
+    yahoo.com, etc.) and disposable email addresses are not allowed.
+    """
+
+    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).
+    """

src/brand/dev/types/brand_prefetch_by_email_response.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["BrandPrefetchByEmailResponse"]
+
+
+class BrandPrefetchByEmailResponse(BaseModel):
+    domain: Optional[str] = None
+    """The domain that was queued for prefetching"""
+
+    message: Optional[str] = None
+    """Success message"""
+
+    status: Optional[str] = None
+    """Status of the response, e.g., 'ok'"""

tests/api_resources/test_brand.py

@@ -19,6 +19,7 @@
     BrandRetrieveNaicsResponse,
     BrandRetrieveByIsinResponse,
     BrandRetrieveByNameResponse,
+    BrandPrefetchByEmailResponse,
     BrandRetrieveByEmailResponse,
     BrandRetrieveByTickerResponse,
     BrandRetrieveSimplifiedResponse,
@@ -296,6 +297,49 @@ def test_streaming_response_prefetch(self, client: BrandDev) -> None:
 
         assert cast(Any, response.is_closed) is True
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_prefetch_by_email(self, client: BrandDev) -> None:
+        brand = client.brand.prefetch_by_email(
+            email="dev@stainless.com",
+        )
+        assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_prefetch_by_email_with_all_params(self, client: BrandDev) -> None:
+        brand = client.brand.prefetch_by_email(
+            email="dev@stainless.com",
+            timeout_ms=1,
+        )
+        assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_raw_response_prefetch_by_email(self, client: BrandDev) -> None:
+        response = client.brand.with_raw_response.prefetch_by_email(
+            email="dev@stainless.com",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        brand = response.parse()
+        assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_streaming_response_prefetch_by_email(self, client: BrandDev) -> None:
+        with client.brand.with_streaming_response.prefetch_by_email(
+            email="dev@stainless.com",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            brand = response.parse()
+            assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
     def test_method_retrieve_by_email(self, client: BrandDev) -> None:
@@ -925,6 +969,49 @@ async def test_streaming_response_prefetch(self, async_client: AsyncBrandDev) ->
 
         assert cast(Any, response.is_closed) is True
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_prefetch_by_email(self, async_client: AsyncBrandDev) -> None:
+        brand = await async_client.brand.prefetch_by_email(
+            email="dev@stainless.com",
+        )
+        assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_prefetch_by_email_with_all_params(self, async_client: AsyncBrandDev) -> None:
+        brand = await async_client.brand.prefetch_by_email(
+            email="dev@stainless.com",
+            timeout_ms=1,
+        )
+        assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_raw_response_prefetch_by_email(self, async_client: AsyncBrandDev) -> None:
+        response = await async_client.brand.with_raw_response.prefetch_by_email(
+            email="dev@stainless.com",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        brand = await response.parse()
+        assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_streaming_response_prefetch_by_email(self, async_client: AsyncBrandDev) -> None:
+        async with async_client.brand.with_streaming_response.prefetch_by_email(
+            email="dev@stainless.com",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            brand = await response.parse()
+            assert_matches_type(BrandPrefetchByEmailResponse, brand, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
     async def test_method_retrieve_by_email(self, async_client: AsyncBrandDev) -> None: