context.dev 0.1.0 → 0.3.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.
Files changed (79) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/client.d.mts +17 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +17 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js +15 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +15 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/ai.d.mts +331 -0
  12. package/resources/ai.d.mts.map +1 -0
  13. package/resources/ai.d.ts +331 -0
  14. package/resources/ai.d.ts.map +1 -0
  15. package/resources/ai.js +33 -0
  16. package/resources/ai.js.map +1 -0
  17. package/resources/ai.mjs +29 -0
  18. package/resources/ai.mjs.map +1 -0
  19. package/resources/brand.d.mts +12 -1056
  20. package/resources/brand.d.mts.map +1 -1
  21. package/resources/brand.d.ts +12 -1056
  22. package/resources/brand.d.ts.map +1 -1
  23. package/resources/brand.js +0 -106
  24. package/resources/brand.js.map +1 -1
  25. package/resources/brand.mjs +0 -106
  26. package/resources/brand.mjs.map +1 -1
  27. package/resources/index.d.mts +6 -1
  28. package/resources/index.d.mts.map +1 -1
  29. package/resources/index.d.ts +6 -1
  30. package/resources/index.d.ts.map +1 -1
  31. package/resources/index.js +11 -1
  32. package/resources/index.js.map +1 -1
  33. package/resources/index.mjs +5 -0
  34. package/resources/index.mjs.map +1 -1
  35. package/resources/industry.d.mts +70 -0
  36. package/resources/industry.d.mts.map +1 -0
  37. package/resources/industry.d.ts +70 -0
  38. package/resources/industry.d.ts.map +1 -0
  39. package/resources/industry.js +15 -0
  40. package/resources/industry.js.map +1 -0
  41. package/resources/industry.mjs +11 -0
  42. package/resources/industry.mjs.map +1 -0
  43. package/resources/style.d.mts +386 -0
  44. package/resources/style.d.mts.map +1 -0
  45. package/resources/style.d.ts +386 -0
  46. package/resources/style.d.ts.map +1 -0
  47. package/resources/style.js +25 -0
  48. package/resources/style.js.map +1 -0
  49. package/resources/style.mjs +21 -0
  50. package/resources/style.mjs.map +1 -0
  51. package/resources/utility.d.mts +79 -0
  52. package/resources/utility.d.mts.map +1 -0
  53. package/resources/utility.d.ts +79 -0
  54. package/resources/utility.d.ts.map +1 -0
  55. package/resources/utility.js +29 -0
  56. package/resources/utility.js.map +1 -0
  57. package/resources/utility.mjs +25 -0
  58. package/resources/utility.mjs.map +1 -0
  59. package/resources/web.d.mts +228 -0
  60. package/resources/web.d.mts.map +1 -0
  61. package/resources/web.d.ts +228 -0
  62. package/resources/web.d.ts.map +1 -0
  63. package/resources/web.js +49 -0
  64. package/resources/web.js.map +1 -0
  65. package/resources/web.mjs +45 -0
  66. package/resources/web.mjs.map +1 -0
  67. package/src/client.ts +93 -52
  68. package/src/resources/ai.ts +417 -0
  69. package/src/resources/brand.ts +318 -1424
  70. package/src/resources/index.ts +37 -26
  71. package/src/resources/industry.ts +92 -0
  72. package/src/resources/style.ts +522 -0
  73. package/src/resources/utility.ts +105 -0
  74. package/src/resources/web.ts +302 -0
  75. package/src/version.ts +1 -1
  76. package/version.d.mts +1 -1
  77. package/version.d.ts +1 -1
  78. package/version.js +1 -1
  79. package/version.mjs +1 -1
