brand.dev 0.10.0 → 0.11.0

data/lib/brand_dev/models.rb

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

data/lib/brand_dev/resources/brand.rb

@@ -130,6 +130,40 @@ module BrandDev
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {BrandDev::Models::BrandRetrieveByEmailParams} for more details.
+      #
+      # 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.
+      #
+      # @overload retrieve_by_email(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      #
+      # @param email [String] Email address to retrieve brand data for (e.g., 'contact@example.com'). The doma
+      #
+      # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByEmailParams::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 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]
+      #
+      # @return [BrandDev::Models::BrandRetrieveByEmailResponse]
+      #
+      # @see BrandDev::Models::BrandRetrieveByEmailParams
+      def retrieve_by_email(params)
+        parsed, options = BrandDev::BrandRetrieveByEmailParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "brand/retrieve-by-email",
+          query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
+          model: BrandDev::Models::BrandRetrieveByEmailResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {BrandDev::Models::BrandRetrieveByNameParams} for more details.
       #

data/lib/brand_dev/version.rb

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

data/lib/brand_dev.rb

@@ -56,6 +56,8 @@ 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_email_params"
+require_relative "brand_dev/models/brand_retrieve_by_email_response"
 require_relative "brand_dev/models/brand_retrieve_by_name_params"
 require_relative "brand_dev/models/brand_retrieve_by_name_response"
 require_relative "brand_dev/models/brand_retrieve_by_ticker_params"

data/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi

@@ -0,0 +1,386 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandRetrieveByEmailParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::BrandRetrieveByEmailParams,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :email
+
+      # Optional parameter to force the language of the retrieved brand data.
+      sig do
+        returns(
+          T.nilable(
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol
+          )
+        )
+      end
+      attr_reader :force_language
+
+      sig do
+        params(
+          force_language:
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol
+        ).void
+      end
+      attr_writer :force_language
+
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :max_speed
+
+      sig { params(max_speed: T::Boolean).void }
+      attr_writer :max_speed
+
+      # 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).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
+      sig do
+        params(
+          email: String,
+          force_language:
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
+          timeout_ms: Integer,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            force_language:
+              BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol,
+            max_speed: T::Boolean,
+            timeout_ms: Integer,
+            request_options: BrandDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Optional parameter to force the language of the retrieved brand data.
+      module ForceLanguage
+        extend BrandDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, BrandDev::BrandRetrieveByEmailParams::ForceLanguage)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALBANIAN =
+          T.let(
+            :albanian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        ARABIC =
+          T.let(
+            :arabic,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        AZERI =
+          T.let(
+            :azeri,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        BENGALI =
+          T.let(
+            :bengali,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        BULGARIAN =
+          T.let(
+            :bulgarian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        CEBUANO =
+          T.let(
+            :cebuano,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        CROATIAN =
+          T.let(
+            :croatian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        CZECH =
+          T.let(
+            :czech,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        DANISH =
+          T.let(
+            :danish,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        DUTCH =
+          T.let(
+            :dutch,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        ENGLISH =
+          T.let(
+            :english,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        ESTONIAN =
+          T.let(
+            :estonian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        FARSI =
+          T.let(
+            :farsi,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        FINNISH =
+          T.let(
+            :finnish,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        FRENCH =
+          T.let(
+            :french,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        GERMAN =
+          T.let(
+            :german,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        HAUSA =
+          T.let(
+            :hausa,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        HAWAIIAN =
+          T.let(
+            :hawaiian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        HINDI =
+          T.let(
+            :hindi,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        HUNGARIAN =
+          T.let(
+            :hungarian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        ICELANDIC =
+          T.let(
+            :icelandic,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        INDONESIAN =
+          T.let(
+            :indonesian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        ITALIAN =
+          T.let(
+            :italian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        KAZAKH =
+          T.let(
+            :kazakh,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        KYRGYZ =
+          T.let(
+            :kyrgyz,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        LATIN =
+          T.let(
+            :latin,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        LATVIAN =
+          T.let(
+            :latvian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        LITHUANIAN =
+          T.let(
+            :lithuanian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        MACEDONIAN =
+          T.let(
+            :macedonian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        MONGOLIAN =
+          T.let(
+            :mongolian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        NEPALI =
+          T.let(
+            :nepali,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        NORWEGIAN =
+          T.let(
+            :norwegian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        PASHTO =
+          T.let(
+            :pashto,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        PIDGIN =
+          T.let(
+            :pidgin,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        POLISH =
+          T.let(
+            :polish,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        PORTUGUESE =
+          T.let(
+            :portuguese,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        ROMANIAN =
+          T.let(
+            :romanian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        RUSSIAN =
+          T.let(
+            :russian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        SERBIAN =
+          T.let(
+            :serbian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        SLOVAK =
+          T.let(
+            :slovak,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        SLOVENE =
+          T.let(
+            :slovene,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        SOMALI =
+          T.let(
+            :somali,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        SPANISH =
+          T.let(
+            :spanish,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        SWAHILI =
+          T.let(
+            :swahili,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        SWEDISH =
+          T.let(
+            :swedish,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        TAGALOG =
+          T.let(
+            :tagalog,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        TURKISH =
+          T.let(
+            :turkish,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        UKRAINIAN =
+          T.let(
+            :ukrainian,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        URDU =
+          T.let(
+            :urdu,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        UZBEK =
+          T.let(
+            :uzbek,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        VIETNAMESE =
+          T.let(
+            :vietnamese,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+        WELSH =
+          T.let(
+            :welsh,
+            BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end