brand.dev 0.0.1.pre.alpha.0

data/sig/brand_dev/models/brand_retrieve_response.rbs

@@ -0,0 +1,418 @@
+module BrandDev
+  module Models
+    type brand_retrieve_response =
+      {
+        brand: BrandDev::Models::BrandRetrieveResponse::Brand,
+        code: Integer,
+        status: String
+      }
+
+    class BrandRetrieveResponse < BrandDev::Internal::Type::BaseModel
+      attr_reader brand: BrandDev::Models::BrandRetrieveResponse::Brand?
+
+      def brand=: (
+        BrandDev::Models::BrandRetrieveResponse::Brand
+      ) -> BrandDev::Models::BrandRetrieveResponse::Brand
+
+      attr_reader code: Integer?
+
+      def code=: (Integer) -> Integer
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      def initialize: (
+        ?brand: BrandDev::Models::BrandRetrieveResponse::Brand,
+        ?code: Integer,
+        ?status: String
+      ) -> void
+
+      def to_hash: -> {
+        brand: BrandDev::Models::BrandRetrieveResponse::Brand,
+        code: Integer,
+        status: String
+      }
+
+      type brand =
+        {
+          address: BrandDev::Models::BrandRetrieveResponse::Brand::Address,
+          backdrops: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop],
+          colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Color],
+          description: String,
+          domain: String,
+          fonts: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font],
+          logos: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo],
+          slogan: String,
+          socials: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social],
+          stock: BrandDev::Models::BrandRetrieveResponse::Brand::Stock,
+          title: String
+        }
+
+      class Brand < BrandDev::Internal::Type::BaseModel
+        attr_reader address: BrandDev::Models::BrandRetrieveResponse::Brand::Address?
+
+        def address=: (
+          BrandDev::Models::BrandRetrieveResponse::Brand::Address
+        ) -> BrandDev::Models::BrandRetrieveResponse::Brand::Address
+
+        attr_reader backdrops: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop]?
+
+        def backdrops=: (
+          ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop]
+
+        attr_reader colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Color]?
+
+        def colors=: (
+          ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Color]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Color]
+
+        attr_reader description: String?
+
+        def description=: (String) -> String
+
+        attr_reader domain: String?
+
+        def domain=: (String) -> String
+
+        attr_reader fonts: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font]?
+
+        def fonts=: (
+          ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font]
+
+        attr_reader logos: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo]?
+
+        def logos=: (
+          ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo]
+
+        attr_reader slogan: String?
+
+        def slogan=: (String) -> String
+
+        attr_reader socials: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social]?
+
+        def socials=: (
+          ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social]
+        ) -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social]
+
+        attr_reader stock: BrandDev::Models::BrandRetrieveResponse::Brand::Stock?
+
+        def stock=: (
+          BrandDev::Models::BrandRetrieveResponse::Brand::Stock
+        ) -> BrandDev::Models::BrandRetrieveResponse::Brand::Stock
+
+        attr_reader title: String?
+
+        def title=: (String) -> String
+
+        def initialize: (
+          ?address: BrandDev::Models::BrandRetrieveResponse::Brand::Address,
+          ?backdrops: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop],
+          ?colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Color],
+          ?description: String,
+          ?domain: String,
+          ?fonts: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font],
+          ?logos: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo],
+          ?slogan: String,
+          ?socials: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social],
+          ?stock: BrandDev::Models::BrandRetrieveResponse::Brand::Stock,
+          ?title: String
+        ) -> void
+
+        def to_hash: -> {
+          address: BrandDev::Models::BrandRetrieveResponse::Brand::Address,
+          backdrops: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop],
+          colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Color],
+          description: String,
+          domain: String,
+          fonts: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Font],
+          logos: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo],
+          slogan: String,
+          socials: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social],
+          stock: BrandDev::Models::BrandRetrieveResponse::Brand::Stock,
+          title: String
+        }
+
+        type address =
+          {
+            city: String,
+            country: String,
+            country_code: String,
+            postal_code: String,
+            state_code: String,
+            state_province: String,
+            street: String
+          }
+
+        class Address < BrandDev::Internal::Type::BaseModel
+          attr_reader city: String?
+
+          def city=: (String) -> String
+
+          attr_reader country: String?
+
+          def country=: (String) -> String
+
+          attr_reader country_code: String?
+
+          def country_code=: (String) -> String
+
+          attr_reader postal_code: String?
+
+          def postal_code=: (String) -> String
+
+          attr_reader state_code: String?
+
+          def state_code=: (String) -> String
+
+          attr_reader state_province: String?
+
+          def state_province=: (String) -> String
+
+          attr_reader street: String?
+
+          def street=: (String) -> String
+
+          def initialize: (
+            ?city: String,
+            ?country: String,
+            ?country_code: String,
+            ?postal_code: String,
+            ?state_code: String,
+            ?state_province: String,
+            ?street: String
+          ) -> void
+
+          def to_hash: -> {
+            city: String,
+            country: String,
+            country_code: String,
+            postal_code: String,
+            state_code: String,
+            state_province: String,
+            street: String
+          }
+        end
+
+        type backdrop =
+          {
+            colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Color],
+            resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Resolution,
+            url: String
+          }
+
+        class Backdrop < BrandDev::Internal::Type::BaseModel
+          attr_reader colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Color]?
+
+          def colors=: (
+            ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Color]
+          ) -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Color]
+
+          attr_reader resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Resolution?
+
+          def resolution=: (
+            BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Resolution
+          ) -> BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Resolution
+
+          attr_reader url: String?
+
+          def url=: (String) -> String
+
+          def initialize: (
+            ?colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Color],
+            ?resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Resolution,
+            ?url: String
+          ) -> void
+
+          def to_hash: -> {
+            colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Color],
+            resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop::Resolution,
+            url: String
+          }
+
+          type color = { hex: String, name: String }
+
+          class Color < BrandDev::Internal::Type::BaseModel
+            attr_reader hex: String?
+
+            def hex=: (String) -> String
+
+            attr_reader name: String?
+
+            def name=: (String) -> String
+
+            def initialize: (?hex: String, ?name: String) -> void
+
+            def to_hash: -> { hex: String, name: String }
+          end
+
+          type resolution = { height: Integer, width: Integer }
+
+          class Resolution < BrandDev::Internal::Type::BaseModel
+            attr_reader height: Integer?
+
+            def height=: (Integer) -> Integer
+
+            attr_reader width: Integer?
+
+            def width=: (Integer) -> Integer
+
+            def initialize: (?height: Integer, ?width: Integer) -> void
+
+            def to_hash: -> { height: Integer, width: Integer }
+          end
+        end
+
+        type color = { hex: String, name: String }
+
+        class Color < BrandDev::Internal::Type::BaseModel
+          attr_reader hex: String?
+
+          def hex=: (String) -> String
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          def initialize: (?hex: String, ?name: String) -> void
+
+          def to_hash: -> { hex: String, name: String }
+        end
+
+        type font = { name: String, usage: String }
+
+        class Font < BrandDev::Internal::Type::BaseModel
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          attr_reader usage: String?
+
+          def usage=: (String) -> String
+
+          def initialize: (?name: String, ?usage: String) -> void
+
+          def to_hash: -> { name: String, usage: String }
+        end
+
+        type logo =
+          {
+            colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color],
+            group: Integer,
+            mode: String,
+            resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution,
+            url: String
+          }
+
+        class Logo < BrandDev::Internal::Type::BaseModel
+          attr_reader colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color]?
+
+          def colors=: (
+            ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color]
+          ) -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color]
+
+          attr_reader group: Integer?
+
+          def group=: (Integer) -> Integer
+
+          attr_reader mode: String?
+
+          def mode=: (String) -> String
+
+          attr_reader resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution?
+
+          def resolution=: (
+            BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution
+          ) -> BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution
+
+          attr_reader url: String?
+
+          def url=: (String) -> String
+
+          def initialize: (
+            ?colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color],
+            ?group: Integer,
+            ?mode: String,
+            ?resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution,
+            ?url: String
+          ) -> void
+
+          def to_hash: -> {
+            colors: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color],
+            group: Integer,
+            mode: String,
+            resolution: BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution,
+            url: String
+          }
+
+          type color = { hex: String, name: String }
+
+          class Color < BrandDev::Internal::Type::BaseModel
+            attr_reader hex: String?
+
+            def hex=: (String) -> String
+
+            attr_reader name: String?
+
+            def name=: (String) -> String
+
+            def initialize: (?hex: String, ?name: String) -> void
+
+            def to_hash: -> { hex: String, name: String }
+          end
+
+          type resolution = { height: Integer, width: Integer }
+
+          class Resolution < BrandDev::Internal::Type::BaseModel
+            attr_reader height: Integer?
+
+            def height=: (Integer) -> Integer
+
+            attr_reader width: Integer?
+
+            def width=: (Integer) -> Integer
+
+            def initialize: (?height: Integer, ?width: Integer) -> void
+
+            def to_hash: -> { height: Integer, width: Integer }
+          end
+        end
+
+        type social = { type: String, url: String }
+
+        class Social < BrandDev::Internal::Type::BaseModel
+          attr_reader type: String?
+
+          def type=: (String) -> String
+
+          attr_reader url: String?
+
+          def url=: (String) -> String
+
+          def initialize: (?type: String, ?url: String) -> void
+
+          def to_hash: -> { type: String, url: String }
+        end
+
+        type stock = { exchange: String, ticker: String }
+
+        class Stock < BrandDev::Internal::Type::BaseModel
+          attr_reader exchange: String?
+
+          def exchange=: (String) -> String
+
+          attr_reader ticker: String?
+
+          def ticker=: (String) -> String
+
+          def initialize: (?exchange: String, ?ticker: String) -> void
+
+          def to_hash: -> { exchange: String, ticker: String }
+        end
+      end
+    end
+  end
+end

data/sig/brand_dev/models/brand_search_params.rbs

@@ -0,0 +1,23 @@
+module BrandDev
+  module Models
+    type brand_search_params =
+      { query: String } & BrandDev::Internal::Type::request_parameters
+
+    class BrandSearchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      attr_accessor query: String
+
+      def initialize: (
+        query: String,
+        ?request_options: BrandDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        query: String,
+        request_options: BrandDev::RequestOptions
+      }
+    end
+  end
+end

data/sig/brand_dev/models/brand_search_response.rbs

@@ -0,0 +1,29 @@
+module BrandDev
+  module Models
+    type brand_search_response_item =
+      { domain: String, logo: String, title: String }
+
+    class BrandSearchResponseItem < BrandDev::Internal::Type::BaseModel
+      attr_reader domain: String?
+
+      def domain=: (String) -> String
+
+      attr_reader logo: String?
+
+      def logo=: (String) -> String
+
+      attr_reader title: String?
+
+      def title=: (String) -> String
+
+      def initialize: (?domain: String, ?logo: String, ?title: String) -> void
+
+      def to_hash: -> { domain: String, logo: String, title: String }
+    end
+
+    type brand_search_response =
+      ::Array[BrandDev::Models::BrandSearchResponseItem]
+
+    BrandSearchResponse: BrandDev::Internal::Type::Converter
+  end
+end

data/sig/brand_dev/models.rbs

@@ -0,0 +1,11 @@
+module BrandDev
+  class BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
+
+  class BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
+
+  class BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams
+
+  class BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
+
+  class BrandSearchParams = BrandDev::Models::BrandSearchParams
+end

data/sig/brand_dev/request_options.rbs

@@ -0,0 +1,34 @@
+module BrandDev
+  type request_opts =
+    BrandDev::RequestOptions | BrandDev::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < BrandDev::Internal::Type::BaseModel
+    def self.validate!: (BrandDev::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?BrandDev::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/brand_dev/resources/brand.rbs

@@ -0,0 +1,33 @@
+module BrandDev
+  module Resources
+    class Brand
+      def retrieve: (
+        domain: String,
+        ?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::BrandRetrieveResponse
+
+      def identify_from_transaction: (
+        transaction_info: String,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::BrandIdentifyFromTransactionResponse
+
+      def retrieve_by_ticker: (
+        ticker: String,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::BrandRetrieveByTickerResponse
+
+      def retrieve_naics: (
+        input: String,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::BrandRetrieveNaicsResponse
+
+      def search: (
+        query: String,
+        ?request_options: BrandDev::request_opts
+      ) -> BrandDev::Models::brand_search_response
+
+      def initialize: (client: BrandDev::Client) -> void
+    end
+  end
+end

data/sig/brand_dev/version.rbs

@@ -0,0 +1,3 @@
+module BrandDev
+  VERSION: String
+end