brand.dev 0.0.1.pre.alpha.0 → 0.0.2

data/rbi/brand_dev/models.rbi

@@ -1,14 +1,23 @@
 # typed: strong
 
 module BrandDev
+  BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams
+
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams
 
   BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
 
-  BrandSearchParams = BrandDev::Models::BrandSearchParams
+  BrandRetrieveSimplifiedParams =
+    BrandDev::Models::BrandRetrieveSimplifiedParams
+
+  BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
+
+  BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
 end

data/rbi/brand_dev/resources/brand.rbi

@@ -9,6 +9,8 @@ module BrandDev
           domain: String,
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveResponse)
       end
@@ -17,6 +19,42 @@ module BrandDev
         domain:,
         # Optional parameter to force the language of the retrieved brand data
         force_language: nil,
+        # Optional parameter to optimize the API call for maximum speed. When set to true,
+        # the API will skip time-consuming operations for faster response at the cost of
+        # less comprehensive data.
+        max_speed: nil,
+        # 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: 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.
+      sig do
+        params(
+          data_to_extract:
+            T::Array[BrandDev::BrandAIQueryParams::DataToExtract::OrHash],
+          domain: String,
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandAIQueryResponse)
+      end
+      def ai_query(
+        # Array of data points to extract from the website
+        data_to_extract:,
+        # The domain name to analyze
+        domain:,
+        # Optional object specifying which pages to analyze
+        specific_pages: nil,
+        # 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
@@ -26,12 +64,39 @@ module BrandDev
       sig do
         params(
           transaction_info: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandIdentifyFromTransactionResponse)
       end
       def identify_from_transaction(
         # Transaction information to identify the brand
         transaction_info:,
+        # 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
+
+      # 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]
+      sig do
+        params(
+          domain: String,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandPrefetchResponse)
+      end
+      def prefetch(
+        # Domain name to prefetch 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
@@ -40,12 +105,17 @@ module BrandDev
       sig do
         params(
           ticker: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveByTickerResponse)
       end
       def retrieve_by_ticker(
         # Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
         ticker:,
+        # 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
@@ -54,6 +124,7 @@ module BrandDev
       sig do
         params(
           input: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveNaicsResponse)
       end
@@ -62,20 +133,76 @@ module BrandDev
         # in `input`, it will be used for classification, otherwise, we will search for
         # the brand using the provided title.
         input:,
+        # 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
+
+      # 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
 
-      # Search brands by query
+      # 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(
-          query: String,
+          domain: String,
+          full_screenshot:
+            BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol,
           request_options: BrandDev::RequestOptions::OrHash
-        ).returns(T::Array[BrandDev::Models::BrandSearchResponseItem])
+        ).returns(BrandDev::Models::BrandScreenshotResponse)
       end
-      def search(
-        # Query string to search brands
-        query:,
+      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
+
+      # Beta feature: Automatically extract comprehensive design system information from
+      # a brand's website including colors, typography, spacing, shadows, and UI
+      # components.
+      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

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_ai_query_params.rbs

@@ -0,0 +1,162 @@
+module BrandDev
+  module Models
+    type brand_ai_query_params =
+      {
+        data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+        domain: String,
+        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        timeout_ms: Integer
+      }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandAIQueryParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract]
+
+      attr_accessor domain: String
+
+      attr_reader specific_pages: BrandDev::BrandAIQueryParams::SpecificPages?
+
+      def specific_pages=: (
+        BrandDev::BrandAIQueryParams::SpecificPages
+      ) -> BrandDev::BrandAIQueryParams::SpecificPages
+
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
+      def initialize: (
+        data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+        domain: String,
+        ?specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        ?timeout_ms: Integer,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
+        domain: String,
+        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        timeout_ms: Integer,
+        request_options: BrandDev::RequestOptions
+      }
+
+      type data_to_extract =
+        {
+          datapoint_description: String,
+          datapoint_example: String,
+          datapoint_name: String,
+          datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+        }
+
+      class DataToExtract < BrandDev::Internal::Type::BaseModel
+        attr_accessor datapoint_description: String
+
+        attr_accessor datapoint_example: String
+
+        attr_accessor datapoint_name: String
+
+        attr_accessor datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+
+        def initialize: (
+          datapoint_description: String,
+          datapoint_example: String,
+          datapoint_name: String,
+          datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+        ) -> void
+
+        def to_hash: -> {
+          datapoint_description: String,
+          datapoint_example: String,
+          datapoint_name: String,
+          datapoint_type: BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type
+        }
+
+        type datapoint_type = :text | :number | :date | :boolean | :list | :url
+
+        module DatapointType
+          extend BrandDev::Internal::Type::Enum
+
+          TEXT: :text
+          NUMBER: :number
+          DATE: :date
+          BOOLEAN: :boolean
+          LIST: :list
+          URL: :url
+
+          def self?.values: -> ::Array[BrandDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type]
+        end
+      end
+
+      type specific_pages =
+        {
+          about_us: bool,
+          blog: bool,
+          careers: bool,
+          contact_us: bool,
+          faq: bool,
+          home_page: bool,
+          privacy_policy: bool,
+          terms_and_conditions: bool
+        }
+
+      class SpecificPages < BrandDev::Internal::Type::BaseModel
+        attr_reader about_us: bool?
+
+        def about_us=: (bool) -> bool
+
+        attr_reader blog: bool?
+
+        def blog=: (bool) -> bool
+
+        attr_reader careers: bool?
+
+        def careers=: (bool) -> bool
+
+        attr_reader contact_us: bool?
+
+        def contact_us=: (bool) -> bool
+
+        attr_reader faq: bool?
+
+        def faq=: (bool) -> bool
+
+        attr_reader home_page: bool?
+
+        def home_page=: (bool) -> bool
+
+        attr_reader privacy_policy: bool?
+
+        def privacy_policy=: (bool) -> bool
+
+        attr_reader terms_and_conditions: bool?
+
+        def terms_and_conditions=: (bool) -> bool
+
+        def initialize: (
+          ?about_us: bool,
+          ?blog: bool,
+          ?careers: bool,
+          ?contact_us: bool,
+          ?faq: bool,
+          ?home_page: bool,
+          ?privacy_policy: bool,
+          ?terms_and_conditions: bool
+        ) -> void
+
+        def to_hash: -> {
+          about_us: bool,
+          blog: bool,
+          careers: bool,
+          contact_us: bool,
+          faq: bool,
+          home_page: bool,
+          privacy_policy: bool,
+          terms_and_conditions: bool
+        }
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_ai_query_response.rbs

@@ -0,0 +1,79 @@
+module BrandDev
+  module Models
+    type brand_ai_query_response =
+      {
+        data_extracted: ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted],
+        domain: String,
+        urls_analyzed: ::Array[String]
+      }
+
+    class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel
+      attr_reader data_extracted: ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted]?
+
+      def data_extracted=: (
+        ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted]
+      ) -> ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted]
+
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
+
+      attr_reader urls_analyzed: ::Array[String]?
+
+      def urls_analyzed=: (::Array[String]) -> ::Array[String]
+
+      def initialize: (
+        ?data_extracted: ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted],
+        ?domain: String,
+        ?urls_analyzed: ::Array[String]
+      ) -> void
+
+      def to_hash: -> {
+        data_extracted: ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted],
+        domain: String,
+        urls_analyzed: ::Array[String]
+      }
+
+      type data_extracted =
+        {
+          datapoint_name: String,
+          datapoint_value: BrandDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value
+        }
+
+      class DataExtracted < BrandDev::Internal::Type::BaseModel
+        attr_reader datapoint_name: String?
+
+        def datapoint_name=: (String) -> String
+
+        attr_reader datapoint_value: BrandDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value?
+
+        def datapoint_value=: (
+          BrandDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value
+        ) -> BrandDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value
+
+        def initialize: (
+          ?datapoint_name: String,
+          ?datapoint_value: BrandDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value
+        ) -> void
+
+        def to_hash: -> {
+          datapoint_name: String,
+          datapoint_value: BrandDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value
+        }
+
+        type datapoint_value =
+          String | Float | bool | ::Array[String] | ::Array[Float]
+
+        module DatapointValue
+          extend BrandDev::Internal::Type::Union
+
+          def self?.variants: -> ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value]
+
+          StringArray: BrandDev::Internal::Type::Converter
+
+          FloatArray: BrandDev::Internal::Type::Converter
+        end
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs

@@ -1,7 +1,7 @@
 module BrandDev
   module Models
     type brand_identify_from_transaction_params =
-      { transaction_info: String }
+      { transaction_info: String, timeout_ms: Integer }
       & BrandDev::Internal::Type::request_parameters
 
     class BrandIdentifyFromTransactionParams < BrandDev::Internal::Type::BaseModel
@@ -10,13 +10,19 @@ module BrandDev
 
       attr_accessor transaction_info: String
 
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
       def initialize: (
         transaction_info: String,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
         transaction_info: String,
+        timeout_ms: Integer,
         request_options: BrandDev::RequestOptions
       }
     end

data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs

@@ -41,7 +41,6 @@ module BrandDev
           colors: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Color],
           description: String,
           domain: String,
-          fonts: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font],
           logos: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo],
           slogan: String,
           socials: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social],
@@ -76,12 +75,6 @@ module BrandDev
 
         def domain=: (String) -> String
 
-        attr_reader fonts: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font]?
-
-        def fonts=: (
-          ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font]
-        ) -> ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font]
-
         attr_reader logos: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo]?
 
         def logos=: (
@@ -114,7 +107,6 @@ module BrandDev
           ?colors: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Color],
           ?description: String,
           ?domain: String,
-          ?fonts: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font],
           ?logos: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo],
           ?slogan: String,
           ?socials: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social],
