Skip to content

Commit f98376c

Browse files
feat(api): api update
1 parent d6acbc6 commit f98376c

5 files changed

Lines changed: 29 additions & 44 deletions

File tree

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 21
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev%2Fcontext.dev-3c753cf7c4d04fe467710a51b1a2f6f024b0b6a670704be7340b92e064bcf1a9.yml
3-
openapi_spec_hash: f9b02e6756001e2be87d541d5cc609e5
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev%2Fcontext.dev-3a604b0c9775298072e70890d369d21d38422553a8fe23d9d081b0dc06035ee2.yml
3+
openapi_spec_hash: f94db2839851fb192f013b3ca258c39f
44
config_hash: 85e90b8fda2e1f326ca60f8ab3e53704

‎src/context/dev/resources/brand.py‎

Lines changed: 22 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,6 @@ def identify_from_transaction(
637637
638638
high_confidence_only: When set to true, the API will perform an additional verification steps to
639639
ensure the identified brand matches the transaction with high confidence.
640-
Defaults to false.
641640
642641
max_speed: Optional parameter to optimize the API call for maximum speed. When set to true,
643642
the API will skip time-consuming operations for faster response at the cost of
@@ -823,9 +822,8 @@ def retrieve_by_email(
823822
) -> BrandRetrieveByEmailResponse:
824823
"""
825824
Retrieve brand information using an email address while detecting disposable and
826-
free email addresses. This endpoint extracts the domain from the email address
827-
and returns brand data for that domain. Disposable and free email addresses
828-
(like gmail.com, yahoo.com) will throw a 422 error.
825+
free email addresses. Disposable and free email addresses (like gmail.com,
826+
yahoo.com) will throw a 422 error.
829827
830828
Args:
831829
email: Email address to retrieve brand data for (e.g., 'contact@example.com'). The
@@ -1008,8 +1006,7 @@ def retrieve_by_isin(
10081006
) -> BrandRetrieveByIsinResponse:
10091007
"""
10101008
Retrieve brand information using an ISIN (International Securities
1011-
Identification Number). This endpoint looks up the company associated with the
1012-
ISIN and returns its brand data.
1009+
Identification Number).
10131010
10141011
Args:
10151012
isin: ISIN (International Securities Identification Number) to retrieve brand data for
@@ -1432,17 +1429,15 @@ def retrieve_by_name(
14321429
extra_body: Body | None = None,
14331430
timeout: float | httpx.Timeout | None | NotGiven = not_given,
14341431
) -> BrandRetrieveByNameResponse:
1435-
"""Retrieve brand information using a company name.
1436-
1437-
This endpoint searches for the
1438-
company by name and returns its brand data.
1432+
"""
1433+
Retrieve brand information using a company name.
14391434
14401435
Args:
14411436
name: Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
14421437
Corporation'). Must be 3-30 characters.
14431438
1444-
country_gl: Optional country code (GL parameter) to specify the country. This affects the
1445-
geographic location used for search queries.
1439+
country_gl: Optional country code hint (GL parameter) to specify the country for the company
1440+
name.
14461441
14471442
force_language: Optional parameter to force the language of the retrieved brand data.
14481443
@@ -1694,10 +1689,8 @@ def retrieve_by_ticker(
16941689
extra_body: Body | None = None,
16951690
timeout: float | httpx.Timeout | None | NotGiven = not_given,
16961691
) -> BrandRetrieveByTickerResponse:
1697-
"""Retrieve brand information using a stock ticker symbol.
1698-
1699-
This endpoint looks up
1700-
the company associated with the ticker and returns its brand data.
1692+
"""
1693+
Retrieve brand information using a stock ticker symbol.
17011694
17021695
Args:
17031696
ticker: Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
@@ -1758,8 +1751,8 @@ def retrieve_simplified(
17581751
) -> BrandRetrieveSimplifiedResponse:
17591752
"""
17601753
Returns a simplified version of brand data containing only essential
1761-
information: domain, title, colors, logos, and backdrops. This endpoint is
1762-
optimized for faster responses and reduced data transfer.
1754+
information: domain, title, colors, logos, and backdrops. Optimized for faster
1755+
responses and reduced data transfer.
17631756
17641757
Args:
17651758
domain: Domain name to retrieve simplified brand data for
@@ -2395,7 +2388,6 @@ async def identify_from_transaction(
23952388
23962389
high_confidence_only: When set to true, the API will perform an additional verification steps to
23972390
ensure the identified brand matches the transaction with high confidence.
2398-
Defaults to false.
23992391
24002392
max_speed: Optional parameter to optimize the API call for maximum speed. When set to true,
24012393
the API will skip time-consuming operations for faster response at the cost of
@@ -2581,9 +2573,8 @@ async def retrieve_by_email(
25812573
) -> BrandRetrieveByEmailResponse:
25822574
"""
25832575
Retrieve brand information using an email address while detecting disposable and
2584-
free email addresses. This endpoint extracts the domain from the email address
2585-
and returns brand data for that domain. Disposable and free email addresses
2586-
(like gmail.com, yahoo.com) will throw a 422 error.
2576+
free email addresses. Disposable and free email addresses (like gmail.com,
2577+
yahoo.com) will throw a 422 error.
25872578
25882579
Args:
25892580
email: Email address to retrieve brand data for (e.g., 'contact@example.com'). The
@@ -2766,8 +2757,7 @@ async def retrieve_by_isin(
27662757
) -> BrandRetrieveByIsinResponse:
27672758
"""
27682759
Retrieve brand information using an ISIN (International Securities
2769-
Identification Number). This endpoint looks up the company associated with the
2770-
ISIN and returns its brand data.
2760+
Identification Number).
27712761
27722762
Args:
27732763
isin: ISIN (International Securities Identification Number) to retrieve brand data for
@@ -3190,17 +3180,15 @@ async def retrieve_by_name(
31903180
extra_body: Body | None = None,
31913181
timeout: float | httpx.Timeout | None | NotGiven = not_given,
31923182
) -> BrandRetrieveByNameResponse:
3193-
"""Retrieve brand information using a company name.
3194-
3195-
This endpoint searches for the
3196-
company by name and returns its brand data.
3183+
"""
3184+
Retrieve brand information using a company name.
31973185
31983186
Args:
31993187
name: Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
32003188
Corporation'). Must be 3-30 characters.
32013189
3202-
country_gl: Optional country code (GL parameter) to specify the country. This affects the
3203-
geographic location used for search queries.
3190+
country_gl: Optional country code hint (GL parameter) to specify the country for the company
3191+
name.
32043192
32053193
force_language: Optional parameter to force the language of the retrieved brand data.
32063194
@@ -3452,10 +3440,8 @@ async def retrieve_by_ticker(
34523440
extra_body: Body | None = None,
34533441
timeout: float | httpx.Timeout | None | NotGiven = not_given,
34543442
) -> BrandRetrieveByTickerResponse:
3455-
"""Retrieve brand information using a stock ticker symbol.
3456-
3457-
This endpoint looks up
3458-
the company associated with the ticker and returns its brand data.
3443+
"""
3444+
Retrieve brand information using a stock ticker symbol.
34593445
34603446
Args:
34613447
ticker: Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
@@ -3516,8 +3502,8 @@ async def retrieve_simplified(
35163502
) -> BrandRetrieveSimplifiedResponse:
35173503
"""
35183504
Returns a simplified version of brand data containing only essential
3519-
information: domain, title, colors, logos, and backdrops. This endpoint is
3520-
optimized for faster responses and reduced data transfer.
3505+
information: domain, title, colors, logos, and backdrops. Optimized for faster
3506+
responses and reduced data transfer.
35213507
35223508
Args:
35233509
domain: Domain name to retrieve simplified brand data for

