context.dev 0.1.0 → 0.2.0

data/lib/context_dev/resources/brand.rb

@@ -36,120 +36,6 @@ module ContextDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandAIProductParams} for more details.
-      #
-      # Beta feature: Given a single URL, determines if it is a product detail page,
-      # classifies the platform/product type, and extracts the product information.
-      # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites.
-      #
-      # @overload ai_product(url:, timeout_ms: nil, request_options: {})
-      #
-      # @param url [String] The product page URL to extract product data from.
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandAIProductResponse]
-      #
-      # @see ContextDev::Models::BrandAIProductParams
-      def ai_product(params)
-        parsed, options = ContextDev::BrandAIProductParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/ai/product",
-          body: parsed,
-          model: ContextDev::Models::BrandAIProductResponse,
-          options: options
-        )
-      end
-
-      # 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.
-      #
-      # @overload ai_products(body:, request_options: {})
-      #
-      # @param body [ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL]
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandAIProductsResponse]
-      #
-      # @see ContextDev::Models::BrandAIProductsParams
-      def ai_products(params)
-        parsed, options = ContextDev::BrandAIProductsParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/ai/products",
-          body: parsed[:body],
-          model: ContextDev::Models::BrandAIProductsResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandAIQueryParams} for more details.
-      #
-      # 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.
-      #
-      # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {})
-      #
-      # @param data_to_extract [Array<ContextDev::Models::BrandAIQueryParams::DataToExtract>] Array of data points to extract from the website
-      #
-      # @param domain [String] The domain name to analyze
-      #
-      # @param specific_pages [ContextDev::Models::BrandAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandAIQueryResponse]
-      #
-      # @see ContextDev::Models::BrandAIQueryParams
-      def ai_query(params)
-        parsed, options = ContextDev::BrandAIQueryParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/ai/query",
-          body: parsed,
-          model: ContextDev::Models::BrandAIQueryResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandFontsParams} for more details.
-      #
-      # Extract font information from a brand's website including font families, usage
-      # statistics, fallbacks, and element/word counts.
-      #
-      # @overload fonts(domain:, timeout_ms: nil, request_options: {})
-      #
-      # @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandFontsResponse]
-      #
-      # @see ContextDev::Models::BrandFontsParams
-      def fonts(params)
-        parsed, options = ContextDev::BrandFontsParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "brand/fonts",
-          query: query.transform_keys(timeout_ms: "timeoutMS"),
-          model: ContextDev::Models::BrandFontsResponse,
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BrandIdentifyFromTransactionParams} for more details.
       #
@@ -193,68 +79,6 @@ module ContextDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandPrefetchParams} for more details.
-      #
-      # 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]
-      #
-      # @overload prefetch(domain:, timeout_ms: nil, request_options: {})
-      #
-      # @param domain [String] Domain name to prefetch brand data for
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandPrefetchResponse]
-      #
-      # @see ContextDev::Models::BrandPrefetchParams
-      def prefetch(params)
-        parsed, options = ContextDev::BrandPrefetchParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/prefetch",
-          body: parsed,
-          model: ContextDev::Models::BrandPrefetchResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandPrefetchByEmailParams} for more details.
-      #
-      # 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]
-      #
-      # @overload prefetch_by_email(email:, timeout_ms: nil, request_options: {})
-      #
-      # @param email [String] Email address to prefetch brand data for. The domain will be extracted from the
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandPrefetchByEmailResponse]
-      #
-      # @see ContextDev::Models::BrandPrefetchByEmailParams
-      def prefetch_by_email(params)
-        parsed, options = ContextDev::BrandPrefetchByEmailParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/prefetch-by-email",
-          body: parsed,
-          model: ContextDev::Models::BrandPrefetchByEmailResponse,
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BrandRetrieveByEmailParams} for more details.
       #
@@ -394,42 +218,6 @@ module ContextDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandRetrieveNaicsParams} for more details.
-      #
-      # Endpoint to classify any brand into a 2022 NAICS code.
-      #
-      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {})
-      #
-      # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
-      #
-      # @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5
-      #
-      # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandRetrieveNaicsResponse]
-      #
-      # @see ContextDev::Models::BrandRetrieveNaicsParams
-      def retrieve_naics(params)
-        parsed, options = ContextDev::BrandRetrieveNaicsParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "brand/naics",
-          query: query.transform_keys(
-            max_results: "maxResults",
-            min_results: "minResults",
-            timeout_ms: "timeoutMS"
-          ),
-          model: ContextDev::Models::BrandRetrieveNaicsResponse,
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
       #
