brand.dev 0.9.0 → 0.11.0

data/rbi/brand_dev/models/brand_retrieve_params.rbi

@@ -44,41 +44,6 @@ module BrandDev
       sig { params(max_speed: T::Boolean).void }
       attr_writer :max_speed
 
-      # 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.
-      sig { returns(T.nilable(String)) }
-      attr_reader :name
-
-      sig { params(name: String).void }
-      attr_writer :name
-
-      # Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
-      # Must be 1-15 characters, letters/numbers/dots only. Cannot be used with domain
-      # or name parameters.
-      sig { returns(T.nilable(String)) }
-      attr_reader :ticker
-
-      sig { params(ticker: String).void }
-      attr_writer :ticker
-
-      # Optional stock exchange for the ticker. Only used when ticker parameter is
-      # provided. Defaults to assume ticker is American if not specified.
-      sig do
-        returns(
-          T.nilable(BrandDev::BrandRetrieveParams::TickerExchange::OrSymbol)
-        )
-      end
-      attr_reader :ticker_exchange
-
-      sig do
-        params(
-          ticker_exchange:
-            BrandDev::BrandRetrieveParams::TickerExchange::OrSymbol
-        ).void
-      end
-      attr_writer :ticker_exchange
-
       # 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).
@@ -94,10 +59,6 @@ module BrandDev
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
           max_speed: T::Boolean,
-          name: String,
-          ticker: String,
-          ticker_exchange:
-            BrandDev::BrandRetrieveParams::TickerExchange::OrSymbol,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -113,17 +74,6 @@ module BrandDev
         # the API will skip time-consuming operations for faster response at the cost of
         # 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-15 characters, letters/numbers/dots only. Cannot be used with domain
-        # or name parameters.
-        ticker: nil,
-        # Optional stock exchange for the ticker. Only used when ticker parameter is
-        # provided. Defaults to assume ticker is American if not specified.
-        ticker_exchange: 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).
@@ -139,10 +89,6 @@ module BrandDev
             force_language:
               BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
             max_speed: T::Boolean,
-            name: String,
-            ticker: String,
-            ticker_exchange:
-              BrandDev::BrandRetrieveParams::TickerExchange::OrSymbol,
             timeout_ms: Integer,
             request_options: BrandDev::RequestOptions
           }
@@ -431,389 +377,6 @@ module BrandDev
         def self.values
         end
       end
-
-      # Optional stock exchange for the ticker. Only used when ticker parameter is
-      # provided. Defaults to assume ticker is American if not specified.
-      module TickerExchange
-        extend BrandDev::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, BrandDev::BrandRetrieveParams::TickerExchange)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        AMEX =
-          T.let(
-            :AMEX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        AMS =
-          T.let(
-            :AMS,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        AQS =
-          T.let(
-            :AQS,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        ASX =
-          T.let(
-            :ASX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        ATH =
-          T.let(
-            :ATH,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        BER =
-          T.let(
-            :BER,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        BME =
-          T.let(
-            :BME,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        BRU =
-          T.let(
-            :BRU,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        BSE =
-          T.let(
-            :BSE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        BUD =
-          T.let(
-            :BUD,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        BUE =
-          T.let(
-            :BUE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        BVC =
-          T.let(
-            :BVC,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        CBOE =
-          T.let(
-            :CBOE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        CNQ =
-          T.let(
-            :CNQ,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        CPH =
-          T.let(
-            :CPH,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        DFM =
-          T.let(
-            :DFM,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        DOH =
-          T.let(
-            :DOH,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        DUB =
-          T.let(
-            :DUB,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        DUS =
-          T.let(
-            :DUS,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        DXE =
-          T.let(
-            :DXE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        EGX =
-          T.let(
-            :EGX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        FSX =
-          T.let(
-            :FSX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        HAM =
-          T.let(
-            :HAM,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        HEL =
-          T.let(
-            :HEL,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        HKSE =
-          T.let(
-            :HKSE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        HOSE =
-          T.let(
-            :HOSE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        ICE =
-          T.let(
-            :ICE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        IOB =
-          T.let(
-            :IOB,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        IST =
-          T.let(
-            :IST,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        JKT =
-          T.let(
-            :JKT,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        JNB =
-          T.let(
-            :JNB,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        JPX =
-          T.let(
-            :JPX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        KLS =
-          T.let(
-            :KLS,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        KOE =
-          T.let(
-            :KOE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        KSC =
-          T.let(
-            :KSC,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        KUW =
-          T.let(
-            :KUW,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        LIS =
-          T.let(
-            :LIS,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        LSE =
-          T.let(
-            :LSE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        MCX =
-          T.let(
-            :MCX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        MEX =
-          T.let(
-            :MEX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        MIL =
-          T.let(
-            :MIL,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        MUN =
-          T.let(
-            :MUN,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        NASDAQ =
-          T.let(
-            :NASDAQ,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        NEO =
-          T.let(
-            :NEO,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        NSE =
-          T.let(
-            :NSE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        NYSE =
-          T.let(
-            :NYSE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        NZE =
-          T.let(
-            :NZE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        OSL =
-          T.let(
-            :OSL,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        OTC =
-          T.let(
-            :OTC,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        PAR =
-          T.let(
-            :PAR,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        PNK =
-          T.let(
-            :PNK,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        PRA =
-          T.let(
-            :PRA,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        RIS =
-          T.let(
-            :RIS,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SAO =
-          T.let(
-            :SAO,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SAU =
-          T.let(
-            :SAU,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SES =
-          T.let(
-            :SES,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SET =
-          T.let(
-            :SET,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SGO =
-          T.let(
-            :SGO,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SHH =
-          T.let(
-            :SHH,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SHZ =
-          T.let(
-            :SHZ,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        SIX =
-          T.let(
-            :SIX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        STO =
-          T.let(
-            :STO,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        STU =
-          T.let(
-            :STU,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        TAI =
-          T.let(
-            :TAI,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        TAL =
-          T.let(
-            :TAL,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        TLV =
-          T.let(
-            :TLV,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        TSX =
-          T.let(
-            :TSX,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        TSXV =
-          T.let(
-            :TSXV,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        TWO =
-          T.let(
-            :TWO,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        VIE =
-          T.let(
-            :VIE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        WSE =
-          T.let(
-            :WSE,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-        XETRA =
-          T.let(
-            :XETRA,
-            BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              BrandDev::BrandRetrieveParams::TickerExchange::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/brand_dev/models.rbi

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

data/rbi/brand_dev/resources/brand.rbi

@@ -3,18 +3,14 @@
 module BrandDev
   module Resources
     class Brand
-      # Retrieve brand information using one of three methods: domain name, company
-      # name, or stock ticker symbol. Exactly one of these parameters must be provided.
+      # Retrieve logos, backdrops, colors, industry, description, and more from any
+      # domain
       sig do
         params(
           domain: String,
           force_language:
             BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
           max_speed: T::Boolean,
-          name: String,
-          ticker: String,
-          ticker_exchange:
-            BrandDev::BrandRetrieveParams::TickerExchange::OrSymbol,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandRetrieveResponse)
@@ -30,17 +26,6 @@ module BrandDev
         # the API will skip time-consuming operations for faster response at the cost of
         # 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-15 characters, letters/numbers/dots only. Cannot be used with domain
-        # or name parameters.
-        ticker: nil,
-        # Optional stock exchange for the ticker. Only used when ticker parameter is
-        # provided. Defaults to assume ticker is American if not specified.
-        ticker_exchange: 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).
@@ -82,6 +67,9 @@ module BrandDev
       sig do
         params(
           transaction_info: String,
+          force_language:
+            BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
           timeout_ms: Integer,
           request_options: BrandDev::RequestOptions::OrHash
         ).returns(BrandDev::Models::BrandIdentifyFromTransactionResponse)
@@ -89,6 +77,12 @@ module BrandDev
       def identify_from_transaction(
         # Transaction information to identify the brand
         transaction_info:,
+        # 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 time-consuming operations for faster response at the cost of
+        # less comprehensive data.
+        max_speed: 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).
@@ -119,6 +113,103 @@ module BrandDev
       )
       end
 
+      # Retrieve brand information using an email address while detecting disposable and
+      # free email addresses. This endpoint extracts the domain from the email address
+      # and returns brand data for that domain. Disposable and free email addresses
+      # (like gmail.com, yahoo.com) will throw a 422 error.
+      sig do
+        params(
+          email: String,
+          force_language:
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandRetrieveByEmailResponse)
+      end
+      def retrieve_by_email(
+        # Email address to retrieve brand data for (e.g., 'contact@example.com'). The
+        # domain will be extracted from the email. Free email providers (gmail.com,
+        # yahoo.com, etc.) and disposable email addresses are not allowed.
+        email:,
+        # 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 time-consuming operations for faster response at the cost of
+        # less comprehensive data.
+        max_speed: 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).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve brand information using a company name. This endpoint searches for the
+      # company by name and returns its brand data.
+      sig do
+        params(
+          name: String,
+          force_language:
+            BrandDev::BrandRetrieveByNameParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandRetrieveByNameResponse)
+      end
+      def retrieve_by_name(
+        # Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
+        # Corporation'). Must be 3-30 characters.
+        name:,
+        # 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 time-consuming operations for faster response at the cost of
+        # less comprehensive data.
+        max_speed: 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).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve brand information using a stock ticker symbol. This endpoint looks up
+      # the company associated with the ticker and returns its brand data.
+      sig do
+        params(
+          ticker: String,
+          force_language:
+            BrandDev::BrandRetrieveByTickerParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
+          ticker_exchange:
+            BrandDev::BrandRetrieveByTickerParams::TickerExchange::OrSymbol,
+          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', 'GOOGL', 'BRK.A').
+        # Must be 1-15 characters, letters/numbers/dots only.
+        ticker:,
+        # 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 time-consuming operations for faster response at the cost of
+        # less comprehensive data.
+        max_speed: nil,
+        # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
+        ticker_exchange: 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).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
       # Endpoint to classify any brand into a 2022 NAICS code.
       sig do
         params(