@@ -7,50 +7,11 @@ export declare class Brand extends APIResource {
7
7
  * domain
8
8
  */
9
9
  retrieve(query: BrandRetrieveParams, options?: RequestOptions): APIPromise<BrandRetrieveResponse>;
10
- /**
11
- * Beta feature: Given a single URL, determines if it is a product detail page,
12
- * classifies the platform/product type, and extracts the product information.
13
- * Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites.
14
- */
15
- aiProduct(body: BrandAIProductParams, options?: RequestOptions): APIPromise<BrandAIProductResponse>;
16
- /**
17
- * Beta feature: Extract product information from a brand's website. Brand.dev will
18
- * analyze the website and return a list of products with details such as name,
19
- * description, image, pricing, features, and more.
20
- */
21
- aiProducts(body: BrandAIProductsParams, options?: RequestOptions): APIPromise<BrandAIProductsResponse>;
22
- /**
23
- * Use AI to extract specific data points from a brand's website. The AI will crawl
24
- * the website and extract the requested information based on the provided data
25
- * points.
26
- */
27
- aiQuery(body: BrandAIQueryParams, options?: RequestOptions): APIPromise<BrandAIQueryResponse>;
28
- /**
29
- * Extract font information from a brand's website including font families, usage
30
- * statistics, fallbacks, and element/word counts.
31
- */
32
- fonts(query: BrandFontsParams, options?: RequestOptions): APIPromise<BrandFontsResponse>;
33
10
  /**
34
11
  * Endpoint specially designed for platforms that want to identify transaction data
35
12
  * by the transaction title.
36
13
  */
37
14
  identifyFromTransaction(query: BrandIdentifyFromTransactionParams, options?: RequestOptions): APIPromise<BrandIdentifyFromTransactionResponse>;
38
- /**
39
- * Signal that you may fetch brand data for a particular domain soon to improve
40
- * latency. This endpoint does not charge credits and is available for paid
41
- * customers to optimize future requests. [You must be on a paid plan to use this
42
- * endpoint]
43
- */
44
- prefetch(body: BrandPrefetchParams, options?: RequestOptions): APIPromise<BrandPrefetchResponse>;
45
- /**
46
- * Signal that you may fetch brand data for a particular domain soon to improve
47
- * latency. This endpoint accepts an email address, extracts the domain from it,
48
- * validates that it's not a disposable or free email provider, and queues the
49
- * domain for prefetching. This endpoint does not charge credits and is available
50
- * for paid customers to optimize future requests. [You must be on a paid plan to
51
- * use this endpoint]
52
- */
53
- prefetchByEmail(body: BrandPrefetchByEmailParams, options?: RequestOptions): APIPromise<BrandPrefetchByEmailResponse>;
54
15
  /**
55
16
  * Retrieve brand information using an email address while detecting disposable and
56
17
  * free email addresses. This endpoint extracts the domain from the email address
@@ -74,53 +35,12 @@ export declare class Brand extends APIResource {
74
35
  * the company associated with the ticker and returns its brand data.
75
36
  */
76
37
  retrieveByTicker(query: BrandRetrieveByTickerParams, options?: RequestOptions): APIPromise<BrandRetrieveByTickerResponse>;
77
- /**
78
- * Endpoint to classify any brand into a 2022 NAICS code.
79
- */
80
- retrieveNaics(query: BrandRetrieveNaicsParams, options?: RequestOptions): APIPromise<BrandRetrieveNaicsResponse>;
81
38
  /**
82
39
  * Returns a simplified version of brand data containing only essential
83
40
  * information: domain, title, colors, logos, and backdrops. This endpoint is
84
41
  * optimized for faster responses and reduced data transfer.
85
42
  */
86
43
  retrieveSimplified(query: BrandRetrieveSimplifiedParams, options?: RequestOptions): APIPromise<BrandRetrieveSimplifiedResponse>;
87
- /**
88
- * Capture a screenshot of a website. Supports both viewport (standard browser
89
- * view) and full-page screenshots. Can also screenshot specific page types (login,
90
- * pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
91
- * the uploaded screenshot image hosted on our CDN.
92
- */
93
- screenshot(query: BrandScreenshotParams, options?: RequestOptions): APIPromise<BrandScreenshotResponse>;
94
- /**
95
- * Automatically extract comprehensive design system information from a brand's
96
- * website including colors, typography, spacing, shadows, and UI components.
97
- * Either 'domain' or 'directUrl' must be provided as a query parameter, but not
98
- * both.
99
- */
100
- styleguide(query?: BrandStyleguideParams | null | undefined, options?: RequestOptions): APIPromise<BrandStyleguideResponse>;
101
- /**
102
- * Scrapes the given URL and returns the raw HTML content of the page. Uses
103
- * automatic proxy escalation to handle blocked sites.
104
- */
105
- webScrapeHTML(query: BrandWebScrapeHTMLParams, options?: RequestOptions): APIPromise<BrandWebScrapeHTMLResponse>;
106
- /**
107
- * Scrapes all images from the given URL. Extracts images from img, svg,
108
- * picture/source, link, and video elements including inline SVGs, base64 data
109
- * URIs, and standard URLs.
110
- */
111
- webScrapeImages(query: BrandWebScrapeImagesParams, options?: RequestOptions): APIPromise<BrandWebScrapeImagesResponse>;
112
- /**
113
- * Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown
114
- * (GFM), and returns the result. Uses automatic proxy escalation to handle blocked
115
- * sites.
116
- */
117
- webScrapeMd(query: BrandWebScrapeMdParams, options?: RequestOptions): APIPromise<BrandWebScrapeMdResponse>;
118
- /**
119
- * Crawls the sitemap of the given domain and returns all discovered page URLs.
120
- * Supports sitemap index files (recursive), parallel fetching with concurrency
121
- * control, deduplication, and filters out non-page resources (images, PDFs, etc.).
122
- */
123
- webScrapeSitemap(query: BrandWebScrapeSitemapParams, options?: RequestOptions): APIPromise<BrandWebScrapeSitemapResponse>;
124
44
  }