@@ -460,191 +248,6 @@ module ContextDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandScreenshotParams} for more details.
-      #
-      # 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.
-      #
-      # @overload screenshot(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {})
-      #
-      # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai
-      #
-      # @param full_screenshot [Symbol, ContextDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
-      #
-      # @param page [Symbol, ContextDev::Models::BrandScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy
-      #
-      # @param prioritize [Symbol, ContextDev::Models::BrandScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandScreenshotResponse]
-      #
-      # @see ContextDev::Models::BrandScreenshotParams
-      def screenshot(params)
-        parsed, options = ContextDev::BrandScreenshotParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "brand/screenshot",
-          query: query.transform_keys(full_screenshot: "fullScreenshot"),
-          model: ContextDev::Models::BrandScreenshotResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandStyleguideParams} for more details.
-      #
-      # Automatically extract comprehensive design system information from a brand's
-      # website including colors, typography, spacing, shadows, and UI components.
-      # Either 'domain' or 'directUrl' must be provided as a query parameter, but not
-      # both.
-      #
-      # @overload styleguide(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {})
-      #
-      # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
-      #
-      # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
-      #
-      # @param prioritize [Symbol, ContextDev::Models::BrandStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandStyleguideResponse]
-      #
-      # @see ContextDev::Models::BrandStyleguideParams
-      def styleguide(params = {})
-        parsed, options = ContextDev::BrandStyleguideParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "brand/styleguide",
-          query: query.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"),
-          model: ContextDev::Models::BrandStyleguideResponse,
-          options: options
-        )
-      end
-
-      # Scrapes the given URL and returns the raw HTML content of the page. Uses
-      # automatic proxy escalation to handle blocked sites.
-      #
-      # @overload web_scrape_html(url:, request_options: {})
-      #
-      # @param url [String] Full URL to scrape (must include http:// or https:// protocol)
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandWebScrapeHTMLResponse]
-      #
-      # @see ContextDev::Models::BrandWebScrapeHTMLParams
-      def web_scrape_html(params)
-        parsed, options = ContextDev::BrandWebScrapeHTMLParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "web/scrape/html",
-          query: query,
-          model: ContextDev::Models::BrandWebScrapeHTMLResponse,
-          options: options
-        )
-      end
-
-      # Scrapes all images from the given URL. Extracts images from img, svg,
-      # picture/source, link, and video elements including inline SVGs, base64 data
-      # URIs, and standard URLs.
-      #
-      # @overload web_scrape_images(url:, request_options: {})
-      #
-      # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol)
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandWebScrapeImagesResponse]
-      #
-      # @see ContextDev::Models::BrandWebScrapeImagesParams
-      def web_scrape_images(params)
-        parsed, options = ContextDev::BrandWebScrapeImagesParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "web/scrape/images",
-          query: query,
-          model: ContextDev::Models::BrandWebScrapeImagesResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandWebScrapeMdParams} for more details.
-      #
-      # Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown
-      # (GFM), and returns the result. Uses automatic proxy escalation to handle blocked
-      # sites.
-      #
-      # @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
-      #
-      # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro
-      #
-      # @param include_images [Boolean] Include image references in Markdown output
-      #
-      # @param include_links [Boolean] Preserve hyperlinks in Markdown output
-      #
-      # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandWebScrapeMdResponse]
-      #
-      # @see ContextDev::Models::BrandWebScrapeMdParams
-      def web_scrape_md(params)
-        parsed, options = ContextDev::BrandWebScrapeMdParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "web/scrape/markdown",
-          query: query.transform_keys(
-            include_images: "includeImages",
-            include_links: "includeLinks",
-            shorten_base64_images: "shortenBase64Images"
-          ),
-          model: ContextDev::Models::BrandWebScrapeMdResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandWebScrapeSitemapParams} for more details.
-      #
-      # Crawls the sitemap of the given domain and returns all discovered page URLs.
-      # Supports sitemap index files (recursive), parallel fetching with concurrency
-      # control, deduplication, and filters out non-page resources (images, PDFs, etc.).
-      #
-      # @overload web_scrape_sitemap(domain:, request_options: {})
-      #
-      # @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandWebScrapeSitemapResponse]
-      #
-      # @see ContextDev::Models::BrandWebScrapeSitemapParams
-      def web_scrape_sitemap(params)
-        parsed, options = ContextDev::BrandWebScrapeSitemapParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "web/scrape/sitemap",
-          query: query,
-          model: ContextDev::Models::BrandWebScrapeSitemapResponse,
-          options: options
-        )
-      end
-
       # @api private
       #
       # @param client [ContextDev::Client]

