aylien_news_api 4.3.0 → 5.0.0

data/lib/aylien_news_api/models/entity.rb

@@ -3,7 +3,7 @@
 
 #The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client. 
 
-The version of the OpenAPI document: 3.0
+The version of the OpenAPI document: 5.0
 Contact: support@aylien.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0-SNAPSHOT
@@ -17,35 +17,38 @@ module AylienNewsApi
     # The unique ID of the entity
     attr_accessor :id
 
-    # The indices of the entity text
-    attr_accessor :indices
-
     attr_accessor :links
 
-    # The entity text
-    attr_accessor :text
-
-    # The stock_ticker of the entity (might be null)
-    attr_accessor :stock_ticker
+    # The stock tickers of the entity (might be empty)
+    attr_accessor :stock_tickers
 
     # An array of the entity types
     attr_accessor :types
 
-    attr_accessor :sentiment
+    attr_accessor :overall_sentiment
+
+    # Describes how relevant an entity is to the article
+    attr_accessor :overall_prominence
+
+    # Amount of entity surface form mentions in the article
+    attr_accessor :overall_frequency
+
+    attr_accessor :body
 
-    attr_accessor :surface_forms
+    attr_accessor :title
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'indices' => :'indices',
         :'links' => :'links',
-        :'text' => :'text',
-        :'stock_ticker' => :'stock_ticker',
+        :'stock_tickers' => :'stock_tickers',
         :'types' => :'types',
-        :'sentiment' => :'sentiment',
-        :'surface_forms' => :'surface_forms'
+        :'overall_sentiment' => :'overall_sentiment',
+        :'overall_prominence' => :'overall_prominence',
+        :'overall_frequency' => :'overall_frequency',
+        :'body' => :'body',
+        :'title' => :'title'
       }
     end
 
@@ -53,13 +56,14 @@ module AylienNewsApi
     def self.openapi_types
       {
         :'id' => :'String',
-        :'indices' => :'Array<Array<Integer>>',
         :'links' => :'EntityLinks',
-        :'text' => :'String',
-        :'stock_ticker' => :'String',
+        :'stock_tickers' => :'Array<String>',
         :'types' => :'Array<String>',
-        :'sentiment' => :'EntitySentiment',
-        :'surface_forms' => :'Array<EntitySurfaceForm>'
+        :'overall_sentiment' => :'EntitySentiment',
+        :'overall_prominence' => :'Float',
+        :'overall_frequency' => :'Integer',
+        :'body' => :'EntityInText',
+        :'title' => :'EntityInText'
       }
     end
 
@@ -88,22 +92,14 @@ module AylienNewsApi
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'indices')
-        if (value = attributes[:'indices']).is_a?(Array)
-          self.indices = value
-        end
-      end
-
       if attributes.key?(:'links')
         self.links = attributes[:'links']
       end
 
-      if attributes.key?(:'text')
-        self.text = attributes[:'text']
-      end
-
-      if attributes.key?(:'stock_ticker')
-        self.stock_ticker = attributes[:'stock_ticker']
+      if attributes.key?(:'stock_tickers')
+        if (value = attributes[:'stock_tickers']).is_a?(Array)
+          self.stock_tickers = value
+        end
       end
 
       if attributes.key?(:'types')
@@ -112,14 +108,24 @@ module AylienNewsApi
         end
       end
 
-      if attributes.key?(:'sentiment')
-        self.sentiment = attributes[:'sentiment']
+      if attributes.key?(:'overall_sentiment')
+        self.overall_sentiment = attributes[:'overall_sentiment']
       end
 
-      if attributes.key?(:'surface_forms')
-        if (value = attributes[:'surface_forms']).is_a?(Array)
-          self.surface_forms = value
-        end
+      if attributes.key?(:'overall_prominence')
+        self.overall_prominence = attributes[:'overall_prominence']
+      end
+
+      if attributes.key?(:'overall_frequency')
+        self.overall_frequency = attributes[:'overall_frequency']
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
       end
     end
 
@@ -127,28 +133,68 @@ module AylienNewsApi
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@overall_prominence.nil? && @overall_prominence > 1
+        invalid_properties.push('invalid value for "overall_prominence", must be smaller than or equal to 1.')
+      end
+
+      if !@overall_prominence.nil? && @overall_prominence < 0
+        invalid_properties.push('invalid value for "overall_prominence", must be greater than or equal to 0.')
+      end
+
+      if !@overall_frequency.nil? && @overall_frequency < 0
+        invalid_properties.push('invalid value for "overall_frequency", must be greater than or equal to 0.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@overall_prominence.nil? && @overall_prominence > 1
+      return false if !@overall_prominence.nil? && @overall_prominence < 0
+      return false if !@overall_frequency.nil? && @overall_frequency < 0
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] overall_prominence Value to be assigned
+    def overall_prominence=(overall_prominence)
+      if !overall_prominence.nil? && overall_prominence > 1
+        fail ArgumentError, 'invalid value for "overall_prominence", must be smaller than or equal to 1.'
+      end
+
+      if !overall_prominence.nil? && overall_prominence < 0
+        fail ArgumentError, 'invalid value for "overall_prominence", must be greater than or equal to 0.'
+      end
+
+      @overall_prominence = overall_prominence
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] overall_frequency Value to be assigned
+    def overall_frequency=(overall_frequency)
+      if !overall_frequency.nil? && overall_frequency < 0
+        fail ArgumentError, 'invalid value for "overall_frequency", must be greater than or equal to 0.'
+      end
+
+      @overall_frequency = overall_frequency
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          indices == o.indices &&
           links == o.links &&
-          text == o.text &&
-          stock_ticker == o.stock_ticker &&
+          stock_tickers == o.stock_tickers &&
           types == o.types &&
-          sentiment == o.sentiment &&
-          surface_forms == o.surface_forms
+          overall_sentiment == o.overall_sentiment &&
+          overall_prominence == o.overall_prominence &&
+          overall_frequency == o.overall_frequency &&
+          body == o.body &&
+          title == o.title
     end
 
     # @see the `==` method
@@ -160,7 +206,7 @@ module AylienNewsApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, indices, links, text, stock_ticker, types, sentiment, surface_forms].hash
+      [id, links, stock_tickers, types, overall_sentiment, overall_prominence, overall_frequency, body, title].hash
     end
 
     # Builds the object from hash

data/lib/aylien_news_api/models/entity_in_text.rb

@@ -0,0 +1,217 @@
+=begin
+#AYLIEN News API
+
+#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client. 
+
+The version of the OpenAPI document: 5.0
+Contact: support@aylien.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module AylienNewsApi
+  class EntityInText
+    attr_accessor :sentiment
+
+    attr_accessor :surface_forms
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sentiment' => :'sentiment',
+        :'surface_forms' => :'surface_forms'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'sentiment' => :'EntitySentiment',
+        :'surface_forms' => :'Array<EntitySurfaceForm>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::EntityInText` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AylienNewsApi::EntityInText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
+
+      if attributes.key?(:'surface_forms')
+        if (value = attributes[:'surface_forms']).is_a?(Array)
+          self.surface_forms = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          sentiment == o.sentiment &&
+          surface_forms == o.surface_forms
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [sentiment, surface_forms].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        AylienNewsApi.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/aylien_news_api/models/entity_links.rb

@@ -3,7 +3,7 @@
 
 #The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client. 
 
-The version of the OpenAPI document: 3.0
+The version of the OpenAPI document: 5.0
 Contact: support@aylien.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0-SNAPSHOT

data/lib/aylien_news_api/models/entity_mention.rb

@@ -0,0 +1,215 @@
+=begin
+#AYLIEN News API
+
+#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client. 
+
+The version of the OpenAPI document: 5.0
+Contact: support@aylien.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module AylienNewsApi
+  class EntityMention
+    attr_accessor :index
+
+    attr_accessor :sentiment
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'index' => :'index',
+        :'sentiment' => :'sentiment'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'index' => :'EntityMentionIndex',
+        :'sentiment' => :'EntitySentiment'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::EntityMention` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AylienNewsApi::EntityMention`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'index')
+        self.index = attributes[:'index']
+      end
+
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          index == o.index &&
+          sentiment == o.sentiment
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [index, sentiment].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        AylienNewsApi.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end