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

data/lib/brand_dev/models.rb

@@ -11,16 +11,16 @@ module BrandDev
       mod.constants.each do |name|
         case mod.const_get(name)
         in true | false
-          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
           mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
         in Integer
-          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
           mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
         in Float
-          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
           mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
         in Symbol
-          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
           mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
         else
         end
@@ -39,13 +39,21 @@ module BrandDev
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  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/lib/brand_dev/resources/brand.rb

@@ -3,14 +3,21 @@
 module BrandDev
   module Resources
     class Brand
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandRetrieveParams} for more details.
+      #
       # Retrieve brand data by domain
       #
-      # @overload retrieve(domain:, force_language: nil, request_options: {})
+      # @overload retrieve(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #
       # @param domain [String] Domain name to retrieve brand data for
       #
       # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
       #
+      # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandRetrieveResponse]
@@ -21,19 +28,57 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/retrieve",
-          query: parsed,
+          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandAIQueryParams} for more details.
+      #
+      # 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.
+      #
+      # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {})
+      #
+      # @param data_to_extract [Array<BrandDev::Models::BrandAIQueryParams::DataToExtract>] Array of data points to extract from the website
+      #
+      # @param domain [String] The domain name to analyze
+      #
+      # @param specific_pages [BrandDev::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 [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandAIQueryResponse]
+      #
+      # @see BrandDev::Models::BrandAIQueryParams
+      def ai_query(params)
+        parsed, options = BrandDev::BrandAIQueryParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/ai/query",
+          body: parsed,
+          model: BrandDev::Models::BrandAIQueryResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandIdentifyFromTransactionParams} for more details.
+      #
       # Endpoint specially designed for platforms that want to identify transaction data
       # by the transaction title.
       #
-      # @overload identify_from_transaction(transaction_info:, request_options: {})
+      # @overload identify_from_transaction(transaction_info:, timeout_ms: nil, request_options: {})
       #
       # @param transaction_info [String] Transaction information to identify the brand
       #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandIdentifyFromTransactionResponse]
@@ -44,18 +89,53 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/transaction_identifier",
-          query: parsed,
+          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandIdentifyFromTransactionResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::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 [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandPrefetchResponse]
+      #
+      # @see BrandDev::Models::BrandPrefetchParams
+      def prefetch(params)
+        parsed, options = BrandDev::BrandPrefetchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/prefetch",
+          body: parsed,
+          model: BrandDev::Models::BrandPrefetchResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandRetrieveByTickerParams} for more details.
+      #
       # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
       #
-      # @overload retrieve_by_ticker(ticker:, request_options: {})
+      # @overload retrieve_by_ticker(ticker:, timeout_ms: nil, request_options: {})
       #
       # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
       #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandRetrieveByTickerResponse]
@@ -66,7 +146,7 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/retrieve-by-ticker",
-          query: parsed,
+          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveByTickerResponse,
           options: options
         )
@@ -77,10 +157,12 @@ module BrandDev
       #
       # Endpoint to classify any brand into a 2022 NAICS code.
       #
-      # @overload retrieve_naics(input:, request_options: {})
+      # @overload retrieve_naics(input:, timeout_ms: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
       #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandRetrieveNaicsResponse]
@@ -91,30 +173,95 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/naics",
-          query: parsed,
+          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveNaicsResponse,
           options: options
         )
       end
 
-      # Search brands by query
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandRetrieveSimplifiedParams} for more details.
+      #
+      # 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.
+      #
+      # @overload retrieve_simplified(domain:, timeout_ms: nil, request_options: {})
+      #
+      # @param domain [String] Domain name to retrieve simplified brand data for
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandRetrieveSimplifiedResponse]
+      #
+      # @see BrandDev::Models::BrandRetrieveSimplifiedParams
+      def retrieve_simplified(params)
+        parsed, options = BrandDev::BrandRetrieveSimplifiedParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/retrieve-simplified",
+          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
+          model: BrandDev::Models::BrandRetrieveSimplifiedResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandScreenshotParams} for more details.
+      #
+      # 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.
+      #
+      # @overload screenshot(domain:, full_screenshot: nil, request_options: {})
+      #
+      # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai
+      #
+      # @param full_screenshot [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandScreenshotResponse]
+      #
+      # @see BrandDev::Models::BrandScreenshotParams
+      def screenshot(params)
+        parsed, options = BrandDev::BrandScreenshotParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/screenshot",
+          query: parsed.transform_keys(full_screenshot: "fullScreenshot"),
+          model: BrandDev::Models::BrandScreenshotResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandStyleguideParams} for more details.
+      #
+      # Beta feature: Automatically extract comprehensive design system information from
+      # a brand's website including colors, typography, spacing, shadows, and UI
+      # components.
+      #
+      # @overload styleguide(domain:, timeout_ms: nil, request_options: {})
       #
-      # @overload search(query:, request_options: {})
+      # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #
-      # @param query [String] Query string to search brands
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<BrandDev::Models::BrandSearchResponseItem>]
+      # @return [BrandDev::Models::BrandStyleguideResponse]
       #
