brand.dev 0.25.0 → 0.27.0

data/rbi/brand_dev/models/brand_styleguide_params.rbi

@@ -11,10 +11,21 @@ module BrandDev
           T.any(BrandDev::BrandStyleguideParams, BrandDev::Internal::AnyHash)
         end
 
+      # A specific URL to fetch the styleguide from directly, bypassing domain
+      # resolution (e.g., 'https://example.com/design-system').
+      sig { returns(T.nilable(String)) }
+      attr_reader :direct_url
+
+      sig { params(direct_url: String).void }
+      attr_writer :direct_url
+
       # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       # domain will be automatically normalized and validated.
-      sig { returns(String) }
-      attr_accessor :domain
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
 
       # Optional parameter to prioritize screenshot capture for styleguide extraction.
       # If 'speed', optimizes for faster capture with basic quality. If 'quality',
@@ -45,6 +56,7 @@ module BrandDev
 
       sig do
         params(
+          direct_url: String,
           domain: String,
           prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
           timeout_ms: Integer,
@@ -52,9 +64,12 @@ module BrandDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # A specific URL to fetch the styleguide from directly, bypassing domain
+        # resolution (e.g., 'https://example.com/design-system').
+        direct_url: nil,
         # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated.
-        domain:,
+        domain: nil,
         # Optional parameter to prioritize screenshot capture for styleguide extraction.
         # If 'speed', optimizes for faster capture with basic quality. If 'quality',
         # optimizes for higher quality with longer wait times. Defaults to 'quality' if
@@ -71,6 +86,7 @@ module BrandDev
       sig do
         override.returns(
           {
+            direct_url: String,
             domain: String,
             prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
             timeout_ms: Integer,

data/rbi/brand_dev/models/brand_web_scrape_html_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandWebScrapeHTMLParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Full URL to scrape (must include http:// or https:// protocol)
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(
+          url: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Full URL to scrape (must include http:// or https:// protocol)
+        url:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { url: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_web_scrape_html_response.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandWebScrapeHTMLResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Raw HTML content of the page
+      sig { returns(String) }
+      attr_accessor :html
+
+      # Indicates success
+      sig do
+        returns(
+          BrandDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean
+        )
+      end
+      attr_accessor :success
+
+      # The URL that was scraped
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(
+          html: String,
+          success:
+            BrandDev::Models::BrandWebScrapeHTMLResponse::Success::OrBoolean,
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Raw HTML content of the page
+        html:,
+        # Indicates success
+        success:,
+        # The URL that was scraped
+        url:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            html: String,
+            success:
+              BrandDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean,
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(
+              T::Boolean,
+              BrandDev::Models::BrandWebScrapeHTMLResponse::Success
+            )
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            BrandDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              BrandDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_web_scrape_images_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::BrandWebScrapeImagesParams,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Full URL to scrape images from (must include http:// or https:// protocol)
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(
+          url: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Full URL to scrape images from (must include http:// or https:// protocol)
+        url:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { url: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_web_scrape_images_response.rbi

@@ -0,0 +1,259 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeImagesResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandWebScrapeImagesResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Array of scraped images
+      sig do
+        returns(T::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image])
+      end
+      attr_accessor :images
+
+      # Indicates success
+      sig do
+        returns(
+          BrandDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean
+        )
+      end
+      attr_accessor :success
+
+      # The URL that was scraped
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(
+          images:
+            T::Array[
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::OrHash
+            ],
+          success:
+            BrandDev::Models::BrandWebScrapeImagesResponse::Success::OrBoolean,
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of scraped images
+        images:,
+        # Indicates success
+        success:,
+        # The URL that was scraped
+        url:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            images:
+              T::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image],
+            success:
+              BrandDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean,
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Image < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image,
+              BrandDev::Internal::AnyHash
+            )
+          end
+
+        # Alt text of the image, or null if not present
+        sig { returns(T.nilable(String)) }
+        attr_accessor :alt
+
+        # The HTML element the image was found in
+        sig do
+          returns(
+            BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
+          )
+        end
+        attr_accessor :element
+
+        # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+        sig { returns(String) }
+        attr_accessor :src
+
+        # The type/format of the src value
+        sig do
+          returns(
+            BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        sig do
+          params(
+            alt: T.nilable(String),
+            element:
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::OrSymbol,
+            src: String,
+            type:
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Alt text of the image, or null if not present
+          alt:,
+          # The HTML element the image was found in
+          element:,
+          # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+          src:,
+          # The type/format of the src value
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              alt: T.nilable(String),
+              element:
+                BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol,
+              src: String,
+              type:
+                BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The HTML element the image was found in
+        module Element
+          extend BrandDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IMG =
+            T.let(
+              :img,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
+            )
+          SVG =
+            T.let(
+              :svg,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
+            )
+          LINK =
+            T.let(
+              :link,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
+            )
+          SOURCE =
+            T.let(
+              :source,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
+            )
+          VIDEO =
+            T.let(
+              :video,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The type/format of the src value
+        module Type
+          extend BrandDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          URL =
+            T.let(
+              :url,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
+            )
+          HTML =
+            T.let(
+              :html,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
+            )
+          BASE64 =
+            T.let(
+              :base64,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Indicates success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(
+              T::Boolean,
+              BrandDev::Models::BrandWebScrapeImagesResponse::Success
+            )
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            BrandDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              BrandDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_web_scrape_md_params.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandWebScrapeMdParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Full URL to scrape and convert to markdown (must include http:// or https://
+      # protocol)
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Include image references in Markdown output
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_images
+
+      sig { params(include_images: T::Boolean).void }
+      attr_writer :include_images
+
+      # Preserve hyperlinks in Markdown output
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_links
+
+      sig { params(include_links: T::Boolean).void }
+      attr_writer :include_links
+
+      sig do
+        params(
+          url: String,
+          include_images: T::Boolean,
+          include_links: T::Boolean,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Full URL to scrape and convert to markdown (must include http:// or https://
+        # protocol)
+        url:,
+        # Include image references in Markdown output
+        include_images: nil,
+        # Preserve hyperlinks in Markdown output
+        include_links: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            url: String,
+            include_images: T::Boolean,
+            include_links: T::Boolean,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_web_scrape_md_response.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandWebScrapeMdResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Page content converted to GitHub Flavored Markdown
+      sig { returns(String) }
+      attr_accessor :markdown
+
+      # Indicates success
+      sig do
+        returns(
+          BrandDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean
+        )
+      end
+      attr_accessor :success
+
+      # The URL that was scraped
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(
+          markdown: String,
+          success:
+            BrandDev::Models::BrandWebScrapeMdResponse::Success::OrBoolean,
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Page content converted to GitHub Flavored Markdown
+        markdown:,
+        # Indicates success
+        success:,
+        # The URL that was scraped
+        url:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            markdown: String,
+            success:
+              BrandDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean,
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates success
+      module Success
+        extend BrandDev::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(
+              T::Boolean,
+              BrandDev::Models::BrandWebScrapeMdResponse::Success
+            )
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            BrandDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              BrandDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::BrandWebScrapeSitemapParams,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
+      # automatically normalized and validated.
+      sig { returns(String) }
+      attr_accessor :domain
+
+      sig do
+        params(
+          domain: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
+        # automatically normalized and validated.
+        domain:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { domain: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end