brand.dev 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d8d59aa62a298e531e77537f0438264b92262f8a1d6e2c85ed2f65855287586
-  data.tar.gz: 77fb50c2084d67c77d21b6eb6a7ec79499b840943516981aafa12448906399c8
+  metadata.gz: be4fa887e23eb9143aaf2472d22397b99b414cb4ff93540d2ea3da5fbae0cfa3
+  data.tar.gz: 1c923c23ca8386e90fefe684df20b6ece1cc9455bcc9fec14d1f7cdb221cb100
 SHA512:
-  metadata.gz: 9553cf289302a4b1c860e1a8b1939d565a4bb0da41b0bf9730f36f7b4bcef11aed20ea7564bdc4dda11cc187c90d71158ae2f1360b333ad6e4a8faef5613e43b
-  data.tar.gz: 77871bfd059aef79e463543a0681319fff73aa3ef40bba9bef364fd09b9b0734ea09689c4ac391ef75099001832067ed22cc634ca478c4092ab5988e14f22396
+  metadata.gz: ac2de9483c9ed519557f9fcff0e2ea5041c938d8fd313a934332321d79133d25081c648bad90e320ed22a09a53faada008b3dae7cf023713350382cf8289ec28
+  data.tar.gz: f82183b8ff1d77f93834c0b4cbcb100ffd3ec1fcfa2ae08f5a3d6f2fc37b8f86933c423e2b5130a1f9319313404a336ac3cc7c4855b3f788e91d971fd3fb669f

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([0e16540](https://github.com/brand-dot-dev/ruby-sdk/commit/0e1654086ce29b4db61d42d680f5c837723200c8))
+* **api:** api update ([25e7a5a](https://github.com/brand-dot-dev/ruby-sdk/commit/25e7a5a8d67e1a1f6d12ea45c9e5f8c3d0172419))
+* **api:** manual updates ([58d3d58](https://github.com/brand-dot-dev/ruby-sdk/commit/58d3d58d2f482c0b7e173dd3c1805c09af80a2c8))
+
+## 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.20.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_ai_products_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#ai_products
+    class BrandAIProductsParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!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. 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:, 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 max_products [Integer] Maximum number of products to extract.
+      #
+      #   @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_ai_products_response.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#ai_products
+    class BrandAIProductsResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute products
+      #   Array of products extracted from the website
+      #
+      #   @return [Array<BrandDev::Models::BrandAIProductsResponse::Product>, nil]
+      optional :products,
+               -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandAIProductsResponse::Product] }
+
+      # @!method initialize(products: nil)
+      #   @param products [Array<BrandDev::Models::BrandAIProductsResponse::Product>] Array of products extracted from the website
+
+      class Product < BrandDev::Internal::Type::BaseModel
+        # @!attribute description
+        #   Description of the product
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute features
+        #   List of product features
+        #
+        #   @return [Array<String>]
+        required :features, BrandDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute name
+        #   Name of the product
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute tags
+        #   Tags associated with the product
+        #
+        #   @return [Array<String>]
+        required :tags, BrandDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute target_audience
+        #   Target audience for the product (array of strings)
+        #
+        #   @return [Array<String>]
+        required :target_audience, BrandDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute billing_frequency
+        #   Billing frequency for the product
+        #
+        #   @return [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency, nil]
+        optional :billing_frequency,
+                 enum: -> { BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency },
+                 nil?: true
+
+        # @!attribute category
+        #   Category of the product
+        #
+        #   @return [String, nil]
+        optional :category, String, nil?: true
+
+        # @!attribute currency
+        #   Currency code for the price (e.g., USD, EUR)
+        #
+        #   @return [String, nil]
+        optional :currency, String, nil?: true
+
+        # @!attribute image_url
+        #   URL to the product image
+        #
+        #   @return [String, nil]
+        optional :image_url, String, nil?: true
+
+        # @!attribute price
+        #   Price of the product
+        #
+        #   @return [Float, nil]
+        optional :price, Float, nil?: true
+
+        # @!attribute pricing_model
+        #   Pricing model for the product
+        #
+        #   @return [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::PricingModel, nil]
+        optional :pricing_model,
+                 enum: -> { BrandDev::Models::BrandAIProductsResponse::Product::PricingModel },
+                 nil?: true
+
+        # @!attribute url
+        #   URL to the product page
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(description:, features:, name:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil)
+        #   @param description [String] Description of the product
+        #
+        #   @param features [Array<String>] List of product features
+        #
+        #   @param name [String] Name of the product
+        #
+        #   @param tags [Array<String>] Tags associated with the product
+        #
+        #   @param target_audience [Array<String>] Target audience for the product (array of strings)
+        #
+        #   @param billing_frequency [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency, nil] Billing frequency for the product
+        #
+        #   @param category [String, nil] Category of the product
+        #
+        #   @param currency [String, nil] Currency code for the price (e.g., USD, EUR)
+        #
+        #   @param image_url [String, nil] URL to the product image
+        #
+        #   @param price [Float, nil] Price of the product
+        #
+        #   @param pricing_model [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::PricingModel, nil] Pricing model for the product
+        #
+        #   @param url [String, nil] URL to the product page
+
+        # Billing frequency for the product
+        #
+        # @see BrandDev::Models::BrandAIProductsResponse::Product#billing_frequency
+        module BillingFrequency
+          extend BrandDev::Internal::Type::Enum
+
+          MONTHLY = :monthly
+          YEARLY = :yearly
+          ONE_TIME = :one_time
+          USAGE_BASED = :usage_based
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Pricing model for the product
+        #
+        # @see BrandDev::Models::BrandAIProductsResponse::Product#pricing_model
+        module PricingModel
+          extend BrandDev::Internal::Type::Enum
+
+          PER_SEAT = :per_seat
+          FLAT = :flat
+          TIERED = :tiered
+          FREEMIUM = :freemium
+          CUSTOM = :custom
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -39,12 +39,16 @@ module BrandDev
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  BrandAIProductsParams = BrandDev::Models::BrandAIProductsParams
+
   BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams
 
   BrandFontsParams = BrandDev::Models::BrandFontsParams
 
   BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchByEmailParams = BrandDev::Models::BrandPrefetchByEmailParams
+
   BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
 
   BrandRetrieveByEmailParams = BrandDev::Models::BrandRetrieveByEmailParams

data/lib/brand_dev/resources/brand.rb

@@ -35,12 +35,43 @@ 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:, max_products: nil, timeout_ms: nil, request_options: {})
+      #
+      # @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. If the request takes longer th
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandAIProductsResponse]
+      #
+      # @see BrandDev::Models::BrandAIProductsParams
+      def ai_products(params)
+        parsed, options = BrandDev::BrandAIProductsParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/ai/products",
+          body: parsed,
+          model: BrandDev::Models::BrandAIProductsResponse,
+          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.
+      # 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, timeout_ms: nil, request_options: {})
       #
@@ -71,8 +102,8 @@ module BrandDev
       # Some parameter documentations has been truncated, see
       # {BrandDev::Models::BrandFontsParams} for more details.
       #
-      # Beta feature: Extract font information from a brand's website including font
-      # families, usage statistics, fallbacks, and element/word counts.
+      # Extract font information from a brand's website including font families, usage
+      # statistics, fallbacks, and element/word counts.
       #
       # @overload fonts(domain:, timeout_ms: nil, request_options: {})
       #
@@ -166,6 +197,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.
       #
@@ -366,10 +429,10 @@ module BrandDev
       # Some parameter documentations has been truncated, see
       # {BrandDev::Models::BrandScreenshotParams} for more details.
       #
-      # Beta feature: Capture a screenshot of a website. Supports both viewport
-      # (standard browser view) and full-page screenshots. Can also screenshot specific
-      # page types (login, pricing, etc.) by using heuristics to find the appropriate
-      # URL. Returns a URL to the uploaded screenshot image hosted on our CDN.
+      # Capture a screenshot of a website. Supports both viewport (standard browser
+      # view) and full-page screenshots. Can also screenshot specific page types (login,
+      # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to
+      # the uploaded screenshot image hosted on our CDN.
       #
       # @overload screenshot(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {})
       #
@@ -400,9 +463,8 @@ module BrandDev
       # Some parameter documentations has been truncated, see
       # {BrandDev::Models::BrandStyleguideParams} for more details.
       #
-      # Beta feature: Automatically extract comprehensive design system information from
-      # a brand's website including colors, typography, spacing, shadows, and UI
-      # components.
+      # Automatically extract comprehensive design system information from a brand's
+      # website including colors, typography, spacing, shadows, and UI components.
       #
       # @overload styleguide(domain:, prioritize: nil, timeout_ms: nil, request_options: {})
       #

data/lib/brand_dev/version.rb

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

data/lib/brand_dev.rb

@@ -52,12 +52,16 @@ require_relative "brand_dev/errors"
 require_relative "brand_dev/internal/transport/base_client"
 require_relative "brand_dev/internal/transport/pooled_net_requester"
 require_relative "brand_dev/client"
+require_relative "brand_dev/models/brand_ai_products_params"
+require_relative "brand_dev/models/brand_ai_products_response"
 require_relative "brand_dev/models/brand_ai_query_params"
 require_relative "brand_dev/models/brand_ai_query_response"
 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_ai_products_params.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandAIProductsParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          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. 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,
+          max_products: Integer,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).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. 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,
+            max_products: Integer,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end