brand.dev 0.0.1.pre.alpha.0

data/rbi/brand_dev/models/brand_search_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandSearchParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(BrandDev::BrandSearchParams, BrandDev::Internal::AnyHash)
+        end
+
+      # Query string to search brands
+      sig { returns(String) }
+      attr_accessor :query
+
+      sig do
+        params(
+          query: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Query string to search brands
+        query:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { query: String, request_options: BrandDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/brand_dev/models/brand_search_response.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module BrandDev
+  module Models
+    class BrandSearchResponseItem < BrandDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            BrandDev::Models::BrandSearchResponseItem,
+            BrandDev::Internal::AnyHash
+          )
+        end
+
+      # Domain name of the brand
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # URL of the brand's logo
+      sig { returns(T.nilable(String)) }
+      attr_reader :logo
+
+      sig { params(logo: String).void }
+      attr_writer :logo
+
+      # Title or name of the brand
+      sig { returns(T.nilable(String)) }
+      attr_reader :title
+
+      sig { params(title: String).void }
+      attr_writer :title
+
+      sig do
+        params(domain: String, logo: String, title: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Domain name of the brand
+        domain: nil,
+        # URL of the brand's logo
+        logo: nil,
+        # Title or name of the brand
+        title: nil
+      )
+      end
+
+      sig { override.returns({ domain: String, logo: String, title: String }) }
+      def to_hash
+      end
+    end
+
+    BrandSearchResponse =
+      T.let(
+        BrandDev::Internal::Type::ArrayOf[
+          BrandDev::Models::BrandSearchResponseItem
+        ],
+        BrandDev::Internal::Type::Converter
+      )
+  end
+end

data/rbi/brand_dev/models.rbi

@@ -0,0 +1,14 @@
+# typed: strong
+
+module BrandDev
+  BrandIdentifyFromTransactionParams =
+    BrandDev::Models::BrandIdentifyFromTransactionParams
+
+  BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
+
+  BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams
+
+  BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
+
+  BrandSearchParams = BrandDev::Models::BrandSearchParams
+end

data/rbi/brand_dev/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+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
+    OrHash =
+      T.type_alias do
+        T.any(BrandDev::RequestOptions, BrandDev::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: BrandDev::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: BrandDev::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/brand_dev/resources/brand.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module BrandDev
+  module Resources
+    class Brand
+      # Retrieve brand data by domain
+      sig do
+        params(
+          domain: String,
+          force_language:
+            BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandRetrieveResponse)
+      end
+      def retrieve(
+        # 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
+
+      # Endpoint specially designed for platforms that want to identify transaction data
+      # by the transaction title.
+      sig do
+        params(
+          transaction_info: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandIdentifyFromTransactionResponse)
+      end
+      def identify_from_transaction(
+        # Transaction information to identify the brand
+        transaction_info:,
+        request_options: {}
+      )
+      end
+
+      # Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
+      sig do
+        params(
+          ticker: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandRetrieveByTickerResponse)
+      end
+      def retrieve_by_ticker(
+        # Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
+        ticker:,
+        request_options: {}
+      )
+      end
+
+      # Endpoint to classify any brand into a 2022 NAICS code.
+      sig do
+        params(
+          input: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(BrandDev::Models::BrandRetrieveNaicsResponse)
+      end
+      def retrieve_naics(
+        # 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
+
+      # Search brands by query
+      sig do
+        params(
+          query: String,
+          request_options: BrandDev::RequestOptions::OrHash
+        ).returns(T::Array[BrandDev::Models::BrandSearchResponseItem])
+      end
+      def search(
+        # Query string to search brands
+        query:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: BrandDev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/brand_dev/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module BrandDev
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/brand_dev/client.rbs

@@ -0,0 +1,26 @@
+module BrandDev
+  class Client < BrandDev::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader brand: BrandDev::Resources::Brand
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/brand_dev/errors.rbs

@@ -0,0 +1,101 @@
+module BrandDev
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < BrandDev::Errors::Error
+    end
+
+    class APIError < BrandDev::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < BrandDev::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < BrandDev::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < BrandDev::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < BrandDev::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/brand_dev/file_part.rbs

@@ -0,0 +1,21 @@
+module BrandDev
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: String?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/brand_dev/internal/transport/base_client.rbs

@@ -0,0 +1,131 @@
+module BrandDev
+  module Internal
+    module Transport
+      class BaseClient
+        extend BrandDev::Internal::Util::SorbetRuntimeSupport
+
+        type request_components =
+          {
+            method: Symbol,
+            path: String | ::Array[String],
+            query: ::Hash[String, (::Array[String] | String)?]?,
+            headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?]?,
+            body: top?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
+            page: Class?,
+            stream: Class?,
+            model: BrandDev::Internal::Type::Converter::input?,
+            options: BrandDev::request_opts?
+          }
+        type request_input =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            max_retries: Integer,
+            timeout: Float
+          }
+
+        MAX_REDIRECTS: 20
+
+        PLATFORM_HEADERS: ::Hash[String, String]
+
+        def self.validate!: (
+          BrandDev::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          BrandDev::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> BrandDev::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | BrandDev::Errors::APIConnectionError status,
+          stream: Enumerable[String]?
+        ) -> void
+
+        attr_reader base_url: URI::Generic
+
+        attr_reader timeout: Float
+
+        attr_reader max_retries: Integer
+
+        attr_reader initial_retry_delay: Float
+
+        attr_reader max_retry_delay: Float
+
+        attr_reader headers: ::Hash[String, String]
+
+        attr_reader idempotency_header: String?
+
+        # @api private
+        attr_reader requester: BrandDev::Internal::Transport::PooledNetRequester
+
+        def initialize: (
+          base_url: String,
+          ?timeout: Float,
+          ?max_retries: Integer,
+          ?initial_retry_delay: Float,
+          ?max_retry_delay: Float,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?],
+          ?idempotency_header: String?
+        ) -> void
+
+        private def auth_headers: -> ::Hash[String, String]
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          BrandDev::Internal::Transport::BaseClient::request_components req,
+          BrandDev::request_options opts
+        ) -> BrandDev::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        private def send_request: (
+          BrandDev::Internal::Transport::BaseClient::request_input request,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: bool
+        ) -> [Integer, top, Enumerable[String]]
+
+        def request: (
+          Symbol method,
+          String | ::Array[String] path,
+          ?query: ::Hash[String, (::Array[String] | String)?]?,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?]?,
+          ?body: top?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: BrandDev::Internal::Type::Converter::input?,
+          ?options: BrandDev::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/brand_dev/internal/transport/pooled_net_requester.rbs

@@ -0,0 +1,45 @@
+module BrandDev
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend BrandDev::Internal::Util::SorbetRuntimeSupport
+
+        type request =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            deadline: Float
+          }
+
+        KEEP_ALIVE_TIMEOUT: 30
+
+        DEFAULT_MAX_CONNECTIONS: Integer
+
+        def self.connect: (URI::Generic url) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          BrandDev::Internal::Transport::PooledNetRequester::request request
+        ) {
+          (String arg0) -> void
+        } -> [top, (^-> void)]
+
+        private def with_pool: (
+          URI::Generic url,
+          deadline: Float
+        ) {
+          (top arg0) -> void
+        } -> void
+
+        def execute: (
+          BrandDev::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

data/sig/brand_dev/internal/type/array_of.rbs

@@ -0,0 +1,48 @@
+module BrandDev
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include BrandDev::Internal::Type::Converter
+        include BrandDev::Internal::Util::SorbetRuntimeSupport
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> BrandDev::Internal::Type::Converter::input
+          | BrandDev::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> instance
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          ::Array[top] | top value,
+          state: BrandDev::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: BrandDev::Internal::Type::Converter::dump_state
+        ) -> (::Array[top] | top)
+
+        def to_sorbet_type: -> top
+
+        def item_type: -> Elem
+
+        def nilable?: -> bool
+
+        def initialize: (
+          ::Hash[Symbol, top]
+          | ^-> BrandDev::Internal::Type::Converter::input
+          | BrandDev::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end