125
45
  export interface BrandRetrieveResponse {
126
46
  /**
@@ -419,222 +339,6 @@ export declare namespace BrandRetrieveResponse {
419
339
  }
420
340
  }
421
341
  }
422
- export interface BrandAIProductResponse {
423
- /**
424
- * Whether the given URL is a product detail page
425
- */
426
- is_product_page?: boolean;
427
- /**
428
- * The detected ecommerce platform, or null if not a product page
429
- */
430
- platform?: 'amazon' | 'tiktok_shop' | 'etsy' | 'generic' | null;
431
- /**
432
- * The extracted product data, or null if not a product page
433
- */
434
- product?: BrandAIProductResponse.Product | null;
435
- }
436
- export declare namespace BrandAIProductResponse {
437
- /**
438
- * The extracted product data, or null if not a product page
439
- */
440
- interface Product {
441
- /**
442
- * Description of the product
443
- */
444
- description: string;
445
- /**
446
- * List of product features
447
- */
448
- features: Array<string>;
449
- /**
450
- * URLs to product images on the page (up to 7)
451
- */
452
- images: Array<string>;
453
- /**
454
- * Name of the product
455
- */
456
- name: string;
457
- /**
458
- * Tags associated with the product
459
- */
460
- tags: Array<string>;
461
- /**
462
- * Target audience for the product (array of strings)
463
- */
464
- target_audience: Array<string>;
465
- /**
466
- * Billing frequency for the product
467
- */
468
- billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
469
- /**
470
- * Category of the product
471
- */
472
- category?: string | null;
473
- /**
474
- * Currency code for the price (e.g., USD, EUR)
475
- */
476
- currency?: string | null;
477
- /**
478
- * URL to the product image
479
- */
480
- image_url?: string | null;
481
- /**
482
- * Price of the product
483
- */
484
- price?: number | null;
485
- /**
486
- * Pricing model for the product
487
- */
488
- pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
489
- /**
490
- * URL to the product page
491
- */
492
- url?: string | null;
493
- }
494
- }
495
- export interface BrandAIProductsResponse {
496
- /**
497
- * Array of products extracted from the website
498
- */
499
- products?: Array<BrandAIProductsResponse.Product>;
500
- }
501
- export declare namespace BrandAIProductsResponse {
502
- interface Product {
503
- /**
504
- * Description of the product
505
- */
506
- description: string;
507
- /**
508
- * List of product features
509
- */
510
- features: Array<string>;
511
- /**
512
- * URLs to product images on the page (up to 7)
513
- */
514
- images: Array<string>;
515
- /**
516
- * Name of the product
517
- */
518
- name: string;
519
- /**
520
- * Tags associated with the product
521
- */
522
- tags: Array<string>;
523
- /**
524
- * Target audience for the product (array of strings)
525
- */
526
- target_audience: Array<string>;
527
- /**
528
- * Billing frequency for the product
529
- */
530
- billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
531
- /**
532
- * Category of the product
533
- */
534
- category?: string | null;
535
- /**
536
- * Currency code for the price (e.g., USD, EUR)
537
- */
538
- currency?: string | null;
539
- /**
540
- * URL to the product image
541
- */
542
- image_url?: string | null;
543
- /**
544
- * Price of the product
545
- */
546
- price?: number | null;
547
- /**
548
- * Pricing model for the product
549
- */
550
- pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
551
- /**
552
- * URL to the product page
553
- */
554
- url?: string | null;
555
- }
556
- }
557
- export interface BrandAIQueryResponse {
558
- /**
559
- * Array of extracted data points
560
- */
561
- data_extracted?: Array<BrandAIQueryResponse.DataExtracted>;
562
- /**
563
- * The domain that was analyzed
564
- */
565
- domain?: string;
566
- /**
567
- * Status of the response, e.g., 'ok'
568
- */
569
- status?: string;
570
- /**
571
- * List of URLs that were analyzed
572
- */
573
- urls_analyzed?: Array<string>;
574
- }
575
- export declare namespace BrandAIQueryResponse {
576
- interface DataExtracted {
577
- /**
578
- * Name of the extracted data point
579
- */
580
- datapoint_name?: string;
581
- /**
582
- * Value of the extracted data point. Can be a primitive type, an array of
583
- * primitives, or an array of objects when datapoint_list_type is 'object'.
584
- */
585
- datapoint_value?: string | number | boolean | Array<string> | Array<number> | Array<unknown>;
586
- }
587
- }
588
- export interface BrandFontsResponse {
589
- /**
590
- * HTTP status code, e.g., 200
591
- */
592
- code: number;
593
- /**
594
- * The normalized domain that was processed
595
- */
596
- domain: string;
597
- /**
598
- * Array of font usage information
599
- */
600
- fonts: Array<BrandFontsResponse.Font>;
601
- /**
602
- * Status of the response, e.g., 'ok'
603
- */
604
- status: string;
605
- }
606
- export declare namespace BrandFontsResponse {
607
- interface Font {
608
- /**
609
- * Array of fallback font families
610
- */
611
- fallbacks: Array<string>;
612
- /**
613
- * Font family name
614
- */
615
- font: string;
616
- /**
617
- * Number of elements using this font
618
- */
619
- num_elements: number;
620
- /**
621
- * Number of words using this font
622
- */
623
- num_words: number;
624
- /**
625
- * Percentage of elements using this font
626
- */
627
- percent_elements: number;
628
- /**
629
- * Percentage of words using this font
630
- */
631
- percent_words: number;
632
- /**
633
- * Array of CSS selectors or element types where this font is used
634
- */
635
- uses: Array<string>;
636
- }
637
- }
638
342
  export interface BrandIdentifyFromTransactionResponse {
639
343
  /**
640
344
  * Detailed brand information
@@ -932,34 +636,6 @@ export declare namespace BrandIdentifyFromTransactionResponse {
932
636
  }
933
637
  }
934
638
  }
935
- export interface BrandPrefetchResponse {
936
- /**
937
- * The domain that was queued for prefetching
938
- */
939
- domain?: string;
940
- /**
941
- * Success message
942
- */
943
- message?: string;
944
- /**
945
- * Status of the response, e.g., 'ok'
946
- */
947
- status?: string;
948
- }
949
- export interface BrandPrefetchByEmailResponse {
950
- /**
951
- * The domain that was queued for prefetching
952
- */
953
- domain?: string;
954
- /**
955
- * Success message
956
- */
957
- message?: string;
958
- /**
959
- * Status of the response, e.g., 'ok'
960
- */
961
- status?: string;
962
- }
963
639
  export interface BrandRetrieveByEmailResponse {
964
640
  /**
965
641
  * Detailed brand information
@@ -2148,40 +1824,6 @@ export declare namespace BrandRetrieveByTickerResponse {
2148
1824
  }
2149
1825
  }
2150
1826
  }
2151
- export interface BrandRetrieveNaicsResponse {
2152
- /**
2153
- * Array of NAICS codes and titles.
2154
- */
2155
- codes?: Array<BrandRetrieveNaicsResponse.Code>;
2156
- /**
2157
- * Domain found for the brand
2158
- */
2159
- domain?: string;
2160
- /**
2161
- * Status of the response, e.g., 'ok'
2162
- */
2163
- status?: string;
2164
- /**
2165
- * Industry classification type, for naics api it will be `naics`
2166
- */
2167
- type?: string;
2168
- }
2169
- export declare namespace BrandRetrieveNaicsResponse {
2170
- interface Code {
2171
- /**
2172
- * NAICS code
2173
- */
2174
- code: string;
2175
- /**
2176
- * Confidence level for how well this NAICS code matches the company description
2177
- */
2178
- confidence: 'high' | 'medium' | 'low';
2179
- /**
2180
- * NAICS title
2181
- */
2182
- name: string;
2183
- }
2184
- }
2185
1827
  export interface BrandRetrieveSimplifiedResponse {
2186
1828
  /**
2187
1829
  * Simplified brand information
@@ -2331,408 +1973,6 @@ export declare namespace BrandRetrieveSimplifiedResponse {
2331
1973
  }
2332
1974
  }
2333
1975
  }
2334
- export interface BrandScreenshotResponse {
2335
- /**
2336
- * HTTP status code
2337
- */
2338
- code?: number;
2339
- /**
2340
- * The normalized domain that was processed
2341
- */
2342
- domain?: string;
2343
- /**
2344
- * Public URL of the uploaded screenshot image
2345
- */
2346
- screenshot?: string;
2347
- /**
2348
- * Type of screenshot that was captured
2349
- */
2350
- screenshotType?: 'viewport' | 'fullPage';
2351
- /**
2352
- * Status of the response, e.g., 'ok'
2353
- */
2354
- status?: string;
2355
- }
2356
- export interface BrandStyleguideResponse {
2357
- /**
2358
- * HTTP status code
2359
- */
2360
- code?: number;
2361
- /**
2362
- * The normalized domain that was processed
2363
- */
2364
- domain?: string;
2365
- /**
2366
- * Status of the response, e.g., 'ok'
2367
- */
2368
- status?: string;
2369
- /**
2370
- * Comprehensive styleguide data extracted from the website
2371
- */
2372
- styleguide?: BrandStyleguideResponse.Styleguide;
2373
- }
2374
- export declare namespace BrandStyleguideResponse {
2375
- /**
2376
- * Comprehensive styleguide data extracted from the website
2377
- */
2378
- interface Styleguide {
2379
- /**
2380
- * Primary colors used on the website
2381
- */
2382
- colors?: Styleguide.Colors;
2383
- /**
2384
- * UI component styles
2385
- */
2386
- components?: Styleguide.Components;
2387
- /**
2388
- * Spacing system used on the website
2389
- */
2390
- elementSpacing?: Styleguide.ElementSpacing;
2391
- /**
2392
- * The primary color mode of the website design
2393
- */
2394
- mode?: 'light' | 'dark';
2395
- /**
2396
- * Shadow styles used on the website
2397
- */
2398
- shadows?: Styleguide.Shadows;
2399
- /**
2400
- * Typography styles used on the website
2401
- */
2402
- typography?: Styleguide.Typography;
2403
- }
2404
- namespace Styleguide {
2405
- /**
2406
- * Primary colors used on the website
2407
- */
2408
- interface Colors {
2409
- /**
2410
- * Accent color of the website (hex format)
2411
- */
2412
- accent?: string;
2413
- /**
2414
- * Background color of the website (hex format)
2415
- */
2416
- background?: string;
2417
- /**
2418
- * Text color of the website (hex format)
2419
- */
2420
- text?: string;
2421
- }
2422
- /**
2423
- * UI component styles
2424
- */
2425
- interface Components {
2426
- /**
2427
- * Button component styles
2428
- */
2429
- button?: Components.Button;
2430
- /**
2431
- * Card component style
2432
- */
2433
- card?: Components.Card;
2434
- }
2435
- namespace Components {
2436
- /**
2437
- * Button component styles
2438
- */
2439
- interface Button {
2440
- /**
2441
- * Link button style
2442
- */
2443
- link?: Button.Link;
2444
- /**
2445
- * Primary button style
2446
- */
2447
- primary?: Button.Primary;
2448
- /**
2449
- * Secondary button style
2450
- */
2451
- secondary?: Button.Secondary;
2452
- }
2453
- namespace Button {
2454
- /**
2455
- * Link button style
2456
- */
2457
- interface Link {
2458
- backgroundColor?: string;
2459
- borderColor?: string;
2460
- borderRadius?: string;
2461
- borderStyle?: string;
2462
- borderWidth?: string;
2463
- boxShadow?: string;
2464
- color?: string;
2465
- fontSize?: string;
2466
- fontWeight?: number;
2467
- padding?: string;
2468
- textDecoration?: string;
2469
- }
2470
- /**
2471
- * Primary button style
2472
- */
2473
- interface Primary {
2474
- backgroundColor?: string;
2475
- borderColor?: string;
2476
- borderRadius?: string;
2477
- borderStyle?: string;
2478
- borderWidth?: string;
2479
- boxShadow?: string;
2480
- color?: string;
2481
- fontSize?: string;
2482
- fontWeight?: number;
2483
- padding?: string;
2484
- textDecoration?: string;
2485
- }
2486
- /**
2487
- * Secondary button style
2488
- */
2489
- interface Secondary {
2490
- backgroundColor?: string;
2491
- borderColor?: string;
2492
- borderRadius?: string;
2493
- borderStyle?: string;
2494
- borderWidth?: string;
2495
- boxShadow?: string;
2496
- color?: string;
2497
- fontSize?: string;
2498
- fontWeight?: number;
2499
- padding?: string;
2500
- textDecoration?: string;
2501
- }
2502
- }
2503
- /**
2504
- * Card component style
2505
- */
2506
- interface Card {
2507
- backgroundColor?: string;
2508
- borderColor?: string;
2509
- borderRadius?: string;
2510
- borderStyle?: string;
2511
- borderWidth?: string;
2512
- boxShadow?: string;
2513
- padding?: string;
2514
- textColor?: string;
2515
- }
2516
- }
2517
- /**
2518
- * Spacing system used on the website
2519
- */
2520
- interface ElementSpacing {
2521
- /**
2522
- * Large spacing value
2523
- */
2524
- lg?: string;
2525
- /**
2526
- * Medium spacing value
2527
- */
2528
- md?: string;
2529
- /**
2530
- * Small spacing value
2531
- */
2532
- sm?: string;
2533
- /**
2534
- * Extra large spacing value
2535
- */
2536
- xl?: string;
2537
- /**
2538
- * Extra small spacing value
2539
- */
2540
- xs?: string;
2541
- }
2542
- /**
2543
- * Shadow styles used on the website
2544
- */
2545
- interface Shadows {
2546
- /**
2547
- * Inner shadow value
2548
- */
2549
- inner?: string;
2550
- /**
2551
- * Large shadow value
2552
- */
2553
- lg?: string;
2554
- /**
2555
- * Medium shadow value
2556
- */
2557
- md?: string;
2558
- /**
2559
- * Small shadow value
2560
- */
2561
- sm?: string;
2562
- /**
2563
- * Extra large shadow value
2564
- */
2565
- xl?: string;
2566
- }
2567
- /**
2568
- * Typography styles used on the website
2569
- */
2570
- interface Typography {
2571
- /**
2572
- * Heading styles
2573
- */
2574
- headings?: Typography.Headings;
2575
- /**
2576
- * Paragraph text styles
2577
- */
2578
- p?: Typography.P;
2579
- }
2580
- namespace Typography {
2581
- /**
2582
- * Heading styles
2583
- */
2584
- interface Headings {
2585
- h1?: Headings.H1;
2586
- h2?: Headings.H2;
2587
- h3?: Headings.H3;
2588
- h4?: Headings.H4;
2589
- }
2590
- namespace Headings {
2591
- interface H1 {
2592
- fontFamily?: string;
2593
- fontSize?: string;
2594
- fontWeight?: number;
2595
- letterSpacing?: string;
2596
- lineHeight?: string;
2597
- }
2598
- interface H2 {
2599
- fontFamily?: string;
2600
- fontSize?: string;
2601
- fontWeight?: number;
2602
- letterSpacing?: string;
2603
- lineHeight?: string;
2604
- }
2605
- interface H3 {
2606
- fontFamily?: string;
2607
- fontSize?: string;
2608
- fontWeight?: number;
2609
- letterSpacing?: string;
2610
- lineHeight?: string;
2611
- }
2612
- interface H4 {
2613
- fontFamily?: string;
2614
- fontSize?: string;
2615
- fontWeight?: number;
2616
- letterSpacing?: string;
2617
- lineHeight?: string;
2618
- }
2619
- }
2620
- /**
2621
- * Paragraph text styles
2622
- */
2623
- interface P {
2624
- fontFamily?: string;
2625
- fontSize?: string;
2626
- fontWeight?: number;
2627
- letterSpacing?: string;
2628
- lineHeight?: string;
2629
- }
2630
- }
2631
- }
2632
- }
2633
- export interface BrandWebScrapeHTMLResponse {
2634
- /**
2635
- * Raw HTML content of the page
2636
- */
2637
- html: string;
2638
- /**
2639
- * Indicates success
2640
- */
2641
- success: true;
2642
- /**
2643
- * The URL that was scraped
2644
- */
2645
- url: string;
2646
- }
2647
- export interface BrandWebScrapeImagesResponse {
2648
- /**
2649
- * Array of scraped images
2650
- */
2651
- images: Array<BrandWebScrapeImagesResponse.Image>;
2652
- /**
2653
- * Indicates success
2654
- */
2655
- success: true;
2656
- /**
2657
- * The URL that was scraped
2658
- */
2659
- url: string;
2660
- }
2661
- export declare namespace BrandWebScrapeImagesResponse {
2662
- interface Image {
2663
- /**
2664
- * Alt text of the image, or null if not present
2665
- */
2666
- alt: string | null;
2667
- /**
2668
- * The HTML element the image was found in
2669
- */
2670
- element: 'img' | 'svg' | 'link' | 'source' | 'video';
2671
- /**
2672
- * The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
2673
- */
2674
- src: string;
2675
- /**
2676
- * The type/format of the src value
2677
- */
2678
- type: 'url' | 'html' | 'base64';
2679
- }
2680
- }
2681
- export interface BrandWebScrapeMdResponse {
2682
- /**
2683
- * Page content converted to GitHub Flavored Markdown
2684
- */
2685
- markdown: string;
2686
- /**
2687
- * Indicates success
2688
- */
2689
- success: true;
2690
- /**
2691
- * The URL that was scraped
2692
- */
2693
- url: string;
2694
- }
2695
- export interface BrandWebScrapeSitemapResponse {
2696
- /**
2697
- * The normalized domain that was crawled
2698
- */
2699
- domain: string;
2700
- /**
2701
- * Metadata about the sitemap crawl operation
2702
- */
2703
- meta: BrandWebScrapeSitemapResponse.Meta;
2704
- /**
2705
- * Indicates success
2706
- */
2707
- success: true;
2708
- /**
2709
- * Array of discovered page URLs from the sitemap (max 500)
2710
- */
2711
- urls: Array<string>;
2712
- }
2713
- export declare namespace BrandWebScrapeSitemapResponse {
2714
- /**
2715
- * Metadata about the sitemap crawl operation
2716
- */
2717
- interface Meta {
2718
- /**
2719
- * Number of errors encountered during crawling
2720
- */
2721
- errors: number;
2722
- /**
2723
- * Total number of sitemap files discovered
2724
- */
2725
- sitemapsDiscovered: number;
2726
- /**
2727
- * Number of sitemap files successfully fetched and parsed
2728
- */
2729
- sitemapsFetched: number;
2730
- /**
2731
- * Number of sitemap files skipped (due to errors, timeouts, or limits)
2732
- */
2733
- sitemapsSkipped: number;
2734
- }
2735
- }
2736
1976
  export interface BrandRetrieveParams {
2737
1977
  /**
2738
1978
  * Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
@@ -2743,7 +1983,7 @@ export interface BrandRetrieveParams {
2743
1983
  * Optional parameter to force the language of the retrieved brand data. Works with
2744
1984
  * all three lookup methods.
2745
1985
  */
2746
- force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
1986
+ force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cantonese' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'korean' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'thai' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2747
1987
  /**
2748
1988
  * Optional parameter to optimize the API call for maximum speed. When set to true,
2749
1989
  * the API will skip time-consuming operations for faster response at the cost of
@@ -2757,157 +1997,6 @@ export interface BrandRetrieveParams {
2757
1997
  */
2758
1998
  timeoutMS?: number;
2759
1999
  }