-      # @see BrandDev::Models::BrandSearchParams
-      def search(params)
-        parsed, options = BrandDev::BrandSearchParams.dump_request(params)
+      # @see BrandDev::Models::BrandStyleguideParams
+      def styleguide(params)
+        parsed, options = BrandDev::BrandStyleguideParams.dump_request(params)
         @client.request(
           method: :get,
-          path: "brand/search",
-          query: parsed,
-          model: BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandSearchResponseItem],
+          path: "brand/styleguide",
+          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
+          model: BrandDev::Models::BrandStyleguideResponse,
           options: options
         )
       end

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.0.1.pre.alpha.0"
+  VERSION = "0.0.2"
 end

data/lib/brand_dev.rb

@@ -50,15 +50,23 @@ require_relative "brand_dev/errors"
 require_relative "brand_dev/internal/transport/base_client"
 require_relative "brand_dev/internal/transport/pooled_net_requester"
 require_relative "brand_dev/client"
+require_relative "brand_dev/models/brand_ai_query_params"
+require_relative "brand_dev/models/brand_ai_query_response"
 require_relative "brand_dev/models/brand_identify_from_transaction_params"
 require_relative "brand_dev/models/brand_identify_from_transaction_response"
+require_relative "brand_dev/models/brand_prefetch_params"
+require_relative "brand_dev/models/brand_prefetch_response"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_params"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_response"
 require_relative "brand_dev/models/brand_retrieve_naics_params"
 require_relative "brand_dev/models/brand_retrieve_naics_response"
 require_relative "brand_dev/models/brand_retrieve_params"
 require_relative "brand_dev/models/brand_retrieve_response"
-require_relative "brand_dev/models/brand_search_params"
-require_relative "brand_dev/models/brand_search_response"
+require_relative "brand_dev/models/brand_retrieve_simplified_params"
+require_relative "brand_dev/models/brand_retrieve_simplified_response"
+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"
 require_relative "brand_dev/resources/brand"

data/rbi/brand_dev/errors.rbi

@@ -8,6 +8,22 @@ module BrandDev
     end
 
     class ConversionError < BrandDev::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
     end
 
     class APIError < BrandDev::Errors::Error

data/rbi/brand_dev/internal/type/boolean.rbi

@@ -22,6 +22,8 @@ module BrandDev
 
         class << self
           # @api private
+          #
+          # Coerce value to Boolean if possible, otherwise return the original value.
           sig do
             override
               .params(

data/rbi/brand_dev/internal/type/converter.rbi

@@ -15,12 +15,14 @@ module BrandDev
         CoerceState =
           T.type_alias do
             {
-              strictness: T.any(T::Boolean, Symbol),
+              translate_names: T::Boolean,
+              strictness: T::Boolean,
               exactness: {
                 yes: Integer,
                 no: Integer,
                 maybe: Integer
               },
+              error: T::Class[StandardError],
               branched: Integer
             }
           end
@@ -88,6 +90,15 @@ module BrandDev
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(translate_names: T::Boolean).returns(
+              BrandDev::Internal::Type::Converter::CoerceState
+            )
+          end
+          def self.new_coerce_state(translate_names: true)
+          end
+
           # @api private
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
@@ -109,14 +120,11 @@ module BrandDev
           def self.coerce(
             target,
             value,
-            # The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-            # coercion strategy when we have to decide between multiple possible conversion
-            # targets:
+            # The `strictness` is one of `true`, `false`. This informs the coercion strategy
+            # when we have to decide between multiple possible conversion targets:
             #
             # - `true`: the conversion must be exact, with minimum coercion.
             # - `false`: the conversion can be approximate, with some coercion.
-            # - `:strong`: the conversion must be exact, with no coercion, and raise an error
-            #   if not possible.
             #
             # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
             # any given conversion attempt, the exactness will be updated based on how closely
@@ -128,15 +136,7 @@ module BrandDev
             # - `no`: the value cannot be converted to the target type.
             #
             # See implementation below for more details.
-            state: {
-              strictness: true,
-              exactness: {
-                yes: 0,
-                no: 0,
-                maybe: 0
-              },
-              branched: 0
-            }
+            state: BrandDev::Internal::Type::Converter.new_coerce_state
           )
           end
 

data/rbi/brand_dev/internal/type/union.rbi

@@ -78,6 +78,11 @@ module BrandDev
         end
 
         # @api private
+        #
+        # Tries to efficiently coerce the given value to one of the known variants.
+        #
+        # If the value cannot match any of the known variants, the coercion is considered
+        # non-viable and returns the original value.
         sig do
           override
             .params(

data/rbi/brand_dev/internal/type/unknown.rbi

@@ -22,6 +22,8 @@ module BrandDev
 
         class << self
           # @api private
+          #
+          # No coercion needed for Unknown type.
           sig do
             override
               .params(

data/rbi/brand_dev/internal/util.rbi

@@ -332,6 +332,8 @@ module BrandDev
         end
 
         # @api private
+        #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
         sig do
           params(body: T.anything).returns([String, T::Enumerable[String]])
         end