brand.dev 0.0.1-alpha.1

package/resources/brand.d.mts

@@ -0,0 +1,806 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Brand extends APIResource {
+    /**
+     * Retrieve brand data by domain
+     */
+    retrieve(query: BrandRetrieveParams, options?: RequestOptions): APIPromise<BrandRetrieveResponse>;
+    /**
+     * Endpoint specially designed for platforms that want to identify transaction data
+     * by the transaction title.
+     */
+    identifyFromTransaction(query: BrandIdentifyFromTransactionParams, options?: RequestOptions): APIPromise<BrandIdentifyFromTransactionResponse>;
+    /**
+     * Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
+     */
+    retrieveByTicker(query: BrandRetrieveByTickerParams, options?: RequestOptions): APIPromise<BrandRetrieveByTickerResponse>;
+    /**
+     * Endpoint to classify any brand into a 2022 NAICS code.
+     */
+    retrieveNaics(query: BrandRetrieveNaicsParams, options?: RequestOptions): APIPromise<BrandRetrieveNaicsResponse>;
+    /**
+     * Search brands by query
+     */
+    search(query: BrandSearchParams, options?: RequestOptions): APIPromise<BrandSearchResponse>;
+}
+export interface BrandRetrieveResponse {
+    /**
+     * Detailed brand information
+     */
+    brand?: BrandRetrieveResponse.Brand;
+    /**
+     * HTTP status code
+     */
+    code?: number;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+}
+export declare namespace BrandRetrieveResponse {
+    /**
+     * Detailed brand information
+     */
+    interface Brand {
+        /**
+         * Physical address of the brand
+         */
+        address?: Brand.Address;
+        /**
+         * An array of backdrop images for the brand
+         */
+        backdrops?: Array<Brand.Backdrop>;
+        /**
+         * An array of brand colors
+         */
+        colors?: Array<Brand.Color>;
+        /**
+         * A brief description of the brand
+         */
+        description?: string;
+        /**
+         * The domain name of the brand
+         */
+        domain?: string;
+        /**
+         * An array of fonts used by the brand's website
+         */
+        fonts?: Array<Brand.Font>;
+        /**
+         * An array of logos associated with the brand
+         */
+        logos?: Array<Brand.Logo>;
+        /**
+         * The brand's slogan
+         */
+        slogan?: string;
+        /**
+         * An array of social media links for the brand
+         */
+        socials?: Array<Brand.Social>;
+        /**
+         * Stock market information for this brand (will be null if not a publicly traded
+         * company)
+         */
+        stock?: Brand.Stock;
+        /**
+         * The title or name of the brand
+         */
+        title?: string;
+    }
+    namespace Brand {
+        /**
+         * Physical address of the brand
+         */
+        interface Address {
+            /**
+             * City name
+             */
+            city?: string;
+            /**
+             * Country name
+             */
+            country?: string;
+            /**
+             * Country code
+             */
+            country_code?: string;
+            /**
+             * Postal or ZIP code
+             */
+            postal_code?: string;
+            /**
+             * State or province code
+             */
+            state_code?: string;
+            /**
+             * State or province name
+             */
+            state_province?: string;
+            /**
+             * Street address
+             */
+            street?: string;
+        }
+        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 {
+                /**
+                 * 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 Font {
+            /**
+             * Name of the font
+             */
+            name?: string;
+            /**
+             * Usage of the font, e.g., 'title', 'body', 'button'
+             */
+            usage?: 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;
+            /**
+             * 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 {
+                /**
+                 * Height of the image in pixels
+                 */
+                height?: number;
+                /**
+                 * Width of the image in pixels
+                 */
+                width?: number;
+            }
+        }
+        interface Social {
+            /**
+             * Type of social media, e.g., 'facebook', 'twitter'
+             */
+            type?: string;
+            /**
+             * URL of the social media page
+             */
+            url?: string;
+        }
+        /**
+         * Stock market information for this brand (will be null if not a publicly traded
+         * company)
+         */
+        interface Stock {
+            /**
+             * Stock exchange name
+             */
+            exchange?: string;
+            /**
+             * Stock ticker symbol
+             */
+            ticker?: string;
+        }
+    }
+}
+export interface BrandIdentifyFromTransactionResponse {
+    /**
+     * Detailed brand information
+     */
+    brand?: BrandIdentifyFromTransactionResponse.Brand;
+    /**
+     * HTTP status code
+     */
+    code?: number;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+}
+export declare namespace BrandIdentifyFromTransactionResponse {
+    /**
+     * Detailed brand information
+     */
+    interface Brand {
+        /**
+         * Physical address of the brand
+         */
+        address?: Brand.Address;
+        /**
+         * An array of backdrop images for the brand
+         */
+        backdrops?: Array<Brand.Backdrop>;
+        /**
+         * An array of brand colors
+         */
+        colors?: Array<Brand.Color>;
+        /**
+         * A brief description of the brand
+         */
+        description?: string;
+        /**
+         * The domain name of the brand
+         */
+        domain?: string;
+        /**
+         * An array of fonts used by the brand's website
+         */
+        fonts?: Array<Brand.Font>;
+        /**
+         * An array of logos associated with the brand
+         */
+        logos?: Array<Brand.Logo>;
+        /**
+         * The brand's slogan
+         */
+        slogan?: string;
+        /**
+         * An array of social media links for the brand
+         */
+        socials?: Array<Brand.Social>;
+        /**
+         * Stock market information for this brand (will be null if not a publicly traded
+         * company)
+         */
+        stock?: Brand.Stock;
+        /**
+         * The title or name of the brand
+         */
+        title?: string;
+    }
+    namespace Brand {
+        /**
+         * Physical address of the brand
+         */
+        interface Address {
+            /**
+             * City name
+             */
+            city?: string;
+            /**
+             * Country name
+             */
+            country?: string;
+            /**
+             * Country code
+             */
+            country_code?: string;
+            /**
+             * Postal or ZIP code
+             */
+            postal_code?: string;
+            /**
+             * State or province code
+             */
+            state_code?: string;
+            /**
+             * State or province name
+             */
+            state_province?: string;
+            /**
+             * Street address
+             */
+            street?: string;
+        }
+        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 {
+                /**
+                 * 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 Font {
+            /**
+             * Name of the font
+             */
+            name?: string;
+            /**
+             * Usage of the font, e.g., 'title', 'body', 'button'
+             */
+            usage?: 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;
+            /**
+             * 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 {
+                /**
+                 * Height of the image in pixels
+                 */
+                height?: number;
+                /**
+                 * Width of the image in pixels
+                 */
+                width?: number;
+            }
+        }
+        interface Social {
+            /**
+             * Type of social media, e.g., 'facebook', 'twitter'
+             */
+            type?: string;
+            /**
+             * URL of the social media page
+             */
+            url?: string;
+        }
+        /**
+         * Stock market information for this brand (will be null if not a publicly traded
+         * company)
+         */
+        interface Stock {
+            /**
+             * Stock exchange name
+             */
+            exchange?: string;
+            /**
+             * Stock ticker symbol
+             */
+            ticker?: string;
+        }
+    }
+}
+export interface BrandRetrieveByTickerResponse {
+    /**
+     * Detailed brand information
+     */
+    brand?: BrandRetrieveByTickerResponse.Brand;
+    /**
+     * HTTP status code
+     */
+    code?: number;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+}
+export declare namespace BrandRetrieveByTickerResponse {
+    /**
+     * Detailed brand information
+     */
+    interface Brand {
+        /**
+         * Physical address of the brand
+         */
+        address?: Brand.Address;
+        /**
+         * An array of backdrop images for the brand
+         */
+        backdrops?: Array<Brand.Backdrop>;
+        /**
+         * An array of brand colors
+         */
+        colors?: Array<Brand.Color>;
+        /**
+         * A brief description of the brand
+         */
+        description?: string;
+        /**
+         * The domain name of the brand
+         */
+        domain?: string;
+        /**
+         * An array of fonts used by the brand's website
+         */
+        fonts?: Array<Brand.Font>;
+        /**
+         * An array of logos associated with the brand
+         */
+        logos?: Array<Brand.Logo>;
+        /**
+         * The brand's slogan
+         */
+        slogan?: string;
+        /**
+         * An array of social media links for the brand
+         */
+        socials?: Array<Brand.Social>;
+        /**
+         * Stock market information for this brand (will be null if not a publicly traded
+         * company)
+         */
+        stock?: Brand.Stock;
+        /**
+         * The title or name of the brand
+         */
+        title?: string;
+    }
+    namespace Brand {
+        /**
+         * Physical address of the brand
+         */
+        interface Address {
+            /**
+             * City name
+             */
+            city?: string;
+            /**
+             * Country name
+             */
+            country?: string;
+            /**
+             * Country code
+             */
+            country_code?: string;
+            /**
+             * Postal or ZIP code
+             */
+            postal_code?: string;
+            /**
+             * State or province code
+             */
+            state_code?: string;
+            /**
+             * State or province name
+             */
+            state_province?: string;
+            /**
+             * Street address
+             */
+            street?: string;
+        }
+        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 {
+                /**
+                 * 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 Font {
+            /**
+             * Name of the font
+             */
+            name?: string;
+            /**
+             * Usage of the font, e.g., 'title', 'body', 'button'
+             */
+            usage?: 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;
+            /**
+             * 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 {
+                /**
+                 * Height of the image in pixels
+                 */
+                height?: number;
+                /**
+                 * Width of the image in pixels
+                 */
+                width?: number;
+            }
+        }
+        interface Social {
+            /**
+             * Type of social media, e.g., 'facebook', 'twitter'
+             */
+            type?: string;
+            /**
+             * URL of the social media page
+             */
+            url?: string;
+        }
+        /**
+         * Stock market information for this brand (will be null if not a publicly traded
+         * company)
+         */
+        interface Stock {
+            /**
+             * Stock exchange name
+             */
+            exchange?: string;
+            /**
+             * Stock ticker symbol
+             */
+            ticker?: string;
+        }
+    }
+}
+export interface BrandRetrieveNaicsResponse {
+    /**
+     * Array of NAICS codes and titles.
+     */
+    codes?: Array<BrandRetrieveNaicsResponse.Code>;
+    /**
+     * Domain found for the brand
+     */
+    domain?: string;
+    /**
+     * Status of the response, e.g., 'ok'
+     */
+    status?: string;
+    /**
+     * Industry classification type, for naics api it will be `naics`
+     */
+    type?: string;
+}
+export declare namespace BrandRetrieveNaicsResponse {
+    interface Code {
+        /**
+         * NAICS code
+         */
+        code?: string;
+        /**
+         * NAICS title
+         */
+        title?: string;
+    }
+}
+export type BrandSearchResponse = Array<BrandSearchResponse.BrandSearchResponseItem>;
+export declare namespace BrandSearchResponse {
+    interface BrandSearchResponseItem {
+        /**
+         * Domain name of the brand
+         */
+        domain?: string;
+        /**
+         * URL of the brand's logo
+         */
+        logo?: string;
+        /**
+         * Title or name of the brand
+         */
+        title?: string;
+    }
+}
+export interface BrandRetrieveParams {
+    /**
+     * Domain name to retrieve brand data for
+     */
+    domain: string;
+    /**
+     * 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';
+}
+export interface BrandIdentifyFromTransactionParams {
+    /**
+     * Transaction information to identify the brand
+     */
+    transaction_info: string;
+}
+export interface BrandRetrieveByTickerParams {
+    /**
+     * Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
+     */
+    ticker: string;
+}
+export interface BrandRetrieveNaicsParams {
+    /**
+     * Brand domain or title to retrieve NAICS code for. If a valid domain is provided
+     * in `input`, it will be used for classification, otherwise, we will search for
+     * the brand using the provided title.
+     */
+    input: string;
+}
+export interface BrandSearchParams {
+    /**
+     * Query string to search brands
+     */
+    query: string;
+}
+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, };
+}
+//# sourceMappingURL=brand.d.mts.map