@@ -128,7 +120,6 @@ module BrandDev
           colors: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Color],
           description: String,
           domain: String,
-          fonts: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font],
           logos: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo],
           slogan: String,
           socials: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social],
@@ -282,22 +273,6 @@ module BrandDev
           def to_hash: -> { hex: String, name: String }
         end
 
-        type font = { name: String, usage: String }
-
-        class Font < BrandDev::Internal::Type::BaseModel
-          attr_reader name: String?
-
-          def name=: (String) -> String
-
-          attr_reader usage: String?
-
-          def usage=: (String) -> String
-
-          def initialize: (?name: String, ?usage: String) -> void
-
-          def to_hash: -> { name: String, usage: String }
-        end
-
         type logo =
           {
             colors: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color],

data/sig/brand_dev/models/brand_prefetch_params.rbs

@@ -0,0 +1,30 @@
+module BrandDev
+  module Models
+    type brand_prefetch_params =
+      { domain: String, timeout_ms: Integer }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandPrefetchParams < 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_prefetch_response.rbs

@@ -0,0 +1,28 @@
+module BrandDev
+  module Models
+    type brand_prefetch_response =
+      { domain: String, message: String, status: String }
+
+    class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
+
+      attr_reader message: String?
+
+      def message=: (String) -> String
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      def initialize: (
+        ?domain: String,
+        ?message: String,
+        ?status: String
+      ) -> void
+
+      def to_hash: -> { domain: String, message: String, status: String }
+    end
+  end
+end

data/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs

@@ -1,7 +1,8 @@
 module BrandDev
   module Models
     type brand_retrieve_by_ticker_params =
-      { ticker: String } & BrandDev::Internal::Type::request_parameters
+      { ticker: String, timeout_ms: Integer }
+      & BrandDev::Internal::Type::request_parameters
 
     class BrandRetrieveByTickerParams < BrandDev::Internal::Type::BaseModel
       extend BrandDev::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,19 @@ module BrandDev
 
       attr_accessor ticker: String
 
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
       def initialize: (
         ticker: String,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
         ticker: String,
+        timeout_ms: Integer,
         request_options: BrandDev::RequestOptions
       }
     end