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

data/lib/brand_dev/internal/type/enum.rb

@@ -56,10 +56,14 @@ module BrandDev
         #
         # @param state [Hash{Symbol=>Object}] .
         #
-        #   @option state [Boolean, :strong] :strictness
+        #   @option state [Boolean] :translate_names
+        #
+        #   @option state [Boolean] :strictness
         #
         #   @option state [Hash{Symbol=>Object}] :exactness
         #
+        #   @option state [Class<StandardError>] :error
+        #
         #   @option state [Integer] :branched
         #
         # @return [Symbol, Object]
@@ -70,8 +74,12 @@ module BrandDev
           if values.include?(val)
             exactness[:yes] += 1
             val
+          elsif values.first&.class == val.class
+            exactness[:maybe] += 1
+            value
           else
-            exactness[values.first&.class == val.class ? :maybe : :no] += 1
+            exactness[:no] += 1
+            state[:error] = TypeError.new("#{value.class} can't be coerced into #{self}")
             value
           end
         end
@@ -91,11 +99,14 @@ module BrandDev
         #
         # @return [Object]
         def to_sorbet_type
-          case values
+          types = values.map { BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
+          case types
           in []
             T.noreturn
-          in [value, *_]
-            T.all(BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          in [type]
+            type
+          else
+            T.any(*types)
           end
         end
 

data/lib/brand_dev/internal/type/file_input.rb

@@ -45,10 +45,14 @@ module BrandDev
           #
           # @param state [Hash{Symbol=>Object}] .
           #
-          #   @option state [Boolean, :strong] :strictness
+          #   @option state [Boolean] :translate_names
+          #
+          #   @option state [Boolean] :strictness
           #
           #   @option state [Hash{Symbol=>Object}] :exactness
           #
+          #   @option state [Class<StandardError>] :error
+          #
           #   @option state [Integer] :branched
           #
           # @return [StringIO, Object]
@@ -62,6 +66,7 @@ module BrandDev
               exactness[:yes] += 1
               value
             else
+              state[:error] = TypeError.new("#{value.class} can't be coerced into #{StringIO}")
               exactness[:no] += 1
               value
             end

data/lib/brand_dev/internal/type/hash_of.rb

@@ -77,10 +77,14 @@ module BrandDev
         #
         # @param state [Hash{Symbol=>Object}] .
         #
-        #   @option state [Boolean, :strong] :strictness
+        #   @option state [Boolean] :translate_names
+        #
+        #   @option state [Boolean] :strictness
         #
         #   @option state [Hash{Symbol=>Object}] :exactness
         #
+        #   @option state [Class<StandardError>] :error
+        #
         #   @option state [Integer] :branched
         #
         # @return [Hash{Symbol=>Object}, Object]
@@ -89,6 +93,7 @@ module BrandDev
 
           unless value.is_a?(Hash)
             exactness[:no] += 1
+            state[:error] = TypeError.new("#{value.class} can't be coerced into #{Hash}")
             return value
           end
 

data/lib/brand_dev/internal/type/union.rb

@@ -115,14 +115,23 @@ module BrandDev
 
         # @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.
+        #
         # @param value [Object]
         #
         # @param state [Hash{Symbol=>Object}] .
         #
-        #   @option state [Boolean, :strong] :strictness
+        #   @option state [Boolean] :translate_names
+        #
+        #   @option state [Boolean] :strictness
         #
         #   @option state [Hash{Symbol=>Object}] :exactness
         #
+        #   @option state [Class<StandardError>] :error
+        #
         #   @option state [Integer] :branched
         #
         # @return [Object]
@@ -133,7 +142,6 @@ module BrandDev
 
           strictness = state.fetch(:strictness)
           exactness = state.fetch(:exactness)
-          state[:strictness] = strictness == :strong ? true : strictness
 
           alternatives = []
           known_variants.each do |_, variant_fn|
@@ -152,13 +160,10 @@ module BrandDev
             end
           end
 
-          case alternatives.sort_by(&:first)
+          case alternatives.sort_by!(&:first)
           in []
             exactness[:no] += 1
-            if strictness == :strong
-              message = "no possible conversion of #{value.class} into a variant of #{target.inspect}"
-              raise ArgumentError.new(message)
-            end
+            state[:error] = ArgumentError.new("no matching variant for #{value.inspect}")
             value
           in [[_, exact, coerced], *]
             exact.each { exactness[_1] += _2 }
@@ -195,11 +200,14 @@ module BrandDev
         #
         # @return [Object]
         def to_sorbet_type
-          case (v = variants)
+          types = variants.map { BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
+          case types
           in []
             T.noreturn
+          in [type]
+            type
           else
-            T.any(*v.map { BrandDev::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+            T.any(*types)
           end
         end
 

data/lib/brand_dev/internal/type/unknown.rb

@@ -33,14 +33,20 @@ module BrandDev
         class << self
           # @api private
           #
+          # No coercion needed for Unknown type.
+          #
           # @param value [Object]
           #
           # @param state [Hash{Symbol=>Object}] .
           #
-          #   @option state [Boolean, :strong] :strictness
+          #   @option state [Boolean] :translate_names
+          #
+          #   @option state [Boolean] :strictness
           #
           #   @option state [Hash{Symbol=>Object}] :exactness
           #
+          #   @option state [Class<StandardError>] :error
+          #
           #   @option state [Integer] :branched
           #
           # @return [Object]

data/lib/brand_dev/internal/util.rb

@@ -497,7 +497,7 @@ module BrandDev
         # @param closing [Array<Proc>]
         # @param content_type [String, nil]
         private def write_multipart_content(y, val:, closing:, content_type: nil)
-          content_type ||= "application/octet-stream"
+          content_line = "Content-Type: %s\r\n\r\n"
 
           case val
           in BrandDev::FilePart
@@ -508,24 +508,21 @@ module BrandDev
               content_type: val.content_type
             )
           in Pathname
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             io = val.open(binmode: true)
             closing << io.method(:close)
             IO.copy_stream(io, y)
           in IO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             IO.copy_stream(val, y)
           in StringIO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             y << val.string
-          in String
-            y << "Content-Type: #{content_type}\r\n\r\n"
-            y << val.to_s
           in -> { primitive?(_1) }
-            y << "Content-Type: text/plain\r\n\r\n"
+            y << format(content_line, content_type || "text/plain")
             y << val.to_s
           else
-            y << "Content-Type: application/json\r\n\r\n"
+            y << format(content_line, content_type || "application/json")
             y << JSON.generate(val)
           end
           y << "\r\n"
@@ -563,6 +560,8 @@ module BrandDev
 
         # @api private
         #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
+        #
         # @param body [Object]
         #
         # @return [Array(String, Enumerable<String>)]

data/lib/brand_dev/models/brand_ai_query_params.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#ai_query
+    class BrandAIQueryParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute data_to_extract
+      #   Array of data points to extract from the website
+      #
+      #   @return [Array<BrandDev::Models::BrandAIQueryParams::DataToExtract>]
+      required :data_to_extract,
+               -> { BrandDev::Internal::Type::ArrayOf[BrandDev::BrandAIQueryParams::DataToExtract] }
+
+      # @!attribute domain
+      #   The domain name to analyze
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute specific_pages
+      #   Optional object specifying which pages to analyze
+      #
+      #   @return [BrandDev::Models::BrandAIQueryParams::SpecificPages, nil]
+      optional :specific_pages, -> { BrandDev::BrandAIQueryParams::SpecificPages }
+
+      # @!attribute timeout_ms
+      #   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).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer, api_name: :timeoutMS
+
+      # @!method initialize(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandAIQueryParams} for more details.
+      #
+      #   @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}]
+
+      class DataToExtract < BrandDev::Internal::Type::BaseModel
+        # @!attribute datapoint_description
+        #   Description of what to extract
+        #
+        #   @return [String]
+        required :datapoint_description, String
+
+        # @!attribute datapoint_example
+        #   Example of the expected value
+        #
+        #   @return [String]
+        required :datapoint_example, String
+
+        # @!attribute datapoint_name
+        #   Name of the data point to extract
+        #
+        #   @return [String]
+        required :datapoint_name, String
+
+        # @!attribute datapoint_type
+        #   Type of the data point
+        #
+        #   @return [Symbol, BrandDev::Models::BrandAIQueryParams::DataToExtract::DatapointType]
+        required :datapoint_type, enum: -> { BrandDev::BrandAIQueryParams::DataToExtract::DatapointType }
+
+        # @!method initialize(datapoint_description:, datapoint_example:, datapoint_name:, datapoint_type:)
+        #   @param datapoint_description [String] Description of what to extract
+        #
+        #   @param datapoint_example [String] Example of the expected value
+        #
+        #   @param datapoint_name [String] Name of the data point to extract
+        #
+        #   @param datapoint_type [Symbol, BrandDev::Models::BrandAIQueryParams::DataToExtract::DatapointType] Type of the data point
+
+        # Type of the data point
+        #
+        # @see BrandDev::Models::BrandAIQueryParams::DataToExtract#datapoint_type
+        module DatapointType
+          extend BrandDev::Internal::Type::Enum
+
+          TEXT = :text
+          NUMBER = :number
+          DATE = :date
+          BOOLEAN = :boolean
+          LIST = :list
+          URL = :url
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class SpecificPages < BrandDev::Internal::Type::BaseModel
+        # @!attribute about_us
+        #   Whether to analyze the about us page
+        #
+        #   @return [Boolean, nil]
+        optional :about_us, BrandDev::Internal::Type::Boolean
+
+        # @!attribute blog
+        #   Whether to analyze the blog
+        #
+        #   @return [Boolean, nil]
+        optional :blog, BrandDev::Internal::Type::Boolean
+
+        # @!attribute careers
+        #   Whether to analyze the careers page
+        #
+        #   @return [Boolean, nil]
+        optional :careers, BrandDev::Internal::Type::Boolean
+
+        # @!attribute contact_us
+        #   Whether to analyze the contact us page
+        #
+        #   @return [Boolean, nil]
+        optional :contact_us, BrandDev::Internal::Type::Boolean
+
+        # @!attribute faq
+        #   Whether to analyze the FAQ page
+        #
+        #   @return [Boolean, nil]
+        optional :faq, BrandDev::Internal::Type::Boolean
+
+        # @!attribute home_page
+        #   Whether to analyze the home page
+        #
+        #   @return [Boolean, nil]
+        optional :home_page, BrandDev::Internal::Type::Boolean
+
+        # @!attribute privacy_policy
+        #   Whether to analyze the privacy policy page
+        #
+        #   @return [Boolean, nil]
+        optional :privacy_policy, BrandDev::Internal::Type::Boolean
+
+        # @!attribute terms_and_conditions
+        #   Whether to analyze the terms and conditions page
+        #
+        #   @return [Boolean, nil]
+        optional :terms_and_conditions, BrandDev::Internal::Type::Boolean
+
+        # @!method initialize(about_us: nil, blog: nil, careers: nil, contact_us: nil, faq: nil, home_page: nil, privacy_policy: nil, terms_and_conditions: nil)
+        #   Optional object specifying which pages to analyze
+        #
+        #   @param about_us [Boolean] Whether to analyze the about us page
+        #
+        #   @param blog [Boolean] Whether to analyze the blog
+        #
+        #   @param careers [Boolean] Whether to analyze the careers page
+        #
+        #   @param contact_us [Boolean] Whether to analyze the contact us page
+        #
+        #   @param faq [Boolean] Whether to analyze the FAQ page
+        #
+        #   @param home_page [Boolean] Whether to analyze the home page
+        #
+        #   @param privacy_policy [Boolean] Whether to analyze the privacy policy page
+        #
+        #   @param terms_and_conditions [Boolean] Whether to analyze the terms and conditions page
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_ai_query_response.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#ai_query
+    class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute data_extracted
+      #   Array of extracted data points
+      #
+      #   @return [Array<BrandDev::Models::BrandAIQueryResponse::DataExtracted>, nil]
+      optional :data_extracted,
+               -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandAIQueryResponse::DataExtracted] }
+
+      # @!attribute domain
+      #   The domain that was analyzed
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute urls_analyzed
+      #   List of URLs that were analyzed
+      #
+      #   @return [Array<String>, nil]
+      optional :urls_analyzed, BrandDev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(data_extracted: nil, domain: nil, urls_analyzed: nil)
+      #   @param data_extracted [Array<BrandDev::Models::BrandAIQueryResponse::DataExtracted>] Array of extracted data points
+      #
+      #   @param domain [String] The domain that was analyzed
+      #
+      #   @param urls_analyzed [Array<String>] List of URLs that were analyzed
+
+      class DataExtracted < BrandDev::Internal::Type::BaseModel
+        # @!attribute datapoint_name
+        #   Name of the extracted data point
+        #
+        #   @return [String, nil]
+        optional :datapoint_name, String
+
+        # @!attribute datapoint_value
+        #   Value of the extracted data point
+        #
+        #   @return [String, Float, Boolean, Array<String>, Array<Float>, nil]
+        optional :datapoint_value,
+                 union: -> { BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue }
+
+        # @!method initialize(datapoint_name: nil, datapoint_value: nil)
+        #   @param datapoint_name [String] Name of the extracted data point
+        #
+        #   @param datapoint_value [String, Float, Boolean, Array<String>, Array<Float>] Value of the extracted data point
+
+        # Value of the extracted data point
+        #
+        # @see BrandDev::Models::BrandAIQueryResponse::DataExtracted#datapoint_value
+        module DatapointValue
+          extend BrandDev::Internal::Type::Union
+
+          variant String
+
+          variant Float
+
+          variant BrandDev::Internal::Type::Boolean
+
+          variant -> { BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::StringArray }
+
+          variant -> { BrandDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::FloatArray }
+
+          # @!method self.variants
+          #   @return [Array(String, Float, Boolean, Array<String>, Array<Float>)]
+
+          # @type [BrandDev::Internal::Type::Converter]
+          StringArray = BrandDev::Internal::Type::ArrayOf[String]
+
+          # @type [BrandDev::Internal::Type::Converter]
+          FloatArray = BrandDev::Internal::Type::ArrayOf[Float]
+        end
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_identify_from_transaction_params.rb

@@ -13,9 +13,22 @@ module BrandDev
       #   @return [String]
       required :transaction_info, String
 
-      # @!method initialize(transaction_info:, request_options: {})
+      # @!attribute timeout_ms
+      #   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).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer
+
+      # @!method initialize(transaction_info:, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandIdentifyFromTransactionParams} for more details.
+      #
       #   @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}]
     end
   end

data/lib/brand_dev/models/brand_identify_from_transaction_response.rb

@@ -63,13 +63,6 @@ module BrandDev
         #   @return [String, nil]
         optional :domain, String
 
-        # @!attribute fonts
-        #   An array of fonts used by the brand's website
-        #
-        #   @return [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font>, nil]
-        optional :fonts,
-                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font] }
-
         # @!attribute logos
         #   An array of logos associated with the brand
         #
