aylien_news_api 1.0.0 → 3.0.0

data/lib/aylien_news_api/models/category.rb

@@ -1,41 +1,35 @@
 =begin
-Copyright 2017 Aylien, Inc. All Rights Reserved.
+#AYLIEN News API
 
-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
+#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. 
 
-http://www.apache.org/licenses/LICENSE-2.0
+The version of the OpenAPI document: 3.0
+Contact: support@aylien.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.3-SNAPSHOT
 
-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.
 =end
 
 require 'date'
 
 module AylienNewsApi
-
   class Category
+    # It defines whether the extracted category is confident or not
+    attr_accessor :confident
+
     # The ID of the category
     attr_accessor :id
 
-    # The taxonomy of the category
-    attr_accessor :taxonomy
-
     # The level of the category
     attr_accessor :level
 
+    attr_accessor :links
+
     # The score of the category
     attr_accessor :score
 
-    # It defines whether the extracted category is confident or not
-    attr_accessor :confident
-
-    # Related links for the category
-    attr_accessor :links
+    # The taxonomy of the category
+    attr_accessor :taxonomy
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -62,66 +56,72 @@ module AylienNewsApi
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'confident' => :'confident',
         :'id' => :'id',
-        :'taxonomy' => :'taxonomy',
         :'level' => :'level',
+        :'links' => :'links',
         :'score' => :'score',
-        :'confident' => :'confident',
-        :'links' => :'links'
+        :'taxonomy' => :'taxonomy'
       }
     end
 
     # Attribute type mapping.
-    def self.api_types
+    def self.openapi_types
       {
+        :'confident' => :'Boolean',
         :'id' => :'String',
-        :'taxonomy' => :'String',
         :'level' => :'Integer',
+        :'links' => :'CategoryLinks',
         :'score' => :'Float',
-        :'confident' => :'BOOLEAN',
-        :'links' => :'CategoryLinks'
+        :'taxonomy' => :'String'
       }
     end
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Category` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      # 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::Category`. 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.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'confident')
+        self.confident = attributes[:'confident']
       end
 
-      if attributes.has_key?(:'taxonomy')
-        self.taxonomy = attributes[:'taxonomy']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'level')
+      if attributes.key?(:'level')
         self.level = attributes[:'level']
       end
 
-      if attributes.has_key?(:'score')
-        self.score = attributes[:'score']
+      if attributes.key?(:'links')
+        self.links = attributes[:'links']
       end
 
-      if attributes.has_key?(:'confident')
-        self.confident = attributes[:'confident']
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
       end
 
-      if attributes.has_key?(:'links')
-        self.links = attributes[:'links']
+      if attributes.key?(:'taxonomy')
+        self.taxonomy = attributes[:'taxonomy']
       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
@@ -129,7 +129,7 @@ module AylienNewsApi
     def valid?
       taxonomy_validator = EnumAttributeValidator.new('String', ["iab-qag", "iptc-subjectcode"])
       return false unless taxonomy_validator.valid?(@taxonomy)
-      return true
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
@@ -137,7 +137,7 @@ module AylienNewsApi
     def taxonomy=(taxonomy)
       validator = EnumAttributeValidator.new('String', ["iab-qag", "iptc-subjectcode"])
       unless validator.valid?(taxonomy)
-        fail ArgumentError, "invalid value for 'taxonomy', must be one of #{validator.allowable_values}."
+        fail ArgumentError, "invalid value for \"taxonomy\", must be one of #{validator.allowable_values}."
       end
       @taxonomy = taxonomy
     end
@@ -147,12 +147,12 @@ module AylienNewsApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          confident == o.confident &&
           id == o.id &&
-          taxonomy == o.taxonomy &&
           level == o.level &&
+          links == o.links &&
           score == o.score &&
-          confident == o.confident &&
-          links == o.links
+          taxonomy == o.taxonomy
     end
 
     # @see the `==` method
@@ -162,9 +162,16 @@ module AylienNewsApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, taxonomy, level, score, confident, links].hash
+      [confident, id, level, links, score, taxonomy].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
@@ -172,12 +179,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]]))
@@ -203,7 +210,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
@@ -224,8 +231,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
 
