brand.dev 0.19.0 → 0.21.0

package/src/resources/brand.ts

@@ -17,17 +17,26 @@ export class Brand extends APIResource {
   }
 
   /**
-   * 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.
+   * Beta feature: Extract product information from a brand's website. Brand.dev will
+   * analyze the website and return a list of products with details such as name,
+   * description, image, pricing, features, and more.
+   */
+  aiProducts(body: BrandAIProductsParams, options?: RequestOptions): APIPromise<BrandAIProductsResponse> {
+    return this._client.post('/brand/ai/products', { body, ...options });
+  }
+
+  /**
+   * 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> {
     return this._client.post('/brand/ai/query', { body, ...options });
   }
 
   /**
-   * Beta feature: Extract font information from a brand's website including font
-   * families, usage statistics, fallbacks, and element/word counts.
+   * Extract font information from a brand's website including font families, usage
+   * statistics, fallbacks, and element/word counts.
    */
   fonts(query: BrandFontsParams, options?: RequestOptions): APIPromise<BrandFontsResponse> {
     return this._client.get('/brand/fonts', { query, ...options });
@@ -54,6 +63,21 @@ export class Brand extends APIResource {
     return this._client.post('/brand/prefetch', { body, ...options });
   }
 
+  /**
+   * Signal that you may fetch brand data for a particular domain soon to improve
+   * latency. This endpoint accepts an email address, extracts the domain from it,
+   * validates that it's not a disposable or free email provider, and queues the
+   * domain for prefetching. 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]
+   */
+  prefetchByEmail(
+    body: BrandPrefetchByEmailParams,
+    options?: RequestOptions,
+  ): APIPromise<BrandPrefetchByEmailResponse> {
+    return this._client.post('/brand/prefetch-by-email', { body, ...options });
+  }
+
   /**
    * Retrieve brand information using an email address while detecting disposable and
    * free email addresses. This endpoint extracts the domain from the email address
@@ -124,19 +148,18 @@ export class Brand extends APIResource {
   }
 
   /**
-   * Beta feature: Capture a screenshot of a website. Supports both viewport
-   * (standard browser view) and full-page screenshots. Can also screenshot specific
-   * page types (login, pricing, etc.) by using heuristics to find the appropriate
-   * URL. Returns a URL to the uploaded screenshot image hosted on our CDN.
+   * Capture a screenshot of a website. Supports both viewport (standard browser
+   * view) and full-page screenshots. Can also screenshot specific page types (login,
+   * pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
+   * the uploaded screenshot image hosted on our CDN.
    */
   screenshot(query: BrandScreenshotParams, options?: RequestOptions): APIPromise<BrandScreenshotResponse> {
     return this._client.get('/brand/screenshot', { query, ...options });
   }
 
   /**
-   * Beta feature: Automatically extract comprehensive design system information from
-   * a brand's website including colors, typography, spacing, shadows, and UI
-   * components.
+   * 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> {
     return this._client.get('/brand/styleguide', { query, ...options });
@@ -742,6 +765,77 @@ export namespace BrandRetrieveResponse {
   }
 }
 
+export interface BrandAIProductsResponse {
+  /**
+   * Array of products extracted from the website
+   */
+  products?: Array<BrandAIProductsResponse.Product>;
+}
+
+export namespace BrandAIProductsResponse {
+  export interface Product {
+    /**
+     * Description of the product
+     */
+    description: string;
+
+    /**
+     * List of product features
+     */
+    features: Array<string>;
+
+    /**
+     * Name of the product
+     */
+    name: string;
+
+    /**
+     * Tags associated with the product
+     */
+    tags: Array<string>;
+
+    /**
+     * Target audience for the product (array of strings)
+     */
+    target_audience: Array<string>;
+
+    /**
+     * Billing frequency for the product
+     */
+    billing_frequency?: 'monthly' | 'yearly' | 'one_time' | 'usage_based' | null;
+
+    /**
+     * Category of the product
+     */
+    category?: string | null;
+
+    /**
+     * Currency code for the price (e.g., USD, EUR)
+     */
+    currency?: string | null;
+
+    /**
+     * URL to the product image
+     */
+    image_url?: string | null;
+
+    /**
+     * Price of the product
+     */
+    price?: number | null;
+
+    /**
+     * Pricing model for the product
+     */
+    pricing_model?: 'per_seat' | 'flat' | 'tiered' | 'freemium' | 'custom' | null;
+
+    /**
+     * URL to the product page
+     */
+    url?: string | null;
+  }
+}
+
 export interface BrandAIQueryResponse {
   /**
    * Array of extracted data points
@@ -1456,6 +1550,23 @@ export interface BrandPrefetchResponse {
   status?: string;
 }
 
+export interface BrandPrefetchByEmailResponse {
+  /**
+   * The domain that was queued for prefetching
+   */
+  domain?: string;
+
+  /**
+   * Success message
+   */
+  message?: string;
+
+  /**
+   * Status of the response, e.g., 'ok'
+   */
+  status?: string;
+}
+
 export interface BrandRetrieveByEmailResponse {
   /**
    * Detailed brand information
@@ -4554,6 +4665,25 @@ export interface BrandRetrieveParams {
   timeoutMS?: number;
 }
 
+export interface BrandAIProductsParams {
+  /**
+   * The domain name to analyze
+   */
+  domain: string;
+
+  /**
+   * Maximum number of products to extract.
+   */
+  maxProducts?: number;
+
+  /**
+   * 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
@@ -5032,6 +5162,22 @@ export interface BrandPrefetchParams {
   timeoutMS?: number;
 }
 
+export interface BrandPrefetchByEmailParams {
+  /**
+   * Email address to prefetch brand data for. The domain will be extracted from the
+   * email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+   * addresses are not allowed.
+   */
+  email: 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 BrandRetrieveByEmailParams {
   /**
    * Email address to retrieve brand data for (e.g., 'contact@example.com'). The
@@ -5524,10 +5670,12 @@ export interface BrandStyleguideParams {
 export declare namespace Brand {
   export {
     type BrandRetrieveResponse as BrandRetrieveResponse,
+    type BrandAIProductsResponse as BrandAIProductsResponse,
     type BrandAIQueryResponse as BrandAIQueryResponse,
     type BrandFontsResponse as BrandFontsResponse,
     type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse,
     type BrandPrefetchResponse as BrandPrefetchResponse,
+    type BrandPrefetchByEmailResponse as BrandPrefetchByEmailResponse,
     type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse,
     type BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse,
     type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse,
@@ -5537,10 +5685,12 @@ export declare namespace Brand {
     type BrandScreenshotResponse as BrandScreenshotResponse,
     type BrandStyleguideResponse as BrandStyleguideResponse,
     type BrandRetrieveParams as BrandRetrieveParams,
+    type BrandAIProductsParams as BrandAIProductsParams,
     type BrandAIQueryParams as BrandAIQueryParams,
     type BrandFontsParams as BrandFontsParams,
     type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams,
     type BrandPrefetchParams as BrandPrefetchParams,
+    type BrandPrefetchByEmailParams as BrandPrefetchByEmailParams,
     type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams,
     type BrandRetrieveByIsinParams as BrandRetrieveByIsinParams,
     type BrandRetrieveByNameParams as BrandRetrieveByNameParams,

package/src/resources/index.ts

@@ -3,10 +3,12 @@
 export {
   Brand,
   type BrandRetrieveResponse,
+  type BrandAIProductsResponse,
   type BrandAIQueryResponse,
   type BrandFontsResponse,
   type BrandIdentifyFromTransactionResponse,
   type BrandPrefetchResponse,
+  type BrandPrefetchByEmailResponse,
   type BrandRetrieveByEmailResponse,
   type BrandRetrieveByIsinResponse,
   type BrandRetrieveByNameResponse,
@@ -16,10 +18,12 @@ export {
   type BrandScreenshotResponse,
   type BrandStyleguideResponse,
   type BrandRetrieveParams,
+  type BrandAIProductsParams,
   type BrandAIQueryParams,
   type BrandFontsParams,
   type BrandIdentifyFromTransactionParams,
   type BrandPrefetchParams,
+  type BrandPrefetchByEmailParams,
   type BrandRetrieveByEmailParams,
   type BrandRetrieveByIsinParams,
   type BrandRetrieveByNameParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.19.0'; // x-release-please-version
+export const VERSION = '0.21.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.19.0";
+export declare const VERSION = "0.21.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.19.0";
+export declare const VERSION = "0.21.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.19.0'; // x-release-please-version
+exports.VERSION = '0.21.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.19.0'; // x-release-please-version
+export const VERSION = '0.21.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map