brand.dev 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94f139a55d3e88238d913a185093f41026e151b9fd968eb8f249f19ddb54202
-  data.tar.gz: 5387c49ab7a97f07f29ff7c937bba1a49377d3555b98299c61fafe22f2d862d7
+  metadata.gz: b7838f8c194543e8e3ba05ae68343cc13ea4aed8ceabcb0502530061da5a41ac
+  data.tar.gz: 9036c6faf4fee43e86625466038184bd93b1c3118ccfcdc132b2d00dabf30fe3
 SHA512:
-  metadata.gz: 7b44cbd8f70815be419af79dfdf414647e5b274e27fa7f8feb01e0671e22b51299728af2867400360adf711c3a756b05a30f1272b9fedc28ab357ba6bf6c0e6b
-  data.tar.gz: 5b2565644ee946cd873a26afeaa9ec5698d360c39677d90d9c6289883be3b0a90f6df1fac6558292798d83877b03f3b3248d309d2137b47223f67a9782781a28
+  metadata.gz: c7b864fff0ccfb6e158d491159cbed2efbb9e497245f5c35779b010ddfa74e43538a228cd7041623da7d806c19a1288ddeea4db6983a3b4a7caf9776e4642613
+  data.tar.gz: 1e7fc08296c8f69cc226b9f84337a48fc90043f1943057f4892841a412200c7a17bb827cd4a34db3b8a983ad4464ea7d877e4213eae8cefb9338b2452e015f15

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.1.0-alpha.4 (2025-06-06)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+### Features
+
+* **api:** manual updates ([05a611f](https://github.com/brand-dot-dev/ruby-sdk/commit/05a611fe140468f965dbb41c0d8250d3dd84a9aa))
+
+
+### Chores
+
+* **internal:** codegen related update ([b850fe2](https://github.com/brand-dot-dev/ruby-sdk/commit/b850fe270f6c9e7d63b380a6bdcdb9c0c6b6b65f))
+
+## 0.1.0-alpha.3 (2025-06-06)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Features
+
+* **api:** manual updates ([7410667](https://github.com/brand-dot-dev/ruby-sdk/commit/7410667d18ceacfb171c91eb14a4825f77e3487b))
+
+
+### Chores
+
+* **internal:** codegen related update ([08a0fc4](https://github.com/brand-dot-dev/ruby-sdk/commit/08a0fc45756634925a18266d526b41a217b37492))
+
 ## 0.1.0-alpha.2 (2025-06-05)
 
 Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)

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

data/lib/brand_dev/models/brand_prefetch_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#prefetch
+    class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to prefetch brand data for
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!method initialize(domain:, request_options: {})
+      #   @param domain [String] Domain name to prefetch brand data for
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_prefetch_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#prefetch
+    class BrandPrefetchResponse < 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/brand_retrieve_params.rb

@@ -19,11 +19,24 @@ module BrandDev
       #   @return [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage, nil]
       optional :force_language, enum: -> { BrandDev::BrandRetrieveParams::ForceLanguage }
 
-      # @!method initialize(domain:, force_language: nil, request_options: {})
+      # @!attribute max_speed
+      #   Optional parameter to optimize the API call for maximum speed. When set to true,
+      #   the API will skip social media data extraction and external service calls (like
+      #   Crunchbase) to return results faster with basic brand information only.
+      #
+      #   @return [Boolean, nil]
+      optional :max_speed, BrandDev::Internal::Type::Boolean
+
+      # @!method initialize(domain:, force_language: nil, max_speed: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandRetrieveParams} for more details.
+      #
       #   @param domain [String] Domain name to retrieve brand data for
       #
       #   @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
       #
+      #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
+      #
       #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
 
       # Optional parameter to force the language of the retrieved brand data

data/lib/brand_dev/models.rb

@@ -43,6 +43,8 @@ module BrandDev
 
   BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

data/lib/brand_dev/resources/brand.rb

@@ -3,14 +3,19 @@
 module BrandDev
   module Resources
     class Brand
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandRetrieveParams} for more details.
+      #
       # Retrieve brand data by domain
       #
-      # @overload retrieve(domain:, force_language: nil, request_options: {})
+      # @overload retrieve(domain:, force_language: nil, max_speed: nil, request_options: {})
       #
       # @param domain [String] Domain name to retrieve brand data for
       #
       # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
       #
+      # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
+      #
       # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [BrandDev::Models::BrandRetrieveResponse]
@@ -21,7 +26,7 @@ module BrandDev
         @client.request(
           method: :get,
           path: "brand/retrieve",
-          query: parsed,
+          query: parsed.transform_keys(max_speed: "maxSpeed"),
           model: BrandDev::Models::BrandRetrieveResponse,
           options: options
         )
@@ -78,6 +83,31 @@ module BrandDev
         )
       end
 
+      # Signal that you may fetch brand data for a particular domain soon to improve
+      # latency. 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(domain:, request_options: {})
+      #
+      # @param domain [String] Domain name to prefetch brand data for
+      #
+      # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [BrandDev::Models::BrandPrefetchResponse]
+      #
+      # @see BrandDev::Models::BrandPrefetchParams
+      def prefetch(params)
+        parsed, options = BrandDev::BrandPrefetchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brand/prefetch",
+          body: parsed,
+          model: BrandDev::Models::BrandPrefetchResponse,
+          options: options
+        )
+      end
+
       # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
       #
       # @overload retrieve_by_ticker(ticker:, request_options: {})

data/lib/brand_dev/version.rb

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

data/lib/brand_dev.rb

@@ -54,6 +54,8 @@ require_relative "brand_dev/models/brand_ai_query_params"
 require_relative "brand_dev/models/brand_ai_query_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_params"
+require_relative "brand_dev/models/brand_prefetch_response"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_params"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_response"
 require_relative "brand_dev/models/brand_retrieve_naics_params"

data/rbi/brand_dev/models/brand_prefetch_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandPrefetchParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Domain name to prefetch brand data for
+      sig { returns(String) }
+      attr_accessor :domain
+
+      sig do
+        params(
+          domain: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Domain name to prefetch brand data for
+        domain:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { domain: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_prefetch_response.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandPrefetchResponse,
+            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/brand_retrieve_params.rbi

@@ -30,11 +30,21 @@ module BrandDev
       end
       attr_writer :force_language
 
+      # Optional parameter to optimize the API call for maximum speed. When set to true,
+      # the API will skip social media data extraction and external service calls (like
+      # Crunchbase) to return results faster with basic brand information only.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :max_speed
+
+      sig { params(max_speed: T::Boolean).void }
+      attr_writer :max_speed
+
       sig do
         params(
           domain: String,
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -43,6 +53,10 @@ module BrandDev
         domain:,
         # Optional parameter to force the language of the retrieved brand data
         force_language: nil,
+        # Optional parameter to optimize the API call for maximum speed. When set to true,
+        # the API will skip social media data extraction and external service calls (like
+        # Crunchbase) to return results faster with basic brand information only.
+        max_speed: nil,
         request_options: {}
       )
       end
@@ -53,6 +67,7 @@ module BrandDev
             domain: String,
             force_language:
               BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+            max_speed: T::Boolean,
             request_options: BrandDev::RequestOptions
           }
         )

data/rbi/brand_dev/models.rbi

@@ -6,6 +6,8 @@ module BrandDev
   BrandIdentifyFromTransactionParams =
     BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

data/rbi/brand_dev/resources/brand.rbi

@@ -9,6 +9,7 @@ module BrandDev
           domain: String,
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveResponse)
       end
@@ -17,6 +18,10 @@ module BrandDev
         domain:,
         # Optional parameter to force the language of the retrieved brand data
         force_language: nil,
+        # Optional parameter to optimize the API call for maximum speed. When set to true,
+        # the API will skip social media data extraction and external service calls (like
+        # Crunchbase) to return results faster with basic brand information only.
+        max_speed: nil,
         request_options: {}
       )
       end
@@ -59,6 +64,23 @@ module BrandDev
       )
       end
 
+      # Signal that you may fetch brand data for a particular domain soon to improve
+      # latency. 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(
+          domain: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandPrefetchResponse)
+      end
+      def prefetch(
+        # Domain name to prefetch brand data for
+        domain:,
+        request_options: {}
+      )
+      end
+
       # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
       sig do
         params(

data/sig/brand_dev/models/brand_prefetch_params.rbs

@@ -0,0 +1,23 @@
+module BrandDev
+  module Models
+    type brand_prefetch_params =
+      { domain: String } & BrandDev::Internal::Type::request_parameters
+
+    class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      def initialize: (
+        domain: String,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/brand_dev/models/brand_prefetch_response.rbs

@@ -0,0 +1,28 @@
+module BrandDev
+  module Models
+    type brand_prefetch_response =
+      { domain: String, message: String, status: String }
+
+    class BrandPrefetchResponse < 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/brand_retrieve_params.rbs

@@ -3,7 +3,8 @@ module BrandDev
     type brand_retrieve_params =
       {
         domain: String,
-        force_language: BrandDev::Models::BrandRetrieveParams::force_language
+        force_language: BrandDev::Models::BrandRetrieveParams::force_language,
+        max_speed: bool
       }
       & BrandDev::Internal::Type::request_parameters
 
@@ -19,15 +20,21 @@ module BrandDev
         BrandDev::Models::BrandRetrieveParams::force_language
       ) -> BrandDev::Models::BrandRetrieveParams::force_language
 
+      attr_reader max_speed: bool?
+
+      def max_speed=: (bool) -> bool
+
       def initialize: (
         domain: String,
         ?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
+        ?max_speed: bool,
         ?request_options: BrandDev::request_opts
       ) -> void
 
       def to_hash: -> {
         domain: String,
         force_language: BrandDev::Models::BrandRetrieveParams::force_language,
+        max_speed: bool,
         request_options: BrandDev::RequestOptions
       }
 

data/sig/brand_dev/models.rbs

@@ -3,6 +3,8 @@ module BrandDev
 
   class BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
 
+  class BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
+
   class BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
 
   class BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams

data/sig/brand_dev/resources/brand.rbs

@@ -4,6 +4,7 @@ module BrandDev
       def retrieve: (
         domain: String,
         ?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
+        ?max_speed: bool,
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandRetrieveResponse
 
@@ -19,6 +20,11 @@ module BrandDev
         ?request_options: BrandDev::request_opts
       ) -> BrandDev::Models::BrandIdentifyFromTransactionResponse
 
+      def prefetch: (
+        domain: String,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::BrandPrefetchResponse
+
       def retrieve_by_ticker: (
         ticker: String,
         ?request_options: BrandDev::request_opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.2
+  version: 0.1.0.pre.alpha.4
 platform: ruby
 authors:
 - Brand Dev
@@ -58,6 +58,8 @@ files:
 - lib/brand_dev/models/brand_ai_query_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_params.rb
+- lib/brand_dev/models/brand_prefetch_response.rb
 - lib/brand_dev/models/brand_retrieve_by_ticker_params.rb
 - lib/brand_dev/models/brand_retrieve_by_ticker_response.rb
 - lib/brand_dev/models/brand_retrieve_naics_params.rb
@@ -93,6 +95,8 @@ files:
 - rbi/brand_dev/models/brand_ai_query_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_params.rbi
+- rbi/brand_dev/models/brand_prefetch_response.rbi
 - rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi
 - rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi
 - rbi/brand_dev/models/brand_retrieve_naics_params.rbi
@@ -127,6 +131,8 @@ files:
 - sig/brand_dev/models/brand_ai_query_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_params.rbs
+- sig/brand_dev/models/brand_prefetch_response.rbs
 - sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs
 - sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs
 - sig/brand_dev/models/brand_retrieve_naics_params.rbs