1414 brand_screenshot_params ,
1515 brand_styleguide_params ,
1616 brand_retrieve_naics_params ,
17- brand_retrieve_by_ticker_params ,
1817 brand_retrieve_simplified_params ,
1918 brand_identify_from_transaction_params ,
2019)
3534from ..types .brand_screenshot_response import BrandScreenshotResponse
3635from ..types .brand_styleguide_response import BrandStyleguideResponse
3736from ..types .brand_retrieve_naics_response import BrandRetrieveNaicsResponse
38- from ..types .brand_retrieve_by_ticker_response import BrandRetrieveByTickerResponse
3937from ..types .brand_retrieve_simplified_response import BrandRetrieveSimplifiedResponse
4038from ..types .brand_identify_from_transaction_response import BrandIdentifyFromTransactionResponse
4139
@@ -65,7 +63,7 @@ def with_streaming_response(self) -> BrandResourceWithStreamingResponse:
6563 def retrieve (
6664 self ,
6765 * ,
68- domain : str ,
66+ domain : str | NotGiven = NOT_GIVEN ,
6967 force_language : Literal [
7068 "albanian" ,
7169 "arabic" ,
@@ -122,6 +120,8 @@ def retrieve(
122120 ]
123121 | NotGiven = NOT_GIVEN ,
124122 max_speed : bool | NotGiven = NOT_GIVEN ,
123+ name : str | NotGiven = NOT_GIVEN ,
124+ ticker : str | NotGiven = NOT_GIVEN ,
125125 timeout_ms : int | NotGiven = NOT_GIVEN ,
126126 # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
127127 # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -131,16 +131,27 @@ def retrieve(
131131 timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
132132 ) -> BrandRetrieveResponse :
133133 """
134- Retrieve brand data by domain
134+ Retrieve brand information using one of three methods: domain name, company
135+ name, or stock ticker symbol. Exactly one of these parameters must be provided.
135136
136137 Args:
137- domain: Domain name to retrieve brand data for
138+ domain: Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
139+ Cannot be used with name or ticker parameters.
138140
139- force_language: Optional parameter to force the language of the retrieved brand data
141+ force_language: Optional parameter to force the language of the retrieved brand data. Works with
142+ all three lookup methods.
140143
141144 max_speed: Optional parameter to optimize the API call for maximum speed. When set to true,
142145 the API will skip time-consuming operations for faster response at the cost of
143- less comprehensive data.
146+ less comprehensive data. Works with all three lookup methods.
147+
148+ name: Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
149+ Corporation'). Must be 3-30 characters. Cannot be used with domain or ticker
150+ parameters.
151+
152+ ticker: Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
153+ Must be 1-6 characters, letters/numbers/dots only. Cannot be used with domain or
154+ name parameters.
144155
145156 timeout_ms: Optional timeout in milliseconds for the request. If the request takes longer
146157 than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -166,6 +177,8 @@ def retrieve(
166177 "domain" : domain ,
167178 "force_language" : force_language ,
168179 "max_speed" : max_speed ,
180+ "name" : name ,
181+ "ticker" : ticker ,
169182 "timeout_ms" : timeout_ms ,
170183 },
171184 brand_retrieve_params .BrandRetrieveParams ,
@@ -327,55 +340,6 @@ def prefetch(
327340 cast_to = BrandPrefetchResponse ,
328341 )
329342
330- def retrieve_by_ticker (
331- self ,
332- * ,
333- ticker : str ,
334- timeout_ms : int | NotGiven = NOT_GIVEN ,
335- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
336- # The extra values given here take precedence over values defined on the client or passed to this method.
337- extra_headers : Headers | None = None ,
338- extra_query : Query | None = None ,
339- extra_body : Body | None = None ,
340- timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
341- ) -> BrandRetrieveByTickerResponse :
342- """Retrieve brand data by stock ticker (e.g.
343-
344- AAPL, TSLA, etc.)
345-
346- Args:
347- ticker: Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
348-
349- timeout_ms: Optional timeout in milliseconds for the request. If the request takes longer
350- than this value, it will be aborted with a 408 status code. Maximum allowed
351- value is 300000ms (5 minutes).
352-
353- extra_headers: Send extra headers
354-
355- extra_query: Add additional query parameters to the request
356-
357- extra_body: Add additional JSON properties to the request
358-
359- timeout: Override the client-level default timeout for this request, in seconds
360- """
361- return self ._get (
362- "/brand/retrieve-by-ticker" ,
363- options = make_request_options (
364- extra_headers = extra_headers ,
365- extra_query = extra_query ,
366- extra_body = extra_body ,
367- timeout = timeout ,
368- query = maybe_transform (
369- {
370- "ticker" : ticker ,
371- "timeout_ms" : timeout_ms ,
372- },
373- brand_retrieve_by_ticker_params .BrandRetrieveByTickerParams ,
374- ),
375- ),
376- cast_to = BrandRetrieveByTickerResponse ,
377- )
378-
379343 def retrieve_naics (
380344 self ,
381345 * ,
@@ -603,7 +567,7 @@ def with_streaming_response(self) -> AsyncBrandResourceWithStreamingResponse:
603567 async def retrieve (
604568 self ,
605569 * ,
606- domain : str ,
570+ domain : str | NotGiven = NOT_GIVEN ,
607571 force_language : Literal [
608572 "albanian" ,
609573 "arabic" ,
@@ -660,6 +624,8 @@ async def retrieve(
660624 ]
661625 | NotGiven = NOT_GIVEN ,
662626 max_speed : bool | NotGiven = NOT_GIVEN ,
627+ name : str | NotGiven = NOT_GIVEN ,
628+ ticker : str | NotGiven = NOT_GIVEN ,
663629 timeout_ms : int | NotGiven = NOT_GIVEN ,
664630 # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
665631 # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -669,16 +635,27 @@ async def retrieve(
669635 timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
670636 ) -> BrandRetrieveResponse :
671637 """
672- Retrieve brand data by domain
638+ Retrieve brand information using one of three methods: domain name, company
639+ name, or stock ticker symbol. Exactly one of these parameters must be provided.
673640
674641 Args:
675- domain: Domain name to retrieve brand data for
642+ domain: Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
643+ Cannot be used with name or ticker parameters.
676644
677- force_language: Optional parameter to force the language of the retrieved brand data
645+ force_language: Optional parameter to force the language of the retrieved brand data. Works with
646+ all three lookup methods.
678647
679648 max_speed: Optional parameter to optimize the API call for maximum speed. When set to true,
680649 the API will skip time-consuming operations for faster response at the cost of
681- less comprehensive data.
650+ less comprehensive data. Works with all three lookup methods.
651+
652+ name: Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
653+ Corporation'). Must be 3-30 characters. Cannot be used with domain or ticker
654+ parameters.
655+
656+ ticker: Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
657+ Must be 1-6 characters, letters/numbers/dots only. Cannot be used with domain or
658+ name parameters.
682659
683660 timeout_ms: Optional timeout in milliseconds for the request. If the request takes longer
684661 than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -704,6 +681,8 @@ async def retrieve(
704681 "domain" : domain ,
705682 "force_language" : force_language ,
706683 "max_speed" : max_speed ,
684+ "name" : name ,
685+ "ticker" : ticker ,
707686 "timeout_ms" : timeout_ms ,
708687 },
709688 brand_retrieve_params .BrandRetrieveParams ,
@@ -865,55 +844,6 @@ async def prefetch(
865844 cast_to = BrandPrefetchResponse ,
866845 )
867846
868- async def retrieve_by_ticker (
869- self ,
870- * ,
871- ticker : str ,
872- timeout_ms : int | NotGiven = NOT_GIVEN ,
873- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
874- # The extra values given here take precedence over values defined on the client or passed to this method.
875- extra_headers : Headers | None = None ,
876- extra_query : Query | None = None ,
877- extra_body : Body | None = None ,
878- timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
879- ) -> BrandRetrieveByTickerResponse :
880- """Retrieve brand data by stock ticker (e.g.
881-
882- AAPL, TSLA, etc.)
883-
884- Args:
885- ticker: Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
886-
887- timeout_ms: Optional timeout in milliseconds for the request. If the request takes longer
888- than this value, it will be aborted with a 408 status code. Maximum allowed
889- value is 300000ms (5 minutes).
890-
891- extra_headers: Send extra headers
892-
893- extra_query: Add additional query parameters to the request
894-
895- extra_body: Add additional JSON properties to the request
896-
897- timeout: Override the client-level default timeout for this request, in seconds
898- """
899- return await self ._get (
900- "/brand/retrieve-by-ticker" ,
901- options = make_request_options (
902- extra_headers = extra_headers ,
903- extra_query = extra_query ,
904- extra_body = extra_body ,
905- timeout = timeout ,
906- query = await async_maybe_transform (
907- {
908- "ticker" : ticker ,
909- "timeout_ms" : timeout_ms ,
910- },
911- brand_retrieve_by_ticker_params .BrandRetrieveByTickerParams ,
912- ),
913- ),
914- cast_to = BrandRetrieveByTickerResponse ,
915- )
916-
917847 async def retrieve_naics (
918848 self ,
919849 * ,
@@ -1134,9 +1064,6 @@ def __init__(self, brand: BrandResource) -> None:
11341064 self .prefetch = to_raw_response_wrapper (
11351065 brand .prefetch ,
11361066 )
1137- self .retrieve_by_ticker = to_raw_response_wrapper (
1138- brand .retrieve_by_ticker ,
1139- )
11401067 self .retrieve_naics = to_raw_response_wrapper (
11411068 brand .retrieve_naics ,
11421069 )
@@ -1167,9 +1094,6 @@ def __init__(self, brand: AsyncBrandResource) -> None:
11671094 self .prefetch = async_to_raw_response_wrapper (
11681095 brand .prefetch ,
11691096 )
1170- self .retrieve_by_ticker = async_to_raw_response_wrapper (
1171- brand .retrieve_by_ticker ,
1172- )
11731097 self .retrieve_naics = async_to_raw_response_wrapper (
11741098 brand .retrieve_naics ,
11751099 )
@@ -1200,9 +1124,6 @@ def __init__(self, brand: BrandResource) -> None:
12001124 self .prefetch = to_streamed_response_wrapper (
12011125 brand .prefetch ,
12021126 )
1203- self .retrieve_by_ticker = to_streamed_response_wrapper (
1204- brand .retrieve_by_ticker ,
1205- )
12061127 self .retrieve_naics = to_streamed_response_wrapper (
12071128 brand .retrieve_naics ,
12081129 )
@@ -1233,9 +1154,6 @@ def __init__(self, brand: AsyncBrandResource) -> None:
12331154 self .prefetch = async_to_streamed_response_wrapper (
12341155 brand .prefetch ,
12351156 )
1236- self .retrieve_by_ticker = async_to_streamed_response_wrapper (
1237- brand .retrieve_by_ticker ,
1238- )
12391157 self .retrieve_naics = async_to_streamed_response_wrapper (
12401158 brand .retrieve_naics ,
12411159 )
0 commit comments