aylien_news_api 4.1.1 → 4.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +100 -31
  3. data/docs/AggregatedSentiment.md +21 -0
  4. data/docs/DefaultApi.md +491 -7
  5. data/docs/DeprecatedEntities.md +19 -0
  6. data/docs/DeprecatedEntity.md +33 -0
  7. data/docs/DeprecatedEntitySurfaceForm.md +21 -0
  8. data/docs/DeprecatedRelatedStories.md +27 -0
  9. data/docs/DeprecatedStories.md +25 -0
  10. data/docs/DeprecatedStory.md +61 -0
  11. data/docs/Entity.md +16 -8
  12. data/docs/EntityInText.md +19 -0
  13. data/docs/EntityLinks.md +6 -2
  14. data/docs/EntityMention.md +19 -0
  15. data/docs/EntityMentionIndex.md +19 -0
  16. data/docs/EntitySentiment.md +19 -0
  17. data/docs/EntitySurfaceForm.md +21 -0
  18. data/docs/Logicals.md +21 -0
  19. data/docs/NestedEntity.md +33 -0
  20. data/docs/Parameter.md +127 -0
  21. data/docs/Query.md +31 -0
  22. data/docs/Story.md +4 -2
  23. data/docs/TimeSeries.md +3 -1
  24. data/docs/Trend.md +3 -1
  25. data/lib/aylien_news_api.rb +16 -1
  26. data/lib/aylien_news_api/api/default_api.rb +728 -11
  27. data/lib/aylien_news_api/models/aggregated_sentiment.rb +228 -0
  28. data/lib/aylien_news_api/models/deprecated_entities.rb +221 -0
  29. data/lib/aylien_news_api/models/deprecated_entity.rb +314 -0
  30. data/lib/aylien_news_api/models/deprecated_entity_surface_form.rb +244 -0
  31. data/lib/aylien_news_api/models/deprecated_related_stories.rb +260 -0
  32. data/lib/aylien_news_api/models/deprecated_stories.rb +252 -0
  33. data/lib/aylien_news_api/models/deprecated_story.rb +429 -0
  34. data/lib/aylien_news_api/models/entity.rb +96 -44
  35. data/lib/aylien_news_api/models/entity_in_text.rb +217 -0
  36. data/lib/aylien_news_api/models/entity_links.rb +25 -5
  37. data/lib/aylien_news_api/models/entity_mention.rb +215 -0
  38. data/lib/aylien_news_api/models/entity_mention_index.rb +265 -0
  39. data/lib/aylien_news_api/models/entity_sentiment.rb +240 -0
  40. data/lib/aylien_news_api/models/entity_surface_form.rb +244 -0
  41. data/lib/aylien_news_api/models/logicals.rb +230 -0
  42. data/lib/aylien_news_api/models/nested_entity.rb +278 -0
  43. data/lib/aylien_news_api/models/parameter.rb +701 -0
  44. data/lib/aylien_news_api/models/query.rb +271 -0
  45. data/lib/aylien_news_api/models/related_stories.rb +1 -0
  46. data/lib/aylien_news_api/models/stories.rb +1 -0
  47. data/lib/aylien_news_api/models/story.rb +19 -6
  48. data/lib/aylien_news_api/models/time_series.rb +13 -4
  49. data/lib/aylien_news_api/models/trend.rb +13 -4
  50. data/lib/aylien_news_api/version.rb +1 -1
  51. data/spec/api/default_api_spec.rb +226 -3
  52. data/spec/models/aggregated_sentiment_spec.rb +53 -0
  53. data/spec/models/deprecated_entities_spec.rb +47 -0
  54. data/spec/models/deprecated_entity_spec.rb +89 -0
  55. data/spec/models/deprecated_entity_surface_form_spec.rb +53 -0
  56. data/spec/models/deprecated_related_stories_spec.rb +71 -0
  57. data/spec/models/deprecated_stories_spec.rb +65 -0
  58. data/spec/models/deprecated_story_spec.rb +173 -0
  59. data/spec/models/entity_in_text_spec.rb +47 -0
  60. data/spec/models/entity_links_spec.rb +12 -0
  61. data/spec/models/entity_mention_index_spec.rb +47 -0
  62. data/spec/models/entity_mention_spec.rb +47 -0
  63. data/spec/models/entity_sentiment_spec.rb +47 -0
  64. data/spec/models/entity_spec.rb +28 -4
  65. data/spec/models/entity_surface_form_spec.rb +53 -0
  66. data/spec/models/logicals_spec.rb +53 -0
  67. data/spec/models/nested_entity_spec.rb +89 -0
  68. data/spec/models/parameter_spec.rb +371 -0
  69. data/spec/models/query_spec.rb +83 -0
  70. data/spec/models/story_spec.rb +6 -0
  71. data/spec/models/time_series_spec.rb +6 -0
  72. data/spec/models/trend_spec.rb +6 -0
  73. metadata +66 -2
