brand.dev 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf8dd90507c84dcea927392291711080cc1dff713f6033bb87f974573f66417
-  data.tar.gz: dab13e3371525060dcf6a098cc9d75faba070512dd62aca367addff096cfab1f
+  metadata.gz: 4d8d59aa62a298e531e77537f0438264b92262f8a1d6e2c85ed2f65855287586
+  data.tar.gz: 77fb50c2084d67c77d21b6eb6a7ec79499b840943516981aafa12448906399c8
 SHA512:
-  metadata.gz: 48199f00792a5f903f0ebb82179675614a0e3f0a68e75b7e03adc7f26cb061b4a44f704b4afcfa6400caf5c539b62c10e2b89120740d3faf661a7e57fe3525db
-  data.tar.gz: ad14e379feafc54eb6989a0fb16c9b37d1eb29424566344f6b0c442921eeafbaf92826d7a5ef5e3f5e4c5acd04749c4700de34be20336965c3d9653671ebb36f
+  metadata.gz: 9553cf289302a4b1c860e1a8b1939d565a4bb0da41b0bf9730f36f7b4bcef11aed20ea7564bdc4dda11cc187c90d71158ae2f1360b333ad6e4a8faef5613e43b
+  data.tar.gz: 77871bfd059aef79e463543a0681319fff73aa3ef40bba9bef364fd09b9b0734ea09689c4ac391ef75099001832067ed22cc634ca478c4092ab5988e14f22396

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([25b73b8](https://github.com/brand-dot-dev/ruby-sdk/commit/25b73b89b739804f3dbb1d189fbde0351184dcaa))
+
+## 0.17.0 (2025-12-11)
+
+Full Changelog: [v0.16.0...v0.17.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.16.0...v0.17.0)
+
+### Features
+
+* **api:** api update ([b4c9da1](https://github.com/brand-dot-dev/ruby-sdk/commit/b4c9da15f5563e5e945d4bbc557fa2f5085c9aef))
+
 ## 0.16.0 (2025-12-01)
 
 Full Changelog: [v0.15.0...v0.16.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.15.0...v0.16.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.16.0"
+gem "brand.dev", "~> 0.18.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/brand_dev/models/brand_identify_from_transaction_params.rb

@@ -47,6 +47,12 @@ module BrandDev
       #   @return [String, nil]
       optional :mcc, String
 
+      # @!attribute phone
+      #   Optional phone number from the transaction to help verify brand match.
+      #
+      #   @return [Float, nil]
+      optional :phone, Float
+
       # @!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
@@ -55,7 +61,7 @@ module BrandDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandIdentifyFromTransactionParams} for more details.
       #
@@ -71,6 +77,8 @@ module BrandDev
       #
       #   @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
       #
+      #   @param phone [Float] Optional phone number from the transaction to help verify brand match.
+      #
       #   @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}]

data/lib/brand_dev/models/brand_retrieve_naics_params.rb

@@ -15,6 +15,19 @@ module BrandDev
       #   @return [String]
       required :input, String
 
+      # @!attribute max_results
+      #   Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
+      #   to 5.
+      #
+      #   @return [Integer, nil]
+      optional :max_results, Integer
+
+      # @!attribute min_results
+      #   Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      #
+      #   @return [Integer, nil]
+      optional :min_results, Integer
+
       # @!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
@@ -23,12 +36,16 @@ module BrandDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer
 
-      # @!method initialize(input:, timeout_ms: nil, request_options: {})
+      # @!method initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {BrandDev::Models::BrandRetrieveNaicsParams} for more details.
       #
       #   @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
       #
+      #   @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5
+      #
+      #   @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      #
       #   @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}]

data/lib/brand_dev/models/brand_retrieve_naics_response.rb

@@ -42,19 +42,41 @@ module BrandDev
         # @!attribute code
         #   NAICS code
         #
-        #   @return [String, nil]
-        optional :code, String
+        #   @return [String]
+        required :code, String
 
-        # @!attribute title
+        # @!attribute confidence
+        #   Confidence level for how well this NAICS code matches the company description
+        #
+        #   @return [Symbol, BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence]
+        required :confidence, enum: -> { BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence }
+
+        # @!attribute name
         #   NAICS title
         #
-        #   @return [String, nil]
-        optional :title, String
+        #   @return [String]
+        required :name, String
 
-        # @!method initialize(code: nil, title: nil)
+        # @!method initialize(code:, confidence:, name:)
         #   @param code [String] NAICS code
         #
-        #   @param title [String] NAICS title
+        #   @param confidence [Symbol, BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence] Confidence level for how well this NAICS code matches the company description
+        #
+        #   @param name [String] NAICS title
+
+        # Confidence level for how well this NAICS code matches the company description
+        #
+        # @see BrandDev::Models::BrandRetrieveNaicsResponse::Code#confidence
+        module Confidence
+          extend BrandDev::Internal::Type::Enum
+
+          HIGH = :high
+          MEDIUM = :medium
+          LOW = :low
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/brand_dev/resources/brand.rb

@@ -102,7 +102,7 @@ module BrandDev
       # Endpoint specially designed for platforms that want to identify transaction data
       # by the transaction title.
       #
-      # @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, timeout_ms: nil, request_options: {})
+      # @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
       #
       # @param transaction_info [String] Transaction information to identify the brand
       #
@@ -116,6 +116,8 @@ module BrandDev
       #
       # @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
       #
+      # @param phone [Float] Optional phone number from the transaction to help verify brand match.
+      #
       # @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]
@@ -302,10 +304,14 @@ module BrandDev
       #
       # Endpoint to classify any brand into a 2022 NAICS code.
       #
-      # @overload retrieve_naics(input:, timeout_ms: nil, request_options: {})
+      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
       #
+      # @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5
+      #
+      # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      #
       # @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]
@@ -318,7 +324,11 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/naics",
-          query: parsed.transform_keys(timeout_ms: "timeoutMS"),
+          query: parsed.transform_keys(
+            max_results: "maxResults",
+            min_results: "minResults",
+            timeout_ms: "timeoutMS"
+          ),
           model: BrandDev::Models::BrandRetrieveNaicsResponse,
           options: options
         )

data/lib/brand_dev/version.rb

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

data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi

@@ -79,6 +79,13 @@ module BrandDev
       sig { params(mcc: String).void }
       attr_writer :mcc
 
+      # Optional phone number from the transaction to help verify brand match.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :phone
+
+      sig { params(phone: Float).void }
+      attr_writer :phone
+
       # 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).
@@ -98,6 +105,7 @@ module BrandDev
             BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
           max_speed: T::Boolean,
           mcc: String,
+          phone: Float,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -119,6 +127,8 @@ module BrandDev
         # Optional Merchant Category Code (MCC) to help identify the business
         # category/industry.
         mcc: nil,
+        # Optional phone number from the transaction to help verify brand match.
+        phone: 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).
@@ -138,6 +148,7 @@ module BrandDev
               BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
             max_speed: T::Boolean,
             mcc: String,
+            phone: Float,
             timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }

data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi

@@ -17,6 +17,21 @@ module BrandDev
       sig { returns(String) }
       attr_accessor :input
 
+      # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
+      # to 5.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_results
+
+      sig { params(max_results: Integer).void }
+      attr_writer :max_results
+
+      # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_results
+
+      sig { params(min_results: Integer).void }
+      attr_writer :min_results
+
       # 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).
@@ -29,6 +44,8 @@ module BrandDev
       sig do
         params(
           input: String,
+          max_results: Integer,
+          min_results: Integer,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -38,6 +55,11 @@ module BrandDev
         # in `input`, it will be used for classification, otherwise, we will search for
         # the brand using the provided title.
         input:,
+        # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
+        # to 5.
+        max_results: nil,
+        # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+        min_results: 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).
@@ -50,6 +72,8 @@ module BrandDev
         override.returns(
           {
             input: String,
+            max_results: Integer,
+            min_results: Integer,
             timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }

data/rbi/brand_dev/models/brand_retrieve_naics_response.rbi

@@ -96,31 +96,91 @@ module BrandDev
           end
 
         # NAICS code
-        sig { returns(T.nilable(String)) }
-        attr_reader :code
+        sig { returns(String) }
+        attr_accessor :code
 
-        sig { params(code: String).void }
-        attr_writer :code
+        # Confidence level for how well this NAICS code matches the company description
+        sig do
+          returns(
+            BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+          )
+        end
+        attr_accessor :confidence
 
         # NAICS title
-        sig { returns(T.nilable(String)) }
-        attr_reader :title
-
-        sig { params(title: String).void }
-        attr_writer :title
-
-        sig { params(code: String, title: String).returns(T.attached_class) }
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          params(
+            code: String,
+            confidence:
+              BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::OrSymbol,
+            name: String
+          ).returns(T.attached_class)
+        end
         def self.new(
           # NAICS code
-          code: nil,
+          code:,
+          # Confidence level for how well this NAICS code matches the company description
+          confidence:,
           # NAICS title
-          title: nil
+          name:
         )
         end
 
-        sig { override.returns({ code: String, title: String }) }
+        sig do
+          override.returns(
+            {
+              code: String,
+              confidence:
+                BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol,
+              name: String
+            }
+          )
+        end
         def to_hash
         end
+
+        # Confidence level for how well this NAICS code matches the company description
+        module Confidence
+          extend BrandDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIGH =
+            T.let(
+              :high,
+              BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+            )
+          LOW =
+            T.let(
+              :low,
+              BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/brand_dev/resources/brand.rbi

@@ -95,6 +95,7 @@ module BrandDev
             BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
           max_speed: T::Boolean,
           mcc: String,
+          phone: Float,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandIdentifyFromTransactionResponse)
@@ -116,6 +117,8 @@ module BrandDev
         # Optional Merchant Category Code (MCC) to help identify the business
         # category/industry.
         mcc: nil,
+        # Optional phone number from the transaction to help verify brand match.
+        phone: 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).
@@ -279,6 +282,8 @@ module BrandDev
       sig do
         params(
           input: String,
+          max_results: Integer,
+          min_results: Integer,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveNaicsResponse)
@@ -288,6 +293,11 @@ module BrandDev
         # in `input`, it will be used for classification, otherwise, we will search for
         # the brand using the provided title.
         input:,
+        # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
+        # to 5.
+        max_results: nil,
+        # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+        min_results: 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).

data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs

@@ -8,6 +8,7 @@ module BrandDev
         force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
         max_speed: bool,
         mcc: String,
+        phone: Float,
         timeout_ms: Integer
       }
       & BrandDev::Internal::Type::request_parameters
@@ -42,6 +43,10 @@ module BrandDev
 
       def mcc=: (String) -> String
 
+      attr_reader phone: Float?
+
+      def phone=: (Float) -> Float
+
       attr_reader timeout_ms: Integer?
 
       def timeout_ms=: (Integer) -> Integer
@@ -53,6 +58,7 @@ module BrandDev
         ?force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
         ?max_speed: bool,
         ?mcc: String,
+        ?phone: Float,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
@@ -64,6 +70,7 @@ module BrandDev
         force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
         max_speed: bool,
         mcc: String,
+        phone: Float,
         timeout_ms: Integer,
         request_options: BrandDev::RequestOptions
       }

