context.dev 0.0.2

data/rbi/context_dev/models/brand_retrieve_naics_params.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::BrandRetrieveNaicsParams,
+            ContextDev::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
+
+      # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
+      # to 5.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_results
+
+      sig { params(max_results: Integer).void }
+      attr_writer :max_results
+
+      # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_results
+
+      sig { params(min_results: Integer).void }
+      attr_writer :min_results
+
+      # Optional timeout in milliseconds for the request. If the request takes longer
+      # than this value, it will be aborted with a 408 status code. Maximum allowed
+      # value is 300000ms (5 minutes).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
+      sig do
+        params(
+          input: String,
+          max_results: Integer,
+          min_results: Integer,
+          timeout_ms: Integer,
+          request_options: ContextDev::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:,
+        # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
+        # to 5.
+        max_results: nil,
+        # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+        min_results: nil,
+        # Optional timeout in milliseconds for the request. If the request takes longer
+        # than this value, it will be aborted with a 408 status code. Maximum allowed
+        # value is 300000ms (5 minutes).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            input: String,
+            max_results: Integer,
+            min_results: Integer,
+            timeout_ms: Integer,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/context_dev/models/brand_retrieve_naics_response.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::BrandRetrieveNaicsResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Array of NAICS codes and titles.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code]
+          )
+        )
+      end
+      attr_reader :codes
+
+      sig do
+        params(
+          codes:
+            T::Array[
+              ContextDev::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[
+              ContextDev::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[ContextDev::Models::BrandRetrieveNaicsResponse::Code],
+            domain: String,
+            status: String,
+            type: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Code < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::BrandRetrieveNaicsResponse::Code,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # NAICS code
+        sig { returns(String) }
+        attr_accessor :code
+
+        # Confidence level for how well this NAICS code matches the company description
+        sig do
+          returns(
+            ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+          )
+        end
+        attr_accessor :confidence
+
+        # NAICS title
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          params(
+            code: String,
+            confidence:
+              ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::OrSymbol,
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # NAICS code
+          code:,
+          # Confidence level for how well this NAICS code matches the company description
+          confidence:,
+          # NAICS title
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              confidence:
+                ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol,
+              name: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Confidence level for how well this NAICS code matches the company description
+        module Confidence
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIGH =
+            T.let(
+              :high,
+              ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+            )
+          LOW =
+            T.let(
+              :low,
+              ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/brand_retrieve_params.rbi

@@ -0,0 +1,382 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandRetrieveParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::BrandRetrieveParams, ContextDev::Internal::AnyHash)
+        end
+
+      # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
+      # Cannot be used with name or ticker parameters.
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # Optional parameter to force the language of the retrieved brand data. Works with
+      # all three lookup methods.
+      sig do
+        returns(
+          T.nilable(ContextDev::BrandRetrieveParams::ForceLanguage::OrSymbol)
+        )
+      end
+      attr_reader :force_language
+
+      sig do
+        params(
+          force_language:
+            ContextDev::BrandRetrieveParams::ForceLanguage::OrSymbol
+        ).void
+      end
+      attr_writer :force_language
+
+      # Optional parameter to optimize the API call for maximum speed. When set to true,
+      # the API will skip time-consuming operations for faster response at the cost of
+      # less comprehensive data. Works with all three lookup methods.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :max_speed
+
+      sig { params(max_speed: T::Boolean).void }
+      attr_writer :max_speed
+
+      # Optional timeout in milliseconds for the request. If the request takes longer
+      # than this value, it will be aborted with a 408 status code. Maximum allowed
+      # value is 300000ms (5 minutes).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout_ms
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
+      sig do
+        params(
+          domain: String,
+          force_language:
+            ContextDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+          max_speed: T::Boolean,
+          timeout_ms: Integer,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
+        # Cannot be used with name or ticker parameters.
+        domain:,
+        # Optional parameter to force the language of the retrieved brand data. Works with
+        # all three lookup methods.
+        force_language: nil,
+        # Optional parameter to optimize the API call for maximum speed. When set to true,
+        # the API will skip time-consuming operations for faster response at the cost of
+        # less comprehensive data. Works with all three lookup methods.
+        max_speed: nil,
+        # Optional timeout in milliseconds for the request. If the request takes longer
+        # than this value, it will be aborted with a 408 status code. Maximum allowed
+        # value is 300000ms (5 minutes).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            domain: String,
+            force_language:
+              ContextDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
+            max_speed: T::Boolean,
+            timeout_ms: Integer,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Optional parameter to force the language of the retrieved brand data. Works with
+      # all three lookup methods.
+      module ForceLanguage
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::BrandRetrieveParams::ForceLanguage)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALBANIAN =
+          T.let(
+            :albanian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        ARABIC =
+          T.let(
+            :arabic,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        AZERI =
+          T.let(
+            :azeri,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        BENGALI =
+          T.let(
+            :bengali,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        BULGARIAN =
+          T.let(
+            :bulgarian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        CEBUANO =
+          T.let(
+            :cebuano,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        CROATIAN =
+          T.let(
+            :croatian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        CZECH =
+          T.let(
+            :czech,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        DANISH =
+          T.let(
+            :danish,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        DUTCH =
+          T.let(
+            :dutch,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        ENGLISH =
+          T.let(
+            :english,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        ESTONIAN =
+          T.let(
+            :estonian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        FARSI =
+          T.let(
+            :farsi,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        FINNISH =
+          T.let(
+            :finnish,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        FRENCH =
+          T.let(
+            :french,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        GERMAN =
+          T.let(
+            :german,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        HAUSA =
+          T.let(
+            :hausa,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        HAWAIIAN =
+          T.let(
+            :hawaiian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        HINDI =
+          T.let(
+            :hindi,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        HUNGARIAN =
+          T.let(
+            :hungarian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        ICELANDIC =
+          T.let(
+            :icelandic,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        INDONESIAN =
+          T.let(
+            :indonesian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        ITALIAN =
+          T.let(
+            :italian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        KAZAKH =
+          T.let(
+            :kazakh,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        KYRGYZ =
+          T.let(
+            :kyrgyz,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        LATIN =
+          T.let(
+            :latin,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        LATVIAN =
+          T.let(
+            :latvian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        LITHUANIAN =
+          T.let(
+            :lithuanian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        MACEDONIAN =
+          T.let(
+            :macedonian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        MONGOLIAN =
+          T.let(
+            :mongolian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        NEPALI =
+          T.let(
+            :nepali,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        NORWEGIAN =
+          T.let(
+            :norwegian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        PASHTO =
+          T.let(
+            :pashto,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        PIDGIN =
+          T.let(
+            :pidgin,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        POLISH =
+          T.let(
+            :polish,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        PORTUGUESE =
+          T.let(
+            :portuguese,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        ROMANIAN =
+          T.let(
+            :romanian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        RUSSIAN =
+          T.let(
+            :russian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        SERBIAN =
+          T.let(
+            :serbian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        SLOVAK =
+          T.let(
+            :slovak,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        SLOVENE =
+          T.let(
+            :slovene,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        SOMALI =
+          T.let(
+            :somali,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        SPANISH =
+          T.let(
+            :spanish,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        SWAHILI =
+          T.let(
+            :swahili,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        SWEDISH =
+          T.let(
+            :swedish,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        TAGALOG =
+          T.let(
+            :tagalog,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        TURKISH =
+          T.let(
+            :turkish,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        UKRAINIAN =
+          T.let(
+            :ukrainian,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        URDU =
+          T.let(
+            :urdu,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        UZBEK =
+          T.let(
+            :uzbek,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        VIETNAMESE =
+          T.let(
+            :vietnamese,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+        WELSH =
+          T.let(
+            :welsh,
+            ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end