brand.dev 0.0.1.pre.alpha.0

data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb

@@ -0,0 +1,432 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#retrieve_by_ticker
+    class BrandRetrieveByTickerResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Detailed brand information
+      #
+      #   @return [BrandDev::Models::BrandRetrieveByTickerResponse::Brand, nil]
+      optional :brand, -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand }
+
+      # @!attribute code
+      #   HTTP status code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(brand: nil, code: nil, status: nil)
+      #   @param brand [BrandDev::Models::BrandRetrieveByTickerResponse::Brand] Detailed brand information
+      #
+      #   @param code [Integer] HTTP status code
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+
+      # @see BrandDev::Models::BrandRetrieveByTickerResponse#brand
+      class Brand < BrandDev::Internal::Type::BaseModel
+        # @!attribute address
+        #   Physical address of the brand
+        #
+        #   @return [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address, nil]
+        optional :address, -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address }
+
+        # @!attribute backdrops
+        #   An array of backdrop images for the brand
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop>, nil]
+        optional :backdrops,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop] }
+
+        # @!attribute colors
+        #   An array of brand colors
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color>, nil]
+        optional :colors,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color] }
+
+        # @!attribute description
+        #   A brief description of the brand
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute domain
+        #   The domain name of the brand
+        #
+        #   @return [String, nil]
+        optional :domain, String
+
+        # @!attribute fonts
+        #   An array of fonts used by the brand's website
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font>, nil]
+        optional :fonts,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font] }
+
+        # @!attribute logos
+        #   An array of logos associated with the brand
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo>, nil]
+        optional :logos,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo] }
+
+        # @!attribute slogan
+        #   The brand's slogan
+        #
+        #   @return [String, nil]
+        optional :slogan, String
+
+        # @!attribute socials
+        #   An array of social media links for the brand
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social>, nil]
+        optional :socials,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social] }
+
+        # @!attribute stock
+        #   Stock market information for this brand (will be null if not a publicly traded
+        #   company)
+        #
+        #   @return [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock, nil]
+        optional :stock, -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock }
+
+        # @!attribute title
+        #   The title or name of the brand
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {BrandDev::Models::BrandRetrieveByTickerResponse::Brand} for more details.
+        #
+        #   Detailed brand information
+        #
+        #   @param address [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address] Physical address of the brand
+        #
+        #   @param backdrops [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop>] An array of backdrop images for the brand
+        #
+        #   @param colors [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color>] An array of brand colors
+        #
+        #   @param description [String] A brief description of the brand
+        #
+        #   @param domain [String] The domain name of the brand
+        #
+        #   @param fonts [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font>] An array of fonts used by the brand's website
+        #
+        #   @param logos [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo>] An array of logos associated with the brand
+        #
+        #   @param slogan [String] The brand's slogan
+        #
+        #   @param socials [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social>] An array of social media links for the brand
+        #
+        #   @param stock [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock] Stock market information for this brand (will be null if not a publicly traded c
+        #
+        #   @param title [String] The title or name of the brand
+
+        # @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand#address
+        class Address < BrandDev::Internal::Type::BaseModel
+          # @!attribute city
+          #   City name
+          #
+          #   @return [String, nil]
+          optional :city, String
+
+          # @!attribute country
+          #   Country name
+          #
+          #   @return [String, nil]
+          optional :country, String
+
+          # @!attribute country_code
+          #   Country code
+          #
+          #   @return [String, nil]
+          optional :country_code, String
+
+          # @!attribute postal_code
+          #   Postal or ZIP code
+          #
+          #   @return [String, nil]
+          optional :postal_code, String
+
+          # @!attribute state_code
+          #   State or province code
+          #
+          #   @return [String, nil]
+          optional :state_code, String
+
+          # @!attribute state_province
+          #   State or province name
+          #
+          #   @return [String, nil]
+          optional :state_province, String
+
+          # @!attribute street
+          #   Street address
+          #
+          #   @return [String, nil]
+          optional :street, String
+
+          # @!method initialize(city: nil, country: nil, country_code: nil, postal_code: nil, state_code: nil, state_province: nil, street: nil)
+          #   Physical address of the brand
+          #
+          #   @param city [String] City name
+          #
+          #   @param country [String] Country name
+          #
+          #   @param country_code [String] Country code
+          #
+          #   @param postal_code [String] Postal or ZIP code
+          #
+          #   @param state_code [String] State or province code
+          #
+          #   @param state_province [String] State or province name
+          #
+          #   @param street [String] Street address
+        end
+
+        class Backdrop < BrandDev::Internal::Type::BaseModel
+          # @!attribute colors
+          #   Array of colors in the backdrop image
+          #
+          #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color>, nil]
+          optional :colors,
+                   -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color] }
+
+          # @!attribute resolution
+          #   Resolution of the backdrop image
+          #
+          #   @return [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution, nil]
+          optional :resolution, -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution }
+
+          # @!attribute url
+          #   URL of the backdrop image
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(colors: nil, resolution: nil, url: nil)
+          #   @param colors [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color>] Array of colors in the backdrop image
+          #
+          #   @param resolution [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution] Resolution of the backdrop image
+          #
+          #   @param url [String] URL of the backdrop image
+
+          class Color < BrandDev::Internal::Type::BaseModel
+            # @!attribute hex
+            #   Color in hexadecimal format
+            #
+            #   @return [String, nil]
+            optional :hex, String
+
+            # @!attribute name
+            #   Name of the color
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(hex: nil, name: nil)
+            #   @param hex [String] Color in hexadecimal format
+            #
+            #   @param name [String] Name of the color
+          end
+
+          # @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop#resolution
+          class Resolution < BrandDev::Internal::Type::BaseModel
+            # @!attribute height
+            #   Height of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :height, Integer
+
+            # @!attribute width
+            #   Width of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :width, Integer
+
+            # @!method initialize(height: nil, width: nil)
+            #   Resolution of the backdrop image
+            #
+            #   @param height [Integer] Height of the image in pixels
+            #
+            #   @param width [Integer] Width of the image in pixels
+          end
+        end
+
+        class Color < BrandDev::Internal::Type::BaseModel
+          # @!attribute hex
+          #   Color in hexadecimal format
+          #
+          #   @return [String, nil]
+          optional :hex, String
+
+          # @!attribute name
+          #   Name of the color
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(hex: nil, name: nil)
+          #   @param hex [String] Color in hexadecimal format
+          #
+          #   @param name [String] Name of the color
+        end
+
+        class Font < BrandDev::Internal::Type::BaseModel
+          # @!attribute name
+          #   Name of the font
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute usage
+          #   Usage of the font, e.g., 'title', 'body', 'button'
+          #
+          #   @return [String, nil]
+          optional :usage, String
+
+          # @!method initialize(name: nil, usage: nil)
+          #   @param name [String] Name of the font
+          #
+          #   @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
+        end
+
+        class Logo < BrandDev::Internal::Type::BaseModel
+          # @!attribute colors
+          #   Array of colors in the logo
+          #
+          #   @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color>, nil]
+          optional :colors,
+                   -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color] }
+
+          # @!attribute group
+          #   Group identifier for logos
+          #
+          #   @return [Integer, nil]
+          optional :group, Integer
+
+          # @!attribute mode
+          #   Mode of the logo, e.g., 'dark', 'light'
+          #
+          #   @return [String, nil]
+          optional :mode, String
+
+          # @!attribute resolution
+          #   Resolution of the logo image
+          #
+          #   @return [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution, nil]
+          optional :resolution, -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution }
+
+          # @!attribute url
+          #   URL of the logo image
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(colors: nil, group: nil, mode: nil, resolution: nil, url: nil)
+          #   @param colors [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color>] Array of colors in the logo
+          #
+          #   @param group [Integer] Group identifier for logos
+          #
+          #   @param mode [String] Mode of the logo, e.g., 'dark', 'light'
+          #
+          #   @param resolution [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution] Resolution of the logo image
+          #
+          #   @param url [String] URL of the logo image
+
+          class Color < BrandDev::Internal::Type::BaseModel
+            # @!attribute hex
+            #   Color in hexadecimal format
+            #
+            #   @return [String, nil]
+            optional :hex, String
+
+            # @!attribute name
+            #   Name of the color
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(hex: nil, name: nil)
+            #   @param hex [String] Color in hexadecimal format
+            #
+            #   @param name [String] Name of the color
+          end
+
+          # @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo#resolution
+          class Resolution < BrandDev::Internal::Type::BaseModel
+            # @!attribute height
+            #   Height of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :height, Integer
+
+            # @!attribute width
+            #   Width of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :width, Integer
+
+            # @!method initialize(height: nil, width: nil)
+            #   Resolution of the logo image
+            #
+            #   @param height [Integer] Height of the image in pixels
+            #
+            #   @param width [Integer] Width of the image in pixels
+          end
+        end
+
+        class Social < BrandDev::Internal::Type::BaseModel
+          # @!attribute type
+          #   Type of social media, e.g., 'facebook', 'twitter'
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!attribute url
+          #   URL of the social media page
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(type: nil, url: nil)
+          #   @param type [String] Type of social media, e.g., 'facebook', 'twitter'
+          #
+          #   @param url [String] URL of the social media page
+        end
+
+        # @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand#stock
+        class Stock < BrandDev::Internal::Type::BaseModel
+          # @!attribute exchange
+          #   Stock exchange name
+          #
+          #   @return [String, nil]
+          optional :exchange, String
+
+          # @!attribute ticker
+          #   Stock ticker symbol
+          #
+          #   @return [String, nil]
+          optional :ticker, String
+
+          # @!method initialize(exchange: nil, ticker: nil)
+          #   Stock market information for this brand (will be null if not a publicly traded
+          #   company)
+          #
+          #   @param exchange [String] Stock exchange name
+          #
+          #   @param ticker [String] Stock ticker symbol
+        end
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_retrieve_naics_params.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#retrieve_naics
+    class BrandRetrieveNaicsParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute input
+      #   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.
+      #
+      #   @return [String]
+      required :input, String
+
+      # @!method initialize(input:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::Models::BrandRetrieveNaicsParams} for more details.
+      #
+      #   @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_retrieve_naics_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#retrieve_naics
+    class BrandRetrieveNaicsResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute codes
+      #   Array of NAICS codes and titles.
+      #
+      #   @return [Array<BrandDev::Models::BrandRetrieveNaicsResponse::Code>, nil]
+      optional :codes,
+               -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveNaicsResponse::Code] }
+
+      # @!attribute domain
+      #   Domain found for the brand
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute type
+      #   Industry classification type, for naics api it will be `naics`
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(codes: nil, domain: nil, status: nil, type: nil)
+      #   @param codes [Array<BrandDev::Models::BrandRetrieveNaicsResponse::Code>] Array of NAICS codes and titles.
+      #
+      #   @param domain [String] Domain found for the brand
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+      #
+      #   @param type [String] Industry classification type, for naics api it will be `naics`
+
+      class Code < BrandDev::Internal::Type::BaseModel
+        # @!attribute code
+        #   NAICS code
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute title
+        #   NAICS title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(code: nil, title: nil)
+        #   @param code [String] NAICS code
+        #
+        #   @param title [String] NAICS title
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_retrieve_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#retrieve
+    class BrandRetrieveParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to retrieve brand data for
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute force_language
+      #   Optional parameter to force the language of the retrieved brand data
+      #
+      #   @return [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage, nil]
+      optional :force_language, enum: -> { BrandDev::BrandRetrieveParams::ForceLanguage }
+
+      # @!method initialize(domain:, force_language: nil, request_options: {})
+      #   @param domain [String] Domain name to retrieve brand data for
+      #
+      #   @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Optional parameter to force the language of the retrieved brand data
+      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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end