brand.dev 0.27.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 352acbb6668a328d87a316a4dba30616f02c7d1d7fcf472df6bb0109d9befdb1
-  data.tar.gz: 155f0018fd308c55dead3ef2ea0850085d21ded6920a9ae9c2f9229a2a527cd3
+  metadata.gz: 627fe92d0bc7ddf8f90668f8fea94981c87b86f44e07050a3bb502f3e8448a28
+  data.tar.gz: 5438f2a94d3e45e69ce0705e3014f57a81d3d8be04b691b7fbbee2df654aa650
 SHA512:
-  metadata.gz: 1f0a1068ce78f873ff484541d3a482de10824e093a4e70ee4df02804e3be6e02d2b5850bece4540b5519e92cd365af87a93b05d2b6fce9d315131d0fce525c02
-  data.tar.gz: e91395f9bb9671f7346e2e3dc0cc5d1e5a6a3b86ff28bd6eba0d03d3e8e546acce9dc8dc43b629f9fd7dc6dd9ea39503e64a3d29202e92bc3bbd3de049268aa1
+  metadata.gz: 3a0f9f9a79e2bc86585a334051744d31f9c28b2ecd13e99829aee645721a73e3d01a722d0d6254962c817e89ad9a30a85c5e18bc0908491805e0649928df9205
+  data.tar.gz: 2e4605272ec70e7a65eb6b6be89b3337bbb1b6fc10daac89d730f23e544177b9352f49f187b3dbc7f3d3d7f1bd440f14ddf96f14cdbe31b4aab144a21b13395a

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 0.28.1 (2026-03-06)
+
+Full Changelog: [v0.28.0...v0.28.1](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.28.0...v0.28.1)
+
+### Chores
+
+* **ci:** add build step ([b2d8fd1](https://github.com/brand-dot-dev/ruby-sdk/commit/b2d8fd1f17caeda7ab95d69ba33f7ad2a4848f55))
+* **internal:** codegen related update ([f199738](https://github.com/brand-dot-dev/ruby-sdk/commit/f199738e587d42fef1acb3891f4ef9e71f365f6b))
+* **internal:** codegen related update ([e55e75e](https://github.com/brand-dot-dev/ruby-sdk/commit/e55e75ed640d0deacbc1503eca4e12eb4e6c4131))
+
+## 0.28.0 (2026-03-01)
+
+Full Changelog: [v0.27.0...v0.28.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.27.0...v0.28.0)
+
+### Features
+
+* **api:** api update ([e331b46](https://github.com/brand-dot-dev/ruby-sdk/commit/e331b462ba84b3bf7e1415b30446dd0415fefd8e))
+* **api:** api update ([2a8660e](https://github.com/brand-dot-dev/ruby-sdk/commit/2a8660ed1f64a46657919b4d7cd314ea47e4d8c6))
+
+
+### Bug Fixes
+
+* properly mock time in ruby ci tests ([3d3021f](https://github.com/brand-dot-dev/ruby-sdk/commit/3d3021f8b4b775084459fa5559e9dec7d856b4be))
+
 ## 0.27.0 (2026-02-24)
 
 Full Changelog: [v0.26.0...v0.27.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.26.0...v0.27.0)

data/README.md

@@ -26,7 +26,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.27.0"
+gem "brand.dev", "~> 0.28.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/brand_dev/internal/util.rb

@@ -490,6 +490,37 @@ module BrandDev
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection[key] = element.map(&:to_s).join(",")
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]

data/lib/brand_dev/models/brand_ai_products_params.rb

@@ -7,45 +7,88 @@ module BrandDev
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
-      # @!attribute domain
-      #   The domain name to analyze.
+      # @!attribute body
       #
-      #   @return [String]
-      required :domain, String
+      #   @return [BrandDev::Models::BrandAIProductsParams::Body::ByDomain, BrandDev::Models::BrandAIProductsParams::Body::ByDirectURL]
+      required :body, union: -> { BrandDev::BrandAIProductsParams::Body }
 
-      # @!attribute max_products
-      #   Maximum number of products to extract.
-      #
-      #   @return [Integer, nil]
-      optional :max_products, Integer, api_name: :maxProducts
+      # @!method initialize(body:, request_options: {})
+      #   @param body [BrandDev::Models::BrandAIProductsParams::Body::ByDomain, BrandDev::Models::BrandAIProductsParams::Body::ByDirectURL]
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
 
-      # @!attribute timeout_ms
-      #   Optional timeout in milliseconds for the request. Maximum allowed value is
-      #   300000ms (5 minutes).
-      #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer, api_name: :timeoutMS
+      module Body
+        extend BrandDev::Internal::Type::Union
 
-      # @!attribute direct_url
-      #   A specific URL to use directly as the starting point for extraction without
-      #   domain resolution.
-      #
-      #   @return [String]
-      required :direct_url, String, api_name: :directUrl
+        variant -> { BrandDev::BrandAIProductsParams::Body::ByDomain }
 
-      # @!method initialize(domain:, direct_url:, max_products: nil, timeout_ms: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {BrandDev::Models::BrandAIProductsParams} for more details.
-      #
-      #   @param domain [String] The domain name to analyze.
-      #
-      #   @param direct_url [String] A specific URL to use directly as the starting point for extraction without doma
-      #
-      #   @param max_products [Integer] Maximum number of products to extract.
-      #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
-      #
-      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+        variant -> { BrandDev::BrandAIProductsParams::Body::ByDirectURL }
+
+        class ByDomain < BrandDev::Internal::Type::BaseModel
+          # @!attribute domain
+          #   The domain name to analyze.
+          #
+          #   @return [String]
+          required :domain, String
+
+          # @!attribute max_products
+          #   Maximum number of products to extract.
+          #
+          #   @return [Integer, nil]
+          optional :max_products, Integer, api_name: :maxProducts
+
+          # @!attribute timeout_ms
+          #   Optional timeout in milliseconds for the request. Maximum allowed value is
+          #   300000ms (5 minutes).
+          #
+          #   @return [Integer, nil]
+          optional :timeout_ms, Integer, api_name: :timeoutMS
+
+          # @!method initialize(domain:, max_products: nil, timeout_ms: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {BrandDev::Models::BrandAIProductsParams::Body::ByDomain} for more details.
+          #
+          #   @param domain [String] The domain name to analyze.
+          #
+          #   @param max_products [Integer] Maximum number of products to extract.
+          #
+          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
+        end
+
+        class ByDirectURL < BrandDev::Internal::Type::BaseModel
+          # @!attribute direct_url
+          #   A specific URL to use directly as the starting point for extraction without
+          #   domain resolution.
+          #
+          #   @return [String]
+          required :direct_url, String, api_name: :directUrl
+
+          # @!attribute max_products
+          #   Maximum number of products to extract.
+          #
+          #   @return [Integer, nil]
+          optional :max_products, Integer, api_name: :maxProducts
+
+          # @!attribute timeout_ms
+          #   Optional timeout in milliseconds for the request. Maximum allowed value is
+          #   300000ms (5 minutes).
+          #
+          #   @return [Integer, nil]
+          optional :timeout_ms, Integer, api_name: :timeoutMS
+
+          # @!method initialize(direct_url:, max_products: nil, timeout_ms: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {BrandDev::Models::BrandAIProductsParams::Body::ByDirectURL} for more details.
+          #
+          #   @param direct_url [String] A specific URL to use directly as the starting point for extraction without doma
+          #
+          #   @param max_products [Integer] Maximum number of products to extract.
+          #
+          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
+        end
+
+        # @!method self.variants
+        #   @return [Array(BrandDev::Models::BrandAIProductsParams::Body::ByDomain, BrandDev::Models::BrandAIProductsParams::Body::ByDirectURL)]
+      end
     end
   end
 end

data/lib/brand_dev/models/brand_identify_from_transaction_params.rb

@@ -32,6 +32,14 @@ module BrandDev
       #   @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage, nil]
       optional :force_language, enum: -> { BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage }
 
+      # @!attribute high_confidence_only
+      #   When set to true, the API will perform an additional verification steps to
+      #   ensure the identified brand matches the transaction with high confidence.
+      #   Defaults to false.
+      #
+      #   @return [Boolean, nil]
+      optional :high_confidence_only, BrandDev::Internal::Type::Boolean
+
       # @!attribute max_speed
       #   Optional parameter to optimize the API call for maximum speed. When set to true,
       #   the API will skip time-consuming operations for faster response at the cost of
@@ -61,7 +69,7 @@ module BrandDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandIdentifyFromTransactionParams} for more details.
       #
@@ -73,6 +81,8 @@ module BrandDev
       #
       #   @param force_language [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      #   @param high_confidence_only [Boolean] When set to true, the API will perform an additional verification steps to ensur
+      #
       #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       #   @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind

data/lib/brand_dev/models/brand_web_scrape_md_params.rb

@@ -26,7 +26,13 @@ module BrandDev
       #   @return [Boolean, nil]
       optional :include_links, BrandDev::Internal::Type::Boolean
 
-      # @!method initialize(url:, include_images: nil, include_links: nil, request_options: {})
+      # @!attribute shorten_base64_images
+      #   Shorten base64-encoded image data in the Markdown output
+      #
+      #   @return [Boolean, nil]
+      optional :shorten_base64_images, BrandDev::Internal::Type::Boolean
+
+      # @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandWebScrapeMdParams} for more details.
       #
@@ -36,6 +42,8 @@ module BrandDev
       #
       #   @param include_links [Boolean] Preserve hyperlinks in Markdown output
       #
+      #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
+      #
       #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/brand_dev/resources/brand.rb

@@ -26,10 +26,11 @@ module BrandDev
       # @see BrandDev::Models::BrandRetrieveParams
       def retrieve(params)
         parsed, options = BrandDev::BrandRetrieveParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/retrieve",
-          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveResponse,
           options: options
         )
@@ -64,23 +65,13 @@ module BrandDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {BrandDev::Models::BrandAIProductsParams} for more details.
-      #
       # Beta feature: Extract product information from a brand's website. Brand.dev will
       # analyze the website and return a list of products with details such as name,
       # description, image, pricing, features, and more.
       #
-      # @overload ai_products(domain:, direct_url:, max_products: nil, timeout_ms: nil, request_options: {})
-      #
-      # @param domain [String] The domain name to analyze.
-      #
-      # @param direct_url [String] A specific URL to use directly as the starting point for extraction without doma
-      #
-      # @param max_products [Integer] Maximum number of products to extract.
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000
+      # @overload ai_products(body:, request_options: {})
       #
+      # @param body [BrandDev::Models::BrandAIProductsParams::Body::ByDomain, BrandDev::Models::BrandAIProductsParams::Body::ByDirectURL]
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandAIProductsResponse]
@@ -91,7 +82,7 @@ module BrandDev
         @client.request(
           method: :post,
           path: "brand/ai/products",
-          body: parsed,
+          body: parsed[:body],
           model: BrandDev::Models::BrandAIProductsResponse,
           options: options
         )
@@ -149,10 +140,11 @@ module BrandDev
       # @see BrandDev::Models::BrandFontsParams
       def fonts(params)
         parsed, options = BrandDev::BrandFontsParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/fonts",
-          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
+          query: query.transform_keys(timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandFontsResponse,
           options: options
         )
@@ -164,7 +156,7 @@ module BrandDev
       # Endpoint specially designed for platforms that want to identify transaction data
       # by the transaction title.
       #
-      # @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
+      # @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
       #
       # @param transaction_info [String] Transaction information to identify the brand
       #
@@ -174,6 +166,8 @@ module BrandDev
       #
       # @param force_language [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
       #
+      # @param high_confidence_only [Boolean] When set to true, the API will perform an additional verification steps to ensur
+      #
       # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
       #
       # @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
@@ -189,10 +183,11 @@ module BrandDev
       # @see BrandDev::Models::BrandIdentifyFromTransactionParams
       def identify_from_transaction(params)
         parsed, options = BrandDev::BrandIdentifyFromTransactionParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/transaction_identifier",
-          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandIdentifyFromTransactionResponse,
           options: options
         )
@@ -285,10 +280,11 @@ module BrandDev
       # @see BrandDev::Models::BrandRetrieveByEmailParams
       def retrieve_by_email(params)
         parsed, options = BrandDev::BrandRetrieveByEmailParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/retrieve-by-email",
-          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveByEmailResponse,
           options: options
         )
@@ -318,10 +314,11 @@ module BrandDev
       # @see BrandDev::Models::BrandRetrieveByIsinParams
       def retrieve_by_isin(params)
         parsed, options = BrandDev::BrandRetrieveByIsinParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/retrieve-by-isin",
-          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveByIsinResponse,
           options: options
         )
@@ -350,10 +347,11 @@ module BrandDev
       # @see BrandDev::Models::BrandRetrieveByNameParams
       def retrieve_by_name(params)
         parsed, options = BrandDev::BrandRetrieveByNameParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/retrieve-by-name",
-          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveByNameResponse,
           options: options
         )
@@ -384,10 +382,11 @@ module BrandDev
       # @see BrandDev::Models::BrandRetrieveByTickerParams
       def retrieve_by_ticker(params)
         parsed, options = BrandDev::BrandRetrieveByTickerParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/retrieve-by-ticker",
-          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveByTickerResponse,
           options: options
         )
@@ -415,10 +414,11 @@ module BrandDev
       # @see BrandDev::Models::BrandRetrieveNaicsParams
       def retrieve_naics(params)
         parsed, options = BrandDev::BrandRetrieveNaicsParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/naics",
-          query: parsed.transform_keys(
+          query: query.transform_keys(
             max_results: "maxResults",
             min_results: "minResults",
             timeout_ms: "timeoutMS"
@@ -448,10 +448,11 @@ module BrandDev
       # @see BrandDev::Models::BrandRetrieveSimplifiedParams
       def retrieve_simplified(params)
         parsed, options = BrandDev::BrandRetrieveSimplifiedParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/retrieve-simplified",
-          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
+          query: query.transform_keys(timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandRetrieveSimplifiedResponse,
           options: options
         )
@@ -482,10 +483,11 @@ module BrandDev
       # @see BrandDev::Models::BrandScreenshotParams
       def screenshot(params)
         parsed, options = BrandDev::BrandScreenshotParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/screenshot",
-          query: parsed.transform_keys(full_screenshot: "fullScreenshot"),
+          query: query.transform_keys(full_screenshot: "fullScreenshot"),
           model: BrandDev::Models::BrandScreenshotResponse,
           options: options
         )
@@ -516,10 +518,11 @@ module BrandDev
       # @see BrandDev::Models::BrandStyleguideParams
       def styleguide(params = {})
         parsed, options = BrandDev::BrandStyleguideParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brand/styleguide",
-          query: parsed.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandStyleguideResponse,
           options: options
         )
@@ -539,10 +542,11 @@ module BrandDev
       # @see BrandDev::Models::BrandWebScrapeHTMLParams
       def web_scrape_html(params)
         parsed, options = BrandDev::BrandWebScrapeHTMLParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "web/scrape/html",
-          query: parsed,
+          query: query,
           model: BrandDev::Models::BrandWebScrapeHTMLResponse,
           options: options
         )
@@ -563,10 +567,11 @@ module BrandDev
       # @see BrandDev::Models::BrandWebScrapeImagesParams
       def web_scrape_images(params)
         parsed, options = BrandDev::BrandWebScrapeImagesParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "web/scrape/images",
-          query: parsed,
+          query: query,
           model: BrandDev::Models::BrandWebScrapeImagesResponse,
           options: options
         )
@@ -579,7 +584,7 @@ module BrandDev
       # (GFM), and returns the result. Uses automatic proxy escalation to handle blocked
       # sites.
       #
-      # @overload web_scrape_md(url:, include_images: nil, include_links: nil, request_options: {})
+      # @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
       #
       # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro
       #
@@ -587,6 +592,8 @@ module BrandDev
       #
       # @param include_links [Boolean] Preserve hyperlinks in Markdown output
       #
+      # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
+      #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandWebScrapeMdResponse]
@@ -594,10 +601,15 @@ module BrandDev
       # @see BrandDev::Models::BrandWebScrapeMdParams
       def web_scrape_md(params)
         parsed, options = BrandDev::BrandWebScrapeMdParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "web/scrape/markdown",
-          query: parsed.transform_keys(include_images: "includeImages", include_links: "includeLinks"),
+          query: query.transform_keys(
+            include_images: "includeImages",
+            include_links: "includeLinks",
+            shorten_base64_images: "shortenBase64Images"
+          ),
           model: BrandDev::Models::BrandWebScrapeMdResponse,
           options: options
         )
