brand.dev 0.10.0 → 0.11.0

data/rbi/brand_dev/models.rbi

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

data/rbi/brand_dev/resources/brand.rbi

@@ -113,6 +113,39 @@ 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

data/sig/brand_dev/models/brand_retrieve_by_email_params.rbs

@@ -0,0 +1,162 @@
+module BrandDev
+  module Models
+    type brand_retrieve_by_email_params =
+      {
+        email: String,
+        force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language,
+        max_speed: bool,
+        timeout_ms: Integer
+      }
+      & BrandDev::Internal::Type::request_parameters
+
+    class BrandRetrieveByEmailParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor email: String
+
+      attr_reader force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language?
+
+      def force_language=: (
+        BrandDev::Models::BrandRetrieveByEmailParams::force_language
+      ) -> BrandDev::Models::BrandRetrieveByEmailParams::force_language
+
+      attr_reader max_speed: bool?
+
+      def max_speed=: (bool) -> bool
+
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
+      def initialize: (
+        email: String,
+        ?force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language,
+        ?max_speed: bool,
+        ?timeout_ms: Integer,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        email: String,
+        force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language,
+        max_speed: bool,
+        timeout_ms: Integer,
+        request_options: BrandDev::RequestOptions
+      }
+
+      type force_language =
+        :albanian
+        | :arabic
+        | :azeri
+        | :bengali
+        | :bulgarian
+        | :cebuano
+        | :croatian
+        | :czech
+        | :danish
+        | :dutch
+        | :english
+        | :estonian
+        | :farsi
+        | :finnish
+        | :french
+        | :german
+        | :hausa
+        | :hawaiian
+        | :hindi
+        | :hungarian
+        | :icelandic
+        | :indonesian
+        | :italian
+        | :kazakh
+        | :kyrgyz
+        | :latin
+        | :latvian
+        | :lithuanian
+        | :macedonian
+        | :mongolian
+        | :nepali
+        | :norwegian
+        | :pashto
+        | :pidgin
+        | :polish
+        | :portuguese
+        | :romanian
+        | :russian
+        | :serbian
+        | :slovak
+        | :slovene
+        | :somali
+        | :spanish
+        | :swahili
+        | :swedish
+        | :tagalog
+        | :turkish
+        | :ukrainian
+        | :urdu
+        | :uzbek
+        | :vietnamese
+        | :welsh
+
+      module ForceLanguage
+        extend BrandDev::Internal::Type::Enum
+
+        ALBANIAN: :albanian
+        ARABIC: :arabic
+        AZERI: :azeri
+        BENGALI: :bengali
+        BULGARIAN: :bulgarian
+        CEBUANO: :cebuano
+        CROATIAN: :croatian
+        CZECH: :czech
+        DANISH: :danish
+        DUTCH: :dutch
+        ENGLISH: :english
+        ESTONIAN: :estonian
+        FARSI: :farsi
+        FINNISH: :finnish
+        FRENCH: :french
+        GERMAN: :german
+        HAUSA: :hausa
+        HAWAIIAN: :hawaiian
+        HINDI: :hindi
+        HUNGARIAN: :hungarian
+        ICELANDIC: :icelandic
+        INDONESIAN: :indonesian
+        ITALIAN: :italian
+        KAZAKH: :kazakh
+        KYRGYZ: :kyrgyz
+        LATIN: :latin
+        LATVIAN: :latvian
+        LITHUANIAN: :lithuanian
+        MACEDONIAN: :macedonian
+        MONGOLIAN: :mongolian
+        NEPALI: :nepali
+        NORWEGIAN: :norwegian
+        PASHTO: :pashto
+        PIDGIN: :pidgin
+        POLISH: :polish
+        PORTUGUESE: :portuguese
+        ROMANIAN: :romanian
+        RUSSIAN: :russian
+        SERBIAN: :serbian
+        SLOVAK: :slovak
+        SLOVENE: :slovene
+        SOMALI: :somali
+        SPANISH: :spanish
+        SWAHILI: :swahili
+        SWEDISH: :swedish
+        TAGALOG: :tagalog
+        TURKISH: :turkish
+        UKRAINIAN: :ukrainian
+        URDU: :urdu
+        UZBEK: :uzbek
+        VIETNAMESE: :vietnamese
+        WELSH: :welsh
+
+        def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByEmailParams::force_language]
+      end
+    end
+  end
+end