context.dev 1.35.0 → 2.0.0

data/lib/context_dev/models/brand_retrieve_by_ticker_params.rb

@@ -1,283 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Brand#retrieve_by_ticker
-    class BrandRetrieveByTickerParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      # @!attribute ticker
-      #   Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
-      #   Must be 1-15 characters, letters/numbers/dots only.
-      #
-      #   @return [String]
-      required :ticker, String
-
-      # @!attribute force_language
-      #   Optional parameter to force the language of the retrieved brand data.
-      #
-      #   @return [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::ForceLanguage, nil]
-      optional :force_language, enum: -> { ContextDev::BrandRetrieveByTickerParams::ForceLanguage }
-
-      # @!attribute max_age_ms
-      #   Maximum age in milliseconds for cached brand data before the API performs a hard
-      #   refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
-      #   are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-      #   year.
-      #
-      #   @return [Integer, nil]
-      optional :max_age_ms, Integer
-
-      # @!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.
-      #
-      #   @return [Boolean, nil]
-      optional :max_speed, ContextDev::Internal::Type::Boolean
-
-      # @!attribute ticker_exchange
-      #   Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
-      #
-      #   @return [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::TickerExchange, nil]
-      optional :ticker_exchange, enum: -> { ContextDev::BrandRetrieveByTickerParams::TickerExchange }
-
-      # @!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(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::BrandRetrieveByTickerParams} for more details.
-      #
-      #   @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
-      #
-      #   @param force_language [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
-      #
-      #   @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
-      #
-      #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
-      #
-      #   @param ticker_exchange [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
-      #
-      #   @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.
-      module ForceLanguage
-        extend ContextDev::Internal::Type::Enum
-
-        AFRIKAANS = :afrikaans
-        ALBANIAN = :albanian
-        AMHARIC = :amharic
-        ARABIC = :arabic
-        ARMENIAN = :armenian
-        ASSAMESE = :assamese
-        AYMARA = :aymara
-        AZERI = :azeri
-        BASQUE = :basque
-        BELARUSIAN = :belarusian
-        BENGALI = :bengali
-        BOSNIAN = :bosnian
-        BULGARIAN = :bulgarian
-        BURMESE = :burmese
-        CANTONESE = :cantonese
-        CATALAN = :catalan
-        CEBUANO = :cebuano
-        CHINESE = :chinese
-        CORSICAN = :corsican
-        CROATIAN = :croatian
-        CZECH = :czech
-        DANISH = :danish
-        DUTCH = :dutch
-        ENGLISH = :english
-        ESPERANTO = :esperanto
-        ESTONIAN = :estonian
-        FARSI = :farsi
-        FIJIAN = :fijian
-        FINNISH = :finnish
-        FRENCH = :french
-        GALICIAN = :galician
-        GEORGIAN = :georgian
-        GERMAN = :german
-        GREEK = :greek
-        GUARANI = :guarani
-        GUJARATI = :gujarati
-        HAITIAN_CREOLE = :"haitian-creole"
-        HAUSA = :hausa
-        HAWAIIAN = :hawaiian
-        HEBREW = :hebrew
-        HINDI = :hindi
-        HMONG = :hmong
-        HUNGARIAN = :hungarian
-        ICELANDIC = :icelandic
-        IGBO = :igbo
-        INDONESIAN = :indonesian
-        IRISH = :irish
-        ITALIAN = :italian
-        JAPANESE = :japanese
-        JAVANESE = :javanese
-        KANNADA = :kannada
-        KAZAKH = :kazakh
-        KHMER = :khmer
-        KINYARWANDA = :kinyarwanda
-        KOREAN = :korean
-        KURDISH = :kurdish
-        KYRGYZ = :kyrgyz
-        LAO = :lao
-        LATIN = :latin
-        LATVIAN = :latvian
-        LINGALA = :lingala
-        LITHUANIAN = :lithuanian
-        LUXEMBOURGISH = :luxembourgish
-        MACEDONIAN = :macedonian
-        MALAGASY = :malagasy
-        MALAY = :malay
-        MALAYALAM = :malayalam
-        MALTESE = :maltese
-        MAORI = :maori
-        MARATHI = :marathi
-        MONGOLIAN = :mongolian
-        NEPALI = :nepali
-        NORWEGIAN = :norwegian
-        ODIA = :odia
-        OROMO = :oromo
-        PASHTO = :pashto
-        PIDGIN = :pidgin
-        POLISH = :polish
-        PORTUGUESE = :portuguese
-        PUNJABI = :punjabi
-        QUECHUA = :quechua
-        ROMANIAN = :romanian
-        RUSSIAN = :russian
-        SAMOAN = :samoan
-        SCOTTISH_GAELIC = :"scottish-gaelic"
-        SERBIAN = :serbian
-        SESOTHO = :sesotho
-        SHONA = :shona
-        SINDHI = :sindhi
-        SINHALA = :sinhala
-        SLOVAK = :slovak
-        SLOVENE = :slovene
-        SOMALI = :somali
-        SPANISH = :spanish
-        SUNDANESE = :sundanese
-        SWAHILI = :swahili
-        SWEDISH = :swedish
-        TAGALOG = :tagalog
-        TAJIK = :tajik
-        TAMIL = :tamil
-        TATAR = :tatar
-        TELUGU = :telugu
-        THAI = :thai
-        TIBETAN = :tibetan
-        TIGRINYA = :tigrinya
-        TONGAN = :tongan
-        TSWANA = :tswana
-        TURKISH = :turkish
-        TURKMEN = :turkmen
-        UKRAINIAN = :ukrainian
-        URDU = :urdu
-        UYGHUR = :uyghur
-        UZBEK = :uzbek
-        VIETNAMESE = :vietnamese
-        WELSH = :welsh
-        WOLOF = :wolof
-        XHOSA = :xhosa
-        YIDDISH = :yiddish
-        YORUBA = :yoruba
-        ZULU = :zulu
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
-      module TickerExchange
-        extend ContextDev::Internal::Type::Enum
-
-        AMEX = :AMEX
-        AMS = :AMS
-        AQS = :AQS
-        ASX = :ASX
-        ATH = :ATH
-        BER = :BER
-        BME = :BME
-        BRU = :BRU
-        BSE = :BSE
-        BUD = :BUD
-        BUE = :BUE
-        BVC = :BVC
-        CBOE = :CBOE
-        CNQ = :CNQ
-        CPH = :CPH
-        DFM = :DFM
-        DOH = :DOH
-        DUB = :DUB
-        DUS = :DUS
-        DXE = :DXE
-        EGX = :EGX
-        FSX = :FSX
-        HAM = :HAM
-        HEL = :HEL
-        HKSE = :HKSE
-        HOSE = :HOSE
-        ICE = :ICE
-        IOB = :IOB
-        IST = :IST
-        JKT = :JKT
-        JNB = :JNB
-        JPX = :JPX
-        KLS = :KLS
-        KOE = :KOE
-        KSC = :KSC
-        KUW = :KUW
-        LIS = :LIS
-        LSE = :LSE
-        MCX = :MCX
-        MEX = :MEX
-        MIL = :MIL
-        MUN = :MUN
-        NASDAQ = :NASDAQ
-        NEO = :NEO
-        NSE = :NSE
-        NYSE = :NYSE
-        NZE = :NZE
-        OSL = :OSL
-        OTC = :OTC
-        PAR = :PAR
-        PNK = :PNK
-        PRA = :PRA
-        RIS = :RIS
-        SAO = :SAO
-        SAU = :SAU
-        SES = :SES
-        SET = :SET
-        SGO = :SGO
-        SHH = :SHH
-        SHZ = :SHZ
-        SIX = :SIX
-        STO = :STO
-        STU = :STU
-        TAI = :TAI
-        TAL = :TAL
-        TLV = :TLV
-        TSX = :TSX
-        TSXV = :TSXV
-        TWO = :TWO
-        VIE = :VIE
-        WSE = :WSE
-        XETRA = :XETRA
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end