@@ -621,10 +633,11 @@ module BrandDev
       # @see BrandDev::Models::BrandWebScrapeSitemapParams
       def web_scrape_sitemap(params)
         parsed, options = BrandDev::BrandWebScrapeSitemapParams.dump_request(params)
+        query = BrandDev::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "web/scrape/sitemap",
-          query: parsed,
+          query: query,
           model: BrandDev::Models::BrandWebScrapeSitemapResponse,
           options: options
         )

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.27.0"
+  VERSION = "0.28.1"
 end

data/rbi/brand_dev/internal/util.rbi

@@ -301,6 +301,26 @@ module BrandDev
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: BrandDev::Internal::AnyHash).returns(
+            BrandDev::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: BrandDev::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/brand_dev/models/brand_ai_products_params.rbi

@@ -11,67 +11,175 @@ module BrandDev
           T.any(BrandDev::BrandAIProductsParams, BrandDev::Internal::AnyHash)
         end
 
-      # The domain name to analyze.
-      sig { returns(String) }
-      attr_accessor :domain
-
-      # Maximum number of products to extract.
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :max_products
-
-      sig { params(max_products: Integer).void }
-      attr_writer :max_products
-
-      # Optional timeout in milliseconds for the request. 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
-
-      # A specific URL to use directly as the starting point for extraction without
-      # domain resolution.
-      sig { returns(String) }
-      attr_accessor :direct_url
+      sig do
+        returns(
+          T.any(
+            BrandDev::BrandAIProductsParams::Body::ByDomain,
+            BrandDev::BrandAIProductsParams::Body::ByDirectURL
+          )
+        )
+      end
+      attr_accessor :body
 
       sig do
         params(
-          domain: String,
-          direct_url: String,
-          max_products: Integer,
-          timeout_ms: Integer,
+          body:
+            T.any(
+              BrandDev::BrandAIProductsParams::Body::ByDomain::OrHash,
+              BrandDev::BrandAIProductsParams::Body::ByDirectURL::OrHash
+            ),
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # The domain name to analyze.
-        domain:,
-        # A specific URL to use directly as the starting point for extraction without
-        # domain resolution.
-        direct_url:,
-        # Maximum number of products to extract.
-        max_products: nil,
-        # Optional timeout in milliseconds for the request. Maximum allowed value is
-        # 300000ms (5 minutes).
-        timeout_ms: nil,
-        request_options: {}
-      )
+      def self.new(body:, request_options: {})
       end
 
       sig do
         override.returns(
           {
-            domain: String,
-            max_products: Integer,
-            timeout_ms: Integer,
-            direct_url: String,
+            body:
+              T.any(
+                BrandDev::BrandAIProductsParams::Body::ByDomain,
+                BrandDev::BrandAIProductsParams::Body::ByDirectURL
+              ),
             request_options: BrandDev::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      module Body
+        extend BrandDev::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              BrandDev::BrandAIProductsParams::Body::ByDomain,
+              BrandDev::BrandAIProductsParams::Body::ByDirectURL
+            )
+          end
+
+        class ByDomain < BrandDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                BrandDev::BrandAIProductsParams::Body::ByDomain,
+                BrandDev::Internal::AnyHash
+              )
+            end
+
+          # The domain name to analyze.
+          sig { returns(String) }
+          attr_accessor :domain
+
+          # Maximum number of products to extract.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_products
+
+          sig { params(max_products: Integer).void }
+          attr_writer :max_products
+
+          # Optional timeout in milliseconds for the request. 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,
+              max_products: Integer,
+              timeout_ms: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The domain name to analyze.
+            domain:,
+            # Maximum number of products to extract.
+            max_products: nil,
+            # Optional timeout in milliseconds for the request. Maximum allowed value is
+            # 300000ms (5 minutes).
+            timeout_ms: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { domain: String, max_products: Integer, timeout_ms: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class ByDirectURL < BrandDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                BrandDev::BrandAIProductsParams::Body::ByDirectURL,
+                BrandDev::Internal::AnyHash
+              )
+            end
+
+          # A specific URL to use directly as the starting point for extraction without
+          # domain resolution.
+          sig { returns(String) }
+          attr_accessor :direct_url
+
+          # Maximum number of products to extract.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_products
+
+          sig { params(max_products: Integer).void }
+          attr_writer :max_products
+
+          # Optional timeout in milliseconds for the request. 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(
+              direct_url: String,
+              max_products: Integer,
+              timeout_ms: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A specific URL to use directly as the starting point for extraction without
+            # domain resolution.
+            direct_url:,
+            # Maximum number of products to extract.
+            max_products: nil,
+            # Optional timeout in milliseconds for the request. Maximum allowed value is
+            # 300000ms (5 minutes).
+            timeout_ms: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { direct_url: String, max_products: Integer, timeout_ms: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[BrandDev::BrandAIProductsParams::Body::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
     end
   end
 end

data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi

@@ -62,6 +62,15 @@ module BrandDev
       end
       attr_writer :force_language
 
+      # When set to true, the API will perform an additional verification steps to
+      # ensure the identified brand matches the transaction with high confidence.
+      # Defaults to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :high_confidence_only
+
+      sig { params(high_confidence_only: T::Boolean).void }
+      attr_writer :high_confidence_only
+
       # Optional parameter to optimize the API call for maximum speed. When set to true,
       # the API will skip time-consuming operations for faster response at the cost of
       # less comprehensive data.
@@ -103,6 +112,7 @@ module BrandDev
             BrandDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
           force_language:
             BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
+          high_confidence_only: T::Boolean,
           max_speed: T::Boolean,
           mcc: String,
           phone: Float,
@@ -120,6 +130,10 @@ module BrandDev
         country_gl: nil,
         # Optional parameter to force the language of the retrieved brand data.
         force_language: nil,
+        # When set to true, the API will perform an additional verification steps to
+        # ensure the identified brand matches the transaction with high confidence.
+        # Defaults to false.
+        high_confidence_only: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
         # less comprehensive data.
@@ -146,6 +160,7 @@ module BrandDev
               BrandDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
             force_language:
               BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
+            high_confidence_only: T::Boolean,
             max_speed: T::Boolean,
             mcc: String,
             phone: Float,

data/rbi/brand_dev/models/brand_web_scrape_md_params.rbi

@@ -30,11 +30,19 @@ module BrandDev
       sig { params(include_links: T::Boolean).void }
       attr_writer :include_links
 
+      # Shorten base64-encoded image data in the Markdown output
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :shorten_base64_images
+
+      sig { params(shorten_base64_images: T::Boolean).void }
+      attr_writer :shorten_base64_images
+
       sig do
         params(
           url: String,
           include_images: T::Boolean,
           include_links: T::Boolean,
+          shorten_base64_images: T::Boolean,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -46,6 +54,8 @@ module BrandDev
         include_images: nil,
         # Preserve hyperlinks in Markdown output
         include_links: nil,
+        # Shorten base64-encoded image data in the Markdown output
+        shorten_base64_images: nil,
         request_options: {}
       )
       end
@@ -56,6 +66,7 @@ module BrandDev
             url: String,
             include_images: T::Boolean,
             include_links: T::Boolean,
+            shorten_base64_images: T::Boolean,
             request_options: BrandDev::RequestOptions
           }
         )

data/rbi/brand_dev/resources/brand.rbi

@@ -59,26 +59,15 @@ module BrandDev
       # description, image, pricing, features, and more.
       sig do
         params(
-          domain: String,
-          direct_url: String,
-          max_products: Integer,
-          timeout_ms: Integer,
+          body:
+            T.any(
+              BrandDev::BrandAIProductsParams::Body::ByDomain::OrHash,
+              BrandDev::BrandAIProductsParams::Body::ByDirectURL::OrHash
+            ),
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandAIProductsResponse)
       end
-      def ai_products(
-        # The domain name to analyze.
-        domain:,
-        # A specific URL to use directly as the starting point for extraction without
-        # domain resolution.
-        direct_url:,
-        # Maximum number of products to extract.
-        max_products: nil,
-        # Optional timeout in milliseconds for the request. Maximum allowed value is
-        # 300000ms (5 minutes).
-        timeout_ms: nil,
-        request_options: {}
-      )
+      def ai_products(body:, request_options: {})
       end
 
       # Use AI to extract specific data points from a brand's website. The AI will crawl
@@ -140,6 +129,7 @@ module BrandDev
             BrandDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
           force_language:
             BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
+          high_confidence_only: T::Boolean,
           max_speed: T::Boolean,
           mcc: String,
           phone: Float,
@@ -157,6 +147,10 @@ module BrandDev
         country_gl: nil,
         # Optional parameter to force the language of the retrieved brand data.
         force_language: nil,
+        # When set to true, the API will perform an additional verification steps to
+        # ensure the identified brand matches the transaction with high confidence.
+        # Defaults to false.
+        high_confidence_only: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
         # less comprehensive data.
@@ -507,6 +501,7 @@ module BrandDev
           url: String,
           include_images: T::Boolean,
           include_links: T::Boolean,
+          shorten_base64_images: T::Boolean,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandWebScrapeMdResponse)
       end
