brand.dev 0.1.0.pre.alpha.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8489d32b9b6fab9c950ab137de8d3cd7a20deff639c8d7c276800ddfe3c0e0be
-  data.tar.gz: 129c18090fafd4cbff4e8dc593b6b7dee9f120c93a8658e192b65d7e6848a8de
+  metadata.gz: 824d292c41a48213239b6d735b4603e5e00e06e78993cf0ef687aa52222c9755
+  data.tar.gz: fd40a5b5cab29332c6a1a25654015f31230523e059646ce75be08696c0605fd8
 SHA512:
-  metadata.gz: 7023535ddb49dd527e5e63ce9ee57f7c7a84b83439f9360edab750246238159abfcd30e4805d14f097622dfee36267f556e571171756c9fdef68d18ddabdf933
-  data.tar.gz: 968d17e3084aa9a17b701f4d78c523a198731f1ed8f0d371e2dd3d0b51ac6778d7af963298d5d679356ef4894bc89996356ea265546a312d7f06db4f4d493afb
+  metadata.gz: 134eb59e2cf2b53012812e2d0028e488ecfae96cc0a0bd18e79f0042421fde9d121a0e90d152e6093947a538367e121d97e89b6c5264d5b3ece7b884d99154c6
+  data.tar.gz: 6dec3e7ad876474973f234021971eb5dd751ac87f638dbee58a95f9915e79c7099c2281b3583e9667c150894409de7edb7cdf72ef5ca9a2b9bdef461de9c3757

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## 0.1.0 (2025-07-29)
+
+Full Changelog: [v0.0.2...v0.1.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.0.2...v0.1.0)
+
+### Features
+
+* **api:** manual updates ([16b9bdc](https://github.com/brand-dot-dev/ruby-sdk/commit/16b9bdcdbcbac819a1120c93399195b102db34ed))
+
+
+### Bug Fixes
+
+* **internal:** ensure sorbet test always runs serially ([b780fe6](https://github.com/brand-dot-dev/ruby-sdk/commit/b780fe622148d3af2db69a59c16470ebf82b3702))
+
+
+### Chores
+
+* **internal:** version bump ([d7516ea](https://github.com/brand-dot-dev/ruby-sdk/commit/d7516ea2cf7f6c5b21236d90fca254a91476d5ad))
+* update contribute.md ([05a6bc4](https://github.com/brand-dot-dev/ruby-sdk/commit/05a6bc4264abb72f63d72ee43a0ba2fac7fd0511))
+
+## 0.0.2 (2025-07-21)
+
+Full Changelog: [v0.0.1...v0.0.2](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.0.1...v0.0.2)
+
+### Chores
+
+* **internal:** version bump ([c8553b7](https://github.com/brand-dot-dev/ruby-sdk/commit/c8553b728303284cda46b2a980743c5533932fdd))
+
+## 0.0.1 (2025-07-21)
+
+Full Changelog: [v0.1.0-alpha.13...v0.0.1](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.13...v0.0.1)
+
+### Features
+
+* **api:** manual updates ([cfaabba](https://github.com/brand-dot-dev/ruby-sdk/commit/cfaabbab93b68ba4926f78560d759d788e4b4b98))
+
+
+### Chores
+
+* **internal:** allow streams to also be unwrapped on a per-row basis ([99d7893](https://github.com/brand-dot-dev/ruby-sdk/commit/99d7893d01a3e111d49fb7c39e53bc9dd524f6b6))
+* **internal:** version bump ([d51ca58](https://github.com/brand-dot-dev/ruby-sdk/commit/d51ca5841eb432576fb2e251d4ebdab02cfb1ad7))
+
+## 0.1.0-alpha.13 (2025-06-29)
+
+Full Changelog: [v0.1.0-alpha.12...v0.1.0-alpha.13](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.12...v0.1.0-alpha.13)
+
+### Chores
+
+* **internal:** version bump ([20129a5](https://github.com/brand-dot-dev/ruby-sdk/commit/20129a56c65cbf2bbe2e6f15ea146213a0b41aa0))
+
 ## 0.1.0-alpha.12 (2025-06-29)
 
 Full Changelog: [v0.1.0-alpha.11...v0.1.0-alpha.12](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.11...v0.1.0-alpha.12)

data/README.md

@@ -15,7 +15,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.1.0.pre.alpha.12"
+gem "brand.dev", "~> 0.1.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -471,6 +471,7 @@ module BrandDev
           self.class.validate!(req)
           model = req.fetch(:model) { BrandDev::Internal::Type::Unknown }
           opts = req[:options].to_h
+          unwrap = req[:unwrap]
           BrandDev::RequestOptions.validate!(opts)
           request = build_request(req.except(:options), opts)
           url = request.fetch(:url)
@@ -487,11 +488,18 @@ module BrandDev
           decoded = BrandDev::Internal::Util.decode_content(response, stream: stream)
           case req
           in {stream: Class => st}
-            st.new(model: model, url: url, status: status, response: response, stream: decoded)
+            st.new(
+              model: model,
+              url: url,
+              status: status,
+              response: response,
+              unwrap: unwrap,
+              stream: decoded
+            )
           in {page: Class => page}
             page.new(client: self, req: req, headers: response, page_data: decoded)
           else
-            unwrapped = BrandDev::Internal::Util.dig(decoded, req[:unwrap])
+            unwrapped = BrandDev::Internal::Util.dig(decoded, unwrap)
             BrandDev::Internal::Type::Converter.coerce(model, unwrapped)
           end
         end

data/lib/brand_dev/models/brand_ai_query_response.rb

@@ -4,6 +4,12 @@ module BrandDev
   module Models
     # @see BrandDev::Resources::Brand#ai_query
     class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute code
+      #   HTTP status code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
       # @!attribute data_extracted
       #   Array of extracted data points
       #
@@ -17,17 +23,27 @@ module BrandDev
       #   @return [String, nil]
       optional :domain, String
 
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
       # @!attribute urls_analyzed
       #   List of URLs that were analyzed
       #
       #   @return [Array<String>, nil]
       optional :urls_analyzed, BrandDev::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(data_extracted: nil, domain: nil, urls_analyzed: nil)
+      # @!method initialize(code: nil, data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil)
+      #   @param code [Integer] HTTP status code
+      #
       #   @param data_extracted [Array<BrandDev::Models::BrandAIQueryResponse::DataExtracted>] Array of extracted data points
       #
       #   @param domain [String] The domain that was analyzed
       #
+      #   @param status [String] Status of the response, e.g., 'ok'
+      #
       #   @param urls_analyzed [Array<String>] List of URLs that were analyzed
 
       class DataExtracted < BrandDev::Internal::Type::BaseModel

data/lib/brand_dev/models/brand_identify_from_transaction_response.rb

@@ -63,12 +63,11 @@ module BrandDev
         #   @return [String, nil]
         optional :domain, String
 
-        # @!attribute fonts
-        #   An array of fonts used by the brand's website
+        # @!attribute is_nsfw
+        #   Indicates whether the brand content is not safe for work (NSFW)
         #
-        #   @return [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font>, nil]
-        optional :fonts,
-                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font] }
+        #   @return [Boolean, nil]
+        optional :is_nsfw, BrandDev::Internal::Type::Boolean
 
         # @!attribute logos
         #   An array of logos associated with the brand
@@ -103,7 +102,7 @@ module BrandDev
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
+        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, is_nsfw: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
         #   Some parameter documentations has been truncated, see
         #   {BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand} for more
         #   details.
@@ -120,7 +119,7 @@ module BrandDev
         #
         #   @param domain [String] The domain name of the brand
         #
-        #   @param fonts [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font>] An array of fonts used by the brand's website
+        #   @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
         #
         #   @param logos [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo>] An array of logos associated with the brand
         #
@@ -283,25 +282,6 @@ module BrandDev
           #   @param name [String] Name of the color
         end
 
-        class Font < BrandDev::Internal::Type::BaseModel
-          # @!attribute name
-          #   Name of the font
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute usage
-          #   Usage of the font, e.g., 'title', 'body', 'button'
-          #
-          #   @return [String, nil]
-          optional :usage, String
-
-          # @!method initialize(name: nil, usage: nil)
-          #   @param name [String] Name of the font
-          #
-          #   @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
-        end
-
         class Logo < BrandDev::Internal::Type::BaseModel
           # @!attribute colors
           #   Array of colors in the logo

data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb

@@ -63,12 +63,11 @@ module BrandDev
         #   @return [String, nil]
         optional :domain, String
 
-        # @!attribute fonts
-        #   An array of fonts used by the brand's website
+        # @!attribute is_nsfw
+        #   Indicates whether the brand content is not safe for work (NSFW)
         #
-        #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font>, nil]
-        optional :fonts,
-                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font] }
+        #   @return [Boolean, nil]
+        optional :is_nsfw, BrandDev::Internal::Type::Boolean
 
         # @!attribute logos
         #   An array of logos associated with the brand
@@ -103,7 +102,7 @@ module BrandDev
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
+        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, is_nsfw: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
         #   Some parameter documentations has been truncated, see
         #   {BrandDev::Models::BrandRetrieveByTickerResponse::Brand} for more details.
         #
@@ -119,7 +118,7 @@ module BrandDev
         #
         #   @param domain [String] The domain name of the brand
         #
-        #   @param fonts [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font>] An array of fonts used by the brand's website
+        #   @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
         #
         #   @param logos [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo>] An array of logos associated with the brand
         #
@@ -281,25 +280,6 @@ module BrandDev
           #   @param name [String] Name of the color
         end
 
-        class Font < BrandDev::Internal::Type::BaseModel
-          # @!attribute name
-          #   Name of the font
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute usage
-          #   Usage of the font, e.g., 'title', 'body', 'button'
-          #
-          #   @return [String, nil]
-          optional :usage, String
-
-          # @!method initialize(name: nil, usage: nil)
-          #   @param name [String] Name of the font
-          #
-          #   @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
-        end
-
         class Logo < BrandDev::Internal::Type::BaseModel
           # @!attribute colors
           #   Array of colors in the logo

data/lib/brand_dev/models/brand_retrieve_response.rb

@@ -63,13 +63,11 @@ module BrandDev
         #   @return [String, nil]
         optional :domain, String
 
-        # @!attribute fonts
-        #   An array of fonts used by the brand's website. NOTE: This is deprecated and will
-        #   be removed in the future. Please migrate to the styleguide API.
+        # @!attribute is_nsfw
+        #   Indicates whether the brand content is not safe for work (NSFW)
         #
-        #   @return [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Font>, nil]
-        optional :fonts,
-                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Font] }
+        #   @return [Boolean, nil]
+        optional :is_nsfw, BrandDev::Internal::Type::Boolean
 
         # @!attribute logos
         #   An array of logos associated with the brand
@@ -104,7 +102,7 @@ module BrandDev
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
+        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, is_nsfw: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
         #   Some parameter documentations has been truncated, see
         #   {BrandDev::Models::BrandRetrieveResponse::Brand} for more details.
         #
@@ -120,7 +118,7 @@ module BrandDev
         #
         #   @param domain [String] The domain name of the brand
         #
-        #   @param fonts [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Font>] An array of fonts used by the brand's website. NOTE: This is deprecated and will
+        #   @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
         #
         #   @param logos [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo>] An array of logos associated with the brand
         #
@@ -282,25 +280,6 @@ module BrandDev
           #   @param name [String] Name of the color
         end
 
-        class Font < BrandDev::Internal::Type::BaseModel
-          # @!attribute name
-          #   Name of the font
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute usage
-          #   Usage of the font, e.g., 'title', 'body', 'button'
-          #
-          #   @return [String, nil]
-          optional :usage, String
-
-          # @!method initialize(name: nil, usage: nil)
-          #   @param name [String] Name of the font
-          #
-          #   @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
-        end
-
         class Logo < BrandDev::Internal::Type::BaseModel
           # @!attribute colors
           #   Array of colors in the logo

data/lib/brand_dev/models.rb

@@ -55,7 +55,5 @@ module BrandDev
 
   BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
 
-  BrandSearchParams = BrandDev::Models::BrandSearchParams
-
   BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
 end

data/lib/brand_dev/resources/brand.rb

@@ -237,33 +237,6 @@ module BrandDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {BrandDev::Models::BrandSearchParams} for more details.
-      #
-      # Search brands by query
-      #
-      # @overload search(query:, timeout_ms: nil, request_options: {})
-      #
-      # @param query [String] Query string to search brands
-      #
-      # @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 [Array<BrandDev::Models::BrandSearchResponseItem>]
-      #
-      # @see BrandDev::Models::BrandSearchParams
-      def search(params)
-        parsed, options = BrandDev::BrandSearchParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "brand/search",
-          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
-          model: BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandSearchResponseItem],
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {BrandDev::Models::BrandStyleguideParams} for more details.
       #

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.1.0.pre.alpha.12"
+  VERSION = "0.1.0"
 end

data/lib/brand_dev.rb

@@ -66,8 +66,6 @@ require_relative "brand_dev/models/brand_retrieve_simplified_params"
 require_relative "brand_dev/models/brand_retrieve_simplified_response"
 require_relative "brand_dev/models/brand_screenshot_params"
 require_relative "brand_dev/models/brand_screenshot_response"
-require_relative "brand_dev/models/brand_search_params"
-require_relative "brand_dev/models/brand_search_response"
 require_relative "brand_dev/models/brand_styleguide_params"
 require_relative "brand_dev/models/brand_styleguide_response"
 require_relative "brand_dev/models"

data/rbi/brand_dev/models/brand_ai_query_response.rbi

@@ -11,6 +11,13 @@ module BrandDev
           )
         end
 
+      # HTTP status code
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :code
+
+      sig { params(code: Integer).void }
+      attr_writer :code
+
       # Array of extracted data points
       sig do
         returns(
@@ -38,6 +45,13 @@ module BrandDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # Status of the response, e.g., 'ok'
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
       # List of URLs that were analyzed
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :urls_analyzed
@@ -47,19 +61,25 @@ module BrandDev
 
       sig do
         params(
+          code: Integer,
           data_extracted:
             T::Array[
               BrandDev::Models::BrandAIQueryResponse::DataExtracted::OrHash
             ],
           domain: String,
+          status: String,
           urls_analyzed: T::Array[String]
         ).returns(T.attached_class)
       end
       def self.new(
+        # HTTP status code
+        code: nil,
         # Array of extracted data points
         data_extracted: nil,
         # The domain that was analyzed
         domain: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil,
         # List of URLs that were analyzed
         urls_analyzed: nil
       )
@@ -68,9 +88,11 @@ module BrandDev
       sig do
         override.returns(
           {
+            code: Integer,
             data_extracted:
               T::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted],
             domain: String,
+            status: String,
             urls_analyzed: T::Array[String]
           }
         )

data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi

@@ -159,27 +159,12 @@ module BrandDev
         sig { params(domain: String).void }
         attr_writer :domain
 
-        # An array of fonts used by the brand's website
-        sig do
-          returns(
-            T.nilable(
-              T::Array[
-                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font
-              ]
-            )
-          )
-        end
-        attr_reader :fonts
+        # Indicates whether the brand content is not safe for work (NSFW)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_nsfw
 
-        sig do
-          params(
-            fonts:
-              T::Array[
-                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font::OrHash
-              ]
-          ).void
-        end
-        attr_writer :fonts
+        sig { params(is_nsfw: T::Boolean).void }
+        attr_writer :is_nsfw
 
         # An array of logos associated with the brand
         sig do
@@ -273,10 +258,7 @@ module BrandDev
               ],
             description: String,
             domain: String,
-            fonts:
-              T::Array[
-                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font::OrHash
-              ],
+            is_nsfw: T::Boolean,
             logos:
               T::Array[
                 BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::OrHash
@@ -302,8 +284,8 @@ module BrandDev
           description: nil,
           # The domain name of the brand
           domain: nil,
-          # An array of fonts used by the brand's website
-          fonts: nil,
+          # Indicates whether the brand content is not safe for work (NSFW)
+          is_nsfw: nil,
           # An array of logos associated with the brand
           logos: nil,
           # The brand's slogan
@@ -333,10 +315,7 @@ module BrandDev
                 ],
               description: String,
               domain: String,
-              fonts:
-                T::Array[
-                  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font
-                ],
+              is_nsfw: T::Boolean,
               logos:
                 T::Array[
                   BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo
@@ -668,43 +647,6 @@ module BrandDev
           end
         end
 
-        class Font < BrandDev::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font,
-                BrandDev::Internal::AnyHash
-              )
-            end
-
-          # Name of the font
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
-
-          # Usage of the font, e.g., 'title', 'body', 'button'
-          sig { returns(T.nilable(String)) }
-          attr_reader :usage
-
-          sig { params(usage: String).void }
-          attr_writer :usage
-
-          sig { params(name: String, usage: String).returns(T.attached_class) }
-          def self.new(
-            # Name of the font
-            name: nil,
-            # Usage of the font, e.g., 'title', 'body', 'button'
-            usage: nil
-          )
-          end
-
-          sig { override.returns({ name: String, usage: String }) }
-          def to_hash
-          end
-        end
-
         class Logo < BrandDev::Internal::Type::BaseModel
           OrHash =
             T.type_alias do