brand.dev 0.9.1 → 0.11.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 +23 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/brand.d.mts +1045 -70
- package/resources/brand.d.mts.map +1 -1
- package/resources/brand.d.ts +1045 -70
- package/resources/brand.d.ts.map +1 -1
- package/resources/brand.js +25 -2
- package/resources/brand.js.map +1 -1
- package/resources/brand.mjs +25 -2
- package/resources/brand.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/src/client.ts +12 -0
- package/src/resources/brand.ts +2423 -298
- package/src/resources/index.ts +6 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
package/resources/brand.d.mts
CHANGED
|
@@ -3,8 +3,8 @@ import { APIPromise } from "../core/api-promise.mjs";
|
|
|
3
3
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
4
|
export declare class Brand extends APIResource {
|
|
5
5
|
/**
|
|
6
|
-
* Retrieve
|
|
7
|
-
*
|
|
6
|
+
* Retrieve logos, backdrops, colors, industry, description, and more from any
|
|
7
|
+
* domain
|
|
8
8
|
*/
|
|
9
9
|
retrieve(query?: BrandRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BrandRetrieveResponse>;
|
|
10
10
|
/**
|
|
@@ -25,6 +25,23 @@ export declare class Brand extends APIResource {
|
|
|
25
25
|
* endpoint]
|
|
26
26
|
*/
|
|
27
27
|
prefetch(body: BrandPrefetchParams, options?: RequestOptions): APIPromise<BrandPrefetchResponse>;
|
|
28
|
+
/**
|
|
29
|
+
* Retrieve brand information using an email address while detecting disposable and
|
|
30
|
+
* free email addresses. This endpoint extracts the domain from the email address
|
|
31
|
+
* and returns brand data for that domain. Disposable and free email addresses
|
|
32
|
+
* (like gmail.com, yahoo.com) will throw a 422 error.
|
|
33
|
+
*/
|
|
34
|
+
retrieveByEmail(query: BrandRetrieveByEmailParams, options?: RequestOptions): APIPromise<BrandRetrieveByEmailResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* Retrieve brand information using a company name. This endpoint searches for the
|
|
37
|
+
* company by name and returns its brand data.
|
|
38
|
+
*/
|
|
39
|
+
retrieveByName(query: BrandRetrieveByNameParams, options?: RequestOptions): APIPromise<BrandRetrieveByNameResponse>;
|
|
40
|
+
/**
|
|
41
|
+
* Retrieve brand information using a stock ticker symbol. This endpoint looks up
|
|
42
|
+
* the company associated with the ticker and returns its brand data.
|
|
43
|
+
*/
|
|
44
|
+
retrieveByTicker(query: BrandRetrieveByTickerParams, options?: RequestOptions): APIPromise<BrandRetrieveByTickerResponse>;
|
|
28
45
|
/**
|
|
29
46
|
* Endpoint to classify any brand into a 2022 NAICS code.
|
|
30
47
|
*/
|
|
@@ -49,11 +66,946 @@ export declare class Brand extends APIResource {
|
|
|
49
66
|
*/
|
|
50
67
|
styleguide(query: BrandStyleguideParams, options?: RequestOptions): APIPromise<BrandStyleguideResponse>;
|
|
51
68
|
}
|
|
52
|
-
export interface BrandRetrieveResponse {
|
|
69
|
+
export interface BrandRetrieveResponse {
|
|
70
|
+
/**
|
|
71
|
+
* Detailed brand information
|
|
72
|
+
*/
|
|
73
|
+
brand?: BrandRetrieveResponse.Brand;
|
|
74
|
+
/**
|
|
75
|
+
* HTTP status code
|
|
76
|
+
*/
|
|
77
|
+
code?: number;
|
|
78
|
+
/**
|
|
79
|
+
* Status of the response, e.g., 'ok'
|
|
80
|
+
*/
|
|
81
|
+
status?: string;
|
|
82
|
+
}
|
|
83
|
+
export declare namespace BrandRetrieveResponse {
|
|
84
|
+
/**
|
|
85
|
+
* Detailed brand information
|
|
86
|
+
*/
|
|
87
|
+
interface Brand {
|
|
88
|
+
/**
|
|
89
|
+
* Physical address of the brand
|
|
90
|
+
*/
|
|
91
|
+
address?: Brand.Address;
|
|
92
|
+
/**
|
|
93
|
+
* An array of backdrop images for the brand
|
|
94
|
+
*/
|
|
95
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
96
|
+
/**
|
|
97
|
+
* An array of brand colors
|
|
98
|
+
*/
|
|
99
|
+
colors?: Array<Brand.Color>;
|
|
100
|
+
/**
|
|
101
|
+
* A brief description of the brand
|
|
102
|
+
*/
|
|
103
|
+
description?: string;
|
|
104
|
+
/**
|
|
105
|
+
* The domain name of the brand
|
|
106
|
+
*/
|
|
107
|
+
domain?: string;
|
|
108
|
+
/**
|
|
109
|
+
* Company email address
|
|
110
|
+
*/
|
|
111
|
+
email?: string;
|
|
112
|
+
/**
|
|
113
|
+
* Industry classification information for the brand
|
|
114
|
+
*/
|
|
115
|
+
industries?: Brand.Industries;
|
|
116
|
+
/**
|
|
117
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
118
|
+
*/
|
|
119
|
+
is_nsfw?: boolean;
|
|
120
|
+
/**
|
|
121
|
+
* Important website links for the brand
|
|
122
|
+
*/
|
|
123
|
+
links?: Brand.Links;
|
|
124
|
+
/**
|
|
125
|
+
* An array of logos associated with the brand
|
|
126
|
+
*/
|
|
127
|
+
logos?: Array<Brand.Logo>;
|
|
128
|
+
/**
|
|
129
|
+
* Company phone number
|
|
130
|
+
*/
|
|
131
|
+
phone?: string;
|
|
132
|
+
/**
|
|
133
|
+
* The brand's slogan
|
|
134
|
+
*/
|
|
135
|
+
slogan?: string;
|
|
136
|
+
/**
|
|
137
|
+
* An array of social media links for the brand
|
|
138
|
+
*/
|
|
139
|
+
socials?: Array<Brand.Social>;
|
|
140
|
+
/**
|
|
141
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
142
|
+
* company)
|
|
143
|
+
*/
|
|
144
|
+
stock?: Brand.Stock;
|
|
145
|
+
/**
|
|
146
|
+
* The title or name of the brand
|
|
147
|
+
*/
|
|
148
|
+
title?: string;
|
|
149
|
+
}
|
|
150
|
+
namespace Brand {
|
|
151
|
+
/**
|
|
152
|
+
* Physical address of the brand
|
|
153
|
+
*/
|
|
154
|
+
interface Address {
|
|
155
|
+
/**
|
|
156
|
+
* City name
|
|
157
|
+
*/
|
|
158
|
+
city?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Country name
|
|
161
|
+
*/
|
|
162
|
+
country?: string;
|
|
163
|
+
/**
|
|
164
|
+
* Country code
|
|
165
|
+
*/
|
|
166
|
+
country_code?: string;
|
|
167
|
+
/**
|
|
168
|
+
* Postal or ZIP code
|
|
169
|
+
*/
|
|
170
|
+
postal_code?: string;
|
|
171
|
+
/**
|
|
172
|
+
* State or province code
|
|
173
|
+
*/
|
|
174
|
+
state_code?: string;
|
|
175
|
+
/**
|
|
176
|
+
* State or province name
|
|
177
|
+
*/
|
|
178
|
+
state_province?: string;
|
|
179
|
+
/**
|
|
180
|
+
* Street address
|
|
181
|
+
*/
|
|
182
|
+
street?: string;
|
|
183
|
+
}
|
|
184
|
+
interface Backdrop {
|
|
185
|
+
/**
|
|
186
|
+
* Array of colors in the backdrop image
|
|
187
|
+
*/
|
|
188
|
+
colors?: Array<Backdrop.Color>;
|
|
189
|
+
/**
|
|
190
|
+
* Resolution of the backdrop image
|
|
191
|
+
*/
|
|
192
|
+
resolution?: Backdrop.Resolution;
|
|
193
|
+
/**
|
|
194
|
+
* URL of the backdrop image
|
|
195
|
+
*/
|
|
196
|
+
url?: string;
|
|
197
|
+
}
|
|
198
|
+
namespace Backdrop {
|
|
199
|
+
interface Color {
|
|
200
|
+
/**
|
|
201
|
+
* Color in hexadecimal format
|
|
202
|
+
*/
|
|
203
|
+
hex?: string;
|
|
204
|
+
/**
|
|
205
|
+
* Name of the color
|
|
206
|
+
*/
|
|
207
|
+
name?: string;
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Resolution of the backdrop image
|
|
211
|
+
*/
|
|
212
|
+
interface Resolution {
|
|
213
|
+
/**
|
|
214
|
+
* Aspect ratio of the image (width/height)
|
|
215
|
+
*/
|
|
216
|
+
aspect_ratio?: number;
|
|
217
|
+
/**
|
|
218
|
+
* Height of the image in pixels
|
|
219
|
+
*/
|
|
220
|
+
height?: number;
|
|
221
|
+
/**
|
|
222
|
+
* Width of the image in pixels
|
|
223
|
+
*/
|
|
224
|
+
width?: number;
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
interface Color {
|
|
228
|
+
/**
|
|
229
|
+
* Color in hexadecimal format
|
|
230
|
+
*/
|
|
231
|
+
hex?: string;
|
|
232
|
+
/**
|
|
233
|
+
* Name of the color
|
|
234
|
+
*/
|
|
235
|
+
name?: string;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* Industry classification information for the brand
|
|
239
|
+
*/
|
|
240
|
+
interface Industries {
|
|
241
|
+
/**
|
|
242
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
243
|
+
*/
|
|
244
|
+
eic?: Array<Industries.Eic>;
|
|
245
|
+
}
|
|
246
|
+
namespace Industries {
|
|
247
|
+
interface Eic {
|
|
248
|
+
/**
|
|
249
|
+
* Industry classification enum
|
|
250
|
+
*/
|
|
251
|
+
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)';
|
|
252
|
+
/**
|
|
253
|
+
* Subindustry classification enum
|
|
254
|
+
*/
|
|
255
|
+
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';
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Important website links for the brand
|
|
260
|
+
*/
|
|
261
|
+
interface Links {
|
|
262
|
+
/**
|
|
263
|
+
* URL to the brand's blog or news page
|
|
264
|
+
*/
|
|
265
|
+
blog?: string | null;
|
|
266
|
+
/**
|
|
267
|
+
* URL to the brand's careers or job opportunities page
|
|
268
|
+
*/
|
|
269
|
+
careers?: string | null;
|
|
270
|
+
/**
|
|
271
|
+
* URL to the brand's contact or contact us page
|
|
272
|
+
*/
|
|
273
|
+
contact?: string | null;
|
|
274
|
+
/**
|
|
275
|
+
* URL to the brand's pricing or plans page
|
|
276
|
+
*/
|
|
277
|
+
pricing?: string | null;
|
|
278
|
+
/**
|
|
279
|
+
* URL to the brand's privacy policy page
|
|
280
|
+
*/
|
|
281
|
+
privacy?: string | null;
|
|
282
|
+
/**
|
|
283
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
284
|
+
*/
|
|
285
|
+
terms?: string | null;
|
|
286
|
+
}
|
|
287
|
+
interface Logo {
|
|
288
|
+
/**
|
|
289
|
+
* Array of colors in the logo
|
|
290
|
+
*/
|
|
291
|
+
colors?: Array<Logo.Color>;
|
|
292
|
+
/**
|
|
293
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
294
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
295
|
+
* has its own background
|
|
296
|
+
*/
|
|
297
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
298
|
+
/**
|
|
299
|
+
* Resolution of the logo image
|
|
300
|
+
*/
|
|
301
|
+
resolution?: Logo.Resolution;
|
|
302
|
+
/**
|
|
303
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
304
|
+
*/
|
|
305
|
+
type?: 'icon' | 'logo';
|
|
306
|
+
/**
|
|
307
|
+
* CDN hosted url of the logo (ready for display)
|
|
308
|
+
*/
|
|
309
|
+
url?: string;
|
|
310
|
+
}
|
|
311
|
+
namespace Logo {
|
|
312
|
+
interface Color {
|
|
313
|
+
/**
|
|
314
|
+
* Color in hexadecimal format
|
|
315
|
+
*/
|
|
316
|
+
hex?: string;
|
|
317
|
+
/**
|
|
318
|
+
* Name of the color
|
|
319
|
+
*/
|
|
320
|
+
name?: string;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Resolution of the logo image
|
|
324
|
+
*/
|
|
325
|
+
interface Resolution {
|
|
326
|
+
/**
|
|
327
|
+
* Aspect ratio of the image (width/height)
|
|
328
|
+
*/
|
|
329
|
+
aspect_ratio?: number;
|
|
330
|
+
/**
|
|
331
|
+
* Height of the image in pixels
|
|
332
|
+
*/
|
|
333
|
+
height?: number;
|
|
334
|
+
/**
|
|
335
|
+
* Width of the image in pixels
|
|
336
|
+
*/
|
|
337
|
+
width?: number;
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
interface Social {
|
|
341
|
+
/**
|
|
342
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
343
|
+
*/
|
|
344
|
+
type?: string;
|
|
345
|
+
/**
|
|
346
|
+
* URL of the social media page
|
|
347
|
+
*/
|
|
348
|
+
url?: string;
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
352
|
+
* company)
|
|
353
|
+
*/
|
|
354
|
+
interface Stock {
|
|
355
|
+
/**
|
|
356
|
+
* Stock exchange name
|
|
357
|
+
*/
|
|
358
|
+
exchange?: string;
|
|
359
|
+
/**
|
|
360
|
+
* Stock ticker symbol
|
|
361
|
+
*/
|
|
362
|
+
ticker?: string;
|
|
363
|
+
}
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
export interface BrandAIQueryResponse {
|
|
367
|
+
/**
|
|
368
|
+
* Array of extracted data points
|
|
369
|
+
*/
|
|
370
|
+
data_extracted?: Array<BrandAIQueryResponse.DataExtracted>;
|
|
371
|
+
/**
|
|
372
|
+
* The domain that was analyzed
|
|
373
|
+
*/
|
|
374
|
+
domain?: string;
|
|
375
|
+
/**
|
|
376
|
+
* Status of the response, e.g., 'ok'
|
|
377
|
+
*/
|
|
378
|
+
status?: string;
|
|
379
|
+
/**
|
|
380
|
+
* List of URLs that were analyzed
|
|
381
|
+
*/
|
|
382
|
+
urls_analyzed?: Array<string>;
|
|
383
|
+
}
|
|
384
|
+
export declare namespace BrandAIQueryResponse {
|
|
385
|
+
interface DataExtracted {
|
|
386
|
+
/**
|
|
387
|
+
* Name of the extracted data point
|
|
388
|
+
*/
|
|
389
|
+
datapoint_name?: string;
|
|
390
|
+
/**
|
|
391
|
+
* Value of the extracted data point
|
|
392
|
+
*/
|
|
393
|
+
datapoint_value?: string | number | boolean | Array<string> | Array<number>;
|
|
394
|
+
}
|
|
395
|
+
}
|
|
396
|
+
export interface BrandIdentifyFromTransactionResponse {
|
|
397
|
+
/**
|
|
398
|
+
* Detailed brand information
|
|
399
|
+
*/
|
|
400
|
+
brand?: BrandIdentifyFromTransactionResponse.Brand;
|
|
401
|
+
/**
|
|
402
|
+
* HTTP status code
|
|
403
|
+
*/
|
|
404
|
+
code?: number;
|
|
405
|
+
/**
|
|
406
|
+
* Status of the response, e.g., 'ok'
|
|
407
|
+
*/
|
|
408
|
+
status?: string;
|
|
409
|
+
}
|
|
410
|
+
export declare namespace BrandIdentifyFromTransactionResponse {
|
|
411
|
+
/**
|
|
412
|
+
* Detailed brand information
|
|
413
|
+
*/
|
|
414
|
+
interface Brand {
|
|
415
|
+
/**
|
|
416
|
+
* Physical address of the brand
|
|
417
|
+
*/
|
|
418
|
+
address?: Brand.Address;
|
|
419
|
+
/**
|
|
420
|
+
* An array of backdrop images for the brand
|
|
421
|
+
*/
|
|
422
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
423
|
+
/**
|
|
424
|
+
* An array of brand colors
|
|
425
|
+
*/
|
|
426
|
+
colors?: Array<Brand.Color>;
|
|
427
|
+
/**
|
|
428
|
+
* A brief description of the brand
|
|
429
|
+
*/
|
|
430
|
+
description?: string;
|
|
431
|
+
/**
|
|
432
|
+
* The domain name of the brand
|
|
433
|
+
*/
|
|
434
|
+
domain?: string;
|
|
435
|
+
/**
|
|
436
|
+
* Company email address
|
|
437
|
+
*/
|
|
438
|
+
email?: string;
|
|
439
|
+
/**
|
|
440
|
+
* Industry classification information for the brand
|
|
441
|
+
*/
|
|
442
|
+
industries?: Brand.Industries;
|
|
443
|
+
/**
|
|
444
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
445
|
+
*/
|
|
446
|
+
is_nsfw?: boolean;
|
|
447
|
+
/**
|
|
448
|
+
* Important website links for the brand
|
|
449
|
+
*/
|
|
450
|
+
links?: Brand.Links;
|
|
451
|
+
/**
|
|
452
|
+
* An array of logos associated with the brand
|
|
453
|
+
*/
|
|
454
|
+
logos?: Array<Brand.Logo>;
|
|
455
|
+
/**
|
|
456
|
+
* Company phone number
|
|
457
|
+
*/
|
|
458
|
+
phone?: string;
|
|
459
|
+
/**
|
|
460
|
+
* The brand's slogan
|
|
461
|
+
*/
|
|
462
|
+
slogan?: string;
|
|
463
|
+
/**
|
|
464
|
+
* An array of social media links for the brand
|
|
465
|
+
*/
|
|
466
|
+
socials?: Array<Brand.Social>;
|
|
467
|
+
/**
|
|
468
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
469
|
+
* company)
|
|
470
|
+
*/
|
|
471
|
+
stock?: Brand.Stock;
|
|
472
|
+
/**
|
|
473
|
+
* The title or name of the brand
|
|
474
|
+
*/
|
|
475
|
+
title?: string;
|
|
476
|
+
}
|
|
477
|
+
namespace Brand {
|
|
478
|
+
/**
|
|
479
|
+
* Physical address of the brand
|
|
480
|
+
*/
|
|
481
|
+
interface Address {
|
|
482
|
+
/**
|
|
483
|
+
* City name
|
|
484
|
+
*/
|
|
485
|
+
city?: string;
|
|
486
|
+
/**
|
|
487
|
+
* Country name
|
|
488
|
+
*/
|
|
489
|
+
country?: string;
|
|
490
|
+
/**
|
|
491
|
+
* Country code
|
|
492
|
+
*/
|
|
493
|
+
country_code?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Postal or ZIP code
|
|
496
|
+
*/
|
|
497
|
+
postal_code?: string;
|
|
498
|
+
/**
|
|
499
|
+
* State or province code
|
|
500
|
+
*/
|
|
501
|
+
state_code?: string;
|
|
502
|
+
/**
|
|
503
|
+
* State or province name
|
|
504
|
+
*/
|
|
505
|
+
state_province?: string;
|
|
506
|
+
/**
|
|
507
|
+
* Street address
|
|
508
|
+
*/
|
|
509
|
+
street?: string;
|
|
510
|
+
}
|
|
511
|
+
interface Backdrop {
|
|
512
|
+
/**
|
|
513
|
+
* Array of colors in the backdrop image
|
|
514
|
+
*/
|
|
515
|
+
colors?: Array<Backdrop.Color>;
|
|
516
|
+
/**
|
|
517
|
+
* Resolution of the backdrop image
|
|
518
|
+
*/
|
|
519
|
+
resolution?: Backdrop.Resolution;
|
|
520
|
+
/**
|
|
521
|
+
* URL of the backdrop image
|
|
522
|
+
*/
|
|
523
|
+
url?: string;
|
|
524
|
+
}
|
|
525
|
+
namespace Backdrop {
|
|
526
|
+
interface Color {
|
|
527
|
+
/**
|
|
528
|
+
* Color in hexadecimal format
|
|
529
|
+
*/
|
|
530
|
+
hex?: string;
|
|
531
|
+
/**
|
|
532
|
+
* Name of the color
|
|
533
|
+
*/
|
|
534
|
+
name?: string;
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* Resolution of the backdrop image
|
|
538
|
+
*/
|
|
539
|
+
interface Resolution {
|
|
540
|
+
/**
|
|
541
|
+
* Aspect ratio of the image (width/height)
|
|
542
|
+
*/
|
|
543
|
+
aspect_ratio?: number;
|
|
544
|
+
/**
|
|
545
|
+
* Height of the image in pixels
|
|
546
|
+
*/
|
|
547
|
+
height?: number;
|
|
548
|
+
/**
|
|
549
|
+
* Width of the image in pixels
|
|
550
|
+
*/
|
|
551
|
+
width?: number;
|
|
552
|
+
}
|
|
553
|
+
}
|
|
554
|
+
interface Color {
|
|
555
|
+
/**
|
|
556
|
+
* Color in hexadecimal format
|
|
557
|
+
*/
|
|
558
|
+
hex?: string;
|
|
559
|
+
/**
|
|
560
|
+
* Name of the color
|
|
561
|
+
*/
|
|
562
|
+
name?: string;
|
|
563
|
+
}
|
|
564
|
+
/**
|
|
565
|
+
* Industry classification information for the brand
|
|
566
|
+
*/
|
|
567
|
+
interface Industries {
|
|
568
|
+
/**
|
|
569
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
570
|
+
*/
|
|
571
|
+
eic?: Array<Industries.Eic>;
|
|
572
|
+
}
|
|
573
|
+
namespace Industries {
|
|
574
|
+
interface Eic {
|
|
575
|
+
/**
|
|
576
|
+
* Industry classification enum
|
|
577
|
+
*/
|
|
578
|
+
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)';
|
|
579
|
+
/**
|
|
580
|
+
* Subindustry classification enum
|
|
581
|
+
*/
|
|
582
|
+
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';
|
|
583
|
+
}
|
|
584
|
+
}
|
|
585
|
+
/**
|
|
586
|
+
* Important website links for the brand
|
|
587
|
+
*/
|
|
588
|
+
interface Links {
|
|
589
|
+
/**
|
|
590
|
+
* URL to the brand's blog or news page
|
|
591
|
+
*/
|
|
592
|
+
blog?: string | null;
|
|
593
|
+
/**
|
|
594
|
+
* URL to the brand's careers or job opportunities page
|
|
595
|
+
*/
|
|
596
|
+
careers?: string | null;
|
|
597
|
+
/**
|
|
598
|
+
* URL to the brand's contact or contact us page
|
|
599
|
+
*/
|
|
600
|
+
contact?: string | null;
|
|
601
|
+
/**
|
|
602
|
+
* URL to the brand's pricing or plans page
|
|
603
|
+
*/
|
|
604
|
+
pricing?: string | null;
|
|
605
|
+
/**
|
|
606
|
+
* URL to the brand's privacy policy page
|
|
607
|
+
*/
|
|
608
|
+
privacy?: string | null;
|
|
609
|
+
/**
|
|
610
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
611
|
+
*/
|
|
612
|
+
terms?: string | null;
|
|
613
|
+
}
|
|
614
|
+
interface Logo {
|
|
615
|
+
/**
|
|
616
|
+
* Array of colors in the logo
|
|
617
|
+
*/
|
|
618
|
+
colors?: Array<Logo.Color>;
|
|
619
|
+
/**
|
|
620
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
621
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
622
|
+
* has its own background
|
|
623
|
+
*/
|
|
624
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
625
|
+
/**
|
|
626
|
+
* Resolution of the logo image
|
|
627
|
+
*/
|
|
628
|
+
resolution?: Logo.Resolution;
|
|
629
|
+
/**
|
|
630
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
631
|
+
*/
|
|
632
|
+
type?: 'icon' | 'logo';
|
|
633
|
+
/**
|
|
634
|
+
* CDN hosted url of the logo (ready for display)
|
|
635
|
+
*/
|
|
636
|
+
url?: string;
|
|
637
|
+
}
|
|
638
|
+
namespace Logo {
|
|
639
|
+
interface Color {
|
|
640
|
+
/**
|
|
641
|
+
* Color in hexadecimal format
|
|
642
|
+
*/
|
|
643
|
+
hex?: string;
|
|
644
|
+
/**
|
|
645
|
+
* Name of the color
|
|
646
|
+
*/
|
|
647
|
+
name?: string;
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* Resolution of the logo image
|
|
651
|
+
*/
|
|
652
|
+
interface Resolution {
|
|
653
|
+
/**
|
|
654
|
+
* Aspect ratio of the image (width/height)
|
|
655
|
+
*/
|
|
656
|
+
aspect_ratio?: number;
|
|
657
|
+
/**
|
|
658
|
+
* Height of the image in pixels
|
|
659
|
+
*/
|
|
660
|
+
height?: number;
|
|
661
|
+
/**
|
|
662
|
+
* Width of the image in pixels
|
|
663
|
+
*/
|
|
664
|
+
width?: number;
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
interface Social {
|
|
668
|
+
/**
|
|
669
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
670
|
+
*/
|
|
671
|
+
type?: string;
|
|
672
|
+
/**
|
|
673
|
+
* URL of the social media page
|
|
674
|
+
*/
|
|
675
|
+
url?: string;
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
679
|
+
* company)
|
|
680
|
+
*/
|
|
681
|
+
interface Stock {
|
|
682
|
+
/**
|
|
683
|
+
* Stock exchange name
|
|
684
|
+
*/
|
|
685
|
+
exchange?: string;
|
|
686
|
+
/**
|
|
687
|
+
* Stock ticker symbol
|
|
688
|
+
*/
|
|
689
|
+
ticker?: string;
|
|
690
|
+
}
|
|
691
|
+
}
|
|
692
|
+
}
|
|
693
|
+
export interface BrandPrefetchResponse {
|
|
694
|
+
/**
|
|
695
|
+
* The domain that was queued for prefetching
|
|
696
|
+
*/
|
|
697
|
+
domain?: string;
|
|
698
|
+
/**
|
|
699
|
+
* Success message
|
|
700
|
+
*/
|
|
701
|
+
message?: string;
|
|
702
|
+
/**
|
|
703
|
+
* Status of the response, e.g., 'ok'
|
|
704
|
+
*/
|
|
705
|
+
status?: string;
|
|
706
|
+
}
|
|
707
|
+
export interface BrandRetrieveByEmailResponse {
|
|
708
|
+
/**
|
|
709
|
+
* Detailed brand information
|
|
710
|
+
*/
|
|
711
|
+
brand?: BrandRetrieveByEmailResponse.Brand;
|
|
712
|
+
/**
|
|
713
|
+
* HTTP status code
|
|
714
|
+
*/
|
|
715
|
+
code?: number;
|
|
716
|
+
/**
|
|
717
|
+
* Status of the response, e.g., 'ok'
|
|
718
|
+
*/
|
|
719
|
+
status?: string;
|
|
720
|
+
}
|
|
721
|
+
export declare namespace BrandRetrieveByEmailResponse {
|
|
722
|
+
/**
|
|
723
|
+
* Detailed brand information
|
|
724
|
+
*/
|
|
725
|
+
interface Brand {
|
|
726
|
+
/**
|
|
727
|
+
* Physical address of the brand
|
|
728
|
+
*/
|
|
729
|
+
address?: Brand.Address;
|
|
730
|
+
/**
|
|
731
|
+
* An array of backdrop images for the brand
|
|
732
|
+
*/
|
|
733
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
734
|
+
/**
|
|
735
|
+
* An array of brand colors
|
|
736
|
+
*/
|
|
737
|
+
colors?: Array<Brand.Color>;
|
|
738
|
+
/**
|
|
739
|
+
* A brief description of the brand
|
|
740
|
+
*/
|
|
741
|
+
description?: string;
|
|
742
|
+
/**
|
|
743
|
+
* The domain name of the brand
|
|
744
|
+
*/
|
|
745
|
+
domain?: string;
|
|
746
|
+
/**
|
|
747
|
+
* Company email address
|
|
748
|
+
*/
|
|
749
|
+
email?: string;
|
|
750
|
+
/**
|
|
751
|
+
* Industry classification information for the brand
|
|
752
|
+
*/
|
|
753
|
+
industries?: Brand.Industries;
|
|
754
|
+
/**
|
|
755
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
756
|
+
*/
|
|
757
|
+
is_nsfw?: boolean;
|
|
758
|
+
/**
|
|
759
|
+
* Important website links for the brand
|
|
760
|
+
*/
|
|
761
|
+
links?: Brand.Links;
|
|
762
|
+
/**
|
|
763
|
+
* An array of logos associated with the brand
|
|
764
|
+
*/
|
|
765
|
+
logos?: Array<Brand.Logo>;
|
|
766
|
+
/**
|
|
767
|
+
* Company phone number
|
|
768
|
+
*/
|
|
769
|
+
phone?: string;
|
|
770
|
+
/**
|
|
771
|
+
* The brand's slogan
|
|
772
|
+
*/
|
|
773
|
+
slogan?: string;
|
|
774
|
+
/**
|
|
775
|
+
* An array of social media links for the brand
|
|
776
|
+
*/
|
|
777
|
+
socials?: Array<Brand.Social>;
|
|
778
|
+
/**
|
|
779
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
780
|
+
* company)
|
|
781
|
+
*/
|
|
782
|
+
stock?: Brand.Stock;
|
|
783
|
+
/**
|
|
784
|
+
* The title or name of the brand
|
|
785
|
+
*/
|
|
786
|
+
title?: string;
|
|
787
|
+
}
|
|
788
|
+
namespace Brand {
|
|
789
|
+
/**
|
|
790
|
+
* Physical address of the brand
|
|
791
|
+
*/
|
|
792
|
+
interface Address {
|
|
793
|
+
/**
|
|
794
|
+
* City name
|
|
795
|
+
*/
|
|
796
|
+
city?: string;
|
|
797
|
+
/**
|
|
798
|
+
* Country name
|
|
799
|
+
*/
|
|
800
|
+
country?: string;
|
|
801
|
+
/**
|
|
802
|
+
* Country code
|
|
803
|
+
*/
|
|
804
|
+
country_code?: string;
|
|
805
|
+
/**
|
|
806
|
+
* Postal or ZIP code
|
|
807
|
+
*/
|
|
808
|
+
postal_code?: string;
|
|
809
|
+
/**
|
|
810
|
+
* State or province code
|
|
811
|
+
*/
|
|
812
|
+
state_code?: string;
|
|
813
|
+
/**
|
|
814
|
+
* State or province name
|
|
815
|
+
*/
|
|
816
|
+
state_province?: string;
|
|
817
|
+
/**
|
|
818
|
+
* Street address
|
|
819
|
+
*/
|
|
820
|
+
street?: string;
|
|
821
|
+
}
|
|
822
|
+
interface Backdrop {
|
|
823
|
+
/**
|
|
824
|
+
* Array of colors in the backdrop image
|
|
825
|
+
*/
|
|
826
|
+
colors?: Array<Backdrop.Color>;
|
|
827
|
+
/**
|
|
828
|
+
* Resolution of the backdrop image
|
|
829
|
+
*/
|
|
830
|
+
resolution?: Backdrop.Resolution;
|
|
831
|
+
/**
|
|
832
|
+
* URL of the backdrop image
|
|
833
|
+
*/
|
|
834
|
+
url?: string;
|
|
835
|
+
}
|
|
836
|
+
namespace Backdrop {
|
|
837
|
+
interface Color {
|
|
838
|
+
/**
|
|
839
|
+
* Color in hexadecimal format
|
|
840
|
+
*/
|
|
841
|
+
hex?: string;
|
|
842
|
+
/**
|
|
843
|
+
* Name of the color
|
|
844
|
+
*/
|
|
845
|
+
name?: string;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Resolution of the backdrop image
|
|
849
|
+
*/
|
|
850
|
+
interface Resolution {
|
|
851
|
+
/**
|
|
852
|
+
* Aspect ratio of the image (width/height)
|
|
853
|
+
*/
|
|
854
|
+
aspect_ratio?: number;
|
|
855
|
+
/**
|
|
856
|
+
* Height of the image in pixels
|
|
857
|
+
*/
|
|
858
|
+
height?: number;
|
|
859
|
+
/**
|
|
860
|
+
* Width of the image in pixels
|
|
861
|
+
*/
|
|
862
|
+
width?: number;
|
|
863
|
+
}
|
|
864
|
+
}
|
|
865
|
+
interface Color {
|
|
866
|
+
/**
|
|
867
|
+
* Color in hexadecimal format
|
|
868
|
+
*/
|
|
869
|
+
hex?: string;
|
|
870
|
+
/**
|
|
871
|
+
* Name of the color
|
|
872
|
+
*/
|
|
873
|
+
name?: string;
|
|
874
|
+
}
|
|
875
|
+
/**
|
|
876
|
+
* Industry classification information for the brand
|
|
877
|
+
*/
|
|
878
|
+
interface Industries {
|
|
879
|
+
/**
|
|
880
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
881
|
+
*/
|
|
882
|
+
eic?: Array<Industries.Eic>;
|
|
883
|
+
}
|
|
884
|
+
namespace Industries {
|
|
885
|
+
interface Eic {
|
|
886
|
+
/**
|
|
887
|
+
* Industry classification enum
|
|
888
|
+
*/
|
|
889
|
+
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)';
|
|
890
|
+
/**
|
|
891
|
+
* Subindustry classification enum
|
|
892
|
+
*/
|
|
893
|
+
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';
|
|
894
|
+
}
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* Important website links for the brand
|
|
898
|
+
*/
|
|
899
|
+
interface Links {
|
|
900
|
+
/**
|
|
901
|
+
* URL to the brand's blog or news page
|
|
902
|
+
*/
|
|
903
|
+
blog?: string | null;
|
|
904
|
+
/**
|
|
905
|
+
* URL to the brand's careers or job opportunities page
|
|
906
|
+
*/
|
|
907
|
+
careers?: string | null;
|
|
908
|
+
/**
|
|
909
|
+
* URL to the brand's contact or contact us page
|
|
910
|
+
*/
|
|
911
|
+
contact?: string | null;
|
|
912
|
+
/**
|
|
913
|
+
* URL to the brand's pricing or plans page
|
|
914
|
+
*/
|
|
915
|
+
pricing?: string | null;
|
|
916
|
+
/**
|
|
917
|
+
* URL to the brand's privacy policy page
|
|
918
|
+
*/
|
|
919
|
+
privacy?: string | null;
|
|
920
|
+
/**
|
|
921
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
922
|
+
*/
|
|
923
|
+
terms?: string | null;
|
|
924
|
+
}
|
|
925
|
+
interface Logo {
|
|
926
|
+
/**
|
|
927
|
+
* Array of colors in the logo
|
|
928
|
+
*/
|
|
929
|
+
colors?: Array<Logo.Color>;
|
|
930
|
+
/**
|
|
931
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
932
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
933
|
+
* has its own background
|
|
934
|
+
*/
|
|
935
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
936
|
+
/**
|
|
937
|
+
* Resolution of the logo image
|
|
938
|
+
*/
|
|
939
|
+
resolution?: Logo.Resolution;
|
|
940
|
+
/**
|
|
941
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
942
|
+
*/
|
|
943
|
+
type?: 'icon' | 'logo';
|
|
944
|
+
/**
|
|
945
|
+
* CDN hosted url of the logo (ready for display)
|
|
946
|
+
*/
|
|
947
|
+
url?: string;
|
|
948
|
+
}
|
|
949
|
+
namespace Logo {
|
|
950
|
+
interface Color {
|
|
951
|
+
/**
|
|
952
|
+
* Color in hexadecimal format
|
|
953
|
+
*/
|
|
954
|
+
hex?: string;
|
|
955
|
+
/**
|
|
956
|
+
* Name of the color
|
|
957
|
+
*/
|
|
958
|
+
name?: string;
|
|
959
|
+
}
|
|
960
|
+
/**
|
|
961
|
+
* Resolution of the logo image
|
|
962
|
+
*/
|
|
963
|
+
interface Resolution {
|
|
964
|
+
/**
|
|
965
|
+
* Aspect ratio of the image (width/height)
|
|
966
|
+
*/
|
|
967
|
+
aspect_ratio?: number;
|
|
968
|
+
/**
|
|
969
|
+
* Height of the image in pixels
|
|
970
|
+
*/
|
|
971
|
+
height?: number;
|
|
972
|
+
/**
|
|
973
|
+
* Width of the image in pixels
|
|
974
|
+
*/
|
|
975
|
+
width?: number;
|
|
976
|
+
}
|
|
977
|
+
}
|
|
978
|
+
interface Social {
|
|
979
|
+
/**
|
|
980
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
981
|
+
*/
|
|
982
|
+
type?: string;
|
|
983
|
+
/**
|
|
984
|
+
* URL of the social media page
|
|
985
|
+
*/
|
|
986
|
+
url?: string;
|
|
987
|
+
}
|
|
988
|
+
/**
|
|
989
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
990
|
+
* company)
|
|
991
|
+
*/
|
|
992
|
+
interface Stock {
|
|
993
|
+
/**
|
|
994
|
+
* Stock exchange name
|
|
995
|
+
*/
|
|
996
|
+
exchange?: string;
|
|
997
|
+
/**
|
|
998
|
+
* Stock ticker symbol
|
|
999
|
+
*/
|
|
1000
|
+
ticker?: string;
|
|
1001
|
+
}
|
|
1002
|
+
}
|
|
1003
|
+
}
|
|
1004
|
+
export interface BrandRetrieveByNameResponse {
|
|
53
1005
|
/**
|
|
54
1006
|
* Detailed brand information
|
|
55
1007
|
*/
|
|
56
|
-
brand?:
|
|
1008
|
+
brand?: BrandRetrieveByNameResponse.Brand;
|
|
57
1009
|
/**
|
|
58
1010
|
* HTTP status code
|
|
59
1011
|
*/
|
|
@@ -63,7 +1015,7 @@ export interface BrandRetrieveResponse {
|
|
|
63
1015
|
*/
|
|
64
1016
|
status?: string;
|
|
65
1017
|
}
|
|
66
|
-
export declare namespace
|
|
1018
|
+
export declare namespace BrandRetrieveByNameResponse {
|
|
67
1019
|
/**
|
|
68
1020
|
* Detailed brand information
|
|
69
1021
|
*/
|
|
@@ -346,41 +1298,11 @@ export declare namespace BrandRetrieveResponse {
|
|
|
346
1298
|
}
|
|
347
1299
|
}
|
|
348
1300
|
}
|
|
349
|
-
export interface
|
|
350
|
-
/**
|
|
351
|
-
* Array of extracted data points
|
|
352
|
-
*/
|
|
353
|
-
data_extracted?: Array<BrandAIQueryResponse.DataExtracted>;
|
|
354
|
-
/**
|
|
355
|
-
* The domain that was analyzed
|
|
356
|
-
*/
|
|
357
|
-
domain?: string;
|
|
358
|
-
/**
|
|
359
|
-
* Status of the response, e.g., 'ok'
|
|
360
|
-
*/
|
|
361
|
-
status?: string;
|
|
362
|
-
/**
|
|
363
|
-
* List of URLs that were analyzed
|
|
364
|
-
*/
|
|
365
|
-
urls_analyzed?: Array<string>;
|
|
366
|
-
}
|
|
367
|
-
export declare namespace BrandAIQueryResponse {
|
|
368
|
-
interface DataExtracted {
|
|
369
|
-
/**
|
|
370
|
-
* Name of the extracted data point
|
|
371
|
-
*/
|
|
372
|
-
datapoint_name?: string;
|
|
373
|
-
/**
|
|
374
|
-
* Value of the extracted data point
|
|
375
|
-
*/
|
|
376
|
-
datapoint_value?: string | number | boolean | Array<string> | Array<number>;
|
|
377
|
-
}
|
|
378
|
-
}
|
|
379
|
-
export interface BrandIdentifyFromTransactionResponse {
|
|
1301
|
+
export interface BrandRetrieveByTickerResponse {
|
|
380
1302
|
/**
|
|
381
1303
|
* Detailed brand information
|
|
382
1304
|
*/
|
|
383
|
-
brand?:
|
|
1305
|
+
brand?: BrandRetrieveByTickerResponse.Brand;
|
|
384
1306
|
/**
|
|
385
1307
|
* HTTP status code
|
|
386
1308
|
*/
|
|
@@ -390,7 +1312,7 @@ export interface BrandIdentifyFromTransactionResponse {
|
|
|
390
1312
|
*/
|
|
391
1313
|
status?: string;
|
|
392
1314
|
}
|
|
393
|
-
export declare namespace
|
|
1315
|
+
export declare namespace BrandRetrieveByTickerResponse {
|
|
394
1316
|
/**
|
|
395
1317
|
* Detailed brand information
|
|
396
1318
|
*/
|
|
@@ -673,20 +1595,6 @@ export declare namespace BrandIdentifyFromTransactionResponse {
|
|
|
673
1595
|
}
|
|
674
1596
|
}
|
|
675
1597
|
}
|
|
676
|
-
export interface BrandPrefetchResponse {
|
|
677
|
-
/**
|
|
678
|
-
* The domain that was queued for prefetching
|
|
679
|
-
*/
|
|
680
|
-
domain?: string;
|
|
681
|
-
/**
|
|
682
|
-
* Success message
|
|
683
|
-
*/
|
|
684
|
-
message?: string;
|
|
685
|
-
/**
|
|
686
|
-
* Status of the response, e.g., 'ok'
|
|
687
|
-
*/
|
|
688
|
-
status?: string;
|
|
689
|
-
}
|
|
690
1598
|
export interface BrandRetrieveNaicsResponse {
|
|
691
1599
|
/**
|
|
692
1600
|
* Array of NAICS codes and titles.
|
|
@@ -1182,23 +2090,6 @@ export interface BrandRetrieveParams {
|
|
|
1182
2090
|
* less comprehensive data. Works with all three lookup methods.
|
|
1183
2091
|
*/
|
|
1184
2092
|
maxSpeed?: boolean;
|
|
1185
|
-
/**
|
|
1186
|
-
* Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
|
|
1187
|
-
* Corporation'). Must be 3-30 characters. Cannot be used with domain or ticker
|
|
1188
|
-
* parameters.
|
|
1189
|
-
*/
|
|
1190
|
-
name?: string;
|
|
1191
|
-
/**
|
|
1192
|
-
* Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
|
|
1193
|
-
* Must be 1-15 characters, letters/numbers/dots only. Cannot be used with domain
|
|
1194
|
-
* or name parameters.
|
|
1195
|
-
*/
|
|
1196
|
-
ticker?: string;
|
|
1197
|
-
/**
|
|
1198
|
-
* Optional stock exchange for the ticker. Only used when ticker parameter is
|
|
1199
|
-
* provided. Defaults to assume ticker is American if not specified.
|
|
1200
|
-
*/
|
|
1201
|
-
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';
|
|
1202
2093
|
/**
|
|
1203
2094
|
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
1204
2095
|
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -1288,6 +2179,16 @@ export interface BrandIdentifyFromTransactionParams {
|
|
|
1288
2179
|
* Transaction information to identify the brand
|
|
1289
2180
|
*/
|
|
1290
2181
|
transaction_info: string;
|
|
2182
|
+
/**
|
|
2183
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
2184
|
+
*/
|
|
2185
|
+
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';
|
|
2186
|
+
/**
|
|
2187
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2188
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2189
|
+
* less comprehensive data.
|
|
2190
|
+
*/
|
|
2191
|
+
maxSpeed?: boolean;
|
|
1291
2192
|
/**
|
|
1292
2193
|
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
1293
2194
|
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -1307,6 +2208,80 @@ export interface BrandPrefetchParams {
|
|
|
1307
2208
|
*/
|
|
1308
2209
|
timeoutMS?: number;
|
|
1309
2210
|
}
|
|
2211
|
+
export interface BrandRetrieveByEmailParams {
|
|
2212
|
+
/**
|
|
2213
|
+
* Email address to retrieve brand data for (e.g., 'contact@example.com'). The
|
|
2214
|
+
* domain will be extracted from the email. Free email providers (gmail.com,
|
|
2215
|
+
* yahoo.com, etc.) and disposable email addresses are not allowed.
|
|
2216
|
+
*/
|
|
2217
|
+
email: string;
|
|
2218
|
+
/**
|
|
2219
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
2220
|
+
*/
|
|
2221
|
+
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';
|
|
2222
|
+
/**
|
|
2223
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2224
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2225
|
+
* less comprehensive data.
|
|
2226
|
+
*/
|
|
2227
|
+
maxSpeed?: boolean;
|
|
2228
|
+
/**
|
|
2229
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2230
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2231
|
+
* value is 300000ms (5 minutes).
|
|
2232
|
+
*/
|
|
2233
|
+
timeoutMS?: number;
|
|
2234
|
+
}
|
|
2235
|
+
export interface BrandRetrieveByNameParams {
|
|
2236
|
+
/**
|
|
2237
|
+
* Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
|
|
2238
|
+
* Corporation'). Must be 3-30 characters.
|
|
2239
|
+
*/
|
|
2240
|
+
name: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
2243
|
+
*/
|
|
2244
|
+
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';
|
|
2245
|
+
/**
|
|
2246
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2247
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2248
|
+
* less comprehensive data.
|
|
2249
|
+
*/
|
|
2250
|
+
maxSpeed?: boolean;
|
|
2251
|
+
/**
|
|
2252
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2253
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2254
|
+
* value is 300000ms (5 minutes).
|
|
2255
|
+
*/
|
|
2256
|
+
timeoutMS?: number;
|
|
2257
|
+
}
|
|
2258
|
+
export interface BrandRetrieveByTickerParams {
|
|
2259
|
+
/**
|
|
2260
|
+
* Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
|
|
2261
|
+
* Must be 1-15 characters, letters/numbers/dots only.
|
|
2262
|
+
*/
|
|
2263
|
+
ticker: string;
|
|
2264
|
+
/**
|
|
2265
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
2266
|
+
*/
|
|
2267
|
+
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';
|
|
2268
|
+
/**
|
|
2269
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2270
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2271
|
+
* less comprehensive data.
|
|
2272
|
+
*/
|
|
2273
|
+
maxSpeed?: boolean;
|
|
2274
|
+
/**
|
|
2275
|
+
* Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
|
|
2276
|
+
*/
|
|
2277
|
+
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';
|
|
2278
|
+
/**
|
|
2279
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2280
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2281
|
+
* value is 300000ms (5 minutes).
|
|
2282
|
+
*/
|
|
2283
|
+
timeoutMS?: number;
|
|
2284
|
+
}
|
|
1310
2285
|
export interface BrandRetrieveNaicsParams {
|
|
1311
2286
|
/**
|
|
1312
2287
|
* Brand domain or title to retrieve NAICS code for. If a valid domain is provided
|
|
@@ -1380,6 +2355,6 @@ export interface BrandStyleguideParams {
|
|
|
1380
2355
|
timeoutMS?: number;
|
|
1381
2356
|
}
|
|
1382
2357
|
export declare namespace Brand {
|
|
1383
|
-
export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse, type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse, type BrandScreenshotResponse as BrandScreenshotResponse, type BrandStyleguideResponse as BrandStyleguideResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, type BrandScreenshotParams as BrandScreenshotParams, type BrandStyleguideParams as BrandStyleguideParams, };
|
|
2358
|
+
export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse, 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 BrandRetrieveParams as BrandRetrieveParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams, type BrandRetrieveByNameParams as BrandRetrieveByNameParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, type BrandScreenshotParams as BrandScreenshotParams, type BrandStyleguideParams as BrandStyleguideParams, };
|
|
1384
2359
|
}
|
|
1385
2360
|
//# sourceMappingURL=brand.d.mts.map
|