brand.dev 0.0.1.pre.alpha.0

data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandRetrieveNaicsParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandRetrieveNaicsParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Brand domain or title to retrieve NAICS code for. If a valid domain is provided
+      # in `input`, it will be used for classification, otherwise, we will search for
+      # the brand using the provided title.
+      sig { returns(String) }
+      attr_accessor :input
+
+      sig do
+        params(
+          input: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Brand domain or title to retrieve NAICS code for. If a valid domain is provided
+        # in `input`, it will be used for classification, otherwise, we will search for
+        # the brand using the provided title.
+        input:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { input: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_retrieve_naics_response.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandRetrieveNaicsResponse < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandRetrieveNaicsResponse,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Array of NAICS codes and titles.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code]
+          )
+        )
+      end
+      attr_reader :codes
+
+      sig do
+        params(
+          codes:
+            T::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code::OrHash]
+        ).void
+      end
+      attr_writer :codes
+
+      # Domain found for the brand
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # Status of the response, e.g., 'ok'
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # Industry classification type, for naics api it will be `naics`
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      sig do
+        params(
+          codes:
+            T::Array[
+              BrandDev::Models::BrandRetrieveNaicsResponse::Code::OrHash
+            ],
+          domain: String,
+          status: String,
+          type: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of NAICS codes and titles.
+        codes: nil,
+        # Domain found for the brand
+        domain: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil,
+        # Industry classification type, for naics api it will be `naics`
+        type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            codes: T::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code],
+            domain: String,
+            status: String,
+            type: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Code < BrandDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              BrandDev::Models::BrandRetrieveNaicsResponse::Code,
+              BrandDev::Internal::AnyHash
+            )
+          end
+
+        # NAICS code
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # NAICS title
+        sig { returns(T.nilable(String)) }
+        attr_reader :title
+
+        sig { params(title: String).void }
+        attr_writer :title
+
+        sig { params(code: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # NAICS code
+          code: nil,
+          # NAICS title
+          title: nil
+        )
+        end
+
+        sig { override.returns({ code: String, title: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_retrieve_params.rbi

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