context.dev 2.8.0 → 2.10.0

data/lib/context_dev/models/news_search_params.rb

@@ -0,0 +1,467 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::News#search
+    class NewsSearchParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute search_by
+      #   What to search for.
+      #
+      #   @return [ContextDev::Models::NewsSearchParams::SearchBy]
+      required :search_by, -> { ContextDev::NewsSearchParams::SearchBy }, api_name: :searchBy
+
+      # @!attribute cursor
+      #   Opaque next_cursor from the previous response, or null for the first page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute filter_by
+      #   Optional result filters.
+      #
+      #   @return [ContextDev::Models::NewsSearchParams::FilterBy, nil]
+      optional :filter_by, -> { ContextDev::NewsSearchParams::FilterBy }, api_name: :filterBy
+
+      # @!attribute limit
+      #   Maximum results to return. Defaults to 10.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute sort_by
+      #   Result ordering. Defaults to newest.
+      #
+      #   @return [ContextDev::Models::NewsSearchParams::SortBy, nil]
+      optional :sort_by, -> { ContextDev::NewsSearchParams::SortBy }, api_name: :sortBy
+
+      # @!attribute tags
+      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(search_by:, cursor: nil, filter_by: nil, limit: nil, sort_by: nil, tags: nil, request_options: {})
+      #   @param search_by [ContextDev::Models::NewsSearchParams::SearchBy] What to search for.
+      #
+      #   @param cursor [String, nil] Opaque next_cursor from the previous response, or null for the first page.
+      #
+      #   @param filter_by [ContextDev::Models::NewsSearchParams::FilterBy] Optional result filters.
+      #
+      #   @param limit [Integer] Maximum results to return. Defaults to 10.
+      #
+      #   @param sort_by [ContextDev::Models::NewsSearchParams::SortBy] Result ordering. Defaults to newest.
+      #
+      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      class SearchBy < ContextDev::Internal::Type::BaseModel
+        # @!attribute entity
+        #   The company to search news for, identified by name, domain, ticker, or ISIN.
+        #
+        #   @return [ContextDev::Models::NewsSearchParams::SearchBy::Entity::Name, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Domain, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Isin]
+        required :entity, union: -> { ContextDev::NewsSearchParams::SearchBy::Entity }
+
+        # @!attribute type
+        #   How to search. Only entity search is supported.
+        #
+        #   @return [Symbol, ContextDev::Models::NewsSearchParams::SearchBy::Type]
+        required :type, enum: -> { ContextDev::NewsSearchParams::SearchBy::Type }
+
+        # @!method initialize(entity:, type:)
+        #   What to search for.
+        #
+        #   @param entity [ContextDev::Models::NewsSearchParams::SearchBy::Entity::Name, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Domain, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Isin] The company to search news for, identified by name, domain, ticker, or ISIN.
+        #
+        #   @param type [Symbol, ContextDev::Models::NewsSearchParams::SearchBy::Type] How to search. Only entity search is supported.
+
+        # The company to search news for, identified by name, domain, ticker, or ISIN.
+        #
+        # @see ContextDev::Models::NewsSearchParams::SearchBy#entity
+        module Entity
+          extend ContextDev::Internal::Type::Union
+
+          discriminator :type
+
+          # Identify the company by name.
+          variant :name, -> { ContextDev::NewsSearchParams::SearchBy::Entity::Name }
+
+          # Identify the company by website domain.
+          variant :domain, -> { ContextDev::NewsSearchParams::SearchBy::Entity::Domain }
+
+          # Identify the company by stock ticker, optionally scoped to an exchange.
+          variant :ticker, -> { ContextDev::NewsSearchParams::SearchBy::Entity::Ticker }
+
+          # Identify the company by International Securities Identification Number.
+          variant :isin, -> { ContextDev::NewsSearchParams::SearchBy::Entity::Isin }
+
+          class Name < ContextDev::Internal::Type::BaseModel
+            # @!attribute name
+            #   Company name.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :name]
+            required :type, const: :name
+
+            # @!method initialize(name:, type: :name)
+            #   Identify the company by name.
+            #
+            #   @param name [String] Company name.
+            #
+            #   @param type [Symbol, :name]
+          end
+
+          class Domain < ContextDev::Internal::Type::BaseModel
+            # @!attribute domain
+            #   Company website domain, such as apple.com.
+            #
+            #   @return [String]
+            required :domain, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :domain]
+            required :type, const: :domain
+
+            # @!method initialize(domain:, type: :domain)
+            #   Identify the company by website domain.
+            #
+            #   @param domain [String] Company website domain, such as apple.com.
+            #
+            #   @param type [Symbol, :domain]
+          end
+
+          class Ticker < ContextDev::Internal::Type::BaseModel
+            # @!attribute ticker
+            #   Public-company ticker.
+            #
+            #   @return [String]
+            required :ticker, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :ticker]
+            required :type, const: :ticker
+
+            # @!attribute exchange
+            #   Stock exchange the ticker trades on, used to disambiguate tickers listed on
+            #   multiple exchanges.
+            #
+            #   @return [Symbol, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker::Exchange, nil]
+            optional :exchange, enum: -> { ContextDev::NewsSearchParams::SearchBy::Entity::Ticker::Exchange }
+
+            # @!method initialize(ticker:, exchange: nil, type: :ticker)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker} for more
+            #   details.
+            #
+            #   Identify the company by stock ticker, optionally scoped to an exchange.
+            #
+            #   @param ticker [String] Public-company ticker.
+            #
+            #   @param exchange [Symbol, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker::Exchange] Stock exchange the ticker trades on, used to disambiguate tickers listed on mult
+            #
+            #   @param type [Symbol, :ticker]
+
+            # Stock exchange the ticker trades on, used to disambiguate tickers listed on
+            # multiple exchanges.
+            #
+            # @see ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker#exchange
+            module Exchange
+              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
+
+          class Isin < ContextDev::Internal::Type::BaseModel
+            # @!attribute isin
+            #   International Securities Identification Number.
+            #
+            #   @return [String]
+            required :isin, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :isin]
+            required :type, const: :isin
+
+            # @!method initialize(isin:, type: :isin)
+            #   Identify the company by International Securities Identification Number.
+            #
+            #   @param isin [String] International Securities Identification Number.
+            #
+            #   @param type [Symbol, :isin]
+          end
+
+          # @!method self.variants
+          #   @return [Array(ContextDev::Models::NewsSearchParams::SearchBy::Entity::Name, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Domain, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Isin)]
+        end
+
+        # How to search. Only entity search is supported.
+        #
+        # @see ContextDev::Models::NewsSearchParams::SearchBy#type
+        module Type
+          extend ContextDev::Internal::Type::Enum
+
+          ENTITY = :entity
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class FilterBy < ContextDev::Internal::Type::BaseModel
+        # @!attribute article_language
+        #   Article languages to include. Up to 3.
+        #
+        #   @return [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::ArticleLanguage>, nil]
+        optional :article_language,
+                 -> {
+                   ContextDev::Internal::Type::ArrayOf[enum: ContextDev::NewsSearchParams::FilterBy::ArticleLanguage]
+                 },
+                 api_name: :articleLanguage
+
+        # @!attribute article_type
+        #   Article types to include. Up to 3.
+        #
+        #   @return [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::ArticleType>, nil]
+        optional :article_type,
+                 -> {
+                   ContextDev::Internal::Type::ArrayOf[enum: ContextDev::NewsSearchParams::FilterBy::ArticleType]
+                 },
+                 api_name: :articleType
+
+        # @!attribute date
+        #   Published-at window in epoch milliseconds.
+        #
+        #   @return [ContextDev::Models::NewsSearchParams::FilterBy::Date, nil]
+        optional :date, -> { ContextDev::NewsSearchParams::FilterBy::Date }
+
+        # @!attribute source_country
+        #   Publisher countries to include, as lowercase ISO 3166-1 alpha-2 codes. Up to 3.
+        #
+        #   @return [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::SourceCountry>, nil]
+        optional :source_country,
+                 -> {
+                   ContextDev::Internal::Type::ArrayOf[enum: ContextDev::NewsSearchParams::FilterBy::SourceCountry]
+                 },
+                 api_name: :sourceCountry
+
+        # @!attribute source_domain
+        #   Publisher domains to include. Up to 3.
+        #
+        #   @return [Array<String>, nil]
+        optional :source_domain, ContextDev::Internal::Type::ArrayOf[String], api_name: :sourceDomain
+
+        # @!method initialize(article_language: nil, article_type: nil, date: nil, source_country: nil, source_domain: nil)
+        #   Optional result filters.
+        #
+        #   @param article_language [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::ArticleLanguage>] Article languages to include. Up to 3.
+        #
+        #   @param article_type [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::ArticleType>] Article types to include. Up to 3.
+        #
+        #   @param date [ContextDev::Models::NewsSearchParams::FilterBy::Date] Published-at window in epoch milliseconds.
+        #
+        #   @param source_country [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::SourceCountry>] Publisher countries to include, as lowercase ISO 3166-1 alpha-2 codes. Up to 3.
+        #
+        #   @param source_domain [Array<String>] Publisher domains to include. Up to 3.
+
+        module ArticleLanguage
+          extend ContextDev::Internal::Type::Enum
+
+          AR = :ar
+          DE = :de
+          EN = :en
+          ES = :es
+          FR = :fr
+          HI = :hi
+          IT = :it
+          JA = :ja
+          KO = :ko
+          NL = :nl
+          PT = :pt
+          RU = :ru
+          ZH = :zh
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module ArticleType
+          extend ContextDev::Internal::Type::Enum
+
+          EDITORIAL = :editorial
+          PRESS_RELEASE = :press_release
+          REGULATORY_FILING = :regulatory_filing
+          ADVISORY = :advisory
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see ContextDev::Models::NewsSearchParams::FilterBy#date
+        class Date < ContextDev::Internal::Type::BaseModel
+          # @!attribute from
+          #   Inclusive start of the published-at window, in epoch milliseconds.
+          #
+          #   @return [Integer, nil]
+          optional :from, Integer
+
+          # @!attribute to
+          #   Inclusive end of the published-at window, in epoch milliseconds.
+          #
+          #   @return [Integer, nil]
+          optional :to, Integer
+
+          # @!method initialize(from: nil, to: nil)
+          #   Published-at window in epoch milliseconds.
+          #
+          #   @param from [Integer] Inclusive start of the published-at window, in epoch milliseconds.
+          #
+          #   @param to [Integer] Inclusive end of the published-at window, in epoch milliseconds.
+        end
+
+        module SourceCountry
+          extend ContextDev::Internal::Type::Enum
+
+          AE = :ae
+          AR = :ar
+          AU = :au
+          CA = :ca
+          CG = :cg
+          CH = :ch
+          CL = :cl
+          DE = :de
+          FI = :fi
+          FR = :fr
+          GB = :gb
+          HK = :hk
+          IL = :il
+          IN = :in
+          JP = :jp
+          KR = :kr
+          MX = :mx
+          NG = :ng
+          NL = :nl
+          QA = :qa
+          SA = :sa
+          SE = :se
+          SG = :sg
+          US = :us
+          ZA = :za
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class SortBy < ContextDev::Internal::Type::BaseModel
+        # @!attribute type
+        #   Result ordering.
+        #
+        #   @return [Symbol, ContextDev::Models::NewsSearchParams::SortBy::Type]
+        required :type, enum: -> { ContextDev::NewsSearchParams::SortBy::Type }
+
+        # @!method initialize(type:)
+        #   Result ordering. Defaults to newest.
+        #
+        #   @param type [Symbol, ContextDev::Models::NewsSearchParams::SortBy::Type] Result ordering.
+
+        # Result ordering.
+        #
+        # @see ContextDev::Models::NewsSearchParams::SortBy#type
+        module Type
+          extend ContextDev::Internal::Type::Enum
+
+          RELEVANCE = :relevance
+          NEWEST = :newest
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/news_search_response.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::News#search
+    class NewsSearchResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<ContextDev::Models::NewsSearchResponse::Data>]
+      required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::NewsSearchResponse::Data] }
+
+      # @!attribute has_more
+      #
+      #   @return [Boolean]
+      required :has_more, ContextDev::Internal::Type::Boolean
+
+      # @!attribute meta
+      #
+      #   @return [ContextDev::Models::NewsSearchResponse::Meta]
+      required :meta, -> { ContextDev::Models::NewsSearchResponse::Meta }
+
+      # @!attribute next_cursor
+      #
+      #   @return [String, nil]
+      required :next_cursor, String, nil?: true
+
+      # @!attribute key_metadata
+      #   Metadata about the API key used for the request. Included in every response
+      #   whenever a valid API key is provided, even when the response status is not 200.
+      #
+      #   @return [ContextDev::Models::NewsSearchResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::NewsSearchResponse::KeyMetadata }
+
+      # @!method initialize(data:, has_more:, meta:, next_cursor:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::NewsSearchResponse} for more details.
+      #
+      #   @param data [Array<ContextDev::Models::NewsSearchResponse::Data>]
+      #
+      #   @param has_more [Boolean]
+      #
+      #   @param meta [ContextDev::Models::NewsSearchResponse::Meta]
+      #
+      #   @param next_cursor [String, nil]
+      #
+      #   @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute authors
+        #
+        #   @return [Array<String>]
+        required :authors, ContextDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute image_url
+        #
+        #   @return [String, nil]
+        required :image_url, String, nil?: true
+
+        # @!attribute language
+        #
+        #   @return [String, nil]
+        required :language, String, nil?: true
+
+        # @!attribute match
+        #
+        #   @return [ContextDev::Models::NewsSearchResponse::Data::Match]
+        required :match, -> { ContextDev::Models::NewsSearchResponse::Data::Match }
+
+        # @!attribute published_at
+        #
+        #   @return [Time, nil]
+        required :published_at, Time, nil?: true
+
+        # @!attribute source
+        #
+        #   @return [ContextDev::Models::NewsSearchResponse::Data::Source]
+        required :source, -> { ContextDev::Models::NewsSearchResponse::Data::Source }
+
+        # @!attribute story_id
+        #   Groups matching normalized headlines published on the same UTC day.
+        #
+        #   @return [String]
+        required :story_id, String
+
+        # @!attribute title
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, ContextDev::Models::NewsSearchResponse::Data::Type]
+        required :type, enum: -> { ContextDev::Models::NewsSearchResponse::Data::Type }
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(id:, authors:, description:, image_url:, language:, match:, published_at:, source:, story_id:, title:, type:, url:)
+        #   @param id [String]
+        #
+        #   @param authors [Array<String>]
+        #
+        #   @param description [String, nil]
+        #
+        #   @param image_url [String, nil]
+        #
+        #   @param language [String, nil]
+        #
+        #   @param match [ContextDev::Models::NewsSearchResponse::Data::Match]
+        #
+        #   @param published_at [Time, nil]
+        #
+        #   @param source [ContextDev::Models::NewsSearchResponse::Data::Source]
+        #
+        #   @param story_id [String] Groups matching normalized headlines published on the same UTC day.
+        #
+        #   @param title [String]
+        #
+        #   @param type [Symbol, ContextDev::Models::NewsSearchResponse::Data::Type]
+        #
+        #   @param url [String]
+
+        # @see ContextDev::Models::NewsSearchResponse::Data#match
+        class Match < ContextDev::Internal::Type::BaseModel
+          # @!attribute confidence
+          #
+          #   @return [Float, nil]
+          required :confidence, Float, nil?: true
+
+          # @!attribute level
+          #
+          #   @return [Symbol, ContextDev::Models::NewsSearchResponse::Data::Match::Level]
+          required :level, enum: -> { ContextDev::Models::NewsSearchResponse::Data::Match::Level }
+
+          # @!method initialize(confidence:, level:)
+          #   @param confidence [Float, nil]
+          #   @param level [Symbol, ContextDev::Models::NewsSearchResponse::Data::Match::Level]
+
+          # @see ContextDev::Models::NewsSearchResponse::Data::Match#level
+          module Level
+            extend ContextDev::Internal::Type::Enum
+
+            PRIMARY = :primary
+            SECONDARY = :secondary
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see ContextDev::Models::NewsSearchResponse::Data#source
+        class Source < ContextDev::Internal::Type::BaseModel
+          # @!attribute direct
+          #   True when Context observed this article in the publisher-owned feed.
+          #
+          #   @return [Boolean]
+          required :direct, ContextDev::Internal::Type::Boolean
+
+          # @!attribute domain
+          #
+          #   @return [String]
+          required :domain, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(direct:, domain:, name:)
+          #   @param direct [Boolean] True when Context observed this article in the publisher-owned feed.
+          #
+          #   @param domain [String]
+          #
+          #   @param name [String]
+        end
+
+        # @see ContextDev::Models::NewsSearchResponse::Data#type
+        module Type
+          extend ContextDev::Internal::Type::Enum
+
+          EDITORIAL = :editorial
+          PRESS_RELEASE = :press_release
+          REGULATORY_FILING = :regulatory_filing
+          ADVISORY = :advisory
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see ContextDev::Models::NewsSearchResponse#meta
+      class Meta < ContextDev::Internal::Type::BaseModel
+        # @!attribute count
+        #
+        #   @return [Integer]
+        required :count, Integer
+
+        # @!method initialize(count:)
+        #   @param count [Integer]
+      end
+
+      # @see ContextDev::Models::NewsSearchResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   Metadata about the API key used for the request. Included in every response
+        #   whenever a valid API key is provided, even when the response status is not 200.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
+    end
+  end
+end