brand.dev 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da2f382bfc60d07b03395142e31176eb88b2640e8a5eb2aa6f83156464d409ae
-  data.tar.gz: e8f182c0ae6057bce6ad230ccb2e36a6dfec2c1723e5135a2e5ada98841d7f28
+  metadata.gz: 352acbb6668a328d87a316a4dba30616f02c7d1d7fcf472df6bb0109d9befdb1
+  data.tar.gz: 155f0018fd308c55dead3ef2ea0850085d21ded6920a9ae9c2f9229a2a527cd3
 SHA512:
-  metadata.gz: d7d6d1ffebf9c3cf4e7c5e1a2ff28278fde05b607679987c0d91ca6d0809919bdae6deb4ff39abda7e4f87dfaec83505f6cd4948632fab18e45ee711a5946a1c
-  data.tar.gz: 958e744b9d622e3c0f36f4cac53681a8bb85f3a4090b2e827b9e15d9b53f71cca873b916fda66a9eb931bb9626ced4f9314be30740d087b0aa32040c359066ae
+  metadata.gz: 1f0a1068ce78f873ff484541d3a482de10824e093a4e70ee4df02804e3be6e02d2b5850bece4540b5519e92cd365af87a93b05d2b6fce9d315131d0fce525c02
+  data.tar.gz: e91395f9bb9671f7346e2e3dc0cc5d1e5a6a3b86ff28bd6eba0d03d3e8e546acce9dc8dc43b629f9fd7dc6dd9ea39503e64a3d29202e92bc3bbd3de049268aa1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([cbe6c73](https://github.com/brand-dot-dev/ruby-sdk/commit/cbe6c7376d1fb53af66e31c6154edd684722e712))
+
 ## 0.26.0 (2026-02-23)
 
 Full Changelog: [v0.25.0...v0.26.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.25.0...v0.26.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.26.0"
+gem "brand.dev", "~> 0.27.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/brand_dev/models/brand_styleguide_params.rb

@@ -7,12 +7,19 @@ module BrandDev
       extend BrandDev::Internal::Type::RequestParameters::Converter
       include BrandDev::Internal::Type::RequestParameters
 
+      # @!attribute direct_url
+      #   A specific URL to fetch the styleguide from directly, bypassing domain
+      #   resolution (e.g., 'https://example.com/design-system').
+      #
+      #   @return [String, nil]
+      optional :direct_url, String
+
       # @!attribute domain
       #   Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #   domain will be automatically normalized and validated.
       #
-      #   @return [String]
-      required :domain, String
+      #   @return [String, nil]
+      optional :domain, String
 
       # @!attribute prioritize
       #   Optional parameter to prioritize screenshot capture for styleguide extraction.
@@ -31,10 +38,12 @@ module BrandDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(domain:, prioritize: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandStyleguideParams} for more details.
       #
+      #   @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
+      #
       #   @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #
       #   @param prioritize [Symbol, BrandDev::Models::BrandStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I

data/lib/brand_dev/resources/brand.rb

@@ -496,8 +496,12 @@ module BrandDev
       #
       # Automatically extract comprehensive design system information from a brand's
       # website including colors, typography, spacing, shadows, and UI components.
+      # Either 'domain' or 'directUrl' must be provided as a query parameter, but not
+      # both.
       #
-      # @overload styleguide(domain:, prioritize: nil, timeout_ms: nil, request_options: {})
+      # @overload styleguide(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {})
+      #
+      # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
       #
       # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #
@@ -510,12 +514,12 @@ module BrandDev
       # @return [BrandDev::Models::BrandStyleguideResponse]
       #
       # @see BrandDev::Models::BrandStyleguideParams
-      def styleguide(params)
+      def styleguide(params = {})
         parsed, options = BrandDev::BrandStyleguideParams.dump_request(params)
         @client.request(
           method: :get,
           path: "brand/styleguide",
-          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
+          query: parsed.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"),
           model: BrandDev::Models::BrandStyleguideResponse,
           options: options
         )

data/lib/brand_dev/version.rb

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

data/rbi/brand_dev/models/brand_styleguide_params.rbi

@@ -11,10 +11,21 @@ module BrandDev
           T.any(BrandDev::BrandStyleguideParams, BrandDev::Internal::AnyHash)
         end
 
+      # A specific URL to fetch the styleguide from directly, bypassing domain
+      # resolution (e.g., 'https://example.com/design-system').
+      sig { returns(T.nilable(String)) }
+      attr_reader :direct_url
+
+      sig { params(direct_url: String).void }
+      attr_writer :direct_url
+
       # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       # domain will be automatically normalized and validated.
-      sig { returns(String) }
-      attr_accessor :domain
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
 
       # Optional parameter to prioritize screenshot capture for styleguide extraction.
       # If 'speed', optimizes for faster capture with basic quality. If 'quality',
@@ -45,6 +56,7 @@ module BrandDev
 
       sig do
         params(
+          direct_url: String,
           domain: String,
           prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
           timeout_ms: Integer,
@@ -52,9 +64,12 @@ module BrandDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # A specific URL to fetch the styleguide from directly, bypassing domain
+        # resolution (e.g., 'https://example.com/design-system').
+        direct_url: nil,
         # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated.
-        domain:,
+        domain: nil,
         # Optional parameter to prioritize screenshot capture for styleguide extraction.
         # If 'speed', optimizes for faster capture with basic quality. If 'quality',
         # optimizes for higher quality with longer wait times. Defaults to 'quality' if
@@ -71,6 +86,7 @@ module BrandDev
       sig do
         override.returns(
           {
+            direct_url: String,
             domain: String,
             prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
             timeout_ms: Integer,

data/rbi/brand_dev/resources/brand.rbi

@@ -437,8 +437,11 @@ module BrandDev
 
       # Automatically extract comprehensive design system information from a brand's
       # website including colors, typography, spacing, shadows, and UI components.
+      # Either 'domain' or 'directUrl' must be provided as a query parameter, but not
+      # both.
       sig do
         params(
+          direct_url: String,
           domain: String,
           prioritize: BrandDev::BrandStyleguideParams::Prioritize::OrSymbol,
           timeout_ms: Integer,
@@ -446,9 +449,12 @@ module BrandDev
         ).returns(BrandDev::Models::BrandStyleguideResponse)
       end
       def styleguide(
+        # A specific URL to fetch the styleguide from directly, bypassing domain
+        # resolution (e.g., 'https://example.com/design-system').
+        direct_url: nil,
         # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
         # domain will be automatically normalized and validated.
-        domain:,
+        domain: nil,
         # Optional parameter to prioritize screenshot capture for styleguide extraction.
         # If 'speed', optimizes for faster capture with basic quality. If 'quality',
         # optimizes for higher quality with longer wait times. Defaults to 'quality' if

data/sig/brand_dev/models/brand_styleguide_params.rbs

@@ -2,6 +2,7 @@ module BrandDev
   module Models
     type brand_styleguide_params =
       {
+        direct_url: String,
         domain: String,
         prioritize: BrandDev::Models::BrandStyleguideParams::prioritize,
         timeout_ms: Integer
@@ -12,7 +13,13 @@ module BrandDev
       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 prioritize: BrandDev::Models::BrandStyleguideParams::prioritize?
 
@@ -25,13 +32,15 @@ module BrandDev
       def timeout_ms=: (Integer) -> Integer
 
       def initialize: (
-        domain: String,
+        ?direct_url: String,
+        ?domain: String,
         ?prioritize: BrandDev::Models::BrandStyleguideParams::prioritize,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
+        direct_url: String,
         domain: String,
         prioritize: BrandDev::Models::BrandStyleguideParams::prioritize,
         timeout_ms: Integer,

data/sig/brand_dev/resources/brand.rbs

@@ -117,7 +117,8 @@ module BrandDev
       ) -> BrandDev::Models::BrandScreenshotResponse
 
       def styleguide: (
-        domain: String,
+        ?direct_url: String,
+        ?domain: String,
         ?prioritize: BrandDev::Models::BrandStyleguideParams::prioritize,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts

metadata

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