@@ -103,7 +96,7 @@ module BrandDev
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
+        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
         #   Some parameter documentations has been truncated, see
         #   {BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand} for more
         #   details.
@@ -120,8 +113,6 @@ module BrandDev
         #
         #   @param domain [String] The domain name of the brand
         #
-        #   @param fonts [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font>] An array of fonts used by the brand's website
-        #
         #   @param logos [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo>] An array of logos associated with the brand
         #
         #   @param slogan [String] The brand's slogan
@@ -283,25 +274,6 @@ module BrandDev
           #   @param name [String] Name of the color
         end
 
-        class Font < BrandDev::Internal::Type::BaseModel
-          # @!attribute name
-          #   Name of the font
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute usage
-          #   Usage of the font, e.g., 'title', 'body', 'button'
-          #
-          #   @return [String, nil]
-          optional :usage, String
-
-          # @!method initialize(name: nil, usage: nil)
-          #   @param name [String] Name of the font
-          #
-          #   @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
-        end
-
         class Logo < BrandDev::Internal::Type::BaseModel
           # @!attribute colors
           #   Array of colors in the logo

data/lib/brand_dev/models/brand_prefetch_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#prefetch
+    class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to prefetch brand data for
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute timeout_ms
+      #   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).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer, api_name: :timeoutMS
+
+      # @!method initialize(domain:, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandPrefetchParams} for more details.
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_prefetch_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#prefetch
+    class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute domain
+      #   The domain that was queued for prefetching
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute message
+      #   Success message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(domain: nil, message: nil, status: nil)
+      #   @param domain [String] The domain that was queued for prefetching
+      #
+      #   @param message [String] Success message
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+    end
+  end
+end

data/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb

@@ -13,9 +13,22 @@ module BrandDev
       #   @return [String]
       required :ticker, String
 
-      # @!method initialize(ticker:, request_options: {})
+      # @!attribute timeout_ms
+      #   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).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer
+
+      # @!method initialize(ticker:, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandRetrieveByTickerParams} for more details.
+      #
       #   @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}]
     end
   end