brand.dev 0.1.0.pre.alpha.7 → 0.1.0.pre.alpha.9

data/rbi/brand_dev/models.rbi

@@ -14,5 +14,12 @@ module BrandDev
 
   BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
 
+  BrandRetrieveSimplifiedParams =
+    BrandDev::Models::BrandRetrieveSimplifiedParams
+
+  BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
+
   BrandSearchParams = BrandDev::Models::BrandSearchParams
+
+  BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
 end

data/rbi/brand_dev/resources/brand.rbi

@@ -141,6 +141,50 @@ module BrandDev
       )
       end
 
+      # Returns a simplified version of brand data containing only essential
+      # information: domain, title, colors, logos, and backdrops. This endpoint is
+      # optimized for faster responses and reduced data transfer.
+      sig do
+        params(
+          domain: String,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandRetrieveSimplifiedResponse)
+      end
+      def retrieve_simplified(
+        # Domain name to retrieve simplified brand data for
+        domain:,
+        # 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).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      # Beta feature: Capture a screenshot of a website. Supports both viewport
+      # (standard browser view) and full-page screenshots. Returns a URL to the uploaded
+      # screenshot image hosted on our CDN.
+      sig do
+        params(
+          domain: String,
+          full_screenshot:
+            BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandScreenshotResponse)
+      end
+      def screenshot(
+        # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
+        # domain will be automatically normalized and validated.
+        domain:,
+        # Optional parameter to determine screenshot type. If 'true', takes a full page
+        # screenshot capturing all content. If 'false' or not provided, takes a viewport
+        # screenshot (standard browser view).
+        full_screenshot: nil,
+        request_options: {}
+      )
+      end
+
       # Search brands by query
       sig do
         params(
@@ -160,6 +204,29 @@ module BrandDev
       )
       end
 
+      # Beta feature: Automatically extract comprehensive design system information from
+      # a brand's website including colors, typography, spacing, shadows, and UI
+      # components. Uses AI-powered analysis of website screenshots to identify design
+      # patterns and create a reusable styleguide.
+      sig do
+        params(
+          domain: String,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandStyleguideResponse)
+      end
+      def styleguide(
+        # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+        # domain will be automatically normalized and validated.
+        domain:,
+        # 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).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: BrandDev::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/brand_dev/errors.rbs

@@ -5,6 +5,15 @@ module BrandDev
     end
 
     class ConversionError < BrandDev::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
     end
 
     class APIError < BrandDev::Errors::Error

data/sig/brand_dev/internal/type/converter.rbs

@@ -8,8 +8,10 @@ module BrandDev
 
         type coerce_state =
           {
-            strictness: bool | :strong,
+            translate_names: bool,
+            strictness: bool,
             exactness: { yes: Integer, no: Integer, maybe: Integer },
+            error: Class,
             branched: Integer
           }
 
@@ -37,6 +39,10 @@ module BrandDev
           | BrandDev::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.new_coerce_state: (
+          ?translate_names: bool
+        ) -> BrandDev::Internal::Type::Converter::coerce_state
+
         def self.coerce: (
           BrandDev::Internal::Type::Converter::input target,
           top value,

data/sig/brand_dev/models/brand_retrieve_simplified_params.rbs

@@ -0,0 +1,30 @@
+module BrandDev
+  module Models
+    type brand_retrieve_simplified_params =
+      { domain: String, timeout_ms: Integer }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandRetrieveSimplifiedParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
+      def initialize: (
+        domain: String,
+        ?timeout_ms: Integer,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        timeout_ms: Integer,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/brand_dev/models/brand_retrieve_simplified_response.rbs

@@ -0,0 +1,292 @@
+module BrandDev
+  module Models
+    type brand_retrieve_simplified_response =
+      {
+        brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand,
+        code: Integer,
+        status: String
+      }
+
+    class BrandRetrieveSimplifiedResponse < BrandDev::Internal::Type::BaseModel
+      attr_reader brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand?
+
+      def brand=: (
+        BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand
+      ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand
+
+      attr_reader code: Integer?
+
+      def code=: (Integer) -> Integer
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      def initialize: (
+        ?brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand,
+        ?code: Integer,
+        ?status: String
+      ) -> void
+
+      def to_hash: -> {
+        brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand,
+        code: Integer,
+        status: String
+      }
+
+      type brand =
+        {
+          backdrops: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop],
+          colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color],
+          domain: String,
+          logos: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo],
+          title: String
+        }
+
+      class Brand < BrandDev::Internal::Type::BaseModel
+        attr_reader backdrops: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop]?
+
+        def backdrops=: (
+          ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop]
+
+        attr_reader colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color]?
+
+        def colors=: (
+          ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color]
+
+        attr_reader domain: String?
+
+        def domain=: (String) -> String
+
+        attr_reader logos: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo]?
+
+        def logos=: (
+          ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo]
+
+        attr_reader title: String?
+
+        def title=: (String) -> String
+
+        def initialize: (
+          ?backdrops: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop],
+          ?colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color],
+          ?domain: String,
+          ?logos: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo],
+          ?title: String
+        ) -> void
+
+        def to_hash: -> {
+          backdrops: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop],
+          colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color],
+          domain: String,
+          logos: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo],
+          title: String
+        }
+
+        type backdrop =
+          {
+            colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color],
+            resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution,
+            url: String
+          }
+
+        class Backdrop < BrandDev::Internal::Type::BaseModel
+          attr_reader colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color]?
+
+          def colors=: (
+            ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color]
+          ) -> ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color]
+
+          attr_reader resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution?
+
+          def resolution=: (
+            BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution
+          ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution
+
+          attr_reader url: String?
+
+          def url=: (String) -> String
+
+          def initialize: (
+            ?colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color],
+            ?resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution,
+            ?url: String
+          ) -> void
+
+          def to_hash: -> {
+            colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color],
+            resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution,
+            url: String
+          }
+
+          type color = { hex: String, name: String }
+
+          class Color < BrandDev::Internal::Type::BaseModel
+            attr_reader hex: String?
+
+            def hex=: (String) -> String
+
+            attr_reader name: String?
+
+            def name=: (String) -> String
+
+            def initialize: (?hex: String, ?name: String) -> void
+
+            def to_hash: -> { hex: String, name: String }
+          end
+
+          type resolution =
+            { aspect_ratio: Float, height: Integer, width: Integer }
+
+          class Resolution < BrandDev::Internal::Type::BaseModel
+            attr_reader aspect_ratio: Float?
+
+            def aspect_ratio=: (Float) -> Float
+
+            attr_reader height: Integer?
+
+            def height=: (Integer) -> Integer
+
+            attr_reader width: Integer?
+
+            def width=: (Integer) -> Integer
+
+            def initialize: (
+              ?aspect_ratio: Float,
+              ?height: Integer,
+              ?width: Integer
+            ) -> void
+
+            def to_hash: -> {
+              aspect_ratio: Float,
+              height: Integer,
+              width: Integer
+            }
+          end
+        end
+
+        type color = { hex: String, name: String }
+
+        class Color < BrandDev::Internal::Type::BaseModel
+          attr_reader hex: String?
+
+          def hex=: (String) -> String
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          def initialize: (?hex: String, ?name: String) -> void
+
+          def to_hash: -> { hex: String, name: String }
+        end
+
+        type logo =
+          {
+            colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color],
+            group: Integer,
+            mode: String,
+            resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution,
+            type: String,
+            url: String
+          }
+
+        class Logo < BrandDev::Internal::Type::BaseModel
+          attr_reader colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color]?
+
+          def colors=: (
+            ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color]
+          ) -> ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color]
+
+          attr_reader group: Integer?
+
+          def group=: (Integer) -> Integer
+
+          attr_reader mode: String?
+
+          def mode=: (String) -> String
+
+          attr_reader resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution?
+
+          def resolution=: (
+            BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution
+          ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution
+
+          attr_reader type: String?
+
+          def type=: (String) -> String
+
+          attr_reader url: String?
+
+          def url=: (String) -> String
+
+          def initialize: (
+            ?colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color],
+            ?group: Integer,
+            ?mode: String,
+            ?resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution,
+            ?type: String,
+            ?url: String
+          ) -> void
+
+          def to_hash: -> {
+            colors: ::Array[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color],
+            group: Integer,
+            mode: String,
+            resolution: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution,
+            type: String,
+            url: String
+          }
+
+          type color = { hex: String, name: String }
+
+          class Color < BrandDev::Internal::Type::BaseModel
+            attr_reader hex: String?
+
+            def hex=: (String) -> String
+
+            attr_reader name: String?
+
+            def name=: (String) -> String
+
+            def initialize: (?hex: String, ?name: String) -> void
+
+            def to_hash: -> { hex: String, name: String }
+          end
+
+          type resolution =
+            { aspect_ratio: Float, height: Integer, width: Integer }
+
+          class Resolution < BrandDev::Internal::Type::BaseModel
+            attr_reader aspect_ratio: Float?
+
+            def aspect_ratio=: (Float) -> Float
+
+            attr_reader height: Integer?
+
+            def height=: (Integer) -> Integer
+
+            attr_reader width: Integer?
+
+            def width=: (Integer) -> Integer
+
+            def initialize: (
+              ?aspect_ratio: Float,
+              ?height: Integer,
+              ?width: Integer
+            ) -> void
+
+            def to_hash: -> {
+              aspect_ratio: Float,
+              height: Integer,
+              width: Integer
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_screenshot_params.rbs

@@ -0,0 +1,46 @@
+module BrandDev
+  module Models
+    type brand_screenshot_params =
+      {
+        domain: String,
+        full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot
+      }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      attr_reader full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot?
+
+      def full_screenshot=: (
+        BrandDev::Models::BrandScreenshotParams::full_screenshot
+      ) -> BrandDev::Models::BrandScreenshotParams::full_screenshot
+
+      def initialize: (
+        domain: String,
+        ?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot,
+        request_options: BrandDev::RequestOptions
+      }
+
+      type full_screenshot = :true | :false
+
+      module FullScreenshot
+        extend BrandDev::Internal::Type::Enum
+
+        TRUE: :true
+        FALSE: :false
+
+        def self?.values: -> ::Array[BrandDev::Models::BrandScreenshotParams::full_screenshot]
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_screenshot_response.rbs

@@ -0,0 +1,63 @@
+module BrandDev
+  module Models
+    type brand_screenshot_response =
+      {
+        code: Integer,
+        domain: String,
+        screenshot: String,
+        screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type,
+        status: String
+      }
+
+    class BrandScreenshotResponse < BrandDev::Internal::Type::BaseModel
+      attr_reader code: Integer?
+
+      def code=: (Integer) -> Integer
+
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
+
+      attr_reader screenshot: String?
+
+      def screenshot=: (String) -> String
+
+      attr_reader screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type?
+
+      def screenshot_type=: (
+        BrandDev::Models::BrandScreenshotResponse::screenshot_type
+      ) -> BrandDev::Models::BrandScreenshotResponse::screenshot_type
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      def initialize: (
+        ?code: Integer,
+        ?domain: String,
+        ?screenshot: String,
+        ?screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type,
+        ?status: String
+      ) -> void
+
+      def to_hash: -> {
+        code: Integer,
+        domain: String,
+        screenshot: String,
+        screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type,
+        status: String
+      }
+
+      type screenshot_type = :viewport | :fullPage
+
+      module ScreenshotType
+        extend BrandDev::Internal::Type::Enum
+
+        VIEWPORT: :viewport
+        FULL_PAGE: :fullPage
+
+        def self?.values: -> ::Array[BrandDev::Models::BrandScreenshotResponse::screenshot_type]
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_styleguide_params.rbs

@@ -0,0 +1,30 @@
+module BrandDev
+  module Models
+    type brand_styleguide_params =
+      { domain: String, timeout_ms: Integer }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandStyleguideParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
+      def initialize: (
+        domain: String,
+        ?timeout_ms: Integer,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        timeout_ms: Integer,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end