aylien_news_api 0.4.0 → 4.1.1

data/lib/aylien_news_api/models/story.rb

@@ -1,244 +1,264 @@
-# Copyright 2016 Aylien, Inc. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+=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: 3.0
+Contact: support@aylien.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
 
 require 'date'
 
 module AylienNewsApi
-
   class Story
-    # ID of the story which is a unique identification
-    attr_accessor :id
-
-    # Title of the story
-    attr_accessor :title
+    attr_accessor :author
 
     # Body of the story
     attr_accessor :body
 
-    # The suggested story summary
-    attr_accessor :summary
+    # Suggested categories for the story
+    attr_accessor :categories
 
-    # The story source
-    attr_accessor :source
+    # Character count of the story body
+    attr_accessor :characters_count
 
-    # The story author
-    attr_accessor :author
+    # An array of clusters the story is associated with
+    attr_accessor :clusters
 
-    # Extracted entities from the story title or body
     attr_accessor :entities
 
-    # Extracted keywords mentioned in the story title or body
-    attr_accessor :keywords
-
     # An array of suggested Story hashtags
     attr_accessor :hashtags
 
-    # Character count of the story body
-    attr_accessor :characters_count
+    # ID of the story which is a unique identification
+    attr_accessor :id
 
-    # Word count of the story body
-    attr_accessor :words_count
+    # Extracted keywords mentioned in the story title or body
+    attr_accessor :keywords
 
-    # Sentence count of the story body
-    attr_accessor :sentences_count
+    # Language of the story
+    attr_accessor :language
+
+    attr_accessor :links
+
+    # An array of extracted media such as images and videos
+    attr_accessor :media
 
     # Paragraph count of the story body
     attr_accessor :paragraphs_count
 
-    # Suggested categories for the story
-    attr_accessor :categories
-
-    # Social shares count for the story
-    attr_accessor :social_shares_count
+    # Published date of the story
+    attr_accessor :published_at
 
-    # An array of extracted media such as images and videos
-    attr_accessor :media
+    # Sentence count of the story body
+    attr_accessor :sentences_count
 
-    # Suggested sentiments for the story title or body
     attr_accessor :sentiment
 
-    # Language of the story
-    attr_accessor :language
+    attr_accessor :social_shares_count
 
-    # Published date of the story
-    attr_accessor :published_at
+    attr_accessor :source
 
-    # Links which is related to the story
-    attr_accessor :links
+    attr_accessor :summary
 
+    # Title of the story
+    attr_accessor :title
+
+    attr_accessor :translations
+
+    # Word count of the story body
+    attr_accessor :words_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'title' => :'title',
-        :'body' => :'body',
-        :'summary' => :'summary',
-        :'source' => :'source',
         :'author' => :'author',
+        :'body' => :'body',
+        :'categories' => :'categories',
+        :'characters_count' => :'characters_count',
+        :'clusters' => :'clusters',
         :'entities' => :'entities',
-        :'keywords' => :'keywords',
         :'hashtags' => :'hashtags',
-        :'characters_count' => :'characters_count',
-        :'words_count' => :'words_count',
-        :'sentences_count' => :'sentences_count',
-        :'paragraphs_count' => :'paragraphs_count',
-        :'categories' => :'categories',
-        :'social_shares_count' => :'social_shares_count',
-        :'media' => :'media',
-        :'sentiment' => :'sentiment',
+        :'id' => :'id',
+        :'keywords' => :'keywords',
         :'language' => :'language',
+        :'links' => :'links',
+        :'media' => :'media',
+        :'paragraphs_count' => :'paragraphs_count',
         :'published_at' => :'published_at',
-        :'links' => :'links'
+        :'sentences_count' => :'sentences_count',
+        :'sentiment' => :'sentiment',
+        :'social_shares_count' => :'social_shares_count',
+        :'source' => :'source',
+        :'summary' => :'summary',
+        :'title' => :'title',
+        :'translations' => :'translations',
+        :'words_count' => :'words_count'
       }
     end
 
     # Attribute type mapping.