2760
- export interface BrandAIProductParams {
2761
- /**
2762
- * The product page URL to extract product data from.
2763
- */
2764
- url: string;
2765
- /**
2766
- * Optional timeout in milliseconds for the request. Maximum allowed value is
2767
- * 300000ms (5 minutes).
2768
- */
2769
- timeoutMS?: number;
2770
- }
2771
- export type BrandAIProductsParams = BrandAIProductsParams.ByDomain | BrandAIProductsParams.ByDirectURL;
2772
- export declare namespace BrandAIProductsParams {
2773
- interface ByDomain {
2774
- /**
2775
- * The domain name to analyze.
2776
- */
2777
- domain: string;
2778
- /**
2779
- * Maximum number of products to extract.
2780
- */
2781
- maxProducts?: number;
2782
- /**
2783
- * Optional timeout in milliseconds for the request. Maximum allowed value is
2784
- * 300000ms (5 minutes).
2785
- */
2786
- timeoutMS?: number;
2787
- }
2788
- interface ByDirectURL {
2789
- /**
2790
- * A specific URL to use directly as the starting point for extraction without
2791
- * domain resolution.
2792
- */
2793
- directUrl: string;
2794
- /**
2795
- * Maximum number of products to extract.
2796
- */
2797
- maxProducts?: number;
2798
- /**
2799
- * Optional timeout in milliseconds for the request. Maximum allowed value is
2800
- * 300000ms (5 minutes).
2801
- */
2802
- timeoutMS?: number;
2803
- }
2804
- }
2805
- export interface BrandAIQueryParams {
2806
- /**
2807
- * Array of data points to extract from the website
2808
- */
2809
- data_to_extract: Array<BrandAIQueryParams.DataToExtract>;
2810
- /**
2811
- * The domain name to analyze
2812
- */
2813
- domain: string;
2814
- /**
2815
- * Optional object specifying which pages to analyze
2816
- */
2817
- specific_pages?: BrandAIQueryParams.SpecificPages;
2818
- /**
2819
- * Optional timeout in milliseconds for the request. If the request takes longer
2820
- * than this value, it will be aborted with a 408 status code. Maximum allowed
2821
- * value is 300000ms (5 minutes).
2822
- */
2823
- timeoutMS?: number;
2824
- }
2825
- export declare namespace BrandAIQueryParams {
2826
- interface DataToExtract {
2827
- /**
2828
- * Description of what to extract
2829
- */
2830
- datapoint_description: string;
2831
- /**
2832
- * Example of the expected value
2833
- */
2834
- datapoint_example: string;
2835
- /**
2836
- * Name of the data point to extract
2837
- */
2838
- datapoint_name: string;
2839
- /**
2840
- * Type of the data point
2841
- */
2842
- datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
2843
- /**
2844
- * Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
2845
- * Use 'object' to extract an array of objects matching a schema.
2846
- */
2847
- datapoint_list_type?: 'string' | 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url' | 'object';
2848
- /**
2849
- * Schema definition for objects when datapoint_list_type is 'object'. Provide a
2850
- * map of field names to their scalar types.
2851
- */
2852
- datapoint_object_schema?: {
2853
- [key: string]: 'string' | 'number' | 'date' | 'boolean';
2854
- };
2855
- }
2856
- /**
2857
- * Optional object specifying which pages to analyze
2858
- */
2859
- interface SpecificPages {
2860
- /**
2861
- * Whether to analyze the about us page
2862
- */
2863
- about_us?: boolean;
2864
- /**
2865
- * Whether to analyze the blog
2866
- */
2867
- blog?: boolean;
2868
- /**
2869
- * Whether to analyze the careers page
2870
- */
2871
- careers?: boolean;
2872
- /**
2873
- * Whether to analyze the contact us page
2874
- */
2875
- contact_us?: boolean;
2876
- /**
2877
- * Whether to analyze the FAQ page
2878
- */
2879
- faq?: boolean;
2880
- /**
2881
- * Whether to analyze the home page
2882
- */
2883
- home_page?: boolean;
2884
- /**
2885
- * Whether to analyze the pricing page
2886
- */
2887
- pricing?: boolean;
2888
- /**
2889
- * Whether to analyze the privacy policy page
2890
- */
2891
- privacy_policy?: boolean;
2892
- /**
2893
- * Whether to analyze the terms and conditions page
2894
- */
2895
- terms_and_conditions?: boolean;
2896
- }
2897
- }
2898
- export interface BrandFontsParams {
2899
- /**
2900
- * Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The
2901
- * domain will be automatically normalized and validated.
2902
- */
2903
- domain: string;
2904
- /**
2905
- * Optional timeout in milliseconds for the request. If the request takes longer
2906
- * than this value, it will be aborted with a 408 status code. Maximum allowed
2907
- * value is 300000ms (5 minutes).
2908
- */
2909
- timeoutMS?: number;
2910
- }
2911
2000
  export interface BrandIdentifyFromTransactionParams {
2912
2001
  /**
2913
2002
  * Transaction information to identify the brand
@@ -2925,7 +2014,7 @@ export interface BrandIdentifyFromTransactionParams {
2925
2014
  /**
2926
2015
  * Optional parameter to force the language of the retrieved brand data.
2927
2016
  */
2928
- force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2017
+ force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cantonese' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'korean' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'thai' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2929
2018
  /**
2930
2019
  * When set to true, the API will perform an additional verification steps to
2931
2020
  * ensure the identified brand matches the transaction with high confidence.
@@ -2954,32 +2043,6 @@ export interface BrandIdentifyFromTransactionParams {
2954
2043
  */
2955
2044
  timeoutMS?: number;
2956
2045
  }
2957
- export interface BrandPrefetchParams {
2958
- /**
2959
- * Domain name to prefetch brand data for
2960
- */
2961
- domain: string;
2962
- /**
2963
- * Optional timeout in milliseconds for the request. If the request takes longer
2964
- * than this value, it will be aborted with a 408 status code. Maximum allowed
2965
- * value is 300000ms (5 minutes).
2966
- */
2967
- timeoutMS?: number;
2968
- }
2969
- export interface BrandPrefetchByEmailParams {
2970
- /**
2971
- * Email address to prefetch brand data for. The domain will be extracted from the
2972
- * email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
2973
- * addresses are not allowed.
2974
- */
2975
- email: string;
2976
- /**
2977
- * Optional timeout in milliseconds for the request. If the request takes longer
2978
- * than this value, it will be aborted with a 408 status code. Maximum allowed
2979
- * value is 300000ms (5 minutes).
2980
- */
2981
- timeoutMS?: number;
2982
- }
2983
2046
  export interface BrandRetrieveByEmailParams {
2984
2047
  /**
2985
2048
  * Email address to retrieve brand data for (e.g., 'contact@example.com'). The
@@ -2990,7 +2053,7 @@ export interface BrandRetrieveByEmailParams {
2990
2053
  /**
2991
2054
  * Optional parameter to force the language of the retrieved brand data.
2992
2055
  */
2993
- force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2056
+ force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cantonese' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'korean' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'thai' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2994
2057
  /**
2995
2058
  * Optional parameter to optimize the API call for maximum speed. When set to true,
2996
2059
  * the API will skip time-consuming operations for faster response at the cost of
@@ -3014,7 +2077,7 @@ export interface BrandRetrieveByIsinParams {
3014
2077
  /**
3015
2078
  * Optional parameter to force the language of the retrieved brand data.
3016
2079
  */
3017
- force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2080
+ force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cantonese' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'korean' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'thai' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
3018
2081
  /**
3019
2082
  * Optional parameter to optimize the API call for maximum speed. When set to true,
3020
2083
  * the API will skip time-consuming operations for faster response at the cost of
@@ -3034,10 +2097,15 @@ export interface BrandRetrieveByNameParams {
3034
2097
  * Corporation'). Must be 3-30 characters.
3035
2098
  */
3036
2099
  name: string;
2100
+ /**
2101
+ * Optional country code (GL parameter) to specify the country. This affects the
2102
+ * geographic location used for search queries.
2103
+ */
2104
+ 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';
3037
2105
  /**
3038
2106
  * Optional parameter to force the language of the retrieved brand data.
3039
2107
  */
3040
- force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2108
+ force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cantonese' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'korean' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'thai' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
3041
2109
  /**
3042
2110
  * Optional parameter to optimize the API call for maximum speed. When set to true,
3043
2111
  * the API will skip time-consuming operations for faster response at the cost of
@@ -3060,7 +2128,7 @@ export interface BrandRetrieveByTickerParams {
3060
2128
  /**
3061
2129
  * Optional parameter to force the language of the retrieved brand data.
3062
2130
  */
3063
- force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
2131
+ force_language?: 'albanian' | 'arabic' | 'azeri' | 'bengali' | 'bulgarian' | 'cantonese' | 'cebuano' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'farsi' | 'finnish' | 'french' | 'german' | 'hausa' | 'hawaiian' | 'hindi' | 'hungarian' | 'icelandic' | 'indonesian' | 'italian' | 'kazakh' | 'korean' | 'kyrgyz' | 'latin' | 'latvian' | 'lithuanian' | 'macedonian' | 'mongolian' | 'nepali' | 'norwegian' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'serbian' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'swahili' | 'swedish' | 'tagalog' | 'thai' | 'turkish' | 'ukrainian' | 'urdu' | 'uzbek' | 'vietnamese' | 'welsh';
3064
2132
  /**
3065
2133
  * Optional parameter to optimize the API call for maximum speed. When set to true,
3066
2134
  * the API will skip time-consuming operations for faster response at the cost of
@@ -3078,29 +2146,6 @@ export interface BrandRetrieveByTickerParams {
3078
2146
  */
3079
2147
  timeoutMS?: number;
3080
2148
  }
3081
- export interface BrandRetrieveNaicsParams {
3082
- /**
3083
- * Brand domain or title to retrieve NAICS code for. If a valid domain is provided
3084
- * in `input`, it will be used for classification, otherwise, we will search for
3085
- * the brand using the provided title.
3086
- */
3087
- input: string;
3088
- /**
3089
- * Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
3090
- * to 5.
3091
- */
3092
- maxResults?: number;
3093
- /**
3094
- * Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
3095
- */
3096
- minResults?: number;
3097
- /**
3098
- * Optional timeout in milliseconds for the request. If the request takes longer
3099
- * than this value, it will be aborted with a 408 status code. Maximum allowed
3100
- * value is 300000ms (5 minutes).
3101
- */
3102
- timeoutMS?: number;
3103
- }
3104
2149
  export interface BrandRetrieveSimplifiedParams {
3105
2150
  /**
3106
2151
  * Domain name to retrieve simplified brand data for
@@ -3113,96 +2158,7 @@ export interface BrandRetrieveSimplifiedParams {
3113
2158
  */
3114
2159
  timeoutMS?: number;
3115
2160
  }
3116
- export interface BrandScreenshotParams {
3117
- /**
3118
- * Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
3119
- * domain will be automatically normalized and validated.
3120
- */
3121
- domain: string;
3122
- /**
3123
- * Optional parameter to determine screenshot type. If 'true', takes a full page
3124
- * screenshot capturing all content. If 'false' or not provided, takes a viewport
3125
- * screenshot (standard browser view).
3126
- */
3127
- fullScreenshot?: 'true' | 'false';
3128
- /**
3129
- * Optional parameter to specify which page type to screenshot. If provided, the
3130
- * system will scrape the domain's links and use heuristics to find the most
3131
- * appropriate URL for the specified page type (30 supported languages). If not
3132
- * provided, screenshots the main domain landing page.
3133
- */
3134
- page?: 'login' | 'signup' | 'blog' | 'careers' | 'pricing' | 'terms' | 'privacy' | 'contact';
3135
- /**
3136
- * Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
3137
- * faster capture with basic quality. If 'quality', optimizes for higher quality
3138
- * with longer wait times. Defaults to 'quality' if not provided.
3139
- */
3140
- prioritize?: 'speed' | 'quality';
3141
- }
3142
- export interface BrandStyleguideParams {
3143
- /**
3144
- * A specific URL to fetch the styleguide from directly, bypassing domain
3145
- * resolution (e.g., 'https://example.com/design-system').
3146
- */
3147
- directUrl?: string;
3148
- /**
3149
- * Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
3150
- * domain will be automatically normalized and validated.
3151
- */
3152
- domain?: string;
3153
- /**
3154
- * Optional parameter to prioritize screenshot capture for styleguide extraction.
3155
- * If 'speed', optimizes for faster capture with basic quality. If 'quality',
3156
- * optimizes for higher quality with longer wait times. Defaults to 'quality' if
3157
- * not provided.
3158
- */
3159
- prioritize?: 'speed' | 'quality';
3160
- /**
3161
- * Optional timeout in milliseconds for the request. If the request takes longer
3162
- * than this value, it will be aborted with a 408 status code. Maximum allowed
3163
- * value is 300000ms (5 minutes).
3164
- */
3165
- timeoutMS?: number;
3166
- }
3167
- export interface BrandWebScrapeHTMLParams {
3168
- /**
3169
- * Full URL to scrape (must include http:// or https:// protocol)
3170
- */
3171
- url: string;
3172
- }
3173
- export interface BrandWebScrapeImagesParams {
3174
- /**
3175
- * Full URL to scrape images from (must include http:// or https:// protocol)
3176
- */
3177
- url: string;
3178
- }
3179
- export interface BrandWebScrapeMdParams {
3180
- /**
3181
- * Full URL to scrape and convert to markdown (must include http:// or https://
3182
- * protocol)
3183
- */
3184
- url: string;
3185
- /**
3186
- * Include image references in Markdown output
3187
- */
3188
- includeImages?: boolean;
3189
- /**
3190
- * Preserve hyperlinks in Markdown output
3191
- */
3192
- includeLinks?: boolean;
3193
- /**
3194
- * Shorten base64-encoded image data in the Markdown output
3195
- */
3196
- shortenBase64Images?: boolean;
3197
- }
3198
- export interface BrandWebScrapeSitemapParams {
3199
- /**
3200
- * Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
3201
- * automatically normalized and validated.
3202
- */
3203
- domain: string;
3204
- }
3205
2161
  export declare namespace Brand {
3206
- export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIProductResponse as BrandAIProductResponse, type BrandAIProductsResponse as BrandAIProductsResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandFontsResponse as BrandFontsResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, type BrandPrefetchByEmailResponse as BrandPrefetchByEmailResponse, type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse, type BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse, type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse, type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse, type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse, type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse, type BrandScreenshotResponse as BrandScreenshotResponse, type BrandStyleguideResponse as BrandStyleguideResponse, type BrandWebScrapeHTMLResponse as BrandWebScrapeHTMLResponse, type BrandWebScrapeImagesResponse as BrandWebScrapeImagesResponse, type BrandWebScrapeMdResponse as BrandWebScrapeMdResponse, type BrandWebScrapeSitemapResponse as BrandWebScrapeSitemapResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandAIProductParams as BrandAIProductParams, type BrandAIProductsParams as BrandAIProductsParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandFontsParams as BrandFontsParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, type BrandPrefetchByEmailParams as BrandPrefetchByEmailParams, type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams, type BrandRetrieveByIsinParams as BrandRetrieveByIsinParams, type BrandRetrieveByNameParams as BrandRetrieveByNameParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, type BrandScreenshotParams as BrandScreenshotParams, type BrandStyleguideParams as BrandStyleguideParams, type BrandWebScrapeHTMLParams as BrandWebScrapeHTMLParams, type BrandWebScrapeImagesParams as BrandWebScrapeImagesParams, type BrandWebScrapeMdParams as BrandWebScrapeMdParams, type BrandWebScrapeSitemapParams as BrandWebScrapeSitemapParams, };
2162
+ export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse, type BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse, type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse, type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse, type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams, type BrandRetrieveByIsinParams as BrandRetrieveByIsinParams, type BrandRetrieveByNameParams as BrandRetrieveByNameParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, };
3207
2163
  }
3208
2164
  //# sourceMappingURL=brand.d.mts.map