‎src/context/dev/resources/web.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ def web_scrape_sitemap(
486486
timeout: float | httpx.Timeout | None | NotGiven = not_given,
487487
) -> WebWebScrapeSitemapResponse:
488488
"""
489-
Crawl an entire website's sitemap and return all discovered page URLs
489+
Crawl an entire website's sitemap and return all discovered page URLs.
490490
491491
Args:
492492
domain: Domain to build a sitemap for
@@ -968,7 +968,7 @@ async def web_scrape_sitemap(
968968
timeout: float | httpx.Timeout | None | NotGiven = not_given,
969969
) -> WebWebScrapeSitemapResponse:
970970
"""
971-
Crawl an entire website's sitemap and return all discovered page URLs
971+
Crawl an entire website's sitemap and return all discovered page URLs.
972972
973973
Args:
974974
domain: Domain to build a sitemap for

‎src/context/dev/types/brand_identify_from_transaction_params.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,6 @@ class BrandIdentifyFromTransactionParams(TypedDict, total=False):
390390
"""
391391
When set to true, the API will perform an additional verification steps to
392392
ensure the identified brand matches the transaction with high confidence.
393-
Defaults to false.
394393
"""
395394

396395
max_speed: Annotated[bool, PropertyInfo(alias="maxSpeed")]

‎src/context/dev/types/brand_retrieve_by_name_params.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ class BrandRetrieveByNameParams(TypedDict, total=False):
257257
"zm",
258258
"zw",
259259
]
260-
"""Optional country code (GL parameter) to specify the country.
261-
262-
This affects the geographic location used for search queries.
260+
"""
261+
Optional country code hint (GL parameter) to specify the country for the company
262+
name.
263263
"""
264264

265265
force_language: Literal[

0 commit comments

Comments
 (0)