-    def self.api_types
+    def self.openapi_types
       {
-        :'id' => :'Integer',
-        :'title' => :'String',
-        :'body' => :'String',
-        :'summary' => :'Summary',
-        :'source' => :'Source',
         :'author' => :'Author',
+        :'body' => :'String',
+        :'categories' => :'Array<Category>',
+        :'characters_count' => :'Integer',
+        :'clusters' => :'Array<Integer>',
         :'entities' => :'Entities',
-        :'keywords' => :'Array<String>',
         :'hashtags' => :'Array<String>',
-        :'characters_count' => :'Integer',
-        :'words_count' => :'Integer',
-        :'sentences_count' => :'Integer',
-        :'paragraphs_count' => :'Integer',
-        :'categories' => :'Array<Category>',
-        :'social_shares_count' => :'ShareCounts',
-        :'media' => :'Array<Media>',
-        :'sentiment' => :'Sentiments',
+        :'id' => :'Integer',
+        :'keywords' => :'Array<String>',
         :'language' => :'String',
+        :'links' => :'StoryLinks',
+        :'media' => :'Array<Media>',
+        :'paragraphs_count' => :'Integer',
         :'published_at' => :'DateTime',
-        :'links' => :'StoryLinks'
+        :'sentences_count' => :'Integer',
+        :'sentiment' => :'Sentiments',
+        :'social_shares_count' => :'ShareCounts',
+        :'source' => :'Source',
+        :'summary' => :'Summary',
+        :'title' => :'String',
+        :'translations' => :'StoryTranslations',
+        :'words_count' => :'Integer'
       }
     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 = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
-
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Story` initialize method"
       end
 
-      if attributes.has_key?(:'title')
-        self.title = attributes[:'title']
+      # 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::Story`. 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?(:'author')
+        self.author = attributes[:'author']
       end
 
-      if attributes.has_key?(:'body')
+      if attributes.key?(:'body')
         self.body = attributes[:'body']
       end
 
-      if attributes.has_key?(:'summary')
-        self.summary = attributes[:'summary']
+      if attributes.key?(:'categories')
+        if (value = attributes[:'categories']).is_a?(Array)
+          self.categories = value
+        end
       end
 
-      if attributes.has_key?(:'source')
-        self.source = attributes[:'source']
+      if attributes.key?(:'characters_count')
+        self.characters_count = attributes[:'characters_count']
       end
 
-      if attributes.has_key?(:'author')
-        self.author = attributes[:'author']
+      if attributes.key?(:'clusters')
+        if (value = attributes[:'clusters']).is_a?(Array)
+          self.clusters = value
+        end
       end
 
-      if attributes.has_key?(:'entities')
+      if attributes.key?(:'entities')
         self.entities = attributes[:'entities']
       end
 
-      if attributes.has_key?(:'keywords')
-        if (value = attributes[:'keywords']).is_a?(Array)
-          self.keywords = value
-        end
-      end
-
-      if attributes.has_key?(:'hashtags')
+      if attributes.key?(:'hashtags')
         if (value = attributes[:'hashtags']).is_a?(Array)
           self.hashtags = value
         end
       end
 
-      if attributes.has_key?(:'characters_count')
-        self.characters_count = attributes[:'characters_count']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'words_count')
-        self.words_count = attributes[:'words_count']
+      if attributes.key?(:'keywords')
+        if (value = attributes[:'keywords']).is_a?(Array)
+          self.keywords = value
+        end
       end
 
-      if attributes.has_key?(:'sentences_count')
-        self.sentences_count = attributes[:'sentences_count']
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
       end
 
-      if attributes.has_key?(:'paragraphs_count')
-        self.paragraphs_count = attributes[:'paragraphs_count']
+      if attributes.key?(:'links')
+        self.links = attributes[:'links']
       end
 
