brand.dev 0.12.0 → 0.14.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 +38 -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 +342 -1
- package/resources/brand.d.mts.map +1 -1
- package/resources/brand.d.ts +342 -1
- package/resources/brand.d.ts.map +1 -1
- package/resources/brand.js +8 -0
- package/resources/brand.js.map +1 -1
- package/resources/brand.mjs +8 -0
- 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 +4 -0
- package/src/resources/brand.ts +1036 -87
- package/src/resources/index.ts +2 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/brand.d.mts
CHANGED
|
@@ -32,6 +32,12 @@ export declare class Brand extends APIResource {
|
|
|
32
32
|
* (like gmail.com, yahoo.com) will throw a 422 error.
|
|
33
33
|
*/
|
|
34
34
|
retrieveByEmail(query: BrandRetrieveByEmailParams, options?: RequestOptions): APIPromise<BrandRetrieveByEmailResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* Retrieve brand information using an ISIN (International Securities
|
|
37
|
+
* Identification Number). This endpoint looks up the company associated with the
|
|
38
|
+
* ISIN and returns its brand data.
|
|
39
|
+
*/
|
|
40
|
+
retrieveByIsin(query: BrandRetrieveByIsinParams, options?: RequestOptions): APIPromise<BrandRetrieveByIsinResponse>;
|
|
35
41
|
/**
|
|
36
42
|
* Retrieve brand information using a company name. This endpoint searches for the
|
|
37
43
|
* company by name and returns its brand data.
|
|
@@ -1001,6 +1007,303 @@ export declare namespace BrandRetrieveByEmailResponse {
|
|
|
1001
1007
|
}
|
|
1002
1008
|
}
|
|
1003
1009
|
}
|
|
1010
|
+
export interface BrandRetrieveByIsinResponse {
|
|
1011
|
+
/**
|
|
1012
|
+
* Detailed brand information
|
|
1013
|
+
*/
|
|
1014
|
+
brand?: BrandRetrieveByIsinResponse.Brand;
|
|
1015
|
+
/**
|
|
1016
|
+
* HTTP status code
|
|
1017
|
+
*/
|
|
1018
|
+
code?: number;
|
|
1019
|
+
/**
|
|
1020
|
+
* Status of the response, e.g., 'ok'
|
|
1021
|
+
*/
|
|
1022
|
+
status?: string;
|
|
1023
|
+
}
|
|
1024
|
+
export declare namespace BrandRetrieveByIsinResponse {
|
|
1025
|
+
/**
|
|
1026
|
+
* Detailed brand information
|
|
1027
|
+
*/
|
|
1028
|
+
interface Brand {
|
|
1029
|
+
/**
|
|
1030
|
+
* Physical address of the brand
|
|
1031
|
+
*/
|
|
1032
|
+
address?: Brand.Address;
|
|
1033
|
+
/**
|
|
1034
|
+
* An array of backdrop images for the brand
|
|
1035
|
+
*/
|
|
1036
|
+
backdrops?: Array<Brand.Backdrop>;
|
|
1037
|
+
/**
|
|
1038
|
+
* An array of brand colors
|
|
1039
|
+
*/
|
|
1040
|
+
colors?: Array<Brand.Color>;
|
|
1041
|
+
/**
|
|
1042
|
+
* A brief description of the brand
|
|
1043
|
+
*/
|
|
1044
|
+
description?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* The domain name of the brand
|
|
1047
|
+
*/
|
|
1048
|
+
domain?: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* Company email address
|
|
1051
|
+
*/
|
|
1052
|
+
email?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Industry classification information for the brand
|
|
1055
|
+
*/
|
|
1056
|
+
industries?: Brand.Industries;
|
|
1057
|
+
/**
|
|
1058
|
+
* Indicates whether the brand content is not safe for work (NSFW)
|
|
1059
|
+
*/
|
|
1060
|
+
is_nsfw?: boolean;
|
|
1061
|
+
/**
|
|
1062
|
+
* Important website links for the brand
|
|
1063
|
+
*/
|
|
1064
|
+
links?: Brand.Links;
|
|
1065
|
+
/**
|
|
1066
|
+
* An array of logos associated with the brand
|
|
1067
|
+
*/
|
|
1068
|
+
logos?: Array<Brand.Logo>;
|
|
1069
|
+
/**
|
|
1070
|
+
* Company phone number
|
|
1071
|
+
*/
|
|
1072
|
+
phone?: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* The brand's slogan
|
|
1075
|
+
*/
|
|
1076
|
+
slogan?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* An array of social media links for the brand
|
|
1079
|
+
*/
|
|
1080
|
+
socials?: Array<Brand.Social>;
|
|
1081
|
+
/**
|
|
1082
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1083
|
+
* company)
|
|
1084
|
+
*/
|
|
1085
|
+
stock?: Brand.Stock;
|
|
1086
|
+
/**
|
|
1087
|
+
* The title or name of the brand
|
|
1088
|
+
*/
|
|
1089
|
+
title?: string;
|
|
1090
|
+
}
|
|
1091
|
+
namespace Brand {
|
|
1092
|
+
/**
|
|
1093
|
+
* Physical address of the brand
|
|
1094
|
+
*/
|
|
1095
|
+
interface Address {
|
|
1096
|
+
/**
|
|
1097
|
+
* City name
|
|
1098
|
+
*/
|
|
1099
|
+
city?: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* Country name
|
|
1102
|
+
*/
|
|
1103
|
+
country?: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* Country code
|
|
1106
|
+
*/
|
|
1107
|
+
country_code?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* Postal or ZIP code
|
|
1110
|
+
*/
|
|
1111
|
+
postal_code?: string;
|
|
1112
|
+
/**
|
|
1113
|
+
* State or province code
|
|
1114
|
+
*/
|
|
1115
|
+
state_code?: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* State or province name
|
|
1118
|
+
*/
|
|
1119
|
+
state_province?: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* Street address
|
|
1122
|
+
*/
|
|
1123
|
+
street?: string;
|
|
1124
|
+
}
|
|
1125
|
+
interface Backdrop {
|
|
1126
|
+
/**
|
|
1127
|
+
* Array of colors in the backdrop image
|
|
1128
|
+
*/
|
|
1129
|
+
colors?: Array<Backdrop.Color>;
|
|
1130
|
+
/**
|
|
1131
|
+
* Resolution of the backdrop image
|
|
1132
|
+
*/
|
|
1133
|
+
resolution?: Backdrop.Resolution;
|
|
1134
|
+
/**
|
|
1135
|
+
* URL of the backdrop image
|
|
1136
|
+
*/
|
|
1137
|
+
url?: string;
|
|
1138
|
+
}
|
|
1139
|
+
namespace Backdrop {
|
|
1140
|
+
interface Color {
|
|
1141
|
+
/**
|
|
1142
|
+
* Color in hexadecimal format
|
|
1143
|
+
*/
|
|
1144
|
+
hex?: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* Name of the color
|
|
1147
|
+
*/
|
|
1148
|
+
name?: string;
|
|
1149
|
+
}
|
|
1150
|
+
/**
|
|
1151
|
+
* Resolution of the backdrop image
|
|
1152
|
+
*/
|
|
1153
|
+
interface Resolution {
|
|
1154
|
+
/**
|
|
1155
|
+
* Aspect ratio of the image (width/height)
|
|
1156
|
+
*/
|
|
1157
|
+
aspect_ratio?: number;
|
|
1158
|
+
/**
|
|
1159
|
+
* Height of the image in pixels
|
|
1160
|
+
*/
|
|
1161
|
+
height?: number;
|
|
1162
|
+
/**
|
|
1163
|
+
* Width of the image in pixels
|
|
1164
|
+
*/
|
|
1165
|
+
width?: number;
|
|
1166
|
+
}
|
|
1167
|
+
}
|
|
1168
|
+
interface Color {
|
|
1169
|
+
/**
|
|
1170
|
+
* Color in hexadecimal format
|
|
1171
|
+
*/
|
|
1172
|
+
hex?: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* Name of the color
|
|
1175
|
+
*/
|
|
1176
|
+
name?: string;
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* Industry classification information for the brand
|
|
1180
|
+
*/
|
|
1181
|
+
interface Industries {
|
|
1182
|
+
/**
|
|
1183
|
+
* Easy Industry Classification - array of industry and subindustry pairs
|
|
1184
|
+
*/
|
|
1185
|
+
eic?: Array<Industries.Eic>;
|
|
1186
|
+
}
|
|
1187
|
+
namespace Industries {
|
|
1188
|
+
interface Eic {
|
|
1189
|
+
/**
|
|
1190
|
+
* Industry classification enum
|
|
1191
|
+
*/
|
|
1192
|
+
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)';
|
|
1193
|
+
/**
|
|
1194
|
+
* Subindustry classification enum
|
|
1195
|
+
*/
|
|
1196
|
+
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';
|
|
1197
|
+
}
|
|
1198
|
+
}
|
|
1199
|
+
/**
|
|
1200
|
+
* Important website links for the brand
|
|
1201
|
+
*/
|
|
1202
|
+
interface Links {
|
|
1203
|
+
/**
|
|
1204
|
+
* URL to the brand's blog or news page
|
|
1205
|
+
*/
|
|
1206
|
+
blog?: string | null;
|
|
1207
|
+
/**
|
|
1208
|
+
* URL to the brand's careers or job opportunities page
|
|
1209
|
+
*/
|
|
1210
|
+
careers?: string | null;
|
|
1211
|
+
/**
|
|
1212
|
+
* URL to the brand's contact or contact us page
|
|
1213
|
+
*/
|
|
1214
|
+
contact?: string | null;
|
|
1215
|
+
/**
|
|
1216
|
+
* URL to the brand's pricing or plans page
|
|
1217
|
+
*/
|
|
1218
|
+
pricing?: string | null;
|
|
1219
|
+
/**
|
|
1220
|
+
* URL to the brand's privacy policy page
|
|
1221
|
+
*/
|
|
1222
|
+
privacy?: string | null;
|
|
1223
|
+
/**
|
|
1224
|
+
* URL to the brand's terms of service or terms and conditions page
|
|
1225
|
+
*/
|
|
1226
|
+
terms?: string | null;
|
|
1227
|
+
}
|
|
1228
|
+
interface Logo {
|
|
1229
|
+
/**
|
|
1230
|
+
* Array of colors in the logo
|
|
1231
|
+
*/
|
|
1232
|
+
colors?: Array<Logo.Color>;
|
|
1233
|
+
/**
|
|
1234
|
+
* Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
|
1235
|
+
* best for dark mode, 'has_opaque_background' = can be used for either as image
|
|
1236
|
+
* has its own background
|
|
1237
|
+
*/
|
|
1238
|
+
mode?: 'light' | 'dark' | 'has_opaque_background';
|
|
1239
|
+
/**
|
|
1240
|
+
* Resolution of the logo image
|
|
1241
|
+
*/
|
|
1242
|
+
resolution?: Logo.Resolution;
|
|
1243
|
+
/**
|
|
1244
|
+
* Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
1245
|
+
*/
|
|
1246
|
+
type?: 'icon' | 'logo';
|
|
1247
|
+
/**
|
|
1248
|
+
* CDN hosted url of the logo (ready for display)
|
|
1249
|
+
*/
|
|
1250
|
+
url?: string;
|
|
1251
|
+
}
|
|
1252
|
+
namespace Logo {
|
|
1253
|
+
interface Color {
|
|
1254
|
+
/**
|
|
1255
|
+
* Color in hexadecimal format
|
|
1256
|
+
*/
|
|
1257
|
+
hex?: string;
|
|
1258
|
+
/**
|
|
1259
|
+
* Name of the color
|
|
1260
|
+
*/
|
|
1261
|
+
name?: string;
|
|
1262
|
+
}
|
|
1263
|
+
/**
|
|
1264
|
+
* Resolution of the logo image
|
|
1265
|
+
*/
|
|
1266
|
+
interface Resolution {
|
|
1267
|
+
/**
|
|
1268
|
+
* Aspect ratio of the image (width/height)
|
|
1269
|
+
*/
|
|
1270
|
+
aspect_ratio?: number;
|
|
1271
|
+
/**
|
|
1272
|
+
* Height of the image in pixels
|
|
1273
|
+
*/
|
|
1274
|
+
height?: number;
|
|
1275
|
+
/**
|
|
1276
|
+
* Width of the image in pixels
|
|
1277
|
+
*/
|
|
1278
|
+
width?: number;
|
|
1279
|
+
}
|
|
1280
|
+
}
|
|
1281
|
+
interface Social {
|
|
1282
|
+
/**
|
|
1283
|
+
* Type of social media, e.g., 'facebook', 'twitter'
|
|
1284
|
+
*/
|
|
1285
|
+
type?: string;
|
|
1286
|
+
/**
|
|
1287
|
+
* URL of the social media page
|
|
1288
|
+
*/
|
|
1289
|
+
url?: string;
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* Stock market information for this brand (will be null if not a publicly traded
|
|
1293
|
+
* company)
|
|
1294
|
+
*/
|
|
1295
|
+
interface Stock {
|
|
1296
|
+
/**
|
|
1297
|
+
* Stock exchange name
|
|
1298
|
+
*/
|
|
1299
|
+
exchange?: string;
|
|
1300
|
+
/**
|
|
1301
|
+
* Stock ticker symbol
|
|
1302
|
+
*/
|
|
1303
|
+
ticker?: string;
|
|
1304
|
+
}
|
|
1305
|
+
}
|
|
1306
|
+
}
|
|
1004
1307
|
export interface BrandRetrieveByNameResponse {
|
|
1005
1308
|
/**
|
|
1006
1309
|
* Detailed brand information
|
|
@@ -2179,6 +2482,15 @@ export interface BrandIdentifyFromTransactionParams {
|
|
|
2179
2482
|
* Transaction information to identify the brand
|
|
2180
2483
|
*/
|
|
2181
2484
|
transaction_info: string;
|
|
2485
|
+
/**
|
|
2486
|
+
* Optional city name to prioritize when searching for the brand.
|
|
2487
|
+
*/
|
|
2488
|
+
city?: string;
|
|
2489
|
+
/**
|
|
2490
|
+
* Optional country code (GL parameter) to specify the country for Google search
|
|
2491
|
+
* results. This affects the geographic location used for search queries.
|
|
2492
|
+
*/
|
|
2493
|
+
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';
|
|
2182
2494
|
/**
|
|
2183
2495
|
* Optional parameter to force the language of the retrieved brand data.
|
|
2184
2496
|
*/
|
|
@@ -2189,6 +2501,11 @@ export interface BrandIdentifyFromTransactionParams {
|
|
|
2189
2501
|
* less comprehensive data.
|
|
2190
2502
|
*/
|
|
2191
2503
|
maxSpeed?: boolean;
|
|
2504
|
+
/**
|
|
2505
|
+
* Optional Merchant Category Code (MCC) to help identify the business
|
|
2506
|
+
* category/industry.
|
|
2507
|
+
*/
|
|
2508
|
+
mcc?: string;
|
|
2192
2509
|
/**
|
|
2193
2510
|
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2194
2511
|
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -2232,6 +2549,30 @@ export interface BrandRetrieveByEmailParams {
|
|
|
2232
2549
|
*/
|
|
2233
2550
|
timeoutMS?: number;
|
|
2234
2551
|
}
|
|
2552
|
+
export interface BrandRetrieveByIsinParams {
|
|
2553
|
+
/**
|
|
2554
|
+
* ISIN (International Securities Identification Number) to retrieve brand data for
|
|
2555
|
+
* (e.g., 'AU000000IMD5', 'US0378331005'). Must be exactly 12 characters: 2 letters
|
|
2556
|
+
* followed by 9 alphanumeric characters and ending with a digit.
|
|
2557
|
+
*/
|
|
2558
|
+
isin: string;
|
|
2559
|
+
/**
|
|
2560
|
+
* Optional parameter to force the language of the retrieved brand data.
|
|
2561
|
+
*/
|
|
2562
|
+
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';
|
|
2563
|
+
/**
|
|
2564
|
+
* Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
2565
|
+
* the API will skip time-consuming operations for faster response at the cost of
|
|
2566
|
+
* less comprehensive data.
|
|
2567
|
+
*/
|
|
2568
|
+
maxSpeed?: boolean;
|
|
2569
|
+
/**
|
|
2570
|
+
* Optional timeout in milliseconds for the request. If the request takes longer
|
|
2571
|
+
* than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
2572
|
+
* value is 300000ms (5 minutes).
|
|
2573
|
+
*/
|
|
2574
|
+
timeoutMS?: number;
|
|
2575
|
+
}
|
|
2235
2576
|
export interface BrandRetrieveByNameParams {
|
|
2236
2577
|
/**
|
|
2237
2578
|
* Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
|
|
@@ -2355,6 +2696,6 @@ export interface BrandStyleguideParams {
|
|
|
2355
2696
|
timeoutMS?: number;
|
|
2356
2697
|
}
|
|
2357
2698
|
export declare namespace Brand {
|
|
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, };
|
|
2699
|
+
export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, 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 BrandRetrieveParams as BrandRetrieveParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, 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, };
|
|
2359
2700
|
}
|
|
2360
2701
|
//# sourceMappingURL=brand.d.mts.map
|