brand.dev 0.1.0.pre.alpha.4 → 0.1.0.pre.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7838f8c194543e8e3ba05ae68343cc13ea4aed8ceabcb0502530061da5a41ac
-  data.tar.gz: 9036c6faf4fee43e86625466038184bd93b1c3118ccfcdc132b2d00dabf30fe3
+  metadata.gz: 0ff1c1363e8b548d944f7b819d56f08f63583655abcfe8e050e24f4d2ee03dfb
+  data.tar.gz: 3cc411e59f0cda02a786942b934b07aa66e4af07884afa849042bdc07c7e17c5
 SHA512:
-  metadata.gz: c7b864fff0ccfb6e158d491159cbed2efbb9e497245f5c35779b010ddfa74e43538a228cd7041623da7d806c19a1288ddeea4db6983a3b4a7caf9776e4642613
-  data.tar.gz: 1e7fc08296c8f69cc226b9f84337a48fc90043f1943057f4892841a412200c7a17bb827cd4a34db3b8a983ad4464ea7d877e4213eae8cefb9338b2452e015f15
+  metadata.gz: 813bd1adf601daf718337c4a4f5e764b8af9630c6ee8351e28b5aa55965c1d4f4b284105a041687e1fac2b0fe91903da7db8d32359fff82a9db6a5e6c9c854a5
+  data.tar.gz: bbf2e2fd8da681b98115655ae937de097f6c864114ebdcbe56cf88b3e1ecd19fd724e19bc17febe79da9aaf049307f85a6446eadc5a25ebf32da3bc7c3dac84e

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.1.0-alpha.6 (2025-06-08)
+
+Full Changelog: [v0.1.0-alpha.5...v0.1.0-alpha.6](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.5...v0.1.0-alpha.6)
+
+### Features
+
+* **api:** manual updates ([aa20a00](https://github.com/brand-dot-dev/ruby-sdk/commit/aa20a0054ed6afaea030f1391f50b94b9e019b17))
+
+
+### Chores
+
+* **internal:** version bump ([223cabb](https://github.com/brand-dot-dev/ruby-sdk/commit/223cabb690bebf1e41c54c6cc1c3367b81d9bb98))
+
+## 0.1.0-alpha.5 (2025-06-06)
+
+Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)
+
+### Features
+
+* **api:** manual updates ([d07e957](https://github.com/brand-dot-dev/ruby-sdk/commit/d07e957a8e10c10626468008285953a205b6dafc))
+
+
+### Chores
+
+* **internal:** version bump ([6b3a243](https://github.com/brand-dot-dev/ruby-sdk/commit/6b3a2437ab0592fee82bc4829e048937f54d9e18))
+
 ## 0.1.0-alpha.4 (2025-06-06)
 
 Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)

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.4"
+gem "brand.dev", "~> 0.1.0.pre.alpha.6"
 ```
 
 <!-- x-release-please-end -->

data/lib/brand_dev/models/brand_ai_query_params.rb

@@ -26,13 +26,26 @@ module BrandDev
       #   @return [BrandDev::Models::BrandAIQueryParams::SpecificPages, nil]
       optional :specific_pages, -> { BrandDev::BrandAIQueryParams::SpecificPages }
 
-      # @!method initialize(data_to_extract:, domain:, specific_pages: nil, 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, 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

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_prefetch_params.rb

@@ -13,9 +13,22 @@ module BrandDev
       #   @return [String]
       required :domain, String
 
-      # @!method initialize(domain:, 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, 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

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

data/lib/brand_dev/models/brand_retrieve_naics_params.rb

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

data/lib/brand_dev/models/brand_retrieve_params.rb

@@ -21,13 +21,21 @@ module BrandDev
 
       # @!attribute max_speed
       #   Optional parameter to optimize the API call for maximum speed. When set to true,
-      #   the API will skip social media data extraction and external service calls (like
-      #   Crunchbase) to return results faster with basic brand information only.
+      #   the API will skip time-consuming operations for faster response at the cost of
+      #   less comprehensive data.
       #
       #   @return [Boolean, nil]
       optional :max_speed, BrandDev::Internal::Type::Boolean
 
-      # @!method initialize(domain:, force_language: nil, max_speed: nil, 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(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandRetrieveParams} for more details.
       #
@@ -37,6 +45,8 @@ module BrandDev
       #
       #   @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}]
 
       # Optional parameter to force the language of the retrieved brand data

data/lib/brand_dev/models/brand_search_params.rb

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

data/lib/brand_dev/resources/brand.rb

@@ -8,7 +8,7 @@ module BrandDev
       #
       # Retrieve brand data by domain
       #
-      # @overload retrieve(domain:, force_language: nil, max_speed: 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
       #
@@ -16,6 +16,8 @@ module BrandDev
       #
       # @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]
@@ -26,17 +28,20 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/retrieve",
-          query: parsed.transform_keys(max_speed: "maxSpeed"),
+          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, request_options: {})
+      # @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
       #
@@ -44,6 +49,8 @@ module BrandDev
       #
       # @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]
@@ -60,13 +67,18 @@ module BrandDev
         )
       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]
@@ -77,21 +89,26 @@ 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:, request_options: {})
+      # @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]
@@ -108,12 +125,17 @@ module BrandDev
         )
       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]
@@ -124,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
         )
@@ -135,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]
@@ -149,18 +173,23 @@ 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
 
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandSearchParams} for more details.
+      #
       # Search brands by query
       #
-      # @overload search(query:, request_options: {})
+      # @overload search(query:, timeout_ms: nil, request_options: {})
       #
       # @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>]
@@ -171,7 +200,7 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/search",
-          query: parsed,
+          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
           model: BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandSearchResponseItem],
           options: options
         )

data/lib/brand_dev/version.rb

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

data/rbi/brand_dev/models/brand_ai_query_params.rbi

@@ -30,12 +30,22 @@ module BrandDev
       end
       attr_writer :specific_pages
 
+      # 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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
       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(T.attached_class)
       end
@@ -46,6 +56,10 @@ module BrandDev
         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
@@ -57,6 +71,7 @@ module BrandDev
               T::Array[BrandDev::BrandAIQueryParams::DataToExtract],
             domain: String,
             specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+            timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }
         )

data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi

@@ -18,15 +18,29 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
       sig do
         params(
           transaction_info: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # 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
@@ -35,6 +49,7 @@ module BrandDev
         override.returns(
           {
             transaction_info: String,
+            timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }
         )

data/rbi/brand_dev/models/brand_prefetch_params.rbi

@@ -15,22 +15,40 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
       sig do
         params(
           domain: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # 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
 
       sig do
         override.returns(
-          { domain: String, request_options: BrandDev::RequestOptions }
+          {
+            domain: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi

@@ -18,22 +18,40 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
       sig do
         params(
           ticker: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # 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
 
       sig do
         override.returns(
-          { ticker: String, request_options: BrandDev::RequestOptions }
+          {
+            ticker: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi

@@ -17,9 +17,19 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
       sig do
         params(
           input: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -28,13 +38,21 @@ 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
 
       sig do
         override.returns(
-          { input: String, request_options: BrandDev::RequestOptions }
+          {
+            input: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/brand_dev/models/brand_retrieve_params.rbi

@@ -31,20 +31,30 @@ module BrandDev
       attr_writer :force_language
 
       # Optional parameter to optimize the API call for maximum speed. When set to true,
-      # the API will skip social media data extraction and external service calls (like
-      # Crunchbase) to return results faster with basic brand information only.
+      # the API will skip time-consuming operations for faster response at the cost of
+      # less comprehensive data.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :max_speed
 
       sig { params(max_speed: T::Boolean).void }
       attr_writer :max_speed
 
+      # 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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
       sig do
         params(
           domain: String,
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
           max_speed: T::Boolean,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -54,9 +64,13 @@ module BrandDev
         # 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 social media data extraction and external service calls (like
-        # Crunchbase) to return results faster with basic brand information only.
+        # 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
@@ -68,6 +82,7 @@ module BrandDev
             force_language:
               BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
             max_speed: T::Boolean,
+            timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }
         )

data/rbi/brand_dev/models/brand_search_params.rbi

@@ -15,22 +15,40 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :query
 
+      # 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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
       sig do
         params(
           query: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # Query string to search brands
         query:,
+        # 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
 
       sig do
         override.returns(
-          { query: String, request_options: BrandDev::RequestOptions }
+          {
+            query: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/brand_dev/resources/brand.rbi

@@ -10,6 +10,7 @@ module BrandDev
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
           max_speed: T::Boolean,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveResponse)
       end
@@ -19,9 +20,13 @@ module BrandDev
         # 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 social media data extraction and external service calls (like
-        # Crunchbase) to return results faster with basic brand information only.
+        # 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
@@ -35,6 +40,7 @@ module BrandDev
             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
@@ -45,6 +51,10 @@ module BrandDev
         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
@@ -54,12 +64,17 @@ 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
@@ -71,12 +86,17 @@ module BrandDev
       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
@@ -85,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
@@ -99,6 +124,7 @@ module BrandDev
       sig do
         params(
           input: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveNaicsResponse)
       end
@@ -107,6 +133,10 @@ 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
@@ -115,12 +145,17 @@ module BrandDev
       sig do
         params(
           query: String,
+          timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T::Array[BrandDev::Models::BrandSearchResponseItem])
       end
       def search(
         # Query string to search brands
         query:,
+        # 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/models/brand_ai_query_params.rbs

@@ -4,7 +4,8 @@ module BrandDev
       {
         data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
         domain: String,
-        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages
+        specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        timeout_ms: Integer
       }
       & BrandDev::Internal::Type::request_parameters
 
@@ -22,10 +23,15 @@ module BrandDev
         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
 
@@ -33,6 +39,7 @@ module BrandDev
         data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
         domain: String,
         specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        timeout_ms: Integer,
         request_options: BrandDev::RequestOptions
       }
 

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

@@ -1,7 +1,8 @@
 module BrandDev
   module Models
     type brand_prefetch_params =
-      { domain: String } & BrandDev::Internal::Type::request_parameters
+      { domain: String, timeout_ms: Integer }
+      & BrandDev::Internal::Type::request_parameters
 
     class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
       extend BrandDev::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,19 @@ module BrandDev
 
       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

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

data/sig/brand_dev/models/brand_retrieve_naics_params.rbs

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

data/sig/brand_dev/models/brand_retrieve_params.rbs

@@ -4,7 +4,8 @@ module BrandDev
       {
         domain: String,
         force_language: BrandDev::Models::BrandRetrieveParams::force_language,
-        max_speed: bool
+        max_speed: bool,
+        timeout_ms: Integer
       }
       & BrandDev::Internal::Type::request_parameters
 
@@ -24,10 +25,15 @@ module BrandDev
 
       def max_speed=: (bool) -> bool
 
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
       def initialize: (
         domain: String,
         ?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
         ?max_speed: bool,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
 
@@ -35,6 +41,7 @@ module BrandDev
         domain: String,
         force_language: BrandDev::Models::BrandRetrieveParams::force_language,
         max_speed: bool,
+        timeout_ms: Integer,
         request_options: BrandDev::RequestOptions
       }
 

data/sig/brand_dev/models/brand_search_params.rbs

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

data/sig/brand_dev/resources/brand.rbs

@@ -5,6 +5,7 @@ module BrandDev
         domain: String,
         ?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
         ?max_speed: bool,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandRetrieveResponse
 
@@ -12,31 +13,37 @@ module BrandDev
         data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
         domain: String,
         ?specific_pages: BrandDev::BrandAIQueryParams::SpecificPages,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandAIQueryResponse
 
       def identify_from_transaction: (
         transaction_info: String,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandIdentifyFromTransactionResponse
 
       def prefetch: (
         domain: String,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandPrefetchResponse
 
       def retrieve_by_ticker: (
         ticker: String,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandRetrieveByTickerResponse
 
       def retrieve_naics: (
         input: String,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandRetrieveNaicsResponse
 
       def search: (
         query: String,
+        ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::brand_search_response
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.4
+  version: 0.1.0.pre.alpha.6
 platform: ruby
 authors:
 - Brand Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool