brand.dev 0.0.1.pre.alpha.0

data/lib/brand_dev/models/brand_retrieve_response.rb

@@ -0,0 +1,432 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#retrieve
+    class BrandRetrieveResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Detailed brand information
+      #
+      #   @return [BrandDev::Models::BrandRetrieveResponse::Brand, nil]
+      optional :brand, -> { BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand] Detailed brand information
+      #
+      #   @param code [Integer] HTTP status code
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+
+      # @see BrandDev::Models::BrandRetrieveResponse#brand
+      class Brand < BrandDev::Internal::Type::BaseModel
+        # @!attribute address
+        #   Physical address of the brand
+        #
+        #   @return [BrandDev::Models::BrandRetrieveResponse::Brand::Address, nil]
+        optional :address, -> { BrandDev::Models::BrandRetrieveResponse::Brand::Address }
+
+        # @!attribute backdrops
+        #   An array of backdrop images for the brand
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop>, nil]
+        optional :backdrops,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop] }
+
+        # @!attribute colors
+        #   An array of brand colors
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Color>, nil]
+        optional :colors,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand::Font>, nil]
+        optional :fonts,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Font] }
+
+        # @!attribute logos
+        #   An array of logos associated with the brand
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo>, nil]
+        optional :logos,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand::Social>, nil]
+        optional :socials,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Social] }
+
+        # @!attribute stock
+        #   Stock market information for this brand (will be null if not a publicly traded
+        #   company)
+        #
+        #   @return [BrandDev::Models::BrandRetrieveResponse::Brand::Stock, nil]
+        optional :stock, -> { BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand} for more details.
+        #
+        #   Detailed brand information
+        #
+        #   @param address [BrandDev::Models::BrandRetrieveResponse::Brand::Address] Physical address of the brand
+        #
+        #   @param backdrops [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop>] An array of backdrop images for the brand
+        #
+        #   @param colors [Array<BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand::Font>] An array of fonts used by the brand's website
+        #
+        #   @param logos [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo>] An array of logos associated with the brand
+        #
+        #   @param slogan [String] The brand's slogan
+        #
+        #   @param socials [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Social>] An array of social media links for the brand
+        #
+        #   @param stock [BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand::Backdrop::Color>, nil]
+          optional :colors,
+                   -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Color] }
+
+          # @!attribute resolution
+          #   Resolution of the backdrop image
+          #
+          #   @return [BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Resolution, nil]
+          optional :resolution, -> { BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand::Backdrop::Color>] Array of colors in the backdrop image
+          #
+          #   @param resolution [BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand::Logo::Color>, nil]
+          optional :colors,
+                   -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::Brand::Logo::Resolution, nil]
+          optional :resolution, -> { BrandDev::Models::BrandRetrieveResponse::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::BrandRetrieveResponse::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::BrandRetrieveResponse::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::BrandRetrieveResponse::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::BrandRetrieveResponse::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_search_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#search
+    class BrandSearchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute query
+      #   Query string to search brands
+      #
+      #   @return [String]
+      required :query, String
+
+      # @!method initialize(query:, request_options: {})
+      #   @param query [String] Query string to search brands
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/brand_dev/models/brand_search_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    class BrandSearchResponseItem < BrandDev::Internal::Type::BaseModel
+      # @!attribute domain
+      #   Domain name of the brand
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute logo
+      #   URL of the brand's logo
+      #
+      #   @return [String, nil]
+      optional :logo, String
+
+      # @!attribute title
+      #   Title or name of the brand
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(domain: nil, logo: nil, title: nil)
+      #   @param domain [String] Domain name of the brand
+      #
+      #   @param logo [String] URL of the brand's logo
+      #
+      #   @param title [String] Title or name of the brand
+    end
+
+    # @type [BrandDev::Internal::Type::Converter]
+    BrandSearchResponse = BrandDev::Internal::Type::ArrayOf[-> { BrandDev::Models::BrandSearchResponseItem }]
+  end
+end

data/lib/brand_dev/models.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module BrandDev
+  [BrandDev::Internal::Type::BaseModel, *BrandDev::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, BrandDev::Internal::AnyHash) } }
+  end
+
+  BrandDev::Internal::Util.walk_namespaces(BrandDev::Models).each do |mod|
+    case mod
+    in BrandDev::Internal::Type::Enum | BrandDev::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  BrandDev::Internal::Util.walk_namespaces(BrandDev::Models)
+                          .lazy
+                          .grep(BrandDev::Internal::Type::Union)
+                          .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
+
+  BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
+
+  BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams
+
+  BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
+
+  BrandSearchParams = BrandDev::Models::BrandSearchParams
+end

data/lib/brand_dev/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module BrandDev
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < BrandDev::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in BrandDev::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, BrandDev::Internal::Type::HashOf[BrandDev::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, BrandDev::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, BrandDev::Internal::Type::HashOf[BrandDev::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(BrandDev::RequestOptions, BrandDev::Internal::AnyHash) }
+    end
+  end
+end