context.dev 0.0.2

data/lib/context_dev/models/brand_retrieve_naics_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#retrieve_naics
+    class BrandRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::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
+
+      # @!attribute max_results
+      #   Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
+      #   to 5.
+      #
+      #   @return [Integer, nil]
+      optional :max_results, Integer
+
+      # @!attribute min_results
+      #   Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      #
+      #   @return [Integer, nil]
+      optional :min_results, Integer
+
+      # @!attribute timeout_ms
+      #   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).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer
+
+      # @!method initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandRetrieveNaicsParams} for more details.
+      #
+      #   @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
+      #
+      #   @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5
+      #
+      #   @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_retrieve_naics_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#retrieve_naics
+    class BrandRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute codes
+      #   Array of NAICS codes and titles.
+      #
+      #   @return [Array<ContextDev::Models::BrandRetrieveNaicsResponse::Code>, nil]
+      optional :codes,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::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<ContextDev::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 < ContextDev::Internal::Type::BaseModel
+        # @!attribute code
+        #   NAICS code
+        #
+        #   @return [String]
+        required :code, String
+
+        # @!attribute confidence
+        #   Confidence level for how well this NAICS code matches the company description
+        #
+        #   @return [Symbol, ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence]
+        required :confidence, enum: -> { ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence }
+
+        # @!attribute name
+        #   NAICS title
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(code:, confidence:, name:)
+        #   @param code [String] NAICS code
+        #
+        #   @param confidence [Symbol, ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence] Confidence level for how well this NAICS code matches the company description
+        #
+        #   @param name [String] NAICS title
+
+        # Confidence level for how well this NAICS code matches the company description
+        #
+        # @see ContextDev::Models::BrandRetrieveNaicsResponse::Code#confidence
+        module Confidence
+          extend ContextDev::Internal::Type::Enum
+
+          HIGH = :high
+          MEDIUM = :medium
+          LOW = :low
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_retrieve_params.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#retrieve
+    class BrandRetrieveParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
+      #   Cannot be used with name or ticker parameters.
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute force_language
+      #   Optional parameter to force the language of the retrieved brand data. Works with
+      #   all three lookup methods.
+      #
+      #   @return [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage, nil]
+      optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::ForceLanguage }
+
+      # @!attribute max_speed
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :max_speed, ContextDev::Internal::Type::Boolean
+
+      # @!attribute timeout_ms
+      #   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).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer
+
+      # @!method initialize(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandRetrieveParams} for more details.
+      #
+      #   @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann
+      #
+      #   @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. Works with
+      #
+      #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Optional parameter to force the language of the retrieved brand data. Works with
+      # all three lookup methods.
+      module ForceLanguage
+        extend ContextDev::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