@@ -518,6 +513,8 @@ module BrandDev
         include_images: nil,
         # Preserve hyperlinks in Markdown output
         include_links: nil,
+        # Shorten base64-encoded image data in the Markdown output
+        shorten_base64_images: nil,
         request_options: {}
       )
       end

data/sig/brand_dev/internal/util.rbs

@@ -106,6 +106,16 @@ module BrandDev
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/brand_dev/models/brand_ai_products_params.rbs

@@ -1,45 +1,88 @@
 module BrandDev
   module Models
     type brand_ai_products_params =
-      {
-        domain: String,
-        max_products: Integer,
-        timeout_ms: Integer,
-        direct_url: String
-      }
+      { body: BrandDev::Models::BrandAIProductsParams::body }
       & BrandDev::Internal::Type::request_parameters
 
     class BrandAIProductsParams < BrandDev::Internal::Type::BaseModel
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
-      attr_accessor domain: String
-
-      attr_reader max_products: Integer?
-
-      def max_products=: (Integer) -> Integer
-
-      attr_reader timeout_ms: Integer?
-
-      def timeout_ms=: (Integer) -> Integer
-
-      attr_accessor direct_url: String
+      attr_accessor body: BrandDev::Models::BrandAIProductsParams::body
 
       def initialize: (
-        domain: String,
-        direct_url: String,
-        ?max_products: Integer,
-        ?timeout_ms: Integer,
+        body: BrandDev::Models::BrandAIProductsParams::body,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
-        domain: String,
-        max_products: Integer,
-        timeout_ms: Integer,
-        direct_url: String,
+        body: BrandDev::Models::BrandAIProductsParams::body,
         request_options: BrandDev::RequestOptions
       }
+
+      type body =
+        BrandDev::BrandAIProductsParams::Body::ByDomain
+        | BrandDev::BrandAIProductsParams::Body::ByDirectURL
+
+      module Body
+        extend BrandDev::Internal::Type::Union
+
+        type by_domain =
+          { domain: String, max_products: Integer, timeout_ms: Integer }
+
+        class ByDomain < BrandDev::Internal::Type::BaseModel
+          attr_accessor domain: String
+
+          attr_reader max_products: Integer?
+
+          def max_products=: (Integer) -> Integer
+
+          attr_reader timeout_ms: Integer?
+
+          def timeout_ms=: (Integer) -> Integer
+
+          def initialize: (
+            domain: String,
+            ?max_products: Integer,
+            ?timeout_ms: Integer
+          ) -> void
+
+          def to_hash: -> {
+            domain: String,
+            max_products: Integer,
+            timeout_ms: Integer
+          }
+        end
+
+        type by_direct_url =
+          { direct_url: String, max_products: Integer, timeout_ms: Integer }
+
+        class ByDirectURL < BrandDev::Internal::Type::BaseModel
+          attr_accessor direct_url: String
+
+          attr_reader max_products: Integer?
+
+          def max_products=: (Integer) -> Integer
+
+          attr_reader timeout_ms: Integer?
+
+          def timeout_ms=: (Integer) -> Integer
+
+          def initialize: (
+            direct_url: String,
+            ?max_products: Integer,
+            ?timeout_ms: Integer
+          ) -> void
+
+          def to_hash: -> {
+            direct_url: String,
+            max_products: Integer,
+            timeout_ms: Integer
+          }
+        end
+
+        def self?.variants: -> ::Array[BrandDev::Models::BrandAIProductsParams::body]
+      end
     end
   end
 end

