context.dev 0.2.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 +10 -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 +7 -1056
  20. package/resources/brand.d.mts.map +1 -1
  21. package/resources/brand.d.ts +7 -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 +66 -1417
  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
@@ -13,41 +13,6 @@ export class Brand extends APIResource {
13
13
  return this._client.get('/brand/retrieve', { query, ...options });
14
14
  }
15
15
 
16
- /**
17
- * Beta feature: Given a single URL, determines if it is a product detail page,
18
- * classifies the platform/product type, and extracts the product information.
19
- * Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites.
20
- */
21
- aiProduct(body: BrandAIProductParams, options?: RequestOptions): APIPromise<BrandAIProductResponse> {
22
- return this._client.post('/brand/ai/product', { body, ...options });
23
- }
24
-
25
- /**
26
- * Beta feature: Extract product information from a brand's website. Brand.dev will
27
- * analyze the website and return a list of products with details such as name,
28
- * description, image, pricing, features, and more.
29
- */
30
- aiProducts(body: BrandAIProductsParams, options?: RequestOptions): APIPromise<BrandAIProductsResponse> {
31
- return this._client.post('/brand/ai/products', { body, ...options });
32
- }
33
-
34
- /**
35
- * Use AI to extract specific data points from a brand's website. The AI will crawl
36
- * the website and extract the requested information based on the provided data
37
- * points.
38
- */
39
- aiQuery(body: BrandAIQueryParams, options?: RequestOptions): APIPromise<BrandAIQueryResponse> {
40
- return this._client.post('/brand/ai/query', { body, ...options });
41
- }
42
-
43
- /**
44
- * Extract font information from a brand's website including font families, usage
45
- * statistics, fallbacks, and element/word counts.
46
- */
47
- fonts(query: BrandFontsParams, options?: RequestOptions): APIPromise<BrandFontsResponse> {
48
- return this._client.get('/brand/fonts', { query, ...options });
49
- }
50
-
51
16
  /**
52
17
  * Endpoint specially designed for platforms that want to identify transaction data
53
18
  * by the transaction title.
@@ -59,31 +24,6 @@ export class Brand extends APIResource {
59
24
  return this._client.get('/brand/transaction_identifier', { query, ...options });
60
25
  }
61
26
 
62
- /**
63
- * Signal that you may fetch brand data for a particular domain soon to improve
64
- * latency. This endpoint does not charge credits and is available for paid
65
- * customers to optimize future requests. [You must be on a paid plan to use this
66
- * endpoint]
67
- */
68
- prefetch(body: BrandPrefetchParams, options?: RequestOptions): APIPromise<BrandPrefetchResponse> {
69
- return this._client.post('/brand/prefetch', { body, ...options });
70
- }
71
-
72
- /**
73
- * Signal that you may fetch brand data for a particular domain soon to improve
74
- * latency. This endpoint accepts an email address, extracts the domain from it,
75
- * validates that it's not a disposable or free email provider, and queues the
76
- * domain for prefetching. This endpoint does not charge credits and is available
77
- * for paid customers to optimize future requests. [You must be on a paid plan to
78
- * use this endpoint]
79
- */
80
- prefetchByEmail(
81
- body: BrandPrefetchByEmailParams,
82
- options?: RequestOptions,
83
- ): APIPromise<BrandPrefetchByEmailResponse> {
84
- return this._client.post('/brand/prefetch-by-email', { body, ...options });
85
- }
86
-
87
27
  /**
88
28
  * Retrieve brand information using an email address while detecting disposable and
89
29
  * free email addresses. This endpoint extracts the domain from the email address
@@ -131,16 +71,6 @@ export class Brand extends APIResource {
131
71
  return this._client.get('/brand/retrieve-by-ticker', { query, ...options });
132
72
  }
133
73
 
134
- /**
135
- * Endpoint to classify any brand into a 2022 NAICS code.
136
- */
137
- retrieveNaics(
138
- query: BrandRetrieveNaicsParams,
139
- options?: RequestOptions,
140
- ): APIPromise<BrandRetrieveNaicsResponse> {
141
- return this._client.get('/brand/naics', { query, ...options });
142
- }
143
-
144
74
  /**
145
75
  * Returns a simplified version of brand data containing only essential
146
76
  * information: domain, title, colors, logos, and backdrops. This endpoint is
@@ -152,73 +82,6 @@ export class Brand extends APIResource {
152
82
  ): APIPromise<BrandRetrieveSimplifiedResponse> {
153
83
  return this._client.get('/brand/retrieve-simplified', { query, ...options });
154
84
  }
155
-
156
- /**
157
- * Capture a screenshot of a website. Supports both viewport (standard browser
158
- * view) and full-page screenshots. Can also screenshot specific page types (login,
159
- * pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
160
- * the uploaded screenshot image hosted on our CDN.
161
- */
162
- screenshot(query: BrandScreenshotParams, options?: RequestOptions): APIPromise<BrandScreenshotResponse> {
163
- return this._client.get('/brand/screenshot', { query, ...options });
164
- }
165
-
166
- /**
167
- * Automatically extract comprehensive design system information from a brand's
168
- * website including colors, typography, spacing, shadows, and UI components.
169
- * Either 'domain' or 'directUrl' must be provided as a query parameter, but not
170
- * both.
171
- */
172
- styleguide(
173
- query: BrandStyleguideParams | null | undefined = {},
174
- options?: RequestOptions,
175
- ): APIPromise<BrandStyleguideResponse> {
176
- return this._client.get('/brand/styleguide', { query, ...options });
177
- }
178
-
179
- /**
180
- * Scrapes the given URL and returns the raw HTML content of the page. Uses
181
- * automatic proxy escalation to handle blocked sites.
182
- */
183
- webScrapeHTML(
184
- query: BrandWebScrapeHTMLParams,
185
- options?: RequestOptions,
186
- ): APIPromise<BrandWebScrapeHTMLResponse> {
187
- return this._client.get('/web/scrape/html', { query, ...options });
188
- }
189
-
190
- /**
191
- * Scrapes all images from the given URL. Extracts images from img, svg,
192
- * picture/source, link, and video elements including inline SVGs, base64 data
193
- * URIs, and standard URLs.
194
- */
195
- webScrapeImages(
196
- query: BrandWebScrapeImagesParams,
197
- options?: RequestOptions,
198
- ): APIPromise<BrandWebScrapeImagesResponse> {
199
- return this._client.get('/web/scrape/images', { query, ...options });
200
- }
201
-
202
- /**
203
- * Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown
204
- * (GFM), and returns the result. Uses automatic proxy escalation to handle blocked
205
- * sites.
206
- */
207
- webScrapeMd(query: BrandWebScrapeMdParams, options?: RequestOptions): APIPromise<BrandWebScrapeMdResponse> {
208
- return this._client.get('/web/scrape/markdown', { query, ...options });
209
- }
210
-
211
- /**
212
- * Crawls the sitemap of the given domain and returns all discovered page URLs.
213
- * Supports sitemap index files (recursive), parallel fetching with concurrency
214
- * control, deduplication, and filters out non-page resources (images, PDFs, etc.).
215
- */
216
- webScrapeSitemap(
217
- query: BrandWebScrapeSitemapParams,
218
- options?: RequestOptions,
219
- ): APIPromise<BrandWebScrapeSitemapResponse> {
220
- return this._client.get('/web/scrape/sitemap', { query, ...options });
221
- }
222
85
  }