data/sig/brand_dev/models/brand_retrieve_naics_params.rbs

@@ -1,7 +1,12 @@
 module BrandDev
   module Models
     type brand_retrieve_naics_params =
-      { input: String, timeout_ms: Integer }
+      {
+        input: String,
+        max_results: Integer,
+        min_results: Integer,
+        timeout_ms: Integer
+      }
       & BrandDev::Internal::Type::request_parameters
 
     class BrandRetrieveNaicsParams < BrandDev::Internal::Type::BaseModel
@@ -10,18 +15,30 @@ module BrandDev
 
       attr_accessor input: String
 
+      attr_reader max_results: Integer?
+
+      def max_results=: (Integer) -> Integer
+
+      attr_reader min_results: Integer?
+
+      def min_results=: (Integer) -> Integer
+
       attr_reader timeout_ms: Integer?
 
       def timeout_ms=: (Integer) -> Integer
 
       def initialize: (
         input: String,
+        ?max_results: Integer,
+        ?min_results: Integer,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
         input: String,
+        max_results: Integer,
+        min_results: Integer,
         timeout_ms: Integer,
         request_options: BrandDev::RequestOptions
       }

data/sig/brand_dev/models/brand_retrieve_naics_response.rbs

@@ -41,20 +41,43 @@ module BrandDev
         type: String
       }
 
