context.dev 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/LICENSE +201 -0
- package/README.md +370 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +181 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +181 -0
- package/client.d.ts.map +1 -0
- package/client.js +465 -0
- package/client.js.map +1 -0
- package/client.mjs +461 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +40 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +37 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/query.d.mts +5 -0
- package/internal/utils/query.d.mts.map +1 -0
- package/internal/utils/query.d.ts +5 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +23 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +20 -0
- package/internal/utils/query.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +8 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +8 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +12 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +9 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +149 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/brand.d.mts +3208 -0
- package/resources/brand.d.mts.map +1 -0
- package/resources/brand.d.ts +3208 -0
- package/resources/brand.d.ts.map +1 -0
- package/resources/brand.js +168 -0
- package/resources/brand.js.map +1 -0
- package/resources/brand.mjs +164 -0
- package/resources/brand.mjs.map +1 -0
- package/resources/index.d.mts +2 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +2 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +7 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +814 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +56 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/query.ts +23 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +9 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/brand.ts +6079 -0
- package/src/resources/index.ts +45 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,3208 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class Brand extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Retrieve logos, backdrops, colors, industry, description, and more from any
|
|
7
|
+
* domain
|
|
8
|
+
*/
|
|
9
|
+
retrieve(query: BrandRetrieveParams, options?: RequestOptions): APIPromise<BrandRetrieveResponse>;
|
|
10
|
+
/**
|
|
11
|
+
* Beta feature: Given a single URL, determines if it is a product detail page,
|
|
12
|
+
* classifies the platform/product type, and extracts the product information.
|
|
13
|
+
* Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites.
|
|
14
|
+
*/
|
|
15
|
+
aiProduct(body: BrandAIProductParams, options?: RequestOptions): APIPromise<BrandAIProductResponse>;
|
|
16
|
+
/**
|
|
17
|
+
* Beta feature: Extract product information from a brand's website. Brand.dev will
|
|
18
|
+
* analyze the website and return a list of products with details such as name,
|
|
19
|
+
* description, image, pricing, features, and more.
|
|
20
|
+
*/
|
|
21
|
+
aiProducts(body: BrandAIProductsParams, options?: RequestOptions): APIPromise<BrandAIProductsResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Use AI to extract specific data points from a brand's website. The AI will crawl
|
|
24
|
+
* the website and extract the requested information based on the provided data
|
|
25
|
+
* points.
|
|
26
|
+
*/
|
|
27
|
+
aiQuery(body: BrandAIQueryParams, options?: RequestOptions): APIPromise<BrandAIQueryResponse>;
|
|
28
|
+
/**
|
|
29
|
+
* Extract font information from a brand's website including font families, usage
|
|
30
|
+
* statistics, fallbacks, and element/word counts.
|
|
31
|
+
*/
|
|
32
|
+
fonts(query: BrandFontsParams, options?: RequestOptions): APIPromise<BrandFontsResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Endpoint specially designed for platforms that want to identify transaction data
|
|
35
|
+
* by the transaction title.
|
|
36
|
+
*/
|
|
37
|
+
identifyFromTransaction(query: BrandIdentifyFromTransactionParams, options?: RequestOptions): APIPromise<BrandIdentifyFromTransactionResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Signal that you may fetch brand data for a particular domain soon to improve
|
|
40
|
+
* latency. This endpoint does not charge credits and is available for paid
|
|
41
|
+
* customers to optimize future requests. [You must be on a paid plan to use this
|
|
42
|
+
* endpoint]
|
|
43
|
+
*/
|
|
44
|
+
prefetch(body: BrandPrefetchParams, options?: RequestOptions): APIPromise<BrandPrefetchResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Signal that you may fetch brand data for a particular domain soon to improve
|
|
47
|
+
* latency. This endpoint accepts an email address, extracts the domain from it,
|
|
48
|
+
* validates that it's not a disposable or free email provider, and queues the
|
|
49
|
+
* domain for prefetching. This endpoint does not charge credits and is available
|
|
50
|
+
* for paid customers to optimize future requests. [You must be on a paid plan to
|
|
51
|
+
* use this endpoint]
|
|
52
|
+
*/
|
|
53
|
+
prefetchByEmail(body: BrandPrefetchByEmailParams, options?: RequestOptions): APIPromise<BrandPrefetchByEmailResponse>;
|
|
54
|
+
/**
|
|
55
|
+
* Retrieve brand information using an email address while detecting disposable and
|
|
56
|
+
* free email addresses. This endpoint extracts the domain from the email address
|
|
57
|
+
* and returns brand data for that domain. Disposable and free email addresses
|
|
58
|
+
* (like gmail.com, yahoo.com) will throw a 422 error.
|
|
59
|
+
*/
|
|
60
|
+
retrieveByEmail(query: BrandRetrieveByEmailParams, options?: RequestOptions): APIPromise<BrandRetrieveByEmailResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* Retrieve brand information using an ISIN (International Securities
|
|
63
|
+
* Identification Number). This endpoint looks up the company associated with the
|
|
64
|
+
* ISIN and returns its brand data.
|
|
65
|
+
*/
|
|
66
|
+
retrieveByIsin(query: BrandRetrieveByIsinParams, options?: RequestOptions): APIPromise<BrandRetrieveByIsinResponse>;
|
|
67
|
+
/**
|
|
68
|
+
* Retrieve brand information using a company name. This endpoint searches for the
|
|
69
|
+
* company by name and returns its brand data.
|
|
70
|
+
*/
|
|
71
|
+
retrieveByName(query: BrandRetrieveByNameParams, options?: RequestOptions): APIPromise<BrandRetrieveByNameResponse>;
|
|
72
|
+
/**
|
|
73
|
+
* Retrieve brand information using a stock ticker symbol. This endpoint looks up
|
|
74
|
+
* the company associated with the ticker and returns its brand data.
|
|
75
|
+
*/
|
|
76
|
+
retrieveByTicker(query: BrandRetrieveByTickerParams, options?: RequestOptions): APIPromise<BrandRetrieveByTickerResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* Endpoint to classify any brand into a 2022 NAICS code.
|
|
79
|
+
*/
|
|
80
|
+
retrieveNaics(query: BrandRetrieveNaicsParams, options?: RequestOptions): APIPromise<BrandRetrieveNaicsResponse>;
|
|
81
|
+
/**
|
|
82
|
+
* Returns a simplified version of brand data containing only essential
|
|
83
|
+
* information: domain, title, colors, logos, and backdrops. This endpoint is
|
|
84
|
+
* optimized for faster responses and reduced data transfer.
|
|
85
|
+
*/
|
|
86
|
+
retrieveSimplified(query: BrandRetrieveSimplifiedParams, options?: RequestOptions): APIPromise<BrandRetrieveSimplifiedResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* Capture a screenshot of a website. Supports both viewport (standard browser
|
|
89
|
+
* view) and full-page screenshots. Can also screenshot specific page types (login,
|
|
90
|
+
* pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
|
|
91
|
+
* the uploaded screenshot image hosted on our CDN.
|
|
92
|
+
*/
|
|
93
|
+
screenshot(query: BrandScreenshotParams, options?: RequestOptions): APIPromise<BrandScreenshotResponse>;
|
|
94
|
+
/**
|
|
95
|
+
* Automatically extract comprehensive design system information from a brand's
|
|
96
|
+
* website including colors, typography, spacing, shadows, and UI components.
|
|
97
|
+
* Either 'domain' or 'directUrl' must be provided as a query parameter, but not
|
|
98
|
+
* both.
|
|
99
|
+
*/
|
|
100
|
+
styleguide(query?: BrandStyleguideParams | null | undefined, options?: RequestOptions): APIPromise<BrandStyleguideResponse>;
|
|
101
|
+
/**
|
|
102
|
+
* Scrapes the given URL and returns the raw HTML content of the page. Uses
|
|
103
|
+
* automatic proxy escalation to handle blocked sites.
|
|
104
|
+
*/
|
|
105
|
+
webScrapeHTML(query: BrandWebScrapeHTMLParams, options?: RequestOptions): APIPromise<BrandWebScrapeHTMLResponse>;
|
|
106
|
+
/**
|
|
107
|
+
* Scrapes all images from the given URL. Extracts images from img, svg,
|
|
108
|
+
* picture/source, link, and video elements including inline SVGs, base64 data
|
|
109
|
+
* URIs, and standard URLs.
|
|
110
|
+
*/
|
|
111
|
+
webScrapeImages(query: BrandWebScrapeImagesParams, options?: RequestOptions): APIPromise<BrandWebScrapeImagesResponse>;
|
|
112
|
+
/**
|
|
113
|
+
* Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown
|
|
114
|
+
* (GFM), and returns the result. Uses automatic proxy escalation to handle blocked
|
|
115
|
+
* sites.
|
|
116
|
+
*/
|
|
117
|
+
webScrapeMd(query: BrandWebScrapeMdParams, options?: RequestOptions): APIPromise<BrandWebScrapeMdResponse>;
|
|
118
|
+
/**
|
|
119
|
+
* Crawls the sitemap of the given domain and returns all discovered page URLs.
|
|
120
|
+
* Supports sitemap index files (recursive), parallel fetching with concurrency
|
|
121
|
+
* control, deduplication, and filters out non-page resources (images, PDFs, etc.).
|
|
122
|
+
*/
|
|
123
|
+
webScrapeSitemap(query: BrandWebScrapeSitemapParams, options?: RequestOptions): APIPromise<BrandWebScrapeSitemapResponse>;
|
|
124
|
+
}
|
|
125
|
+
export interface BrandRetrieveResponse {
|
|
126
|
+
/**
|
|
127
|
+
* Detailed brand information
|
|
128
|
+
*/
|
|
129
|
+
brand?: BrandRetrieveResponse.Brand;
|
|
130
|
+
/**
|
|
131
|
+
* HTTP status code
|
|
132
|
+
*/
|
|
133
|
+
code?: number;
|
|
134
|
+
/**
|
|
135
|
+
* Status of the response, e.g., 'ok'
|
|
136
|
+
*/
|
|
137
|
+
status?: string;
|
|
138
|
+
}
|
|
139
|
+
export declare namespace BrandRetrieveResponse {
|
|
140
|
+
/**
|
|
141
|
+
* Detailed brand information
|
|
142
|
+
*/
|
|
143
|
+
interface Brand {
|
|
144
|
+
/**
|
|
145
|
+
* Physical address of the brand
|
|
146
|
+
*/
|
|
147
|
+
address?: Brand.Address;
|
|
148
|
+
/**
|
|
149
|
+
* An array of backdrop images for the brand
|
|
150
|
+
*/
|
|
151
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
152
|
+
/**
|
|
153
|
+
* An array of brand colors
|
|
154
|
+
*/
|
|
155
|
+
colors?: Array<Brand.Color>;
|
|
156
|
+
/**
|
|
157
|
+
* A brief description of the brand
|
|
158
|
+
*/
|
|
159
|
+
description?: string;
|
|
160
|
+
/**
|
|
161
|
+
* The domain name of the brand
|
|
162
|
+
*/
|
|
163
|
+
domain?: string;
|
|
164
|
+
/**
|
|
165
|
+
* Company email address
|
|
166
|
+
*/
|
|
167
|
+
email?: string;
|
|
168
|
+
/**
|
|
169
|
+
* Industry classification information for the brand
|
|
170
|
+
*/
|
|
171
|
+
industries?: Brand.Industries;
|
|
172
|
+
/**
|
|
173
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
174
|
+
*/
|
|
175
|
+
is_nsfw?: boolean;
|
|
176
|
+
/**
|
|
177
|
+
* Important website links for the brand
|
|
178
|
+
*/
|
|
179
|
+
links?: Brand.Links;
|
|
180
|
+
/**
|
|
181
|
+
* An array of logos associated with the brand
|
|
182
|
+
*/
|
|
183
|
+
logos?: Array<Brand.Logo>;
|
|
184
|
+
/**
|
|
185
|
+
* Company phone number
|
|
186
|
+
*/
|
|
187
|
+
phone?: string;
|
|
188
|
+
/**
|
|
189
|
+
* The brand's slogan
|
|
190
|
+
*/
|
|
191
|
+
slogan?: string;
|
|
192
|
+
/**
|
|
193
|
+
* An array of social media links for the brand
|
|
194
|
+
*/
|
|
195
|
+
socials?: Array<Brand.Social>;
|
|
196
|
+
/**
|
|
197
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
198
|
+
* company)
|
|
199
|
+
*/
|
|
200
|
+
stock?: Brand.Stock;
|
|
201
|
+
/**
|
|
202
|
+
* The title or name of the brand
|
|
203
|
+
*/
|
|
204
|
+
title?: string;
|
|
205
|
+
}
|
|
206
|
+
namespace Brand {
|
|
207
|
+
/**
|
|
208
|
+
* Physical address of the brand
|
|
209
|
+
*/
|
|
210
|
+
interface Address {
|
|
211
|
+
/**
|
|
212
|
+
* City name
|
|
213
|
+
*/
|
|
214
|
+
city?: string;
|
|
215
|
+
/**
|
|
216
|
+
* Country name
|
|
217
|
+
*/
|
|
218
|
+
country?: string;
|
|
219
|
+
/**
|
|
220
|
+
* Country code
|
|
221
|
+
*/
|
|
222
|
+
country_code?: string;
|
|
223
|
+
/**
|
|
224
|
+
* Postal or ZIP code
|
|
225
|
+
*/
|
|
226
|
+
postal_code?: string;
|
|
227
|
+
/**
|
|
228
|
+
* State or province code
|
|
229
|
+
*/
|
|
230
|
+
state_code?: string;
|
|
231
|
+
/**
|
|
232
|
+
* State or province name
|
|
233
|
+
*/
|
|
234
|
+
state_province?: string;
|
|
235
|
+
/**
|
|
236
|
+
* Street address
|
|
237
|
+
*/
|
|
238
|
+
street?: string;
|
|
239
|
+
}
|
|
240
|
+
interface Backdrop {
|
|
241
|
+
/**
|
|
242
|
+
* Array of colors in the backdrop image
|
|
243
|
+
*/
|
|
244
|
+
colors?: Array<Backdrop.Color>;
|
|
245
|
+
/**
|
|
246
|
+
* Resolution of the backdrop image
|
|
247
|
+
*/
|
|
248
|
+
resolution?: Backdrop.Resolution;
|
|
249
|
+
/**
|
|
250
|
+
* URL of the backdrop image
|
|
251
|
+
*/
|
|
252
|
+
url?: string;
|
|
253
|
+
}
|
|
254
|
+
namespace Backdrop {
|
|
255
|
+
interface Color {
|
|
256
|
+
/**
|
|
257
|
+
* Color in hexadecimal format
|
|
258
|
+
*/
|
|
259
|
+
hex?: string;
|
|
260
|
+
/**
|
|
261
|
+
* Name of the color
|
|
262
|
+
*/
|
|
263
|
+
name?: string;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Resolution of the backdrop image
|
|
267
|
+
*/
|
|
268
|
+
interface Resolution {
|
|
269
|
+
/**
|
|
270
|
+
* Aspect ratio of the image (width/height)
|
|
271
|
+
*/
|
|
272
|
+
aspect_ratio?: number;
|
|
273
|
+
/**
|
|
274
|
+
* Height of the image in pixels
|
|
275
|
+
*/
|
|
276
|
+
height?: number;
|
|
277
|
+
/**
|
|
278
|
+
* Width of the image in pixels
|
|
279
|
+
*/
|
|
280
|
+
width?: number;
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
interface Color {
|
|
284
|
+
/**
|
|
285
|
+
* Color in hexadecimal format
|
|
286
|
+
*/
|
|
287
|
+
hex?: string;
|
|
288
|
+
/**
|
|
289
|
+
* Name of the color
|
|
290
|
+
*/
|
|
291
|
+
name?: string;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* Industry classification information for the brand
|
|
295
|
+
*/
|
|
296
|
+
interface Industries {
|
|
297
|
+
/**
|
|
298
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
299
|
+
*/
|
|
300
|
+
eic?: Array<Industries.Eic>;
|
|
301
|
+
}
|
|
302
|
+
namespace Industries {
|
|
303
|
+
interface Eic {
|
|
304
|
+
/**
|
|
305
|
+
* Industry classification enum
|
|
306
|
+
*/
|
|
307
|
+
industry: 'Aerospace & Defense' | 'Technology' | 'Finance' | 'Healthcare' | 'Retail & E-commerce' | 'Entertainment' | 'Education' | 'Government & Nonprofit' | 'Industrial & Energy' | 'Automotive & Transportation' | 'Lifestyle & Leisure' | 'Luxury & Fashion' | 'News & Media' | 'Sports' | 'Real Estate & PropTech' | 'Legal & Compliance' | 'Telecommunications' | 'Agriculture & Food' | 'Professional Services & Agencies' | 'Chemicals & Materials' | 'Logistics & Supply Chain' | 'Hospitality & Tourism' | 'Construction & Built Environment' | 'Consumer Packaged Goods (CPG)';
|
|
308
|
+
/**
|
|
309
|
+
* Subindustry classification enum
|
|
310
|
+
*/
|
|
311
|
+
subindustry: 'Defense Systems & Military Hardware' | 'Aerospace Manufacturing' | 'Avionics & Navigation Technology' | 'Subsea & Naval Defense Systems' | 'Space & Satellite Technology' | 'Defense IT & Systems Integration' | 'Software (B2B)' | 'Software (B2C)' | 'Cloud Infrastructure & DevOps' | 'Cybersecurity' | 'Artificial Intelligence & Machine Learning' | 'Data Infrastructure & Analytics' | 'Hardware & Semiconductors' | 'Fintech Infrastructure' | 'eCommerce & Marketplace Platforms' | 'Developer Tools & APIs' | 'Web3 & Blockchain' | 'XR & Spatial Computing' | 'Banking & Lending' | 'Investment Management & WealthTech' | 'Insurance & InsurTech' | 'Payments & Money Movement' | 'Accounting, Tax & Financial Planning Tools' | 'Capital Markets & Trading Platforms' | 'Financial Infrastructure & APIs' | 'Credit Scoring & Risk Management' | 'Cryptocurrency & Digital Assets' | 'BNPL & Alternative Financing' | 'Healthcare Providers & Services' | 'Pharmaceuticals & Drug Development' | 'Medical Devices & Diagnostics' | 'Biotechnology & Genomics' | 'Digital Health & Telemedicine' | 'Health Insurance & Benefits Tech' | 'Clinical Trials & Research Platforms' | 'Mental Health & Wellness' | 'Healthcare IT & EHR Systems' | 'Consumer Health & Wellness Products' | 'Online Marketplaces' | 'Direct-to-Consumer (DTC) Brands' | 'Retail Tech & Point-of-Sale Systems' | 'Omnichannel & In-Store Retail' | 'E-commerce Enablement & Infrastructure' | 'Subscription & Membership Commerce' | 'Social Commerce & Influencer Platforms' | 'Fashion & Apparel Retail' | 'Food, Beverage & Grocery E-commerce' | 'Streaming Platforms (Video, Music, Audio)' | 'Gaming & Interactive Entertainment' | 'Creator Economy & Influencer Platforms' | 'Advertising, Adtech & Media Buying' | 'Film, TV & Production Studios' | 'Events, Venues & Live Entertainment' | 'Virtual Worlds & Metaverse Experiences' | 'K-12 Education Platforms & Tools' | 'Higher Education & University Tech' | 'Online Learning & MOOCs' | 'Test Prep & Certification' | 'Corporate Training & Upskilling' | 'Tutoring & Supplemental Learning' | 'Education Management Systems (LMS/SIS)' | 'Language Learning' | 'Creator-Led & Cohort-Based Courses' | 'Special Education & Accessibility Tools' | 'Government Technology & Digital Services' | 'Civic Engagement & Policy Platforms' | 'International Development & Humanitarian Aid' | 'Philanthropy & Grantmaking' | 'Nonprofit Operations & Fundraising Tools' | 'Public Health & Social Services' | 'Education & Youth Development Programs' | 'Environmental & Climate Action Organizations' | 'Legal Aid & Social Justice Advocacy' | 'Municipal & Infrastructure Services' | 'Manufacturing & Industrial Automation' | 'Energy Production (Oil, Gas, Nuclear)' | 'Renewable Energy & Cleantech' | 'Utilities & Grid Infrastructure' | 'Industrial IoT & Monitoring Systems' | 'Construction & Heavy Equipment' | 'Mining & Natural Resources' | 'Environmental Engineering & Sustainability' | 'Energy Storage & Battery Technology' | 'Automotive OEMs & Vehicle Manufacturing' | 'Electric Vehicles (EVs) & Charging Infrastructure' | 'Mobility-as-a-Service (MaaS)' | 'Fleet Management' | 'Public Transit & Urban Mobility' | 'Autonomous Vehicles & ADAS' | 'Aftermarket Parts & Services' | 'Telematics & Vehicle Connectivity' | 'Aviation & Aerospace Transport' | 'Maritime Shipping' | 'Fitness & Wellness' | 'Beauty & Personal Care' | 'Home & Living' | 'Dating & Relationships' | 'Hobbies, Crafts & DIY' | 'Outdoor & Recreational Gear' | 'Events, Experiences & Ticketing Platforms' | 'Designer & Luxury Apparel' | 'Accessories, Jewelry & Watches' | 'Footwear & Leather Goods' | 'Beauty, Fragrance & Skincare' | 'Fashion Marketplaces & Retail Platforms' | 'Sustainable & Ethical Fashion' | 'Resale, Vintage & Circular Fashion' | 'Fashion Tech & Virtual Try-Ons' | 'Streetwear & Emerging Luxury' | 'Couture & Made-to-Measure' | 'News Publishing & Journalism' | 'Digital Media & Content Platforms' | 'Broadcasting (TV & Radio)' | 'Podcasting & Audio Media' | 'News Aggregators & Curation Tools' | 'Independent & Creator-Led Media' | 'Newsletters & Substack-Style Platforms' | 'Political & Investigative Media' | 'Trade & Niche Publications' | 'Media Monitoring & Analytics' | 'Professional Teams & Leagues' | 'Sports Media & Broadcasting' | 'Sports Betting & Fantasy Sports' | 'Fitness & Athletic Training Platforms' | 'Sportswear & Equipment' | 'Esports & Competitive Gaming' | 'Sports Venues & Event Management' | 'Athlete Management & Talent Agencies' | 'Sports Tech & Performance Analytics' | 'Youth, Amateur & Collegiate Sports' | 'Real Estate Marketplaces' | 'Property Management Software' | 'Rental Platforms' | 'Mortgage & Lending Tech' | 'Real Estate Investment Platforms' | 'Law Firms & Legal Services' | 'Legal Tech & Automation' | 'Regulatory Compliance' | 'E-Discovery & Litigation Tools' | 'Contract Management' | 'Governance, Risk & Compliance (GRC)' | 'IP & Trademark Management' | 'Legal Research & Intelligence' | 'Compliance Training & Certification' | 'Whistleblower & Ethics Reporting' | 'Mobile & Wireless Networks (3G/4G/5G)' | 'Broadband & Fiber Internet' | 'Satellite & Space-Based Communications' | 'Network Equipment & Infrastructure' | 'Telecom Billing & OSS/BSS Systems' | 'VoIP & Unified Communications' | 'Internet Service Providers (ISPs)' | 'Edge Computing & Network Virtualization' | 'IoT Connectivity Platforms' | 'Precision Agriculture & AgTech' | 'Crop & Livestock Production' | 'Food & Beverage Manufacturing & Processing' | 'Food Distribution' | 'Restaurants & Food Service' | 'Agricultural Inputs & Equipment' | 'Sustainable & Regenerative Agriculture' | 'Seafood & Aquaculture' | 'Management Consulting' | 'Marketing & Advertising Agencies' | 'Design, Branding & Creative Studios' | 'IT Services & Managed Services' | 'Staffing, Recruiting & Talent' | 'Accounting & Tax Firms' | 'Public Relations & Communications' | 'Business Process Outsourcing (BPO)' | 'Professional Training & Coaching' | 'Specialty Chemicals' | 'Commodity & Petrochemicals' | 'Polymers, Plastics & Rubber' | 'Coatings, Adhesives & Sealants' | 'Industrial Gases' | 'Advanced Materials & Composites' | 'Battery Materials & Energy Storage' | 'Electronic Materials & Semiconductor Chemicals' | 'Agrochemicals & Fertilizers' | 'Freight & Transportation Tech' | 'Last-Mile Delivery' | 'Warehouse Automation' | 'Supply Chain Visibility Platforms' | 'Logistics Marketplaces' | 'Shipping & Freight Forwarding' | 'Cold Chain Logistics' | 'Reverse Logistics & Returns' | 'Cross-Border Trade Tech' | 'Transportation Management Systems (TMS)' | 'Hotels & Accommodation' | 'Vacation Rentals & Short-Term Stays' | 'Restaurant Tech & Management' | 'Travel Booking Platforms' | 'Tourism Experiences & Activities' | 'Cruise Lines & Marine Tourism' | 'Hospitality Management Systems' | 'Event & Venue Management' | 'Corporate Travel Management' | 'Travel Insurance & Protection' | 'Construction Management Software' | 'BIM/CAD & Design Tools' | 'Construction Marketplaces' | 'Equipment Rental & Management' | 'Building Materials & Procurement' | 'Construction Workforce Management' | 'Project Estimation & Bidding' | 'Modular & Prefab Construction' | 'Construction Safety & Compliance' | 'Smart Building Technology' | 'Food & Beverage CPG' | 'Home & Personal Care CPG' | 'CPG Analytics & Insights' | 'Direct-to-Consumer CPG Brands' | 'CPG Supply Chain & Distribution' | 'Private Label Manufacturing' | 'CPG Retail Intelligence' | 'Sustainable CPG & Packaging' | 'Beauty & Cosmetics CPG' | 'Health & Wellness CPG';
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* Important website links for the brand
|
|
316
|
+
*/
|
|
317
|
+
interface Links {
|
|
318
|
+
/**
|
|
319
|
+
* URL to the brand's blog or news page
|
|
320
|
+
*/
|
|
321
|
+
blog?: string | null;
|
|
322
|
+
/**
|
|
323
|
+
* URL to the brand's careers or job opportunities page
|
|
324
|
+
*/
|
|
325
|
+
careers?: string | null;
|
|
326
|
+
/**
|
|
327
|
+
* URL to the brand's contact or contact us page
|
|
328
|
+
*/
|
|
329
|
+
contact?: string | null;
|
|
330
|
+
/**
|
|
331
|
+
* URL to the brand's pricing or plans page
|
|
332
|
+
*/
|
|
333
|
+
pricing?: string | null;
|
|
334
|
+
/**
|
|
335
|
+
* URL to the brand's privacy policy page
|
|
336
|
+
*/
|
|
337
|
+
privacy?: string | null;
|
|
338
|
+
/**
|
|
339
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
340
|
+
*/
|
|
341
|
+
terms?: string | null;
|
|
342
|
+
}
|
|
343
|
+
interface Logo {
|
|
344
|
+
/**
|
|
345
|
+
* Array of colors in the logo
|
|
346
|
+
*/
|
|
347
|
+
colors?: Array<Logo.Color>;
|
|
348
|
+
/**
|
|
349
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
350
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
351
|
+
* has its own background
|
|
352
|
+
*/
|
|
353
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
354
|
+
/**
|
|
355
|
+
* Resolution of the logo image
|
|
356
|
+
*/
|
|
357
|
+
resolution?: Logo.Resolution;
|
|
358
|
+
/**
|
|
359
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
360
|
+
*/
|
|
361
|
+
type?: 'icon' | 'logo';
|
|
362
|
+
/**
|
|
363
|
+
* CDN hosted url of the logo (ready for display)
|
|
364
|
+
*/
|
|
365
|
+
url?: string;
|
|
366
|
+
}
|
|
367
|
+
namespace Logo {
|
|
368
|
+
interface Color {
|
|
369
|
+
/**
|
|
370
|
+
* Color in hexadecimal format
|
|
371
|
+
*/
|
|
372
|
+
hex?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Name of the color
|
|
375
|
+
*/
|
|
376
|
+
name?: string;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* Resolution of the logo image
|
|
380
|
+
*/
|
|
381
|
+
interface Resolution {
|
|
382
|
+
/**
|
|
383
|
+
* Aspect ratio of the image (width/height)
|
|
384
|
+
*/
|
|
385
|
+
aspect_ratio?: number;
|
|
386
|
+
/**
|
|
387
|
+
* Height of the image in pixels
|
|
388
|
+
*/
|
|
389
|
+
height?: number;
|
|
390
|
+
/**
|
|
391
|
+
* Width of the image in pixels
|
|
392
|
+
*/
|
|
393
|
+
width?: number;
|
|
394
|
+
}
|
|
395
|
+
}
|
|
396
|
+
interface Social {
|
|
397
|
+
/**
|
|
398
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
399
|
+
*/
|
|
400
|
+
type?: string;
|
|
401
|
+
/**
|
|
402
|
+
* URL of the social media page
|
|
403
|
+
*/
|
|
404
|
+
url?: string;
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
408
|
+
* company)
|
|
409
|
+
*/
|
|
410
|
+
interface Stock {
|
|
411
|
+
/**
|
|
412
|
+
* Stock exchange name
|
|
413
|
+
*/
|
|
414
|
+
exchange?: string;
|
|
415
|
+
/**
|
|
416
|
+
* Stock ticker symbol
|
|
417
|
+
*/
|
|
418
|
+
ticker?: string;
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
export interface BrandAIProductResponse {
|
|
423
|
+
/**
|
|
424
|
+
* Whether the given URL is a product detail page
|
|
425
|
+
*/
|
|
426
|
+
is_product_page?: boolean;
|
|
427
|
+
/**
|
|
428
|
+
* The detected ecommerce platform, or null if not a product page
|
|
429
|
+
*/
|
|
430
|
+
platform?: 'amazon' | 'tiktok_shop' | 'etsy' | 'generic' | null;
|
|
431
|
+
/**
|
|
432
|
+
* The extracted product data, or null if not a product page
|
|
433
|
+
*/
|
|
434
|
+
product?: BrandAIProductResponse.Product | null;
|
|
435
|
+
}
|
|
436
|
+
export declare namespace BrandAIProductResponse {
|
|
437
|
+
/**
|
|
438
|
+
* The extracted product data, or null if not a product page
|
|
439
|
+
*/
|
|
440
|
+
interface Product {
|
|
441
|
+
/**
|
|
442
|
+
* Description of the product
|
|
443
|
+
*/
|
|
444
|
+
description: string;
|
|
445
|
+
/**
|
|
446
|
+
* List of product features
|
|
447
|
+
*/
|
|
448
|
+
features: Array<string>;
|
|
449
|
+
/**
|
|
450
|
+
* URLs to product images on the page (up to 7)
|
|
451
|
+
*/
|
|
452
|
+
images: Array<string>;
|
|
453
|
+
/**
|
|
454
|
+
* Name of the product
|
|
455
|
+
*/
|
|
456
|
+
name: string;
|
|
457
|
+
/**
|
|
458
|
+
* Tags associated with the product
|
|
459
|
+
*/
|
|
460
|
+
tags: Array<string>;
|
|
461
|
+
/**
|
|
462
|
+
* Target audience for the product (array of strings)
|
|
463
|
+
*/
|
|
464
|
+
target_audience: Array<string>;
|
|
465
|
+
/**
|
|
466
|
+
* Billing frequency for the product
|
|
467
|
+
*/
|
|
468
|
+
billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
|
|
469
|
+
/**
|
|
470
|
+
* Category of the product
|
|
471
|
+
*/
|
|
472
|
+
category?: string | null;
|
|
473
|
+
/**
|
|
474
|
+
* Currency code for the price (e.g., USD, EUR)
|
|
475
|
+
*/
|
|
476
|
+
currency?: string | null;
|
|
477
|
+
/**
|
|
478
|
+
* URL to the product image
|
|
479
|
+
*/
|
|
480
|
+
image_url?: string | null;
|
|
481
|
+
/**
|
|
482
|
+
* Price of the product
|
|
483
|
+
*/
|
|
484
|
+
price?: number | null;
|
|
485
|
+
/**
|
|
486
|
+
* Pricing model for the product
|
|
487
|
+
*/
|
|
488
|
+
pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
|
|
489
|
+
/**
|
|
490
|
+
* URL to the product page
|
|
491
|
+
*/
|
|
492
|
+
url?: string | null;
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
export interface BrandAIProductsResponse {
|
|
496
|
+
/**
|
|
497
|
+
* Array of products extracted from the website
|
|
498
|
+
*/
|
|
499
|
+
products?: Array<BrandAIProductsResponse.Product>;
|
|
500
|
+
}
|
|
501
|
+
export declare namespace BrandAIProductsResponse {
|
|
502
|
+
interface Product {
|
|
503
|
+
/**
|
|
504
|
+
* Description of the product
|
|
505
|
+
*/
|
|
506
|
+
description: string;
|
|
507
|
+
/**
|
|
508
|
+
* List of product features
|
|
509
|
+
*/
|
|
510
|
+
features: Array<string>;
|
|
511
|
+
/**
|
|
512
|
+
* URLs to product images on the page (up to 7)
|
|
513
|
+
*/
|
|
514
|
+
images: Array<string>;
|
|
515
|
+
/**
|
|
516
|
+
* Name of the product
|
|
517
|
+
*/
|
|
518
|
+
name: string;
|
|
519
|
+
/**
|
|
520
|
+
* Tags associated with the product
|
|
521
|
+
*/
|
|
522
|
+
tags: Array<string>;
|
|
523
|
+
/**
|
|
524
|
+
* Target audience for the product (array of strings)
|
|
525
|
+
*/
|
|
526
|
+
target_audience: Array<string>;
|
|
527
|
+
/**
|
|
528
|
+
* Billing frequency for the product
|
|
529
|
+
*/
|
|
530
|
+
billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
|
|
531
|
+
/**
|
|
532
|
+
* Category of the product
|
|
533
|
+
*/
|
|
534
|
+
category?: string | null;
|
|
535
|
+
/**
|
|
536
|
+
* Currency code for the price (e.g., USD, EUR)
|
|
537
|
+
*/
|
|
538
|
+
currency?: string | null;
|
|
539
|
+
/**
|
|
540
|
+
* URL to the product image
|
|
541
|
+
*/
|
|
542
|
+
image_url?: string | null;
|
|
543
|
+
/**
|
|
544
|
+
* Price of the product
|
|
545
|
+
*/
|
|
546
|
+
price?: number | null;
|
|
547
|
+
/**
|
|
548
|
+
* Pricing model for the product
|
|
549
|
+
*/
|
|
550
|
+
pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
|
|
551
|
+
/**
|
|
552
|
+
* URL to the product page
|
|
553
|
+
*/
|
|
554
|
+
url?: string | null;
|
|
555
|
+
}
|
|
556
|
+
}
|
|
557
|
+
export interface BrandAIQueryResponse {
|
|
558
|
+
/**
|
|
559
|
+
* Array of extracted data points
|
|
560
|
+
*/
|
|
561
|
+
data_extracted?: Array<BrandAIQueryResponse.DataExtracted>;
|
|
562
|
+
/**
|
|
563
|
+
* The domain that was analyzed
|
|
564
|
+
*/
|
|
565
|
+
domain?: string;
|
|
566
|
+
/**
|
|
567
|
+
* Status of the response, e.g., 'ok'
|
|
568
|
+
*/
|
|
569
|
+
status?: string;
|
|
570
|
+
/**
|
|
571
|
+
* List of URLs that were analyzed
|
|
572
|
+
*/
|
|
573
|
+
urls_analyzed?: Array<string>;
|
|
574
|
+
}
|
|
575
|
+
export declare namespace BrandAIQueryResponse {
|
|
576
|
+
interface DataExtracted {
|
|
577
|
+
/**
|
|
578
|
+
* Name of the extracted data point
|
|
579
|
+
*/
|
|
580
|
+
datapoint_name?: string;
|
|
581
|
+
/**
|
|
582
|
+
* Value of the extracted data point. Can be a primitive type, an array of
|
|
583
|
+
* primitives, or an array of objects when datapoint_list_type is 'object'.
|
|
584
|
+
*/
|
|
585
|
+
datapoint_value?: string | number | boolean | Array<string> | Array<number> | Array<unknown>;
|
|
586
|
+
}
|
|
587
|
+
}
|
|
588
|
+
export interface BrandFontsResponse {
|
|
589
|
+
/**
|
|
590
|
+
* HTTP status code, e.g., 200
|
|
591
|
+
*/
|
|
592
|
+
code: number;
|
|
593
|
+
/**
|
|
594
|
+
* The normalized domain that was processed
|
|
595
|
+
*/
|
|
596
|
+
domain: string;
|
|
597
|
+
/**
|
|
598
|
+
* Array of font usage information
|
|
599
|
+
*/
|
|
600
|
+
fonts: Array<BrandFontsResponse.Font>;
|
|
601
|
+
/**
|
|
602
|
+
* Status of the response, e.g., 'ok'
|
|
603
|
+
*/
|
|
604
|
+
status: string;
|
|
605
|
+
}
|
|
606
|
+
export declare namespace BrandFontsResponse {
|
|
607
|
+
interface Font {
|
|
608
|
+
/**
|
|
609
|
+
* Array of fallback font families
|
|
610
|
+
*/
|
|
611
|
+
fallbacks: Array<string>;
|
|
612
|
+
/**
|
|
613
|
+
* Font family name
|
|
614
|
+
*/
|
|
615
|
+
font: string;
|
|
616
|
+
/**
|
|
617
|
+
* Number of elements using this font
|
|
618
|
+
*/
|
|
619
|
+
num_elements: number;
|
|
620
|
+
/**
|
|
621
|
+
* Number of words using this font
|
|
622
|
+
*/
|
|
623
|
+
num_words: number;
|
|
624
|
+
/**
|
|
625
|
+
* Percentage of elements using this font
|
|
626
|
+
*/
|
|
627
|
+
percent_elements: number;
|
|
628
|
+
/**
|
|
629
|
+
* Percentage of words using this font
|
|
630
|
+
*/
|
|
631
|
+
percent_words: number;
|
|
632
|
+
/**
|
|
633
|
+
* Array of CSS selectors or element types where this font is used
|
|
634
|
+
*/
|
|
635
|
+
uses: Array<string>;
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
export interface BrandIdentifyFromTransactionResponse {
|
|
639
|
+
/**
|
|
640
|
+
* Detailed brand information
|
|
641
|
+
*/
|
|
642
|
+
brand?: BrandIdentifyFromTransactionResponse.Brand;
|
|
643
|
+
/**
|
|
644
|
+
* HTTP status code
|
|
645
|
+
*/
|
|
646
|
+
code?: number;
|
|
647
|
+
/**
|
|
648
|
+
* Status of the response, e.g., 'ok'
|
|
649
|
+
*/
|
|
650
|
+
status?: string;
|
|
651
|
+
}
|
|
652
|
+
export declare namespace BrandIdentifyFromTransactionResponse {
|
|
653
|
+
/**
|
|
654
|
+
* Detailed brand information
|
|
655
|
+
*/
|
|
656
|
+
interface Brand {
|
|
657
|
+
/**
|
|
658
|
+
* Physical address of the brand
|
|
659
|
+
*/
|
|
660
|
+
address?: Brand.Address;
|
|
661
|
+
/**
|
|
662
|
+
* An array of backdrop images for the brand
|
|
663
|
+
*/
|
|
664
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
665
|
+
/**
|
|
666
|
+
* An array of brand colors
|
|
667
|
+
*/
|
|
668
|
+
colors?: Array<Brand.Color>;
|
|
669
|
+
/**
|
|
670
|
+
* A brief description of the brand
|
|
671
|
+
*/
|
|
672
|
+
description?: string;
|
|
673
|
+
/**
|
|
674
|
+
* The domain name of the brand
|
|
675
|
+
*/
|
|
676
|
+
domain?: string;
|
|
677
|
+
/**
|
|
678
|
+
* Company email address
|
|
679
|
+
*/
|
|
680
|
+
email?: string;
|
|
681
|
+
/**
|
|
682
|
+
* Industry classification information for the brand
|
|
683
|
+
*/
|
|
684
|
+
industries?: Brand.Industries;
|
|
685
|
+
/**
|
|
686
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
687
|
+
*/
|
|
688
|
+
is_nsfw?: boolean;
|
|
689
|
+
/**
|
|
690
|
+
* Important website links for the brand
|
|
691
|
+
*/
|
|
692
|
+
links?: Brand.Links;
|
|
693
|
+
/**
|
|
694
|
+
* An array of logos associated with the brand
|
|
695
|
+
*/
|
|
696
|
+
logos?: Array<Brand.Logo>;
|
|
697
|
+
/**
|
|
698
|
+
* Company phone number
|
|
699
|
+
*/
|
|
700
|
+
phone?: string;
|
|
701
|
+
/**
|
|
702
|
+
* The brand's slogan
|
|
703
|
+
*/
|
|
704
|
+
slogan?: string;
|
|
705
|
+
/**
|
|
706
|
+
* An array of social media links for the brand
|
|
707
|
+
*/
|
|
708
|
+
socials?: Array<Brand.Social>;
|
|
709
|
+
/**
|
|
710
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
711
|
+
* company)
|
|
712
|
+
*/
|
|
713
|
+
stock?: Brand.Stock;
|
|
714
|
+
/**
|
|
715
|
+
* The title or name of the brand
|
|
716
|
+
*/
|
|
717
|
+
title?: string;
|
|
718
|
+
}
|
|
719
|
+
namespace Brand {
|
|
720
|
+
/**
|
|
721
|
+
* Physical address of the brand
|
|
722
|
+
*/
|
|
723
|
+
interface Address {
|
|
724
|
+
/**
|
|
725
|
+
* City name
|
|
726
|
+
*/
|
|
727
|
+
city?: string;
|
|
728
|
+
/**
|
|
729
|
+
* Country name
|
|
730
|
+
*/
|
|
731
|
+
country?: string;
|
|
732
|
+
/**
|
|
733
|
+
* Country code
|
|
734
|
+
*/
|
|
735
|
+
country_code?: string;
|
|
736
|
+
/**
|
|
737
|
+
* Postal or ZIP code
|
|
738
|
+
*/
|
|
739
|
+
postal_code?: string;
|
|
740
|
+
/**
|
|
741
|
+
* State or province code
|
|
742
|
+
*/
|
|
743
|
+
state_code?: string;
|
|
744
|
+
/**
|
|
745
|
+
* State or province name
|
|
746
|
+
*/
|
|
747
|
+
state_province?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Street address
|
|
750
|
+
*/
|
|
751
|
+
street?: string;
|
|
752
|
+
}
|
|
753
|
+
interface Backdrop {
|
|
754
|
+
/**
|
|
755
|
+
* Array of colors in the backdrop image
|
|
756
|
+
*/
|
|
757
|
+
colors?: Array<Backdrop.Color>;
|
|
758
|
+
/**
|
|
759
|
+
* Resolution of the backdrop image
|
|
760
|
+
*/
|
|
761
|
+
resolution?: Backdrop.Resolution;
|
|
762
|
+
/**
|
|
763
|
+
* URL of the backdrop image
|
|
764
|
+
*/
|
|
765
|
+
url?: string;
|
|
766
|
+
}
|
|
767
|
+
namespace Backdrop {
|
|
768
|
+
interface Color {
|
|
769
|
+
/**
|
|
770
|
+
* Color in hexadecimal format
|
|
771
|
+
*/
|
|
772
|
+
hex?: string;
|
|
773
|
+
/**
|
|
774
|
+
* Name of the color
|
|
775
|
+
*/
|
|
776
|
+
name?: string;
|
|
777
|
+
}
|
|
778
|
+
/**
|
|
779
|
+
* Resolution of the backdrop image
|
|
780
|
+
*/
|
|
781
|
+
interface Resolution {
|
|
782
|
+
/**
|
|
783
|
+
* Aspect ratio of the image (width/height)
|
|
784
|
+
*/
|
|
785
|
+
aspect_ratio?: number;
|
|
786
|
+
/**
|
|
787
|
+
* Height of the image in pixels
|
|
788
|
+
*/
|
|
789
|
+
height?: number;
|
|
790
|
+
/**
|
|
791
|
+
* Width of the image in pixels
|
|
792
|
+
*/
|
|
793
|
+
width?: number;
|
|
794
|
+
}
|
|
795
|
+
}
|
|
796
|
+
interface Color {
|
|
797
|
+
/**
|
|
798
|
+
* Color in hexadecimal format
|
|
799
|
+
*/
|
|
800
|
+
hex?: string;
|
|
801
|
+
/**
|
|
802
|
+
* Name of the color
|
|
803
|
+
*/
|
|
804
|
+
name?: string;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* Industry classification information for the brand
|
|
808
|
+
*/
|
|
809
|
+
interface Industries {
|
|
810
|
+
/**
|
|
811
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
812
|
+
*/
|
|
813
|
+
eic?: Array<Industries.Eic>;
|
|
814
|
+
}
|
|
815
|
+
namespace Industries {
|
|
816
|
+
interface Eic {
|
|
817
|
+
/**
|
|
818
|
+
* Industry classification enum
|
|
819
|
+
*/
|
|
820
|
+
industry: 'Aerospace & Defense' | 'Technology' | 'Finance' | 'Healthcare' | 'Retail & E-commerce' | 'Entertainment' | 'Education' | 'Government & Nonprofit' | 'Industrial & Energy' | 'Automotive & Transportation' | 'Lifestyle & Leisure' | 'Luxury & Fashion' | 'News & Media' | 'Sports' | 'Real Estate & PropTech' | 'Legal & Compliance' | 'Telecommunications' | 'Agriculture & Food' | 'Professional Services & Agencies' | 'Chemicals & Materials' | 'Logistics & Supply Chain' | 'Hospitality & Tourism' | 'Construction & Built Environment' | 'Consumer Packaged Goods (CPG)';
|
|
821
|
+
/**
|
|
822
|
+
* Subindustry classification enum
|
|
823
|
+
*/
|
|
824
|
+
subindustry: 'Defense Systems & Military Hardware' | 'Aerospace Manufacturing' | 'Avionics & Navigation Technology' | 'Subsea & Naval Defense Systems' | 'Space & Satellite Technology' | 'Defense IT & Systems Integration' | 'Software (B2B)' | 'Software (B2C)' | 'Cloud Infrastructure & DevOps' | 'Cybersecurity' | 'Artificial Intelligence & Machine Learning' | 'Data Infrastructure & Analytics' | 'Hardware & Semiconductors' | 'Fintech Infrastructure' | 'eCommerce & Marketplace Platforms' | 'Developer Tools & APIs' | 'Web3 & Blockchain' | 'XR & Spatial Computing' | 'Banking & Lending' | 'Investment Management & WealthTech' | 'Insurance & InsurTech' | 'Payments & Money Movement' | 'Accounting, Tax & Financial Planning Tools' | 'Capital Markets & Trading Platforms' | 'Financial Infrastructure & APIs' | 'Credit Scoring & Risk Management' | 'Cryptocurrency & Digital Assets' | 'BNPL & Alternative Financing' | 'Healthcare Providers & Services' | 'Pharmaceuticals & Drug Development' | 'Medical Devices & Diagnostics' | 'Biotechnology & Genomics' | 'Digital Health & Telemedicine' | 'Health Insurance & Benefits Tech' | 'Clinical Trials & Research Platforms' | 'Mental Health & Wellness' | 'Healthcare IT & EHR Systems' | 'Consumer Health & Wellness Products' | 'Online Marketplaces' | 'Direct-to-Consumer (DTC) Brands' | 'Retail Tech & Point-of-Sale Systems' | 'Omnichannel & In-Store Retail' | 'E-commerce Enablement & Infrastructure' | 'Subscription & Membership Commerce' | 'Social Commerce & Influencer Platforms' | 'Fashion & Apparel Retail' | 'Food, Beverage & Grocery E-commerce' | 'Streaming Platforms (Video, Music, Audio)' | 'Gaming & Interactive Entertainment' | 'Creator Economy & Influencer Platforms' | 'Advertising, Adtech & Media Buying' | 'Film, TV & Production Studios' | 'Events, Venues & Live Entertainment' | 'Virtual Worlds & Metaverse Experiences' | 'K-12 Education Platforms & Tools' | 'Higher Education & University Tech' | 'Online Learning & MOOCs' | 'Test Prep & Certification' | 'Corporate Training & Upskilling' | 'Tutoring & Supplemental Learning' | 'Education Management Systems (LMS/SIS)' | 'Language Learning' | 'Creator-Led & Cohort-Based Courses' | 'Special Education & Accessibility Tools' | 'Government Technology & Digital Services' | 'Civic Engagement & Policy Platforms' | 'International Development & Humanitarian Aid' | 'Philanthropy & Grantmaking' | 'Nonprofit Operations & Fundraising Tools' | 'Public Health & Social Services' | 'Education & Youth Development Programs' | 'Environmental & Climate Action Organizations' | 'Legal Aid & Social Justice Advocacy' | 'Municipal & Infrastructure Services' | 'Manufacturing & Industrial Automation' | 'Energy Production (Oil, Gas, Nuclear)' | 'Renewable Energy & Cleantech' | 'Utilities & Grid Infrastructure' | 'Industrial IoT & Monitoring Systems' | 'Construction & Heavy Equipment' | 'Mining & Natural Resources' | 'Environmental Engineering & Sustainability' | 'Energy Storage & Battery Technology' | 'Automotive OEMs & Vehicle Manufacturing' | 'Electric Vehicles (EVs) & Charging Infrastructure' | 'Mobility-as-a-Service (MaaS)' | 'Fleet Management' | 'Public Transit & Urban Mobility' | 'Autonomous Vehicles & ADAS' | 'Aftermarket Parts & Services' | 'Telematics & Vehicle Connectivity' | 'Aviation & Aerospace Transport' | 'Maritime Shipping' | 'Fitness & Wellness' | 'Beauty & Personal Care' | 'Home & Living' | 'Dating & Relationships' | 'Hobbies, Crafts & DIY' | 'Outdoor & Recreational Gear' | 'Events, Experiences & Ticketing Platforms' | 'Designer & Luxury Apparel' | 'Accessories, Jewelry & Watches' | 'Footwear & Leather Goods' | 'Beauty, Fragrance & Skincare' | 'Fashion Marketplaces & Retail Platforms' | 'Sustainable & Ethical Fashion' | 'Resale, Vintage & Circular Fashion' | 'Fashion Tech & Virtual Try-Ons' | 'Streetwear & Emerging Luxury' | 'Couture & Made-to-Measure' | 'News Publishing & Journalism' | 'Digital Media & Content Platforms' | 'Broadcasting (TV & Radio)' | 'Podcasting & Audio Media' | 'News Aggregators & Curation Tools' | 'Independent & Creator-Led Media' | 'Newsletters & Substack-Style Platforms' | 'Political & Investigative Media' | 'Trade & Niche Publications' | 'Media Monitoring & Analytics' | 'Professional Teams & Leagues' | 'Sports Media & Broadcasting' | 'Sports Betting & Fantasy Sports' | 'Fitness & Athletic Training Platforms' | 'Sportswear & Equipment' | 'Esports & Competitive Gaming' | 'Sports Venues & Event Management' | 'Athlete Management & Talent Agencies' | 'Sports Tech & Performance Analytics' | 'Youth, Amateur & Collegiate Sports' | 'Real Estate Marketplaces' | 'Property Management Software' | 'Rental Platforms' | 'Mortgage & Lending Tech' | 'Real Estate Investment Platforms' | 'Law Firms & Legal Services' | 'Legal Tech & Automation' | 'Regulatory Compliance' | 'E-Discovery & Litigation Tools' | 'Contract Management' | 'Governance, Risk & Compliance (GRC)' | 'IP & Trademark Management' | 'Legal Research & Intelligence' | 'Compliance Training & Certification' | 'Whistleblower & Ethics Reporting' | 'Mobile & Wireless Networks (3G/4G/5G)' | 'Broadband & Fiber Internet' | 'Satellite & Space-Based Communications' | 'Network Equipment & Infrastructure' | 'Telecom Billing & OSS/BSS Systems' | 'VoIP & Unified Communications' | 'Internet Service Providers (ISPs)' | 'Edge Computing & Network Virtualization' | 'IoT Connectivity Platforms' | 'Precision Agriculture & AgTech' | 'Crop & Livestock Production' | 'Food & Beverage Manufacturing & Processing' | 'Food Distribution' | 'Restaurants & Food Service' | 'Agricultural Inputs & Equipment' | 'Sustainable & Regenerative Agriculture' | 'Seafood & Aquaculture' | 'Management Consulting' | 'Marketing & Advertising Agencies' | 'Design, Branding & Creative Studios' | 'IT Services & Managed Services' | 'Staffing, Recruiting & Talent' | 'Accounting & Tax Firms' | 'Public Relations & Communications' | 'Business Process Outsourcing (BPO)' | 'Professional Training & Coaching' | 'Specialty Chemicals' | 'Commodity & Petrochemicals' | 'Polymers, Plastics & Rubber' | 'Coatings, Adhesives & Sealants' | 'Industrial Gases' | 'Advanced Materials & Composites' | 'Battery Materials & Energy Storage' | 'Electronic Materials & Semiconductor Chemicals' | 'Agrochemicals & Fertilizers' | 'Freight & Transportation Tech' | 'Last-Mile Delivery' | 'Warehouse Automation' | 'Supply Chain Visibility Platforms' | 'Logistics Marketplaces' | 'Shipping & Freight Forwarding' | 'Cold Chain Logistics' | 'Reverse Logistics & Returns' | 'Cross-Border Trade Tech' | 'Transportation Management Systems (TMS)' | 'Hotels & Accommodation' | 'Vacation Rentals & Short-Term Stays' | 'Restaurant Tech & Management' | 'Travel Booking Platforms' | 'Tourism Experiences & Activities' | 'Cruise Lines & Marine Tourism' | 'Hospitality Management Systems' | 'Event & Venue Management' | 'Corporate Travel Management' | 'Travel Insurance & Protection' | 'Construction Management Software' | 'BIM/CAD & Design Tools' | 'Construction Marketplaces' | 'Equipment Rental & Management' | 'Building Materials & Procurement' | 'Construction Workforce Management' | 'Project Estimation & Bidding' | 'Modular & Prefab Construction' | 'Construction Safety & Compliance' | 'Smart Building Technology' | 'Food & Beverage CPG' | 'Home & Personal Care CPG' | 'CPG Analytics & Insights' | 'Direct-to-Consumer CPG Brands' | 'CPG Supply Chain & Distribution' | 'Private Label Manufacturing' | 'CPG Retail Intelligence' | 'Sustainable CPG & Packaging' | 'Beauty & Cosmetics CPG' | 'Health & Wellness CPG';
|
|
825
|
+
}
|
|
826
|
+
}
|
|
827
|
+
/**
|
|
828
|
+
* Important website links for the brand
|
|
829
|
+
*/
|
|
830
|
+
interface Links {
|
|
831
|
+
/**
|
|
832
|
+
* URL to the brand's blog or news page
|
|
833
|
+
*/
|
|
834
|
+
blog?: string | null;
|
|
835
|
+
/**
|
|
836
|
+
* URL to the brand's careers or job opportunities page
|
|
837
|
+
*/
|
|
838
|
+
careers?: string | null;
|
|
839
|
+
/**
|
|
840
|
+
* URL to the brand's contact or contact us page
|
|
841
|
+
*/
|
|
842
|
+
contact?: string | null;
|
|
843
|
+
/**
|
|
844
|
+
* URL to the brand's pricing or plans page
|
|
845
|
+
*/
|
|
846
|
+
pricing?: string | null;
|
|
847
|
+
/**
|
|
848
|
+
* URL to the brand's privacy policy page
|
|
849
|
+
*/
|
|
850
|
+
privacy?: string | null;
|
|
851
|
+
/**
|
|
852
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
853
|
+
*/
|
|
854
|
+
terms?: string | null;
|
|
855
|
+
}
|
|
856
|
+
interface Logo {
|
|
857
|
+
/**
|
|
858
|
+
* Array of colors in the logo
|
|
859
|
+
*/
|
|
860
|
+
colors?: Array<Logo.Color>;
|
|
861
|
+
/**
|
|
862
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
863
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
864
|
+
* has its own background
|
|
865
|
+
*/
|
|
866
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
867
|
+
/**
|
|
868
|
+
* Resolution of the logo image
|
|
869
|
+
*/
|
|
870
|
+
resolution?: Logo.Resolution;
|
|
871
|
+
/**
|
|
872
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
873
|
+
*/
|
|
874
|
+
type?: 'icon' | 'logo';
|
|
875
|
+
/**
|
|
876
|
+
* CDN hosted url of the logo (ready for display)
|
|
877
|
+
*/
|
|
878
|
+
url?: string;
|
|
879
|
+
}
|
|
880
|
+
namespace Logo {
|
|
881
|
+
interface Color {
|
|
882
|
+
/**
|
|
883
|
+
* Color in hexadecimal format
|
|
884
|
+
*/
|
|
885
|
+
hex?: string;
|
|
886
|
+
/**
|
|
887
|
+
* Name of the color
|
|
888
|
+
*/
|
|
889
|
+
name?: string;
|
|
890
|
+
}
|
|
891
|
+
/**
|
|
892
|
+
* Resolution of the logo image
|
|
893
|
+
*/
|
|
894
|
+
interface Resolution {
|
|
895
|
+
/**
|
|
896
|
+
* Aspect ratio of the image (width/height)
|
|
897
|
+
*/
|
|
898
|
+
aspect_ratio?: number;
|
|
899
|
+
/**
|
|
900
|
+
* Height of the image in pixels
|
|
901
|
+
*/
|
|
902
|
+
height?: number;
|
|
903
|
+
/**
|
|
904
|
+
* Width of the image in pixels
|
|
905
|
+
*/
|
|
906
|
+
width?: number;
|
|
907
|
+
}
|
|
908
|
+
}
|
|
909
|
+
interface Social {
|
|
910
|
+
/**
|
|
911
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
912
|
+
*/
|
|
913
|
+
type?: string;
|
|
914
|
+
/**
|
|
915
|
+
* URL of the social media page
|
|
916
|
+
*/
|
|
917
|
+
url?: string;
|
|
918
|
+
}
|
|
919
|
+
/**
|
|
920
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
921
|
+
* company)
|
|
922
|
+
*/
|
|
923
|
+
interface Stock {
|
|
924
|
+
/**
|
|
925
|
+
* Stock exchange name
|
|
926
|
+
*/
|
|
927
|
+
exchange?: string;
|
|
928
|
+
/**
|
|
929
|
+
* Stock ticker symbol
|
|
930
|
+
*/
|
|
931
|
+
ticker?: string;
|
|
932
|
+
}
|
|
933
|
+
}
|
|
934
|
+
}
|
|
935
|
+
export interface BrandPrefetchResponse {
|
|
936
|
+
/**
|
|
937
|
+
* The domain that was queued for prefetching
|
|
938
|
+
*/
|
|
939
|
+
domain?: string;
|
|
940
|
+
/**
|
|
941
|
+
* Success message
|
|
942
|
+
*/
|
|
943
|
+
message?: string;
|
|
944
|
+
/**
|
|
945
|
+
* Status of the response, e.g., 'ok'
|
|
946
|
+
*/
|
|
947
|
+
status?: string;
|
|
948
|
+
}
|
|
949
|
+
export interface BrandPrefetchByEmailResponse {
|
|
950
|
+
/**
|
|
951
|
+
* The domain that was queued for prefetching
|
|
952
|
+
*/
|
|
953
|
+
domain?: string;
|
|
954
|
+
/**
|
|
955
|
+
* Success message
|
|
956
|
+
*/
|
|
957
|
+
message?: string;
|
|
958
|
+
/**
|
|
959
|
+
* Status of the response, e.g., 'ok'
|
|
960
|
+
*/
|
|
961
|
+
status?: string;
|
|
962
|
+
}
|
|
963
|
+
export interface BrandRetrieveByEmailResponse {
|
|
964
|
+
/**
|
|
965
|
+
* Detailed brand information
|
|
966
|
+
*/
|
|
967
|
+
brand?: BrandRetrieveByEmailResponse.Brand;
|
|
968
|
+
/**
|
|
969
|
+
* HTTP status code
|
|
970
|
+
*/
|
|
971
|
+
code?: number;
|
|
972
|
+
/**
|
|
973
|
+
* Status of the response, e.g., 'ok'
|
|
974
|
+
*/
|
|
975
|
+
status?: string;
|
|
976
|
+
}
|
|
977
|
+
export declare namespace BrandRetrieveByEmailResponse {
|
|
978
|
+
/**
|
|
979
|
+
* Detailed brand information
|
|
980
|
+
*/
|
|
981
|
+
interface Brand {
|
|
982
|
+
/**
|
|
983
|
+
* Physical address of the brand
|
|
984
|
+
*/
|
|
985
|
+
address?: Brand.Address;
|
|
986
|
+
/**
|
|
987
|
+
* An array of backdrop images for the brand
|
|
988
|
+
*/
|
|
989
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
990
|
+
/**
|
|
991
|
+
* An array of brand colors
|
|
992
|
+
*/
|
|
993
|
+
colors?: Array<Brand.Color>;
|
|
994
|
+
/**
|
|
995
|
+
* A brief description of the brand
|
|
996
|
+
*/
|
|
997
|
+
description?: string;
|
|
998
|
+
/**
|
|
999
|
+
* The domain name of the brand
|
|
1000
|
+
*/
|
|
1001
|
+
domain?: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* Company email address
|
|
1004
|
+
*/
|
|
1005
|
+
email?: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* Industry classification information for the brand
|
|
1008
|
+
*/
|
|
1009
|
+
industries?: Brand.Industries;
|
|
1010
|
+
/**
|
|
1011
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
1012
|
+
*/
|
|
1013
|
+
is_nsfw?: boolean;
|
|
1014
|
+
/**
|
|
1015
|
+
* Important website links for the brand
|
|
1016
|
+
*/
|
|
1017
|
+
links?: Brand.Links;
|
|
1018
|
+
/**
|
|
1019
|
+
* An array of logos associated with the brand
|
|
1020
|
+
*/
|
|
1021
|
+
logos?: Array<Brand.Logo>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Company phone number
|
|
1024
|
+
*/
|
|
1025
|
+
phone?: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* The brand's slogan
|
|
1028
|
+
*/
|
|
1029
|
+
slogan?: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* An array of social media links for the brand
|
|
1032
|
+
*/
|
|
1033
|
+
socials?: Array<Brand.Social>;
|
|
1034
|
+
/**
|
|
1035
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1036
|
+
* company)
|
|
1037
|
+
*/
|
|
1038
|
+
stock?: Brand.Stock;
|
|
1039
|
+
/**
|
|
1040
|
+
* The title or name of the brand
|
|
1041
|
+
*/
|
|
1042
|
+
title?: string;
|
|
1043
|
+
}
|
|
1044
|
+
namespace Brand {
|
|
1045
|
+
/**
|
|
1046
|
+
* Physical address of the brand
|
|
1047
|
+
*/
|
|
1048
|
+
interface Address {
|
|
1049
|
+
/**
|
|
1050
|
+
* City name
|
|
1051
|
+
*/
|
|
1052
|
+
city?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Country name
|
|
1055
|
+
*/
|
|
1056
|
+
country?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* Country code
|
|
1059
|
+
*/
|
|
1060
|
+
country_code?: string;
|
|
1061
|
+
/**
|
|
1062
|
+
* Postal or ZIP code
|
|
1063
|
+
*/
|
|
1064
|
+
postal_code?: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* State or province code
|
|
1067
|
+
*/
|
|
1068
|
+
state_code?: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* State or province name
|
|
1071
|
+
*/
|
|
1072
|
+
state_province?: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* Street address
|
|
1075
|
+
*/
|
|
1076
|
+
street?: string;
|
|
1077
|
+
}
|
|
1078
|
+
interface Backdrop {
|
|
1079
|
+
/**
|
|
1080
|
+
* Array of colors in the backdrop image
|
|
1081
|
+
*/
|
|
1082
|
+
colors?: Array<Backdrop.Color>;
|
|
1083
|
+
/**
|
|
1084
|
+
* Resolution of the backdrop image
|
|
1085
|
+
*/
|
|
1086
|
+
resolution?: Backdrop.Resolution;
|
|
1087
|
+
/**
|
|
1088
|
+
* URL of the backdrop image
|
|
1089
|
+
*/
|
|
1090
|
+
url?: string;
|
|
1091
|
+
}
|
|
1092
|
+
namespace Backdrop {
|
|
1093
|
+
interface Color {
|
|
1094
|
+
/**
|
|
1095
|
+
* Color in hexadecimal format
|
|
1096
|
+
*/
|
|
1097
|
+
hex?: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* Name of the color
|
|
1100
|
+
*/
|
|
1101
|
+
name?: string;
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* Resolution of the backdrop image
|
|
1105
|
+
*/
|
|
1106
|
+
interface Resolution {
|
|
1107
|
+
/**
|
|
1108
|
+
* Aspect ratio of the image (width/height)
|
|
1109
|
+
*/
|
|
1110
|
+
aspect_ratio?: number;
|
|
1111
|
+
/**
|
|
1112
|
+
* Height of the image in pixels
|
|
1113
|
+
*/
|
|
1114
|
+
height?: number;
|
|
1115
|
+
/**
|
|
1116
|
+
* Width of the image in pixels
|
|
1117
|
+
*/
|
|
1118
|
+
width?: number;
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
interface Color {
|
|
1122
|
+
/**
|
|
1123
|
+
* Color in hexadecimal format
|
|
1124
|
+
*/
|
|
1125
|
+
hex?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* Name of the color
|
|
1128
|
+
*/
|
|
1129
|
+
name?: string;
|
|
1130
|
+
}
|
|
1131
|
+
/**
|
|
1132
|
+
* Industry classification information for the brand
|
|
1133
|
+
*/
|
|
1134
|
+
interface Industries {
|
|
1135
|
+
/**
|
|
1136
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
1137
|
+
*/
|
|
1138
|
+
eic?: Array<Industries.Eic>;
|
|
1139
|
+
}
|
|
1140
|
+
namespace Industries {
|
|
1141
|
+
interface Eic {
|
|
1142
|
+
/**
|
|
1143
|
+
* Industry classification enum
|
|
1144
|
+
*/
|
|
1145
|
+
industry: 'Aerospace & Defense' | 'Technology' | 'Finance' | 'Healthcare' | 'Retail & E-commerce' | 'Entertainment' | 'Education' | 'Government & Nonprofit' | 'Industrial & Energy' | 'Automotive & Transportation' | 'Lifestyle & Leisure' | 'Luxury & Fashion' | 'News & Media' | 'Sports' | 'Real Estate & PropTech' | 'Legal & Compliance' | 'Telecommunications' | 'Agriculture & Food' | 'Professional Services & Agencies' | 'Chemicals & Materials' | 'Logistics & Supply Chain' | 'Hospitality & Tourism' | 'Construction & Built Environment' | 'Consumer Packaged Goods (CPG)';
|
|
1146
|
+
/**
|
|
1147
|
+
* Subindustry classification enum
|
|
1148
|
+
*/
|
|
1149
|
+
subindustry: 'Defense Systems & Military Hardware' | 'Aerospace Manufacturing' | 'Avionics & Navigation Technology' | 'Subsea & Naval Defense Systems' | 'Space & Satellite Technology' | 'Defense IT & Systems Integration' | 'Software (B2B)' | 'Software (B2C)' | 'Cloud Infrastructure & DevOps' | 'Cybersecurity' | 'Artificial Intelligence & Machine Learning' | 'Data Infrastructure & Analytics' | 'Hardware & Semiconductors' | 'Fintech Infrastructure' | 'eCommerce & Marketplace Platforms' | 'Developer Tools & APIs' | 'Web3 & Blockchain' | 'XR & Spatial Computing' | 'Banking & Lending' | 'Investment Management & WealthTech' | 'Insurance & InsurTech' | 'Payments & Money Movement' | 'Accounting, Tax & Financial Planning Tools' | 'Capital Markets & Trading Platforms' | 'Financial Infrastructure & APIs' | 'Credit Scoring & Risk Management' | 'Cryptocurrency & Digital Assets' | 'BNPL & Alternative Financing' | 'Healthcare Providers & Services' | 'Pharmaceuticals & Drug Development' | 'Medical Devices & Diagnostics' | 'Biotechnology & Genomics' | 'Digital Health & Telemedicine' | 'Health Insurance & Benefits Tech' | 'Clinical Trials & Research Platforms' | 'Mental Health & Wellness' | 'Healthcare IT & EHR Systems' | 'Consumer Health & Wellness Products' | 'Online Marketplaces' | 'Direct-to-Consumer (DTC) Brands' | 'Retail Tech & Point-of-Sale Systems' | 'Omnichannel & In-Store Retail' | 'E-commerce Enablement & Infrastructure' | 'Subscription & Membership Commerce' | 'Social Commerce & Influencer Platforms' | 'Fashion & Apparel Retail' | 'Food, Beverage & Grocery E-commerce' | 'Streaming Platforms (Video, Music, Audio)' | 'Gaming & Interactive Entertainment' | 'Creator Economy & Influencer Platforms' | 'Advertising, Adtech & Media Buying' | 'Film, TV & Production Studios' | 'Events, Venues & Live Entertainment' | 'Virtual Worlds & Metaverse Experiences' | 'K-12 Education Platforms & Tools' | 'Higher Education & University Tech' | 'Online Learning & MOOCs' | 'Test Prep & Certification' | 'Corporate Training & Upskilling' | 'Tutoring & Supplemental Learning' | 'Education Management Systems (LMS/SIS)' | 'Language Learning' | 'Creator-Led & Cohort-Based Courses' | 'Special Education & Accessibility Tools' | 'Government Technology & Digital Services' | 'Civic Engagement & Policy Platforms' | 'International Development & Humanitarian Aid' | 'Philanthropy & Grantmaking' | 'Nonprofit Operations & Fundraising Tools' | 'Public Health & Social Services' | 'Education & Youth Development Programs' | 'Environmental & Climate Action Organizations' | 'Legal Aid & Social Justice Advocacy' | 'Municipal & Infrastructure Services' | 'Manufacturing & Industrial Automation' | 'Energy Production (Oil, Gas, Nuclear)' | 'Renewable Energy & Cleantech' | 'Utilities & Grid Infrastructure' | 'Industrial IoT & Monitoring Systems' | 'Construction & Heavy Equipment' | 'Mining & Natural Resources' | 'Environmental Engineering & Sustainability' | 'Energy Storage & Battery Technology' | 'Automotive OEMs & Vehicle Manufacturing' | 'Electric Vehicles (EVs) & Charging Infrastructure' | 'Mobility-as-a-Service (MaaS)' | 'Fleet Management' | 'Public Transit & Urban Mobility' | 'Autonomous Vehicles & ADAS' | 'Aftermarket Parts & Services' | 'Telematics & Vehicle Connectivity' | 'Aviation & Aerospace Transport' | 'Maritime Shipping' | 'Fitness & Wellness' | 'Beauty & Personal Care' | 'Home & Living' | 'Dating & Relationships' | 'Hobbies, Crafts & DIY' | 'Outdoor & Recreational Gear' | 'Events, Experiences & Ticketing Platforms' | 'Designer & Luxury Apparel' | 'Accessories, Jewelry & Watches' | 'Footwear & Leather Goods' | 'Beauty, Fragrance & Skincare' | 'Fashion Marketplaces & Retail Platforms' | 'Sustainable & Ethical Fashion' | 'Resale, Vintage & Circular Fashion' | 'Fashion Tech & Virtual Try-Ons' | 'Streetwear & Emerging Luxury' | 'Couture & Made-to-Measure' | 'News Publishing & Journalism' | 'Digital Media & Content Platforms' | 'Broadcasting (TV & Radio)' | 'Podcasting & Audio Media' | 'News Aggregators & Curation Tools' | 'Independent & Creator-Led Media' | 'Newsletters & Substack-Style Platforms' | 'Political & Investigative Media' | 'Trade & Niche Publications' | 'Media Monitoring & Analytics' | 'Professional Teams & Leagues' | 'Sports Media & Broadcasting' | 'Sports Betting & Fantasy Sports' | 'Fitness & Athletic Training Platforms' | 'Sportswear & Equipment' | 'Esports & Competitive Gaming' | 'Sports Venues & Event Management' | 'Athlete Management & Talent Agencies' | 'Sports Tech & Performance Analytics' | 'Youth, Amateur & Collegiate Sports' | 'Real Estate Marketplaces' | 'Property Management Software' | 'Rental Platforms' | 'Mortgage & Lending Tech' | 'Real Estate Investment Platforms' | 'Law Firms & Legal Services' | 'Legal Tech & Automation' | 'Regulatory Compliance' | 'E-Discovery & Litigation Tools' | 'Contract Management' | 'Governance, Risk & Compliance (GRC)' | 'IP & Trademark Management' | 'Legal Research & Intelligence' | 'Compliance Training & Certification' | 'Whistleblower & Ethics Reporting' | 'Mobile & Wireless Networks (3G/4G/5G)' | 'Broadband & Fiber Internet' | 'Satellite & Space-Based Communications' | 'Network Equipment & Infrastructure' | 'Telecom Billing & OSS/BSS Systems' | 'VoIP & Unified Communications' | 'Internet Service Providers (ISPs)' | 'Edge Computing & Network Virtualization' | 'IoT Connectivity Platforms' | 'Precision Agriculture & AgTech' | 'Crop & Livestock Production' | 'Food & Beverage Manufacturing & Processing' | 'Food Distribution' | 'Restaurants & Food Service' | 'Agricultural Inputs & Equipment' | 'Sustainable & Regenerative Agriculture' | 'Seafood & Aquaculture' | 'Management Consulting' | 'Marketing & Advertising Agencies' | 'Design, Branding & Creative Studios' | 'IT Services & Managed Services' | 'Staffing, Recruiting & Talent' | 'Accounting & Tax Firms' | 'Public Relations & Communications' | 'Business Process Outsourcing (BPO)' | 'Professional Training & Coaching' | 'Specialty Chemicals' | 'Commodity & Petrochemicals' | 'Polymers, Plastics & Rubber' | 'Coatings, Adhesives & Sealants' | 'Industrial Gases' | 'Advanced Materials & Composites' | 'Battery Materials & Energy Storage' | 'Electronic Materials & Semiconductor Chemicals' | 'Agrochemicals & Fertilizers' | 'Freight & Transportation Tech' | 'Last-Mile Delivery' | 'Warehouse Automation' | 'Supply Chain Visibility Platforms' | 'Logistics Marketplaces' | 'Shipping & Freight Forwarding' | 'Cold Chain Logistics' | 'Reverse Logistics & Returns' | 'Cross-Border Trade Tech' | 'Transportation Management Systems (TMS)' | 'Hotels & Accommodation' | 'Vacation Rentals & Short-Term Stays' | 'Restaurant Tech & Management' | 'Travel Booking Platforms' | 'Tourism Experiences & Activities' | 'Cruise Lines & Marine Tourism' | 'Hospitality Management Systems' | 'Event & Venue Management' | 'Corporate Travel Management' | 'Travel Insurance & Protection' | 'Construction Management Software' | 'BIM/CAD & Design Tools' | 'Construction Marketplaces' | 'Equipment Rental & Management' | 'Building Materials & Procurement' | 'Construction Workforce Management' | 'Project Estimation & Bidding' | 'Modular & Prefab Construction' | 'Construction Safety & Compliance' | 'Smart Building Technology' | 'Food & Beverage CPG' | 'Home & Personal Care CPG' | 'CPG Analytics & Insights' | 'Direct-to-Consumer CPG Brands' | 'CPG Supply Chain & Distribution' | 'Private Label Manufacturing' | 'CPG Retail Intelligence' | 'Sustainable CPG & Packaging' | 'Beauty & Cosmetics CPG' | 'Health & Wellness CPG';
|
|
1150
|
+
}
|
|
1151
|
+
}
|
|
1152
|
+
/**
|
|
1153
|
+
* Important website links for the brand
|
|
1154
|
+
*/
|
|
1155
|
+
interface Links {
|
|
1156
|
+
/**
|
|
1157
|
+
* URL to the brand's blog or news page
|
|
1158
|
+
*/
|
|
1159
|
+
blog?: string | null;
|
|
1160
|
+
/**
|
|
1161
|
+
* URL to the brand's careers or job opportunities page
|
|
1162
|
+
*/
|
|
1163
|
+
careers?: string | null;
|
|
1164
|
+
/**
|
|
1165
|
+
* URL to the brand's contact or contact us page
|
|
1166
|
+
*/
|
|
1167
|
+
contact?: string | null;
|
|
1168
|
+
/**
|
|
1169
|
+
* URL to the brand's pricing or plans page
|
|
1170
|
+
*/
|
|
1171
|
+
pricing?: string | null;
|
|
1172
|
+
/**
|
|
1173
|
+
* URL to the brand's privacy policy page
|
|
1174
|
+
*/
|
|
1175
|
+
privacy?: string | null;
|
|
1176
|
+
/**
|
|
1177
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
1178
|
+
*/
|
|
1179
|
+
terms?: string | null;
|
|
1180
|
+
}
|
|
1181
|
+
interface Logo {
|
|
1182
|
+
/**
|
|
1183
|
+
* Array of colors in the logo
|
|
1184
|
+
*/
|
|
1185
|
+
colors?: Array<Logo.Color>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
1188
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
1189
|
+
* has its own background
|
|
1190
|
+
*/
|
|
1191
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
1192
|
+
/**
|
|
1193
|
+
* Resolution of the logo image
|
|
1194
|
+
*/
|
|
1195
|
+
resolution?: Logo.Resolution;
|
|
1196
|
+
/**
|
|
1197
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
1198
|
+
*/
|
|
1199
|
+
type?: 'icon' | 'logo';
|
|
1200
|
+
/**
|
|
1201
|
+
* CDN hosted url of the logo (ready for display)
|
|
1202
|
+
*/
|
|
1203
|
+
url?: string;
|
|
1204
|
+
}
|
|
1205
|
+
namespace Logo {
|
|
1206
|
+
interface Color {
|
|
1207
|
+
/**
|
|
1208
|
+
* Color in hexadecimal format
|
|
1209
|
+
*/
|
|
1210
|
+
hex?: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* Name of the color
|
|
1213
|
+
*/
|
|
1214
|
+
name?: string;
|
|
1215
|
+
}
|
|
1216
|
+
/**
|
|
1217
|
+
* Resolution of the logo image
|
|
1218
|
+
*/
|
|
1219
|
+
interface Resolution {
|
|
1220
|
+
/**
|
|
1221
|
+
* Aspect ratio of the image (width/height)
|
|
1222
|
+
*/
|
|
1223
|
+
aspect_ratio?: number;
|
|
1224
|
+
/**
|
|
1225
|
+
* Height of the image in pixels
|
|
1226
|
+
*/
|
|
1227
|
+
height?: number;
|
|
1228
|
+
/**
|
|
1229
|
+
* Width of the image in pixels
|
|
1230
|
+
*/
|
|
1231
|
+
width?: number;
|
|
1232
|
+
}
|
|
1233
|
+
}
|
|
1234
|
+
interface Social {
|
|
1235
|
+
/**
|
|
1236
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
1237
|
+
*/
|
|
1238
|
+
type?: string;
|
|
1239
|
+
/**
|
|
1240
|
+
* URL of the social media page
|
|
1241
|
+
*/
|
|
1242
|
+
url?: string;
|
|
1243
|
+
}
|
|
1244
|
+
/**
|
|
1245
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1246
|
+
* company)
|
|
1247
|
+
*/
|
|
1248
|
+
interface Stock {
|
|
1249
|
+
/**
|
|
1250
|
+
* Stock exchange name
|
|
1251
|
+
*/
|
|
1252
|
+
exchange?: string;
|
|
1253
|
+
/**
|
|
1254
|
+
* Stock ticker symbol
|
|
1255
|
+
*/
|
|
1256
|
+
ticker?: string;
|
|
1257
|
+
}
|
|
1258
|
+
}
|
|
1259
|
+
}
|
|
1260
|
+
export interface BrandRetrieveByIsinResponse {
|
|
1261
|
+
/**
|
|
1262
|
+
* Detailed brand information
|
|
1263
|
+
*/
|
|
1264
|
+
brand?: BrandRetrieveByIsinResponse.Brand;
|
|
1265
|
+
/**
|
|
1266
|
+
* HTTP status code
|
|
1267
|
+
*/
|
|
1268
|
+
code?: number;
|
|
1269
|
+
/**
|
|
1270
|
+
* Status of the response, e.g., 'ok'
|
|
1271
|
+
*/
|
|
1272
|
+
status?: string;
|
|
1273
|
+
}
|
|
1274
|
+
export declare namespace BrandRetrieveByIsinResponse {
|
|
1275
|
+
/**
|
|
1276
|
+
* Detailed brand information
|
|
1277
|
+
*/
|
|
1278
|
+
interface Brand {
|
|
1279
|
+
/**
|
|
1280
|
+
* Physical address of the brand
|
|
1281
|
+
*/
|
|
1282
|
+
address?: Brand.Address;
|
|
1283
|
+
/**
|
|
1284
|
+
* An array of backdrop images for the brand
|
|
1285
|
+
*/
|
|
1286
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
1287
|
+
/**
|
|
1288
|
+
* An array of brand colors
|
|
1289
|
+
*/
|
|
1290
|
+
colors?: Array<Brand.Color>;
|
|
1291
|
+
/**
|
|
1292
|
+
* A brief description of the brand
|
|
1293
|
+
*/
|
|
1294
|
+
description?: string;
|
|
1295
|
+
/**
|
|
1296
|
+
* The domain name of the brand
|
|
1297
|
+
*/
|
|
1298
|
+
domain?: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* Company email address
|
|
1301
|
+
*/
|
|
1302
|
+
email?: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* Industry classification information for the brand
|
|
1305
|
+
*/
|
|
1306
|
+
industries?: Brand.Industries;
|
|
1307
|
+
/**
|
|
1308
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
1309
|
+
*/
|
|
1310
|
+
is_nsfw?: boolean;
|
|
1311
|
+
/**
|
|
1312
|
+
* Important website links for the brand
|
|
1313
|
+
*/
|
|
1314
|
+
links?: Brand.Links;
|
|
1315
|
+
/**
|
|
1316
|
+
* An array of logos associated with the brand
|
|
1317
|
+
*/
|
|
1318
|
+
logos?: Array<Brand.Logo>;
|
|
1319
|
+
/**
|
|
1320
|
+
* Company phone number
|
|
1321
|
+
*/
|
|
1322
|
+
phone?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* The brand's slogan
|
|
1325
|
+
*/
|
|
1326
|
+
slogan?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* An array of social media links for the brand
|
|
1329
|
+
*/
|
|
1330
|
+
socials?: Array<Brand.Social>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1333
|
+
* company)
|
|
1334
|
+
*/
|
|
1335
|
+
stock?: Brand.Stock;
|
|
1336
|
+
/**
|
|
1337
|
+
* The title or name of the brand
|
|
1338
|
+
*/
|
|
1339
|
+
title?: string;
|
|
1340
|
+
}
|
|
1341
|
+
namespace Brand {
|
|
1342
|
+
/**
|
|
1343
|
+
* Physical address of the brand
|
|
1344
|
+
*/
|
|
1345
|
+
interface Address {
|
|
1346
|
+
/**
|
|
1347
|
+
* City name
|
|
1348
|
+
*/
|
|
1349
|
+
city?: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* Country name
|
|
1352
|
+
*/
|
|
1353
|
+
country?: string;
|
|
1354
|
+
/**
|
|
1355
|
+
* Country code
|
|
1356
|
+
*/
|
|
1357
|
+
country_code?: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* Postal or ZIP code
|
|
1360
|
+
*/
|
|
1361
|
+
postal_code?: string;
|
|
1362
|
+
/**
|
|
1363
|
+
* State or province code
|
|
1364
|
+
*/
|
|
1365
|
+
state_code?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* State or province name
|
|
1368
|
+
*/
|
|
1369
|
+
state_province?: string;
|
|
1370
|
+
/**
|
|
1371
|
+
* Street address
|
|
1372
|
+
*/
|
|
1373
|
+
street?: string;
|
|
1374
|
+
}
|
|
1375
|
+
interface Backdrop {
|
|
1376
|
+
/**
|
|
1377
|
+
* Array of colors in the backdrop image
|
|
1378
|
+
*/
|
|
1379
|
+
colors?: Array<Backdrop.Color>;
|
|
1380
|
+
/**
|
|
1381
|
+
* Resolution of the backdrop image
|
|
1382
|
+
*/
|
|
1383
|
+
resolution?: Backdrop.Resolution;
|
|
1384
|
+
/**
|
|
1385
|
+
* URL of the backdrop image
|
|
1386
|
+
*/
|
|
1387
|
+
url?: string;
|
|
1388
|
+
}
|
|
1389
|
+
namespace Backdrop {
|
|
1390
|
+
interface Color {
|
|
1391
|
+
/**
|
|
1392
|
+
* Color in hexadecimal format
|
|
1393
|
+
*/
|
|
1394
|
+
hex?: string;
|
|
1395
|
+
/**
|
|
1396
|
+
* Name of the color
|
|
1397
|
+
*/
|
|
1398
|
+
name?: string;
|
|
1399
|
+
}
|
|
1400
|
+
/**
|
|
1401
|
+
* Resolution of the backdrop image
|
|
1402
|
+
*/
|
|
1403
|
+
interface Resolution {
|
|
1404
|
+
/**
|
|
1405
|
+
* Aspect ratio of the image (width/height)
|
|
1406
|
+
*/
|
|
1407
|
+
aspect_ratio?: number;
|
|
1408
|
+
/**
|
|
1409
|
+
* Height of the image in pixels
|
|
1410
|
+
*/
|
|
1411
|
+
height?: number;
|
|
1412
|
+
/**
|
|
1413
|
+
* Width of the image in pixels
|
|
1414
|
+
*/
|
|
1415
|
+
width?: number;
|
|
1416
|
+
}
|
|
1417
|
+
}
|
|
1418
|
+
interface Color {
|
|
1419
|
+
/**
|
|
1420
|
+
* Color in hexadecimal format
|
|
1421
|
+
*/
|
|
1422
|
+
hex?: string;
|
|
1423
|
+
/**
|
|
1424
|
+
* Name of the color
|
|
1425
|
+
*/
|
|
1426
|
+
name?: string;
|
|
1427
|
+
}
|
|
1428
|
+
/**
|
|
1429
|
+
* Industry classification information for the brand
|
|
1430
|
+
*/
|
|
1431
|
+
interface Industries {
|
|
1432
|
+
/**
|
|
1433
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
1434
|
+
*/
|
|
1435
|
+
eic?: Array<Industries.Eic>;
|
|
1436
|
+
}
|
|
1437
|
+
namespace Industries {
|
|
1438
|
+
interface Eic {
|
|
1439
|
+
/**
|
|
1440
|
+
* Industry classification enum
|
|
1441
|
+
*/
|
|
1442
|
+
industry: 'Aerospace & Defense' | 'Technology' | 'Finance' | 'Healthcare' | 'Retail & E-commerce' | 'Entertainment' | 'Education' | 'Government & Nonprofit' | 'Industrial & Energy' | 'Automotive & Transportation' | 'Lifestyle & Leisure' | 'Luxury & Fashion' | 'News & Media' | 'Sports' | 'Real Estate & PropTech' | 'Legal & Compliance' | 'Telecommunications' | 'Agriculture & Food' | 'Professional Services & Agencies' | 'Chemicals & Materials' | 'Logistics & Supply Chain' | 'Hospitality & Tourism' | 'Construction & Built Environment' | 'Consumer Packaged Goods (CPG)';
|
|
1443
|
+
/**
|
|
1444
|
+
* Subindustry classification enum
|
|
1445
|
+
*/
|
|
1446
|
+
subindustry: 'Defense Systems & Military Hardware' | 'Aerospace Manufacturing' | 'Avionics & Navigation Technology' | 'Subsea & Naval Defense Systems' | 'Space & Satellite Technology' | 'Defense IT & Systems Integration' | 'Software (B2B)' | 'Software (B2C)' | 'Cloud Infrastructure & DevOps' | 'Cybersecurity' | 'Artificial Intelligence & Machine Learning' | 'Data Infrastructure & Analytics' | 'Hardware & Semiconductors' | 'Fintech Infrastructure' | 'eCommerce & Marketplace Platforms' | 'Developer Tools & APIs' | 'Web3 & Blockchain' | 'XR & Spatial Computing' | 'Banking & Lending' | 'Investment Management & WealthTech' | 'Insurance & InsurTech' | 'Payments & Money Movement' | 'Accounting, Tax & Financial Planning Tools' | 'Capital Markets & Trading Platforms' | 'Financial Infrastructure & APIs' | 'Credit Scoring & Risk Management' | 'Cryptocurrency & Digital Assets' | 'BNPL & Alternative Financing' | 'Healthcare Providers & Services' | 'Pharmaceuticals & Drug Development' | 'Medical Devices & Diagnostics' | 'Biotechnology & Genomics' | 'Digital Health & Telemedicine' | 'Health Insurance & Benefits Tech' | 'Clinical Trials & Research Platforms' | 'Mental Health & Wellness' | 'Healthcare IT & EHR Systems' | 'Consumer Health & Wellness Products' | 'Online Marketplaces' | 'Direct-to-Consumer (DTC) Brands' | 'Retail Tech & Point-of-Sale Systems' | 'Omnichannel & In-Store Retail' | 'E-commerce Enablement & Infrastructure' | 'Subscription & Membership Commerce' | 'Social Commerce & Influencer Platforms' | 'Fashion & Apparel Retail' | 'Food, Beverage & Grocery E-commerce' | 'Streaming Platforms (Video, Music, Audio)' | 'Gaming & Interactive Entertainment' | 'Creator Economy & Influencer Platforms' | 'Advertising, Adtech & Media Buying' | 'Film, TV & Production Studios' | 'Events, Venues & Live Entertainment' | 'Virtual Worlds & Metaverse Experiences' | 'K-12 Education Platforms & Tools' | 'Higher Education & University Tech' | 'Online Learning & MOOCs' | 'Test Prep & Certification' | 'Corporate Training & Upskilling' | 'Tutoring & Supplemental Learning' | 'Education Management Systems (LMS/SIS)' | 'Language Learning' | 'Creator-Led & Cohort-Based Courses' | 'Special Education & Accessibility Tools' | 'Government Technology & Digital Services' | 'Civic Engagement & Policy Platforms' | 'International Development & Humanitarian Aid' | 'Philanthropy & Grantmaking' | 'Nonprofit Operations & Fundraising Tools' | 'Public Health & Social Services' | 'Education & Youth Development Programs' | 'Environmental & Climate Action Organizations' | 'Legal Aid & Social Justice Advocacy' | 'Municipal & Infrastructure Services' | 'Manufacturing & Industrial Automation' | 'Energy Production (Oil, Gas, Nuclear)' | 'Renewable Energy & Cleantech' | 'Utilities & Grid Infrastructure' | 'Industrial IoT & Monitoring Systems' | 'Construction & Heavy Equipment' | 'Mining & Natural Resources' | 'Environmental Engineering & Sustainability' | 'Energy Storage & Battery Technology' | 'Automotive OEMs & Vehicle Manufacturing' | 'Electric Vehicles (EVs) & Charging Infrastructure' | 'Mobility-as-a-Service (MaaS)' | 'Fleet Management' | 'Public Transit & Urban Mobility' | 'Autonomous Vehicles & ADAS' | 'Aftermarket Parts & Services' | 'Telematics & Vehicle Connectivity' | 'Aviation & Aerospace Transport' | 'Maritime Shipping' | 'Fitness & Wellness' | 'Beauty & Personal Care' | 'Home & Living' | 'Dating & Relationships' | 'Hobbies, Crafts & DIY' | 'Outdoor & Recreational Gear' | 'Events, Experiences & Ticketing Platforms' | 'Designer & Luxury Apparel' | 'Accessories, Jewelry & Watches' | 'Footwear & Leather Goods' | 'Beauty, Fragrance & Skincare' | 'Fashion Marketplaces & Retail Platforms' | 'Sustainable & Ethical Fashion' | 'Resale, Vintage & Circular Fashion' | 'Fashion Tech & Virtual Try-Ons' | 'Streetwear & Emerging Luxury' | 'Couture & Made-to-Measure' | 'News Publishing & Journalism' | 'Digital Media & Content Platforms' | 'Broadcasting (TV & Radio)' | 'Podcasting & Audio Media' | 'News Aggregators & Curation Tools' | 'Independent & Creator-Led Media' | 'Newsletters & Substack-Style Platforms' | 'Political & Investigative Media' | 'Trade & Niche Publications' | 'Media Monitoring & Analytics' | 'Professional Teams & Leagues' | 'Sports Media & Broadcasting' | 'Sports Betting & Fantasy Sports' | 'Fitness & Athletic Training Platforms' | 'Sportswear & Equipment' | 'Esports & Competitive Gaming' | 'Sports Venues & Event Management' | 'Athlete Management & Talent Agencies' | 'Sports Tech & Performance Analytics' | 'Youth, Amateur & Collegiate Sports' | 'Real Estate Marketplaces' | 'Property Management Software' | 'Rental Platforms' | 'Mortgage & Lending Tech' | 'Real Estate Investment Platforms' | 'Law Firms & Legal Services' | 'Legal Tech & Automation' | 'Regulatory Compliance' | 'E-Discovery & Litigation Tools' | 'Contract Management' | 'Governance, Risk & Compliance (GRC)' | 'IP & Trademark Management' | 'Legal Research & Intelligence' | 'Compliance Training & Certification' | 'Whistleblower & Ethics Reporting' | 'Mobile & Wireless Networks (3G/4G/5G)' | 'Broadband & Fiber Internet' | 'Satellite & Space-Based Communications' | 'Network Equipment & Infrastructure' | 'Telecom Billing & OSS/BSS Systems' | 'VoIP & Unified Communications' | 'Internet Service Providers (ISPs)' | 'Edge Computing & Network Virtualization' | 'IoT Connectivity Platforms' | 'Precision Agriculture & AgTech' | 'Crop & Livestock Production' | 'Food & Beverage Manufacturing & Processing' | 'Food Distribution' | 'Restaurants & Food Service' | 'Agricultural Inputs & Equipment' | 'Sustainable & Regenerative Agriculture' | 'Seafood & Aquaculture' | 'Management Consulting' | 'Marketing & Advertising Agencies' | 'Design, Branding & Creative Studios' | 'IT Services & Managed Services' | 'Staffing, Recruiting & Talent' | 'Accounting & Tax Firms' | 'Public Relations & Communications' | 'Business Process Outsourcing (BPO)' | 'Professional Training & Coaching' | 'Specialty Chemicals' | 'Commodity & Petrochemicals' | 'Polymers, Plastics & Rubber' | 'Coatings, Adhesives & Sealants' | 'Industrial Gases' | 'Advanced Materials & Composites' | 'Battery Materials & Energy Storage' | 'Electronic Materials & Semiconductor Chemicals' | 'Agrochemicals & Fertilizers' | 'Freight & Transportation Tech' | 'Last-Mile Delivery' | 'Warehouse Automation' | 'Supply Chain Visibility Platforms' | 'Logistics Marketplaces' | 'Shipping & Freight Forwarding' | 'Cold Chain Logistics' | 'Reverse Logistics & Returns' | 'Cross-Border Trade Tech' | 'Transportation Management Systems (TMS)' | 'Hotels & Accommodation' | 'Vacation Rentals & Short-Term Stays' | 'Restaurant Tech & Management' | 'Travel Booking Platforms' | 'Tourism Experiences & Activities' | 'Cruise Lines & Marine Tourism' | 'Hospitality Management Systems' | 'Event & Venue Management' | 'Corporate Travel Management' | 'Travel Insurance & Protection' | 'Construction Management Software' | 'BIM/CAD & Design Tools' | 'Construction Marketplaces' | 'Equipment Rental & Management' | 'Building Materials & Procurement' | 'Construction Workforce Management' | 'Project Estimation & Bidding' | 'Modular & Prefab Construction' | 'Construction Safety & Compliance' | 'Smart Building Technology' | 'Food & Beverage CPG' | 'Home & Personal Care CPG' | 'CPG Analytics & Insights' | 'Direct-to-Consumer CPG Brands' | 'CPG Supply Chain & Distribution' | 'Private Label Manufacturing' | 'CPG Retail Intelligence' | 'Sustainable CPG & Packaging' | 'Beauty & Cosmetics CPG' | 'Health & Wellness CPG';
|
|
1447
|
+
}
|
|
1448
|
+
}
|
|
1449
|
+
/**
|
|
1450
|
+
* Important website links for the brand
|
|
1451
|
+
*/
|
|
1452
|
+
interface Links {
|
|
1453
|
+
/**
|
|
1454
|
+
* URL to the brand's blog or news page
|
|
1455
|
+
*/
|
|
1456
|
+
blog?: string | null;
|
|
1457
|
+
/**
|
|
1458
|
+
* URL to the brand's careers or job opportunities page
|
|
1459
|
+
*/
|
|
1460
|
+
careers?: string | null;
|
|
1461
|
+
/**
|
|
1462
|
+
* URL to the brand's contact or contact us page
|
|
1463
|
+
*/
|
|
1464
|
+
contact?: string | null;
|
|
1465
|
+
/**
|
|
1466
|
+
* URL to the brand's pricing or plans page
|
|
1467
|
+
*/
|
|
1468
|
+
pricing?: string | null;
|
|
1469
|
+
/**
|
|
1470
|
+
* URL to the brand's privacy policy page
|
|
1471
|
+
*/
|
|
1472
|
+
privacy?: string | null;
|
|
1473
|
+
/**
|
|
1474
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
1475
|
+
*/
|
|
1476
|
+
terms?: string | null;
|
|
1477
|
+
}
|
|
1478
|
+
interface Logo {
|
|
1479
|
+
/**
|
|
1480
|
+
* Array of colors in the logo
|
|
1481
|
+
*/
|
|
1482
|
+
colors?: Array<Logo.Color>;
|
|
1483
|
+
/**
|
|
1484
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
1485
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
1486
|
+
* has its own background
|
|
1487
|
+
*/
|
|
1488
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
1489
|
+
/**
|
|
1490
|
+
* Resolution of the logo image
|
|
1491
|
+
*/
|
|
1492
|
+
resolution?: Logo.Resolution;
|
|
1493
|
+
/**
|
|
1494
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
1495
|
+
*/
|
|
1496
|
+
type?: 'icon' | 'logo';
|
|
1497
|
+
/**
|
|
1498
|
+
* CDN hosted url of the logo (ready for display)
|
|
1499
|
+
*/
|
|
1500
|
+
url?: string;
|
|
1501
|
+
}
|
|
1502
|
+
namespace Logo {
|
|
1503
|
+
interface Color {
|
|
1504
|
+
/**
|
|
1505
|
+
* Color in hexadecimal format
|
|
1506
|
+
*/
|
|
1507
|
+
hex?: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* Name of the color
|
|
1510
|
+
*/
|
|
1511
|
+
name?: string;
|
|
1512
|
+
}
|
|
1513
|
+
/**
|
|
1514
|
+
* Resolution of the logo image
|
|
1515
|
+
*/
|
|
1516
|
+
interface Resolution {
|
|
1517
|
+
/**
|
|
1518
|
+
* Aspect ratio of the image (width/height)
|
|
1519
|
+
*/
|
|
1520
|
+
aspect_ratio?: number;
|
|
1521
|
+
/**
|
|
1522
|
+
* Height of the image in pixels
|
|
1523
|
+
*/
|
|
1524
|
+
height?: number;
|
|
1525
|
+
/**
|
|
1526
|
+
* Width of the image in pixels
|
|
1527
|
+
*/
|
|
1528
|
+
width?: number;
|
|
1529
|
+
}
|
|
1530
|
+
}
|
|
1531
|
+
interface Social {
|
|
1532
|
+
/**
|
|
1533
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
1534
|
+
*/
|
|
1535
|
+
type?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* URL of the social media page
|
|
1538
|
+
*/
|
|
1539
|
+
url?: string;
|
|
1540
|
+
}
|
|
1541
|
+
/**
|
|
1542
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1543
|
+
* company)
|
|
1544
|
+
*/
|
|
1545
|
+
interface Stock {
|
|
1546
|
+
/**
|
|
1547
|
+
* Stock exchange name
|
|
1548
|
+
*/
|
|
1549
|
+
exchange?: string;
|
|
1550
|
+
/**
|
|
1551
|
+
* Stock ticker symbol
|
|
1552
|
+
*/
|
|
1553
|
+
ticker?: string;
|
|
1554
|
+
}
|
|
1555
|
+
}
|
|
1556
|
+
}
|
|
1557
|
+
export interface BrandRetrieveByNameResponse {
|
|
1558
|
+
/**
|
|
1559
|
+
* Detailed brand information
|
|
1560
|
+
*/
|
|
1561
|
+
brand?: BrandRetrieveByNameResponse.Brand;
|
|
1562
|
+
/**
|
|
1563
|
+
* HTTP status code
|
|
1564
|
+
*/
|
|
1565
|
+
code?: number;
|
|
1566
|
+
/**
|
|
1567
|
+
* Status of the response, e.g., 'ok'
|
|
1568
|
+
*/
|
|
1569
|
+
status?: string;
|
|
1570
|
+
}
|
|
1571
|
+
export declare namespace BrandRetrieveByNameResponse {
|
|
1572
|
+
/**
|
|
1573
|
+
* Detailed brand information
|
|
1574
|
+
*/
|
|
1575
|
+
interface Brand {
|
|
1576
|
+
/**
|
|
1577
|
+
* Physical address of the brand
|
|
1578
|
+
*/
|
|
1579
|
+
address?: Brand.Address;
|
|
1580
|
+
/**
|
|
1581
|
+
* An array of backdrop images for the brand
|
|
1582
|
+
*/
|
|
1583
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
1584
|
+
/**
|
|
1585
|
+
* An array of brand colors
|
|
1586
|
+
*/
|
|
1587
|
+
colors?: Array<Brand.Color>;
|
|
1588
|
+
/**
|
|
1589
|
+
* A brief description of the brand
|
|
1590
|
+
*/
|
|
1591
|
+
description?: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* The domain name of the brand
|
|
1594
|
+
*/
|
|
1595
|
+
domain?: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* Company email address
|
|
1598
|
+
*/
|
|
1599
|
+
email?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* Industry classification information for the brand
|
|
1602
|
+
*/
|
|
1603
|
+
industries?: Brand.Industries;
|
|
1604
|
+
/**
|
|
1605
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
1606
|
+
*/
|
|
1607
|
+
is_nsfw?: boolean;
|
|
1608
|
+
/**
|
|
1609
|
+
* Important website links for the brand
|
|
1610
|
+
*/
|
|
1611
|
+
links?: Brand.Links;
|
|
1612
|
+
/**
|
|
1613
|
+
* An array of logos associated with the brand
|
|
1614
|
+
*/
|
|
1615
|
+
logos?: Array<Brand.Logo>;
|
|
1616
|
+
/**
|
|
1617
|
+
* Company phone number
|
|
1618
|
+
*/
|
|
1619
|
+
phone?: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* The brand's slogan
|
|
1622
|
+
*/
|
|
1623
|
+
slogan?: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* An array of social media links for the brand
|
|
1626
|
+
*/
|
|
1627
|
+
socials?: Array<Brand.Social>;
|
|
1628
|
+
/**
|
|
1629
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1630
|
+
* company)
|
|
1631
|
+
*/
|
|
1632
|
+
stock?: Brand.Stock;
|
|
1633
|
+
/**
|
|
1634
|
+
* The title or name of the brand
|
|
1635
|
+
*/
|
|
1636
|
+
title?: string;
|
|
1637
|
+
}
|
|
1638
|
+
namespace Brand {
|
|
1639
|
+
/**
|
|
1640
|
+
* Physical address of the brand
|
|
1641
|
+
*/
|
|
1642
|
+
interface Address {
|
|
1643
|
+
/**
|
|
1644
|
+
* City name
|
|
1645
|
+
*/
|
|
1646
|
+
city?: string;
|
|
1647
|
+
/**
|
|
1648
|
+
* Country name
|
|
1649
|
+
*/
|
|
1650
|
+
country?: string;
|
|
1651
|
+
/**
|
|
1652
|
+
* Country code
|
|
1653
|
+
*/
|
|
1654
|
+
country_code?: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* Postal or ZIP code
|
|
1657
|
+
*/
|
|
1658
|
+
postal_code?: string;
|
|
1659
|
+
/**
|
|
1660
|
+
* State or province code
|
|
1661
|
+
*/
|
|
1662
|
+
state_code?: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* State or province name
|
|
1665
|
+
*/
|
|
1666
|
+
state_province?: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* Street address
|
|
1669
|
+
*/
|
|
1670
|
+
street?: string;
|
|
1671
|
+
}
|
|
1672
|
+
interface Backdrop {
|
|
1673
|
+
/**
|
|
1674
|
+
* Array of colors in the backdrop image
|
|
1675
|
+
*/
|
|
1676
|
+
colors?: Array<Backdrop.Color>;
|
|
1677
|
+
/**
|
|
1678
|
+
* Resolution of the backdrop image
|
|
1679
|
+
*/
|
|
1680
|
+
resolution?: Backdrop.Resolution;
|
|
1681
|
+
/**
|
|
1682
|
+
* URL of the backdrop image
|
|
1683
|
+
*/
|
|
1684
|
+
url?: string;
|
|
1685
|
+
}
|
|
1686
|
+
namespace Backdrop {
|
|
1687
|
+
interface Color {
|
|
1688
|
+
/**
|
|
1689
|
+
* Color in hexadecimal format
|
|
1690
|
+
*/
|
|
1691
|
+
hex?: string;
|
|
1692
|
+
/**
|
|
1693
|
+
* Name of the color
|
|
1694
|
+
*/
|
|
1695
|
+
name?: string;
|
|
1696
|
+
}
|
|
1697
|
+
/**
|
|
1698
|
+
* Resolution of the backdrop image
|
|
1699
|
+
*/
|
|
1700
|
+
interface Resolution {
|
|
1701
|
+
/**
|
|
1702
|
+
* Aspect ratio of the image (width/height)
|
|
1703
|
+
*/
|
|
1704
|
+
aspect_ratio?: number;
|
|
1705
|
+
/**
|
|
1706
|
+
* Height of the image in pixels
|
|
1707
|
+
*/
|
|
1708
|
+
height?: number;
|
|
1709
|
+
/**
|
|
1710
|
+
* Width of the image in pixels
|
|
1711
|
+
*/
|
|
1712
|
+
width?: number;
|
|
1713
|
+
}
|
|
1714
|
+
}
|
|
1715
|
+
interface Color {
|
|
1716
|
+
/**
|
|
1717
|
+
* Color in hexadecimal format
|
|
1718
|
+
*/
|
|
1719
|
+
hex?: string;
|
|
1720
|
+
/**
|
|
1721
|
+
* Name of the color
|
|
1722
|
+
*/
|
|
1723
|
+
name?: string;
|
|
1724
|
+
}
|
|
1725
|
+
/**
|
|
1726
|
+
* Industry classification information for the brand
|
|
1727
|
+
*/
|
|
1728
|
+
interface Industries {
|
|
1729
|
+
/**
|
|
1730
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
1731
|
+
*/
|
|
1732
|
+
eic?: Array<Industries.Eic>;
|
|
1733
|
+
}
|
|
1734
|
+
namespace Industries {
|
|
1735
|
+
interface Eic {
|
|
1736
|
+
/**
|
|
1737
|
+
* Industry classification enum
|
|
1738
|
+
*/
|
|
1739
|
+
industry: 'Aerospace & Defense' | 'Technology' | 'Finance' | 'Healthcare' | 'Retail & E-commerce' | 'Entertainment' | 'Education' | 'Government & Nonprofit' | 'Industrial & Energy' | 'Automotive & Transportation' | 'Lifestyle & Leisure' | 'Luxury & Fashion' | 'News & Media' | 'Sports' | 'Real Estate & PropTech' | 'Legal & Compliance' | 'Telecommunications' | 'Agriculture & Food' | 'Professional Services & Agencies' | 'Chemicals & Materials' | 'Logistics & Supply Chain' | 'Hospitality & Tourism' | 'Construction & Built Environment' | 'Consumer Packaged Goods (CPG)';
|
|
1740
|
+
/**
|
|
1741
|
+
* Subindustry classification enum
|
|
1742
|
+
*/
|
|
1743
|
+
subindustry: 'Defense Systems & Military Hardware' | 'Aerospace Manufacturing' | 'Avionics & Navigation Technology' | 'Subsea & Naval Defense Systems' | 'Space & Satellite Technology' | 'Defense IT & Systems Integration' | 'Software (B2B)' | 'Software (B2C)' | 'Cloud Infrastructure & DevOps' | 'Cybersecurity' | 'Artificial Intelligence & Machine Learning' | 'Data Infrastructure & Analytics' | 'Hardware & Semiconductors' | 'Fintech Infrastructure' | 'eCommerce & Marketplace Platforms' | 'Developer Tools & APIs' | 'Web3 & Blockchain' | 'XR & Spatial Computing' | 'Banking & Lending' | 'Investment Management & WealthTech' | 'Insurance & InsurTech' | 'Payments & Money Movement' | 'Accounting, Tax & Financial Planning Tools' | 'Capital Markets & Trading Platforms' | 'Financial Infrastructure & APIs' | 'Credit Scoring & Risk Management' | 'Cryptocurrency & Digital Assets' | 'BNPL & Alternative Financing' | 'Healthcare Providers & Services' | 'Pharmaceuticals & Drug Development' | 'Medical Devices & Diagnostics' | 'Biotechnology & Genomics' | 'Digital Health & Telemedicine' | 'Health Insurance & Benefits Tech' | 'Clinical Trials & Research Platforms' | 'Mental Health & Wellness' | 'Healthcare IT & EHR Systems' | 'Consumer Health & Wellness Products' | 'Online Marketplaces' | 'Direct-to-Consumer (DTC) Brands' | 'Retail Tech & Point-of-Sale Systems' | 'Omnichannel & In-Store Retail' | 'E-commerce Enablement & Infrastructure' | 'Subscription & Membership Commerce' | 'Social Commerce & Influencer Platforms' | 'Fashion & Apparel Retail' | 'Food, Beverage & Grocery E-commerce' | 'Streaming Platforms (Video, Music, Audio)' | 'Gaming & Interactive Entertainment' | 'Creator Economy & Influencer Platforms' | 'Advertising, Adtech & Media Buying' | 'Film, TV & Production Studios' | 'Events, Venues & Live Entertainment' | 'Virtual Worlds & Metaverse Experiences' | 'K-12 Education Platforms & Tools' | 'Higher Education & University Tech' | 'Online Learning & MOOCs' | 'Test Prep & Certification' | 'Corporate Training & Upskilling' | 'Tutoring & Supplemental Learning' | 'Education Management Systems (LMS/SIS)' | 'Language Learning' | 'Creator-Led & Cohort-Based Courses' | 'Special Education & Accessibility Tools' | 'Government Technology & Digital Services' | 'Civic Engagement & Policy Platforms' | 'International Development & Humanitarian Aid' | 'Philanthropy & Grantmaking' | 'Nonprofit Operations & Fundraising Tools' | 'Public Health & Social Services' | 'Education & Youth Development Programs' | 'Environmental & Climate Action Organizations' | 'Legal Aid & Social Justice Advocacy' | 'Municipal & Infrastructure Services' | 'Manufacturing & Industrial Automation' | 'Energy Production (Oil, Gas, Nuclear)' | 'Renewable Energy & Cleantech' | 'Utilities & Grid Infrastructure' | 'Industrial IoT & Monitoring Systems' | 'Construction & Heavy Equipment' | 'Mining & Natural Resources' | 'Environmental Engineering & Sustainability' | 'Energy Storage & Battery Technology' | 'Automotive OEMs & Vehicle Manufacturing' | 'Electric Vehicles (EVs) & Charging Infrastructure' | 'Mobility-as-a-Service (MaaS)' | 'Fleet Management' | 'Public Transit & Urban Mobility' | 'Autonomous Vehicles & ADAS' | 'Aftermarket Parts & Services' | 'Telematics & Vehicle Connectivity' | 'Aviation & Aerospace Transport' | 'Maritime Shipping' | 'Fitness & Wellness' | 'Beauty & Personal Care' | 'Home & Living' | 'Dating & Relationships' | 'Hobbies, Crafts & DIY' | 'Outdoor & Recreational Gear' | 'Events, Experiences & Ticketing Platforms' | 'Designer & Luxury Apparel' | 'Accessories, Jewelry & Watches' | 'Footwear & Leather Goods' | 'Beauty, Fragrance & Skincare' | 'Fashion Marketplaces & Retail Platforms' | 'Sustainable & Ethical Fashion' | 'Resale, Vintage & Circular Fashion' | 'Fashion Tech & Virtual Try-Ons' | 'Streetwear & Emerging Luxury' | 'Couture & Made-to-Measure' | 'News Publishing & Journalism' | 'Digital Media & Content Platforms' | 'Broadcasting (TV & Radio)' | 'Podcasting & Audio Media' | 'News Aggregators & Curation Tools' | 'Independent & Creator-Led Media' | 'Newsletters & Substack-Style Platforms' | 'Political & Investigative Media' | 'Trade & Niche Publications' | 'Media Monitoring & Analytics' | 'Professional Teams & Leagues' | 'Sports Media & Broadcasting' | 'Sports Betting & Fantasy Sports' | 'Fitness & Athletic Training Platforms' | 'Sportswear & Equipment' | 'Esports & Competitive Gaming' | 'Sports Venues & Event Management' | 'Athlete Management & Talent Agencies' | 'Sports Tech & Performance Analytics' | 'Youth, Amateur & Collegiate Sports' | 'Real Estate Marketplaces' | 'Property Management Software' | 'Rental Platforms' | 'Mortgage & Lending Tech' | 'Real Estate Investment Platforms' | 'Law Firms & Legal Services' | 'Legal Tech & Automation' | 'Regulatory Compliance' | 'E-Discovery & Litigation Tools' | 'Contract Management' | 'Governance, Risk & Compliance (GRC)' | 'IP & Trademark Management' | 'Legal Research & Intelligence' | 'Compliance Training & Certification' | 'Whistleblower & Ethics Reporting' | 'Mobile & Wireless Networks (3G/4G/5G)' | 'Broadband & Fiber Internet' | 'Satellite & Space-Based Communications' | 'Network Equipment & Infrastructure' | 'Telecom Billing & OSS/BSS Systems' | 'VoIP & Unified Communications' | 'Internet Service Providers (ISPs)' | 'Edge Computing & Network Virtualization' | 'IoT Connectivity Platforms' | 'Precision Agriculture & AgTech' | 'Crop & Livestock Production' | 'Food & Beverage Manufacturing & Processing' | 'Food Distribution' | 'Restaurants & Food Service' | 'Agricultural Inputs & Equipment' | 'Sustainable & Regenerative Agriculture' | 'Seafood & Aquaculture' | 'Management Consulting' | 'Marketing & Advertising Agencies' | 'Design, Branding & Creative Studios' | 'IT Services & Managed Services' | 'Staffing, Recruiting & Talent' | 'Accounting & Tax Firms' | 'Public Relations & Communications' | 'Business Process Outsourcing (BPO)' | 'Professional Training & Coaching' | 'Specialty Chemicals' | 'Commodity & Petrochemicals' | 'Polymers, Plastics & Rubber' | 'Coatings, Adhesives & Sealants' | 'Industrial Gases' | 'Advanced Materials & Composites' | 'Battery Materials & Energy Storage' | 'Electronic Materials & Semiconductor Chemicals' | 'Agrochemicals & Fertilizers' | 'Freight & Transportation Tech' | 'Last-Mile Delivery' | 'Warehouse Automation' | 'Supply Chain Visibility Platforms' | 'Logistics Marketplaces' | 'Shipping & Freight Forwarding' | 'Cold Chain Logistics' | 'Reverse Logistics & Returns' | 'Cross-Border Trade Tech' | 'Transportation Management Systems (TMS)' | 'Hotels & Accommodation' | 'Vacation Rentals & Short-Term Stays' | 'Restaurant Tech & Management' | 'Travel Booking Platforms' | 'Tourism Experiences & Activities' | 'Cruise Lines & Marine Tourism' | 'Hospitality Management Systems' | 'Event & Venue Management' | 'Corporate Travel Management' | 'Travel Insurance & Protection' | 'Construction Management Software' | 'BIM/CAD & Design Tools' | 'Construction Marketplaces' | 'Equipment Rental & Management' | 'Building Materials & Procurement' | 'Construction Workforce Management' | 'Project Estimation & Bidding' | 'Modular & Prefab Construction' | 'Construction Safety & Compliance' | 'Smart Building Technology' | 'Food & Beverage CPG' | 'Home & Personal Care CPG' | 'CPG Analytics & Insights' | 'Direct-to-Consumer CPG Brands' | 'CPG Supply Chain & Distribution' | 'Private Label Manufacturing' | 'CPG Retail Intelligence' | 'Sustainable CPG & Packaging' | 'Beauty & Cosmetics CPG' | 'Health & Wellness CPG';
|
|
1744
|
+
}
|
|
1745
|
+
}
|
|
1746
|
+
/**
|
|
1747
|
+
* Important website links for the brand
|
|
1748
|
+
*/
|
|
1749
|
+
interface Links {
|
|
1750
|
+
/**
|
|
1751
|
+
* URL to the brand's blog or news page
|
|
1752
|
+
*/
|
|
1753
|
+
blog?: string | null;
|
|
1754
|
+
/**
|
|
1755
|
+
* URL to the brand's careers or job opportunities page
|
|
1756
|
+
*/
|
|
1757
|
+
careers?: string | null;
|
|
1758
|
+
/**
|
|
1759
|
+
* URL to the brand's contact or contact us page
|
|
1760
|
+
*/
|
|
1761
|
+
contact?: string | null;
|
|
1762
|
+
/**
|
|
1763
|
+
* URL to the brand's pricing or plans page
|
|
1764
|
+
*/
|
|
1765
|
+
pricing?: string | null;
|
|
1766
|
+
/**
|
|
1767
|
+
* URL to the brand's privacy policy page
|
|
1768
|
+
*/
|
|
1769
|
+
privacy?: string | null;
|
|
1770
|
+
/**
|
|
1771
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
1772
|
+
*/
|
|
1773
|
+
terms?: string | null;
|
|
1774
|
+
}
|
|
1775
|
+
interface Logo {
|
|
1776
|
+
/**
|
|
1777
|
+
* Array of colors in the logo
|
|
1778
|
+
*/
|
|
1779
|
+
colors?: Array<Logo.Color>;
|
|
1780
|
+
/**
|
|
1781
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
1782
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
1783
|
+
* has its own background
|
|
1784
|
+
*/
|
|
1785
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
1786
|
+
/**
|
|
1787
|
+
* Resolution of the logo image
|
|
1788
|
+
*/
|
|
1789
|
+
resolution?: Logo.Resolution;
|
|
1790
|
+
/**
|
|
1791
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
1792
|
+
*/
|
|
1793
|
+
type?: 'icon' | 'logo';
|
|
1794
|
+
/**
|
|
1795
|
+
* CDN hosted url of the logo (ready for display)
|
|
1796
|
+
*/
|
|
1797
|
+
url?: string;
|
|
1798
|
+
}
|
|
1799
|
+
namespace Logo {
|
|
1800
|
+
interface Color {
|
|
1801
|
+
/**
|
|
1802
|
+
* Color in hexadecimal format
|
|
1803
|
+
*/
|
|
1804
|
+
hex?: string;
|
|
1805
|
+
/**
|
|
1806
|
+
* Name of the color
|
|
1807
|
+
*/
|
|
1808
|
+
name?: string;
|
|
1809
|
+
}
|
|
1810
|
+
/**
|
|
1811
|
+
* Resolution of the logo image
|
|
1812
|
+
*/
|
|
1813
|
+
interface Resolution {
|
|
1814
|
+
/**
|
|
1815
|
+
* Aspect ratio of the image (width/height)
|
|
1816
|
+
*/
|
|
1817
|
+
aspect_ratio?: number;
|
|
1818
|
+
/**
|
|
1819
|
+
* Height of the image in pixels
|
|
1820
|
+
*/
|
|
1821
|
+
height?: number;
|
|
1822
|
+
/**
|
|
1823
|
+
* Width of the image in pixels
|
|
1824
|
+
*/
|
|
1825
|
+
width?: number;
|
|
1826
|
+
}
|
|
1827
|
+
}
|
|
1828
|
+
interface Social {
|
|
1829
|
+
/**
|
|
1830
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
1831
|
+
*/
|
|
1832
|
+
type?: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* URL of the social media page
|
|
1835
|
+
*/
|
|
1836
|
+
url?: string;
|
|
1837
|
+
}
|
|
1838
|
+
/**
|
|
1839
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1840
|
+
* company)
|
|
1841
|
+
*/
|
|
1842
|
+
interface Stock {
|
|
1843
|
+
/**
|
|
1844
|
+
* Stock exchange name
|
|
1845
|
+
*/
|
|
1846
|
+
exchange?: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* Stock ticker symbol
|
|
1849
|
+
*/
|
|
1850
|
+
ticker?: string;
|
|
1851
|
+
}
|
|
1852
|
+
}
|
|
1853
|
+
}
|
|
1854
|
+
export interface BrandRetrieveByTickerResponse {
|
|
1855
|
+
/**
|
|
1856
|
+
* Detailed brand information
|
|
1857
|
+
*/
|
|
1858
|
+
brand?: BrandRetrieveByTickerResponse.Brand;
|
|
1859
|
+
/**
|
|
1860
|
+
* HTTP status code
|
|
1861
|
+
*/
|
|
1862
|
+
code?: number;
|
|
1863
|
+
/**
|
|
1864
|
+
* Status of the response, e.g., 'ok'
|
|
1865
|
+
*/
|
|
1866
|
+
status?: string;
|
|
1867
|
+
}
|
|
1868
|
+
export declare namespace BrandRetrieveByTickerResponse {
|
|
1869
|
+
/**
|
|
1870
|
+
* Detailed brand information
|
|
1871
|
+
*/
|
|
1872
|
+
interface Brand {
|
|
1873
|
+
/**
|
|
1874
|
+
* Physical address of the brand
|
|
1875
|
+
*/
|
|
1876
|
+
address?: Brand.Address;
|
|
1877
|
+
/**
|
|
1878
|
+
* An array of backdrop images for the brand
|
|
1879
|
+
*/
|
|
1880
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
1881
|
+
/**
|
|
1882
|
+
* An array of brand colors
|
|
1883
|
+
*/
|
|
1884
|
+
colors?: Array<Brand.Color>;
|
|
1885
|
+
/**
|
|
1886
|
+
* A brief description of the brand
|
|
1887
|
+
*/
|
|
1888
|
+
description?: string;
|
|
1889
|
+
/**
|
|
1890
|
+
* The domain name of the brand
|
|
1891
|
+
*/
|
|
1892
|
+
domain?: string;
|
|
1893
|
+
/**
|
|
1894
|
+
* Company email address
|
|
1895
|
+
*/
|
|
1896
|
+
email?: string;
|
|
1897
|
+
/**
|
|
1898
|
+
* Industry classification information for the brand
|
|
1899
|
+
*/
|
|
1900
|
+
industries?: Brand.Industries;
|
|
1901
|
+
/**
|
|
1902
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
1903
|
+
*/
|
|
1904
|
+
is_nsfw?: boolean;
|
|
1905
|
+
/**
|
|
1906
|
+
* Important website links for the brand
|
|
1907
|
+
*/
|
|
1908
|
+
links?: Brand.Links;
|
|
1909
|
+
/**
|
|
1910
|
+
* An array of logos associated with the brand
|
|
1911
|
+
*/
|
|
1912
|
+
logos?: Array<Brand.Logo>;
|
|
1913
|
+
/**
|
|
1914
|
+
* Company phone number
|
|
1915
|
+
*/
|
|
1916
|
+
phone?: string;
|
|
1917
|
+
/**
|
|
1918
|
+
* The brand's slogan
|
|
1919
|
+
*/
|
|
1920
|
+
slogan?: string;
|
|
1921
|
+
/**
|
|
1922
|
+
* An array of social media links for the brand
|
|
1923
|
+
*/
|
|
1924
|
+
socials?: Array<Brand.Social>;
|
|
1925
|
+
/**
|
|
1926
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1927
|
+
* company)
|
|
1928
|
+
*/
|
|
1929
|
+
stock?: Brand.Stock;
|
|
1930
|
+
/**
|
|
1931
|
+
* The title or name of the brand
|
|
1932
|
+
*/
|
|
1933
|
+
title?: string;
|
|
1934
|
+
}
|
|
1935
|
+
namespace Brand {
|
|
1936
|
+
/**
|
|
1937
|
+
* Physical address of the brand
|
|
1938
|
+
*/
|
|
1939
|
+
interface Address {
|
|
1940
|
+
/**
|
|
1941
|
+
* City name
|
|
1942
|
+
*/
|
|
1943
|
+
city?: string;
|
|
1944
|
+
/**
|
|
1945
|
+
* Country name
|
|
1946
|
+
*/
|
|
1947
|
+
country?: string;
|
|
1948
|
+
/**
|
|
1949
|
+
* Country code
|
|
1950
|
+
*/
|
|
1951
|
+
country_code?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* Postal or ZIP code
|
|
1954
|
+
*/
|
|
1955
|
+
postal_code?: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* State or province code
|
|
1958
|
+
*/
|
|
1959
|
+
state_code?: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* State or province name
|
|
1962
|
+
*/
|
|
1963
|
+
state_province?: string;
|
|
1964
|
+
/**
|
|
1965
|
+
* Street address
|
|
1966
|
+
*/
|
|
1967
|
+
street?: string;
|
|
1968
|
+
}
|
|
1969
|
+
interface Backdrop {
|
|
1970
|
+
/**
|
|
1971
|
+
* Array of colors in the backdrop image
|
|
1972
|
+
*/
|
|
1973
|
+
colors?: Array<Backdrop.Color>;
|
|
1974
|
+
/**
|
|
1975
|
+
* Resolution of the backdrop image
|
|
1976
|
+
*/
|
|
1977
|
+
resolution?: Backdrop.Resolution;
|
|
1978
|
+
/**
|
|
1979
|
+
* URL of the backdrop image
|
|
1980
|
+
*/
|
|
1981
|
+
url?: string;
|
|
1982
|
+
}
|
|
1983
|
+
namespace Backdrop {
|
|
1984
|
+
interface Color {
|
|
1985
|
+
/**
|
|
1986
|
+
* Color in hexadecimal format
|
|
1987
|
+
*/
|
|
1988
|
+
hex?: string;
|
|
1989
|
+
/**
|
|
1990
|
+
* Name of the color
|
|
1991
|
+
*/
|
|
1992
|
+
name?: string;
|
|
1993
|
+
}
|
|
1994
|
+
/**
|
|
1995
|
+
* Resolution of the backdrop image
|
|
1996
|
+
*/
|
|
1997
|
+
interface Resolution {
|
|
1998
|
+
/**
|
|
1999
|
+
* Aspect ratio of the image (width/height)
|
|
2000
|
+
*/
|
|
2001
|
+
aspect_ratio?: number;
|
|
2002
|
+
/**
|
|
2003
|
+
* Height of the image in pixels
|
|
2004
|
+
*/
|
|
2005
|
+
height?: number;
|
|
2006
|
+
/**
|
|
2007
|
+
* Width of the image in pixels
|
|
2008
|
+
*/
|
|
2009
|
+
width?: number;
|
|
2010
|
+
}
|
|
2011
|
+
}
|
|
2012
|
+
interface Color {
|
|
2013
|
+
/**
|
|
2014
|
+
* Color in hexadecimal format
|
|
2015
|
+
*/
|
|
2016
|
+
hex?: string;
|
|
2017
|
+
/**
|
|
2018
|
+
* Name of the color
|
|
2019
|
+
*/
|
|
2020
|
+
name?: string;
|
|
2021
|
+
}
|
|
2022
|
+
/**
|
|
2023
|
+
* Industry classification information for the brand
|
|
2024
|
+
*/
|
|
2025
|
+
interface Industries {
|
|
2026
|
+
/**
|
|
2027
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
2028
|
+
*/
|
|
2029
|
+
eic?: Array<Industries.Eic>;
|
|
2030
|
+
}
|
|
2031
|
+
namespace Industries {
|
|
2032
|
+
interface Eic {
|
|
2033
|
+
/**
|
|
2034
|
+
* Industry classification enum
|
|
2035
|
+
*/
|
|
2036
|
+
industry: 'Aerospace & Defense' | 'Technology' | 'Finance' | 'Healthcare' | 'Retail & E-commerce' | 'Entertainment' | 'Education' | 'Government & Nonprofit' | 'Industrial & Energy' | 'Automotive & Transportation' | 'Lifestyle & Leisure' | 'Luxury & Fashion' | 'News & Media' | 'Sports' | 'Real Estate & PropTech' | 'Legal & Compliance' | 'Telecommunications' | 'Agriculture & Food' | 'Professional Services & Agencies' | 'Chemicals & Materials' | 'Logistics & Supply Chain' | 'Hospitality & Tourism' | 'Construction & Built Environment' | 'Consumer Packaged Goods (CPG)';
|
|
2037
|
+
/**
|
|
2038
|
+
* Subindustry classification enum
|
|
2039
|
+
*/
|
|
2040
|
+
subindustry: 'Defense Systems & Military Hardware' | 'Aerospace Manufacturing' | 'Avionics & Navigation Technology' | 'Subsea & Naval Defense Systems' | 'Space & Satellite Technology' | 'Defense IT & Systems Integration' | 'Software (B2B)' | 'Software (B2C)' | 'Cloud Infrastructure & DevOps' | 'Cybersecurity' | 'Artificial Intelligence & Machine Learning' | 'Data Infrastructure & Analytics' | 'Hardware & Semiconductors' | 'Fintech Infrastructure' | 'eCommerce & Marketplace Platforms' | 'Developer Tools & APIs' | 'Web3 & Blockchain' | 'XR & Spatial Computing' | 'Banking & Lending' | 'Investment Management & WealthTech' | 'Insurance & InsurTech' | 'Payments & Money Movement' | 'Accounting, Tax & Financial Planning Tools' | 'Capital Markets & Trading Platforms' | 'Financial Infrastructure & APIs' | 'Credit Scoring & Risk Management' | 'Cryptocurrency & Digital Assets' | 'BNPL & Alternative Financing' | 'Healthcare Providers & Services' | 'Pharmaceuticals & Drug Development' | 'Medical Devices & Diagnostics' | 'Biotechnology & Genomics' | 'Digital Health & Telemedicine' | 'Health Insurance & Benefits Tech' | 'Clinical Trials & Research Platforms' | 'Mental Health & Wellness' | 'Healthcare IT & EHR Systems' | 'Consumer Health & Wellness Products' | 'Online Marketplaces' | 'Direct-to-Consumer (DTC) Brands' | 'Retail Tech & Point-of-Sale Systems' | 'Omnichannel & In-Store Retail' | 'E-commerce Enablement & Infrastructure' | 'Subscription & Membership Commerce' | 'Social Commerce & Influencer Platforms' | 'Fashion & Apparel Retail' | 'Food, Beverage & Grocery E-commerce' | 'Streaming Platforms (Video, Music, Audio)' | 'Gaming & Interactive Entertainment' | 'Creator Economy & Influencer Platforms' | 'Advertising, Adtech & Media Buying' | 'Film, TV & Production Studios' | 'Events, Venues & Live Entertainment' | 'Virtual Worlds & Metaverse Experiences' | 'K-12 Education Platforms & Tools' | 'Higher Education & University Tech' | 'Online Learning & MOOCs' | 'Test Prep & Certification' | 'Corporate Training & Upskilling' | 'Tutoring & Supplemental Learning' | 'Education Management Systems (LMS/SIS)' | 'Language Learning' | 'Creator-Led & Cohort-Based Courses' | 'Special Education & Accessibility Tools' | 'Government Technology & Digital Services' | 'Civic Engagement & Policy Platforms' | 'International Development & Humanitarian Aid' | 'Philanthropy & Grantmaking' | 'Nonprofit Operations & Fundraising Tools' | 'Public Health & Social Services' | 'Education & Youth Development Programs' | 'Environmental & Climate Action Organizations' | 'Legal Aid & Social Justice Advocacy' | 'Municipal & Infrastructure Services' | 'Manufacturing & Industrial Automation' | 'Energy Production (Oil, Gas, Nuclear)' | 'Renewable Energy & Cleantech' | 'Utilities & Grid Infrastructure' | 'Industrial IoT & Monitoring Systems' | 'Construction & Heavy Equipment' | 'Mining & Natural Resources' | 'Environmental Engineering & Sustainability' | 'Energy Storage & Battery Technology' | 'Automotive OEMs & Vehicle Manufacturing' | 'Electric Vehicles (EVs) & Charging Infrastructure' | 'Mobility-as-a-Service (MaaS)' | 'Fleet Management' | 'Public Transit & Urban Mobility' | 'Autonomous Vehicles & ADAS' | 'Aftermarket Parts & Services' | 'Telematics & Vehicle Connectivity' | 'Aviation & Aerospace Transport' | 'Maritime Shipping' | 'Fitness & Wellness' | 'Beauty & Personal Care' | 'Home & Living' | 'Dating & Relationships' | 'Hobbies, Crafts & DIY' | 'Outdoor & Recreational Gear' | 'Events, Experiences & Ticketing Platforms' | 'Designer & Luxury Apparel' | 'Accessories, Jewelry & Watches' | 'Footwear & Leather Goods' | 'Beauty, Fragrance & Skincare' | 'Fashion Marketplaces & Retail Platforms' | 'Sustainable & Ethical Fashion' | 'Resale, Vintage & Circular Fashion' | 'Fashion Tech & Virtual Try-Ons' | 'Streetwear & Emerging Luxury' | 'Couture & Made-to-Measure' | 'News Publishing & Journalism' | 'Digital Media & Content Platforms' | 'Broadcasting (TV & Radio)' | 'Podcasting & Audio Media' | 'News Aggregators & Curation Tools' | 'Independent & Creator-Led Media' | 'Newsletters & Substack-Style Platforms' | 'Political & Investigative Media' | 'Trade & Niche Publications' | 'Media Monitoring & Analytics' | 'Professional Teams & Leagues' | 'Sports Media & Broadcasting' | 'Sports Betting & Fantasy Sports' | 'Fitness & Athletic Training Platforms' | 'Sportswear & Equipment' | 'Esports & Competitive Gaming' | 'Sports Venues & Event Management' | 'Athlete Management & Talent Agencies' | 'Sports Tech & Performance Analytics' | 'Youth, Amateur & Collegiate Sports' | 'Real Estate Marketplaces' | 'Property Management Software' | 'Rental Platforms' | 'Mortgage & Lending Tech' | 'Real Estate Investment Platforms' | 'Law Firms & Legal Services' | 'Legal Tech & Automation' | 'Regulatory Compliance' | 'E-Discovery & Litigation Tools' | 'Contract Management' | 'Governance, Risk & Compliance (GRC)' | 'IP & Trademark Management' | 'Legal Research & Intelligence' | 'Compliance Training & Certification' | 'Whistleblower & Ethics Reporting' | 'Mobile & Wireless Networks (3G/4G/5G)' | 'Broadband & Fiber Internet' | 'Satellite & Space-Based Communications' | 'Network Equipment & Infrastructure' | 'Telecom Billing & OSS/BSS Systems' | 'VoIP & Unified Communications' | 'Internet Service Providers (ISPs)' | 'Edge Computing & Network Virtualization' | 'IoT Connectivity Platforms' | 'Precision Agriculture & AgTech' | 'Crop & Livestock Production' | 'Food & Beverage Manufacturing & Processing' | 'Food Distribution' | 'Restaurants & Food Service' | 'Agricultural Inputs & Equipment' | 'Sustainable & Regenerative Agriculture' | 'Seafood & Aquaculture' | 'Management Consulting' | 'Marketing & Advertising Agencies' | 'Design, Branding & Creative Studios' | 'IT Services & Managed Services' | 'Staffing, Recruiting & Talent' | 'Accounting & Tax Firms' | 'Public Relations & Communications' | 'Business Process Outsourcing (BPO)' | 'Professional Training & Coaching' | 'Specialty Chemicals' | 'Commodity & Petrochemicals' | 'Polymers, Plastics & Rubber' | 'Coatings, Adhesives & Sealants' | 'Industrial Gases' | 'Advanced Materials & Composites' | 'Battery Materials & Energy Storage' | 'Electronic Materials & Semiconductor Chemicals' | 'Agrochemicals & Fertilizers' | 'Freight & Transportation Tech' | 'Last-Mile Delivery' | 'Warehouse Automation' | 'Supply Chain Visibility Platforms' | 'Logistics Marketplaces' | 'Shipping & Freight Forwarding' | 'Cold Chain Logistics' | 'Reverse Logistics & Returns' | 'Cross-Border Trade Tech' | 'Transportation Management Systems (TMS)' | 'Hotels & Accommodation' | 'Vacation Rentals & Short-Term Stays' | 'Restaurant Tech & Management' | 'Travel Booking Platforms' | 'Tourism Experiences & Activities' | 'Cruise Lines & Marine Tourism' | 'Hospitality Management Systems' | 'Event & Venue Management' | 'Corporate Travel Management' | 'Travel Insurance & Protection' | 'Construction Management Software' | 'BIM/CAD & Design Tools' | 'Construction Marketplaces' | 'Equipment Rental & Management' | 'Building Materials & Procurement' | 'Construction Workforce Management' | 'Project Estimation & Bidding' | 'Modular & Prefab Construction' | 'Construction Safety & Compliance' | 'Smart Building Technology' | 'Food & Beverage CPG' | 'Home & Personal Care CPG' | 'CPG Analytics & Insights' | 'Direct-to-Consumer CPG Brands' | 'CPG Supply Chain & Distribution' | 'Private Label Manufacturing' | 'CPG Retail Intelligence' | 'Sustainable CPG & Packaging' | 'Beauty & Cosmetics CPG' | 'Health & Wellness CPG';
|
|
2041
|
+
}
|
|
2042
|
+
}
|
|
2043
|
+
/**
|
|
2044
|
+
* Important website links for the brand
|
|
2045
|
+
*/
|
|
2046
|
+
interface Links {
|
|
2047
|
+
/**
|
|
2048
|
+
* URL to the brand's blog or news page
|
|
2049
|
+
*/
|
|
2050
|
+
blog?: string | null;
|
|
2051
|
+
/**
|
|
2052
|
+
* URL to the brand's careers or job opportunities page
|
|
2053
|
+
*/
|
|
2054
|
+
careers?: string | null;
|
|
2055
|
+
/**
|
|
2056
|
+
* URL to the brand's contact or contact us page
|
|
2057
|
+
*/
|
|
2058
|
+
contact?: string | null;
|
|
2059
|
+
/**
|
|
2060
|
+
* URL to the brand's pricing or plans page
|
|
2061
|
+
*/
|
|
2062
|
+
pricing?: string | null;
|
|
2063
|
+
/**
|
|
2064
|
+
* URL to the brand's privacy policy page
|
|
2065
|
+
*/
|
|
2066
|
+
privacy?: string | null;
|
|
2067
|
+
/**
|
|
2068
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
2069
|
+
*/
|
|
2070
|
+
terms?: string | null;
|
|
2071
|
+
}
|
|
2072
|
+
interface Logo {
|
|
2073
|
+
/**
|
|
2074
|
+
* Array of colors in the logo
|
|
2075
|
+
*/
|
|
2076
|
+
colors?: Array<Logo.Color>;
|
|
2077
|
+
/**
|
|
2078
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
2079
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
2080
|
+
* has its own background
|
|
2081
|
+
*/
|
|
2082
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
2083
|
+
/**
|
|
2084
|
+
* Resolution of the logo image
|
|
2085
|
+
*/
|
|
2086
|
+
resolution?: Logo.Resolution;
|
|
2087
|
+
/**
|
|
2088
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
2089
|
+
*/
|
|
2090
|
+
type?: 'icon' | 'logo';
|
|
2091
|
+
/**
|
|
2092
|
+
* CDN hosted url of the logo (ready for display)
|
|
2093
|
+
*/
|
|
2094
|
+
url?: string;
|
|
2095
|
+
}
|
|
2096
|
+
namespace Logo {
|
|
2097
|
+
interface Color {
|
|
2098
|
+
/**
|
|
2099
|
+
* Color in hexadecimal format
|
|
2100
|
+
*/
|
|
2101
|
+
hex?: string;
|
|
2102
|
+
/**
|
|
2103
|
+
* Name of the color
|
|
2104
|
+
*/
|
|
2105
|
+
name?: string;
|
|
2106
|
+
}
|
|
2107
|
+
/**
|
|
2108
|
+
* Resolution of the logo image
|
|
2109
|
+
*/
|
|
2110
|
+
interface Resolution {
|
|
2111
|
+
/**
|
|
2112
|
+
* Aspect ratio of the image (width/height)
|
|
2113
|
+
*/
|
|
2114
|
+
aspect_ratio?: number;
|
|
2115
|
+
/**
|
|
2116
|
+
* Height of the image in pixels
|
|
2117
|
+
*/
|
|
2118
|
+
height?: number;
|
|
2119
|
+
/**
|
|
2120
|
+
* Width of the image in pixels
|
|
2121
|
+
*/
|
|
2122
|
+
width?: number;
|
|
2123
|
+
}
|
|
2124
|
+
}
|
|
2125
|
+
interface Social {
|
|
2126
|
+
/**
|
|
2127
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
2128
|
+
*/
|
|
2129
|
+
type?: string;
|
|
2130
|
+
/**
|
|
2131
|
+
* URL of the social media page
|
|
2132
|
+
*/
|
|
2133
|
+
url?: string;
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
2137
|
+
* company)
|
|
2138
|
+
*/
|
|
2139
|
+
interface Stock {
|
|
2140
|
+
/**
|
|
2141
|
+
* Stock exchange name
|
|
2142
|
+
*/
|
|
2143
|
+
exchange?: string;
|
|
2144
|
+
/**
|
|
2145
|
+
* Stock ticker symbol
|
|
2146
|
+
*/
|
|
2147
|
+
ticker?: string;
|
|
2148
|
+
}
|
|
2149
|
+
}
|
|
2150
|
+
}
|
|
2151
|
+
export interface BrandRetrieveNaicsResponse {
|
|
2152
|
+
/**
|
|
2153
|
+
* Array of NAICS codes and titles.
|
|
2154
|
+
*/
|
|
2155
|
+
codes?: Array<BrandRetrieveNaicsResponse.Code>;
|
|
2156
|
+
/**
|
|
2157
|
+
* Domain found for the brand
|
|
2158
|
+
*/
|
|
2159
|
+
domain?: string;
|
|
2160
|
+
/**
|
|
2161
|
+
* Status of the response, e.g., 'ok'
|
|
2162
|
+
*/
|
|
2163
|
+
status?: string;
|
|
2164
|
+
/**
|
|
2165
|
+
* Industry classification type, for naics api it will be `naics`
|
|
2166
|
+
*/
|
|
2167
|
+
type?: string;
|
|
2168
|
+
}
|
|
2169
|
+
export declare namespace BrandRetrieveNaicsResponse {
|
|
2170
|
+
interface Code {
|
|
2171
|
+
/**
|
|
2172
|
+
* NAICS code
|
|
2173
|
+
*/
|
|
2174
|
+
code: string;
|
|
2175
|
+
/**
|
|
2176
|
+
* Confidence level for how well this NAICS code matches the company description
|
|
2177
|
+
*/
|
|
2178
|
+
confidence: 'high' | 'medium' | 'low';
|
|
2179
|
+
/**
|
|
2180
|
+
* NAICS title
|
|
2181
|
+
*/
|
|
2182
|
+
name: string;
|
|
2183
|
+
}
|
|
2184
|
+
}
|
|
2185
|
+
export interface BrandRetrieveSimplifiedResponse {
|
|
2186
|
+
/**
|
|
2187
|
+
* Simplified brand information
|
|
2188
|
+
*/
|
|
2189
|
+
brand?: BrandRetrieveSimplifiedResponse.Brand;
|
|
2190
|
+
/**
|
|
2191
|
+
* HTTP status code of the response
|
|
2192
|
+
*/
|
|
2193
|
+
code?: number;
|
|
2194
|
+
/**
|
|
2195
|
+
* Status of the response, e.g., 'ok'
|
|
2196
|
+
*/
|
|
2197
|
+
status?: string;
|
|
2198
|
+
}
|
|
2199
|
+
export declare namespace BrandRetrieveSimplifiedResponse {
|
|
2200
|
+
/**
|
|
2201
|
+
* Simplified brand information
|
|
2202
|
+
*/
|
|
2203
|
+
interface Brand {
|
|
2204
|
+
/**
|
|
2205
|
+
* An array of backdrop images for the brand
|
|
2206
|
+
*/
|
|
2207
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
2208
|
+
/**
|
|
2209
|
+
* An array of brand colors
|
|
2210
|
+
*/
|
|
2211
|
+
colors?: Array<Brand.Color>;
|
|
2212
|
+
/**
|
|
2213
|
+
* The domain name of the brand
|
|
2214
|
+
*/
|
|
2215
|
+
domain?: string;
|
|
2216
|
+
/**
|
|
2217
|
+
* An array of logos associated with the brand
|
|
2218
|
+
*/
|
|
2219
|
+
logos?: Array<Brand.Logo>;
|
|
2220
|
+
/**
|
|
2221
|
+
* The title or name of the brand
|
|
2222
|
+
*/
|
|
2223
|
+
title?: string;
|
|
2224
|
+
}
|
|
2225
|
+
namespace Brand {
|
|
2226
|
+
interface Backdrop {
|
|
2227
|
+
/**
|
|
2228
|
+
* Array of colors in the backdrop image
|
|
2229
|
+
*/
|
|
2230
|
+
colors?: Array<Backdrop.Color>;
|
|
2231
|
+
/**
|
|
2232
|
+
* Resolution of the backdrop image
|
|
2233
|
+
*/
|
|
2234
|
+
resolution?: Backdrop.Resolution;
|
|
2235
|
+
/**
|
|
2236
|
+
* URL of the backdrop image
|
|
2237
|
+
*/
|
|
2238
|
+
url?: string;
|
|
2239
|
+
}
|
|
2240
|
+
namespace Backdrop {
|
|
2241
|
+
interface Color {
|
|
2242
|
+
/**
|
|
2243
|
+
* Color in hexadecimal format
|
|
2244
|
+
*/
|
|
2245
|
+
hex?: string;
|
|
2246
|
+
/**
|
|
2247
|
+
* Name of the color
|
|
2248
|
+
*/
|
|
2249
|
+
name?: string;
|
|
2250
|
+
}
|
|
2251
|
+
/**
|
|
2252
|
+
* Resolution of the backdrop image
|
|
2253
|
+
*/
|
|
2254
|
+
interface Resolution {
|
|
2255
|
+
/**
|
|
2256
|
+
* Aspect ratio of the image (width/height)
|
|
2257
|
+
*/
|
|
2258
|
+
aspect_ratio?: number;
|
|
2259
|
+
/**
|
|
2260
|
+
* Height of the image in pixels
|
|
2261
|
+
*/
|
|
2262
|
+
height?: number;
|
|
2263
|
+
/**
|
|
2264
|
+
* Width of the image in pixels
|
|
2265
|
+
*/
|
|
2266
|
+
width?: number;
|
|
2267
|
+
}
|
|
2268
|
+
}
|
|
2269
|
+
interface Color {
|
|
2270
|
+
/**
|
|
2271
|
+
* Color in hexadecimal format
|
|
2272
|
+
*/
|
|
2273
|
+
hex?: string;
|
|
2274
|
+
/**
|
|
2275
|
+
* Name of the color
|
|
2276
|
+
*/
|
|
2277
|
+
name?: string;
|
|
2278
|
+
}
|
|
2279
|
+
interface Logo {
|
|
2280
|
+
/**
|
|
2281
|
+
* Array of colors in the logo
|
|
2282
|
+
*/
|
|
2283
|
+
colors?: Array<Logo.Color>;
|
|
2284
|
+
/**
|
|
2285
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
2286
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
2287
|
+
* has its own background
|
|
2288
|
+
*/
|
|
2289
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
2290
|
+
/**
|
|
2291
|
+
* Resolution of the logo image
|
|
2292
|
+
*/
|
|
2293
|
+
resolution?: Logo.Resolution;
|
|
2294
|
+
/**
|
|
2295
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
2296
|
+
*/
|
|
2297
|
+
type?: 'icon' | 'logo';
|
|
2298
|
+
/**
|
|
2299
|
+
* CDN hosted url of the logo (ready for display)
|
|
2300
|
+
*/
|
|
2301
|
+
url?: string;
|
|
2302
|
+
}
|
|
2303
|
+
namespace Logo {
|
|
2304
|
+
interface Color {
|
|
2305
|
+
/**
|
|
2306
|
+
* Color in hexadecimal format
|
|
2307
|
+
*/
|
|
2308
|
+
hex?: string;
|
|
2309
|
+
/**
|
|
2310
|
+
* Name of the color
|
|
2311
|
+
*/
|
|
2312
|
+
name?: string;
|
|
2313
|
+
}
|
|
2314
|
+
/**
|
|
2315
|
+
* Resolution of the logo image
|
|
2316
|
+
*/
|
|
2317
|
+
interface Resolution {
|
|
2318
|
+
/**
|
|
2319
|
+
* Aspect ratio of the image (width/height)
|
|
2320
|
+
*/
|
|
2321
|
+
aspect_ratio?: number;
|
|
2322
|
+
/**
|
|
2323
|
+
* Height of the image in pixels
|
|
2324
|
+
*/
|
|
2325
|
+
height?: number;
|
|
2326
|
+
/**
|
|
2327
|
+
* Width of the image in pixels
|
|
2328
|
+
*/
|
|
2329
|
+
width?: number;
|
|
2330
|
+
}
|
|
2331
|
+
}
|
|
2332
|
+
}
|
|
2333
|
+
}
|
|
2334
|
+
export interface BrandScreenshotResponse {
|
|
2335
|
+
/**
|
|
2336
|
+
* HTTP status code
|
|
2337
|
+
*/
|
|
2338
|
+
code?: number;
|
|
2339
|
+
/**
|
|
2340
|
+
* The normalized domain that was processed
|
|
2341
|
+
*/
|
|
2342
|
+
domain?: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* Public URL of the uploaded screenshot image
|
|
2345
|
+
*/
|
|
2346
|
+
screenshot?: string;
|
|
2347
|
+
/**
|
|
2348
|
+
* Type of screenshot that was captured
|
|
2349
|
+
*/
|
|
2350
|
+
screenshotType?: 'viewport' | 'fullPage';
|
|
2351
|
+
/**
|
|
2352
|
+
* Status of the response, e.g., 'ok'
|
|
2353
|
+
*/
|
|
2354
|
+
status?: string;
|
|
2355
|
+
}
|
|
2356
|
+
export interface BrandStyleguideResponse {
|
|
2357
|
+
/**
|
|
2358
|
+
* HTTP status code
|
|
2359
|
+
*/
|
|
2360
|
+
code?: number;
|
|
2361
|
+
/**
|
|
2362
|
+
* The normalized domain that was processed
|
|
2363
|
+
*/
|
|
2364
|
+
domain?: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* Status of the response, e.g., 'ok'
|
|
2367
|
+
*/
|
|
2368
|
+
status?: string;
|
|
2369
|
+
/**
|
|
2370
|
+
* Comprehensive styleguide data extracted from the website
|
|
2371
|
+
*/
|
|
2372
|
+
styleguide?: BrandStyleguideResponse.Styleguide;
|
|
2373
|
+
}
|
|
2374
|
+
export declare namespace BrandStyleguideResponse {
|
|
2375
|
+
/**
|
|
2376
|
+
* Comprehensive styleguide data extracted from the website
|
|
2377
|
+
*/
|
|
2378
|
+
interface Styleguide {
|
|
2379
|
+
/**
|
|
2380
|
+
* Primary colors used on the website
|
|
2381
|
+
*/
|
|
2382
|
+
colors?: Styleguide.Colors;
|
|
2383
|
+
/**
|
|
2384
|
+
* UI component styles
|
|
2385
|
+
*/
|
|
2386
|
+
components?: Styleguide.Components;
|
|
2387
|
+
/**
|
|
2388
|
+
* Spacing system used on the website
|
|
2389
|
+
*/
|
|
2390
|
+
elementSpacing?: Styleguide.ElementSpacing;
|
|
2391
|
+
/**
|
|
2392
|
+
* The primary color mode of the website design
|
|
2393
|
+
*/
|
|
2394
|
+
mode?: 'light' | 'dark';
|
|
2395
|
+
/**
|
|
2396
|
+
* Shadow styles used on the website
|
|
2397
|
+
*/
|
|
2398
|
+
shadows?: Styleguide.Shadows;
|
|
2399
|
+
/**
|
|
2400
|
+
* Typography styles used on the website
|
|
2401
|
+
*/
|
|
2402
|
+
typography?: Styleguide.Typography;
|
|
2403
|
+
}
|
|
2404
|
+
namespace Styleguide {
|
|
2405
|
+
/**
|
|
2406
|
+
* Primary colors used on the website
|
|
2407
|
+
*/
|
|
2408
|
+
interface Colors {
|
|
2409
|
+
/**
|
|
2410
|
+
* Accent color of the website (hex format)
|
|
2411
|
+
*/
|
|
2412
|
+
accent?: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* Background color of the website (hex format)
|
|
2415
|
+
*/
|
|
2416
|
+
background?: string;
|
|
2417
|
+
/**
|
|
2418
|
+
* Text color of the website (hex format)
|
|
2419
|
+
*/
|
|
2420
|
+
text?: string;
|
|
2421
|
+
}
|
|
2422
|
+
/**
|
|
2423
|
+
* UI component styles
|
|
2424
|
+
*/
|
|
2425
|
+
interface Components {
|
|
2426
|
+
/**
|
|
2427
|
+
* Button component styles
|
|
2428
|
+
*/
|
|
2429
|
+
button?: Components.Button;
|
|
2430
|
+
/**
|
|
2431
|
+
* Card component style
|
|
2432
|
+
*/
|
|
2433
|
+
card?: Components.Card;
|
|
2434
|
+
}
|
|
2435
|
+
namespace Components {
|
|
2436
|
+
/**
|
|
2437
|
+
* Button component styles
|
|
2438
|
+
*/
|
|
2439
|
+
interface Button {
|
|
2440
|
+
/**
|
|
2441
|
+
* Link button style
|
|
2442
|
+
*/
|
|
2443
|
+
link?: Button.Link;
|
|
2444
|
+
/**
|
|
2445
|
+
* Primary button style
|
|
2446
|
+
*/
|
|
2447
|
+
primary?: Button.Primary;
|
|
2448
|
+
/**
|
|
2449
|
+
* Secondary button style
|
|
2450
|
+
*/
|
|
2451
|
+
secondary?: Button.Secondary;
|
|
2452
|
+
}
|
|
2453
|
+
namespace Button {
|
|
2454
|
+
/**
|
|
2455
|
+
* Link button style
|
|
2456
|
+
*/
|
|
2457
|
+
interface Link {
|
|
2458
|
+
backgroundColor?: string;
|
|
2459
|
+
borderColor?: string;
|
|
2460
|
+
borderRadius?: string;
|
|
2461
|
+
borderStyle?: string;
|
|
2462
|
+
borderWidth?: string;
|
|
2463
|
+
boxShadow?: string;
|
|
2464
|
+
color?: string;
|
|
2465
|
+
fontSize?: string;
|
|
2466
|
+
fontWeight?: number;
|
|
2467
|
+
padding?: string;
|
|
2468
|
+
textDecoration?: string;
|
|
2469
|
+
}
|
|
2470
|
+
/**
|
|
2471
|
+
* Primary button style
|
|
2472
|
+
*/
|
|
2473
|
+
interface Primary {
|
|
2474
|
+
backgroundColor?: string;
|
|
2475
|
+
borderColor?: string;
|
|
2476
|
+
borderRadius?: string;
|
|
2477
|
+
borderStyle?: string;
|
|
2478
|
+
borderWidth?: string;
|
|
2479
|
+
boxShadow?: string;
|
|
2480
|
+
color?: string;
|
|
2481
|
+
fontSize?: string;
|
|
2482
|
+
fontWeight?: number;
|
|
2483
|
+
padding?: string;
|
|
2484
|
+
textDecoration?: string;
|
|
2485
|
+
}
|
|
2486
|
+
/**
|
|
2487
|
+
* Secondary button style
|
|
2488
|
+
*/
|
|
2489
|
+
interface Secondary {
|
|
2490
|
+
backgroundColor?: string;
|
|
2491
|
+
borderColor?: string;
|
|
2492
|
+
borderRadius?: string;
|
|
2493
|
+
borderStyle?: string;
|
|
2494
|
+
borderWidth?: string;
|
|
2495
|
+
boxShadow?: string;
|
|
2496
|
+
color?: string;
|
|
2497
|
+
fontSize?: string;
|
|
2498
|
+
fontWeight?: number;
|
|
2499
|
+
padding?: string;
|
|
2500
|
+
textDecoration?: string;
|
|
2501
|
+
}
|
|
2502
|
+
}
|
|
2503
|
+
/**
|
|
2504
|
+
* Card component style
|
|
2505
|
+
*/
|
|
2506
|
+
interface Card {
|
|
2507
|
+
backgroundColor?: string;
|
|
2508
|
+
borderColor?: string;
|
|
2509
|
+
borderRadius?: string;
|
|
2510
|
+
borderStyle?: string;
|
|
2511
|
+
borderWidth?: string;
|
|
2512
|
+
boxShadow?: string;
|
|
2513
|
+
padding?: string;
|
|
2514
|
+
textColor?: string;
|
|
2515
|
+
}
|
|
2516
|
+
}
|
|
2517
|
+
/**
|
|
2518
|
+
* Spacing system used on the website
|
|
2519
|
+
*/
|
|
2520
|
+
interface ElementSpacing {
|
|
2521
|
+
/**
|
|
2522
|
+
* Large spacing value
|
|
2523
|
+
*/
|
|
2524
|
+
lg?: string;
|
|
2525
|
+
/**
|
|
2526
|
+
* Medium spacing value
|
|
2527
|
+
*/
|
|
2528
|
+
md?: string;
|
|
2529
|
+
/**
|
|
2530
|
+
* Small spacing value
|
|
2531
|
+
*/
|
|
2532
|
+
sm?: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* Extra large spacing value
|
|
2535
|
+
*/
|
|
2536
|
+
xl?: string;
|
|
2537
|
+
/**
|
|
2538
|
+
* Extra small spacing value
|
|
2539
|
+
*/
|
|
2540
|
+
xs?: string;
|
|
2541
|
+
}
|
|
2542
|
+
/**
|
|
2543
|
+
* Shadow styles used on the website
|
|
2544
|
+
*/
|
|
2545
|
+
interface Shadows {
|
|
2546
|
+
/**
|
|
2547
|
+
* Inner shadow value
|
|
2548
|
+
*/
|
|
2549
|
+
inner?: string;
|
|
2550
|
+
/**
|
|
2551
|
+
* Large shadow value
|
|
2552
|
+
*/
|
|
2553
|
+
lg?: string;
|
|
2554
|
+
/**
|
|
2555
|
+
* Medium shadow value
|
|
2556
|
+
*/
|
|
2557
|
+
md?: string;
|
|
2558
|
+
/**
|
|
2559
|
+
* Small shadow value
|
|
2560
|
+
*/
|
|
2561
|
+
sm?: string;
|
|
2562
|
+
/**
|
|
2563
|
+
* Extra large shadow value
|
|
2564
|
+
*/
|
|
2565
|
+
xl?: string;
|
|
2566
|
+
}
|
|
2567
|
+
/**
|
|
2568
|
+
* Typography styles used on the website
|
|
2569
|
+
*/
|
|
2570
|
+
interface Typography {
|
|
2571
|
+
/**
|
|
2572
|
+
* Heading styles
|
|
2573
|
+
*/
|
|
2574
|
+
headings?: Typography.Headings;
|
|
2575
|
+
/**
|
|
2576
|
+
* Paragraph text styles
|
|
2577
|
+
*/
|
|
2578
|
+
p?: Typography.P;
|
|
2579
|
+
}
|
|
2580
|
+
namespace Typography {
|
|
2581
|
+
/**
|
|
2582
|
+
* Heading styles
|
|
2583
|
+
*/
|
|
2584
|
+
interface Headings {
|
|
2585
|
+
h1?: Headings.H1;
|
|
2586
|
+
h2?: Headings.H2;
|
|
2587
|
+
h3?: Headings.H3;
|
|
2588
|
+
h4?: Headings.H4;
|
|
2589
|
+
}
|
|
2590
|
+
namespace Headings {
|
|
2591
|
+
interface H1 {
|
|
2592
|
+
fontFamily?: string;
|
|
2593
|
+
fontSize?: string;
|
|
2594
|
+
fontWeight?: number;
|
|
2595
|
+
letterSpacing?: string;
|
|
2596
|
+
lineHeight?: string;
|
|
2597
|
+
}
|
|
2598
|
+
interface H2 {
|
|
2599
|
+
fontFamily?: string;
|
|
2600
|
+
fontSize?: string;
|
|
2601
|
+
fontWeight?: number;
|
|
2602
|
+
letterSpacing?: string;
|
|
2603
|
+
lineHeight?: string;
|
|
2604
|
+
}
|
|
2605
|
+
interface H3 {
|
|
2606
|
+
fontFamily?: string;
|
|
2607
|
+
fontSize?: string;
|
|
2608
|
+
fontWeight?: number;
|
|
2609
|
+
letterSpacing?: string;
|
|
2610
|
+
lineHeight?: string;
|
|
2611
|
+
}
|
|
2612
|
+
interface H4 {
|
|
2613
|
+
fontFamily?: string;
|
|
2614
|
+
fontSize?: string;
|
|
2615
|
+
fontWeight?: number;
|
|
2616
|
+
letterSpacing?: string;
|
|
2617
|
+
lineHeight?: string;
|
|
2618
|
+
}
|
|
2619
|
+
}
|
|
2620
|
+
/**
|
|
2621
|
+
* Paragraph text styles
|
|
2622
|
+
*/
|
|
2623
|
+
interface P {
|
|
2624
|
+
fontFamily?: string;
|
|
2625
|
+
fontSize?: string;
|
|
2626
|
+
fontWeight?: number;
|
|
2627
|
+
letterSpacing?: string;
|
|
2628
|
+
lineHeight?: string;
|
|
2629
|
+
}
|
|
2630
|
+
}
|
|
2631
|
+
}
|
|
2632
|
+
}
|
|
2633
|
+
export interface BrandWebScrapeHTMLResponse {
|
|
2634
|
+
/**
|
|
2635
|
+
* Raw HTML content of the page
|
|
2636
|
+
*/
|
|
2637
|
+
html: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* Indicates success
|
|
2640
|
+
*/
|
|
2641
|
+
success: true;
|
|
2642
|
+
/**
|
|
2643
|
+
* The URL that was scraped
|
|
2644
|
+
*/
|
|
2645
|
+
url: string;
|
|
2646
|
+
}
|
|
2647
|
+
export interface BrandWebScrapeImagesResponse {
|
|
2648
|
+
/**
|
|
2649
|
+
* Array of scraped images
|
|
2650
|
+
*/
|
|
2651
|
+
images: Array<BrandWebScrapeImagesResponse.Image>;
|
|
2652
|
+
/**
|
|
2653
|
+
* Indicates success
|
|
2654
|
+
*/
|
|
2655
|
+
success: true;
|
|
2656
|
+
/**
|
|
2657
|
+
* The URL that was scraped
|
|
2658
|
+
*/
|
|
2659
|
+
url: string;
|
|
2660
|
+
}
|
|
2661
|
+
export declare namespace BrandWebScrapeImagesResponse {
|
|
2662
|
+
interface Image {
|
|
2663
|
+
/**
|
|
2664
|
+
* Alt text of the image, or null if not present
|
|
2665
|
+
*/
|
|
2666
|
+
alt: string | null;
|
|
2667
|
+
/**
|
|
2668
|
+
* The HTML element the image was found in
|
|
2669
|
+
*/
|
|
2670
|
+
element: 'img' | 'svg' | 'link' | 'source' | 'video';
|
|
2671
|
+
/**
|
|
2672
|
+
* The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
|
|
2673
|
+
*/
|
|
2674
|
+
src: string;
|
|
2675
|
+
/**
|
|
2676
|
+
* The type/format of the src value
|
|
2677
|
+
*/
|
|
2678
|
+
type: 'url' | 'html' | 'base64';
|
|
2679
|
+
}
|
|
2680
|
+
}
|
|
2681
|
+
export interface BrandWebScrapeMdResponse {
|
|
2682
|
+
/**
|
|
2683
|
+
* Page content converted to GitHub Flavored Markdown
|
|
2684
|
+
*/
|
|
2685
|
+
markdown: string;
|
|
2686
|
+
/**
|
|
2687
|
+
* Indicates success
|
|
2688
|
+
*/
|
|
2689
|
+
success: true;
|
|
2690
|
+
/**
|
|
2691
|
+
* The URL that was scraped
|
|
2692
|
+
*/
|
|
2693
|
+
url: string;
|
|
2694
|
+
}
|
|
2695
|
+
export interface BrandWebScrapeSitemapResponse {
|
|
2696
|
+
/**
|
|
2697
|
+
* The normalized domain that was crawled
|
|
2698
|
+
*/
|
|
2699
|
+
domain: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* Metadata about the sitemap crawl operation
|
|
2702
|
+
*/
|
|
2703
|
+
meta: BrandWebScrapeSitemapResponse.Meta;
|
|
2704
|
+
/**
|
|
2705
|
+
* Indicates success
|
|
2706
|
+
*/
|
|
2707
|
+
success: true;
|
|
2708
|
+
/**
|
|
2709
|
+
* Array of discovered page URLs from the sitemap (max 500)
|
|
2710
|
+
*/
|
|
2711
|
+
urls: Array<string>;
|
|
2712
|
+
}
|
|
2713
|
+
export declare namespace BrandWebScrapeSitemapResponse {
|
|
2714
|
+
/**
|
|
2715
|
+
* Metadata about the sitemap crawl operation
|
|
2716
|
+
*/
|
|
2717
|
+
interface Meta {
|
|
2718
|
+
/**
|
|
2719
|
+
* Number of errors encountered during crawling
|
|
2720
|
+
*/
|
|
2721
|
+
errors: number;
|
|
2722
|
+
/**
|
|
2723
|
+
* Total number of sitemap files discovered
|
|
2724
|
+
*/
|
|
2725
|
+
sitemapsDiscovered: number;
|
|
2726
|
+
/**
|
|
2727
|
+
* Number of sitemap files successfully fetched and parsed
|
|
2728
|
+
*/
|
|
2729
|
+
sitemapsFetched: number;
|
|
2730
|
+
/**
|
|
2731
|
+
* Number of sitemap files skipped (due to errors, timeouts, or limits)
|
|
2732
|
+
*/
|
|
2733
|
+
sitemapsSkipped: number;
|
|
2734
|
+
}
|
|
2735
|
+
}
|
|
2736
|
+
export interface BrandRetrieveParams {
|
|
2737
|
+
/**
|
|
2738
|
+
* Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
|
|
2739
|
+
* Cannot be used with name or ticker parameters.
|
|
2740
|
+
*/
|
|
2741
|
+
domain: string;
|
|
2742
|
+
/**
|
|
2743
|
+
* Optional parameter to force the language of the retrieved brand data. Works with
|
|
2744
|
+
* all three lookup methods.
|
|
2745
|
+
*/
|
|
2746
|
+
force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
|
|
2747
|
+
/**
|
|
2748
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2749
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2750
|
+
* less comprehensive data. Works with all three lookup methods.
|
|
2751
|
+
*/
|
|
2752
|
+
maxSpeed?: boolean;
|
|
2753
|
+
/**
|
|
2754
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2755
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2756
|
+
* value is 300000ms (5 minutes).
|
|
2757
|
+
*/
|
|
2758
|
+
timeoutMS?: number;
|
|
2759
|
+
}
|
|
2760
|
+
export interface BrandAIProductParams {
|
|
2761
|
+
/**
|
|
2762
|
+
* The product page URL to extract product data from.
|
|
2763
|
+
*/
|
|
2764
|
+
url: string;
|
|
2765
|
+
/**
|
|
2766
|
+
* Optional timeout in milliseconds for the request. Maximum allowed value is
|
|
2767
|
+
* 300000ms (5 minutes).
|
|
2768
|
+
*/
|
|
2769
|
+
timeoutMS?: number;
|
|
2770
|
+
}
|
|
2771
|
+
export type BrandAIProductsParams = BrandAIProductsParams.ByDomain | BrandAIProductsParams.ByDirectURL;
|
|
2772
|
+
export declare namespace BrandAIProductsParams {
|
|
2773
|
+
interface ByDomain {
|
|
2774
|
+
/**
|
|
2775
|
+
* The domain name to analyze.
|
|
2776
|
+
*/
|
|
2777
|
+
domain: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* Maximum number of products to extract.
|
|
2780
|
+
*/
|
|
2781
|
+
maxProducts?: number;
|
|
2782
|
+
/**
|
|
2783
|
+
* Optional timeout in milliseconds for the request. Maximum allowed value is
|
|
2784
|
+
* 300000ms (5 minutes).
|
|
2785
|
+
*/
|
|
2786
|
+
timeoutMS?: number;
|
|
2787
|
+
}
|
|
2788
|
+
interface ByDirectURL {
|
|
2789
|
+
/**
|
|
2790
|
+
* A specific URL to use directly as the starting point for extraction without
|
|
2791
|
+
* domain resolution.
|
|
2792
|
+
*/
|
|
2793
|
+
directUrl: string;
|
|
2794
|
+
/**
|
|
2795
|
+
* Maximum number of products to extract.
|
|
2796
|
+
*/
|
|
2797
|
+
maxProducts?: number;
|
|
2798
|
+
/**
|
|
2799
|
+
* Optional timeout in milliseconds for the request. Maximum allowed value is
|
|
2800
|
+
* 300000ms (5 minutes).
|
|
2801
|
+
*/
|
|
2802
|
+
timeoutMS?: number;
|
|
2803
|
+
}
|
|
2804
|
+
}
|
|
2805
|
+
export interface BrandAIQueryParams {
|
|
2806
|
+
/**
|
|
2807
|
+
* Array of data points to extract from the website
|
|
2808
|
+
*/
|
|
2809
|
+
data_to_extract: Array<BrandAIQueryParams.DataToExtract>;
|
|
2810
|
+
/**
|
|
2811
|
+
* The domain name to analyze
|
|
2812
|
+
*/
|
|
2813
|
+
domain: string;
|
|
2814
|
+
/**
|
|
2815
|
+
* Optional object specifying which pages to analyze
|
|
2816
|
+
*/
|
|
2817
|
+
specific_pages?: BrandAIQueryParams.SpecificPages;
|
|
2818
|
+
/**
|
|
2819
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2820
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2821
|
+
* value is 300000ms (5 minutes).
|
|
2822
|
+
*/
|
|
2823
|
+
timeoutMS?: number;
|
|
2824
|
+
}
|
|
2825
|
+
export declare namespace BrandAIQueryParams {
|
|
2826
|
+
interface DataToExtract {
|
|
2827
|
+
/**
|
|
2828
|
+
* Description of what to extract
|
|
2829
|
+
*/
|
|
2830
|
+
datapoint_description: string;
|
|
2831
|
+
/**
|
|
2832
|
+
* Example of the expected value
|
|
2833
|
+
*/
|
|
2834
|
+
datapoint_example: string;
|
|
2835
|
+
/**
|
|
2836
|
+
* Name of the data point to extract
|
|
2837
|
+
*/
|
|
2838
|
+
datapoint_name: string;
|
|
2839
|
+
/**
|
|
2840
|
+
* Type of the data point
|
|
2841
|
+
*/
|
|
2842
|
+
datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
|
|
2843
|
+
/**
|
|
2844
|
+
* Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
|
|
2845
|
+
* Use 'object' to extract an array of objects matching a schema.
|
|
2846
|
+
*/
|
|
2847
|
+
datapoint_list_type?: 'string' | 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url' | 'object';
|
|
2848
|
+
/**
|
|
2849
|
+
* Schema definition for objects when datapoint_list_type is 'object'. Provide a
|
|
2850
|
+
* map of field names to their scalar types.
|
|
2851
|
+
*/
|
|
2852
|
+
datapoint_object_schema?: {
|
|
2853
|
+
[key: string]: 'string' | 'number' | 'date' | 'boolean';
|
|
2854
|
+
};
|
|
2855
|
+
}
|
|
2856
|
+
/**
|
|
2857
|
+
* Optional object specifying which pages to analyze
|
|
2858
|
+
*/
|
|
2859
|
+
interface SpecificPages {
|
|
2860
|
+
/**
|
|
2861
|
+
* Whether to analyze the about us page
|
|
2862
|
+
*/
|
|
2863
|
+
about_us?: boolean;
|
|
2864
|
+
/**
|
|
2865
|
+
* Whether to analyze the blog
|
|
2866
|
+
*/
|
|
2867
|
+
blog?: boolean;
|
|
2868
|
+
/**
|
|
2869
|
+
* Whether to analyze the careers page
|
|
2870
|
+
*/
|
|
2871
|
+
careers?: boolean;
|
|
2872
|
+
/**
|
|
2873
|
+
* Whether to analyze the contact us page
|
|
2874
|
+
*/
|
|
2875
|
+
contact_us?: boolean;
|
|
2876
|
+
/**
|
|
2877
|
+
* Whether to analyze the FAQ page
|
|
2878
|
+
*/
|
|
2879
|
+
faq?: boolean;
|
|
2880
|
+
/**
|
|
2881
|
+
* Whether to analyze the home page
|
|
2882
|
+
*/
|
|
2883
|
+
home_page?: boolean;
|
|
2884
|
+
/**
|
|
2885
|
+
* Whether to analyze the pricing page
|
|
2886
|
+
*/
|
|
2887
|
+
pricing?: boolean;
|
|
2888
|
+
/**
|
|
2889
|
+
* Whether to analyze the privacy policy page
|
|
2890
|
+
*/
|
|
2891
|
+
privacy_policy?: boolean;
|
|
2892
|
+
/**
|
|
2893
|
+
* Whether to analyze the terms and conditions page
|
|
2894
|
+
*/
|
|
2895
|
+
terms_and_conditions?: boolean;
|
|
2896
|
+
}
|
|
2897
|
+
}
|
|
2898
|
+
export interface BrandFontsParams {
|
|
2899
|
+
/**
|
|
2900
|
+
* Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The
|
|
2901
|
+
* domain will be automatically normalized and validated.
|
|
2902
|
+
*/
|
|
2903
|
+
domain: string;
|
|
2904
|
+
/**
|
|
2905
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2906
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2907
|
+
* value is 300000ms (5 minutes).
|
|
2908
|
+
*/
|
|
2909
|
+
timeoutMS?: number;
|
|
2910
|
+
}
|
|
2911
|
+
export interface BrandIdentifyFromTransactionParams {
|
|
2912
|
+
/**
|
|
2913
|
+
* Transaction information to identify the brand
|
|
2914
|
+
*/
|
|
2915
|
+
transaction_info: string;
|
|
2916
|
+
/**
|
|
2917
|
+
* Optional city name to prioritize when searching for the brand.
|
|
2918
|
+
*/
|
|
2919
|
+
city?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* Optional country code (GL parameter) to specify the country. This affects the
|
|
2922
|
+
* geographic location used for search queries.
|
|
2923
|
+
*/
|
|
2924
|
+
country_gl?: 'ad' | 'ae' | 'af' | 'ag' | 'ai' | 'al' | 'am' | 'an' | 'ao' | 'aq' | 'ar' | 'as' | 'at' | 'au' | 'aw' | 'az' | 'ba' | 'bb' | 'bd' | 'be' | 'bf' | 'bg' | 'bh' | 'bi' | 'bj' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'bt' | 'bv' | 'bw' | 'by' | 'bz' | 'ca' | 'cc' | 'cd' | 'cf' | 'cg' | 'ch' | 'ci' | 'ck' | 'cl' | 'cm' | 'cn' | 'co' | 'cr' | 'cu' | 'cv' | 'cx' | 'cy' | 'cz' | 'de' | 'dj' | 'dk' | 'dm' | 'do' | 'dz' | 'ec' | 'ee' | 'eg' | 'eh' | 'er' | 'es' | 'et' | 'fi' | 'fj' | 'fk' | 'fm' | 'fo' | 'fr' | 'ga' | 'gb' | 'gd' | 'ge' | 'gf' | 'gh' | 'gi' | 'gl' | 'gm' | 'gn' | 'gp' | 'gq' | 'gr' | 'gs' | 'gt' | 'gu' | 'gw' | 'gy' | 'hk' | 'hm' | 'hn' | 'hr' | 'ht' | 'hu' | 'id' | 'ie' | 'il' | 'in' | 'io' | 'iq' | 'ir' | 'is' | 'it' | 'jm' | 'jo' | 'jp' | 'ke' | 'kg' | 'kh' | 'ki' | 'km' | 'kn' | 'kp' | 'kr' | 'kw' | 'ky' | 'kz' | 'la' | 'lb' | 'lc' | 'li' | 'lk' | 'lr' | 'ls' | 'lt' | 'lu' | 'lv' | 'ly' | 'ma' | 'mc' | 'md' | 'mg' | 'mh' | 'mk' | 'ml' | 'mm' | 'mn' | 'mo' | 'mp' | 'mq' | 'mr' | 'ms' | 'mt' | 'mu' | 'mv' | 'mw' | 'mx' | 'my' | 'mz' | 'na' | 'nc' | 'ne' | 'nf' | 'ng' | 'ni' | 'nl' | 'no' | 'np' | 'nr' | 'nu' | 'nz' | 'om' | 'pa' | 'pe' | 'pf' | 'pg' | 'ph' | 'pk' | 'pl' | 'pm' | 'pn' | 'pr' | 'ps' | 'pt' | 'pw' | 'py' | 'qa' | 're' | 'ro' | 'rs' | 'ru' | 'rw' | 'sa' | 'sb' | 'sc' | 'sd' | 'se' | 'sg' | 'sh' | 'si' | 'sj' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sr' | 'st' | 'sv' | 'sy' | 'sz' | 'tc' | 'td' | 'tf' | 'tg' | 'th' | 'tj' | 'tk' | 'tl' | 'tm' | 'tn' | 'to' | 'tr' | 'tt' | 'tv' | 'tw' | 'tz' | 'ua' | 'ug' | 'um' | 'us' | 'uy' | 'uz' | 'va' | 'vc' | 've' | 'vg' | 'vi' | 'vn' | 'vu' | 'wf' | 'ws' | 'ye' | 'yt' | 'za' | 'zm' | 'zw';
|
|
2925
|
+
/**
|
|
2926
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
2927
|
+
*/
|
|
2928
|
+
force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
|
|
2929
|
+
/**
|
|
2930
|
+
* When set to true, the API will perform an additional verification steps to
|
|
2931
|
+
* ensure the identified brand matches the transaction with high confidence.
|
|
2932
|
+
* Defaults to false.
|
|
2933
|
+
*/
|
|
2934
|
+
high_confidence_only?: boolean;
|
|
2935
|
+
/**
|
|
2936
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2937
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2938
|
+
* less comprehensive data.
|
|
2939
|
+
*/
|
|
2940
|
+
maxSpeed?: boolean;
|
|
2941
|
+
/**
|
|
2942
|
+
* Optional Merchant Category Code (MCC) to help identify the business
|
|
2943
|
+
* category/industry.
|
|
2944
|
+
*/
|
|
2945
|
+
mcc?: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* Optional phone number from the transaction to help verify brand match.
|
|
2948
|
+
*/
|
|
2949
|
+
phone?: number;
|
|
2950
|
+
/**
|
|
2951
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2952
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2953
|
+
* value is 300000ms (5 minutes).
|
|
2954
|
+
*/
|
|
2955
|
+
timeoutMS?: number;
|
|
2956
|
+
}
|
|
2957
|
+
export interface BrandPrefetchParams {
|
|
2958
|
+
/**
|
|
2959
|
+
* Domain name to prefetch brand data for
|
|
2960
|
+
*/
|
|
2961
|
+
domain: string;
|
|
2962
|
+
/**
|
|
2963
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2964
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2965
|
+
* value is 300000ms (5 minutes).
|
|
2966
|
+
*/
|
|
2967
|
+
timeoutMS?: number;
|
|
2968
|
+
}
|
|
2969
|
+
export interface BrandPrefetchByEmailParams {
|
|
2970
|
+
/**
|
|
2971
|
+
* Email address to prefetch brand data for. The domain will be extracted from the
|
|
2972
|
+
* email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
|
|
2973
|
+
* addresses are not allowed.
|
|
2974
|
+
*/
|
|
2975
|
+
email: string;
|
|
2976
|
+
/**
|
|
2977
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2978
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2979
|
+
* value is 300000ms (5 minutes).
|
|
2980
|
+
*/
|
|
2981
|
+
timeoutMS?: number;
|
|
2982
|
+
}
|
|
2983
|
+
export interface BrandRetrieveByEmailParams {
|
|
2984
|
+
/**
|
|
2985
|
+
* Email address to retrieve brand data for (e.g., 'contact@example.com'). The
|
|
2986
|
+
* domain will be extracted from the email. Free email providers (gmail.com,
|
|
2987
|
+
* yahoo.com, etc.) and disposable email addresses are not allowed.
|
|
2988
|
+
*/
|
|
2989
|
+
email: string;
|
|
2990
|
+
/**
|
|
2991
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
2992
|
+
*/
|
|
2993
|
+
force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
|
|
2994
|
+
/**
|
|
2995
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2996
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2997
|
+
* less comprehensive data.
|
|
2998
|
+
*/
|
|
2999
|
+
maxSpeed?: boolean;
|
|
3000
|
+
/**
|
|
3001
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
3002
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
3003
|
+
* value is 300000ms (5 minutes).
|
|
3004
|
+
*/
|
|
3005
|
+
timeoutMS?: number;
|
|
3006
|
+
}
|
|
3007
|
+
export interface BrandRetrieveByIsinParams {
|
|
3008
|
+
/**
|
|
3009
|
+
* ISIN (International Securities Identification Number) to retrieve brand data for
|
|
3010
|
+
* (e.g., 'AU000000IMD5', 'US0378331005'). Must be exactly 12 characters: 2 letters
|
|
3011
|
+
* followed by 9 alphanumeric characters and ending with a digit.
|
|
3012
|
+
*/
|
|
3013
|
+
isin: string;
|
|
3014
|
+
/**
|
|
3015
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
3016
|
+
*/
|
|
3017
|
+
force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
|
|
3018
|
+
/**
|
|
3019
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
3020
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
3021
|
+
* less comprehensive data.
|
|
3022
|
+
*/
|
|
3023
|
+
maxSpeed?: boolean;
|
|
3024
|
+
/**
|
|
3025
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
3026
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
3027
|
+
* value is 300000ms (5 minutes).
|
|
3028
|
+
*/
|
|
3029
|
+
timeoutMS?: number;
|
|
3030
|
+
}
|
|
3031
|
+
export interface BrandRetrieveByNameParams {
|
|
3032
|
+
/**
|
|
3033
|
+
* Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
|
|
3034
|
+
* Corporation'). Must be 3-30 characters.
|
|
3035
|
+
*/
|
|
3036
|
+
name: string;
|
|
3037
|
+
/**
|
|
3038
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
3039
|
+
*/
|
|
3040
|
+
force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
|
|
3041
|
+
/**
|
|
3042
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
3043
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
3044
|
+
* less comprehensive data.
|
|
3045
|
+
*/
|
|
3046
|
+
maxSpeed?: boolean;
|
|
3047
|
+
/**
|
|
3048
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
3049
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
3050
|
+
* value is 300000ms (5 minutes).
|
|
3051
|
+
*/
|
|
3052
|
+
timeoutMS?: number;
|
|
3053
|
+
}
|
|
3054
|
+
export interface BrandRetrieveByTickerParams {
|
|
3055
|
+
/**
|
|
3056
|
+
* Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
|
|
3057
|
+
* Must be 1-15 characters, letters/numbers/dots only.
|
|
3058
|
+
*/
|
|
3059
|
+
ticker: string;
|
|
3060
|
+
/**
|
|
3061
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
3062
|
+
*/
|
|
3063
|
+
force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
|
|
3064
|
+
/**
|
|
3065
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
3066
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
3067
|
+
* less comprehensive data.
|
|
3068
|
+
*/
|
|
3069
|
+
maxSpeed?: boolean;
|
|
3070
|
+
/**
|
|
3071
|
+
* Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
|
|
3072
|
+
*/
|
|
3073
|
+
ticker_exchange?: 'AMEX' | 'AMS' | 'AQS' | 'ASX' | 'ATH' | 'BER' | 'BME' | 'BRU' | 'BSE' | 'BUD' | 'BUE' | 'BVC' | 'CBOE' | 'CNQ' | 'CPH' | 'DFM' | 'DOH' | 'DUB' | 'DUS' | 'DXE' | 'EGX' | 'FSX' | 'HAM' | 'HEL' | 'HKSE' | 'HOSE' | 'ICE' | 'IOB' | 'IST' | 'JKT' | 'JNB' | 'JPX' | 'KLS' | 'KOE' | 'KSC' | 'KUW' | 'LIS' | 'LSE' | 'MCX' | 'MEX' | 'MIL' | 'MUN' | 'NASDAQ' | 'NEO' | 'NSE' | 'NYSE' | 'NZE' | 'OSL' | 'OTC' | 'PAR' | 'PNK' | 'PRA' | 'RIS' | 'SAO' | 'SAU' | 'SES' | 'SET' | 'SGO' | 'SHH' | 'SHZ' | 'SIX' | 'STO' | 'STU' | 'TAI' | 'TAL' | 'TLV' | 'TSX' | 'TSXV' | 'TWO' | 'VIE' | 'WSE' | 'XETRA';
|
|
3074
|
+
/**
|
|
3075
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
3076
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
3077
|
+
* value is 300000ms (5 minutes).
|
|
3078
|
+
*/
|
|
3079
|
+
timeoutMS?: number;
|
|
3080
|
+
}
|
|
3081
|
+
export interface BrandRetrieveNaicsParams {
|
|
3082
|
+
/**
|
|
3083
|
+
* Brand domain or title to retrieve NAICS code for. If a valid domain is provided
|
|
3084
|
+
* in `input`, it will be used for classification, otherwise, we will search for
|
|
3085
|
+
* the brand using the provided title.
|
|
3086
|
+
*/
|
|
3087
|
+
input: string;
|
|
3088
|
+
/**
|
|
3089
|
+
* Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
|
|
3090
|
+
* to 5.
|
|
3091
|
+
*/
|
|
3092
|
+
maxResults?: number;
|
|
3093
|
+
/**
|
|
3094
|
+
* Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
|
|
3095
|
+
*/
|
|
3096
|
+
minResults?: number;
|
|
3097
|
+
/**
|
|
3098
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
3099
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
3100
|
+
* value is 300000ms (5 minutes).
|
|
3101
|
+
*/
|
|
3102
|
+
timeoutMS?: number;
|
|
3103
|
+
}
|
|
3104
|
+
export interface BrandRetrieveSimplifiedParams {
|
|
3105
|
+
/**
|
|
3106
|
+
* Domain name to retrieve simplified brand data for
|
|
3107
|
+
*/
|
|
3108
|
+
domain: string;
|
|
3109
|
+
/**
|
|
3110
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
3111
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
3112
|
+
* value is 300000ms (5 minutes).
|
|
3113
|
+
*/
|
|
3114
|
+
timeoutMS?: number;
|
|
3115
|
+
}
|
|
3116
|
+
export interface BrandScreenshotParams {
|
|
3117
|
+
/**
|
|
3118
|
+
* Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
|
|
3119
|
+
* domain will be automatically normalized and validated.
|
|
3120
|
+
*/
|
|
3121
|
+
domain: string;
|
|
3122
|
+
/**
|
|
3123
|
+
* Optional parameter to determine screenshot type. If 'true', takes a full page
|
|
3124
|
+
* screenshot capturing all content. If 'false' or not provided, takes a viewport
|
|
3125
|
+
* screenshot (standard browser view).
|
|
3126
|
+
*/
|
|
3127
|
+
fullScreenshot?: 'true' | 'false';
|
|
3128
|
+
/**
|
|
3129
|
+
* Optional parameter to specify which page type to screenshot. If provided, the
|
|
3130
|
+
* system will scrape the domain's links and use heuristics to find the most
|
|
3131
|
+
* appropriate URL for the specified page type (30 supported languages). If not
|
|
3132
|
+
* provided, screenshots the main domain landing page.
|
|
3133
|
+
*/
|
|
3134
|
+
page?: 'login' | 'signup' | 'blog' | 'careers' | 'pricing' | 'terms' | 'privacy' | 'contact';
|
|
3135
|
+
/**
|
|
3136
|
+
* Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
|
|
3137
|
+
* faster capture with basic quality. If 'quality', optimizes for higher quality
|
|
3138
|
+
* with longer wait times. Defaults to 'quality' if not provided.
|
|
3139
|
+
*/
|
|
3140
|
+
prioritize?: 'speed' | 'quality';
|
|
3141
|
+
}
|
|
3142
|
+
export interface BrandStyleguideParams {
|
|
3143
|
+
/**
|
|
3144
|
+
* A specific URL to fetch the styleguide from directly, bypassing domain
|
|
3145
|
+
* resolution (e.g., 'https://example.com/design-system').
|
|
3146
|
+
*/
|
|
3147
|
+
directUrl?: string;
|
|
3148
|
+
/**
|
|
3149
|
+
* Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
|
|
3150
|
+
* domain will be automatically normalized and validated.
|
|
3151
|
+
*/
|
|
3152
|
+
domain?: string;
|
|
3153
|
+
/**
|
|
3154
|
+
* Optional parameter to prioritize screenshot capture for styleguide extraction.
|
|
3155
|
+
* If 'speed', optimizes for faster capture with basic quality. If 'quality',
|
|
3156
|
+
* optimizes for higher quality with longer wait times. Defaults to 'quality' if
|
|
3157
|
+
* not provided.
|
|
3158
|
+
*/
|
|
3159
|
+
prioritize?: 'speed' | 'quality';
|
|
3160
|
+
/**
|
|
3161
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
3162
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
3163
|
+
* value is 300000ms (5 minutes).
|
|
3164
|
+
*/
|
|
3165
|
+
timeoutMS?: number;
|
|
3166
|
+
}
|
|
3167
|
+
export interface BrandWebScrapeHTMLParams {
|
|
3168
|
+
/**
|
|
3169
|
+
* Full URL to scrape (must include http:// or https:// protocol)
|
|
3170
|
+
*/
|
|
3171
|
+
url: string;
|
|
3172
|
+
}
|
|
3173
|
+
export interface BrandWebScrapeImagesParams {
|
|
3174
|
+
/**
|
|
3175
|
+
* Full URL to scrape images from (must include http:// or https:// protocol)
|
|
3176
|
+
*/
|
|
3177
|
+
url: string;
|
|
3178
|
+
}
|
|
3179
|
+
export interface BrandWebScrapeMdParams {
|
|
3180
|
+
/**
|
|
3181
|
+
* Full URL to scrape and convert to markdown (must include http:// or https://
|
|
3182
|
+
* protocol)
|
|
3183
|
+
*/
|
|
3184
|
+
url: string;
|
|
3185
|
+
/**
|
|
3186
|
+
* Include image references in Markdown output
|
|
3187
|
+
*/
|
|
3188
|
+
includeImages?: boolean;
|
|
3189
|
+
/**
|
|
3190
|
+
* Preserve hyperlinks in Markdown output
|
|
3191
|
+
*/
|
|
3192
|
+
includeLinks?: boolean;
|
|
3193
|
+
/**
|
|
3194
|
+
* Shorten base64-encoded image data in the Markdown output
|
|
3195
|
+
*/
|
|
3196
|
+
shortenBase64Images?: boolean;
|
|
3197
|
+
}
|
|
3198
|
+
export interface BrandWebScrapeSitemapParams {
|
|
3199
|
+
/**
|
|
3200
|
+
* Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
|
|
3201
|
+
* automatically normalized and validated.
|
|
3202
|
+
*/
|
|
3203
|
+
domain: string;
|
|
3204
|
+
}
|
|
3205
|
+
export declare namespace Brand {
|
|
3206
|
+
export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIProductResponse as BrandAIProductResponse, type BrandAIProductsResponse as BrandAIProductsResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandFontsResponse as BrandFontsResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, type BrandPrefetchByEmailResponse as BrandPrefetchByEmailResponse, type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse, type BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse, type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse, type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse, type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse, type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse, type BrandScreenshotResponse as BrandScreenshotResponse, type BrandStyleguideResponse as BrandStyleguideResponse, type BrandWebScrapeHTMLResponse as BrandWebScrapeHTMLResponse, type BrandWebScrapeImagesResponse as BrandWebScrapeImagesResponse, type BrandWebScrapeMdResponse as BrandWebScrapeMdResponse, type BrandWebScrapeSitemapResponse as BrandWebScrapeSitemapResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandAIProductParams as BrandAIProductParams, type BrandAIProductsParams as BrandAIProductsParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandFontsParams as BrandFontsParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, type BrandPrefetchByEmailParams as BrandPrefetchByEmailParams, type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams, type BrandRetrieveByIsinParams as BrandRetrieveByIsinParams, type BrandRetrieveByNameParams as BrandRetrieveByNameParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, type BrandScreenshotParams as BrandScreenshotParams, type BrandStyleguideParams as BrandStyleguideParams, type BrandWebScrapeHTMLParams as BrandWebScrapeHTMLParams, type BrandWebScrapeImagesParams as BrandWebScrapeImagesParams, type BrandWebScrapeMdParams as BrandWebScrapeMdParams, type BrandWebScrapeSitemapParams as BrandWebScrapeSitemapParams, };
|
|
3207
|
+
}
|
|
3208
|
+
//# sourceMappingURL=brand.d.mts.map
|