223
86
 
224
87
  export interface BrandRetrieveResponse {
@@ -820,269 +683,6 @@ export namespace BrandRetrieveResponse {
820
683
  }
821
684
  }
822
685
 
823
- export interface BrandAIProductResponse {
824
- /**
825
- * Whether the given URL is a product detail page
826
- */
827
- is_product_page?: boolean;
828
-
829
- /**
830
- * The detected ecommerce platform, or null if not a product page
831
- */
832
- platform?: 'amazon' | 'tiktok_shop' | 'etsy' | 'generic' | null;
833
-
834
- /**
835
- * The extracted product data, or null if not a product page
836
- */
837
- product?: BrandAIProductResponse.Product | null;
838
- }
839
-
840
- export namespace BrandAIProductResponse {
841
- /**
842
- * The extracted product data, or null if not a product page
843
- */
844
- export interface Product {
845
- /**
846
- * Description of the product
847
- */
848
- description: string;
849
-
850
- /**
851
- * List of product features
852
- */
853
- features: Array<string>;
854
-
855
- /**
856
- * URLs to product images on the page (up to 7)
857
- */
858
- images: Array<string>;
859
-
860
- /**
861
- * Name of the product
862
- */
863
- name: string;
864
-
865
- /**
866
- * Tags associated with the product
867
- */
868
- tags: Array<string>;
869
-
870
- /**
871
- * Target audience for the product (array of strings)
872
- */
873
- target_audience: Array<string>;
874
-
875
- /**
876
- * Billing frequency for the product
877
- */
878
- billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
879
-
880
- /**
881
- * Category of the product
882
- */
883
- category?: string | null;
884
-
885
- /**
886
- * Currency code for the price (e.g., USD, EUR)
887
- */
888
- currency?: string | null;
889
-
890
- /**
891
- * URL to the product image
892
- */
893
- image_url?: string | null;
894
-
895
- /**
896
- * Price of the product
897
- */
898
- price?: number | null;
899
-
900
- /**
901
- * Pricing model for the product
902
- */
903
- pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
904
-
905
- /**
906
- * URL to the product page
907
- */
908
- url?: string | null;
909
- }
910
- }
911
-
912
- export interface BrandAIProductsResponse {
913
- /**
914
- * Array of products extracted from the website
915
- */
916
- products?: Array<BrandAIProductsResponse.Product>;
917
- }
918
-
919
- export namespace BrandAIProductsResponse {
920
- export interface Product {
921
- /**
922
- * Description of the product
923
- */
924
- description: string;
925
-
926
- /**
927
- * List of product features
928
- */
929
- features: Array<string>;
930
-
931
- /**
932
- * URLs to product images on the page (up to 7)
933
- */
934
- images: Array<string>;
935
-
936
- /**
937
- * Name of the product
938
- */
939
- name: string;
940
-
941
- /**
942
- * Tags associated with the product
943
- */
944
- tags: Array<string>;
945
-
946
- /**
947
- * Target audience for the product (array of strings)
948
- */
949
- target_audience: Array<string>;
950
-
951
- /**
952
- * Billing frequency for the product
953
- */
954
- billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
955
-
956
- /**
957
- * Category of the product
958
- */
959
- category?: string | null;
960
-
961
- /**
962
- * Currency code for the price (e.g., USD, EUR)
963
- */
964
- currency?: string | null;
965
-
966
- /**
967
- * URL to the product image
968
- */
969
- image_url?: string | null;
970
-
971
- /**
972
- * Price of the product
973
- */
974
- price?: number | null;
975
-
976
- /**
977
- * Pricing model for the product
978
- */
979
- pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
980
-
981
- /**
982
- * URL to the product page
983
- */
984
- url?: string | null;
985
- }
986
- }
987
-
988
- export interface BrandAIQueryResponse {
989
- /**
990
- * Array of extracted data points
991
- */
992
- data_extracted?: Array<BrandAIQueryResponse.DataExtracted>;
993
-
994
- /**
995
- * The domain that was analyzed
996
- */
997
- domain?: string;
998
-
999
- /**
1000
- * Status of the response, e.g., 'ok'
1001
- */
1002
- status?: string;
1003
-
1004
- /**
1005
- * List of URLs that were analyzed
1006
- */
1007
- urls_analyzed?: Array<string>;
1008
- }
1009
-
1010
- export namespace BrandAIQueryResponse {
1011
- export interface DataExtracted {
1012
- /**
1013
- * Name of the extracted data point
1014
- */
1015
- datapoint_name?: string;
1016
-
1017
- /**
1018
- * Value of the extracted data point. Can be a primitive type, an array of
1019
- * primitives, or an array of objects when datapoint_list_type is 'object'.
1020
- */
1021
- datapoint_value?: string | number | boolean | Array<string> | Array<number> | Array<unknown>;
1022
- }
1023
- }
1024
-
1025
- export interface BrandFontsResponse {
1026
- /**
1027
- * HTTP status code, e.g., 200
1028
- */
1029
- code: number;
1030
-
1031
- /**
1032
- * The normalized domain that was processed
1033
- */
1034
- domain: string;
1035
-
1036
- /**
1037
- * Array of font usage information
1038
- */
1039
- fonts: Array<BrandFontsResponse.Font>;
1040
-
1041
- /**
1042
- * Status of the response, e.g., 'ok'
1043
- */
1044
- status: string;
1045
- }
1046
-
1047
- export namespace BrandFontsResponse {
1048
- export interface Font {
1049
- /**
1050
- * Array of fallback font families
1051
- */
1052
- fallbacks: Array<string>;
1053
-
1054
- /**
1055
- * Font family name
1056
- */
1057
- font: string;
1058
-
1059
- /**
1060
- * Number of elements using this font
1061
- */
1062
- num_elements: number;
1063
-
1064
- /**
1065
- * Number of words using this font
1066
- */
1067
- num_words: number;
1068
-
1069
- /**
1070
- * Percentage of elements using this font
1071
- */
1072
- percent_elements: number;
1073
-
1074
- /**
1075
- * Percentage of words using this font
1076
- */
1077
- percent_words: number;
1078
-
1079
- /**
1080
- * Array of CSS selectors or element types where this font is used
1081
- */
1082
- uses: Array<string>;
1083
- }
1084
- }
1085
-
1086
686
  export interface BrandIdentifyFromTransactionResponse {
1087
687
  /**
1088
688
  * Detailed brand information
@@ -1682,40 +1282,6 @@ export namespace BrandIdentifyFromTransactionResponse {
1682
1282
  }
1683
1283
  }
1684
1284
 
1685
- export interface BrandPrefetchResponse {
1686
- /**
1687
- * The domain that was queued for prefetching
1688
- */
1689
- domain?: string;
1690
-
1691
- /**
1692
- * Success message
1693
- */
1694
- message?: string;
1695
-
1696
- /**
1697
- * Status of the response, e.g., 'ok'
1698
- */
1699
- status?: string;
1700
- }
1701
-
1702
- export interface BrandPrefetchByEmailResponse {
1703
- /**
1704
- * The domain that was queued for prefetching
1705
- */
1706
- domain?: string;
1707
-
1708
- /**
1709
- * Success message
1710
- */
1711
- message?: string;
1712
-
1713
- /**
1714
- * Status of the response, e.g., 'ok'
1715
- */
1716
- status?: string;
1717
- }
1718
-
1719
1285
  export interface BrandRetrieveByEmailResponse {
1720
1286
  /**
1721
1287
  * Detailed brand information
@@ -4112,78 +3678,37 @@ export namespace BrandRetrieveByTickerResponse {
4112
3678
  }
4113
3679
  }
4114
3680
 
4115
- export interface BrandRetrieveNaicsResponse {
3681
+ export interface BrandRetrieveSimplifiedResponse {
4116
3682
  /**
4117
- * Array of NAICS codes and titles.
3683
+ * Simplified brand information
4118
3684
  */
4119
- codes?: Array<BrandRetrieveNaicsResponse.Code>;
3685
+ brand?: BrandRetrieveSimplifiedResponse.Brand;
4120
3686
 
4121
3687
  /**
4122
- * Domain found for the brand
3688
+ * HTTP status code of the response
4123
3689
  */
4124
- domain?: string;
3690
+ code?: number;
4125
3691
 
4126
3692
  /**
4127
3693
  * Status of the response, e.g., 'ok'
4128
3694
  */
4129
3695
  status?: string;
3696
+ }
4130
3697
 
3698
+ export namespace BrandRetrieveSimplifiedResponse {
4131
3699
  /**
4132
- * Industry classification type, for naics api it will be `naics`
3700
+ * Simplified brand information
4133
3701
  */
4134
- type?: string;
4135
- }
4136
-
4137
- export namespace BrandRetrieveNaicsResponse {
4138
- export interface Code {
3702
+ export interface Brand {
4139
3703
  /**
4140
- * NAICS code
3704
+ * An array of backdrop images for the brand
4141
3705
  */
4142
- code: string;
3706
+ backdrops?: Array<Brand.Backdrop>;
4143
3707
 
4144
3708
  /**
4145
- * Confidence level for how well this NAICS code matches the company description
3709
+ * An array of brand colors
4146
3710
  */
4147
- confidence: 'high' | 'medium' | 'low';
4148
-
4149
- /**
4150
- * NAICS title
4151
- */
4152
- name: string;
4153
- }
4154
- }
4155
-
4156
- export interface BrandRetrieveSimplifiedResponse {
4157
- /**
4158
- * Simplified brand information
4159
- */
4160
- brand?: BrandRetrieveSimplifiedResponse.Brand;
4161
-
4162
- /**
4163
- * HTTP status code of the response
4164
- */
4165
- code?: number;
4166
-
4167
- /**
4168
- * Status of the response, e.g., 'ok'
4169
- */
4170
- status?: string;
4171
- }
4172
-
4173
- export namespace BrandRetrieveSimplifiedResponse {
4174
- /**
4175
- * Simplified brand information
4176
- */
4177
- export interface Brand {
4178
- /**
4179
- * An array of backdrop images for the brand
4180
- */
4181
- backdrops?: Array<Brand.Backdrop>;
4182
-
4183
- /**
4184
- * An array of brand colors
4185
- */
4186
- colors?: Array<Brand.Color>;
3711
+ colors?: Array<Brand.Color>;
4187
3712
 
4188
3713
  /**
4189
3714
  * The domain name of the brand
@@ -4288,573 +3813,45 @@ export namespace BrandRetrieveSimplifiedResponse {
4288
3813
  */
4289
3814
  type?: 'icon' | 'logo';
4290
3815
 
4291
- /**
4292
- * CDN hosted url of the logo (ready for display)
4293
- */
4294
- url?: string;
4295
- }
4296
-
4297
- export namespace Logo {
4298
- export interface Color {
4299
- /**
4300
- * Color in hexadecimal format
4301
- */
4302
- hex?: string;
4303
-
4304
- /**
4305
- * Name of the color
4306
- */
4307
- name?: string;
4308
- }
4309
-
4310
- /**
4311
- * Resolution of the logo image
4312
- */
4313
- export interface Resolution {
4314
- /**
4315
- * Aspect ratio of the image (width/height)
4316
- */
4317
- aspect_ratio?: number;
4318
-
4319
- /**
4320
- * Height of the image in pixels
4321
- */
4322
- height?: number;
4323
-
4324
- /**
4325
- * Width of the image in pixels
4326
- */
4327
- width?: number;
4328
- }
4329
- }
4330
- }
4331
- }
4332
-
4333
- export interface BrandScreenshotResponse {
4334
- /**
4335
- * HTTP status code
4336
- */
4337
- code?: number;
4338
-
4339
- /**
4340
- * The normalized domain that was processed
4341
- */
4342
- domain?: string;
4343
-
4344
- /**
4345
- * Public URL of the uploaded screenshot image
4346
- */
4347
- screenshot?: string;
4348
-
4349
- /**
4350
- * Type of screenshot that was captured
4351
- */
4352
- screenshotType?: 'viewport' | 'fullPage';
4353
-
4354
- /**
4355
- * Status of the response, e.g., 'ok'
4356
- */
4357
- status?: string;
4358
- }
4359
-
4360
- export interface BrandStyleguideResponse {
4361
- /**
4362
- * HTTP status code
4363
- */
4364
- code?: number;
4365
-
4366
- /**
4367
- * The normalized domain that was processed
4368
- */
4369
- domain?: string;
4370
-
4371
- /**
4372
- * Status of the response, e.g., 'ok'
4373
- */
4374
- status?: string;
4375
-
4376
- /**
4377
- * Comprehensive styleguide data extracted from the website
4378
- */
4379
- styleguide?: BrandStyleguideResponse.Styleguide;
4380
- }
4381
-
4382
- export namespace BrandStyleguideResponse {
4383
- /**
4384
- * Comprehensive styleguide data extracted from the website
4385
- */
4386
- export interface Styleguide {
4387
- /**
4388
- * Primary colors used on the website
4389
- */
4390
- colors?: Styleguide.Colors;
4391
-
4392
- /**
4393
- * UI component styles
4394
- */
4395
- components?: Styleguide.Components;
4396
-
4397
- /**
4398
- * Spacing system used on the website
4399
- */
4400
- elementSpacing?: Styleguide.ElementSpacing;
4401
-
4402
- /**
4403
- * The primary color mode of the website design
4404
- */
4405
- mode?: 'light' | 'dark';
4406
-
4407
- /**
4408
- * Shadow styles used on the website
4409
- */
4410
- shadows?: Styleguide.Shadows;
4411
-
4412
- /**
4413
- * Typography styles used on the website
4414
- */
4415
- typography?: Styleguide.Typography;
4416
- }
4417
-
4418
- export namespace Styleguide {
4419
- /**
4420
- * Primary colors used on the website
4421
- */
4422
- export interface Colors {
4423
- /**
4424
- * Accent color of the website (hex format)
4425
- */
4426
- accent?: string;
4427
-
4428
- /**
4429
- * Background color of the website (hex format)
4430
- */
4431
- background?: string;
4432
-
4433
- /**
4434
- * Text color of the website (hex format)
4435
- */
4436
- text?: string;
4437
- }
4438
-
4439
- /**
4440
- * UI component styles
4441
- */
4442
- export interface Components {
4443
- /**
4444
- * Button component styles
4445
- */
4446
- button?: Components.Button;
4447
-
4448
- /**
4449
- * Card component style
4450
- */
4451
- card?: Components.Card;
4452
- }
4453
-
4454
- export namespace Components {
4455
- /**
4456
- * Button component styles
4457
- */
4458
- export interface Button {
4459
- /**
4460
- * Link button style
4461
- */
4462
- link?: Button.Link;
4463
-
4464
- /**
4465
- * Primary button style
4466
- */
4467
- primary?: Button.Primary;
4468
-
4469
- /**
4470
- * Secondary button style
4471
- */
4472
- secondary?: Button.Secondary;
4473
- }
4474
-
4475
- export namespace Button {
4476
- /**
4477
- * Link button style
4478
- */
4479
- export interface Link {
4480
- backgroundColor?: string;
4481
-
4482
- borderColor?: string;
4483
-
4484
- borderRadius?: string;
4485
-
4486
- borderStyle?: string;
4487
-
4488
- borderWidth?: string;
4489
-
4490
- boxShadow?: string;
4491
-
4492
- color?: string;
4493
-
4494
- fontSize?: string;
4495
-
4496
- fontWeight?: number;
4497
-
4498
- padding?: string;
4499
-
4500
- textDecoration?: string;
4501
- }
4502
-
4503
- /**
4504
- * Primary button style
4505
- */
4506
- export interface Primary {
4507
- backgroundColor?: string;
4508
-
4509
- borderColor?: string;
4510
-
4511
- borderRadius?: string;
4512
-
4513
- borderStyle?: string;
4514
-
4515
- borderWidth?: string;
4516
-
4517
- boxShadow?: string;
4518
-
4519
- color?: string;
4520
-
4521
- fontSize?: string;
4522
-
4523
- fontWeight?: number;
4524
-
4525
- padding?: string;
4526
-
4527
- textDecoration?: string;
4528
- }
4529
-
4530
- /**
4531
- * Secondary button style
4532
- */
4533
- export interface Secondary {
4534
- backgroundColor?: string;
4535
-
4536
- borderColor?: string;
4537
-
4538
- borderRadius?: string;
4539
-
4540
- borderStyle?: string;
4541
-
4542
- borderWidth?: string;
4543
-
4544
- boxShadow?: string;
4545
-
4546
- color?: string;
4547
-
4548
- fontSize?: string;
4549
-
4550
- fontWeight?: number;
4551
-
4552
- padding?: string;
4553
-
4554
- textDecoration?: string;
4555
- }
4556
- }
4557
-
4558
- /**
4559
- * Card component style
4560
- */
4561
- export interface Card {
4562
- backgroundColor?: string;
4563
-
4564
- borderColor?: string;
4565
-
4566
- borderRadius?: string;
4567
-
4568
- borderStyle?: string;
4569
-
4570
- borderWidth?: string;
4571
-
4572
- boxShadow?: string;
4573
-
4574
- padding?: string;
4575
-
4576
- textColor?: string;
4577
- }
4578
- }
4579
-
4580
- /**
4581
- * Spacing system used on the website
4582
- */
4583
- export interface ElementSpacing {
4584
- /**
4585
- * Large spacing value
4586
- */
4587
- lg?: string;
4588
-
4589
- /**
4590
- * Medium spacing value
4591
- */
4592
- md?: string;
4593
-
4594
- /**
4595
- * Small spacing value
4596
- */
4597
- sm?: string;
4598
-
4599
- /**
4600
- * Extra large spacing value
4601
- */
4602
- xl?: string;
4603
-
4604
- /**
4605
- * Extra small spacing value
4606
- */
4607
- xs?: string;
4608
- }
4609
-
4610
- /**
4611
- * Shadow styles used on the website
4612
- */
4613
- export interface Shadows {
4614
- /**
4615
- * Inner shadow value
4616
- */
4617
- inner?: string;
4618
-
4619
- /**
4620
- * Large shadow value
4621
- */
4622
- lg?: string;
4623
-
4624
- /**
4625
- * Medium shadow value
4626
- */
4627
- md?: string;
4628
-
4629
- /**
4630
- * Small shadow value
4631
- */
4632
- sm?: string;
4633
-
4634
- /**
4635
- * Extra large shadow value
4636
- */
4637
- xl?: string;
4638
- }
4639
-
4640
- /**
4641
- * Typography styles used on the website
4642
- */
4643
- export interface Typography {
4644
- /**
4645
- * Heading styles
4646
- */
4647
- headings?: Typography.Headings;
4648
-
4649
- /**
4650
- * Paragraph text styles
4651
- */
4652
- p?: Typography.P;
4653
- }
4654
-
4655
- export namespace Typography {
4656
- /**
4657
- * Heading styles
4658
- */
4659
- export interface Headings {
4660
- h1?: Headings.H1;
4661
-
4662
- h2?: Headings.H2;
4663
-
4664
- h3?: Headings.H3;
4665
-
4666
- h4?: Headings.H4;
4667
- }
4668
-
4669
- export namespace Headings {
4670
- export interface H1 {
4671
- fontFamily?: string;
4672
-
4673
- fontSize?: string;
4674
-
4675
- fontWeight?: number;
4676
-
4677
- letterSpacing?: string;
4678
-
4679
- lineHeight?: string;
4680
- }
4681
-
4682
- export interface H2 {
4683
- fontFamily?: string;
4684
-
4685
- fontSize?: string;
4686
-
4687
- fontWeight?: number;
4688
-
4689
- letterSpacing?: string;
4690
-
4691
- lineHeight?: string;
4692
- }
4693
-
4694
- export interface H3 {
4695
- fontFamily?: string;
4696
-
4697
- fontSize?: string;
4698
-
4699
- fontWeight?: number;
4700
-
4701
- letterSpacing?: string;
4702
-
4703
- lineHeight?: string;
4704
- }
4705
-
4706
- export interface H4 {
4707
- fontFamily?: string;
4708
-
4709
- fontSize?: string;
4710
-
4711
- fontWeight?: number;
4712
-
4713
- letterSpacing?: string;
4714
-
4715
- lineHeight?: string;
4716
- }
4717
- }
4718
-
4719
- /**
4720
- * Paragraph text styles
4721
- */
4722
- export interface P {
4723
- fontFamily?: string;
4724
-
4725
- fontSize?: string;
4726
-
4727
- fontWeight?: number;
4728
-
4729
- letterSpacing?: string;
4730
-
4731
- lineHeight?: string;
4732
- }
4733
- }
4734
- }
4735
- }
4736
-
4737
- export interface BrandWebScrapeHTMLResponse {
4738
- /**
4739
- * Raw HTML content of the page
4740
- */
4741
- html: string;
4742
-
4743
- /**
4744
- * Indicates success
4745
- */
4746
- success: true;
4747
-
4748
- /**
4749
- * The URL that was scraped
4750
- */
4751
- url: string;
4752
- }
4753
-
4754
- export interface BrandWebScrapeImagesResponse {
4755
- /**
4756
- * Array of scraped images
4757
- */
4758
- images: Array<BrandWebScrapeImagesResponse.Image>;
4759
-
4760
- /**
4761
- * Indicates success
4762
- */
4763
- success: true;
4764
-
4765
- /**
4766
- * The URL that was scraped
4767
- */
4768
- url: string;
4769
- }
4770
-
4771
- export namespace BrandWebScrapeImagesResponse {
4772
- export interface Image {
4773
- /**
4774
- * Alt text of the image, or null if not present
4775
- */
4776
- alt: string | null;
4777
-
4778
- /**
4779
- * The HTML element the image was found in
4780
- */
4781
- element: 'img' | 'svg' | 'link' | 'source' | 'video';
4782
-
4783
- /**
4784
- * The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
4785
- */
4786
- src: string;
4787
-
4788
- /**
4789
- * The type/format of the src value
4790
- */
4791
- type: 'url' | 'html' | 'base64';
4792
- }
4793
- }
4794
-
4795
- export interface BrandWebScrapeMdResponse {
4796
- /**
4797
- * Page content converted to GitHub Flavored Markdown
4798
- */
4799
- markdown: string;
4800
-
4801
- /**
4802
- * Indicates success
4803
- */
4804
- success: true;
4805
-
4806
- /**
4807
- * The URL that was scraped
4808
- */
4809
- url: string;
4810
- }
4811
-
4812
- export interface BrandWebScrapeSitemapResponse {
4813
- /**
4814
- * The normalized domain that was crawled
4815
- */
4816
- domain: string;
4817
-
4818
- /**
4819
- * Metadata about the sitemap crawl operation
4820
- */
4821
- meta: BrandWebScrapeSitemapResponse.Meta;
4822
-
4823
- /**
4824
- * Indicates success
4825
- */
4826
- success: true;
4827
-
4828
- /**
4829
- * Array of discovered page URLs from the sitemap (max 500)
4830
- */
4831
- urls: Array<string>;
4832
- }
3816
+ /**
3817
+ * CDN hosted url of the logo (ready for display)
3818
+ */
3819
+ url?: string;
3820
+ }
4833
3821
 
4834
- export namespace BrandWebScrapeSitemapResponse {
4835
- /**
4836
- * Metadata about the sitemap crawl operation
4837
- */
4838
- export interface Meta {
4839
- /**
4840
- * Number of errors encountered during crawling
4841
- */
4842
- errors: number;
3822
+ export namespace Logo {
3823
+ export interface Color {
3824
+ /**
3825
+ * Color in hexadecimal format
3826
+ */
3827
+ hex?: string;
4843
3828
 
4844
- /**
4845
- * Total number of sitemap files discovered
4846
- */
4847
- sitemapsDiscovered: number;
3829
+ /**
3830
+ * Name of the color
3831
+ */
3832
+ name?: string;
3833
+ }
4848
3834
 
4849
- /**
4850
- * Number of sitemap files successfully fetched and parsed
4851
- */
4852
- sitemapsFetched: number;
3835
+ /**
3836
+ * Resolution of the logo image
3837
+ */
3838
+ export interface Resolution {
3839
+ /**
3840
+ * Aspect ratio of the image (width/height)
3841
+ */
3842
+ aspect_ratio?: number;
4853
3843
 
4854
- /**
4855
- * Number of sitemap files skipped (due to errors, timeouts, or limits)
4856
- */
4857
- sitemapsSkipped: number;
3844
+ /**
3845
+ * Height of the image in pixels
3846
+ */
3847
+ height?: number;
3848
+
3849
+ /**
3850
+ * Width of the image in pixels
3851
+ */
3852
+ width?: number;
3853
+ }
3854
+ }
4858
3855
  }
4859
3856
  }
4860
3857
 
@@ -4875,6 +3872,7 @@ export interface BrandRetrieveParams {
4875
3872
  | 'azeri'
4876
3873
  | 'bengali'
4877
3874
  | 'bulgarian'
3875
+ | 'cantonese'
4878
3876
  | 'cebuano'
4879
3877
  | 'croatian'
4880
3878
  | 'czech'
@@ -4894,6 +3892,7 @@ export interface BrandRetrieveParams {
4894
3892
  | 'indonesian'
4895
3893
  | 'italian'
4896
3894
  | 'kazakh'
3895
+ | 'korean'
4897
3896
  | 'kyrgyz'
4898
3897
  | 'latin'
4899
3898
  | 'latvian'
@@ -4916,6 +3915,7 @@ export interface BrandRetrieveParams {
4916
3915
  | 'swahili'
4917
3916
  | 'swedish'
4918
3917
  | 'tagalog'
3918
+ | 'thai'
4919
3919
  | 'turkish'
4920
3920
  | 'ukrainian'
4921
3921
  | 'urdu'
@@ -4938,185 +3938,6 @@ export interface BrandRetrieveParams {
4938
3938
  timeoutMS?: number;
4939
3939
  }
4940
3940
 
4941
- export interface BrandAIProductParams {
4942
- /**
4943
- * The product page URL to extract product data from.
4944
- */
4945
- url: string;
4946
-
4947
- /**
4948
- * Optional timeout in milliseconds for the request. Maximum allowed value is
4949
- * 300000ms (5 minutes).
4950
- */
4951
- timeoutMS?: number;
4952
- }
4953
-
4954
- export type BrandAIProductsParams = BrandAIProductsParams.ByDomain | BrandAIProductsParams.ByDirectURL;
4955
-
4956
- export declare namespace BrandAIProductsParams {
4957
- export interface ByDomain {
4958
- /**
4959
- * The domain name to analyze.
4960
- */
4961
- domain: string;
4962
-
4963
- /**
4964
- * Maximum number of products to extract.
4965
- */
4966
- maxProducts?: number;
4967
-
4968
- /**
4969
- * Optional timeout in milliseconds for the request. Maximum allowed value is
4970
- * 300000ms (5 minutes).
4971
- */
4972
- timeoutMS?: number;
4973
- }
4974
-
4975
- export interface ByDirectURL {
4976
- /**
4977
- * A specific URL to use directly as the starting point for extraction without
4978
- * domain resolution.
4979
- */
4980
- directUrl: string;
4981
-
4982
- /**
4983
- * Maximum number of products to extract.
4984
- */
4985
- maxProducts?: number;
4986
-
4987
- /**
4988
- * Optional timeout in milliseconds for the request. Maximum allowed value is
4989
- * 300000ms (5 minutes).
4990
- */
4991
- timeoutMS?: number;
4992
- }
4993
- }
4994
-
4995
- export interface BrandAIQueryParams {
4996
- /**
4997
- * Array of data points to extract from the website
4998
- */
4999
- data_to_extract: Array<BrandAIQueryParams.DataToExtract>;
5000
-
5001
- /**
5002
- * The domain name to analyze
5003
- */
5004
- domain: string;
5005
-
5006
- /**
5007
- * Optional object specifying which pages to analyze
5008
- */
5009
- specific_pages?: BrandAIQueryParams.SpecificPages;
5010
-
5011
- /**
5012
- * Optional timeout in milliseconds for the request. If the request takes longer
5013
- * than this value, it will be aborted with a 408 status code. Maximum allowed
5014
- * value is 300000ms (5 minutes).
5015
- */
5016
- timeoutMS?: number;
5017
- }
5018
-
5019
- export namespace BrandAIQueryParams {
5020
- export interface DataToExtract {
5021
- /**
5022
- * Description of what to extract
5023
- */
5024
- datapoint_description: string;
5025
-
5026
- /**
5027
- * Example of the expected value
5028
- */
5029
- datapoint_example: string;
5030
-
5031
- /**
5032
- * Name of the data point to extract
5033
- */
5034
- datapoint_name: string;
5035
-
5036
- /**
5037
- * Type of the data point
5038
- */
5039
- datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
5040
-
5041
- /**
5042
- * Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
5043
- * Use 'object' to extract an array of objects matching a schema.
5044
- */
5045
- datapoint_list_type?: 'string' | 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url' | 'object';
5046
-
5047
- /**
5048
- * Schema definition for objects when datapoint_list_type is 'object'. Provide a
5049
- * map of field names to their scalar types.
5050
- */
5051
- datapoint_object_schema?: { [key: string]: 'string' | 'number' | 'date' | 'boolean' };
5052
- }
5053
-
5054
- /**
5055
- * Optional object specifying which pages to analyze
5056
- */
5057
- export interface SpecificPages {
5058
- /**
5059
- * Whether to analyze the about us page
5060
- */
5061
- about_us?: boolean;
5062
-
5063
- /**
5064
- * Whether to analyze the blog
5065
- */
5066
- blog?: boolean;
5067
-
5068
- /**
5069
- * Whether to analyze the careers page
5070
- */
5071
- careers?: boolean;
5072
-
5073
- /**
5074
- * Whether to analyze the contact us page
5075
- */
5076
- contact_us?: boolean;
5077
-
5078
- /**
5079
- * Whether to analyze the FAQ page
5080
- */
5081
- faq?: boolean;
5082
-
5083
- /**
5084
- * Whether to analyze the home page
5085
- */
5086
- home_page?: boolean;
5087
-
5088
- /**
5089
- * Whether to analyze the pricing page
5090
- */
5091
- pricing?: boolean;
5092
-
5093
- /**
5094
- * Whether to analyze the privacy policy page
5095
- */
5096
- privacy_policy?: boolean;
5097
-
5098
- /**
5099
- * Whether to analyze the terms and conditions page
5100
- */
5101
- terms_and_conditions?: boolean;
5102
- }
5103
- }
5104
-
5105
- export interface BrandFontsParams {
5106
- /**
5107
- * Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The
5108
- * domain will be automatically normalized and validated.
5109
- */
5110
- domain: string;
5111
-
5112
- /**
5113
- * Optional timeout in milliseconds for the request. If the request takes longer
5114
- * than this value, it will be aborted with a 408 status code. Maximum allowed
5115
- * value is 300000ms (5 minutes).
5116
- */
5117
- timeoutMS?: number;
5118
- }
5119
-
5120
3941
  export interface BrandIdentifyFromTransactionParams {
5121
3942
  /**
5122
3943
  * Transaction information to identify the brand
@@ -5382,6 +4203,7 @@ export interface BrandIdentifyFromTransactionParams {
5382
4203
  | 'azeri'
5383
4204
  | 'bengali'
5384
4205
  | 'bulgarian'
4206
+ | 'cantonese'
5385
4207
  | 'cebuano'
5386
4208
  | 'croatian'
5387
4209
  | 'czech'
@@ -5401,6 +4223,7 @@ export interface BrandIdentifyFromTransactionParams {
5401
4223
  | 'indonesian'
5402
4224
  | 'italian'
5403
4225
  | 'kazakh'
4226
+ | 'korean'
5404
4227
  | 'kyrgyz'
5405
4228
  | 'latin'
5406
4229
  | 'latvian'
@@ -5423,6 +4246,7 @@ export interface BrandIdentifyFromTransactionParams {
5423
4246
  | 'swahili'
5424
4247
  | 'swedish'
5425
4248
  | 'tagalog'
4249
+ | 'thai'
5426
4250
  | 'turkish'
5427
4251
  | 'ukrainian'
5428
4252
  | 'urdu'
@@ -5463,36 +4287,6 @@ export interface BrandIdentifyFromTransactionParams {
5463
4287
  timeoutMS?: number;
5464
4288
  }
5465
4289
 
5466
- export interface BrandPrefetchParams {
5467
- /**
5468
- * Domain name to prefetch brand data for
5469
- */
5470
- domain: string;
5471
-
5472
- /**
5473
- * Optional timeout in milliseconds for the request. If the request takes longer
5474
- * than this value, it will be aborted with a 408 status code. Maximum allowed
5475
- * value is 300000ms (5 minutes).
5476
- */
5477
- timeoutMS?: number;
5478
- }
5479
-
5480
- export interface BrandPrefetchByEmailParams {
5481
- /**
5482
- * Email address to prefetch brand data for. The domain will be extracted from the
5483
- * email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
5484
- * addresses are not allowed.
5485
- */
5486
- email: string;
5487
-
5488
- /**
5489
- * Optional timeout in milliseconds for the request. If the request takes longer
5490
- * than this value, it will be aborted with a 408 status code. Maximum allowed
5491
- * value is 300000ms (5 minutes).
5492
- */
5493
- timeoutMS?: number;
5494
- }
5495
-
5496
4290
  export interface BrandRetrieveByEmailParams {
5497
4291
  /**
5498
4292
  * Email address to retrieve brand data for (e.g., 'contact@example.com'). The
@@ -5510,6 +4304,7 @@ export interface BrandRetrieveByEmailParams {
5510
4304
  | 'azeri'
5511
4305
  | 'bengali'
5512
4306
  | 'bulgarian'
4307
+ | 'cantonese'
5513
4308
  | 'cebuano'
5514
4309
  | 'croatian'
5515
4310
  | 'czech'
@@ -5529,6 +4324,7 @@ export interface BrandRetrieveByEmailParams {
5529
4324
  | 'indonesian'
5530
4325
  | 'italian'
5531
4326
  | 'kazakh'
4327
+ | 'korean'
5532
4328
  | 'kyrgyz'
5533
4329
  | 'latin'
5534
4330
  | 'latvian'
@@ -5551,6 +4347,7 @@ export interface BrandRetrieveByEmailParams {
5551
4347
  | 'swahili'
5552
4348
  | 'swedish'
5553
4349
  | 'tagalog'
4350
+ | 'thai'
5554
4351
  | 'turkish'
5555
4352
  | 'ukrainian'
5556
4353
  | 'urdu'
@@ -5590,6 +4387,7 @@ export interface BrandRetrieveByIsinParams {
5590
4387
  | 'azeri'
5591
4388
  | 'bengali'
5592
4389
  | 'bulgarian'
4390
+ | 'cantonese'
5593
4391
  | 'cebuano'
5594
4392
  | 'croatian'
5595
4393
  | 'czech'
@@ -5609,6 +4407,7 @@ export interface BrandRetrieveByIsinParams {
5609
4407
  | 'indonesian'
5610
4408
  | 'italian'
5611
4409
  | 'kazakh'
4410
+ | 'korean'
5612
4411
  | 'kyrgyz'
5613
4412
  | 'latin'
5614
4413
  | 'latvian'
@@ -5631,6 +4430,7 @@ export interface BrandRetrieveByIsinParams {
5631
4430
  | 'swahili'
5632
4431
  | 'swedish'
5633
4432
  | 'tagalog'
4433
+ | 'thai'
5634
4434
  | 'turkish'
5635
4435
  | 'ukrainian'
5636
4436
  | 'urdu'
@@ -5914,6 +4714,7 @@ export interface BrandRetrieveByNameParams {
5914
4714
  | 'azeri'
5915
4715
  | 'bengali'
5916
4716
  | 'bulgarian'
4717
+ | 'cantonese'
5917
4718
  | 'cebuano'
5918
4719
  | 'croatian'
5919
4720
  | 'czech'
@@ -5933,6 +4734,7 @@ export interface BrandRetrieveByNameParams {
5933
4734
  | 'indonesian'
5934
4735
  | 'italian'
5935
4736
  | 'kazakh'
4737
+ | 'korean'
5936
4738
  | 'kyrgyz'
5937
4739
  | 'latin'
5938
4740
  | 'latvian'
@@ -5955,6 +4757,7 @@ export interface BrandRetrieveByNameParams {
5955
4757
  | 'swahili'
5956
4758
  | 'swedish'
5957
4759
  | 'tagalog'
4760
+ | 'thai'
5958
4761
  | 'turkish'
5959
4762
  | 'ukrainian'
5960
4763
  | 'urdu'
@@ -5993,6 +4796,7 @@ export interface BrandRetrieveByTickerParams {
5993
4796
  | 'azeri'
5994
4797
  | 'bengali'
5995
4798
  | 'bulgarian'
4799
+ | 'cantonese'
5996
4800
  | 'cebuano'
5997
4801
  | 'croatian'
5998
4802
  | 'czech'
@@ -6012,6 +4816,7 @@ export interface BrandRetrieveByTickerParams {
6012
4816
  | 'indonesian'
6013
4817
  | 'italian'
6014
4818
  | 'kazakh'
4819
+ | 'korean'
6015
4820
  | 'kyrgyz'
6016
4821
  | 'latin'
6017
4822
  | 'latvian'
@@ -6034,6 +4839,7 @@ export interface BrandRetrieveByTickerParams {
6034
4839
  | 'swahili'
6035
4840
  | 'swedish'
6036
4841
  | 'tagalog'
4842
+ | 'thai'
6037
4843
  | 'turkish'
6038
4844
  | 'ukrainian'
6039
4845
  | 'urdu'
@@ -6133,33 +4939,6 @@ export interface BrandRetrieveByTickerParams {
6133
4939
  timeoutMS?: number;
6134
4940
  }
6135
4941
 
6136
- export interface BrandRetrieveNaicsParams {
6137
- /**
6138
- * Brand domain or title to retrieve NAICS code for. If a valid domain is provided
6139
- * in `input`, it will be used for classification, otherwise, we will search for
6140
- * the brand using the provided title.
6141
- */
6142
- input: string;
6143
-
6144
- /**
6145
- * Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
6146
- * to 5.
6147
- */
6148
- maxResults?: number;
6149
-
6150
- /**
6151
- * Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
6152
- */
6153
- minResults?: number;
6154
-
6155
- /**
6156
- * Optional timeout in milliseconds for the request. If the request takes longer
6157
- * than this value, it will be aborted with a 408 status code. Maximum allowed
6158
- * value is 300000ms (5 minutes).
6159
- */
6160
- timeoutMS?: number;
6161
- }
6162
-
6163
4942
  export interface BrandRetrieveSimplifiedParams {
6164
4943
  /**
6165
4944
  * Domain name to retrieve simplified brand data for
@@ -6174,151 +4953,21 @@ export interface BrandRetrieveSimplifiedParams {
6174
4953
  timeoutMS?: number;
6175
4954
  }
6176
4955
 
6177
- export interface BrandScreenshotParams {
6178
- /**
6179
- * Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
6180
- * domain will be automatically normalized and validated.
6181
- */
6182
- domain: string;
6183
-
6184
- /**
6185
- * Optional parameter to determine screenshot type. If 'true', takes a full page
6186
- * screenshot capturing all content. If 'false' or not provided, takes a viewport
6187
- * screenshot (standard browser view).
6188
- */
6189
- fullScreenshot?: 'true' | 'false';
6190
-
6191
- /**
6192
- * Optional parameter to specify which page type to screenshot. If provided, the
6193
- * system will scrape the domain's links and use heuristics to find the most
6194
- * appropriate URL for the specified page type (30 supported languages). If not
6195
- * provided, screenshots the main domain landing page.
6196
- */
6197
- page?: 'login' | 'signup' | 'blog' | 'careers' | 'pricing' | 'terms' | 'privacy' | 'contact';
6198
-
6199
- /**
6200
- * Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
6201
- * faster capture with basic quality. If 'quality', optimizes for higher quality
6202
- * with longer wait times. Defaults to 'quality' if not provided.
6203
- */
6204
- prioritize?: 'speed' | 'quality';
6205
- }
6206
-
6207
- export interface BrandStyleguideParams {
6208
- /**
6209
- * A specific URL to fetch the styleguide from directly, bypassing domain
6210
- * resolution (e.g., 'https://example.com/design-system').
6211
- */
6212
- directUrl?: string;
6213
-
6214
- /**
6215
- * Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
6216
- * domain will be automatically normalized and validated.
6217
- */
6218
- domain?: string;
6219
-
6220
- /**
6221
- * Optional parameter to prioritize screenshot capture for styleguide extraction.
6222
- * If 'speed', optimizes for faster capture with basic quality. If 'quality',
6223
- * optimizes for higher quality with longer wait times. Defaults to 'quality' if
6224
- * not provided.
6225
- */
6226
- prioritize?: 'speed' | 'quality';
6227
-
6228
- /**
6229
- * Optional timeout in milliseconds for the request. If the request takes longer
6230
- * than this value, it will be aborted with a 408 status code. Maximum allowed
6231
- * value is 300000ms (5 minutes).
6232
- */
6233
- timeoutMS?: number;
6234
- }
6235
-
6236
- export interface BrandWebScrapeHTMLParams {
6237
- /**
6238
- * Full URL to scrape (must include http:// or https:// protocol)
6239
- */
6240
- url: string;
6241
- }
6242
-
6243
- export interface BrandWebScrapeImagesParams {
6244
- /**
6245
- * Full URL to scrape images from (must include http:// or https:// protocol)
6246
- */
6247
- url: string;
6248
- }
6249
-
6250
- export interface BrandWebScrapeMdParams {
6251
- /**
6252
- * Full URL to scrape and convert to markdown (must include http:// or https://
6253
- * protocol)
6254
- */
6255
- url: string;
6256
-
6257
- /**
6258
- * Include image references in Markdown output
6259
- */
6260
- includeImages?: boolean;
6261
-
6262
- /**
6263
- * Preserve hyperlinks in Markdown output
6264
- */
6265
- includeLinks?: boolean;
6266
-
6267
- /**
6268
- * Shorten base64-encoded image data in the Markdown output
6269
- */
6270
- shortenBase64Images?: boolean;
6271
- }
6272
-
6273
- export interface BrandWebScrapeSitemapParams {
6274
- /**
6275
- * Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
6276
- * automatically normalized and validated.
6277
- */
6278
- domain: string;
6279
- }
6280
-
6281
4956
  export declare namespace Brand {
6282
4957
  export {
6283
4958
  type BrandRetrieveResponse as BrandRetrieveResponse,
6284
- type BrandAIProductResponse as BrandAIProductResponse,
6285
- type BrandAIProductsResponse as BrandAIProductsResponse,
6286
- type BrandAIQueryResponse as BrandAIQueryResponse,
6287
- type BrandFontsResponse as BrandFontsResponse,
6288
4959
  type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse,
6289
- type BrandPrefetchResponse as BrandPrefetchResponse,
6290
- type BrandPrefetchByEmailResponse as BrandPrefetchByEmailResponse,
6291
4960
  type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse,
6292
4961
  type BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse,
6293
4962
  type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse,
6294
4963
  type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse,
6295
- type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse,
6296
4964
  type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse,
6297
- type BrandScreenshotResponse as BrandScreenshotResponse,
6298
- type BrandStyleguideResponse as BrandStyleguideResponse,
6299
- type BrandWebScrapeHTMLResponse as BrandWebScrapeHTMLResponse,
6300
- type BrandWebScrapeImagesResponse as BrandWebScrapeImagesResponse,
6301
- type BrandWebScrapeMdResponse as BrandWebScrapeMdResponse,
6302
- type BrandWebScrapeSitemapResponse as BrandWebScrapeSitemapResponse,
6303
4965
  type BrandRetrieveParams as BrandRetrieveParams,
6304
- type BrandAIProductParams as BrandAIProductParams,
6305
- type BrandAIProductsParams as BrandAIProductsParams,
6306
- type BrandAIQueryParams as BrandAIQueryParams,
6307
- type BrandFontsParams as BrandFontsParams,
6308
4966
  type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams,
6309
- type BrandPrefetchParams as BrandPrefetchParams,
6310
- type BrandPrefetchByEmailParams as BrandPrefetchByEmailParams,
6311
4967
  type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams,
6312
4968
  type BrandRetrieveByIsinParams as BrandRetrieveByIsinParams,
6313
4969
  type BrandRetrieveByNameParams as BrandRetrieveByNameParams,
6314
4970
  type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams,
6315
- type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams,
6316
4971
  type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams,
6317
- type BrandScreenshotParams as BrandScreenshotParams,
6318
- type BrandStyleguideParams as BrandStyleguideParams,
6319
- type BrandWebScrapeHTMLParams as BrandWebScrapeHTMLParams,
6320
- type BrandWebScrapeImagesParams as BrandWebScrapeImagesParams,
6321
- type BrandWebScrapeMdParams as BrandWebScrapeMdParams,
6322
- type BrandWebScrapeSitemapParams as BrandWebScrapeSitemapParams,
6323
4972
  };
6324
4973
  }