@@ -0,0 +1,230 @@
1
+ =begin
2
+ #AYLIEN News API
3
+
4
+ #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.
5
+
6
+ The version of the OpenAPI document: 3.0
7
+ Contact: support@aylien.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module AylienNewsApi
16
+ class Logicals
17
+ attr_accessor :_and
18
+
19
+ attr_accessor :_or
20
+
21
+ attr_accessor :_not
22
+
23
+ # Attribute mapping from ruby-style variable name to JSON key.
24
+ def self.attribute_map
25
+ {
26
+ :'_and' => :'$and',
27
+ :'_or' => :'$or',
28
+ :'_not' => :'$not'
29
+ }
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.openapi_types
34
+ {
35
+ :'_and' => :'Array<AnyOfLogicalsParameter>',
36
+ :'_or' => :'Array<AnyOfLogicalsParameter>',
37
+ :'_not' => :'Array<AnyOfLogicalsParameter>'
38
+ }
39
+ end
40
+
41
+ # List of attributes with nullable: true
42
+ def self.openapi_nullable
43
+ Set.new([
44
+ ])
45
+ end
46
+
47
+ # Initializes the object
48
+ # @param [Hash] attributes Model attributes in the form of hash
49
+ def initialize(attributes = {})
50
+ if (!attributes.is_a?(Hash))
51
+ fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Logicals` initialize method"
52
+ end
53
+
54
+ # check to see if the attribute exists and convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}) { |(k, v), h|
56
+ if (!self.class.attribute_map.key?(k.to_sym))
57
+ fail ArgumentError, "`#{k}` is not a valid attribute in `AylienNewsApi::Logicals`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
58
+ end
59
+ h[k.to_sym] = v
60
+ }
61
+
62
+ if attributes.key?(:'_and')
63
+ if (value = attributes[:'_and']).is_a?(Array)
64
+ self._and = value
65
+ end
66
+ end
67
+
68
+ if attributes.key?(:'_or')
69
+ if (value = attributes[:'_or']).is_a?(Array)
70
+ self._or = value
71
+ end
72
+ end
73
+
74
+ if attributes.key?(:'_not')
75
+ if (value = attributes[:'_not']).is_a?(Array)
76
+ self._not = value
77
+ end
78
+ end
79
+ end
80
+
81
+ # Show invalid properties with the reasons. Usually used together with valid?
82
+ # @return Array for valid properties with the reasons
83
+ def list_invalid_properties
84
+ invalid_properties = Array.new
85
+ invalid_properties
86
+ end
87
+
88
+ # Check to see if the all the properties in the model are valid
89
+ # @return true if the model is valid
90
+ def valid?
91
+ true
92
+ end
93
+
94
+ # Checks equality by comparing each attribute.
95
+ # @param [Object] Object to be compared
96
+ def ==(o)
97
+ return true if self.equal?(o)
98
+ self.class == o.class &&
99
+ _and == o._and &&
100
+ _or == o._or &&
101
+ _not == o._not
102
+ end
103
+
104
+ # @see the `==` method
105
+ # @param [Object] Object to be compared
106
+ def eql?(o)
107
+ self == o
108
+ end
109
+
110
+ # Calculates hash code according to all attributes.
111
+ # @return [Integer] Hash code
112
+ def hash
113
+ [_and, _or, _not].hash
114
+ end
115
+
116
+ # Builds the object from hash
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ # @return [Object] Returns the model itself
119
+ def self.build_from_hash(attributes)
120
+ new.build_from_hash(attributes)
121
+ end
122
+
123
+ # Builds the object from hash
124
+ # @param [Hash] attributes Model attributes in the form of hash
125
+ # @return [Object] Returns the model itself
126
+ def build_from_hash(attributes)
127
+ return nil unless attributes.is_a?(Hash)
128
+ self.class.openapi_types.each_pair do |key, type|
129
+ if type =~ /\AArray<(.*)>/i
130
+ # check to ensure the input is an array given that the attribute
131
+ # is documented as an array but the input is not
132
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
133
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
134
+ end
135
+ elsif !attributes[self.class.attribute_map[key]].nil?
136
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
137
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
138
+ end
139
+
140
+ self
141
+ end
142
+
143
+ # Deserializes the data based on type
144
+ # @param string type Data type
145
+ # @param string value Value to be deserialized
146
+ # @return [Object] Deserialized data
147
+ def _deserialize(type, value)
148
+ case type.to_sym
149
+ when :DateTime
150
+ DateTime.parse(value)
151
+ when :Date
152
+ Date.parse(value)
153
+ when :String
154
+ value.to_s
155
+ when :Integer
156
+ value.to_i
157
+ when :Float
158
+ value.to_f
159
+ when :Boolean
160
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
161
+ true
162
+ else
163
+ false
164
+ end
165
+ when :Object
166
+ # generic object (usually a Hash), return directly
167
+ value
168
+ when /\AArray<(?<inner_type>.+)>\z/
169
+ inner_type = Regexp.last_match[:inner_type]
170
+ value.map { |v| _deserialize(inner_type, v) }
171
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
172
+ k_type = Regexp.last_match[:k_type]
173
+ v_type = Regexp.last_match[:v_type]
174
+ {}.tap do |hash|
175
+ value.each do |k, v|
176
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
177
+ end
178
+ end
179
+ else # model
180
+ AylienNewsApi.const_get(type).build_from_hash(value)
181
+ end
182
+ end
183
+
184
+ # Returns the string representation of the object
185
+ # @return [String] String presentation of the object
186
+ def to_s
187
+ to_hash.to_s
188
+ end
189
+
190
+ # to_body is an alias to to_hash (backward compatibility)
191
+ # @return [Hash] Returns the object in the form of hash
192
+ def to_body
193
+ to_hash
194
+ end
195
+
196
+ # Returns the object in the form of hash
197
+ # @return [Hash] Returns the object in the form of hash
198
+ def to_hash
199
+ hash = {}
200
+ self.class.attribute_map.each_pair do |attr, param|
201
+ value = self.send(attr)
202
+ if value.nil?
203
+ is_nullable = self.class.openapi_nullable.include?(attr)
204
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
205
+ end
206
+
207
+ hash[param] = _to_hash(value)
208
+ end
209
+ hash
210
+ end
211
+
212
+ # Outputs non-array value in the form of hash
213
+ # For object, use to_hash. Otherwise, just return the value
214
+ # @param [Object] value Any valid value
215
+ # @return [Hash] Returns the value in the form of hash
216
+ def _to_hash(value)
217
+ if value.is_a?(Array)
218
+ value.compact.map { |v| _to_hash(v) }
219
+ elsif value.is_a?(Hash)
220
+ {}.tap do |hash|
221
+ value.each { |k, v| hash[k] = _to_hash(v) }
222
+ end
223
+ elsif value.respond_to? :to_hash
224
+ value.to_hash
225
+ else
226
+ value
227
+ end
228
+ end
229
+ end
230
+ end
@@ -0,0 +1,278 @@
1
+ =begin
2
+ #AYLIEN News API
3
+
4
+ #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.
5
+
6
+ The version of the OpenAPI document: 3.0
7
+ Contact: support@aylien.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module AylienNewsApi
16
+ class NestedEntity
17
+ attr_accessor :id
18
+
19
+ attr_accessor :name
20
+
21
+ attr_accessor :surface_forms_text
22
+
23
+ attr_accessor :sentiment
24
+
25
+ attr_accessor :element
26
+
27
+ attr_accessor :links_wikipedia
28
+
29
+ attr_accessor :links_wikidata
30
+
31
+ attr_accessor :stock_ticker
32
+
33
+ attr_accessor :type
34
+
35
+ # Attribute mapping from ruby-style variable name to JSON key.
36
+ def self.attribute_map
37
+ {
38
+ :'id' => :'id',
39
+ :'name' => :'name',
40
+ :'surface_forms_text' => :'surface_forms.text',
41
+ :'sentiment' => :'sentiment',
42
+ :'element' => :'element',
43
+ :'links_wikipedia' => :'links.wikipedia',
44
+ :'links_wikidata' => :'links.wikidata',
45
+ :'stock_ticker' => :'stock_ticker',
46
+ :'type' => :'type'
47
+ }
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'id' => :'Query',
54
+ :'name' => :'Query',
55
+ :'surface_forms_text' => :'Query',
56
+ :'sentiment' => :'Query',
57
+ :'element' => :'Query',
58
+ :'links_wikipedia' => :'Query',
59
+ :'links_wikidata' => :'Query',
60
+ :'stock_ticker' => :'Query',
61
+ :'type' => :'Query'
62
+ }
63
+ end
64
+
65
+ # List of attributes with nullable: true
66
+ def self.openapi_nullable
67
+ Set.new([
68
+ ])
69
+ end
70
+
71
+ # Initializes the object
72
+ # @param [Hash] attributes Model attributes in the form of hash
73
+ def initialize(attributes = {})
74
+ if (!attributes.is_a?(Hash))
75
+ fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::NestedEntity` initialize method"
76
+ end
77
+
78
+ # check to see if the attribute exists and convert string to symbol for hash key
79
+ attributes = attributes.each_with_object({}) { |(k, v), h|
80
+ if (!self.class.attribute_map.key?(k.to_sym))
81
+ fail ArgumentError, "`#{k}` is not a valid attribute in `AylienNewsApi::NestedEntity`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
82
+ end
83
+ h[k.to_sym] = v
84
+ }
85
+
86
+ if attributes.key?(:'id')
87
+ self.id = attributes[:'id']
88
+ end
89
+
90
+ if attributes.key?(:'name')
91
+ self.name = attributes[:'name']
92
+ end
93
+
94
+ if attributes.key?(:'surface_forms_text')
95
+ self.surface_forms_text = attributes[:'surface_forms_text']
96
+ end
97
+
98
+ if attributes.key?(:'sentiment')
99
+ self.sentiment = attributes[:'sentiment']
100
+ end
101
+
102
+ if attributes.key?(:'element')
103
+ self.element = attributes[:'element']
104
+ end
105
+
106
+ if attributes.key?(:'links_wikipedia')
107
+ self.links_wikipedia = attributes[:'links_wikipedia']
108
+ end
109
+
110
+ if attributes.key?(:'links_wikidata')
111
+ self.links_wikidata = attributes[:'links_wikidata']
112
+ end
113
+
114
+ if attributes.key?(:'stock_ticker')
115
+ self.stock_ticker = attributes[:'stock_ticker']
116
+ end
117
+
118
+ if attributes.key?(:'type')
119
+ self.type = attributes[:'type']
120
+ end
121
+ end
122
+
123
+ # Show invalid properties with the reasons. Usually used together with valid?
124
+ # @return Array for valid properties with the reasons
125
+ def list_invalid_properties
126
+ invalid_properties = Array.new
127
+ invalid_properties
128
+ end
129
+
130
+ # Check to see if the all the properties in the model are valid
131
+ # @return true if the model is valid
132
+ def valid?
133
+ true
134
+ end
135
+
136
+ # Checks equality by comparing each attribute.
137
+ # @param [Object] Object to be compared
138
+ def ==(o)
139
+ return true if self.equal?(o)
140
+ self.class == o.class &&
141
+ id == o.id &&
142
+ name == o.name &&
143
+ surface_forms_text == o.surface_forms_text &&
144
+ sentiment == o.sentiment &&
145
+ element == o.element &&
146
+ links_wikipedia == o.links_wikipedia &&
147
+ links_wikidata == o.links_wikidata &&
148
+ stock_ticker == o.stock_ticker &&
149
+ type == o.type
150
+ end
151
+
152
+ # @see the `==` method
153
+ # @param [Object] Object to be compared
154
+ def eql?(o)
155
+ self == o
156
+ end
157
+
158
+ # Calculates hash code according to all attributes.
159
+ # @return [Integer] Hash code
160
+ def hash
161
+ [id, name, surface_forms_text, sentiment, element, links_wikipedia, links_wikidata, stock_ticker, type].hash
162
+ end
163
+
164
+ # Builds the object from hash
165
+ # @param [Hash] attributes Model attributes in the form of hash
166
+ # @return [Object] Returns the model itself
167
+ def self.build_from_hash(attributes)
168
+ new.build_from_hash(attributes)
169
+ end
170
+
171
+ # Builds the object from hash
172
+ # @param [Hash] attributes Model attributes in the form of hash
173
+ # @return [Object] Returns the model itself
174
+ def build_from_hash(attributes)
175
+ return nil unless attributes.is_a?(Hash)
176
+ self.class.openapi_types.each_pair do |key, type|
177
+ if type =~ /\AArray<(.*)>/i
178
+ # check to ensure the input is an array given that the attribute
179
+ # is documented as an array but the input is not
180
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
181
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
182
+ end
183
+ elsif !attributes[self.class.attribute_map[key]].nil?
184
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
185
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
186
+ end
187
+
188
+ self
189
+ end
190
+
191
+ # Deserializes the data based on type
192
+ # @param string type Data type
193
+ # @param string value Value to be deserialized
194
+ # @return [Object] Deserialized data
195
+ def _deserialize(type, value)
196
+ case type.to_sym
197
+ when :DateTime
198
+ DateTime.parse(value)
199
+ when :Date
200
+ Date.parse(value)
201
+ when :String
202
+ value.to_s
203
+ when :Integer
204
+ value.to_i
205
+ when :Float
206
+ value.to_f
207
+ when :Boolean
208
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
209
+ true
210
+ else
211
+ false
212
+ end
213
+ when :Object
214
+ # generic object (usually a Hash), return directly
215
+ value
216
+ when /\AArray<(?<inner_type>.+)>\z/
217
+ inner_type = Regexp.last_match[:inner_type]
218
+ value.map { |v| _deserialize(inner_type, v) }
219
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
220
+ k_type = Regexp.last_match[:k_type]
221
+ v_type = Regexp.last_match[:v_type]
222
+ {}.tap do |hash|
223
+ value.each do |k, v|
224
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
225
+ end
226
+ end
227
+ else # model
228
+ AylienNewsApi.const_get(type).build_from_hash(value)
229
+ end
230
+ end
231
+
232
+ # Returns the string representation of the object
233
+ # @return [String] String presentation of the object
234
+ def to_s
235
+ to_hash.to_s
236
+ end
237
+
238
+ # to_body is an alias to to_hash (backward compatibility)
239
+ # @return [Hash] Returns the object in the form of hash
240
+ def to_body
241
+ to_hash
242
+ end
243
+
244
+ # Returns the object in the form of hash
245
+ # @return [Hash] Returns the object in the form of hash
246
+ def to_hash
247
+ hash = {}
248
+ self.class.attribute_map.each_pair do |attr, param|
249
+ value = self.send(attr)
250
+ if value.nil?
251
+ is_nullable = self.class.openapi_nullable.include?(attr)
252
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
253
+ end
254
+
255
+ hash[param] = _to_hash(value)
256
+ end
257
+ hash
258
+ end
259
+
260
+ # Outputs non-array value in the form of hash
261
+ # For object, use to_hash. Otherwise, just return the value
262
+ # @param [Object] value Any valid value
263
+ # @return [Hash] Returns the value in the form of hash
264
+ def _to_hash(value)
265
+ if value.is_a?(Array)
266
+ value.compact.map { |v| _to_hash(v) }
267
+ elsif value.is_a?(Hash)
268
+ {}.tap do |hash|
269
+ value.each { |k, v| hash[k] = _to_hash(v) }
270
+ end
271
+ elsif value.respond_to? :to_hash
272
+ value.to_hash
273
+ else
274
+ value
275
+ end
276
+ end
277
+ end
278
+ end