brand.dev 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d8d59aa62a298e531e77537f0438264b92262f8a1d6e2c85ed2f65855287586
-  data.tar.gz: 77fb50c2084d67c77d21b6eb6a7ec79499b840943516981aafa12448906399c8
+  metadata.gz: 5236e2be3cfd4c0d76d750b1cf8763549794d34ce485d269b65f28e86c264e1a
+  data.tar.gz: 2eca5ea736c10ded4bf560f2312c89122f2755e879fc9b4f3dabe68c45da8b5f
 SHA512:
-  metadata.gz: 9553cf289302a4b1c860e1a8b1939d565a4bb0da41b0bf9730f36f7b4bcef11aed20ea7564bdc4dda11cc187c90d71158ae2f1360b333ad6e4a8faef5613e43b
-  data.tar.gz: 77871bfd059aef79e463543a0681319fff73aa3ef40bba9bef364fd09b9b0734ea09689c4ac391ef75099001832067ed22cc634ca478c4092ab5988e14f22396
+  metadata.gz: 483f164eedf7a9ff9fa29cd607998493be1f611f400c4332f6b6d744788bc0b0b597a65f347fe0b51885117b202c6b546dfd5e7c415ba8a8059166302f259618
+  data.tar.gz: ec67429f2dc1d6c6807daef902ae95ae214e959b7e80d326b762946f506f61e132d3d8f59084d8819be03ea38a5b0b78e2d929c0665b4a49aef611e9e8af0aac

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.19.0 (2025-12-22)
+
+Full Changelog: [v0.18.0...v0.19.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.18.0...v0.19.0)
+
+### Features
+
+* **api:** manual updates ([eb518d4](https://github.com/brand-dot-dev/ruby-sdk/commit/eb518d4ef48fa91039cf54e2ccdc0b9261770268))
+
+
+### Bug Fixes
+
+* calling `break` out of streams should be instantaneous ([df6f134](https://github.com/brand-dot-dev/ruby-sdk/commit/df6f1348f710b76e3fe4d0b604bb1e98472143d6))
+* issue where json.parse errors when receiving HTTP 204 with nobody ([f041e46](https://github.com/brand-dot-dev/ruby-sdk/commit/f041e461d2fd1b711b63cd11a909a1b44e50247c))
+
 ## 0.18.0 (2025-12-14)
 
 Full Changelog: [v0.17.0...v0.18.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.17.0...v0.18.0)

data/README.md

@@ -17,7 +17,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.18.0"
+gem "brand.dev", "~> 0.19.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -153,17 +153,19 @@ module BrandDev
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure

data/lib/brand_dev/internal/util.rb

@@ -657,7 +657,8 @@ module BrandDev
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
           in BrandDev::Internal::Util::JSON_CONTENT
-            json = stream.to_a.join
+            return nil if (json = stream.to_a.join).empty?
+
             begin
               JSON.parse(json, symbolize_names: true)
             rescue JSON::ParserError => e
@@ -667,7 +668,11 @@ module BrandDev
           in BrandDev::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
-              lines.each { y << JSON.parse(_1, symbolize_names: true) }
+              lines.each do
+                next if _1.empty?
+
+                y << JSON.parse(_1, symbolize_names: true)
+              end
             end
           in %r{^text/event-stream}
             lines = decode_lines(stream)

data/lib/brand_dev/models/brand_prefetch_by_email_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#prefetch_by_email
+    class BrandPrefetchByEmailParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #   Email address to prefetch brand data for. The domain will be extracted from the
+      #   email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+      #   addresses are not allowed.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute timeout_ms
+      #   Optional timeout in milliseconds for the request. If the request takes longer
+      #   than this value, it will be aborted with a 408 status code. Maximum allowed
+      #   value is 300000ms (5 minutes).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer, api_name: :timeoutMS
+
+      # @!method initialize(email:, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandPrefetchByEmailParams} for more details.
+      #
+      #   @param email [String] Email address to prefetch brand data for. The domain will be extracted from the
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_prefetch_by_email_response.rb

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

data/lib/brand_dev/models.rb

@@ -45,6 +45,8 @@ module BrandDev
 
   BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchByEmailParams = BrandDev::Models::BrandPrefetchByEmailParams
+
   BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
 
   BrandRetrieveByEmailParams = BrandDev::Models::BrandRetrieveByEmailParams

data/lib/brand_dev/resources/brand.rb

@@ -166,6 +166,38 @@ module BrandDev
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandPrefetchByEmailParams} for more details.
+      #
+      # Signal that you may fetch brand data for a particular domain soon to improve
+      # latency. This endpoint accepts an email address, extracts the domain from it,
+      # validates that it's not a disposable or free email provider, and queues the
+      # domain for prefetching. 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_by_email(email:, timeout_ms: nil, request_options: {})
+      #
+      # @param email [String] Email address to prefetch brand data for. The domain will be extracted from the
+      #
+      # @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::BrandPrefetchByEmailResponse]
+      #
+      # @see BrandDev::Models::BrandPrefetchByEmailParams
+      def prefetch_by_email(params)
+        parsed, options = BrandDev::BrandPrefetchByEmailParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/prefetch-by-email",
+          body: parsed,
+          model: BrandDev::Models::BrandPrefetchByEmailResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {BrandDev::Models::BrandRetrieveByEmailParams} for more details.
       #

data/lib/brand_dev/version.rb

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

data/lib/brand_dev.rb

@@ -58,6 +58,8 @@ require_relative "brand_dev/models/brand_fonts_params"
 require_relative "brand_dev/models/brand_fonts_response"
 require_relative "brand_dev/models/brand_identify_from_transaction_params"
 require_relative "brand_dev/models/brand_identify_from_transaction_response"
+require_relative "brand_dev/models/brand_prefetch_by_email_params"
+require_relative "brand_dev/models/brand_prefetch_by_email_response"
 require_relative "brand_dev/models/brand_prefetch_params"
 require_relative "brand_dev/models/brand_prefetch_response"
 require_relative "brand_dev/models/brand_retrieve_by_email_params"

data/rbi/brand_dev/models/brand_prefetch_by_email_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchByEmailParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::BrandPrefetchByEmailParams,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Email address to prefetch brand data for. The domain will be extracted from the
+      # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+      # addresses are not allowed.
+      sig { returns(String) }
+      attr_accessor :email
+
+      # 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(
+          email: String,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address to prefetch brand data for. The domain will be extracted from the
+        # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+        # addresses are not allowed.
+        email:,
+        # 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(
+          {
+            email: String,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_prefetch_by_email_response.rbi

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

data/rbi/brand_dev/models.rbi

@@ -8,6 +8,8 @@ module BrandDev
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchByEmailParams = BrandDev::Models::BrandPrefetchByEmailParams
+
   BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
 
   BrandRetrieveByEmailParams = BrandDev::Models::BrandRetrieveByEmailParams

data/rbi/brand_dev/resources/brand.rbi

@@ -149,6 +149,32 @@ module BrandDev
       )
       end
 
+      # Signal that you may fetch brand data for a particular domain soon to improve
+      # latency. This endpoint accepts an email address, extracts the domain from it,
+      # validates that it's not a disposable or free email provider, and queues the
+      # domain for prefetching. This endpoint does not charge credits and is available
+      # for paid customers to optimize future requests. [You must be on a paid plan to
+      # use this endpoint]
+      sig do
+        params(
+          email: String,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandPrefetchByEmailResponse)
+      end
+      def prefetch_by_email(
+        # Email address to prefetch brand data for. The domain will be extracted from the
+        # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+        # addresses are not allowed.
+        email:,
+        # 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
+
       # Retrieve brand information using an email address while detecting disposable and
       # free email addresses. This endpoint extracts the domain from the email address
       # and returns brand data for that domain. Disposable and free email addresses

data/sig/brand_dev/models/brand_prefetch_by_email_params.rbs

@@ -0,0 +1,30 @@
+module BrandDev
+  module Models
+    type brand_prefetch_by_email_params =
+      { email: String, timeout_ms: Integer }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandPrefetchByEmailParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor email: String
+
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
+      def initialize: (
+        email: String,
+        ?timeout_ms: Integer,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        email: String,
+        timeout_ms: Integer,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/brand_dev/models/brand_prefetch_by_email_response.rbs

@@ -0,0 +1,28 @@
+module BrandDev
+  module Models
+    type brand_prefetch_by_email_response =
+      { domain: String, message: String, status: String }
+
+    class BrandPrefetchByEmailResponse < BrandDev::Internal::Type::BaseModel
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
+
+      attr_reader message: String?
+
+      def message=: (String) -> String
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      def initialize: (
+        ?domain: String,
+        ?message: String,
+        ?status: String
+      ) -> void
+
+      def to_hash: -> { domain: String, message: String, status: String }
+    end
+  end
+end

data/sig/brand_dev/models.rbs

@@ -5,6 +5,8 @@ module BrandDev
 
   class BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  class BrandPrefetchByEmailParams = BrandDev::Models::BrandPrefetchByEmailParams
+
   class BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
 
   class BrandRetrieveByEmailParams = BrandDev::Models::BrandRetrieveByEmailParams

data/sig/brand_dev/resources/brand.rbs

@@ -41,6 +41,12 @@ module BrandDev
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandPrefetchResponse
 
+      def prefetch_by_email: (
+        email: String,
+        ?timeout_ms: Integer,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::BrandPrefetchByEmailResponse
+
       def retrieve_by_email: (
         email: String,
         ?force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Brand Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-14 00:00:00.000000000 Z
+date: 2025-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -60,6 +60,8 @@ files:
 - lib/brand_dev/models/brand_fonts_response.rb
 - lib/brand_dev/models/brand_identify_from_transaction_params.rb
 - lib/brand_dev/models/brand_identify_from_transaction_response.rb
+- lib/brand_dev/models/brand_prefetch_by_email_params.rb
+- lib/brand_dev/models/brand_prefetch_by_email_response.rb
 - lib/brand_dev/models/brand_prefetch_params.rb
 - lib/brand_dev/models/brand_prefetch_response.rb
 - lib/brand_dev/models/brand_retrieve_by_email_params.rb
@@ -109,6 +111,8 @@ files:
 - rbi/brand_dev/models/brand_fonts_response.rbi
 - rbi/brand_dev/models/brand_identify_from_transaction_params.rbi
 - rbi/brand_dev/models/brand_identify_from_transaction_response.rbi
+- rbi/brand_dev/models/brand_prefetch_by_email_params.rbi
+- rbi/brand_dev/models/brand_prefetch_by_email_response.rbi
 - rbi/brand_dev/models/brand_prefetch_params.rbi
 - rbi/brand_dev/models/brand_prefetch_response.rbi
 - rbi/brand_dev/models/brand_retrieve_by_email_params.rbi
@@ -157,6 +161,8 @@ files:
 - sig/brand_dev/models/brand_fonts_response.rbs
 - sig/brand_dev/models/brand_identify_from_transaction_params.rbs
 - sig/brand_dev/models/brand_identify_from_transaction_response.rbs
+- sig/brand_dev/models/brand_prefetch_by_email_params.rbs
+- sig/brand_dev/models/brand_prefetch_by_email_response.rbs
 - sig/brand_dev/models/brand_prefetch_params.rbs
 - sig/brand_dev/models/brand_prefetch_response.rbs
 - sig/brand_dev/models/brand_retrieve_by_email_params.rbs