-      type code = { code: String, title: String }
+      type code =
+        {
+          code: String,
+          confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence,
+          name: String
+        }
 
       class Code < BrandDev::Internal::Type::BaseModel
-        attr_reader code: String?
+        attr_accessor code: String
 
-        def code=: (String) -> String
+        attr_accessor confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence
 
-        attr_reader title: String?
+        attr_accessor name: String
 
-        def title=: (String) -> String
+        def initialize: (
+          code: String,
+          confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence,
+          name: String
+        ) -> void
 
-        def initialize: (?code: String, ?title: String) -> void
+        def to_hash: -> {
+          code: String,
+          confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence,
+          name: String
+        }
 
-        def to_hash: -> { code: String, title: String }
+        type confidence = :high | :medium | :low
+
+        module Confidence
+          extend BrandDev::Internal::Type::Enum
+
+          HIGH: :high
+          MEDIUM: :medium
+          LOW: :low
+
+          def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence]
+        end
       end
     end
   end

data/sig/brand_dev/resources/brand.rbs

@@ -30,6 +30,7 @@ module BrandDev
         ?force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
         ?max_speed: bool,
         ?mcc: String,
+        ?phone: Float,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandIdentifyFromTransactionResponse
@@ -75,6 +76,8 @@ module BrandDev
 
       def retrieve_naics: (
         input: String,
+        ?max_results: Integer,
+        ?min_results: Integer,
         ?timeout_ms: Integer,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandRetrieveNaicsResponse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Brand Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-01 00:00:00.000000000 Z
+date: 2025-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool