brand.dev 0.1.0-alpha.1 → 0.1.0-alpha.10

package/resources/brand.d.mts

@@ -6,11 +6,24 @@ export declare class Brand extends APIResource {
      * Retrieve brand data by domain
      */
     retrieve(query: BrandRetrieveParams, options?: RequestOptions): APIPromise<BrandRetrieveResponse>;
+    /**
+     * Beta feature: Use AI to extract specific data points from a brand's website. The
+     * AI will crawl the website and extract the requested information based on the
+     * provided data points.
+     */
+    aiQuery(body: BrandAIQueryParams, options?: RequestOptions): APIPromise<BrandAIQueryResponse>;
     /**
      * Endpoint specially designed for platforms that want to identify transaction data
      * by the transaction title.
      */
     identifyFromTransaction(query: BrandIdentifyFromTransactionParams, options?: RequestOptions): APIPromise<BrandIdentifyFromTransactionResponse>;
+    /**
+     * Signal that you may fetch brand data for a particular domain soon to improve
+     * latency. This endpoint does not charge credits and is available for paid
+     * customers to optimize future requests. [You must be on a paid plan to use this
+     * endpoint]
+     */
+    prefetch(body: BrandPrefetchParams, options?: RequestOptions): APIPromise<BrandPrefetchResponse>;
     /**
      * Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
      */
@@ -19,10 +32,28 @@ export declare class Brand extends APIResource {
      * Endpoint to classify any brand into a 2022 NAICS code.
      */
     retrieveNaics(query: BrandRetrieveNaicsParams, options?: RequestOptions): APIPromise<BrandRetrieveNaicsResponse>;
+    /**
+     * Returns a simplified version of brand data containing only essential
+     * information: domain, title, colors, logos, and backdrops. This endpoint is
+     * optimized for faster responses and reduced data transfer.
+     */
+    retrieveSimplified(query: BrandRetrieveSimplifiedParams, options?: RequestOptions): APIPromise<BrandRetrieveSimplifiedResponse>;
+    /**
+     * Beta feature: Capture a screenshot of a website. Supports both viewport
+     * (standard browser view) and full-page screenshots. Returns a URL to the uploaded
+     * screenshot image hosted on our CDN.
+     */
+    screenshot(query: BrandScreenshotParams, options?: RequestOptions): APIPromise<BrandScreenshotResponse>;
     /**
      * Search brands by query
      */
     search(query: BrandSearchParams, options?: RequestOptions): APIPromise<BrandSearchResponse>;
+    /**
+     * Beta feature: Automatically extract comprehensive design system information from
+     * a brand's website including colors, typography, spacing, shadows, and UI
+     * components.
+     */
+    styleguide(query: BrandStyleguideParams, options?: RequestOptions): APIPromise<BrandStyleguideResponse>;
 }
 export interface BrandRetrieveResponse {
     /**
@@ -255,6 +286,32 @@ export declare namespace BrandRetrieveResponse {
         }
     }
 }
+export interface BrandAIQueryResponse {
+    /**
+     * Array of extracted data points
+     */
+    data_extracted?: Array<BrandAIQueryResponse.DataExtracted>;
+    /**
+     * The domain that was analyzed
+     */
+    domain?: string;
+    /**
+     * List of URLs that were analyzed
+     */
+    urls_analyzed?: Array<string>;
+}
+export declare namespace BrandAIQueryResponse {
+    interface DataExtracted {
+        /**
+         * Name of the extracted data point
+         */
+        datapoint_name?: string;
+        /**
+         * Value of the extracted data point
+         */
+        datapoint_value?: string | number | boolean | Array<string> | Array<number>;
+    }
+}
 export interface BrandIdentifyFromTransactionResponse {
     /**
      * Detailed brand information
@@ -486,6 +543,20 @@ export declare namespace BrandIdentifyFromTransactionResponse {
         }
     }
 }
+export interface BrandPrefetchResponse {
+    /**
+     * The domain that was queued for prefetching
+     */
+    domain?: string;
+    /**
+     * Success message
+     */
+    message?: string;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+}
 export interface BrandRetrieveByTickerResponse {
     /**
      * Detailed brand information
@@ -747,6 +818,179 @@ export declare namespace BrandRetrieveNaicsResponse {
         title?: string;
     }
 }
+export interface BrandRetrieveSimplifiedResponse {
+    /**
+     * Simplified brand information
+     */
+    brand?: BrandRetrieveSimplifiedResponse.Brand;
+    /**
+     * HTTP status code of the response
+     */
+    code?: number;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+}
+export declare namespace BrandRetrieveSimplifiedResponse {
+    /**
+     * Simplified brand information
+     */
+    interface Brand {
+        /**
+         * An array of backdrop images for the brand
+         */
+        backdrops?: Array<Brand.Backdrop>;
+        /**
+         * An array of brand colors
+         */
+        colors?: Array<Brand.Color>;
+        /**
+         * The domain name of the brand
+         */
+        domain?: string;
+        /**
+         * An array of logos associated with the brand
+         */
+        logos?: Array<Brand.Logo>;
+        /**
+         * The title or name of the brand
+         */
+        title?: string;
+    }
+    namespace Brand {
+        interface Backdrop {
+            /**
+             * Array of colors in the backdrop image
+             */
+            colors?: Array<Backdrop.Color>;
+            /**
+             * Resolution of the backdrop image
+             */
+            resolution?: Backdrop.Resolution;
+            /**
+             * URL of the backdrop image
+             */
+            url?: string;
+        }
+        namespace Backdrop {
+            interface Color {
+                /**
+                 * Color in hexadecimal format
+                 */
+                hex?: string;
+                /**
+                 * Name of the color
+                 */
+                name?: string;
+            }
+            /**
+             * Resolution of the backdrop image
+             */
+            interface Resolution {
+                /**
+                 * Aspect ratio of the image (width/height)
+                 */
+                aspect_ratio?: number;
+                /**
+                 * Height of the image in pixels
+                 */
+                height?: number;
+                /**
+                 * Width of the image in pixels
+                 */
+                width?: number;
+            }
+        }
+        interface Color {
+            /**
+             * Color in hexadecimal format
+             */
+            hex?: string;
+            /**
+             * Name of the color
+             */
+            name?: string;
+        }
+        interface Logo {
+            /**
+             * Array of colors in the logo
+             */
+            colors?: Array<Logo.Color>;
+            /**
+             * Group identifier for logos
+             */
+            group?: number;
+            /**
+             * Mode of the logo, e.g., 'dark', 'light'
+             */
+            mode?: string;
+            /**
+             * Resolution of the logo image
+             */
+            resolution?: Logo.Resolution;
+            /**
+             * Type of the logo based on resolution (e.g., 'icon', 'logo', 'banner')
+             */
+            type?: string;
+            /**
+             * URL of the logo image
+             */
+            url?: string;
+        }
+        namespace Logo {
+            interface Color {
+                /**
+                 * Color in hexadecimal format
+                 */
+                hex?: string;
+                /**
+                 * Name of the color
+                 */
+                name?: string;
+            }
+            /**
+             * Resolution of the logo image
+             */
+            interface Resolution {
+                /**
+                 * Aspect ratio of the image (width/height)
+                 */
+                aspect_ratio?: number;
+                /**
+                 * Height of the image in pixels
+                 */
+                height?: number;
+                /**
+                 * Width of the image in pixels
+                 */
+                width?: number;
+            }
+        }
+    }
+}
+export interface BrandScreenshotResponse {
+    /**
+     * HTTP status code
+     */
+    code?: number;
+    /**
+     * The normalized domain that was processed
+     */
+    domain?: string;
+    /**
+     * Public URL of the uploaded screenshot image
+     */
+    screenshot?: string;
+    /**
+     * Type of screenshot that was captured
+     */
+    screenshotType?: 'viewport' | 'fullPage';
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+}
 export type BrandSearchResponse = Array<BrandSearchResponse.BrandSearchResponseItem>;
 export declare namespace BrandSearchResponse {
     interface BrandSearchResponseItem {
@@ -764,6 +1008,279 @@ export declare namespace BrandSearchResponse {
         title?: string;
     }
 }
+export interface BrandStyleguideResponse {
+    /**
+     * HTTP status code
+     */
+    code?: number;
+    /**
+     * The normalized domain that was processed
+     */
+    domain?: string;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+    /**
+     * Comprehensive styleguide data extracted from the website
+     */
+    styleguide?: BrandStyleguideResponse.Styleguide;
+}
+export declare namespace BrandStyleguideResponse {
+    /**
+     * Comprehensive styleguide data extracted from the website
+     */
+    interface Styleguide {
+        /**
+         * Primary colors used on the website
+         */
+        colors?: Styleguide.Colors;
+        /**
+         * UI component styles
+         */
+        components?: Styleguide.Components;
+        /**
+         * Spacing system used on the website
+         */
+        elementSpacing?: Styleguide.ElementSpacing;
+        /**
+         * Shadow styles used on the website
+         */
+        shadows?: Styleguide.Shadows;
+        /**
+         * Typography styles used on the website
+         */
+        typography?: Styleguide.Typography;
+    }
+    namespace Styleguide {
+        /**
+         * Primary colors used on the website
+         */
+        interface Colors {
+            /**
+             * Accent color of the website (hex format)
+             */
+            accent?: string;
+            /**
+             * Background color of the website (hex format)
+             */
+            background?: string;
+            /**
+             * Text color of the website (hex format)
+             */
+            text?: string;
+        }
+        /**
+         * UI component styles
+         */
+        interface Components {
+            /**
+             * Button component styles
+             */
+            button?: Components.Button;
+            /**
+             * Card component style
+             */
+            card?: Components.Card;
+        }
+        namespace Components {
+            /**
+             * Button component styles
+             */
+            interface Button {
+                /**
+                 * Link button style
+                 */
+                link?: Button.Link;
+                /**
+                 * Primary button style
+                 */
+                primary?: Button.Primary;
+                /**
+                 * Secondary button style
+                 */
+                secondary?: Button.Secondary;
+            }
+            namespace Button {
+                /**
+                 * Link button style
+                 */
+                interface Link {
+                    backgroundColor?: string;
+                    borderColor?: string;
+                    borderRadius?: string;
+                    borderStyle?: string;
+                    borderWidth?: string;
+                    boxShadow?: string;
+                    color?: string;
+                    fontSize?: string;
+                    fontWeight?: number;
+                    padding?: string;
+                    textDecoration?: string;
+                }
+                /**
+                 * Primary button style
+                 */
+                interface Primary {
+                    backgroundColor?: string;
+                    borderColor?: string;
+                    borderRadius?: string;
+                    borderStyle?: string;
+                    borderWidth?: string;
+                    boxShadow?: string;
+                    color?: string;
+                    fontSize?: string;
+                    fontWeight?: number;
+                    padding?: string;
+                    textDecoration?: string;
+                }
+                /**
+                 * Secondary button style
+                 */
+                interface Secondary {
+                    backgroundColor?: string;
+                    borderColor?: string;
+                    borderRadius?: string;
+                    borderStyle?: string;
+                    borderWidth?: string;
+                    boxShadow?: string;
+                    color?: string;
+                    fontSize?: string;
+                    fontWeight?: number;
+                    padding?: string;
+                    textDecoration?: string;
+                }
+            }
+            /**
+             * Card component style
+             */
+            interface Card {
+                backgroundColor?: string;
+                borderColor?: string;
+                borderRadius?: string;
+                borderStyle?: string;
+                borderWidth?: string;
+                boxShadow?: string;
+                padding?: string;
+                textColor?: string;
+            }
+        }
+        /**
+         * Spacing system used on the website
+         */
+        interface ElementSpacing {
+            /**
+             * Large spacing value
+             */
+            lg?: string;
+            /**
+             * Medium spacing value
+             */
+            md?: string;
+            /**
+             * Small spacing value
+             */
+            sm?: string;
+            /**
+             * Extra large spacing value
+             */
+            xl?: string;
+            /**
+             * Extra small spacing value
+             */
+            xs?: string;
+        }
+        /**
+         * Shadow styles used on the website
+         */
+        interface Shadows {
+            /**
+             * Inner shadow value
+             */
+            inner?: string;
+            /**
+             * Large shadow value
+             */
+            lg?: string;
+            /**
+             * Medium shadow value
+             */
+            md?: string;
+            /**
+             * Small shadow value
+             */
+            sm?: string;
+            /**
+             * Extra large shadow value
+             */
+            xl?: string;
+        }
+        /**
+         * Typography styles used on the website
+         */
+        interface Typography {
+            /**
+             * Heading styles
+             */
+            headings?: Typography.Headings;
+            /**
+             * Paragraph text styles
+             */
+            p?: Typography.P;
+        }
+        namespace Typography {
+            /**
+             * Heading styles
+             */
+            interface Headings {
+                h1?: Headings.H1;
+                h2?: Headings.H2;
+                h3?: Headings.H3;
+                h4?: Headings.H4;
+            }
+            namespace Headings {
+                interface H1 {
+                    fontFamily?: string;
+                    fontSize?: string;
+                    fontWeight?: number;
+                    letterSpacing?: string;
+                    lineHeight?: string;
+                }
+                interface H2 {
+                    fontFamily?: string;
+                    fontSize?: string;
+                    fontWeight?: number;
+                    letterSpacing?: string;
+                    lineHeight?: string;
+                }
+                interface H3 {
+                    fontFamily?: string;
+                    fontSize?: string;
+                    fontWeight?: number;
+                    letterSpacing?: string;
+                    lineHeight?: string;
+                }
+                interface H4 {
+                    fontFamily?: string;
+                    fontSize?: string;
+                    fontWeight?: number;
+                    letterSpacing?: string;
+                    lineHeight?: string;
+                }
+            }
+            /**
+             * Paragraph text styles
+             */
+            interface P {
+                fontFamily?: string;
+                fontSize?: string;
+                fontWeight?: number;
+                letterSpacing?: string;
+                lineHeight?: string;
+            }
+        }
+    }
+}
 export interface BrandRetrieveParams {
     /**
      * Domain name to retrieve brand data for
@@ -773,18 +1290,131 @@ export interface BrandRetrieveParams {
      * Optional parameter to force the language of the retrieved brand data
      */
     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';
+    /**
+     * Optional parameter to optimize the API call for maximum speed. When set to true,
+     * the API will skip time-consuming operations for faster response at the cost of
+     * less comprehensive data.
+     */
+    maxSpeed?: boolean;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export interface BrandAIQueryParams {
+    /**
+     * Array of data points to extract from the website
+     */
+    data_to_extract: Array<BrandAIQueryParams.DataToExtract>;
+    /**
+     * The domain name to analyze
+     */
+    domain: string;
+    /**
+     * Optional object specifying which pages to analyze
+     */
+    specific_pages?: BrandAIQueryParams.SpecificPages;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export declare namespace BrandAIQueryParams {
+    interface DataToExtract {
+        /**
+         * Description of what to extract
+         */
+        datapoint_description: string;
+        /**
+         * Example of the expected value
+         */
+        datapoint_example: string;
+        /**
+         * Name of the data point to extract
+         */
+        datapoint_name: string;
+        /**
+         * Type of the data point
+         */
+        datapoint_type: 'text' | 'number' | 'date' | 'boolean' | 'list' | 'url';
+    }
+    /**
+     * Optional object specifying which pages to analyze
+     */
+    interface SpecificPages {
+        /**
+         * Whether to analyze the about us page
+         */
+        about_us?: boolean;
+        /**
+         * Whether to analyze the blog
+         */
+        blog?: boolean;
+        /**
+         * Whether to analyze the careers page
+         */
+        careers?: boolean;
+        /**
+         * Whether to analyze the contact us page
+         */
+        contact_us?: boolean;
+        /**
+         * Whether to analyze the FAQ page
+         */
+        faq?: boolean;
+        /**
+         * Whether to analyze the home page
+         */
+        home_page?: boolean;
+        /**
+         * Whether to analyze the privacy policy page
+         */
+        privacy_policy?: boolean;
+        /**
+         * Whether to analyze the terms and conditions page
+         */
+        terms_and_conditions?: boolean;
+    }
 }
 export interface BrandIdentifyFromTransactionParams {
     /**
      * Transaction information to identify the brand
      */
     transaction_info: string;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export interface BrandPrefetchParams {
+    /**
+     * Domain name to prefetch brand data for
+     */
+    domain: string;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
 }
 export interface BrandRetrieveByTickerParams {
     /**
      * Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
      */
     ticker: string;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
 }
 export interface BrandRetrieveNaicsParams {
     /**
@@ -793,14 +1423,64 @@ export interface BrandRetrieveNaicsParams {
      * the brand using the provided title.
      */
     input: string;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export interface BrandRetrieveSimplifiedParams {
+    /**
+     * Domain name to retrieve simplified brand data for
+     */
+    domain: string;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export interface BrandScreenshotParams {
+    /**
+     * Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
+     * domain will be automatically normalized and validated.
+     */
+    domain: string;
+    /**
+     * Optional parameter to determine screenshot type. If 'true', takes a full page
+     * screenshot capturing all content. If 'false' or not provided, takes a viewport
+     * screenshot (standard browser view).
+     */
+    fullScreenshot?: 'true' | 'false';
 }
 export interface BrandSearchParams {
     /**
      * Query string to search brands
      */
     query: string;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
+}
+export interface BrandStyleguideParams {
+    /**
+     * Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+     * domain will be automatically normalized and validated.
+     */
+    domain: string;
+    /**
+     * Optional timeout in milliseconds for the request. If the request takes longer
+     * than this value, it will be aborted with a 408 status code. Maximum allowed
+     * value is 300000ms (5 minutes).
+     */
+    timeoutMS?: number;
 }
 export declare namespace Brand {
-    export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse, type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse, type BrandSearchResponse as BrandSearchResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandSearchParams as BrandSearchParams, };
+    export { type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse, type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse, type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse, type BrandScreenshotResponse as BrandScreenshotResponse, type BrandSearchResponse as BrandSearchResponse, type BrandStyleguideResponse as BrandStyleguideResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, type BrandScreenshotParams as BrandScreenshotParams, type BrandSearchParams as BrandSearchParams, type BrandStyleguideParams as BrandStyleguideParams, };
 }
 //# sourceMappingURL=brand.d.mts.map