brand.dev 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 586503b2436acd1a836fdd867ebaf4258c5cb928320defd1b62b70c712439bc8
-  data.tar.gz: 3adcd4f046fd0a5d7ee98a6ee2367191e1925a3549a0a8a4b779d876d1c2fe72
+  metadata.gz: 352acbb6668a328d87a316a4dba30616f02c7d1d7fcf472df6bb0109d9befdb1
+  data.tar.gz: 155f0018fd308c55dead3ef2ea0850085d21ded6920a9ae9c2f9229a2a527cd3
 SHA512:
-  metadata.gz: 96a199073279aa10b42f908a1fc3705290eebb271559fd8249bfdb2d8cd157dbd32fdb177381139ebed4bc2b6154f6e1b251c6e4278f6f19091c0321d3408063
-  data.tar.gz: cb915b6992b9ab682c0a0ebec5b11d7245f18c18e23fbf649bd19595157733f99e5d68763b37e2443572fa9911fe32d4f406d3a72e173035a7342a17aafc56ac
+  metadata.gz: 1f0a1068ce78f873ff484541d3a482de10824e093a4e70ee4df02804e3be6e02d2b5850bece4540b5519e92cd365af87a93b05d2b6fce9d315131d0fce525c02
+  data.tar.gz: e91395f9bb9671f7346e2e3dc0cc5d1e5a6a3b86ff28bd6eba0d03d3e8e546acce9dc8dc43b629f9fd7dc6dd9ea39503e64a3d29202e92bc3bbd3de049268aa1

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.27.0 (2026-02-24)
+
+Full Changelog: [v0.26.0...v0.27.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.26.0...v0.27.0)
+
+### Features
+
+* **api:** api update ([cbe6c73](https://github.com/brand-dot-dev/ruby-sdk/commit/cbe6c7376d1fb53af66e31c6154edd684722e712))
+
+## 0.26.0 (2026-02-23)
+
+Full Changelog: [v0.25.0...v0.26.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.25.0...v0.26.0)
+
+### Features
+
+* **api:** manual updates ([bfe9b29](https://github.com/brand-dot-dev/ruby-sdk/commit/bfe9b298f2c51f4d2762da550344251c2b0b7256))
+
 ## 0.25.0 (2026-02-22)
 
 Full Changelog: [v0.24.0...v0.25.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.24.0...v0.25.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "brand.dev", "~> 0.25.0"
+gem "brand.dev", "~> 0.27.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/brand_dev/models/brand_styleguide_params.rb

@@ -7,12 +7,19 @@ module BrandDev
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
+      # @!attribute direct_url
+      #   A specific URL to fetch the styleguide from directly, bypassing domain
+      #   resolution (e.g., 'https://example.com/design-system').
+      #
+      #   @return [String, nil]
+      optional :direct_url, String
+
       # @!attribute domain
       #   Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #   domain will be automatically normalized and validated.
       #
-      #   @return [String]
-      required :domain, String
+      #   @return [String, nil]
+      optional :domain, String
 
       # @!attribute prioritize
       #   Optional parameter to prioritize screenshot capture for styleguide extraction.
@@ -31,10 +38,12 @@ module BrandDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(domain:, prioritize: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandStyleguideParams} for more details.
       #
+      #   @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, BrandDev::Models::BrandStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I

data/lib/brand_dev/models/brand_web_scrape_html_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_html
+    class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Full URL to scrape (must include http:// or https:// protocol)
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(url:, request_options: {})
+      #   @param url [String] Full URL to scrape (must include http:// or https:// protocol)
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_web_scrape_html_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_html
+    class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute html
+      #   Raw HTML content of the page
+      #
+      #   @return [String]
+      required :html, String
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, BrandDev::Models::BrandWebScrapeHTMLResponse::Success]
+      required :success, enum: -> { BrandDev::Models::BrandWebScrapeHTMLResponse::Success }
+
+      # @!attribute url
+      #   The URL that was scraped
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(html:, success:, url:)
+      #   @param html [String] Raw HTML content of the page
+      #
+      #   @param success [Boolean, BrandDev::Models::BrandWebScrapeHTMLResponse::Success] Indicates success
+      #
+      #   @param url [String] The URL that was scraped
+
+      # Indicates success
+      #
+      # @see BrandDev::Models::BrandWebScrapeHTMLResponse#success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_web_scrape_images_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_images
+    class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Full URL to scrape images from (must include http:// or https:// protocol)
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(url:, request_options: {})
+      #   @param url [String] Full URL to scrape images from (must include http:// or https:// protocol)
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_web_scrape_images_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_images
+    class BrandWebScrapeImagesResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute images
+      #   Array of scraped images
+      #
+      #   @return [Array<BrandDev::Models::BrandWebScrapeImagesResponse::Image>]
+      required :images,
+               -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandWebScrapeImagesResponse::Image] }
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, BrandDev::Models::BrandWebScrapeImagesResponse::Success]
+      required :success, enum: -> { BrandDev::Models::BrandWebScrapeImagesResponse::Success }
+
+      # @!attribute url
+      #   The URL that was scraped
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(images:, success:, url:)
+      #   @param images [Array<BrandDev::Models::BrandWebScrapeImagesResponse::Image>] Array of scraped images
+      #
+      #   @param success [Boolean, BrandDev::Models::BrandWebScrapeImagesResponse::Success] Indicates success
+      #
+      #   @param url [String] The URL that was scraped
+
+      class Image < BrandDev::Internal::Type::BaseModel
+        # @!attribute alt
+        #   Alt text of the image, or null if not present
+        #
+        #   @return [String, nil]
+        required :alt, String, nil?: true
+
+        # @!attribute element
+        #   The HTML element the image was found in
+        #
+        #   @return [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element]
+        required :element, enum: -> { BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element }
+
+        # @!attribute src
+        #   The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+        #
+        #   @return [String]
+        required :src, String
+
+        # @!attribute type
+        #   The type/format of the src value
+        #
+        #   @return [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type]
+        required :type, enum: -> { BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type }
+
+        # @!method initialize(alt:, element:, src:, type:)
+        #   @param alt [String, nil] Alt text of the image, or null if not present
+        #
+        #   @param element [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element] The HTML element the image was found in
+        #
+        #   @param src [String] The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+        #
+        #   @param type [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type] The type/format of the src value
+
+        # The HTML element the image was found in
+        #
+        # @see BrandDev::Models::BrandWebScrapeImagesResponse::Image#element
+        module Element
+          extend BrandDev::Internal::Type::Enum
+
+          IMG = :img
+          SVG = :svg
+          LINK = :link
+          SOURCE = :source
+          VIDEO = :video
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The type/format of the src value
+        #
+        # @see BrandDev::Models::BrandWebScrapeImagesResponse::Image#type
+        module Type
+          extend BrandDev::Internal::Type::Enum
+
+          URL = :url
+          HTML = :html
+          BASE64 = :base64
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Indicates success
+      #
+      # @see BrandDev::Models::BrandWebScrapeImagesResponse#success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_web_scrape_md_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_md
+    class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Full URL to scrape and convert to markdown (must include http:// or https://
+      #   protocol)
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute include_images
+      #   Include image references in Markdown output
+      #
+      #   @return [Boolean, nil]
+      optional :include_images, BrandDev::Internal::Type::Boolean
+
+      # @!attribute include_links
+      #   Preserve hyperlinks in Markdown output
+      #
+      #   @return [Boolean, nil]
+      optional :include_links, BrandDev::Internal::Type::Boolean
+
+      # @!method initialize(url:, include_images: nil, include_links: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandWebScrapeMdParams} for more details.
+      #
+      #   @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 request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_web_scrape_md_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_md
+    class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute markdown
+      #   Page content converted to GitHub Flavored Markdown
+      #
+      #   @return [String]
+      required :markdown, String
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, BrandDev::Models::BrandWebScrapeMdResponse::Success]
+      required :success, enum: -> { BrandDev::Models::BrandWebScrapeMdResponse::Success }
+
+      # @!attribute url
+      #   The URL that was scraped
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(markdown:, success:, url:)
+      #   @param markdown [String] Page content converted to GitHub Flavored Markdown
+      #
+      #   @param success [Boolean, BrandDev::Models::BrandWebScrapeMdResponse::Success] Indicates success
+      #
+      #   @param url [String] The URL that was scraped
+
+      # Indicates success
+      #
+      # @see BrandDev::Models::BrandWebScrapeMdResponse#success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_sitemap
+    class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
+      #   automatically normalized and validated.
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!method initialize(domain:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandWebScrapeSitemapParams} for more details.
+      #
+      #   @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_web_scrape_sitemap_response.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#web_scrape_sitemap
+    class BrandWebScrapeSitemapResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute domain
+      #   The normalized domain that was crawled
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute meta
+      #   Metadata about the sitemap crawl operation
+      #
+      #   @return [BrandDev::Models::BrandWebScrapeSitemapResponse::Meta]
+      required :meta, -> { BrandDev::Models::BrandWebScrapeSitemapResponse::Meta }
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, BrandDev::Models::BrandWebScrapeSitemapResponse::Success]
+      required :success, enum: -> { BrandDev::Models::BrandWebScrapeSitemapResponse::Success }
+
+      # @!attribute urls
+      #   Array of discovered page URLs from the sitemap (max 500)
+      #
+      #   @return [Array<String>]
+      required :urls, BrandDev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(domain:, meta:, success:, urls:)
+      #   @param domain [String] The normalized domain that was crawled
+      #
+      #   @param meta [BrandDev::Models::BrandWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation
+      #
+      #   @param success [Boolean, BrandDev::Models::BrandWebScrapeSitemapResponse::Success] Indicates success
+      #
+      #   @param urls [Array<String>] Array of discovered page URLs from the sitemap (max 500)
+
+      # @see BrandDev::Models::BrandWebScrapeSitemapResponse#meta
+      class Meta < BrandDev::Internal::Type::BaseModel
+        # @!attribute errors
+        #   Number of errors encountered during crawling
+        #
+        #   @return [Integer]
+        required :errors, Integer
+
+        # @!attribute sitemaps_discovered
+        #   Total number of sitemap files discovered
+        #
+        #   @return [Integer]
+        required :sitemaps_discovered, Integer, api_name: :sitemapsDiscovered
+
+        # @!attribute sitemaps_fetched
+        #   Number of sitemap files successfully fetched and parsed
+        #
+        #   @return [Integer]
+        required :sitemaps_fetched, Integer, api_name: :sitemapsFetched
+
+        # @!attribute sitemaps_skipped
+        #   Number of sitemap files skipped (due to errors, timeouts, or limits)
+        #
+        #   @return [Integer]
+        required :sitemaps_skipped, Integer, api_name: :sitemapsSkipped
+
+        # @!method initialize(errors:, sitemaps_discovered:, sitemaps_fetched:, sitemaps_skipped:)
+        #   Metadata about the sitemap crawl operation
+        #
+        #   @param errors [Integer] Number of errors encountered during crawling
+        #
+        #   @param sitemaps_discovered [Integer] Total number of sitemap files discovered
+        #
+        #   @param sitemaps_fetched [Integer] Number of sitemap files successfully fetched and parsed
+        #
+        #   @param sitemaps_skipped [Integer] Number of sitemap files skipped (due to errors, timeouts, or limits)
+      end
+
+      # Indicates success
+      #
+      # @see BrandDev::Models::BrandWebScrapeSitemapResponse#success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models.rb

@@ -70,4 +70,12 @@ module BrandDev
   BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
 
   BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
+
+  BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams
+
+  BrandWebScrapeImagesParams = BrandDev::Models::BrandWebScrapeImagesParams
+
+  BrandWebScrapeMdParams = BrandDev::Models::BrandWebScrapeMdParams
+
+  BrandWebScrapeSitemapParams = BrandDev::Models::BrandWebScrapeSitemapParams
 end

data/lib/brand_dev/resources/brand.rb

@@ -496,8 +496,12 @@ module BrandDev
       #
       # 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(domain:, prioritize: nil, timeout_ms: nil, request_options: {})
+      # @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
       #
@@ -510,17 +514,122 @@ module BrandDev
       # @return [BrandDev::Models::BrandStyleguideResponse]
       #
       # @see BrandDev::Models::BrandStyleguideParams
-      def styleguide(params)
+      def styleguide(params = {})
         parsed, options = BrandDev::BrandStyleguideParams.dump_request(params)
         @client.request(
           method: :get,
           path: "brand/styleguide",
-          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
+          query: parsed.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"),
           model: BrandDev::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 [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandWebScrapeHTMLResponse]
+      #
+      # @see BrandDev::Models::BrandWebScrapeHTMLParams
+      def web_scrape_html(params)
+        parsed, options = BrandDev::BrandWebScrapeHTMLParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "web/scrape/html",
+          query: parsed,
+          model: BrandDev::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 [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandWebScrapeImagesResponse]
+      #
+      # @see BrandDev::Models::BrandWebScrapeImagesParams
+      def web_scrape_images(params)
+        parsed, options = BrandDev::BrandWebScrapeImagesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "web/scrape/images",
+          query: parsed,
+          model: BrandDev::Models::BrandWebScrapeImagesResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::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, 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 request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandWebScrapeMdResponse]
+      #
+      # @see BrandDev::Models::BrandWebScrapeMdParams
+      def web_scrape_md(params)
+        parsed, options = BrandDev::BrandWebScrapeMdParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "web/scrape/markdown",
+          query: parsed.transform_keys(include_images: "includeImages", include_links: "includeLinks"),
+          model: BrandDev::Models::BrandWebScrapeMdResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::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 [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandWebScrapeSitemapResponse]
+      #
+      # @see BrandDev::Models::BrandWebScrapeSitemapParams
+      def web_scrape_sitemap(params)
+        parsed, options = BrandDev::BrandWebScrapeSitemapParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "web/scrape/sitemap",
+          query: parsed,
+          model: BrandDev::Models::BrandWebScrapeSitemapResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [BrandDev::Client]

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.25.0"
+  VERSION = "0.27.0"
 end

data/lib/brand_dev.rb

@@ -84,5 +84,13 @@ require_relative "brand_dev/models/brand_screenshot_params"
 require_relative "brand_dev/models/brand_screenshot_response"
 require_relative "brand_dev/models/brand_styleguide_params"
 require_relative "brand_dev/models/brand_styleguide_response"
+require_relative "brand_dev/models/brand_web_scrape_html_params"
+require_relative "brand_dev/models/brand_web_scrape_html_response"
+require_relative "brand_dev/models/brand_web_scrape_images_params"
+require_relative "brand_dev/models/brand_web_scrape_images_response"
+require_relative "brand_dev/models/brand_web_scrape_md_params"
+require_relative "brand_dev/models/brand_web_scrape_md_response"
+require_relative "brand_dev/models/brand_web_scrape_sitemap_params"
+require_relative "brand_dev/models/brand_web_scrape_sitemap_response"
 require_relative "brand_dev/models"
 require_relative "brand_dev/resources/brand"