brand.dev 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9985ae9ba5e62a158a02c8cd2b290bab9811c3ebc6f3061c2f1d90cbf2d0dbe
-  data.tar.gz: cf66b53c0110ff560bb84484e6113990f4f078aa740ca1a8e653cd32334c6f06
+  metadata.gz: 5b4785c6a5194cf7d3a6a7da3a3e39a22d115838178cc06abbaef4ccd772b76f
+  data.tar.gz: 2f1de5954cd94b141efb40db439bbc41976e686868c1fcb0f53dd2c882e6d481
 SHA512:
-  metadata.gz: d1cdf4ea4e6b14cdf0bd77d0eb0d2a9d75edee737d10d0464f30df495b35e6eb811e55ca8cb1f379c6dd2f109d8052541e7671d0efbcf5cb57f66ca6d53cbfe0
-  data.tar.gz: 23b905b672117b2d6ade382f7f0291d800072c1de2967b21f0bde3cad888e5317d87cf42e688697db88d31264c0f70d1eadcee46941c943e4ea171173adf5d39
+  metadata.gz: 90e4b94324308dbb27808e0cb1e497b6a025d5d828f9c4e51f9e356dbc775732a081c942007423cc11b8f2a98bf5f3e691c353017fe640214033633ba3b4a3e5
+  data.tar.gz: b3b8049f2c366e2d41dd865bcf4d96df7c26b46407df10fb302803f5e7f23990e9e972b350dcfe351a4b82e475e81a5e1f5c6a41ea549562ca4e75a4e471bfca

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 0.1.0-alpha.3 (2025-06-06)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Features
+
+* **api:** manual updates ([7410667](https://github.com/brand-dot-dev/ruby-sdk/commit/7410667d18ceacfb171c91eb14a4825f77e3487b))
+
+
+### Chores
+
+* **internal:** codegen related update ([08a0fc4](https://github.com/brand-dot-dev/ruby-sdk/commit/08a0fc45756634925a18266d526b41a217b37492))
+
+## 0.1.0-alpha.2 (2025-06-05)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* **api:** manual updates ([6613bcd](https://github.com/brand-dot-dev/ruby-sdk/commit/6613bcdddf846a0dbcb1e507da7ec58c93e4125d))
+
+
+### Bug Fixes
+
+* `to_sorbet_type` should not return branded types ([0047f7c](https://github.com/brand-dot-dev/ruby-sdk/commit/0047f7ce754514e6c5ac04546aa262d1e4df68f5))
+* default content-type for text in multi-part formdata uploads should be text/plain ([c39a8a7](https://github.com/brand-dot-dev/ruby-sdk/commit/c39a8a78f5445fa88de3b9f765d6211889ba78ef))
+
 ## 0.1.0-alpha.1 (2025-06-02)
 
 Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "brand.dev", "~> 0.1.0.pre.alpha.1"
+gem "brand.dev", "~> 0.1.0.pre.alpha.3"
 ```
 
 <!-- x-release-please-end -->

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

@@ -91,11 +91,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/union.rb

@@ -195,11 +195,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/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

@@ -21,17 +21,17 @@ module BrandDev
       required :domain, String
 
       # @!attribute specific_pages
-      #   Optional array of specific pages to analyze
+      #   Optional object specifying which pages to analyze
       #
-      #   @return [Array<String>, nil]
-      optional :specific_pages, BrandDev::Internal::Type::ArrayOf[String]
+      #   @return [BrandDev::Models::BrandAIQueryParams::SpecificPages, nil]
+      optional :specific_pages, -> { BrandDev::BrandAIQueryParams::SpecificPages }
 
       # @!method initialize(data_to_extract:, domain:, specific_pages: 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 [Array<String>] Optional array of specific pages to analyze
+      #   @param specific_pages [BrandDev::Models::BrandAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
       #
       #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -86,6 +86,75 @@ module BrandDev
           #   @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_prefetch_params.rb

@@ -0,0 +1,22 @@
+# 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
+
+      # @!method initialize(domain:, request_options: {})
+      #   @param domain [String] Domain name to prefetch brand data for
+      #
+      #   @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.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
@@ -43,6 +43,8 @@ module BrandDev
 
   BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

data/lib/brand_dev/resources/brand.rb

@@ -37,7 +37,7 @@ module BrandDev
       #
       # @param domain [String] The domain name to analyze
       #
-      # @param specific_pages [Array<String>] Optional array of specific pages to analyze
+      # @param specific_pages [BrandDev::Models::BrandAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
       #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -78,6 +78,31 @@ module BrandDev
         )
       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]
+      #
+      # @overload prefetch(domain:, request_options: {})
+      #
+      # @param domain [String] Domain name to prefetch brand data for
+      #
+      # @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
+
       # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
       #
       # @overload retrieve_by_ticker(ticker:, request_options: {})

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.1.0.pre.alpha.1"
+  VERSION = "0.1.0.pre.alpha.3"
 end

data/lib/brand_dev.rb

@@ -54,6 +54,8 @@ 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"

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

data/rbi/brand_dev/models/brand_ai_query_params.rbi

@@ -19,11 +19,15 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :domain
 
-      # Optional array of specific pages to analyze
-      sig { returns(T.nilable(T::Array[String])) }
+      # Optional object specifying which pages to analyze
+      sig { returns(T.nilable(BrandDev::BrandAIQueryParams::SpecificPages)) }
       attr_reader :specific_pages
 
-      sig { params(specific_pages: T::Array[String]).void }
+      sig do
+        params(
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash
+        ).void
+      end
       attr_writer :specific_pages
 
       sig do
@@ -31,7 +35,7 @@ module BrandDev
           data_to_extract:
             T::Array[BrandDev::BrandAIQueryParams::DataToExtract::OrHash],
           domain: String,
-          specific_pages: T::Array[String],
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -40,7 +44,7 @@ module BrandDev
         data_to_extract:,
         # The domain name to analyze
         domain:,
-        # Optional array of specific pages to analyze
+        # Optional object specifying which pages to analyze
         specific_pages: nil,
         request_options: {}
       )
@@ -52,7 +56,7 @@ module BrandDev
             data_to_extract:
               T::Array[BrandDev::BrandAIQueryParams::DataToExtract],
             domain: String,
-            specific_pages: T::Array[String],
+            specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
             request_options: BrandDev::RequestOptions
           }
         )
@@ -179,6 +183,122 @@ module BrandDev
           end
         end
       end
+
+      class SpecificPages < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::BrandAIQueryParams::SpecificPages,
+              BrandDev::Internal::AnyHash
+            )
+          end
+
+        # Whether to analyze the about us page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :about_us
+
+        sig { params(about_us: T::Boolean).void }
+        attr_writer :about_us
+
+        # Whether to analyze the blog
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :blog
+
+        sig { params(blog: T::Boolean).void }
+        attr_writer :blog
+
+        # Whether to analyze the careers page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :careers
+
+        sig { params(careers: T::Boolean).void }
+        attr_writer :careers
+
+        # Whether to analyze the contact us page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :contact_us
+
+        sig { params(contact_us: T::Boolean).void }
+        attr_writer :contact_us
+
+        # Whether to analyze the FAQ page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :faq
+
+        sig { params(faq: T::Boolean).void }
+        attr_writer :faq
+
+        # Whether to analyze the home page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :home_page
+
+        sig { params(home_page: T::Boolean).void }
+        attr_writer :home_page
+
+        # Whether to analyze the privacy policy page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :privacy_policy
+
+        sig { params(privacy_policy: T::Boolean).void }
+        attr_writer :privacy_policy
+
+        # Whether to analyze the terms and conditions page
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :terms_and_conditions
+
+        sig { params(terms_and_conditions: T::Boolean).void }
+        attr_writer :terms_and_conditions
+
+        # Optional object specifying which pages to analyze
+        sig do
+          params(
+            about_us: T::Boolean,
+            blog: T::Boolean,
+            careers: T::Boolean,
+            contact_us: T::Boolean,
+            faq: T::Boolean,
+            home_page: T::Boolean,
+            privacy_policy: T::Boolean,
+            terms_and_conditions: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether to analyze the about us page
+          about_us: nil,
+          # Whether to analyze the blog
+          blog: nil,
+          # Whether to analyze the careers page
+          careers: nil,
+          # Whether to analyze the contact us page
+          contact_us: nil,
+          # Whether to analyze the FAQ page
+          faq: nil,
+          # Whether to analyze the home page
+          home_page: nil,
+          # Whether to analyze the privacy policy page
+          privacy_policy: nil,
+          # Whether to analyze the terms and conditions page
+          terms_and_conditions: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              about_us: T::Boolean,
+              blog: T::Boolean,
+              careers: T::Boolean,
+              contact_us: T::Boolean,
+              faq: T::Boolean,
+              home_page: T::Boolean,
+              privacy_policy: T::Boolean,
+              terms_and_conditions: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/brand_dev/models/brand_prefetch_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandPrefetchParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Domain name to prefetch brand data for
+      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 prefetch brand data for
+        domain:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { domain: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_prefetch_response.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandPrefetchResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # The domain that was queued for prefetching
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # Success message
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      # Status of the response, e.g., 'ok'
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      sig do
+        params(domain: String, message: String, status: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # The domain that was queued for prefetching
+        domain: nil,
+        # Success message
+        message: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil
+      )
+      end
+
+      sig do
+        override.returns({ domain: String, message: String, status: String })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models.rbi

@@ -6,6 +6,8 @@ module BrandDev
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

data/rbi/brand_dev/resources/brand.rbi

@@ -29,7 +29,7 @@ module BrandDev
           data_to_extract:
             T::Array[BrandDev::BrandAIQueryParams::DataToExtract::OrHash],
           domain: String,
-          specific_pages: T::Array[String],
+          specific_pages: BrandDev::BrandAIQueryParams::SpecificPages::OrHash,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandAIQueryResponse)
       end
@@ -38,7 +38,7 @@ module BrandDev
         data_to_extract:,
         # The domain name to analyze
         domain:,
-        # Optional array of specific pages to analyze
+        # Optional object specifying which pages to analyze
         specific_pages: nil,
         request_options: {}
       )
@@ -59,6 +59,23 @@ module BrandDev
       )
       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,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandPrefetchResponse)
+      end
+      def prefetch(
+        # Domain name to prefetch brand data for
+        domain:,
+        request_options: {}
+      )
+      end
+
       # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
       sig do
         params(

data/sig/brand_dev/models/brand_ai_query_params.rbs

@@ -4,7 +4,7 @@ module BrandDev
       {
         data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
         domain: String,
-        specific_pages: ::Array[String]
+        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages
       }
       & BrandDev::Internal::Type::request_parameters
 
@@ -16,21 +16,23 @@ module BrandDev
 
       attr_accessor domain: String
 
-      attr_reader specific_pages: ::Array[String]?
+      attr_reader specific_pages: BrandDev::BrandAIQueryParams::SpecificPages?
 
-      def specific_pages=: (::Array[String]) -> ::Array[String]
+      def specific_pages=: (
+        BrandDev::BrandAIQueryParams::SpecificPages
+      ) -> BrandDev::BrandAIQueryParams::SpecificPages
 
       def initialize: (
         data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
         domain: String,
-        ?specific_pages: ::Array[String],
+        ?specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
         data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
         domain: String,
-        specific_pages: ::Array[String],
+        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
         request_options: BrandDev::RequestOptions
       }
 
@@ -80,6 +82,74 @@ module BrandDev
           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_prefetch_params.rbs

@@ -0,0 +1,23 @@
+module BrandDev
+  module Models
+    type brand_prefetch_params =
+      { domain: String } & 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
+
+      def initialize: (
+        domain: String,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        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.rbs

@@ -3,6 +3,8 @@ module BrandDev
 
   class BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  class BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   class BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   class BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

data/sig/brand_dev/resources/brand.rbs

@@ -10,7 +10,7 @@ module BrandDev
       def ai_query: (
         data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
         domain: String,
-        ?specific_pages: ::Array[String],
+        ?specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandAIQueryResponse
 
@@ -19,6 +19,11 @@ module BrandDev
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandIdentifyFromTransactionResponse
 
+      def prefetch: (
+        domain: String,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::BrandPrefetchResponse
+
       def retrieve_by_ticker: (
         ticker: String,
         ?request_options: BrandDev::request_opts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.1
+  version: 0.1.0.pre.alpha.3
 platform: ruby
 authors:
 - Brand Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-02 00:00:00.000000000 Z
+date: 2025-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -58,6 +58,8 @@ files:
 - lib/brand_dev/models/brand_ai_query_response.rb
 - lib/brand_dev/models/brand_identify_from_transaction_params.rb
 - lib/brand_dev/models/brand_identify_from_transaction_response.rb
+- lib/brand_dev/models/brand_prefetch_params.rb
+- lib/brand_dev/models/brand_prefetch_response.rb
 - lib/brand_dev/models/brand_retrieve_by_ticker_params.rb
 - lib/brand_dev/models/brand_retrieve_by_ticker_response.rb
 - lib/brand_dev/models/brand_retrieve_naics_params.rb
@@ -93,6 +95,8 @@ files:
 - rbi/brand_dev/models/brand_ai_query_response.rbi
 - rbi/brand_dev/models/brand_identify_from_transaction_params.rbi
 - rbi/brand_dev/models/brand_identify_from_transaction_response.rbi
+- rbi/brand_dev/models/brand_prefetch_params.rbi
+- rbi/brand_dev/models/brand_prefetch_response.rbi
 - rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi
 - rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi
 - rbi/brand_dev/models/brand_retrieve_naics_params.rbi
@@ -127,6 +131,8 @@ files:
 - sig/brand_dev/models/brand_ai_query_response.rbs
 - sig/brand_dev/models/brand_identify_from_transaction_params.rbs
 - sig/brand_dev/models/brand_identify_from_transaction_response.rbs
+- sig/brand_dev/models/brand_prefetch_params.rbs
+- sig/brand_dev/models/brand_prefetch_response.rbs
 - sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs
 - sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs
 - sig/brand_dev/models/brand_retrieve_naics_params.rbs