-      if attributes.has_key?(:'categories')
-        if (value = attributes[:'categories']).is_a?(Array)
-          self.categories = value
+      if attributes.key?(:'media')
+        if (value = attributes[:'media']).is_a?(Array)
+          self.media = value
         end
       end
 
-      if attributes.has_key?(:'social_shares_count')
-        self.social_shares_count = attributes[:'social_shares_count']
+      if attributes.key?(:'paragraphs_count')
+        self.paragraphs_count = attributes[:'paragraphs_count']
       end
 
-      if attributes.has_key?(:'media')
-        if (value = attributes[:'media']).is_a?(Array)
-          self.media = value
-        end
+      if attributes.key?(:'published_at')
+        self.published_at = attributes[:'published_at']
+      end
+
+      if attributes.key?(:'sentences_count')
+        self.sentences_count = attributes[:'sentences_count']
       end
 
-      if attributes.has_key?(:'sentiment')
+      if attributes.key?(:'sentiment')
         self.sentiment = attributes[:'sentiment']
       end
 
-      if attributes.has_key?(:'language')
-        self.language = attributes[:'language']
+      if attributes.key?(:'social_shares_count')
+        self.social_shares_count = attributes[:'social_shares_count']
       end
 
-      if attributes.has_key?(:'published_at')
-        self.published_at = attributes[:'published_at']
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
       end
 
-      if attributes.has_key?(:'links')
-        self.links = attributes[:'links']
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
       end
 
+      if attributes.key?(:'translations')
+        self.translations = attributes[:'translations']
+      end
+
+      if attributes.key?(:'words_count')
+        self.words_count = attributes[:'words_count']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      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 true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -246,26 +266,28 @@ module AylienNewsApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          title == o.title &&
-          body == o.body &&
-          summary == o.summary &&
-          source == o.source &&
           author == o.author &&
+          body == o.body &&
+          categories == o.categories &&
+          characters_count == o.characters_count &&
+          clusters == o.clusters &&
           entities == o.entities &&
-          keywords == o.keywords &&
           hashtags == o.hashtags &&
-          characters_count == o.characters_count &&
-          words_count == o.words_count &&
-          sentences_count == o.sentences_count &&
-          paragraphs_count == o.paragraphs_count &&
-          categories == o.categories &&
-          social_shares_count == o.social_shares_count &&
-          media == o.media &&
-          sentiment == o.sentiment &&
+          id == o.id &&
+          keywords == o.keywords &&
           language == o.language &&
+          links == o.links &&
+          media == o.media &&
+          paragraphs_count == o.paragraphs_count &&
           published_at == o.published_at &&
-          links == o.links
+          sentences_count == o.sentences_count &&
+          sentiment == o.sentiment &&
+          social_shares_count == o.social_shares_count &&
+          source == o.source &&
+          summary == o.summary &&
+          title == o.title &&
+          translations == o.translations &&
+          words_count == o.words_count
     end
 
     # @see the `==` method
@@ -275,9 +297,16 @@ module AylienNewsApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links].hash
+      [author, body, categories, characters_count, clusters, entities, hashtags, id, keywords, language, links, media, paragraphs_count, published_at, sentences_count, sentiment, social_shares_count, source, summary, title, translations, words_count].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
@@ -285,12 +314,12 @@ module AylienNewsApi
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.api_types.each_pair do |key, type|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # 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) } )
+            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]]))
@@ -316,7 +345,7 @@ module AylienNewsApi
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -337,8 +366,7 @@ module AylienNewsApi
           end
         end
       else # model
-        temp_model = AylienNewsApi.const_get(type).new
-        temp_model.build_from_hash(value)
+        AylienNewsApi.const_get(type).build_from_hash(value)
       end
     end
 
@@ -360,7 +388,11 @@ module AylienNewsApi
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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
@@ -372,7 +404,7 @@ module AylienNewsApi
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -383,7 +415,5 @@ module AylienNewsApi
         value
       end
     end
-
   end
-
 end