@@ -259,7 +265,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) }
@@ -270,7 +276,5 @@ module AylienNewsApi
         value
       end
     end
-
   end
-
 end

data/lib/aylien_news_api/models/category_links.rb

@@ -1,76 +1,76 @@
 =begin
-Copyright 2017 Aylien, Inc. All Rights Reserved.
+#AYLIEN News API
 
-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
+#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. 
 
-http://www.apache.org/licenses/LICENSE-2.0
+The version of the OpenAPI document: 3.0
+Contact: support@aylien.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.3-SNAPSHOT
 
-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.
 =end
 
 require 'date'
 
 module AylienNewsApi
-
   class CategoryLinks
-    # A URL pointing to the category
-    attr_accessor :_self
-
     # A URL pointing to the parent category
     attr_accessor :parent
 
+    # A URL pointing to the category
+    attr_accessor :_self
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'_self' => :'self',
-        :'parent' => :'parent'
+        :'parent' => :'parent',
+        :'_self' => :'self'
       }
     end
 
     # Attribute type mapping.
-    def self.api_types
+    def self.openapi_types
       {
-        :'_self' => :'String',
-        :'parent' => :'String'
+        :'parent' => :'String',
+        :'_self' => :'String'
       }
     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?(:'self')
-        self._self = attributes[:'self']
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::CategoryLinks` initialize method"
       end
 
-      if attributes.has_key?(:'parent')
+      # 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::CategoryLinks`. 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?(:'parent')
         self.parent = attributes[:'parent']
       end
 
+      if attributes.key?(:'_self')
+        self._self = attributes[:'_self']
+      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.
@@ -78,8 +78,8 @@ module AylienNewsApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          _self == o._self &&
-          parent == o.parent
+          parent == o.parent &&
+          _self == o._self
     end
 
     # @see the `==` method
@@ -89,9 +89,16 @@ module AylienNewsApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [_self, parent].hash
+      [parent, _self].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
@@ -99,12 +106,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]]))
@@ -130,7 +137,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
@@ -151,8 +158,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
 
@@ -186,7 +192,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) }
@@ -197,7 +203,5 @@ module AylienNewsApi
         value
       end
     end
-
   end
-
 end

data/lib/aylien_news_api/models/cluster.rb

@@ -0,0 +1,255 @@
+=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: 4.1.3-SNAPSHOT
+
+=end
+
+require 'date'
+
+module AylienNewsApi
+  class Cluster
+    # Publication date of the earliest story in cluster
+    attr_accessor :earliest_story
+
+    # ID of the cluster which is a unique identification
+    attr_accessor :id
+
+    # Publication date of the latest story in cluster
+    attr_accessor :latest_story
+
+    attr_accessor :location
+
+    attr_accessor :representative_story
+
+    # Number of stories associated with the cluster
+    attr_accessor :story_count
+
+    # Time of the event
+    attr_accessor :time
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'earliest_story' => :'earliest_story',
+        :'id' => :'id',
+        :'latest_story' => :'latest_story',
+        :'location' => :'location',
+        :'representative_story' => :'representative_story',
+        :'story_count' => :'story_count',
+        :'time' => :'time'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'earliest_story' => :'DateTime',
+        :'id' => :'Integer',
+        :'latest_story' => :'DateTime',
+        :'location' => :'Location',
+        :'representative_story' => :'RepresentativeStory',
+        :'story_count' => :'Integer',
+        :'time' => :'DateTime'
+      }
+    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::Cluster` 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::Cluster`. 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?(:'earliest_story')
+        self.earliest_story = attributes[:'earliest_story']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'latest_story')
+        self.latest_story = attributes[:'latest_story']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'representative_story')
+        self.representative_story = attributes[:'representative_story']
+      end
+
+      if attributes.key?(:'story_count')
+        self.story_count = attributes[:'story_count']
+      end
+
+      if attributes.key?(:'time')
+        self.time = attributes[:'time']
+      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 &&
+          earliest_story == o.earliest_story &&
+          id == o.id &&
+          latest_story == o.latest_story &&
+          location == o.location &&
+          representative_story == o.representative_story &&
+          story_count == o.story_count &&
+          time == o.time
+    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
+      [earliest_story, id, latest_story, location, representative_story, story_count, time].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)
+        next if value.nil?
+        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