data/lib/context_dev/resources/industry.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Resources
+    class Industry
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::IndustryRetrieveNaicsParams} for more details.
+      #
+      # Endpoint to classify any brand into a 2022 NAICS code.
+      #
+      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {})
+      #
+      # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
+      #
+      # @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5
+      #
+      # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::IndustryRetrieveNaicsResponse]
+      #
+      # @see ContextDev::Models::IndustryRetrieveNaicsParams
+      def retrieve_naics(params)
+        parsed, options = ContextDev::IndustryRetrieveNaicsParams.dump_request(params)
+        query = ContextDev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "brand/naics",
+          query: query.transform_keys(
+            max_results: "maxResults",
+            min_results: "minResults",
+            timeout_ms: "timeoutMS"
+          ),
+          model: ContextDev::Models::IndustryRetrieveNaicsResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ContextDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/context_dev/resources/style.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Resources
+    class Style
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::StyleExtractFontsParams} for more details.
+      #
+      # Extract font information from a brand's website including font families, usage
+      # statistics, fallbacks, and element/word counts.
+      #
+      # @overload extract_fonts(domain:, timeout_ms: nil, request_options: {})
+      #
+      # @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::StyleExtractFontsResponse]
+      #
+      # @see ContextDev::Models::StyleExtractFontsParams
+      def extract_fonts(params)
+        parsed, options = ContextDev::StyleExtractFontsParams.dump_request(params)
+        query = ContextDev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "brand/fonts",
+          query: query.transform_keys(timeout_ms: "timeoutMS"),
+          model: ContextDev::Models::StyleExtractFontsResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::StyleExtractStyleguideParams} for more details.
+      #
+      # Automatically extract comprehensive design system information from a brand's
+      # website including colors, typography, spacing, shadows, and UI components.
+      # Either 'domain' or 'directUrl' must be provided as a query parameter, but not
+      # both.
+      #
+      # @overload extract_styleguide(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {})
+      #
+      # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
+      #
+      # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      #
+      # @param prioritize [Symbol, ContextDev::Models::StyleExtractStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::StyleExtractStyleguideResponse]
+      #
+      # @see ContextDev::Models::StyleExtractStyleguideParams
+      def extract_styleguide(params = {})
+        parsed, options = ContextDev::StyleExtractStyleguideParams.dump_request(params)
+        query = ContextDev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "brand/styleguide",
+          query: query.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"),
+          model: ContextDev::Models::StyleExtractStyleguideResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ContextDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/context_dev/resources/utility.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Resources
+    class Utility
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::UtilityPrefetchParams} for more details.
+      #
+      # 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]
+      #
+      # @overload prefetch(domain:, timeout_ms: nil, request_options: {})
+      #
+      # @param domain [String] Domain name to prefetch brand data for
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::UtilityPrefetchResponse]
+      #
+      # @see ContextDev::Models::UtilityPrefetchParams
+      def prefetch(params)
+        parsed, options = ContextDev::UtilityPrefetchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/prefetch",
+          body: parsed,
+          model: ContextDev::Models::UtilityPrefetchResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::UtilityPrefetchByEmailParams} for more details.
+      #
+      # 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]
+      #
+      # @overload prefetch_by_email(email:, timeout_ms: nil, request_options: {})
+      #
+      # @param email [String] Email address to prefetch brand data for. The domain will be extracted from the
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::UtilityPrefetchByEmailResponse]
+      #
+      # @see ContextDev::Models::UtilityPrefetchByEmailParams
+      def prefetch_by_email(params)
+        parsed, options = ContextDev::UtilityPrefetchByEmailParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/prefetch-by-email",
+          body: parsed,
+          model: ContextDev::Models::UtilityPrefetchByEmailResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ContextDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end