brand.dev 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be4fa887e23eb9143aaf2472d22397b99b414cb4ff93540d2ea3da5fbae0cfa3
-  data.tar.gz: 1c923c23ca8386e90fefe684df20b6ece1cc9455bcc9fec14d1f7cdb221cb100
+  metadata.gz: 73bfa839e4a462bc79f8d9fe6b6d8120ffff7ccc4f9da829328bb081eee1f9ac
+  data.tar.gz: 9e8e4646335f5c229cfa63c93e192a76dd767965df8714b807f218fed1e65de0
 SHA512:
-  metadata.gz: ac2de9483c9ed519557f9fcff0e2ea5041c938d8fd313a934332321d79133d25081c648bad90e320ed22a09a53faada008b3dae7cf023713350382cf8289ec28
-  data.tar.gz: f82183b8ff1d77f93834c0b4cbcb100ffd3ec1fcfa2ae08f5a3d6f2fc37b8f86933c423e2b5130a1f9319313404a336ac3cc7c4855b3f788e91d971fd3fb669f
+  metadata.gz: 3b2512f8069a014412a4f323863a6ef5d4c9a5b9f871758e0990aaac655059cae0168e96d76e34cebf871d018fc905288597df757b01e3a32468ad43497ca4d6
+  data.tar.gz: 3ba4231e77f884b787073607b2454bc146cf175a44541e5a0c49f406f9e0bfb7332e8711a2dada8ce10c28ed0265c5b422c72d8b396d34631aab24af0b2f9409

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 0.22.0 (2026-02-07)
+
+Full Changelog: [v0.21.0...v0.22.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.21.0...v0.22.0)
+
+### Features
+
+* **api:** api update ([f61453c](https://github.com/brand-dot-dev/ruby-sdk/commit/f61453cacff28784915b193547f730b8eb76cf92))
+
+
+### Bug Fixes
+
+* **client:** always add content-length to post body, even when empty ([6d12b11](https://github.com/brand-dot-dev/ruby-sdk/commit/6d12b114daabfd7ca3afc167a18adbe1fe347a36))
+* **client:** loosen json header parsing ([3739920](https://github.com/brand-dot-dev/ruby-sdk/commit/37399200e8e055ed11e83489cdf2674a2a9e6aa8))
+
+
+### Chores
+
+* **docs:** remove www prefix ([5b8d2c8](https://github.com/brand-dot-dev/ruby-sdk/commit/5b8d2c8b141d6bc47c5ac75aa640d620bfd3ada2))
+
+## 0.21.0 (2026-02-02)
+
+Full Changelog: [v0.20.0...v0.21.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.20.0...v0.21.0)
+
+### Features
+
+* **api:** api update ([a423b3c](https://github.com/brand-dot-dev/ruby-sdk/commit/a423b3c7bb3672541395e056cc611df45597d188))
+
+
+### Bug Fixes
+
+* **docs:** fix mcp installation instructions for remote servers ([a6ec5ef](https://github.com/brand-dot-dev/ruby-sdk/commit/a6ec5efbad9664835ade1580fe9433adda3b495b))
+
+
+### Chores
+
+* **internal:** update `actions/checkout` version ([06ba397](https://github.com/brand-dot-dev/ruby-sdk/commit/06ba3972227f9850264787f04bb0d49cf786ee74))
+* move `cgi` into dependencies for ruby 4 ([0e2e7df](https://github.com/brand-dot-dev/ruby-sdk/commit/0e2e7df7deebaa4950ff7813f52ad00fc033b74a))
+
+
+### Documentation
+
+* prominently feature MCP server setup in root SDK readmes ([328c136](https://github.com/brand-dot-dev/ruby-sdk/commit/328c136767a0b5ae60cc7cdfd23681e50f2569b5))
+
 ## 0.20.0 (2026-01-05)
 
 Full Changelog: [v0.19.0...v0.20.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.19.0...v0.20.0)

data/README.md

@@ -4,6 +4,15 @@ The Brand Dev Ruby library provides convenient access to the Brand Dev REST API
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## MCP Server
+
+Use the Brand Dev MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=brand.dev-mcp&config=eyJuYW1lIjoiYnJhbmQuZGV2LW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL2JyYW5kLWRldi5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LWJyYW5kLWRldi1hcGkta2V5IjoiTXkgQVBJIEtleSJ9fQ)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22brand.dev-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fbrand-dev.stlmcp.com%22%2C%22headers%22%3A%7B%22x-brand-dev-api-key%22%3A%22My%20API%20Key%22%7D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/brand.dev).
@@ -17,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.20.0"
+gem "brand.dev", "~> 0.22.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/brand_dev/internal/transport/pooled_net_requester.rb

@@ -75,7 +75,7 @@ module BrandDev
 
             case body
             in nil
-              nil
+              req["content-length"] ||= 0 unless req["transfer-encoding"]
             in String
               req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
               req.body_stream = BrandDev::Internal::Util::ReadIOAdapter.new(body, &blk)

data/lib/brand_dev/internal/util.rb

@@ -485,7 +485,7 @@ module BrandDev
       end
 
       # @type [Regexp]
-      JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
+      JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}
       # @type [Regexp]
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 

data/lib/brand_dev/models/brand_ai_products_params.rb

@@ -7,11 +7,21 @@ module BrandDev
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
+      # @!attribute direct_url
+      #   A specific URL to use directly as the starting point for extraction without
+      #   domain resolution. Useful when you want to extract products from a specific page
+      #   rather than discovering the site's product pages automatically. Either 'domain'
+      #   or 'directUrl' must be provided, but not both.
+      #
+      #   @return [String, nil]
+      optional :direct_url, String, api_name: :directUrl
+
       # @!attribute domain
-      #   The domain name to analyze
+      #   The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
+      #   not both.
       #
-      #   @return [String]
-      required :domain, String
+      #   @return [String, nil]
+      optional :domain, String
 
       # @!attribute max_products
       #   Maximum number of products to extract.
@@ -27,11 +37,13 @@ module BrandDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer, api_name: :timeoutMS
 
-      # @!method initialize(domain:, max_products: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(direct_url: nil, domain: nil, 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 domain [String] The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
       #
       #   @param max_products [Integer] Maximum number of products to extract.
       #

data/lib/brand_dev/models/brand_retrieve_params.rb

@@ -11,8 +11,8 @@ module BrandDev
       #   Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
       #   Cannot be used with name or ticker parameters.
       #
-      #   @return [String, nil]
-      optional :domain, String
+      #   @return [String]
+      required :domain, String
 
       # @!attribute force_language
       #   Optional parameter to force the language of the retrieved brand data. Works with
@@ -37,7 +37,7 @@ module BrandDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(domain: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      # @!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.
       #

data/lib/brand_dev/resources/brand.rb

@@ -9,7 +9,7 @@ module BrandDev
       # Retrieve logos, backdrops, colors, industry, description, and more from any
       # domain
       #
-      # @overload retrieve(domain: nil, force_language: nil, max_speed: nil, timeout_ms: 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 (e.g., 'example.com', 'google.com'). Cann
       #
@@ -24,7 +24,7 @@ module BrandDev
       # @return [BrandDev::Models::BrandRetrieveResponse]
       #
       # @see BrandDev::Models::BrandRetrieveParams
-      def retrieve(params = {})
+      def retrieve(params)
         parsed, options = BrandDev::BrandRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
@@ -42,9 +42,11 @@ module BrandDev
       # analyze the website and return a list of products with details such as name,
       # description, image, pricing, features, and more.
       #
-      # @overload ai_products(domain:, max_products: nil, timeout_ms: nil, request_options: {})
+      # @overload ai_products(direct_url: nil, domain: nil, 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 domain [String] The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
       #
       # @param max_products [Integer] Maximum number of products to extract.
       #
@@ -55,7 +57,7 @@ module BrandDev
       # @return [BrandDev::Models::BrandAIProductsResponse]
       #
       # @see BrandDev::Models::BrandAIProductsParams
-      def ai_products(params)
+      def ai_products(params = {})
         parsed, options = BrandDev::BrandAIProductsParams.dump_request(params)
         @client.request(
           method: :post,

data/lib/brand_dev/version.rb

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

data/rbi/brand_dev/internal/util.rbi

@@ -296,7 +296,7 @@ module BrandDev
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 

data/rbi/brand_dev/models/brand_ai_products_params.rbi

@@ -11,9 +11,23 @@ module BrandDev
           T.any(BrandDev::BrandAIProductsParams, BrandDev::Internal::AnyHash)
         end
 
-      # The domain name to analyze
-      sig { returns(String) }
-      attr_accessor :domain
+      # A specific URL to use directly as the starting point for extraction without
+      # domain resolution. Useful when you want to extract products from a specific page
+      # rather than discovering the site's product pages automatically. Either 'domain'
+      # or 'directUrl' must be provided, but not both.
+      sig { returns(T.nilable(String)) }
+      attr_reader :direct_url
+
+      sig { params(direct_url: String).void }
+      attr_writer :direct_url
+
+      # The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
+      # not both.
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
 
       # Maximum number of products to extract.
       sig { returns(T.nilable(Integer)) }
@@ -33,6 +47,7 @@ module BrandDev
 
       sig do
         params(
+          direct_url: String,
           domain: String,
           max_products: Integer,
           timeout_ms: Integer,
@@ -40,8 +55,14 @@ module BrandDev
         ).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. Useful when you want to extract products from a specific page
+        # rather than discovering the site's product pages automatically. Either 'domain'
+        # or 'directUrl' must be provided, but not both.
+        direct_url: nil,
+        # The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
+        # not both.
+        domain: nil,
         # Maximum number of products to extract.
         max_products: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
@@ -55,6 +76,7 @@ module BrandDev
       sig do
         override.returns(
           {
+            direct_url: String,
             domain: String,
             max_products: Integer,
             timeout_ms: Integer,

data/rbi/brand_dev/models/brand_retrieve_params.rbi

@@ -13,11 +13,8 @@ module BrandDev
 
       # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
       # Cannot be used with name or ticker parameters.
-      sig { returns(T.nilable(String)) }
-      attr_reader :domain
-
-      sig { params(domain: String).void }
-      attr_writer :domain
+      sig { returns(String) }
+      attr_accessor :domain
 
       # Optional parameter to force the language of the retrieved brand data. Works with
       # all three lookup methods.
@@ -66,7 +63,7 @@ module BrandDev
       def self.new(
         # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
         # Cannot be used with name or ticker parameters.
-        domain: nil,
+        domain:,
         # Optional parameter to force the language of the retrieved brand data. Works with
         # all three lookup methods.
         force_language: nil,

data/rbi/brand_dev/resources/brand.rbi

@@ -18,7 +18,7 @@ module BrandDev
       def retrieve(
         # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
         # Cannot be used with name or ticker parameters.
-        domain: nil,
+        domain:,
         # Optional parameter to force the language of the retrieved brand data. Works with
         # all three lookup methods.
         force_language: nil,
@@ -39,6 +39,7 @@ module BrandDev
       # description, image, pricing, features, and more.
       sig do
         params(
+          direct_url: String,
           domain: String,
           max_products: Integer,
           timeout_ms: Integer,
@@ -46,8 +47,14 @@ module BrandDev
         ).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. Useful when you want to extract products from a specific page
+        # rather than discovering the site's product pages automatically. Either 'domain'
+        # or 'directUrl' must be provided, but not both.
+        direct_url: nil,
+        # The domain name to analyze. Either 'domain' or 'directUrl' must be provided, but
+        # not both.
+        domain: nil,
         # Maximum number of products to extract.
         max_products: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer

data/sig/brand_dev/models/brand_ai_products_params.rbs

@@ -1,14 +1,25 @@
 module BrandDev
   module Models
     type brand_ai_products_params =
-      { domain: String, max_products: Integer, timeout_ms: Integer }
+      {
+        direct_url: String,
+        domain: String,
+        max_products: Integer,
+        timeout_ms: Integer
+      }
       & 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 direct_url: String?
+
+      def direct_url=: (String) -> String
+
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
 
       attr_reader max_products: Integer?
 
@@ -19,13 +30,15 @@ module BrandDev
       def timeout_ms=: (Integer) -> Integer
 
       def initialize: (
-        domain: String,
+        ?direct_url: String,
+        ?domain: String,
         ?max_products: Integer,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
+        direct_url: String,
         domain: String,
         max_products: Integer,
         timeout_ms: Integer,

data/sig/brand_dev/models/brand_retrieve_params.rbs

@@ -13,9 +13,7 @@ module BrandDev
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
-      attr_reader domain: String?
-
-      def domain=: (String) -> String
+      attr_accessor domain: String
 
       attr_reader force_language: BrandDev::Models::BrandRetrieveParams::force_language?
 
@@ -32,7 +30,7 @@ module BrandDev
       def timeout_ms=: (Integer) -> Integer
 
       def initialize: (
-        ?domain: String,
+        domain: String,
         ?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
         ?max_speed: bool,
         ?timeout_ms: Integer,

data/sig/brand_dev/resources/brand.rbs

@@ -2,7 +2,7 @@ module BrandDev
   module Resources
     class Brand
       def retrieve: (
-        ?domain: String,
+        domain: String,
         ?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
         ?max_speed: bool,
         ?timeout_ms: Integer,
@@ -10,7 +10,8 @@ module BrandDev
       ) -> BrandDev::Models::BrandRetrieveResponse
 
       def ai_products: (
-        domain: String,
+        ?direct_url: String,
+        ?domain: String,
         ?max_products: Integer,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Brand Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-05 00:00:00.000000000 Z
+date: 2026-02-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement