aylien_news_api 1.0.0 → 3.0.0

data/lib/aylien_news_api/models/entities.rb

@@ -1,80 +1,80 @@
 =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 Entities
-    # An array of extracted entities from the story title
-    attr_accessor :title
-
     # An array of extracted entities from the story body
     attr_accessor :body
 
+    # An array of extracted entities from the story title
+    attr_accessor :title
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'title' => :'title',
-        :'body' => :'body'
+        :'body' => :'body',
+        :'title' => :'title'
       }
     end
 
     # Attribute type mapping.
-    def self.api_types
+    def self.openapi_types
       {
-        :'title' => :'Array<Entity>',
-        :'body' => :'Array<Entity>'
+        :'body' => :'Array<Entity>',
+        :'title' => :'Array<Entity>'
       }
     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.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Entities` initialize method"
+      end
 
-      if attributes.has_key?(:'title')
-        if (value = attributes[:'title']).is_a?(Array)
-          self.title = value
+      # 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::Entities`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
-      end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'body')
+      if attributes.key?(:'body')
         if (value = attributes[:'body']).is_a?(Array)
           self.body = value
         end
       end
 
+      if attributes.key?(:'title')
+        if (value = attributes[:'title']).is_a?(Array)
+          self.title = value
+        end
+      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.
@@ -82,8 +82,8 @@ module AylienNewsApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          title == o.title &&
-          body == o.body
+          body == o.body &&
+          title == o.title
     end
 
     # @see the `==` method
@@ -93,9 +93,16 @@ module AylienNewsApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [title, body].hash
+      [body, title].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
@@ -103,12 +110,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]]))
@@ -134,7 +141,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
@@ -155,8 +162,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
 
@@ -190,7 +196,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) }
@@ -201,7 +207,5 @@ module AylienNewsApi
         value
       end
     end
-
   end
-
 end

data/lib/aylien_news_api/models/entity.rb

@@ -1,109 +1,108 @@
 =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 Entity
-    # The entity text
-    attr_accessor :text
+    # The indices of the entity text
+    attr_accessor :indices
+
+    attr_accessor :links
 
     # The entity score
     attr_accessor :score
 
+    # The entity text
+    attr_accessor :text
+
     # An array of the dbpedia types
     attr_accessor :types
 
-    # Related links to the entity
-    attr_accessor :links
-
-    # The indices of the entity text
-    attr_accessor :indices
-
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'text' => :'text',
-        :'score' => :'score',
-        :'types' => :'types',
+        :'indices' => :'indices',
         :'links' => :'links',
-        :'indices' => :'indices'
+        :'score' => :'score',
+        :'text' => :'text',
+        :'types' => :'types'
       }
     end
 
     # Attribute type mapping.
-    def self.api_types
+    def self.openapi_types
       {
-        :'text' => :'String',
-        :'score' => :'Float',
-        :'types' => :'Array<String>',
+        :'indices' => :'Array<Array<Integer>>',
         :'links' => :'EntityLinks',
-        :'indices' => :'Array<Array<Integer>>'
+        :'score' => :'Float',
+        :'text' => :'String',
+        :'types' => :'Array<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::Entity` 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::Entity`. 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?(:'text')
-        self.text = attributes[:'text']
+      if attributes.key?(:'indices')
+        if (value = attributes[:'indices']).is_a?(Array)
+          self.indices = value
+        end
       end
 
-      if attributes.has_key?(:'score')
-        self.score = attributes[:'score']
+      if attributes.key?(:'links')
+        self.links = attributes[:'links']
       end
 
-      if attributes.has_key?(:'types')
-        if (value = attributes[:'types']).is_a?(Array)
-          self.types = value
-        end
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
       end
 
-      if attributes.has_key?(:'links')
-        self.links = attributes[:'links']
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
       end
 
-      if attributes.has_key?(:'indices')
-        if (value = attributes[:'indices']).is_a?(Array)
-          self.indices = value
+      if attributes.key?(:'types')
+        if (value = attributes[:'types']).is_a?(Array)
+          self.types = value
         end
       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
       if !@score.nil? && @score > 1
-        invalid_properties.push("invalid value for 'score', must be smaller than or equal to 1.")
+        invalid_properties.push('invalid value for "score", must be smaller than or equal to 1.')
       end
 
       if !@score.nil? && @score < 0
-        invalid_properties.push("invalid value for 'score', must be greater than or equal to 0.")
+        invalid_properties.push('invalid value for "score", must be greater than or equal to 0.')
       end
 
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
@@ -111,19 +110,18 @@ module AylienNewsApi
     def valid?
       return false if !@score.nil? && @score > 1
       return false if !@score.nil? && @score < 0
-      return true
+      true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] score Value to be assigned
     def score=(score)
-
       if !score.nil? && score > 1
-        fail ArgumentError, "invalid value for 'score', must be smaller than or equal to 1."
+        fail ArgumentError, 'invalid value for "score", must be smaller than or equal to 1.'
       end
 
       if !score.nil? && score < 0
-        fail ArgumentError, "invalid value for 'score', must be greater than or equal to 0."
+        fail ArgumentError, 'invalid value for "score", must be greater than or equal to 0.'
       end
 
       @score = score
@@ -134,11 +132,11 @@ module AylienNewsApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          text == o.text &&
-          score == o.score &&
-          types == o.types &&
+          indices == o.indices &&
           links == o.links &&
-          indices == o.indices
+          score == o.score &&
+          text == o.text &&
+          types == o.types
     end
 
     # @see the `==` method
@@ -148,9 +146,16 @@ module AylienNewsApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [text, score, types, links, indices].hash
+      [indices, links, score, text, types].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
@@ -158,12 +163,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]]))
@@ -189,7 +194,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
@@ -210,8 +215,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
 
@@ -245,7 +249,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) }
@@ -256,7 +260,5 @@ module AylienNewsApi
         value
       end
     end
-
   end
-
 end