brand.dev 0.9.1 → 0.12.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.
@@ -6,8 +6,8 @@ import { RequestOptions } from '../internal/request-options';
6
6
 
7
7
  export class Brand extends APIResource {
8
8
  /**
9
- * Retrieve brand information using one of three methods: domain name, company
10
- * name, or stock ticker symbol. Exactly one of these parameters must be provided.
9
+ * Retrieve logos, backdrops, colors, industry, description, and more from any
10
+ * domain
11
11
  */
12
12
  retrieve(
13
13
  query: BrandRetrieveParams | null | undefined = {},
@@ -46,6 +46,41 @@ export class Brand extends APIResource {
46
46
  return this._client.post('/brand/prefetch', { body, ...options });
47
47
  }
48
48
 
49
+ /**
50
+ * Retrieve brand information using an email address while detecting disposable and
51
+ * free email addresses. This endpoint extracts the domain from the email address
52
+ * and returns brand data for that domain. Disposable and free email addresses
53
+ * (like gmail.com, yahoo.com) will throw a 422 error.
54
+ */
55
+ retrieveByEmail(
56
+ query: BrandRetrieveByEmailParams,
57
+ options?: RequestOptions,
58
+ ): APIPromise<BrandRetrieveByEmailResponse> {
59
+ return this._client.get('/brand/retrieve-by-email', { query, ...options });
60
+ }
61
+
62
+ /**
63
+ * Retrieve brand information using a company name. This endpoint searches for the
64
+ * company by name and returns its brand data.
65
+ */
66
+ retrieveByName(
67
+ query: BrandRetrieveByNameParams,
68
+ options?: RequestOptions,
69
+ ): APIPromise<BrandRetrieveByNameResponse> {
70
+ return this._client.get('/brand/retrieve-by-name', { query, ...options });
71
+ }
72
+
73
+ /**
74
+ * Retrieve brand information using a stock ticker symbol. This endpoint looks up
75
+ * the company associated with the ticker and returns its brand data.
76
+ */
77
+ retrieveByTicker(
78
+ query: BrandRetrieveByTickerParams,
79
+ options?: RequestOptions,
80
+ ): APIPromise<BrandRetrieveByTickerResponse> {
81
+ return this._client.get('/brand/retrieve-by-ticker', { query, ...options });
82
+ }
83
+
49
84
  /**
50
85
  * Endpoint to classify any brand into a 2022 NAICS code.
51
86
  */
@@ -1339,84 +1374,99 @@ export interface BrandPrefetchResponse {
1339
1374
  status?: string;
1340
1375
  }
1341
1376
 
1342
- export interface BrandRetrieveNaicsResponse {
1377
+ export interface BrandRetrieveByEmailResponse {
1343
1378
  /**
1344
- * Array of NAICS codes and titles.
1379
+ * Detailed brand information
1345
1380
  */
1346
- codes?: Array<BrandRetrieveNaicsResponse.Code>;
1381
+ brand?: BrandRetrieveByEmailResponse.Brand;
1347
1382
 
1348
1383
  /**
1349
- * Domain found for the brand
1384
+ * HTTP status code
1350
1385
  */
1351
- domain?: string;
1386
+ code?: number;
1352
1387
 
1353
1388
  /**
1354
1389
  * Status of the response, e.g., 'ok'
1355
1390
  */
1356
1391
  status?: string;
1392
+ }
1357
1393
 
1394
+ export namespace BrandRetrieveByEmailResponse {
1358
1395
  /**
1359
- * Industry classification type, for naics api it will be `naics`
1396
+ * Detailed brand information
1360
1397
  */
1361
- type?: string;
1362
- }
1398
+ export interface Brand {
1399
+ /**
1400
+ * Physical address of the brand
1401
+ */
1402
+ address?: Brand.Address;
1363
1403
 
1364
- export namespace BrandRetrieveNaicsResponse {
1365
- export interface Code {
1366
1404
  /**
1367
- * NAICS code
1405
+ * An array of backdrop images for the brand
1368
1406
  */
1369
- code?: string;
1407
+ backdrops?: Array<Brand.Backdrop>;
1370
1408
 
1371
1409
  /**
1372
- * NAICS title
1410
+ * An array of brand colors
1373
1411
  */
1374
- title?: string;
1375
- }
1376
- }
1412
+ colors?: Array<Brand.Color>;
1377
1413
 
1378
- export interface BrandRetrieveSimplifiedResponse {
1379
- /**
1380
- * Simplified brand information
1381
- */
1382
- brand?: BrandRetrieveSimplifiedResponse.Brand;
1414
+ /**
1415
+ * A brief description of the brand
1416
+ */
1417
+ description?: string;
1383
1418
 
1384
- /**
1385
- * HTTP status code of the response
1386
- */
1387
- code?: number;
1419
+ /**
1420
+ * The domain name of the brand
1421
+ */
1422
+ domain?: string;
1388
1423
 
1389
- /**
1390
- * Status of the response, e.g., 'ok'
1391
- */
1392
- status?: string;
1393
- }
1424
+ /**
1425
+ * Company email address
1426
+ */
1427
+ email?: string;
1394
1428
 
1395
- export namespace BrandRetrieveSimplifiedResponse {
1396
- /**
1397
- * Simplified brand information
1398
- */
1399
- export interface Brand {
1400
1429
  /**
1401
- * An array of backdrop images for the brand
1430
+ * Industry classification information for the brand
1402
1431
  */
1403
- backdrops?: Array<Brand.Backdrop>;
1432
+ industries?: Brand.Industries;
1404
1433
 
1405
1434
  /**
1406
- * An array of brand colors
1435
+ * Indicates whether the brand content is not safe for work (NSFW)
1407
1436
  */
1408
- colors?: Array<Brand.Color>;
1437
+ is_nsfw?: boolean;
1409
1438
 
1410
1439
  /**
1411
- * The domain name of the brand
1440
+ * Important website links for the brand
1412
1441
  */
1413
- domain?: string;
1442
+ links?: Brand.Links;
1414
1443
 
1415
1444
  /**
1416
1445
  * An array of logos associated with the brand
1417
1446
  */
1418
1447
  logos?: Array<Brand.Logo>;
1419
1448
 
1449
+ /**
1450
+ * Company phone number
1451
+ */
1452
+ phone?: string;
1453
+
1454
+ /**
1455
+ * The brand's slogan
1456
+ */
1457
+ slogan?: string;
1458
+
1459
+ /**
1460
+ * An array of social media links for the brand
1461
+ */
1462
+ socials?: Array<Brand.Social>;
1463
+
1464
+ /**
1465
+ * Stock market information for this brand (will be null if not a publicly traded
1466
+ * company)
1467
+ */
1468
+ stock?: Brand.Stock;
1469
+
1420
1470
  /**
1421
1471
  * The title or name of the brand
1422
1472
  */
@@ -1424,6 +1474,46 @@ export namespace BrandRetrieveSimplifiedResponse {
1424
1474
  }
1425
1475
 
1426
1476
  export namespace Brand {
1477
+ /**
1478
+ * Physical address of the brand
1479
+ */
1480
+ export interface Address {
1481
+ /**
1482
+ * City name
1483
+ */
1484
+ city?: string;
1485
+
1486
+ /**
1487
+ * Country name
1488
+ */
1489
+ country?: string;
1490
+
1491
+ /**
1492
+ * Country code
1493
+ */
1494
+ country_code?: string;
1495
+
1496
+ /**
1497
+ * Postal or ZIP code
1498
+ */
1499
+ postal_code?: string;
1500
+
1501
+ /**
1502
+ * State or province code
1503
+ */
1504
+ state_code?: string;
1505
+
1506
+ /**
1507
+ * State or province name
1508
+ */
1509
+ state_province?: string;
1510
+
1511
+ /**
1512
+ * Street address
1513
+ */
1514
+ street?: string;
1515
+ }
1516
+
1427
1517
  export interface Backdrop {
1428
1518
  /**
1429
1519
  * Array of colors in the backdrop image
@@ -1487,87 +1577,1829 @@ export namespace BrandRetrieveSimplifiedResponse {
1487
1577
  name?: string;
1488
1578
  }
1489
1579
 
1490
- export interface Logo {
1491
- /**
1492
- * Array of colors in the logo
1493
- */
1494
- colors?: Array<Logo.Color>;
1495
-
1496
- /**
1497
- * Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
1498
- * best for dark mode, 'has_opaque_background' = can be used for either as image
1499
- * has its own background
1500
- */
1501
- mode?: 'light' | 'dark' | 'has_opaque_background';
1502
-
1503
- /**
1504
- * Resolution of the logo image
1505
- */
1506
- resolution?: Logo.Resolution;
1507
-
1508
- /**
1509
- * Type of the logo based on resolution (e.g., 'icon', 'logo')
1510
- */
1511
- type?: 'icon' | 'logo';
1512
-
1580
+ /**
1581
+ * Industry classification information for the brand
1582
+ */
1583
+ export interface Industries {
1513
1584
  /**
1514
- * CDN hosted url of the logo (ready for display)
1585
+ * Easy Industry Classification - array of industry and subindustry pairs
1515
1586
  */
1516
- url?: string;
1587
+ eic?: Array<Industries.Eic>;
1517
1588
  }
1518
1589
 
1519
- export namespace Logo {
1520
- export interface Color {
1521
- /**
1522
- * Color in hexadecimal format
1523
- */
1524
- hex?: string;
1525
-
1526
- /**
1527
- * Name of the color
1528
- */
1529
- name?: string;
1530
- }
1531
-
1532
- /**
1533
- * Resolution of the logo image
1534
- */
1535
- export interface Resolution {
1536
- /**
1537
- * Aspect ratio of the image (width/height)
1538
- */
1539
- aspect_ratio?: number;
1540
-
1590
+ export namespace Industries {
1591
+ export interface Eic {
1541
1592
  /**
1542
- * Height of the image in pixels
1593
+ * Industry classification enum
1543
1594
  */
1544
- height?: number;
1595
+ industry:
1596
+ | 'Aerospace & Defense'
1597
+ | 'Technology'
1598
+ | 'Finance'
1599
+ | 'Healthcare'
1600
+ | 'Retail & E-commerce'
1601
+ | 'Entertainment'
1602
+ | 'Education'
1603
+ | 'Government & Nonprofit'
1604
+ | 'Industrial & Energy'
1605
+ | 'Automotive & Transportation'
1606
+ | 'Lifestyle & Leisure'
1607
+ | 'Luxury & Fashion'
1608
+ | 'News & Media'
1609
+ | 'Sports'
1610
+ | 'Real Estate & PropTech'
1611
+ | 'Legal & Compliance'
1612
+ | 'Telecommunications'
1613
+ | 'Agriculture & Food'
1614
+ | 'Professional Services & Agencies'
1615
+ | 'Chemicals & Materials'
1616
+ | 'Logistics & Supply Chain'
1617
+ | 'Hospitality & Tourism'
1618
+ | 'Construction & Built Environment'
1619
+ | 'Consumer Packaged Goods (CPG)';
1545
1620
 
1546
1621
  /**
1547
- * Width of the image in pixels
1622
+ * Subindustry classification enum
1548
1623
  */
1549
- width?: number;
1550
- }
1551
- }
1552
- }
1553
- }
1554
-
1555
- export interface BrandScreenshotResponse {
1556
- /**
1557
- * HTTP status code
1558
- */
1559
- code?: number;
1560
-
1561
- /**
1562
- * The normalized domain that was processed
1563
- */
1564
- domain?: string;
1565
-
1566
- /**
1567
- * Public URL of the uploaded screenshot image
1568
- */
1569
- screenshot?: string;
1570
-
1624
+ subindustry:
1625
+ | 'Defense Systems & Military Hardware'
1626
+ | 'Aerospace Manufacturing'
1627
+ | 'Avionics & Navigation Technology'
1628
+ | 'Subsea & Naval Defense Systems'
1629
+ | 'Space & Satellite Technology'
1630
+ | 'Defense IT & Systems Integration'
1631
+ | 'Software (B2B)'
1632
+ | 'Software (B2C)'
1633
+ | 'Cloud Infrastructure & DevOps'
1634
+ | 'Cybersecurity'
1635
+ | 'Artificial Intelligence & Machine Learning'
1636
+ | 'Data Infrastructure & Analytics'
1637
+ | 'Hardware & Semiconductors'
1638
+ | 'Fintech Infrastructure'
1639
+ | 'eCommerce & Marketplace Platforms'
1640
+ | 'Developer Tools & APIs'
1641
+ | 'Web3 & Blockchain'
1642
+ | 'XR & Spatial Computing'
1643
+ | 'Banking & Lending'
1644
+ | 'Investment Management & WealthTech'
1645
+ | 'Insurance & InsurTech'
1646
+ | 'Payments & Money Movement'
1647
+ | 'Accounting, Tax & Financial Planning Tools'
1648
+ | 'Capital Markets & Trading Platforms'
1649
+ | 'Financial Infrastructure & APIs'
1650
+ | 'Credit Scoring & Risk Management'
1651
+ | 'Cryptocurrency & Digital Assets'
1652
+ | 'BNPL & Alternative Financing'
1653
+ | 'Healthcare Providers & Services'
1654
+ | 'Pharmaceuticals & Drug Development'
1655
+ | 'Medical Devices & Diagnostics'
1656
+ | 'Biotechnology & Genomics'
1657
+ | 'Digital Health & Telemedicine'
1658
+ | 'Health Insurance & Benefits Tech'
1659
+ | 'Clinical Trials & Research Platforms'
1660
+ | 'Mental Health & Wellness'
1661
+ | 'Healthcare IT & EHR Systems'
1662
+ | 'Consumer Health & Wellness Products'
1663
+ | 'Online Marketplaces'
1664
+ | 'Direct-to-Consumer (DTC) Brands'
1665
+ | 'Retail Tech & Point-of-Sale Systems'
1666
+ | 'Omnichannel & In-Store Retail'
1667
+ | 'E-commerce Enablement & Infrastructure'
1668
+ | 'Subscription & Membership Commerce'
1669
+ | 'Social Commerce & Influencer Platforms'
1670
+ | 'Fashion & Apparel Retail'
1671
+ | 'Food, Beverage & Grocery E-commerce'
1672
+ | 'Streaming Platforms (Video, Music, Audio)'
1673
+ | 'Gaming & Interactive Entertainment'
1674
+ | 'Creator Economy & Influencer Platforms'
1675
+ | 'Advertising, Adtech & Media Buying'
1676
+ | 'Film, TV & Production Studios'
1677
+ | 'Events, Venues & Live Entertainment'
1678
+ | 'Virtual Worlds & Metaverse Experiences'
1679
+ | 'K-12 Education Platforms & Tools'
1680
+ | 'Higher Education & University Tech'
1681
+ | 'Online Learning & MOOCs'
1682
+ | 'Test Prep & Certification'
1683
+ | 'Corporate Training & Upskilling'
1684
+ | 'Tutoring & Supplemental Learning'
1685
+ | 'Education Management Systems (LMS/SIS)'
1686
+ | 'Language Learning'
1687
+ | 'Creator-Led & Cohort-Based Courses'
1688
+ | 'Special Education & Accessibility Tools'
1689
+ | 'Government Technology & Digital Services'
1690
+ | 'Civic Engagement & Policy Platforms'
1691
+ | 'International Development & Humanitarian Aid'
1692
+ | 'Philanthropy & Grantmaking'
1693
+ | 'Nonprofit Operations & Fundraising Tools'
1694
+ | 'Public Health & Social Services'
1695
+ | 'Education & Youth Development Programs'
1696
+ | 'Environmental & Climate Action Organizations'
1697
+ | 'Legal Aid & Social Justice Advocacy'
1698
+ | 'Municipal & Infrastructure Services'
1699
+ | 'Manufacturing & Industrial Automation'
1700
+ | 'Energy Production (Oil, Gas, Nuclear)'
1701
+ | 'Renewable Energy & Cleantech'
1702
+ | 'Utilities & Grid Infrastructure'
1703
+ | 'Industrial IoT & Monitoring Systems'
1704
+ | 'Construction & Heavy Equipment'
1705
+ | 'Mining & Natural Resources'
1706
+ | 'Environmental Engineering & Sustainability'
1707
+ | 'Energy Storage & Battery Technology'
1708
+ | 'Automotive OEMs & Vehicle Manufacturing'
1709
+ | 'Electric Vehicles (EVs) & Charging Infrastructure'
1710
+ | 'Mobility-as-a-Service (MaaS)'
1711
+ | 'Fleet Management'
1712
+ | 'Public Transit & Urban Mobility'
1713
+ | 'Autonomous Vehicles & ADAS'
1714
+ | 'Aftermarket Parts & Services'
1715
+ | 'Telematics & Vehicle Connectivity'
1716
+ | 'Aviation & Aerospace Transport'
1717
+ | 'Maritime Shipping'
1718
+ | 'Fitness & Wellness'
1719
+ | 'Beauty & Personal Care'
1720
+ | 'Home & Living'
1721
+ | 'Dating & Relationships'
1722
+ | 'Hobbies, Crafts & DIY'
1723
+ | 'Outdoor & Recreational Gear'
1724
+ | 'Events, Experiences & Ticketing Platforms'
1725
+ | 'Designer & Luxury Apparel'
1726
+ | 'Accessories, Jewelry & Watches'
1727
+ | 'Footwear & Leather Goods'
1728
+ | 'Beauty, Fragrance & Skincare'
1729
+ | 'Fashion Marketplaces & Retail Platforms'
1730
+ | 'Sustainable & Ethical Fashion'
1731
+ | 'Resale, Vintage & Circular Fashion'
1732
+ | 'Fashion Tech & Virtual Try-Ons'
1733
+ | 'Streetwear & Emerging Luxury'
1734
+ | 'Couture & Made-to-Measure'
1735
+ | 'News Publishing & Journalism'
1736
+ | 'Digital Media & Content Platforms'
1737
+ | 'Broadcasting (TV & Radio)'
1738
+ | 'Podcasting & Audio Media'
1739
+ | 'News Aggregators & Curation Tools'
1740
+ | 'Independent & Creator-Led Media'
1741
+ | 'Newsletters & Substack-Style Platforms'
1742
+ | 'Political & Investigative Media'
1743
+ | 'Trade & Niche Publications'
1744
+ | 'Media Monitoring & Analytics'
1745
+ | 'Professional Teams & Leagues'
1746
+ | 'Sports Media & Broadcasting'
1747
+ | 'Sports Betting & Fantasy Sports'
1748
+ | 'Fitness & Athletic Training Platforms'
1749
+ | 'Sportswear & Equipment'
1750
+ | 'Esports & Competitive Gaming'
1751
+ | 'Sports Venues & Event Management'
1752
+ | 'Athlete Management & Talent Agencies'
1753
+ | 'Sports Tech & Performance Analytics'
1754
+ | 'Youth, Amateur & Collegiate Sports'
1755
+ | 'Real Estate Marketplaces'
1756
+ | 'Property Management Software'
1757
+ | 'Rental Platforms'
1758
+ | 'Mortgage & Lending Tech'
1759
+ | 'Real Estate Investment Platforms'
1760
+ | 'Law Firms & Legal Services'
1761
+ | 'Legal Tech & Automation'
1762
+ | 'Regulatory Compliance'
1763
+ | 'E-Discovery & Litigation Tools'
1764
+ | 'Contract Management'
1765
+ | 'Governance, Risk & Compliance (GRC)'
1766
+ | 'IP & Trademark Management'
1767
+ | 'Legal Research & Intelligence'
1768
+ | 'Compliance Training & Certification'
1769
+ | 'Whistleblower & Ethics Reporting'
1770
+ | 'Mobile & Wireless Networks (3G/4G/5G)'
1771
+ | 'Broadband & Fiber Internet'
1772
+ | 'Satellite & Space-Based Communications'
1773
+ | 'Network Equipment & Infrastructure'
1774
+ | 'Telecom Billing & OSS/BSS Systems'
1775
+ | 'VoIP & Unified Communications'
1776
+ | 'Internet Service Providers (ISPs)'
1777
+ | 'Edge Computing & Network Virtualization'
1778
+ | 'IoT Connectivity Platforms'
1779
+ | 'Precision Agriculture & AgTech'
1780
+ | 'Crop & Livestock Production'
1781
+ | 'Food & Beverage Manufacturing & Processing'
1782
+ | 'Food Distribution'
1783
+ | 'Restaurants & Food Service'
1784
+ | 'Agricultural Inputs & Equipment'
1785
+ | 'Sustainable & Regenerative Agriculture'
1786
+ | 'Seafood & Aquaculture'
1787
+ | 'Management Consulting'
1788
+ | 'Marketing & Advertising Agencies'
1789
+ | 'Design, Branding & Creative Studios'
1790
+ | 'IT Services & Managed Services'
1791
+ | 'Staffing, Recruiting & Talent'
1792
+ | 'Accounting & Tax Firms'
1793
+ | 'Public Relations & Communications'
1794
+ | 'Business Process Outsourcing (BPO)'
1795
+ | 'Professional Training & Coaching'
1796
+ | 'Specialty Chemicals'
1797
+ | 'Commodity & Petrochemicals'
1798
+ | 'Polymers, Plastics & Rubber'
1799
+ | 'Coatings, Adhesives & Sealants'
1800
+ | 'Industrial Gases'
1801
+ | 'Advanced Materials & Composites'
1802
+ | 'Battery Materials & Energy Storage'
1803
+ | 'Electronic Materials & Semiconductor Chemicals'
1804
+ | 'Agrochemicals & Fertilizers'
1805
+ | 'Freight & Transportation Tech'
1806
+ | 'Last-Mile Delivery'
1807
+ | 'Warehouse Automation'
1808
+ | 'Supply Chain Visibility Platforms'
1809
+ | 'Logistics Marketplaces'
1810
+ | 'Shipping & Freight Forwarding'
1811
+ | 'Cold Chain Logistics'
1812
+ | 'Reverse Logistics & Returns'
1813
+ | 'Cross-Border Trade Tech'
1814
+ | 'Transportation Management Systems (TMS)'
1815
+ | 'Hotels & Accommodation'
1816
+ | 'Vacation Rentals & Short-Term Stays'
1817
+ | 'Restaurant Tech & Management'
1818
+ | 'Travel Booking Platforms'
1819
+ | 'Tourism Experiences & Activities'
1820
+ | 'Cruise Lines & Marine Tourism'
1821
+ | 'Hospitality Management Systems'
1822
+ | 'Event & Venue Management'
1823
+ | 'Corporate Travel Management'
1824
+ | 'Travel Insurance & Protection'
1825
+ | 'Construction Management Software'
1826
+ | 'BIM/CAD & Design Tools'
1827
+ | 'Construction Marketplaces'
1828
+ | 'Equipment Rental & Management'
1829
+ | 'Building Materials & Procurement'
1830
+ | 'Construction Workforce Management'
1831
+ | 'Project Estimation & Bidding'
1832
+ | 'Modular & Prefab Construction'
1833
+ | 'Construction Safety & Compliance'
1834
+ | 'Smart Building Technology'
1835
+ | 'Food & Beverage CPG'
1836
+ | 'Home & Personal Care CPG'
1837
+ | 'CPG Analytics & Insights'
1838
+ | 'Direct-to-Consumer CPG Brands'
1839
+ | 'CPG Supply Chain & Distribution'
1840
+ | 'Private Label Manufacturing'
1841
+ | 'CPG Retail Intelligence'
1842
+ | 'Sustainable CPG & Packaging'
1843
+ | 'Beauty & Cosmetics CPG'
1844
+ | 'Health & Wellness CPG';
1845
+ }
1846
+ }
1847
+
1848
+ /**
1849
+ * Important website links for the brand
1850
+ */
1851
+ export interface Links {
1852
+ /**
1853
+ * URL to the brand's blog or news page
1854
+ */
1855
+ blog?: string | null;
1856
+
1857
+ /**
1858
+ * URL to the brand's careers or job opportunities page
1859
+ */
1860
+ careers?: string | null;
1861
+
1862
+ /**
1863
+ * URL to the brand's contact or contact us page
1864
+ */
1865
+ contact?: string | null;
1866
+
1867
+ /**
1868
+ * URL to the brand's pricing or plans page
1869
+ */
1870
+ pricing?: string | null;
1871
+
1872
+ /**
1873
+ * URL to the brand's privacy policy page
1874
+ */
1875
+ privacy?: string | null;
1876
+
1877
+ /**
1878
+ * URL to the brand's terms of service or terms and conditions page
1879
+ */
1880
+ terms?: string | null;
1881
+ }
1882
+
1883
+ export interface Logo {
1884
+ /**
1885
+ * Array of colors in the logo
1886
+ */
1887
+ colors?: Array<Logo.Color>;
1888
+
1889
+ /**
1890
+ * Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
1891
+ * best for dark mode, 'has_opaque_background' = can be used for either as image
1892
+ * has its own background
1893
+ */
1894
+ mode?: 'light' | 'dark' | 'has_opaque_background';
1895
+
1896
+ /**
1897
+ * Resolution of the logo image
1898
+ */
1899
+ resolution?: Logo.Resolution;
1900
+
1901
+ /**
1902
+ * Type of the logo based on resolution (e.g., 'icon', 'logo')
1903
+ */
1904
+ type?: 'icon' | 'logo';
1905
+
1906
+ /**
1907
+ * CDN hosted url of the logo (ready for display)
1908
+ */
1909
+ url?: string;
1910
+ }
1911
+
1912
+ export namespace Logo {
1913
+ export interface Color {
1914
+ /**
1915
+ * Color in hexadecimal format
1916
+ */
1917
+ hex?: string;
1918
+
1919
+ /**
1920
+ * Name of the color
1921
+ */
1922
+ name?: string;
1923
+ }
1924
+
1925
+ /**
1926
+ * Resolution of the logo image
1927
+ */
1928
+ export interface Resolution {
1929
+ /**
1930
+ * Aspect ratio of the image (width/height)
1931
+ */
1932
+ aspect_ratio?: number;
1933
+
1934
+ /**
1935
+ * Height of the image in pixels
1936
+ */
1937
+ height?: number;
1938
+
1939
+ /**
1940
+ * Width of the image in pixels
1941
+ */
1942
+ width?: number;
1943
+ }
1944
+ }
1945
+
1946
+ export interface Social {
1947
+ /**
1948
+ * Type of social media, e.g., 'facebook', 'twitter'
1949
+ */
1950
+ type?: string;
1951
+
1952
+ /**
1953
+ * URL of the social media page
1954
+ */
1955
+ url?: string;
1956
+ }
1957
+
1958
+ /**
1959
+ * Stock market information for this brand (will be null if not a publicly traded
1960
+ * company)
1961
+ */
1962
+ export interface Stock {
1963
+ /**
1964
+ * Stock exchange name
1965
+ */
1966
+ exchange?: string;
1967
+
1968
+ /**
1969
+ * Stock ticker symbol
1970
+ */
1971
+ ticker?: string;
1972
+ }
1973
+ }
1974
+ }
1975
+
1976
+ export interface BrandRetrieveByNameResponse {
1977
+ /**
1978
+ * Detailed brand information
1979
+ */
1980
+ brand?: BrandRetrieveByNameResponse.Brand;
1981
+
1982
+ /**
1983
+ * HTTP status code
1984
+ */
1985
+ code?: number;
1986
+
1987
+ /**
1988
+ * Status of the response, e.g., 'ok'
1989
+ */
1990
+ status?: string;
1991
+ }
1992
+
1993
+ export namespace BrandRetrieveByNameResponse {
1994
+ /**
1995
+ * Detailed brand information
1996
+ */
1997
+ export interface Brand {
1998
+ /**
1999
+ * Physical address of the brand
2000
+ */
2001
+ address?: Brand.Address;
2002
+
2003
+ /**
2004
+ * An array of backdrop images for the brand
2005
+ */
2006
+ backdrops?: Array<Brand.Backdrop>;
2007
+
2008
+ /**
2009
+ * An array of brand colors
2010
+ */
2011
+ colors?: Array<Brand.Color>;
2012
+
2013
+ /**
2014
+ * A brief description of the brand
2015
+ */
2016
+ description?: string;
2017
+
2018
+ /**
2019
+ * The domain name of the brand
2020
+ */
2021
+ domain?: string;
2022
+
2023
+ /**
2024
+ * Company email address
2025
+ */
2026
+ email?: string;
2027
+
2028
+ /**
2029
+ * Industry classification information for the brand
2030
+ */
2031
+ industries?: Brand.Industries;
2032
+
2033
+ /**
2034
+ * Indicates whether the brand content is not safe for work (NSFW)
2035
+ */
2036
+ is_nsfw?: boolean;
2037
+
2038
+ /**
2039
+ * Important website links for the brand
2040
+ */
2041
+ links?: Brand.Links;
2042
+
2043
+ /**
2044
+ * An array of logos associated with the brand
2045
+ */
2046
+ logos?: Array<Brand.Logo>;
2047
+
2048
+ /**
2049
+ * Company phone number
2050
+ */
2051
+ phone?: string;
2052
+
2053
+ /**
2054
+ * The brand's slogan
2055
+ */
2056
+ slogan?: string;
2057
+
2058
+ /**
2059
+ * An array of social media links for the brand
2060
+ */
2061
+ socials?: Array<Brand.Social>;
2062
+
2063
+ /**
2064
+ * Stock market information for this brand (will be null if not a publicly traded
2065
+ * company)
2066
+ */
2067
+ stock?: Brand.Stock;
2068
+
2069
+ /**
2070
+ * The title or name of the brand
2071
+ */
2072
+ title?: string;
2073
+ }
2074
+
2075
+ export namespace Brand {
2076
+ /**
2077
+ * Physical address of the brand
2078
+ */
2079
+ export interface Address {
2080
+ /**
2081
+ * City name
2082
+ */
2083
+ city?: string;
2084
+
2085
+ /**
2086
+ * Country name
2087
+ */
2088
+ country?: string;
2089
+
2090
+ /**
2091
+ * Country code
2092
+ */
2093
+ country_code?: string;
2094
+
2095
+ /**
2096
+ * Postal or ZIP code
2097
+ */
2098
+ postal_code?: string;
2099
+
2100
+ /**
2101
+ * State or province code
2102
+ */
2103
+ state_code?: string;
2104
+
2105
+ /**
2106
+ * State or province name
2107
+ */
2108
+ state_province?: string;
2109
+
2110
+ /**
2111
+ * Street address
2112
+ */
2113
+ street?: string;
2114
+ }
2115
+
2116
+ export interface Backdrop {
2117
+ /**
2118
+ * Array of colors in the backdrop image
2119
+ */
2120
+ colors?: Array<Backdrop.Color>;
2121
+
2122
+ /**
2123
+ * Resolution of the backdrop image
2124
+ */
2125
+ resolution?: Backdrop.Resolution;
2126
+
2127
+ /**
2128
+ * URL of the backdrop image
2129
+ */
2130
+ url?: string;
2131
+ }
2132
+
2133
+ export namespace Backdrop {
2134
+ export interface Color {
2135
+ /**
2136
+ * Color in hexadecimal format
2137
+ */
2138
+ hex?: string;
2139
+
2140
+ /**
2141
+ * Name of the color
2142
+ */
2143
+ name?: string;
2144
+ }
2145
+
2146
+ /**
2147
+ * Resolution of the backdrop image
2148
+ */
2149
+ export interface Resolution {
2150
+ /**
2151
+ * Aspect ratio of the image (width/height)
2152
+ */
2153
+ aspect_ratio?: number;
2154
+
2155
+ /**
2156
+ * Height of the image in pixels
2157
+ */
2158
+ height?: number;
2159
+
2160
+ /**
2161
+ * Width of the image in pixels
2162
+ */
2163
+ width?: number;
2164
+ }
2165
+ }
2166
+
2167
+ export interface Color {
2168
+ /**
2169
+ * Color in hexadecimal format
2170
+ */
2171
+ hex?: string;
2172
+
2173
+ /**
2174
+ * Name of the color
2175
+ */
2176
+ name?: string;
2177
+ }
2178
+
2179
+ /**
2180
+ * Industry classification information for the brand
2181
+ */
2182
+ export interface Industries {
2183
+ /**
2184
+ * Easy Industry Classification - array of industry and subindustry pairs
2185
+ */
2186
+ eic?: Array<Industries.Eic>;
2187
+ }
2188
+
2189
+ export namespace Industries {
2190
+ export interface Eic {
2191
+ /**
2192
+ * Industry classification enum
2193
+ */
2194
+ industry:
2195
+ | 'Aerospace & Defense'
2196
+ | 'Technology'
2197
+ | 'Finance'
2198
+ | 'Healthcare'
2199
+ | 'Retail & E-commerce'
2200
+ | 'Entertainment'
2201
+ | 'Education'
2202
+ | 'Government & Nonprofit'
2203
+ | 'Industrial & Energy'
2204
+ | 'Automotive & Transportation'
2205
+ | 'Lifestyle & Leisure'
2206
+ | 'Luxury & Fashion'
2207
+ | 'News & Media'
2208
+ | 'Sports'
2209
+ | 'Real Estate & PropTech'
2210
+ | 'Legal & Compliance'
2211
+ | 'Telecommunications'
2212
+ | 'Agriculture & Food'
2213
+ | 'Professional Services & Agencies'
2214
+ | 'Chemicals & Materials'
2215
+ | 'Logistics & Supply Chain'
2216
+ | 'Hospitality & Tourism'
2217
+ | 'Construction & Built Environment'
2218
+ | 'Consumer Packaged Goods (CPG)';
2219
+
2220
+ /**
2221
+ * Subindustry classification enum
2222
+ */
2223
+ subindustry:
2224
+ | 'Defense Systems & Military Hardware'
2225
+ | 'Aerospace Manufacturing'
2226
+ | 'Avionics & Navigation Technology'
2227
+ | 'Subsea & Naval Defense Systems'
2228
+ | 'Space & Satellite Technology'
2229
+ | 'Defense IT & Systems Integration'
2230
+ | 'Software (B2B)'
2231
+ | 'Software (B2C)'
2232
+ | 'Cloud Infrastructure & DevOps'
2233
+ | 'Cybersecurity'
2234
+ | 'Artificial Intelligence & Machine Learning'
2235
+ | 'Data Infrastructure & Analytics'
2236
+ | 'Hardware & Semiconductors'
2237
+ | 'Fintech Infrastructure'
2238
+ | 'eCommerce & Marketplace Platforms'
2239
+ | 'Developer Tools & APIs'
2240
+ | 'Web3 & Blockchain'
2241
+ | 'XR & Spatial Computing'
2242
+ | 'Banking & Lending'
2243
+ | 'Investment Management & WealthTech'
2244
+ | 'Insurance & InsurTech'
2245
+ | 'Payments & Money Movement'
2246
+ | 'Accounting, Tax & Financial Planning Tools'
2247
+ | 'Capital Markets & Trading Platforms'
2248
+ | 'Financial Infrastructure & APIs'
2249
+ | 'Credit Scoring & Risk Management'
2250
+ | 'Cryptocurrency & Digital Assets'
2251
+ | 'BNPL & Alternative Financing'
2252
+ | 'Healthcare Providers & Services'
2253
+ | 'Pharmaceuticals & Drug Development'
2254
+ | 'Medical Devices & Diagnostics'
2255
+ | 'Biotechnology & Genomics'
2256
+ | 'Digital Health & Telemedicine'
2257
+ | 'Health Insurance & Benefits Tech'
2258
+ | 'Clinical Trials & Research Platforms'
2259
+ | 'Mental Health & Wellness'
2260
+ | 'Healthcare IT & EHR Systems'
2261
+ | 'Consumer Health & Wellness Products'
2262
+ | 'Online Marketplaces'
2263
+ | 'Direct-to-Consumer (DTC) Brands'
2264
+ | 'Retail Tech & Point-of-Sale Systems'
2265
+ | 'Omnichannel & In-Store Retail'
2266
+ | 'E-commerce Enablement & Infrastructure'
2267
+ | 'Subscription & Membership Commerce'
2268
+ | 'Social Commerce & Influencer Platforms'
2269
+ | 'Fashion & Apparel Retail'
2270
+ | 'Food, Beverage & Grocery E-commerce'
2271
+ | 'Streaming Platforms (Video, Music, Audio)'
2272
+ | 'Gaming & Interactive Entertainment'
2273
+ | 'Creator Economy & Influencer Platforms'
2274
+ | 'Advertising, Adtech & Media Buying'
2275
+ | 'Film, TV & Production Studios'
2276
+ | 'Events, Venues & Live Entertainment'
2277
+ | 'Virtual Worlds & Metaverse Experiences'
2278
+ | 'K-12 Education Platforms & Tools'
2279
+ | 'Higher Education & University Tech'
2280
+ | 'Online Learning & MOOCs'
2281
+ | 'Test Prep & Certification'
2282
+ | 'Corporate Training & Upskilling'
2283
+ | 'Tutoring & Supplemental Learning'
2284
+ | 'Education Management Systems (LMS/SIS)'
2285
+ | 'Language Learning'
2286
+ | 'Creator-Led & Cohort-Based Courses'
2287
+ | 'Special Education & Accessibility Tools'
2288
+ | 'Government Technology & Digital Services'
2289
+ | 'Civic Engagement & Policy Platforms'
2290
+ | 'International Development & Humanitarian Aid'
2291
+ | 'Philanthropy & Grantmaking'
2292
+ | 'Nonprofit Operations & Fundraising Tools'
2293
+ | 'Public Health & Social Services'
2294
+ | 'Education & Youth Development Programs'
2295
+ | 'Environmental & Climate Action Organizations'
2296
+ | 'Legal Aid & Social Justice Advocacy'
2297
+ | 'Municipal & Infrastructure Services'
2298
+ | 'Manufacturing & Industrial Automation'
2299
+ | 'Energy Production (Oil, Gas, Nuclear)'
2300
+ | 'Renewable Energy & Cleantech'
2301
+ | 'Utilities & Grid Infrastructure'
2302
+ | 'Industrial IoT & Monitoring Systems'
2303
+ | 'Construction & Heavy Equipment'
2304
+ | 'Mining & Natural Resources'
2305
+ | 'Environmental Engineering & Sustainability'
2306
+ | 'Energy Storage & Battery Technology'
2307
+ | 'Automotive OEMs & Vehicle Manufacturing'
2308
+ | 'Electric Vehicles (EVs) & Charging Infrastructure'
2309
+ | 'Mobility-as-a-Service (MaaS)'
2310
+ | 'Fleet Management'
2311
+ | 'Public Transit & Urban Mobility'
2312
+ | 'Autonomous Vehicles & ADAS'
2313
+ | 'Aftermarket Parts & Services'
2314
+ | 'Telematics & Vehicle Connectivity'
2315
+ | 'Aviation & Aerospace Transport'
2316
+ | 'Maritime Shipping'
2317
+ | 'Fitness & Wellness'
2318
+ | 'Beauty & Personal Care'
2319
+ | 'Home & Living'
2320
+ | 'Dating & Relationships'
2321
+ | 'Hobbies, Crafts & DIY'
2322
+ | 'Outdoor & Recreational Gear'
2323
+ | 'Events, Experiences & Ticketing Platforms'
2324
+ | 'Designer & Luxury Apparel'
2325
+ | 'Accessories, Jewelry & Watches'
2326
+ | 'Footwear & Leather Goods'
2327
+ | 'Beauty, Fragrance & Skincare'
2328
+ | 'Fashion Marketplaces & Retail Platforms'
2329
+ | 'Sustainable & Ethical Fashion'
2330
+ | 'Resale, Vintage & Circular Fashion'
2331
+ | 'Fashion Tech & Virtual Try-Ons'
2332
+ | 'Streetwear & Emerging Luxury'
2333
+ | 'Couture & Made-to-Measure'
2334
+ | 'News Publishing & Journalism'
2335
+ | 'Digital Media & Content Platforms'
2336
+ | 'Broadcasting (TV & Radio)'
2337
+ | 'Podcasting & Audio Media'
2338
+ | 'News Aggregators & Curation Tools'
2339
+ | 'Independent & Creator-Led Media'
2340
+ | 'Newsletters & Substack-Style Platforms'
2341
+ | 'Political & Investigative Media'
2342
+ | 'Trade & Niche Publications'
2343
+ | 'Media Monitoring & Analytics'
2344
+ | 'Professional Teams & Leagues'
2345
+ | 'Sports Media & Broadcasting'
2346
+ | 'Sports Betting & Fantasy Sports'
2347
+ | 'Fitness & Athletic Training Platforms'
2348
+ | 'Sportswear & Equipment'
2349
+ | 'Esports & Competitive Gaming'
2350
+ | 'Sports Venues & Event Management'
2351
+ | 'Athlete Management & Talent Agencies'
2352
+ | 'Sports Tech & Performance Analytics'
2353
+ | 'Youth, Amateur & Collegiate Sports'
2354
+ | 'Real Estate Marketplaces'
2355
+ | 'Property Management Software'
2356
+ | 'Rental Platforms'
2357
+ | 'Mortgage & Lending Tech'
2358
+ | 'Real Estate Investment Platforms'
2359
+ | 'Law Firms & Legal Services'
2360
+ | 'Legal Tech & Automation'
2361
+ | 'Regulatory Compliance'
2362
+ | 'E-Discovery & Litigation Tools'
2363
+ | 'Contract Management'
2364
+ | 'Governance, Risk & Compliance (GRC)'
2365
+ | 'IP & Trademark Management'
2366
+ | 'Legal Research & Intelligence'
2367
+ | 'Compliance Training & Certification'
2368
+ | 'Whistleblower & Ethics Reporting'
2369
+ | 'Mobile & Wireless Networks (3G/4G/5G)'
2370
+ | 'Broadband & Fiber Internet'
2371
+ | 'Satellite & Space-Based Communications'
2372
+ | 'Network Equipment & Infrastructure'
2373
+ | 'Telecom Billing & OSS/BSS Systems'
2374
+ | 'VoIP & Unified Communications'
2375
+ | 'Internet Service Providers (ISPs)'
2376
+ | 'Edge Computing & Network Virtualization'
2377
+ | 'IoT Connectivity Platforms'
2378
+ | 'Precision Agriculture & AgTech'
2379
+ | 'Crop & Livestock Production'
2380
+ | 'Food & Beverage Manufacturing & Processing'
2381
+ | 'Food Distribution'
2382
+ | 'Restaurants & Food Service'
2383
+ | 'Agricultural Inputs & Equipment'
2384
+ | 'Sustainable & Regenerative Agriculture'
2385
+ | 'Seafood & Aquaculture'
2386
+ | 'Management Consulting'
2387
+ | 'Marketing & Advertising Agencies'
2388
+ | 'Design, Branding & Creative Studios'
2389
+ | 'IT Services & Managed Services'
2390
+ | 'Staffing, Recruiting & Talent'
2391
+ | 'Accounting & Tax Firms'
2392
+ | 'Public Relations & Communications'
2393
+ | 'Business Process Outsourcing (BPO)'
2394
+ | 'Professional Training & Coaching'
2395
+ | 'Specialty Chemicals'
2396
+ | 'Commodity & Petrochemicals'
2397
+ | 'Polymers, Plastics & Rubber'
2398
+ | 'Coatings, Adhesives & Sealants'
2399
+ | 'Industrial Gases'
2400
+ | 'Advanced Materials & Composites'
2401
+ | 'Battery Materials & Energy Storage'
2402
+ | 'Electronic Materials & Semiconductor Chemicals'
2403
+ | 'Agrochemicals & Fertilizers'
2404
+ | 'Freight & Transportation Tech'
2405
+ | 'Last-Mile Delivery'
2406
+ | 'Warehouse Automation'
2407
+ | 'Supply Chain Visibility Platforms'
2408
+ | 'Logistics Marketplaces'
2409
+ | 'Shipping & Freight Forwarding'
2410
+ | 'Cold Chain Logistics'
2411
+ | 'Reverse Logistics & Returns'
2412
+ | 'Cross-Border Trade Tech'
2413
+ | 'Transportation Management Systems (TMS)'
2414
+ | 'Hotels & Accommodation'
2415
+ | 'Vacation Rentals & Short-Term Stays'
2416
+ | 'Restaurant Tech & Management'
2417
+ | 'Travel Booking Platforms'
2418
+ | 'Tourism Experiences & Activities'
2419
+ | 'Cruise Lines & Marine Tourism'
2420
+ | 'Hospitality Management Systems'
2421
+ | 'Event & Venue Management'
2422
+ | 'Corporate Travel Management'
2423
+ | 'Travel Insurance & Protection'
2424
+ | 'Construction Management Software'
2425
+ | 'BIM/CAD & Design Tools'
2426
+ | 'Construction Marketplaces'
2427
+ | 'Equipment Rental & Management'
2428
+ | 'Building Materials & Procurement'
2429
+ | 'Construction Workforce Management'
2430
+ | 'Project Estimation & Bidding'
2431
+ | 'Modular & Prefab Construction'
2432
+ | 'Construction Safety & Compliance'
2433
+ | 'Smart Building Technology'
2434
+ | 'Food & Beverage CPG'
2435
+ | 'Home & Personal Care CPG'
2436
+ | 'CPG Analytics & Insights'
2437
+ | 'Direct-to-Consumer CPG Brands'
2438
+ | 'CPG Supply Chain & Distribution'
2439
+ | 'Private Label Manufacturing'
2440
+ | 'CPG Retail Intelligence'
2441
+ | 'Sustainable CPG & Packaging'
2442
+ | 'Beauty & Cosmetics CPG'
2443
+ | 'Health & Wellness CPG';
2444
+ }
2445
+ }
2446
+
2447
+ /**
2448
+ * Important website links for the brand
2449
+ */
2450
+ export interface Links {
2451
+ /**
2452
+ * URL to the brand's blog or news page
2453
+ */
2454
+ blog?: string | null;
2455
+
2456
+ /**
2457
+ * URL to the brand's careers or job opportunities page
2458
+ */
2459
+ careers?: string | null;
2460
+
2461
+ /**
2462
+ * URL to the brand's contact or contact us page
2463
+ */
2464
+ contact?: string | null;
2465
+
2466
+ /**
2467
+ * URL to the brand's pricing or plans page
2468
+ */
2469
+ pricing?: string | null;
2470
+
2471
+ /**
2472
+ * URL to the brand's privacy policy page
2473
+ */
2474
+ privacy?: string | null;
2475
+
2476
+ /**
2477
+ * URL to the brand's terms of service or terms and conditions page
2478
+ */
2479
+ terms?: string | null;
2480
+ }
2481
+
2482
+ export interface Logo {
2483
+ /**
2484
+ * Array of colors in the logo
2485
+ */
2486
+ colors?: Array<Logo.Color>;
2487
+
2488
+ /**
2489
+ * Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
2490
+ * best for dark mode, 'has_opaque_background' = can be used for either as image
2491
+ * has its own background
2492
+ */
2493
+ mode?: 'light' | 'dark' | 'has_opaque_background';
2494
+
2495
+ /**
2496
+ * Resolution of the logo image
2497
+ */
2498
+ resolution?: Logo.Resolution;
2499
+
2500
+ /**
2501
+ * Type of the logo based on resolution (e.g., 'icon', 'logo')
2502
+ */
2503
+ type?: 'icon' | 'logo';
2504
+
2505
+ /**
2506
+ * CDN hosted url of the logo (ready for display)
2507
+ */
2508
+ url?: string;
2509
+ }
2510
+
2511
+ export namespace Logo {
2512
+ export interface Color {
2513
+ /**
2514
+ * Color in hexadecimal format
2515
+ */
2516
+ hex?: string;
2517
+
2518
+ /**
2519
+ * Name of the color
2520
+ */
2521
+ name?: string;
2522
+ }
2523
+
2524
+ /**
2525
+ * Resolution of the logo image
2526
+ */
2527
+ export interface Resolution {
2528
+ /**
2529
+ * Aspect ratio of the image (width/height)
2530
+ */
2531
+ aspect_ratio?: number;
2532
+
2533
+ /**
2534
+ * Height of the image in pixels
2535
+ */
2536
+ height?: number;
2537
+
2538
+ /**
2539
+ * Width of the image in pixels
2540
+ */
2541
+ width?: number;
2542
+ }
2543
+ }
2544
+
2545
+ export interface Social {
2546
+ /**
2547
+ * Type of social media, e.g., 'facebook', 'twitter'
2548
+ */
2549
+ type?: string;
2550
+
2551
+ /**
2552
+ * URL of the social media page
2553
+ */
2554
+ url?: string;
2555
+ }
2556
+
2557
+ /**
2558
+ * Stock market information for this brand (will be null if not a publicly traded
2559
+ * company)
2560
+ */
2561
+ export interface Stock {
2562
+ /**
2563
+ * Stock exchange name
2564
+ */
2565
+ exchange?: string;
2566
+
2567
+ /**
2568
+ * Stock ticker symbol
2569
+ */
2570
+ ticker?: string;
2571
+ }
2572
+ }
2573
+ }
2574
+
2575
+ export interface BrandRetrieveByTickerResponse {
2576
+ /**
2577
+ * Detailed brand information
2578
+ */
2579
+ brand?: BrandRetrieveByTickerResponse.Brand;
2580
+
2581
+ /**
2582
+ * HTTP status code
2583
+ */
2584
+ code?: number;
2585
+
2586
+ /**
2587
+ * Status of the response, e.g., 'ok'
2588
+ */
2589
+ status?: string;
2590
+ }
2591
+
2592
+ export namespace BrandRetrieveByTickerResponse {
2593
+ /**
2594
+ * Detailed brand information
2595
+ */
2596
+ export interface Brand {
2597
+ /**
2598
+ * Physical address of the brand
2599
+ */
2600
+ address?: Brand.Address;
2601
+
2602
+ /**
2603
+ * An array of backdrop images for the brand
2604
+ */
2605
+ backdrops?: Array<Brand.Backdrop>;
2606
+
2607
+ /**
2608
+ * An array of brand colors
2609
+ */
2610
+ colors?: Array<Brand.Color>;
2611
+
2612
+ /**
2613
+ * A brief description of the brand
2614
+ */
2615
+ description?: string;
2616
+
2617
+ /**
2618
+ * The domain name of the brand
2619
+ */
2620
+ domain?: string;
2621
+
2622
+ /**
2623
+ * Company email address
2624
+ */
2625
+ email?: string;
2626
+
2627
+ /**
2628
+ * Industry classification information for the brand
2629
+ */
2630
+ industries?: Brand.Industries;
2631
+
2632
+ /**
2633
+ * Indicates whether the brand content is not safe for work (NSFW)
2634
+ */
2635
+ is_nsfw?: boolean;
2636
+
2637
+ /**
2638
+ * Important website links for the brand
2639
+ */
2640
+ links?: Brand.Links;
2641
+
2642
+ /**
2643
+ * An array of logos associated with the brand
2644
+ */
2645
+ logos?: Array<Brand.Logo>;
2646
+
2647
+ /**
2648
+ * Company phone number
2649
+ */
2650
+ phone?: string;
2651
+
2652
+ /**
2653
+ * The brand's slogan
2654
+ */
2655
+ slogan?: string;
2656
+
2657
+ /**
2658
+ * An array of social media links for the brand
2659
+ */
2660
+ socials?: Array<Brand.Social>;
2661
+
2662
+ /**
2663
+ * Stock market information for this brand (will be null if not a publicly traded
2664
+ * company)
2665
+ */
2666
+ stock?: Brand.Stock;
2667
+
2668
+ /**
2669
+ * The title or name of the brand
2670
+ */
2671
+ title?: string;
2672
+ }
2673
+
2674
+ export namespace Brand {
2675
+ /**
2676
+ * Physical address of the brand
2677
+ */
2678
+ export interface Address {
2679
+ /**
2680
+ * City name
2681
+ */
2682
+ city?: string;
2683
+
2684
+ /**
2685
+ * Country name
2686
+ */
2687
+ country?: string;
2688
+
2689
+ /**
2690
+ * Country code
2691
+ */
2692
+ country_code?: string;
2693
+
2694
+ /**
2695
+ * Postal or ZIP code
2696
+ */
2697
+ postal_code?: string;
2698
+
2699
+ /**
2700
+ * State or province code
2701
+ */
2702
+ state_code?: string;
2703
+
2704
+ /**
2705
+ * State or province name
2706
+ */
2707
+ state_province?: string;
2708
+
2709
+ /**
2710
+ * Street address
2711
+ */
2712
+ street?: string;
2713
+ }
2714
+
2715
+ export interface Backdrop {
2716
+ /**
2717
+ * Array of colors in the backdrop image
2718
+ */
2719
+ colors?: Array<Backdrop.Color>;
2720
+
2721
+ /**
2722
+ * Resolution of the backdrop image
2723
+ */
2724
+ resolution?: Backdrop.Resolution;
2725
+
2726
+ /**
2727
+ * URL of the backdrop image
2728
+ */
2729
+ url?: string;
2730
+ }
2731
+
2732
+ export namespace Backdrop {
2733
+ export interface Color {
2734
+ /**
2735
+ * Color in hexadecimal format
2736
+ */
2737
+ hex?: string;
2738
+
2739
+ /**
2740
+ * Name of the color
2741
+ */
2742
+ name?: string;
2743
+ }
2744
+
2745
+ /**
2746
+ * Resolution of the backdrop image
2747
+ */
2748
+ export interface Resolution {
2749
+ /**
2750
+ * Aspect ratio of the image (width/height)
2751
+ */
2752
+ aspect_ratio?: number;
2753
+
2754
+ /**
2755
+ * Height of the image in pixels
2756
+ */
2757
+ height?: number;
2758
+
2759
+ /**
2760
+ * Width of the image in pixels
2761
+ */
2762
+ width?: number;
2763
+ }
2764
+ }
2765
+
2766
+ export interface Color {
2767
+ /**
2768
+ * Color in hexadecimal format
2769
+ */
2770
+ hex?: string;
2771
+
2772
+ /**
2773
+ * Name of the color
2774
+ */
2775
+ name?: string;
2776
+ }
2777
+
2778
+ /**
2779
+ * Industry classification information for the brand
2780
+ */
2781
+ export interface Industries {
2782
+ /**
2783
+ * Easy Industry Classification - array of industry and subindustry pairs
2784
+ */
2785
+ eic?: Array<Industries.Eic>;
2786
+ }
2787
+
2788
+ export namespace Industries {
2789
+ export interface Eic {
2790
+ /**
2791
+ * Industry classification enum
2792
+ */
2793
+ industry:
2794
+ | 'Aerospace & Defense'
2795
+ | 'Technology'
2796
+ | 'Finance'
2797
+ | 'Healthcare'
2798
+ | 'Retail & E-commerce'
2799
+ | 'Entertainment'
2800
+ | 'Education'
2801
+ | 'Government & Nonprofit'
2802
+ | 'Industrial & Energy'
2803
+ | 'Automotive & Transportation'
2804
+ | 'Lifestyle & Leisure'
2805
+ | 'Luxury & Fashion'
2806
+ | 'News & Media'
2807
+ | 'Sports'
2808
+ | 'Real Estate & PropTech'
2809
+ | 'Legal & Compliance'
2810
+ | 'Telecommunications'
2811
+ | 'Agriculture & Food'
2812
+ | 'Professional Services & Agencies'
2813
+ | 'Chemicals & Materials'
2814
+ | 'Logistics & Supply Chain'
2815
+ | 'Hospitality & Tourism'
2816
+ | 'Construction & Built Environment'
2817
+ | 'Consumer Packaged Goods (CPG)';
2818
+
2819
+ /**
2820
+ * Subindustry classification enum
2821
+ */
2822
+ subindustry:
2823
+ | 'Defense Systems & Military Hardware'
2824
+ | 'Aerospace Manufacturing'
2825
+ | 'Avionics & Navigation Technology'
2826
+ | 'Subsea & Naval Defense Systems'
2827
+ | 'Space & Satellite Technology'
2828
+ | 'Defense IT & Systems Integration'
2829
+ | 'Software (B2B)'
2830
+ | 'Software (B2C)'
2831
+ | 'Cloud Infrastructure & DevOps'
2832
+ | 'Cybersecurity'
2833
+ | 'Artificial Intelligence & Machine Learning'
2834
+ | 'Data Infrastructure & Analytics'
2835
+ | 'Hardware & Semiconductors'
2836
+ | 'Fintech Infrastructure'
2837
+ | 'eCommerce & Marketplace Platforms'
2838
+ | 'Developer Tools & APIs'
2839
+ | 'Web3 & Blockchain'
2840
+ | 'XR & Spatial Computing'
2841
+ | 'Banking & Lending'
2842
+ | 'Investment Management & WealthTech'
2843
+ | 'Insurance & InsurTech'
2844
+ | 'Payments & Money Movement'
2845
+ | 'Accounting, Tax & Financial Planning Tools'
2846
+ | 'Capital Markets & Trading Platforms'
2847
+ | 'Financial Infrastructure & APIs'
2848
+ | 'Credit Scoring & Risk Management'
2849
+ | 'Cryptocurrency & Digital Assets'
2850
+ | 'BNPL & Alternative Financing'
2851
+ | 'Healthcare Providers & Services'
2852
+ | 'Pharmaceuticals & Drug Development'
2853
+ | 'Medical Devices & Diagnostics'
2854
+ | 'Biotechnology & Genomics'
2855
+ | 'Digital Health & Telemedicine'
2856
+ | 'Health Insurance & Benefits Tech'
2857
+ | 'Clinical Trials & Research Platforms'
2858
+ | 'Mental Health & Wellness'
2859
+ | 'Healthcare IT & EHR Systems'
2860
+ | 'Consumer Health & Wellness Products'
2861
+ | 'Online Marketplaces'
2862
+ | 'Direct-to-Consumer (DTC) Brands'
2863
+ | 'Retail Tech & Point-of-Sale Systems'
2864
+ | 'Omnichannel & In-Store Retail'
2865
+ | 'E-commerce Enablement & Infrastructure'
2866
+ | 'Subscription & Membership Commerce'
2867
+ | 'Social Commerce & Influencer Platforms'
2868
+ | 'Fashion & Apparel Retail'
2869
+ | 'Food, Beverage & Grocery E-commerce'
2870
+ | 'Streaming Platforms (Video, Music, Audio)'
2871
+ | 'Gaming & Interactive Entertainment'
2872
+ | 'Creator Economy & Influencer Platforms'
2873
+ | 'Advertising, Adtech & Media Buying'
2874
+ | 'Film, TV & Production Studios'
2875
+ | 'Events, Venues & Live Entertainment'
2876
+ | 'Virtual Worlds & Metaverse Experiences'
2877
+ | 'K-12 Education Platforms & Tools'
2878
+ | 'Higher Education & University Tech'
2879
+ | 'Online Learning & MOOCs'
2880
+ | 'Test Prep & Certification'
2881
+ | 'Corporate Training & Upskilling'
2882
+ | 'Tutoring & Supplemental Learning'
2883
+ | 'Education Management Systems (LMS/SIS)'
2884
+ | 'Language Learning'
2885
+ | 'Creator-Led & Cohort-Based Courses'
2886
+ | 'Special Education & Accessibility Tools'
2887
+ | 'Government Technology & Digital Services'
2888
+ | 'Civic Engagement & Policy Platforms'
2889
+ | 'International Development & Humanitarian Aid'
2890
+ | 'Philanthropy & Grantmaking'
2891
+ | 'Nonprofit Operations & Fundraising Tools'
2892
+ | 'Public Health & Social Services'
2893
+ | 'Education & Youth Development Programs'
2894
+ | 'Environmental & Climate Action Organizations'
2895
+ | 'Legal Aid & Social Justice Advocacy'
2896
+ | 'Municipal & Infrastructure Services'
2897
+ | 'Manufacturing & Industrial Automation'
2898
+ | 'Energy Production (Oil, Gas, Nuclear)'
2899
+ | 'Renewable Energy & Cleantech'
2900
+ | 'Utilities & Grid Infrastructure'
2901
+ | 'Industrial IoT & Monitoring Systems'
2902
+ | 'Construction & Heavy Equipment'
2903
+ | 'Mining & Natural Resources'
2904
+ | 'Environmental Engineering & Sustainability'
2905
+ | 'Energy Storage & Battery Technology'
2906
+ | 'Automotive OEMs & Vehicle Manufacturing'
2907
+ | 'Electric Vehicles (EVs) & Charging Infrastructure'
2908
+ | 'Mobility-as-a-Service (MaaS)'
2909
+ | 'Fleet Management'
2910
+ | 'Public Transit & Urban Mobility'
2911
+ | 'Autonomous Vehicles & ADAS'
2912
+ | 'Aftermarket Parts & Services'
2913
+ | 'Telematics & Vehicle Connectivity'
2914
+ | 'Aviation & Aerospace Transport'
2915
+ | 'Maritime Shipping'
2916
+ | 'Fitness & Wellness'
2917
+ | 'Beauty & Personal Care'
2918
+ | 'Home & Living'
2919
+ | 'Dating & Relationships'
2920
+ | 'Hobbies, Crafts & DIY'
2921
+ | 'Outdoor & Recreational Gear'
2922
+ | 'Events, Experiences & Ticketing Platforms'
2923
+ | 'Designer & Luxury Apparel'
2924
+ | 'Accessories, Jewelry & Watches'
2925
+ | 'Footwear & Leather Goods'
2926
+ | 'Beauty, Fragrance & Skincare'
2927
+ | 'Fashion Marketplaces & Retail Platforms'
2928
+ | 'Sustainable & Ethical Fashion'
2929
+ | 'Resale, Vintage & Circular Fashion'
2930
+ | 'Fashion Tech & Virtual Try-Ons'
2931
+ | 'Streetwear & Emerging Luxury'
2932
+ | 'Couture & Made-to-Measure'
2933
+ | 'News Publishing & Journalism'
2934
+ | 'Digital Media & Content Platforms'
2935
+ | 'Broadcasting (TV & Radio)'
2936
+ | 'Podcasting & Audio Media'
2937
+ | 'News Aggregators & Curation Tools'
2938
+ | 'Independent & Creator-Led Media'
2939
+ | 'Newsletters & Substack-Style Platforms'
2940
+ | 'Political & Investigative Media'
2941
+ | 'Trade & Niche Publications'
2942
+ | 'Media Monitoring & Analytics'
2943
+ | 'Professional Teams & Leagues'
2944
+ | 'Sports Media & Broadcasting'
2945
+ | 'Sports Betting & Fantasy Sports'
2946
+ | 'Fitness & Athletic Training Platforms'
2947
+ | 'Sportswear & Equipment'
2948
+ | 'Esports & Competitive Gaming'
2949
+ | 'Sports Venues & Event Management'
2950
+ | 'Athlete Management & Talent Agencies'
2951
+ | 'Sports Tech & Performance Analytics'
2952
+ | 'Youth, Amateur & Collegiate Sports'
2953
+ | 'Real Estate Marketplaces'
2954
+ | 'Property Management Software'
2955
+ | 'Rental Platforms'
2956
+ | 'Mortgage & Lending Tech'
2957
+ | 'Real Estate Investment Platforms'
2958
+ | 'Law Firms & Legal Services'
2959
+ | 'Legal Tech & Automation'
2960
+ | 'Regulatory Compliance'
2961
+ | 'E-Discovery & Litigation Tools'
2962
+ | 'Contract Management'
2963
+ | 'Governance, Risk & Compliance (GRC)'
2964
+ | 'IP & Trademark Management'
2965
+ | 'Legal Research & Intelligence'
2966
+ | 'Compliance Training & Certification'
2967
+ | 'Whistleblower & Ethics Reporting'
2968
+ | 'Mobile & Wireless Networks (3G/4G/5G)'
2969
+ | 'Broadband & Fiber Internet'
2970
+ | 'Satellite & Space-Based Communications'
2971
+ | 'Network Equipment & Infrastructure'
2972
+ | 'Telecom Billing & OSS/BSS Systems'
2973
+ | 'VoIP & Unified Communications'
2974
+ | 'Internet Service Providers (ISPs)'
2975
+ | 'Edge Computing & Network Virtualization'
2976
+ | 'IoT Connectivity Platforms'
2977
+ | 'Precision Agriculture & AgTech'
2978
+ | 'Crop & Livestock Production'
2979
+ | 'Food & Beverage Manufacturing & Processing'
2980
+ | 'Food Distribution'
2981
+ | 'Restaurants & Food Service'
2982
+ | 'Agricultural Inputs & Equipment'
2983
+ | 'Sustainable & Regenerative Agriculture'
2984
+ | 'Seafood & Aquaculture'
2985
+ | 'Management Consulting'
2986
+ | 'Marketing & Advertising Agencies'
2987
+ | 'Design, Branding & Creative Studios'
2988
+ | 'IT Services & Managed Services'
2989
+ | 'Staffing, Recruiting & Talent'
2990
+ | 'Accounting & Tax Firms'
2991
+ | 'Public Relations & Communications'
2992
+ | 'Business Process Outsourcing (BPO)'
2993
+ | 'Professional Training & Coaching'
2994
+ | 'Specialty Chemicals'
2995
+ | 'Commodity & Petrochemicals'
2996
+ | 'Polymers, Plastics & Rubber'
2997
+ | 'Coatings, Adhesives & Sealants'
2998
+ | 'Industrial Gases'
2999
+ | 'Advanced Materials & Composites'
3000
+ | 'Battery Materials & Energy Storage'
3001
+ | 'Electronic Materials & Semiconductor Chemicals'
3002
+ | 'Agrochemicals & Fertilizers'
3003
+ | 'Freight & Transportation Tech'
3004
+ | 'Last-Mile Delivery'
3005
+ | 'Warehouse Automation'
3006
+ | 'Supply Chain Visibility Platforms'
3007
+ | 'Logistics Marketplaces'
3008
+ | 'Shipping & Freight Forwarding'
3009
+ | 'Cold Chain Logistics'
3010
+ | 'Reverse Logistics & Returns'
3011
+ | 'Cross-Border Trade Tech'
3012
+ | 'Transportation Management Systems (TMS)'
3013
+ | 'Hotels & Accommodation'
3014
+ | 'Vacation Rentals & Short-Term Stays'
3015
+ | 'Restaurant Tech & Management'
3016
+ | 'Travel Booking Platforms'
3017
+ | 'Tourism Experiences & Activities'
3018
+ | 'Cruise Lines & Marine Tourism'
3019
+ | 'Hospitality Management Systems'
3020
+ | 'Event & Venue Management'
3021
+ | 'Corporate Travel Management'
3022
+ | 'Travel Insurance & Protection'
3023
+ | 'Construction Management Software'
3024
+ | 'BIM/CAD & Design Tools'
3025
+ | 'Construction Marketplaces'
3026
+ | 'Equipment Rental & Management'
3027
+ | 'Building Materials & Procurement'
3028
+ | 'Construction Workforce Management'
3029
+ | 'Project Estimation & Bidding'
3030
+ | 'Modular & Prefab Construction'
3031
+ | 'Construction Safety & Compliance'
3032
+ | 'Smart Building Technology'
3033
+ | 'Food & Beverage CPG'
3034
+ | 'Home & Personal Care CPG'
3035
+ | 'CPG Analytics & Insights'
3036
+ | 'Direct-to-Consumer CPG Brands'
3037
+ | 'CPG Supply Chain & Distribution'
3038
+ | 'Private Label Manufacturing'
3039
+ | 'CPG Retail Intelligence'
3040
+ | 'Sustainable CPG & Packaging'
3041
+ | 'Beauty & Cosmetics CPG'
3042
+ | 'Health & Wellness CPG';
3043
+ }
3044
+ }
3045
+
3046
+ /**
3047
+ * Important website links for the brand
3048
+ */
3049
+ export interface Links {
3050
+ /**
3051
+ * URL to the brand's blog or news page
3052
+ */
3053
+ blog?: string | null;
3054
+
3055
+ /**
3056
+ * URL to the brand's careers or job opportunities page
3057
+ */
3058
+ careers?: string | null;
3059
+
3060
+ /**
3061
+ * URL to the brand's contact or contact us page
3062
+ */
3063
+ contact?: string | null;
3064
+
3065
+ /**
3066
+ * URL to the brand's pricing or plans page
3067
+ */
3068
+ pricing?: string | null;
3069
+
3070
+ /**
3071
+ * URL to the brand's privacy policy page
3072
+ */
3073
+ privacy?: string | null;
3074
+
3075
+ /**
3076
+ * URL to the brand's terms of service or terms and conditions page
3077
+ */
3078
+ terms?: string | null;
3079
+ }
3080
+
3081
+ export interface Logo {
3082
+ /**
3083
+ * Array of colors in the logo
3084
+ */
3085
+ colors?: Array<Logo.Color>;
3086
+
3087
+ /**
3088
+ * Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
3089
+ * best for dark mode, 'has_opaque_background' = can be used for either as image
3090
+ * has its own background
3091
+ */
3092
+ mode?: 'light' | 'dark' | 'has_opaque_background';
3093
+
3094
+ /**
3095
+ * Resolution of the logo image
3096
+ */
3097
+ resolution?: Logo.Resolution;
3098
+
3099
+ /**
3100
+ * Type of the logo based on resolution (e.g., 'icon', 'logo')
3101
+ */
3102
+ type?: 'icon' | 'logo';
3103
+
3104
+ /**
3105
+ * CDN hosted url of the logo (ready for display)
3106
+ */
3107
+ url?: string;
3108
+ }
3109
+
3110
+ export namespace Logo {
3111
+ export interface Color {
3112
+ /**
3113
+ * Color in hexadecimal format
3114
+ */
3115
+ hex?: string;
3116
+
3117
+ /**
3118
+ * Name of the color
3119
+ */
3120
+ name?: string;
3121
+ }
3122
+
3123
+ /**
3124
+ * Resolution of the logo image
3125
+ */
3126
+ export interface Resolution {
3127
+ /**
3128
+ * Aspect ratio of the image (width/height)
3129
+ */
3130
+ aspect_ratio?: number;
3131
+
3132
+ /**
3133
+ * Height of the image in pixels
3134
+ */
3135
+ height?: number;
3136
+
3137
+ /**
3138
+ * Width of the image in pixels
3139
+ */
3140
+ width?: number;
3141
+ }
3142
+ }
3143
+
3144
+ export interface Social {
3145
+ /**
3146
+ * Type of social media, e.g., 'facebook', 'twitter'
3147
+ */
3148
+ type?: string;
3149
+
3150
+ /**
3151
+ * URL of the social media page
3152
+ */
3153
+ url?: string;
3154
+ }
3155
+
3156
+ /**
3157
+ * Stock market information for this brand (will be null if not a publicly traded
3158
+ * company)
3159
+ */
3160
+ export interface Stock {
3161
+ /**
3162
+ * Stock exchange name
3163
+ */
3164
+ exchange?: string;
3165
+
3166
+ /**
3167
+ * Stock ticker symbol
3168
+ */
3169
+ ticker?: string;
3170
+ }
3171
+ }
3172
+ }
3173
+
3174
+ export interface BrandRetrieveNaicsResponse {
3175
+ /**
3176
+ * Array of NAICS codes and titles.
3177
+ */
3178
+ codes?: Array<BrandRetrieveNaicsResponse.Code>;
3179
+
3180
+ /**
3181
+ * Domain found for the brand
3182
+ */
3183
+ domain?: string;
3184
+
3185
+ /**
3186
+ * Status of the response, e.g., 'ok'
3187
+ */
3188
+ status?: string;
3189
+
3190
+ /**
3191
+ * Industry classification type, for naics api it will be `naics`
3192
+ */
3193
+ type?: string;
3194
+ }
3195
+
3196
+ export namespace BrandRetrieveNaicsResponse {
3197
+ export interface Code {
3198
+ /**
3199
+ * NAICS code
3200
+ */
3201
+ code?: string;
3202
+
3203
+ /**
3204
+ * NAICS title
3205
+ */
3206
+ title?: string;
3207
+ }
3208
+ }
3209
+
3210
+ export interface BrandRetrieveSimplifiedResponse {
3211
+ /**
3212
+ * Simplified brand information
3213
+ */
3214
+ brand?: BrandRetrieveSimplifiedResponse.Brand;
3215
+
3216
+ /**
3217
+ * HTTP status code of the response
3218
+ */
3219
+ code?: number;
3220
+
3221
+ /**
3222
+ * Status of the response, e.g., 'ok'
3223
+ */
3224
+ status?: string;
3225
+ }
3226
+
3227
+ export namespace BrandRetrieveSimplifiedResponse {
3228
+ /**
3229
+ * Simplified brand information
3230
+ */
3231
+ export interface Brand {
3232
+ /**
3233
+ * An array of backdrop images for the brand
3234
+ */
3235
+ backdrops?: Array<Brand.Backdrop>;
3236
+
3237
+ /**
3238
+ * An array of brand colors
3239
+ */
3240
+ colors?: Array<Brand.Color>;
3241
+
3242
+ /**
3243
+ * The domain name of the brand
3244
+ */
3245
+ domain?: string;
3246
+
3247
+ /**
3248
+ * An array of logos associated with the brand
3249
+ */
3250
+ logos?: Array<Brand.Logo>;
3251
+
3252
+ /**
3253
+ * The title or name of the brand
3254
+ */
3255
+ title?: string;
3256
+ }
3257
+
3258
+ export namespace Brand {
3259
+ export interface Backdrop {
3260
+ /**
3261
+ * Array of colors in the backdrop image
3262
+ */
3263
+ colors?: Array<Backdrop.Color>;
3264
+
3265
+ /**
3266
+ * Resolution of the backdrop image
3267
+ */
3268
+ resolution?: Backdrop.Resolution;
3269
+
3270
+ /**
3271
+ * URL of the backdrop image
3272
+ */
3273
+ url?: string;
3274
+ }
3275
+
3276
+ export namespace Backdrop {
3277
+ export interface Color {
3278
+ /**
3279
+ * Color in hexadecimal format
3280
+ */
3281
+ hex?: string;
3282
+
3283
+ /**
3284
+ * Name of the color
3285
+ */
3286
+ name?: string;
3287
+ }
3288
+
3289
+ /**
3290
+ * Resolution of the backdrop image
3291
+ */
3292
+ export interface Resolution {
3293
+ /**
3294
+ * Aspect ratio of the image (width/height)
3295
+ */
3296
+ aspect_ratio?: number;
3297
+
3298
+ /**
3299
+ * Height of the image in pixels
3300
+ */
3301
+ height?: number;
3302
+
3303
+ /**
3304
+ * Width of the image in pixels
3305
+ */
3306
+ width?: number;
3307
+ }
3308
+ }
3309
+
3310
+ export interface Color {
3311
+ /**
3312
+ * Color in hexadecimal format
3313
+ */
3314
+ hex?: string;
3315
+
3316
+ /**
3317
+ * Name of the color
3318
+ */
3319
+ name?: string;
3320
+ }
3321
+
3322
+ export interface Logo {
3323
+ /**
3324
+ * Array of colors in the logo
3325
+ */
3326
+ colors?: Array<Logo.Color>;
3327
+
3328
+ /**
3329
+ * Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
3330
+ * best for dark mode, 'has_opaque_background' = can be used for either as image
3331
+ * has its own background
3332
+ */
3333
+ mode?: 'light' | 'dark' | 'has_opaque_background';
3334
+
3335
+ /**
3336
+ * Resolution of the logo image
3337
+ */
3338
+ resolution?: Logo.Resolution;
3339
+
3340
+ /**
3341
+ * Type of the logo based on resolution (e.g., 'icon', 'logo')
3342
+ */
3343
+ type?: 'icon' | 'logo';
3344
+
3345
+ /**
3346
+ * CDN hosted url of the logo (ready for display)
3347
+ */
3348
+ url?: string;
3349
+ }
3350
+
3351
+ export namespace Logo {
3352
+ export interface Color {
3353
+ /**
3354
+ * Color in hexadecimal format
3355
+ */
3356
+ hex?: string;
3357
+
3358
+ /**
3359
+ * Name of the color
3360
+ */
3361
+ name?: string;
3362
+ }
3363
+
3364
+ /**
3365
+ * Resolution of the logo image
3366
+ */
3367
+ export interface Resolution {
3368
+ /**
3369
+ * Aspect ratio of the image (width/height)
3370
+ */
3371
+ aspect_ratio?: number;
3372
+
3373
+ /**
3374
+ * Height of the image in pixels
3375
+ */
3376
+ height?: number;
3377
+
3378
+ /**
3379
+ * Width of the image in pixels
3380
+ */
3381
+ width?: number;
3382
+ }
3383
+ }
3384
+ }
3385
+ }
3386
+
3387
+ export interface BrandScreenshotResponse {
3388
+ /**
3389
+ * HTTP status code
3390
+ */
3391
+ code?: number;
3392
+
3393
+ /**
3394
+ * The normalized domain that was processed
3395
+ */
3396
+ domain?: string;
3397
+
3398
+ /**
3399
+ * Public URL of the uploaded screenshot image
3400
+ */
3401
+ screenshot?: string;
3402
+
1571
3403
  /**
1572
3404
  * Type of screenshot that was captured
1573
3405
  */
@@ -1881,91 +3713,435 @@ export namespace BrandStyleguideResponse {
1881
3713
  export interface Headings {
1882
3714
  h1?: Headings.H1;
1883
3715
 
1884
- h2?: Headings.H2;
3716
+ h2?: Headings.H2;
3717
+
3718
+ h3?: Headings.H3;
3719
+
3720
+ h4?: Headings.H4;
3721
+ }
3722
+
3723
+ export namespace Headings {
3724
+ export interface H1 {
3725
+ fontFamily?: string;
3726
+
3727
+ fontSize?: string;
3728
+
3729
+ fontWeight?: number;
3730
+
3731
+ letterSpacing?: string;
3732
+
3733
+ lineHeight?: string;
3734
+ }
3735
+
3736
+ export interface H2 {
3737
+ fontFamily?: string;
3738
+
3739
+ fontSize?: string;
3740
+
3741
+ fontWeight?: number;
3742
+
3743
+ letterSpacing?: string;
3744
+
3745
+ lineHeight?: string;
3746
+ }
3747
+
3748
+ export interface H3 {
3749
+ fontFamily?: string;
3750
+
3751
+ fontSize?: string;
3752
+
3753
+ fontWeight?: number;
3754
+
3755
+ letterSpacing?: string;
3756
+
3757
+ lineHeight?: string;
3758
+ }
3759
+
3760
+ export interface H4 {
3761
+ fontFamily?: string;
3762
+
3763
+ fontSize?: string;
3764
+
3765
+ fontWeight?: number;
3766
+
3767
+ letterSpacing?: string;
3768
+
3769
+ lineHeight?: string;
3770
+ }
3771
+ }
3772
+
3773
+ /**
3774
+ * Paragraph text styles
3775
+ */
3776
+ export interface P {
3777
+ fontFamily?: string;
3778
+
3779
+ fontSize?: string;
3780
+
3781
+ fontWeight?: number;
3782
+
3783
+ letterSpacing?: string;
3784
+
3785
+ lineHeight?: string;
3786
+ }
3787
+ }
3788
+ }
3789
+ }
3790
+
3791
+ export interface BrandRetrieveParams {
3792
+ /**
3793
+ * Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
3794
+ * Cannot be used with name or ticker parameters.
3795
+ */
3796
+ domain?: string;
3797
+
3798
+ /**
3799
+ * Optional parameter to force the language of the retrieved brand data. Works with
3800
+ * all three lookup methods.
3801
+ */
3802
+ force_language?:
3803
+ | 'albanian'
3804
+ | 'arabic'
3805
+ | 'azeri'
3806
+ | 'bengali'
3807
+ | 'bulgarian'
3808
+ | 'cebuano'
3809
+ | 'croatian'
3810
+ | 'czech'
3811
+ | 'danish'
3812
+ | 'dutch'
3813
+ | 'english'
3814
+ | 'estonian'
3815
+ | 'farsi'
3816
+ | 'finnish'
3817
+ | 'french'
3818
+ | 'german'
3819
+ | 'hausa'
3820
+ | 'hawaiian'
3821
+ | 'hindi'
3822
+ | 'hungarian'
3823
+ | 'icelandic'
3824
+ | 'indonesian'
3825
+ | 'italian'
3826
+ | 'kazakh'
3827
+ | 'kyrgyz'
3828
+ | 'latin'
3829
+ | 'latvian'
3830
+ | 'lithuanian'
3831
+ | 'macedonian'
3832
+ | 'mongolian'
3833
+ | 'nepali'
3834
+ | 'norwegian'
3835
+ | 'pashto'
3836
+ | 'pidgin'
3837
+ | 'polish'
3838
+ | 'portuguese'
3839
+ | 'romanian'
3840
+ | 'russian'
3841
+ | 'serbian'
3842
+ | 'slovak'
3843
+ | 'slovene'
3844
+ | 'somali'
3845
+ | 'spanish'
3846
+ | 'swahili'
3847
+ | 'swedish'
3848
+ | 'tagalog'
3849
+ | 'turkish'
3850
+ | 'ukrainian'
3851
+ | 'urdu'
3852
+ | 'uzbek'
3853
+ | 'vietnamese'
3854
+ | 'welsh';
3855
+
3856
+ /**
3857
+ * Optional parameter to optimize the API call for maximum speed. When set to true,
3858
+ * the API will skip time-consuming operations for faster response at the cost of
3859
+ * less comprehensive data. Works with all three lookup methods.
3860
+ */
3861
+ maxSpeed?: boolean;
1885
3862
 
1886
- h3?: Headings.H3;
3863
+ /**
3864
+ * Optional timeout in milliseconds for the request. If the request takes longer
3865
+ * than this value, it will be aborted with a 408 status code. Maximum allowed
3866
+ * value is 300000ms (5 minutes).
3867
+ */
3868
+ timeoutMS?: number;
3869
+ }
1887
3870
 
1888
- h4?: Headings.H4;
1889
- }
3871
+ export interface BrandAIQueryParams {
3872
+ /**
3873
+ * Array of data points to extract from the website
3874
+ */
3875
+ data_to_extract: Array<BrandAIQueryParams.DataToExtract>;
1890
3876
 
1891
- export namespace Headings {
1892
- export interface H1 {
1893
- fontFamily?: string;
3877
+ /**
3878
+ * The domain name to analyze
3879
+ */
3880
+ domain: string;
1894
3881
 
1895
- fontSize?: string;
3882
+ /**
3883
+ * Optional object specifying which pages to analyze
3884
+ */
3885
+ specific_pages?: BrandAIQueryParams.SpecificPages;
1896
3886
 
1897
- fontWeight?: number;
3887
+ /**
3888
+ * Optional timeout in milliseconds for the request. If the request takes longer
3889
+ * than this value, it will be aborted with a 408 status code. Maximum allowed
3890
+ * value is 300000ms (5 minutes).
3891
+ */
3892
+ timeoutMS?: number;
3893
+ }
1898
3894
 
1899
- letterSpacing?: string;
3895
+ export namespace BrandAIQueryParams {
3896
+ export interface DataToExtract {
3897
+ /**
3898
+ * Description of what to extract
3899
+ */
3900
+ datapoint_description: string;
1900
3901
 
1901
- lineHeight?: string;
1902
- }
3902
+ /**
3903
+ * Example of the expected value
3904
+ */
3905
+ datapoint_example: string;
1903
3906
 
1904
- export interface H2 {
1905
- fontFamily?: string;
3907
+ /**
3908
+ * Name of the data point to extract
3909
+ */
3910
+ datapoint_name: string;
1906
3911
 
1907
- fontSize?: string;
3912
+ /**
3913
+ * Type of the data point
3914
+ */
3915
+ datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
3916
+ }
1908
3917
 
1909
- fontWeight?: number;
3918
+ /**
3919
+ * Optional object specifying which pages to analyze
3920
+ */
3921
+ export interface SpecificPages {
3922
+ /**
3923
+ * Whether to analyze the about us page
3924
+ */
3925
+ about_us?: boolean;
1910
3926
 
1911
- letterSpacing?: string;
3927
+ /**
3928
+ * Whether to analyze the blog
3929
+ */
3930
+ blog?: boolean;
1912
3931
 
1913
- lineHeight?: string;
1914
- }
3932
+ /**
3933
+ * Whether to analyze the careers page
3934
+ */
3935
+ careers?: boolean;
1915
3936
 
1916
- export interface H3 {
1917
- fontFamily?: string;
3937
+ /**
3938
+ * Whether to analyze the contact us page
3939
+ */
3940
+ contact_us?: boolean;
1918
3941
 
1919
- fontSize?: string;
3942
+ /**
3943
+ * Whether to analyze the FAQ page
3944
+ */
3945
+ faq?: boolean;
1920
3946
 
1921
- fontWeight?: number;
3947
+ /**
3948
+ * Whether to analyze the home page
3949
+ */
3950
+ home_page?: boolean;
1922
3951
 
1923
- letterSpacing?: string;
3952
+ /**
3953
+ * Whether to analyze the privacy policy page
3954
+ */
3955
+ privacy_policy?: boolean;
1924
3956
 
1925
- lineHeight?: string;
1926
- }
3957
+ /**
3958
+ * Whether to analyze the terms and conditions page
3959
+ */
3960
+ terms_and_conditions?: boolean;
3961
+ }
3962
+ }
1927
3963
 
1928
- export interface H4 {
1929
- fontFamily?: string;
3964
+ export interface BrandIdentifyFromTransactionParams {
3965
+ /**
3966
+ * Transaction information to identify the brand
3967
+ */
3968
+ transaction_info: string;
1930
3969
 
1931
- fontSize?: string;
3970
+ /**
3971
+ * Optional parameter to force the language of the retrieved brand data.
3972
+ */
3973
+ force_language?:
3974
+ | 'albanian'
3975
+ | 'arabic'
3976
+ | 'azeri'
3977
+ | 'bengali'
3978
+ | 'bulgarian'
3979
+ | 'cebuano'
3980
+ | 'croatian'
3981
+ | 'czech'
3982
+ | 'danish'
3983
+ | 'dutch'
3984
+ | 'english'
3985
+ | 'estonian'
3986
+ | 'farsi'
3987
+ | 'finnish'
3988
+ | 'french'
3989
+ | 'german'
3990
+ | 'hausa'
3991
+ | 'hawaiian'
3992
+ | 'hindi'
3993
+ | 'hungarian'
3994
+ | 'icelandic'
3995
+ | 'indonesian'
3996
+ | 'italian'
3997
+ | 'kazakh'
3998
+ | 'kyrgyz'
3999
+ | 'latin'
4000
+ | 'latvian'
4001
+ | 'lithuanian'
4002
+ | 'macedonian'
4003
+ | 'mongolian'
4004
+ | 'nepali'
4005
+ | 'norwegian'
4006
+ | 'pashto'
4007
+ | 'pidgin'
4008
+ | 'polish'
4009
+ | 'portuguese'
4010
+ | 'romanian'
4011
+ | 'russian'
4012
+ | 'serbian'
4013
+ | 'slovak'
4014
+ | 'slovene'
4015
+ | 'somali'
4016
+ | 'spanish'
4017
+ | 'swahili'
4018
+ | 'swedish'
4019
+ | 'tagalog'
4020
+ | 'turkish'
4021
+ | 'ukrainian'
4022
+ | 'urdu'
4023
+ | 'uzbek'
4024
+ | 'vietnamese'
4025
+ | 'welsh';
1932
4026
 
1933
- fontWeight?: number;
4027
+ /**
4028
+ * Optional parameter to optimize the API call for maximum speed. When set to true,
4029
+ * the API will skip time-consuming operations for faster response at the cost of
4030
+ * less comprehensive data.
4031
+ */
4032
+ maxSpeed?: boolean;
1934
4033
 
1935
- letterSpacing?: string;
4034
+ /**
4035
+ * Optional timeout in milliseconds for the request. If the request takes longer
4036
+ * than this value, it will be aborted with a 408 status code. Maximum allowed
4037
+ * value is 300000ms (5 minutes).
4038
+ */
4039
+ timeoutMS?: number;
4040
+ }
1936
4041
 
1937
- lineHeight?: string;
1938
- }
1939
- }
4042
+ export interface BrandPrefetchParams {
4043
+ /**
4044
+ * Domain name to prefetch brand data for
4045
+ */
4046
+ domain: string;
1940
4047
 
1941
- /**
1942
- * Paragraph text styles
1943
- */
1944
- export interface P {
1945
- fontFamily?: string;
4048
+ /**
4049
+ * Optional timeout in milliseconds for the request. If the request takes longer
4050
+ * than this value, it will be aborted with a 408 status code. Maximum allowed
4051
+ * value is 300000ms (5 minutes).
4052
+ */
4053
+ timeoutMS?: number;
4054
+ }
1946
4055
 
1947
- fontSize?: string;
4056
+ export interface BrandRetrieveByEmailParams {
4057
+ /**
4058
+ * Email address to retrieve brand data for (e.g., 'contact@example.com'). The
4059
+ * domain will be extracted from the email. Free email providers (gmail.com,
4060
+ * yahoo.com, etc.) and disposable email addresses are not allowed.
4061
+ */
4062
+ email: string;
1948
4063
 
1949
- fontWeight?: number;
4064
+ /**
4065
+ * Optional parameter to force the language of the retrieved brand data.
4066
+ */
4067
+ force_language?:
4068
+ | 'albanian'
4069
+ | 'arabic'
4070
+ | 'azeri'
4071
+ | 'bengali'
4072
+ | 'bulgarian'
4073
+ | 'cebuano'
4074
+ | 'croatian'
4075
+ | 'czech'
4076
+ | 'danish'
4077
+ | 'dutch'
4078
+ | 'english'
4079
+ | 'estonian'
4080
+ | 'farsi'
4081
+ | 'finnish'
4082
+ | 'french'
4083
+ | 'german'
4084
+ | 'hausa'
4085
+ | 'hawaiian'
4086
+ | 'hindi'
4087
+ | 'hungarian'
4088
+ | 'icelandic'
4089
+ | 'indonesian'
4090
+ | 'italian'
4091
+ | 'kazakh'
4092
+ | 'kyrgyz'
4093
+ | 'latin'
4094
+ | 'latvian'
4095
+ | 'lithuanian'
4096
+ | 'macedonian'
4097
+ | 'mongolian'
4098
+ | 'nepali'
4099
+ | 'norwegian'
4100
+ | 'pashto'
4101
+ | 'pidgin'
4102
+ | 'polish'
4103
+ | 'portuguese'
4104
+ | 'romanian'
4105
+ | 'russian'
4106
+ | 'serbian'
4107
+ | 'slovak'
4108
+ | 'slovene'
4109
+ | 'somali'
4110
+ | 'spanish'
4111
+ | 'swahili'
4112
+ | 'swedish'
4113
+ | 'tagalog'
4114
+ | 'turkish'
4115
+ | 'ukrainian'
4116
+ | 'urdu'
4117
+ | 'uzbek'
4118
+ | 'vietnamese'
4119
+ | 'welsh';
1950
4120
 
1951
- letterSpacing?: string;
4121
+ /**
4122
+ * Optional parameter to optimize the API call for maximum speed. When set to true,
4123
+ * the API will skip time-consuming operations for faster response at the cost of
4124
+ * less comprehensive data.
4125
+ */
4126
+ maxSpeed?: boolean;
1952
4127
 
1953
- lineHeight?: string;
1954
- }
1955
- }
1956
- }
4128
+ /**
4129
+ * Optional timeout in milliseconds for the request. If the request takes longer
4130
+ * than this value, it will be aborted with a 408 status code. Maximum allowed
4131
+ * value is 300000ms (5 minutes).
4132
+ */
4133
+ timeoutMS?: number;
1957
4134
  }
1958
4135
 
1959
- export interface BrandRetrieveParams {
4136
+ export interface BrandRetrieveByNameParams {
1960
4137
  /**
1961
- * Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
1962
- * Cannot be used with name or ticker parameters.
4138
+ * Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
4139
+ * Corporation'). Must be 3-30 characters.
1963
4140
  */
1964
- domain?: string;
4141
+ name: string;
1965
4142
 
1966
4143
  /**
1967
- * Optional parameter to force the language of the retrieved brand data. Works with
1968
- * all three lookup methods.
4144
+ * Optional parameter to force the language of the retrieved brand data.
1969
4145
  */
1970
4146
  force_language?:
1971
4147
  | 'albanian'
@@ -2024,27 +4200,91 @@ export interface BrandRetrieveParams {
2024
4200
  /**
2025
4201
  * Optional parameter to optimize the API call for maximum speed. When set to true,
2026
4202
  * the API will skip time-consuming operations for faster response at the cost of
2027
- * less comprehensive data. Works with all three lookup methods.
4203
+ * less comprehensive data.
2028
4204
  */
2029
4205
  maxSpeed?: boolean;
2030
4206
 
2031
4207
  /**
2032
- * Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
2033
- * Corporation'). Must be 3-30 characters. Cannot be used with domain or ticker
2034
- * parameters.
4208
+ * Optional timeout in milliseconds for the request. If the request takes longer
4209
+ * than this value, it will be aborted with a 408 status code. Maximum allowed
4210
+ * value is 300000ms (5 minutes).
2035
4211
  */
2036
- name?: string;
4212
+ timeoutMS?: number;
4213
+ }
2037
4214
 
4215
+ export interface BrandRetrieveByTickerParams {
2038
4216
  /**
2039
4217
  * Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
2040
- * Must be 1-15 characters, letters/numbers/dots only. Cannot be used with domain
2041
- * or name parameters.
4218
+ * Must be 1-15 characters, letters/numbers/dots only.
4219
+ */
4220
+ ticker: string;
4221
+
4222
+ /**
4223
+ * Optional parameter to force the language of the retrieved brand data.
4224
+ */
4225
+ force_language?:
4226
+ | 'albanian'
4227
+ | 'arabic'
4228
+ | 'azeri'
4229
+ | 'bengali'
4230
+ | 'bulgarian'
4231
+ | 'cebuano'
4232
+ | 'croatian'
4233
+ | 'czech'
4234
+ | 'danish'
4235
+ | 'dutch'
4236
+ | 'english'
4237
+ | 'estonian'
4238
+ | 'farsi'
4239
+ | 'finnish'
4240
+ | 'french'
4241
+ | 'german'
4242
+ | 'hausa'
4243
+ | 'hawaiian'
4244
+ | 'hindi'
4245
+ | 'hungarian'
4246
+ | 'icelandic'
4247
+ | 'indonesian'
4248
+ | 'italian'
4249
+ | 'kazakh'
4250
+ | 'kyrgyz'
4251
+ | 'latin'
4252
+ | 'latvian'
4253
+ | 'lithuanian'
4254
+ | 'macedonian'
4255
+ | 'mongolian'
4256
+ | 'nepali'
4257
+ | 'norwegian'
4258
+ | 'pashto'
4259
+ | 'pidgin'
4260
+ | 'polish'
4261
+ | 'portuguese'
4262
+ | 'romanian'
4263
+ | 'russian'
4264
+ | 'serbian'
4265
+ | 'slovak'
4266
+ | 'slovene'
4267
+ | 'somali'
4268
+ | 'spanish'
4269
+ | 'swahili'
4270
+ | 'swedish'
4271
+ | 'tagalog'
4272
+ | 'turkish'
4273
+ | 'ukrainian'
4274
+ | 'urdu'
4275
+ | 'uzbek'
4276
+ | 'vietnamese'
4277
+ | 'welsh';
4278
+
4279
+ /**
4280
+ * Optional parameter to optimize the API call for maximum speed. When set to true,
4281
+ * the API will skip time-consuming operations for faster response at the cost of
4282
+ * less comprehensive data.
2042
4283
  */
2043
- ticker?: string;
4284
+ maxSpeed?: boolean;
2044
4285
 
2045
4286
  /**
2046
- * Optional stock exchange for the ticker. Only used when ticker parameter is
2047
- * provided. Defaults to assume ticker is American if not specified.
4287
+ * Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
2048
4288
  */
2049
4289
  ticker_exchange?:
2050
4290
  | 'AMEX'
@@ -2128,127 +4368,6 @@ export interface BrandRetrieveParams {
2128
4368
  timeoutMS?: number;
2129
4369
  }
2130
4370
 
2131
- export interface BrandAIQueryParams {
2132
- /**
2133
- * Array of data points to extract from the website
2134
- */
2135
- data_to_extract: Array<BrandAIQueryParams.DataToExtract>;
2136
-
2137
- /**
2138
- * The domain name to analyze
2139
- */
2140
- domain: string;
2141
-
2142
- /**
2143
- * Optional object specifying which pages to analyze
2144
- */
2145
- specific_pages?: BrandAIQueryParams.SpecificPages;
2146
-
2147
- /**
2148
- * Optional timeout in milliseconds for the request. If the request takes longer
2149
- * than this value, it will be aborted with a 408 status code. Maximum allowed
2150
- * value is 300000ms (5 minutes).
2151
- */
2152
- timeoutMS?: number;
2153
- }
2154
-
2155
- export namespace BrandAIQueryParams {
2156
- export interface DataToExtract {
2157
- /**
2158
- * Description of what to extract
2159
- */
2160
- datapoint_description: string;
2161
-
2162
- /**
2163
- * Example of the expected value
2164
- */
2165
- datapoint_example: string;
2166
-
2167
- /**
2168
- * Name of the data point to extract
2169
- */
2170
- datapoint_name: string;
2171
-
2172
- /**
2173
- * Type of the data point
2174
- */
2175
- datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
2176
- }
2177
-
2178
- /**
2179
- * Optional object specifying which pages to analyze
2180
- */
2181
- export interface SpecificPages {
2182
- /**
2183
- * Whether to analyze the about us page
2184
- */
2185
- about_us?: boolean;
2186
-
2187
- /**
2188
- * Whether to analyze the blog
2189
- */
2190
- blog?: boolean;
2191
-
2192
- /**
2193
- * Whether to analyze the careers page
2194
- */
2195
- careers?: boolean;
2196
-
2197
- /**
2198
- * Whether to analyze the contact us page
2199
- */
2200
- contact_us?: boolean;
2201
-
2202
- /**
2203
- * Whether to analyze the FAQ page
2204
- */
2205
- faq?: boolean;
2206
-
2207
- /**
2208
- * Whether to analyze the home page
2209
- */
2210
- home_page?: boolean;
2211
-
2212
- /**
2213
- * Whether to analyze the privacy policy page
2214
- */
2215
- privacy_policy?: boolean;
2216
-
2217
- /**
2218
- * Whether to analyze the terms and conditions page
2219
- */
2220
- terms_and_conditions?: boolean;
2221
- }
2222
- }
2223
-
2224
- export interface BrandIdentifyFromTransactionParams {
2225
- /**
2226
- * Transaction information to identify the brand
2227
- */
2228
- transaction_info: string;
2229
-
2230
- /**
2231
- * Optional timeout in milliseconds for the request. If the request takes longer
2232
- * than this value, it will be aborted with a 408 status code. Maximum allowed
2233
- * value is 300000ms (5 minutes).
2234
- */
2235
- timeoutMS?: number;
2236
- }
2237
-
2238
- export interface BrandPrefetchParams {
2239
- /**
2240
- * Domain name to prefetch brand data for
2241
- */
2242
- domain: string;
2243
-
2244
- /**
2245
- * Optional timeout in milliseconds for the request. If the request takes longer
2246
- * than this value, it will be aborted with a 408 status code. Maximum allowed
2247
- * value is 300000ms (5 minutes).
2248
- */
2249
- timeoutMS?: number;
2250
- }
2251
-
2252
4371
  export interface BrandRetrieveNaicsParams {
2253
4372
  /**
2254
4373
  * Brand domain or title to retrieve NAICS code for. If a valid domain is provided
@@ -2338,6 +4457,9 @@ export declare namespace Brand {
2338
4457
  type BrandAIQueryResponse as BrandAIQueryResponse,
2339
4458
  type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse,
2340
4459
  type BrandPrefetchResponse as BrandPrefetchResponse,
4460
+ type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse,
4461
+ type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse,
4462
+ type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse,
2341
4463
  type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse,
2342
4464
  type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse,
2343
4465
  type BrandScreenshotResponse as BrandScreenshotResponse,
@@ -2346,6 +4468,9 @@ export declare namespace Brand {
2346
4468
  type BrandAIQueryParams as BrandAIQueryParams,
2347
4469
  type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams,
2348
4470
  type BrandPrefetchParams as BrandPrefetchParams,
4471
+ type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams,
4472
+ type BrandRetrieveByNameParams as BrandRetrieveByNameParams,
4473
+ type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams,
2349
4474
  type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams,
2350
4475
  type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams,
2351
4476
  type BrandScreenshotParams as BrandScreenshotParams,