brand.dev 0.2.0 → 0.3.0

data/rbi/brand_dev/models.rbi

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

data/rbi/brand_dev/resources/brand.rbi

@@ -3,26 +3,39 @@
 module BrandDev
   module Resources
     class Brand
-      # Retrieve brand data by domain
+      # Retrieve brand information using one of three methods: domain name, company
+      # name, or stock ticker symbol. Exactly one of these parameters must be provided.
       sig do
         params(
           domain: String,
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
           max_speed: T::Boolean,
+          name: String,
+          ticker: String,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveResponse)
       end
       def retrieve(
-        # Domain name to retrieve brand data for
-        domain:,
-        # Optional parameter to force the language of the retrieved brand data
+        # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
+        # Cannot be used with name or ticker parameters.
+        domain: nil,
+        # Optional parameter to force the language of the retrieved brand data. Works with
+        # all three lookup methods.
         force_language: nil,
         # Optional parameter to optimize the API call for maximum speed. When set to true,
         # the API will skip time-consuming operations for faster response at the cost of
-        # less comprehensive data.
+        # less comprehensive data. Works with all three lookup methods.
         max_speed: nil,
+        # Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
+        # Corporation'). Must be 3-30 characters. Cannot be used with domain or ticker
+        # parameters.
+        name: nil,
+        # Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
+        # Must be 1-6 characters, letters/numbers/dots only. Cannot be used with domain or
+        # name parameters.
+        ticker: 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).
@@ -101,25 +114,6 @@ module BrandDev
       )
       end
 
-      # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
-      sig do
-        params(
-          ticker: String,
-          timeout_ms: Integer,
-          request_options: BrandDev::RequestOptions::OrHash
-        ).returns(BrandDev::Models::BrandRetrieveByTickerResponse)
-      end
-      def retrieve_by_ticker(
-        # Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
-        ticker:,
-        # 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
-
       # Endpoint to classify any brand into a 2022 NAICS code.
       sig do
         params(

data/sig/brand_dev/internal/transport/base_client.rbs

@@ -99,7 +99,7 @@ module BrandDev
           retry_count: Integer
         ) -> Float
 
-        private def send_request: (
+        def send_request: (
           BrandDev::Internal::Transport::BaseClient::request_input request,
           redirect_count: Integer,
           retry_count: Integer,

data/sig/brand_dev/internal/type/converter.rbs

@@ -39,6 +39,23 @@ module BrandDev
           | BrandDev::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.meta_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> BrandDev::Internal::Type::Converter::input?,
+            union: ^-> BrandDev::Internal::Type::Converter::input?
+          }
+          | ^-> BrandDev::Internal::Type::Converter::input
+          | BrandDev::Internal::Type::Converter::input type_info,
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> BrandDev::Internal::Type::Converter::input?,
+            union: ^-> BrandDev::Internal::Type::Converter::input?
+          }
+          | ^-> BrandDev::Internal::Type::Converter::input
+          | BrandDev::Internal::Type::Converter::input spec
+        ) -> ::Hash[Symbol, top]
+
         def self.new_coerce_state: (
           ?translate_names: bool
         ) -> BrandDev::Internal::Type::Converter::coerce_state

data/sig/brand_dev/internal/type/union.rbs

@@ -5,9 +5,9 @@ module BrandDev
         include BrandDev::Internal::Type::Converter
         include BrandDev::Internal::Util::SorbetRuntimeSupport
 
-        private def self.known_variants: -> ::Array[[Symbol?, (^-> BrandDev::Internal::Type::Converter::input)]]
+        private def self.known_variants: -> ::Array[[Symbol?, (^-> BrandDev::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
 
-        def self.derefed_variants: -> ::Array[[Symbol?, top]]
+        def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
 
         def self.variants: -> ::Array[top]