data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs

@@ -6,6 +6,7 @@ module BrandDev
         city: String,
         country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
         force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
+        high_confidence_only: bool,
         max_speed: bool,
         mcc: String,
         phone: Float,
@@ -35,6 +36,10 @@ module BrandDev
         BrandDev::Models::BrandIdentifyFromTransactionParams::force_language
       ) -> BrandDev::Models::BrandIdentifyFromTransactionParams::force_language
 
+      attr_reader high_confidence_only: bool?
+
+      def high_confidence_only=: (bool) -> bool
+
       attr_reader max_speed: bool?
 
       def max_speed=: (bool) -> bool
@@ -56,6 +61,7 @@ module BrandDev
         ?city: String,
         ?country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
         ?force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
+        ?high_confidence_only: bool,
         ?max_speed: bool,
         ?mcc: String,
         ?phone: Float,
@@ -68,6 +74,7 @@ module BrandDev
         city: String,
         country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
         force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
+        high_confidence_only: bool,
         max_speed: bool,
         mcc: String,
         phone: Float,

data/sig/brand_dev/models/brand_web_scrape_md_params.rbs

@@ -1,7 +1,12 @@
 module BrandDev
   module Models
     type brand_web_scrape_md_params =
-      { url: String, include_images: bool, include_links: bool }
+      {
+        url: String,
+        include_images: bool,
+        include_links: bool,
+        :shorten_base64_images => bool
+      }
       & BrandDev::Internal::Type::request_parameters
 
     class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel
@@ -18,10 +23,15 @@ module BrandDev
 
       def include_links=: (bool) -> bool
 
+      attr_reader shorten_base64_images: bool?
+
+      def shorten_base64_images=: (bool) -> bool
+
       def initialize: (
         url: String,
         ?include_images: bool,
         ?include_links: bool,
+        ?shorten_base64_images: bool,
         ?request_options: BrandDev::request_opts
       ) -> void
 
@@ -29,6 +39,7 @@ module BrandDev
         url: String,
         include_images: bool,
         include_links: bool,
+        :shorten_base64_images => bool,
         request_options: BrandDev::RequestOptions
       }
     end

data/sig/brand_dev/resources/brand.rbs

@@ -16,10 +16,7 @@ module BrandDev
       ) -> BrandDev::Models::BrandAIProductResponse
 
       def ai_products: (
-        domain: String,
-        direct_url: String,
-        ?max_products: Integer,
-        ?timeout_ms: Integer,
+        body: BrandDev::Models::BrandAIProductsParams::body,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandAIProductsResponse
 
@@ -42,6 +39,7 @@ module BrandDev
         ?city: String,
         ?country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
         ?force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
+        ?high_confidence_only: bool,
         ?max_speed: bool,
         ?mcc: String,
         ?phone: Float,
@@ -138,6 +136,7 @@ module BrandDev
         url: String,
         ?include_images: bool,
         ?include_links: bool,
+        ?shorten_base64_images: bool,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandWebScrapeMdResponse
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.1
 platform: ruby
 authors:
 - Brand Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-24 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi