aylien_news_api 0.4.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +1 -1
  4. data/Rakefile +8 -0
  5. data/aylien_news_api.gemspec +17 -13
  6. data/docs/DefaultApi.md +897 -611
  7. data/docs/StoryLinks.md +1 -0
  8. data/lib/aylien_news_api.rb +15 -13
  9. data/lib/aylien_news_api/api/default_api.rb +861 -344
  10. data/lib/aylien_news_api/api_client.rb +18 -15
  11. data/lib/aylien_news_api/api_error.rb +22 -18
  12. data/lib/aylien_news_api/configuration.rb +15 -13
  13. data/lib/aylien_news_api/models/author.rb +15 -13
  14. data/lib/aylien_news_api/models/autocomplete.rb +15 -13
  15. data/lib/aylien_news_api/models/autocompletes.rb +15 -13
  16. data/lib/aylien_news_api/models/category.rb +15 -13
  17. data/lib/aylien_news_api/models/category_links.rb +15 -13
  18. data/lib/aylien_news_api/models/coverages.rb +15 -13
  19. data/lib/aylien_news_api/models/entities.rb +15 -13
  20. data/lib/aylien_news_api/models/entity.rb +25 -23
  21. data/lib/aylien_news_api/models/entity_links.rb +15 -13
  22. data/lib/aylien_news_api/models/error.rb +15 -13
  23. data/lib/aylien_news_api/models/error_links.rb +15 -13
  24. data/lib/aylien_news_api/models/errors.rb +15 -13
  25. data/lib/aylien_news_api/models/histogram_interval.rb +15 -13
  26. data/lib/aylien_news_api/models/histograms.rb +15 -13
  27. data/lib/aylien_news_api/models/location.rb +15 -13
  28. data/lib/aylien_news_api/models/media.rb +15 -13
  29. data/lib/aylien_news_api/models/rank.rb +15 -13
  30. data/lib/aylien_news_api/models/rankings.rb +15 -13
  31. data/lib/aylien_news_api/models/related_stories.rb +15 -13
  32. data/lib/aylien_news_api/models/scope.rb +15 -13
  33. data/lib/aylien_news_api/models/sentiment.rb +25 -23
  34. data/lib/aylien_news_api/models/sentiments.rb +15 -13
  35. data/lib/aylien_news_api/models/share_count.rb +15 -13
  36. data/lib/aylien_news_api/models/share_counts.rb +15 -13
  37. data/lib/aylien_news_api/models/source.rb +15 -13
  38. data/lib/aylien_news_api/models/stories.rb +15 -13
  39. data/lib/aylien_news_api/models/story.rb +15 -13
  40. data/lib/aylien_news_api/models/story_cluster.rb +15 -13
  41. data/lib/aylien_news_api/models/story_links.rb +29 -17
  42. data/lib/aylien_news_api/models/summary.rb +15 -13
  43. data/lib/aylien_news_api/models/time_series.rb +15 -13
  44. data/lib/aylien_news_api/models/time_series_list.rb +15 -13
  45. data/lib/aylien_news_api/models/trend.rb +15 -13
  46. data/lib/aylien_news_api/models/trends.rb +15 -13
  47. data/lib/aylien_news_api/version.rb +16 -14
  48. data/spec/api/default_api_spec.rb +463 -189
  49. data/spec/api_client_spec.rb +25 -101
  50. data/spec/configuration_spec.rb +26 -19
  51. data/spec/models/author_spec.rb +19 -29
  52. data/spec/models/autocomplete_spec.rb +18 -24
  53. data/spec/models/autocompletes_spec.rb +17 -19
  54. data/spec/models/category_links_spec.rb +18 -24
  55. data/spec/models/category_spec.rb +26 -44
  56. data/spec/models/coverages_spec.rb +27 -39
  57. data/spec/models/entities_spec.rb +18 -24
  58. data/spec/models/entity_links_spec.rb +17 -19
  59. data/spec/models/entity_spec.rb +21 -39
  60. data/spec/models/error_links_spec.rb +17 -19
  61. data/spec/models/error_spec.rb +22 -44
  62. data/spec/models/errors_spec.rb +17 -19
  63. data/spec/models/histogram_interval_spec.rb +18 -24
  64. data/spec/models/histograms_spec.rb +21 -39
  65. data/spec/models/location_spec.rb +19 -29
  66. data/spec/models/media_spec.rb +50 -24
  67. data/spec/models/rank_spec.rb +15 -13
  68. data/spec/models/rankings_spec.rb +15 -13
  69. data/spec/models/related_stories_spec.rb +26 -34
  70. data/spec/models/scope_spec.rb +24 -34
  71. data/spec/models/sentiment_spec.rb +22 -24
  72. data/spec/models/sentiments_spec.rb +18 -24
  73. data/spec/models/share_count_spec.rb +18 -24
  74. data/spec/models/share_counts_spec.rb +20 -34
  75. data/spec/models/source_spec.rb +52 -44
  76. data/spec/models/stories_spec.rb +19 -29
  77. data/spec/models/story_cluster_spec.rb +21 -39
  78. data/spec/models/story_links_spec.rb +25 -29
  79. data/spec/models/story_spec.rb +36 -114
  80. data/spec/models/summary_spec.rb +17 -19
  81. data/spec/models/time_series_list_spec.rb +20 -34
  82. data/spec/models/time_series_spec.rb +18 -24
  83. data/spec/models/trend_spec.rb +18 -24
  84. data/spec/models/trends_spec.rb +18 -24
  85. data/spec/spec_helper.rb +15 -13
  86. metadata +25 -8
  87. data/Gemfile.lock +0 -65
  88. data/LICENSE +0 -13
  89. data/aylien_news_api-0.2.0.gem +0 -0
  90. data/aylien_news_api-0.3.0.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b3132b1bd9cc8b1fa55d502f8d66ff6f1917cd2e
4
- data.tar.gz: f5e66a9f11ecdffd1c8dbb465799dc6575aa723a
3
+ metadata.gz: 5ea05755c0dca9f54d2692d19de7c0b3e57b56f5
4
+ data.tar.gz: c01243a6380de1279f16e05cb40732e78b577bec
5
5
  SHA512:
6
- metadata.gz: e3d7fd480e3cf79ac8314021f0f2ac482b479131fac2f1300123fd8a5194c73a42bc92ef8e687a8c3e22a527c7262992a50cd0ecb876f2dda26342105a768d5f
7
- data.tar.gz: 753f9b17f7989e7cdb918830ad427364a4dd76ba78f6f58704ca45219ee7938c9c859f0742bfdb63192dc740ecd4ae3a5372986b2e178f25286e6a538afbee82
6
+ metadata.gz: e88fd64f146b7d7b04dbf79163f7b89ba4beea6de80658a779b51a5ff19a33a2b6e7a10548741551372ba76c5e7ab174ae7d847b958381ee6bb33a8ccff67fc8
7
+ data.tar.gz: c0ab73ef74b8e631a837fbddaa2eda33e57e23044d9857bedb21886d6efbeee407dcf419768a0d500363725f2502df83dea4522415d3e95012da1fee0487a0eb
data/Gemfile CHANGED
@@ -1,3 +1,3 @@
1
- source "https://rubygems.org"
1
+ source 'https://rubygems.org'
2
2
 
3
3
  gemspec
data/README.md CHANGED
@@ -7,4 +7,4 @@ Sign up at [https://newsapi.aylien.com/](https://newsapi.aylien.com/).
7
7
  For more documentation see [https://newsapi.aylien.com/docs/](https://newsapi.aylien.com/docs/).
8
8
 
9
9
  ## Bug Reports
10
- If you've got a bug report, please contact us at support@aylien.com.
10
+ If you've got a bug report, please contact us at support@aylien.com.
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -1,17 +1,20 @@
1
1
  # -*- encoding: utf-8 -*-
2
- # Copyright 2016 Aylien, Inc. All Rights Reserved.
3
2
  #
4
- # Licensed under the Apache License, Version 2.0 (the "License");
5
- # you may not use this file except in compliance with the License.
6
- # You may obtain a copy of the License at
7
- #
8
- # http://www.apache.org/licenses/LICENSE-2.0
9
- #
10
- # Unless required by applicable law or agreed to in writing, software
11
- # distributed under the License is distributed on an "AS IS" BASIS,
12
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- # See the License for the specific language governing permissions and
14
- # limitations under the License.
3
+ =begin
4
+ Copyright 2017 Aylien, Inc. All Rights Reserved.
5
+
6
+ Licensed under the Apache License, Version 2.0 (the "License");
7
+ you may not use this file except in compliance with the License.
8
+ You may obtain a copy of the License at
9
+
10
+ http://www.apache.org/licenses/LICENSE-2.0
11
+
12
+ Unless required by applicable law or agreed to in writing, software
13
+ distributed under the License is distributed on an "AS IS" BASIS,
14
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ See the License for the specific language governing permissions and
16
+ limitations under the License.
17
+ =end
15
18
 
16
19
  $:.push File.expand_path("../lib", __FILE__)
17
20
  require "aylien_news_api/version"
@@ -20,7 +23,7 @@ Gem::Specification.new do |s|
20
23
  s.name = "aylien_news_api"
21
24
  s.version = AylienNewsApi::VERSION
22
25
  s.platform = Gem::Platform::RUBY
23
- s.authors = ["Hamed R. Nik"]
26
+ s.authors = ["Hamed Ramezanian Nik"]
24
27
  s.email = ["hamed.r.nik@gmail.com"]
25
28
  s.homepage = "https://newsapi.aylien.com/"
26
29
  s.summary = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content"
@@ -31,6 +34,7 @@ Gem::Specification.new do |s|
31
34
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
32
35
  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
33
36
 
37
+ s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
34
38
  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
35
39
  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
36
40
  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
@@ -24,36 +24,33 @@ This endpoint is used for getting list of autocompletes by providing a specific
24
24
  ```ruby
25
25
  # load the gem
26
26
  require 'aylien_news_api'
27
+
27
28
  # setup authorization
28
29
  AylienNewsApi.configure do |config|
29
- # Configure API key authorization: app_key
30
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
31
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
33
-
34
30
  # Configure API key authorization: app_id
35
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
36
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
37
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
31
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
32
+
33
+ # Configure API key authorization: app_key
34
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
38
35
  end
39
36
 
40
37
  api_instance = AylienNewsApi::DefaultApi.new
41
38
 
42
- type = "type_example" # String | This parameter is used for defining the type of autocompletes.
43
-
44
- term = "term_example" # String | This parameter is used for finding autocomplete objects that contain the specified value.
39
+ type = "type_example"
40
+ term = "term_example"
45
41
 
46
42
  opts = {
47
- language: "en", # String | This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
48
- per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
43
+ language: "en",
44
+ per_page: 3
49
45
  }
50
46
 
51
47
  begin
52
48
  #List autocompletes
53
49
  result = api_instance.list_autocompletes(type, term, opts)
54
- p result
50
+ puts result
55
51
  rescue AylienNewsApi::ApiError => e
56
52
  puts "Exception when calling DefaultApi->list_autocompletes: #{e}"
53
+ puts e.response_body
57
54
  end
58
55
  ```
59
56
 
@@ -61,9 +58,9 @@ end
61
58
 
62
59
  Name | Type | Description | Notes
63
60
  ------------- | ------------- | ------------- | -------------
64
- **type** | **String**| This parameter is used for defining the type of autocompletes. |
61
+ **type** | **String**| This parameter is used for defining the type of autocompletes. | [enum: source_names, source_domains, entity_types, dbpedia_resources]
65
62
  **term** | **String**| This parameter is used for finding autocomplete objects that contain the specified value. |
66
- **language** | **String**| This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to en]
63
+ **language** | **String**| This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to en] [enum: en, de, fr, it, es, pt]
67
64
  **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
68
65
 
69
66
  ### Return type
@@ -77,7 +74,7 @@ Name | Type | Description | Notes
77
74
  ### HTTP request headers
78
75
 
79
76
  - **Content-Type**: application/x-www-form-urlencoded
80
- - **Accept**: application/json
77
+ - **Accept**: application/json, text/xml
81
78
 
82
79
 
83
80
 
@@ -92,95 +89,118 @@ This endpoint is used for finding story coverages based on the parameters provid
92
89
  ```ruby
93
90
  # load the gem
94
91
  require 'aylien_news_api'
92
+
95
93
  # setup authorization
96
94
  AylienNewsApi.configure do |config|
97
- # Configure API key authorization: app_key
98
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
99
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
100
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
101
-
102
95
  # Configure API key authorization: app_id
103
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
104
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
96
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
97
+
98
+ # Configure API key authorization: app_key
99
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
106
100
  end
107
101
 
108
102
  api_instance = AylienNewsApi::DefaultApi.new
109
103
 
110
104
  opts = {
111
- id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
112
- title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
113
- body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
114
- text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
115
- language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
116
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
117
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
118
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
119
- categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
120
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
121
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
122
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
123
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
124
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
125
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
126
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
127
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
128
- sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
129
- sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
130
- media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
131
- media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
132
- media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
133
- media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
134
- media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
135
- media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
136
- media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
137
- media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
138
- media_images_format: ["media_images_format_example"], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
139
- media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
140
- media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
141
- author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
142
- author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
143
- source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
144
- source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
145
- source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
146
- source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
147
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
148
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
149
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
150
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
151
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
152
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
153
- source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
154
- source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
155
- source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
156
- source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
157
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
158
- social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
159
- social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
160
- social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
161
- social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
162
- social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
163
- social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
164
- social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
165
- social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
166
- cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
167
- cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
168
- _return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
169
- story_id: 789, # Integer | A story id
170
- story_url: "story_url_example", # String | An article or webpage
171
- story_title: "story_title_example", # String | Title of the article
172
- story_body: "story_body_example", # String | Body of the article
173
- story_published_at: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Publish date of the article. If you use a url or title and body of an article for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the [XML Schema specification (ISO 8601)](https://www.w3.org/TR/xmlschema-2/#dateTime).
174
- story_language: "auto", # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
175
- per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
105
+ id: [56],
106
+ not_id: [56],
107
+ title: "title_example",
108
+ body: "body_example",
109
+ text: "text_example",
110
+ language: ["language_example"],
111
+ not_language: ["not_language_example"],
112
+ published_at_start: "published_at_start_example",
113
+ published_at_end: "published_at_end_example",
114
+ categories_taxonomy: "categories_taxonomy_example",
115
+ categories_confident: true,
116
+ categories_id: ["categories_id_example"],
117
+ not_categories_id: ["not_categories_id_example"],
118
+ categories_level: [56],
119
+ not_categories_level: [56],
120
+ entities_title_text: ["entities_title_text_example"],
121
+ not_entities_title_text: ["not_entities_title_text_example"],
122
+ entities_title_type: ["entities_title_type_example"],
123
+ not_entities_title_type: ["not_entities_title_type_example"],
124
+ entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
125
+ not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
126
+ entities_body_text: ["entities_body_text_example"],
127
+ not_entities_body_text: ["not_entities_body_text_example"],
128
+ entities_body_type: ["entities_body_type_example"],
129
+ not_entities_body_type: ["not_entities_body_type_example"],
130
+ entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
131
+ not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
132
+ sentiment_title_polarity: "sentiment_title_polarity_example",
133
+ not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
134
+ sentiment_body_polarity: "sentiment_body_polarity_example",
135
+ not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
136
+ media_images_count_min: 56,
137
+ media_images_count_max: 56,
138
+ media_images_width_min: 56,
139
+ media_images_width_max: 56,
140
+ media_images_height_min: 56,
141
+ media_images_height_max: 56,
142
+ media_images_content_length_min: 56,
143
+ media_images_content_length_max: 56,
144
+ media_images_format: ["media_images_format_example"],
145
+ not_media_images_format: ["not_media_images_format_example"],
146
+ media_videos_count_min: 56,
147
+ media_videos_count_max: 56,
148
+ author_id: [56],
149
+ not_author_id: [56],
150
+ author_name: "author_name_example",
151
+ not_author_name: "not_author_name_example",
152
+ source_id: [56],
153
+ not_source_id: [56],
154
+ source_name: ["source_name_example"],
155
+ not_source_name: ["not_source_name_example"],
156
+ source_domain: ["source_domain_example"],
157
+ not_source_domain: ["not_source_domain_example"],
158
+ source_locations_country: ["source_locations_country_example"],
159
+ not_source_locations_country: ["not_source_locations_country_example"],
160
+ source_locations_state: ["source_locations_state_example"],
161
+ not_source_locations_state: ["not_source_locations_state_example"],
162
+ source_locations_city: ["source_locations_city_example"],
163
+ not_source_locations_city: ["not_source_locations_city_example"],
164
+ source_scopes_country: ["source_scopes_country_example"],
165
+ not_source_scopes_country: ["not_source_scopes_country_example"],
166
+ source_scopes_state: ["source_scopes_state_example"],
167
+ not_source_scopes_state: ["not_source_scopes_state_example"],
168
+ source_scopes_city: ["source_scopes_city_example"],
169
+ not_source_scopes_city: ["not_source_scopes_city_example"],
170
+ source_scopes_level: ["source_scopes_level_example"],
171
+ not_source_scopes_level: ["not_source_scopes_level_example"],
172
+ source_links_in_count_min: 56,
173
+ source_links_in_count_max: 56,
174
+ source_rankings_alexa_rank_min: 56,
175
+ source_rankings_alexa_rank_max: 56,
176
+ source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
177
+ social_shares_count_facebook_min: 56,
178
+ social_shares_count_facebook_max: 56,
179
+ social_shares_count_google_plus_min: 56,
180
+ social_shares_count_google_plus_max: 56,
181
+ social_shares_count_linkedin_min: 56,
182
+ social_shares_count_linkedin_max: 56,
183
+ social_shares_count_reddit_min: 56,
184
+ social_shares_count_reddit_max: 56,
185
+ cluster: false,
186
+ cluster_algorithm: "lingo",
187
+ _return: ["_return_example"],
188
+ story_id: 789,
189
+ story_url: "story_url_example",
190
+ story_title: "story_title_example",
191
+ story_body: "story_body_example",
192
+ story_published_at: DateTime.parse("2013-10-20T19:20:30+01:00"),
193
+ story_language: "auto",
194
+ per_page: 3
176
195
  }
177
196
 
178
197
  begin
179
198
  #List coverages
180
199
  result = api_instance.list_coverages(opts)
181
- p result
200
+ puts result
182
201
  rescue AylienNewsApi::ApiError => e
183
202
  puts "Exception when calling DefaultApi->list_coverages: #{e}"
203
+ puts e.response_body
184
204
  end
185
205
  ```
186
206
 
@@ -188,25 +208,37 @@ end
188
208
 
189
209
  Name | Type | Description | Notes
190
210
  ------------- | ------------- | ------------- | -------------
191
- **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
211
+ **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
212
+ **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
192
213
  **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
193
214
  **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
194
215
  **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
195
- **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
216
+ **language** | **Array&lt;String&gt;**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
217
+ **not_language** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
196
218
  **published_at_start** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
197
219
  **published_at_end** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
198
- **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
220
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [enum: iab-qag, iptc-subjectcode]
199
221
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
200
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
201
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
202
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
203
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
204
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
205
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
206
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
207
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
208
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
209
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
222
+ **categories_id** | **Array&lt;String&gt;**| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
223
+ **not_categories_id** | **Array&lt;String&gt;**| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
224
+ **categories_level** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
225
+ **not_categories_level** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
226
+ **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
227
+ **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
228
+ **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
229
+ **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
230
+ **entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
231
+ **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
232
+ **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
233
+ **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
234
+ **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
235
+ **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
236
+ **entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
237
+ **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
238
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
239
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
240
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
241
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
210
242
  **media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
211
243
  **media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
212
244
  **media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
@@ -215,26 +247,39 @@ Name | Type | Description | Notes
215
247
  **media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
216
248
  **media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
217
249
  **media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
218
- **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
250
+ **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
251
+ **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
219
252
  **media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
220
253
  **media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
221
- **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
254
+ **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
255
+ **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
222
256
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
223
- **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
224
- **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
225
- **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
226
- **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
227
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
228
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
229
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
230
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
231
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
232
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
257
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
258
+ **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
259
+ **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
260
+ **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
261
+ **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
262
+ **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
263
+ **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
264
+ **source_locations_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
265
+ **not_source_locations_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
266
+ **source_locations_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
267
+ **not_source_locations_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
268
+ **source_locations_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
269
+ **not_source_locations_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
270
+ **source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
271
+ **not_source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
272
+ **source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
273
+ **not_source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
274
+ **source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
275
+ **not_source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
276
+ **source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
277
+ **not_source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
233
278
  **source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
234
279
  **source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
235
280
  **source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
236
281
  **source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
237
- **source_rankings_alexa_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
282
+ **source_rankings_alexa_country** | **Array&lt;String&gt;**| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
238
283
  **social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
239
284
  **social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
240
285
  **social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
@@ -244,14 +289,14 @@ Name | Type | Description | Notes
244
289
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
245
290
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
246
291
  **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to false]
247
- **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo]
248
- **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
292
+ **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo] [enum: stc, lingo, kmeans]
293
+ **_return** | **Array&lt;String&gt;**| This parameter is used for specifying return fields. | [optional] [enum: 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]
249
294
  **story_id** | **Integer**| A story id | [optional]
250
295
  **story_url** | **String**| An article or webpage | [optional]
251
296
  **story_title** | **String**| Title of the article | [optional]
252
297
  **story_body** | **String**| Body of the article | [optional]
253
298
  **story_published_at** | **DateTime**| Publish date of the article. If you use a url or title and body of an article for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the [XML Schema specification (ISO 8601)](https://www.w3.org/TR/xmlschema-2/#dateTime). | [optional]
254
- **story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto]
299
+ **story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto] [enum: auto, en, de, fr, it, es, pt]
255
300
  **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
256
301
 
257
302
  ### Return type
@@ -265,7 +310,7 @@ Name | Type | Description | Notes
265
310
  ### HTTP request headers
266
311
 
267
312
  - **Content-Type**: application/x-www-form-urlencoded
268
- - **Accept**: application/json
313
+ - **Accept**: application/json, text/xml
269
314
 
270
315
 
271
316
 
@@ -280,89 +325,112 @@ This endpoint is used for getting histograms based on the `field` parameter pass
280
325
  ```ruby
281
326
  # load the gem
282
327
  require 'aylien_news_api'
328
+
283
329
  # setup authorization
284
330
  AylienNewsApi.configure do |config|
285
- # Configure API key authorization: app_key
286
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
287
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
288
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
289
-
290
331
  # Configure API key authorization: app_id
291
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
292
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
293
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
332
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
333
+
334
+ # Configure API key authorization: app_key
335
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
294
336
  end
295
337
 
296
338
  api_instance = AylienNewsApi::DefaultApi.new
297
339
 
298
340
  opts = {
299
- id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
300
- title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
301
- body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
302
- text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
303
- language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
304
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
305
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
306
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
307
- categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
308
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
309
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
310
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
311
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
312
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
313
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
314
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
315
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
316
- sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
317
- sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
318
- media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
319
- media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
320
- media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
321
- media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
322
- media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
323
- media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
324
- media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
325
- media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
326
- media_images_format: ["media_images_format_example"], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
327
- media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
328
- media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
329
- author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
330
- author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
331
- source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
332
- source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
333
- source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
334
- source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
335
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
336
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
337
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
338
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
339
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
340
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
341
- source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
342
- source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
343
- source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
344
- source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
345
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
346
- social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
347
- social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
348
- social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
349
- social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
350
- social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
351
- social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
352
- social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
353
- social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
354
- interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
355
- interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
356
- interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
357
- field: "social_shares_count" # String | This parameter is used for specifying the y-axis variable for the histogram.
341
+ id: [56],
342
+ not_id: [56],
343
+ title: "title_example",
344
+ body: "body_example",
345
+ text: "text_example",
346
+ language: ["language_example"],
347
+ not_language: ["not_language_example"],
348
+ published_at_start: "published_at_start_example",
349
+ published_at_end: "published_at_end_example",
350
+ categories_taxonomy: "categories_taxonomy_example",
351
+ categories_confident: true,
352
+ categories_id: ["categories_id_example"],
353
+ not_categories_id: ["not_categories_id_example"],
354
+ categories_level: [56],
355
+ not_categories_level: [56],
356
+ entities_title_text: ["entities_title_text_example"],
357
+ not_entities_title_text: ["not_entities_title_text_example"],
358
+ entities_title_type: ["entities_title_type_example"],
359
+ not_entities_title_type: ["not_entities_title_type_example"],
360
+ entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
361
+ not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
362
+ entities_body_text: ["entities_body_text_example"],
363
+ not_entities_body_text: ["not_entities_body_text_example"],
364
+ entities_body_type: ["entities_body_type_example"],
365
+ not_entities_body_type: ["not_entities_body_type_example"],
366
+ entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
367
+ not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
368
+ sentiment_title_polarity: "sentiment_title_polarity_example",
369
+ not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
370
+ sentiment_body_polarity: "sentiment_body_polarity_example",
371
+ not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
372
+ media_images_count_min: 56,
373
+ media_images_count_max: 56,
374
+ media_images_width_min: 56,
375
+ media_images_width_max: 56,
376
+ media_images_height_min: 56,
377
+ media_images_height_max: 56,
378
+ media_images_content_length_min: 56,
379
+ media_images_content_length_max: 56,
380
+ media_images_format: ["media_images_format_example"],
381
+ not_media_images_format: ["not_media_images_format_example"],
382
+ media_videos_count_min: 56,
383
+ media_videos_count_max: 56,
384
+ author_id: [56],
385
+ not_author_id: [56],
386
+ author_name: "author_name_example",
387
+ not_author_name: "not_author_name_example",
388
+ source_id: [56],
389
+ not_source_id: [56],
390
+ source_name: ["source_name_example"],
391
+ not_source_name: ["not_source_name_example"],
392
+ source_domain: ["source_domain_example"],
393
+ not_source_domain: ["not_source_domain_example"],
394
+ source_locations_country: ["source_locations_country_example"],
395
+ not_source_locations_country: ["not_source_locations_country_example"],
396
+ source_locations_state: ["source_locations_state_example"],
397
+ not_source_locations_state: ["not_source_locations_state_example"],
398
+ source_locations_city: ["source_locations_city_example"],
399
+ not_source_locations_city: ["not_source_locations_city_example"],
400
+ source_scopes_country: ["source_scopes_country_example"],
401
+ not_source_scopes_country: ["not_source_scopes_country_example"],
402
+ source_scopes_state: ["source_scopes_state_example"],
403
+ not_source_scopes_state: ["not_source_scopes_state_example"],
404
+ source_scopes_city: ["source_scopes_city_example"],
405
+ not_source_scopes_city: ["not_source_scopes_city_example"],
406
+ source_scopes_level: ["source_scopes_level_example"],
407
+ not_source_scopes_level: ["not_source_scopes_level_example"],
408
+ source_links_in_count_min: 56,
409
+ source_links_in_count_max: 56,
410
+ source_rankings_alexa_rank_min: 56,
411
+ source_rankings_alexa_rank_max: 56,
412
+ source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
413
+ social_shares_count_facebook_min: 56,
414
+ social_shares_count_facebook_max: 56,
415
+ social_shares_count_google_plus_min: 56,
416
+ social_shares_count_google_plus_max: 56,
417
+ social_shares_count_linkedin_min: 56,
418
+ social_shares_count_linkedin_max: 56,
419
+ social_shares_count_reddit_min: 56,
420
+ social_shares_count_reddit_max: 56,
421
+ interval_start: 56,
422
+ interval_end: 56,
423
+ interval_width: 56,
424
+ field: "social_shares_count"
358
425
  }
359
426
 
360
427
  begin
361
428
  #List histograms
362
429
  result = api_instance.list_histograms(opts)
363
- p result
430
+ puts result
364
431
  rescue AylienNewsApi::ApiError => e
365
432
  puts "Exception when calling DefaultApi->list_histograms: #{e}"
433
+ puts e.response_body
366
434
  end
367
435
  ```
368
436
 
@@ -370,25 +438,37 @@ end
370
438
 
371
439
  Name | Type | Description | Notes
372
440
  ------------- | ------------- | ------------- | -------------
373
- **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
441
+ **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
442
+ **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
374
443
  **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
375
444
  **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
376
445
  **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
377
- **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
446
+ **language** | **Array&lt;String&gt;**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
447
+ **not_language** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
378
448
  **published_at_start** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
379
449
  **published_at_end** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
380
- **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
450
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [enum: iab-qag, iptc-subjectcode]
381
451
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
382
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
383
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
384
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
385
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
386
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
387
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
388
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
389
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
390
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
391
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
452
+ **categories_id** | **Array&lt;String&gt;**| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
453
+ **not_categories_id** | **Array&lt;String&gt;**| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
454
+ **categories_level** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
455
+ **not_categories_level** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
456
+ **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
457
+ **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
458
+ **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
459
+ **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
460
+ **entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
461
+ **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
462
+ **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
463
+ **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
464
+ **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
465
+ **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
466
+ **entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
467
+ **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
468
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
469
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
470
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
471
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
392
472
  **media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
393
473
  **media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
394
474
  **media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
@@ -397,26 +477,39 @@ Name | Type | Description | Notes
397
477
  **media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
398
478
  **media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
399
479
  **media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
400
- **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
480
+ **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
481
+ **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
401
482
  **media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
402
483
  **media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
403
- **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
484
+ **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
485
+ **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
404
486
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
405
- **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
406
- **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
407
- **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
408
- **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
409
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
410
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
411
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
412
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
413
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
414
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
487
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
488
+ **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
489
+ **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
490
+ **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
491
+ **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
492
+ **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
493
+ **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
494
+ **source_locations_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
495
+ **not_source_locations_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
496
+ **source_locations_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
497
+ **not_source_locations_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
498
+ **source_locations_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
499
+ **not_source_locations_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
500
+ **source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
501
+ **not_source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
502
+ **source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
503
+ **not_source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
504
+ **source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
505
+ **not_source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
506
+ **source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
507
+ **not_source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
415
508
  **source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
416
509
  **source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
417
510
  **source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
418
511
  **source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
419
- **source_rankings_alexa_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
512
+ **source_rankings_alexa_country** | **Array&lt;String&gt;**| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
420
513
  **social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
421
514
  **social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
422
515
  **social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
@@ -428,7 +521,7 @@ Name | Type | Description | Notes
428
521
  **interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
429
522
  **interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
430
523
  **interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
431
- **field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to social_shares_count]
524
+ **field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to social_shares_count] [enum: social_shares_count, social_shares_count.facebook, social_shares_count.linkedin, social_shares_count.reddit, social_shares_count.google_plus, characters_count, words_count, sentences_count, paragraphs_count, media.images.count, media.videos.count, source.links_in_count, source.rankings.alexa.rank, source.rankings.alexa.rank.AF, source.rankings.alexa.rank.AX, source.rankings.alexa.rank.AL, source.rankings.alexa.rank.DZ, source.rankings.alexa.rank.AS, source.rankings.alexa.rank.AD, source.rankings.alexa.rank.AO, source.rankings.alexa.rank.AI, source.rankings.alexa.rank.AQ, source.rankings.alexa.rank.AG, source.rankings.alexa.rank.AR, source.rankings.alexa.rank.AM, source.rankings.alexa.rank.AW, source.rankings.alexa.rank.AU, source.rankings.alexa.rank.AT, source.rankings.alexa.rank.AZ, source.rankings.alexa.rank.BS, source.rankings.alexa.rank.BH, source.rankings.alexa.rank.BD, source.rankings.alexa.rank.BB, source.rankings.alexa.rank.BY, source.rankings.alexa.rank.BE, source.rankings.alexa.rank.BZ, source.rankings.alexa.rank.BJ, source.rankings.alexa.rank.BM, source.rankings.alexa.rank.BT, source.rankings.alexa.rank.BO, source.rankings.alexa.rank.BQ, source.rankings.alexa.rank.BA, source.rankings.alexa.rank.BW, source.rankings.alexa.rank.BV, source.rankings.alexa.rank.BR, source.rankings.alexa.rank.IO, source.rankings.alexa.rank.BN, source.rankings.alexa.rank.BG, source.rankings.alexa.rank.BF, source.rankings.alexa.rank.BI, source.rankings.alexa.rank.KH, source.rankings.alexa.rank.CM, source.rankings.alexa.rank.CA, source.rankings.alexa.rank.CV, source.rankings.alexa.rank.KY, source.rankings.alexa.rank.CF, source.rankings.alexa.rank.TD, source.rankings.alexa.rank.CL, source.rankings.alexa.rank.CN, source.rankings.alexa.rank.CX, source.rankings.alexa.rank.CC, source.rankings.alexa.rank.CO, source.rankings.alexa.rank.KM, source.rankings.alexa.rank.CG, source.rankings.alexa.rank.CD, source.rankings.alexa.rank.CK, source.rankings.alexa.rank.CR, source.rankings.alexa.rank.CI, source.rankings.alexa.rank.HR, source.rankings.alexa.rank.CU, source.rankings.alexa.rank.CW, source.rankings.alexa.rank.CY, source.rankings.alexa.rank.CZ, source.rankings.alexa.rank.DK, source.rankings.alexa.rank.DJ, source.rankings.alexa.rank.DM, source.rankings.alexa.rank.DO, source.rankings.alexa.rank.EC, source.rankings.alexa.rank.EG, source.rankings.alexa.rank.SV, source.rankings.alexa.rank.GQ, source.rankings.alexa.rank.ER, source.rankings.alexa.rank.EE, source.rankings.alexa.rank.ET, source.rankings.alexa.rank.FK, source.rankings.alexa.rank.FO, source.rankings.alexa.rank.FJ, source.rankings.alexa.rank.FI, source.rankings.alexa.rank.FR, source.rankings.alexa.rank.GF, source.rankings.alexa.rank.PF, source.rankings.alexa.rank.TF, source.rankings.alexa.rank.GA, source.rankings.alexa.rank.GM, source.rankings.alexa.rank.GE, source.rankings.alexa.rank.DE, source.rankings.alexa.rank.GH, source.rankings.alexa.rank.GI, source.rankings.alexa.rank.GR, source.rankings.alexa.rank.GL, source.rankings.alexa.rank.GD, source.rankings.alexa.rank.GP, source.rankings.alexa.rank.GU, source.rankings.alexa.rank.GT, source.rankings.alexa.rank.GG, source.rankings.alexa.rank.GN, source.rankings.alexa.rank.GW, source.rankings.alexa.rank.GY, source.rankings.alexa.rank.HT, source.rankings.alexa.rank.HM, source.rankings.alexa.rank.VA, source.rankings.alexa.rank.HN, source.rankings.alexa.rank.HK, source.rankings.alexa.rank.HU, source.rankings.alexa.rank.IS, source.rankings.alexa.rank.IN, source.rankings.alexa.rank.ID, source.rankings.alexa.rank.IR, source.rankings.alexa.rank.IQ, source.rankings.alexa.rank.IE, source.rankings.alexa.rank.IM, source.rankings.alexa.rank.IL, source.rankings.alexa.rank.IT, source.rankings.alexa.rank.JM, source.rankings.alexa.rank.JP, source.rankings.alexa.rank.JE, source.rankings.alexa.rank.JO, source.rankings.alexa.rank.KZ, source.rankings.alexa.rank.KE, source.rankings.alexa.rank.KI, source.rankings.alexa.rank.KP, source.rankings.alexa.rank.KR, source.rankings.alexa.rank.KW, source.rankings.alexa.rank.KG, source.rankings.alexa.rank.LA, source.rankings.alexa.rank.LV, source.rankings.alexa.rank.LB, source.rankings.alexa.rank.LS, source.rankings.alexa.rank.LR, source.rankings.alexa.rank.LY, source.rankings.alexa.rank.LI, source.rankings.alexa.rank.LT, source.rankings.alexa.rank.LU, source.rankings.alexa.rank.MO, source.rankings.alexa.rank.MK, source.rankings.alexa.rank.MG, source.rankings.alexa.rank.MW, source.rankings.alexa.rank.MY, source.rankings.alexa.rank.MV, source.rankings.alexa.rank.ML, source.rankings.alexa.rank.MT, source.rankings.alexa.rank.MH, source.rankings.alexa.rank.MQ, source.rankings.alexa.rank.MR, source.rankings.alexa.rank.MU, source.rankings.alexa.rank.YT, source.rankings.alexa.rank.MX, source.rankings.alexa.rank.FM, source.rankings.alexa.rank.MD, source.rankings.alexa.rank.MC, source.rankings.alexa.rank.MN, source.rankings.alexa.rank.ME, source.rankings.alexa.rank.MS, source.rankings.alexa.rank.MA, source.rankings.alexa.rank.MZ, source.rankings.alexa.rank.MM, source.rankings.alexa.rank.NA, source.rankings.alexa.rank.NR, source.rankings.alexa.rank.NP, source.rankings.alexa.rank.NL, source.rankings.alexa.rank.NC, source.rankings.alexa.rank.NZ, source.rankings.alexa.rank.NI, source.rankings.alexa.rank.NE, source.rankings.alexa.rank.NG, source.rankings.alexa.rank.NU, source.rankings.alexa.rank.NF, source.rankings.alexa.rank.MP, source.rankings.alexa.rank.NO, source.rankings.alexa.rank.OM, source.rankings.alexa.rank.PK, source.rankings.alexa.rank.PW, source.rankings.alexa.rank.PS, source.rankings.alexa.rank.PA, source.rankings.alexa.rank.PG, source.rankings.alexa.rank.PY, source.rankings.alexa.rank.PE, source.rankings.alexa.rank.PH, source.rankings.alexa.rank.PN, source.rankings.alexa.rank.PL, source.rankings.alexa.rank.PT, source.rankings.alexa.rank.PR, source.rankings.alexa.rank.QA, source.rankings.alexa.rank.RE, source.rankings.alexa.rank.RO, source.rankings.alexa.rank.RU, source.rankings.alexa.rank.RW, source.rankings.alexa.rank.BL, source.rankings.alexa.rank.SH, source.rankings.alexa.rank.KN, source.rankings.alexa.rank.LC, source.rankings.alexa.rank.MF, source.rankings.alexa.rank.PM, source.rankings.alexa.rank.VC, source.rankings.alexa.rank.WS, source.rankings.alexa.rank.SM, source.rankings.alexa.rank.ST, source.rankings.alexa.rank.SA, source.rankings.alexa.rank.SN, source.rankings.alexa.rank.RS, source.rankings.alexa.rank.SC, source.rankings.alexa.rank.SL, source.rankings.alexa.rank.SG, source.rankings.alexa.rank.SX, source.rankings.alexa.rank.SK, source.rankings.alexa.rank.SI, source.rankings.alexa.rank.SB, source.rankings.alexa.rank.SO, source.rankings.alexa.rank.ZA, source.rankings.alexa.rank.GS, source.rankings.alexa.rank.SS, source.rankings.alexa.rank.ES, source.rankings.alexa.rank.LK, source.rankings.alexa.rank.SD, source.rankings.alexa.rank.SR, source.rankings.alexa.rank.SJ, source.rankings.alexa.rank.SZ, source.rankings.alexa.rank.SE, source.rankings.alexa.rank.CH, source.rankings.alexa.rank.SY, source.rankings.alexa.rank.TW, source.rankings.alexa.rank.TJ, source.rankings.alexa.rank.TZ, source.rankings.alexa.rank.TH, source.rankings.alexa.rank.TL, source.rankings.alexa.rank.TG, source.rankings.alexa.rank.TK, source.rankings.alexa.rank.TO, source.rankings.alexa.rank.TT, source.rankings.alexa.rank.TN, source.rankings.alexa.rank.TR, source.rankings.alexa.rank.TM, source.rankings.alexa.rank.TC, source.rankings.alexa.rank.TV, source.rankings.alexa.rank.UG, source.rankings.alexa.rank.UA, source.rankings.alexa.rank.AE, source.rankings.alexa.rank.GB, source.rankings.alexa.rank.US, source.rankings.alexa.rank.UM, source.rankings.alexa.rank.UY, source.rankings.alexa.rank.UZ, source.rankings.alexa.rank.VU, source.rankings.alexa.rank.VE, source.rankings.alexa.rank.VN, source.rankings.alexa.rank.VG, source.rankings.alexa.rank.VI, source.rankings.alexa.rank.WF, source.rankings.alexa.rank.EH, source.rankings.alexa.rank.YE, source.rankings.alexa.rank.ZM, source.rankings.alexa.rank.ZW]
432
525
 
433
526
  ### Return type
434
527
 
@@ -441,7 +534,7 @@ Name | Type | Description | Notes
441
534
  ### HTTP request headers
442
535
 
443
536
  - **Content-Type**: application/x-www-form-urlencoded
444
- - **Accept**: application/json
537
+ - **Accept**: application/json, text/xml
445
538
 
446
539
 
447
540
 
@@ -456,95 +549,118 @@ This endpoint is used for finding related stories based on the parameters provid
456
549
  ```ruby
457
550
  # load the gem
458
551
  require 'aylien_news_api'
552
+
459
553
  # setup authorization
460
554
  AylienNewsApi.configure do |config|
461
- # Configure API key authorization: app_key
462
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
463
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
464
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
465
-
466
555
  # Configure API key authorization: app_id
467
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
468
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
469
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
556
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
557
+
558
+ # Configure API key authorization: app_key
559
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
470
560
  end
471
561
 
472
562
  api_instance = AylienNewsApi::DefaultApi.new
473
563
 
474
564
  opts = {
475
- id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
476
- title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
477
- body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
478
- text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
479
- language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
480
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
481
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
482
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
483
- categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
484
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
485
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
486
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
487
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
488
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
489
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
490
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
491
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
492
- sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
493
- sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
494
- media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
495
- media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
496
- media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
497
- media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
498
- media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
499
- media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
500
- media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
501
- media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
502
- media_images_format: ["media_images_format_example"], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
503
- media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
504
- media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
505
- author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
506
- author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
507
- source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
508
- source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
509
- source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
510
- source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
511
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
512
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
513
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
514
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
515
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
516
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
517
- source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
518
- source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
519
- source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
520
- source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
521
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
522
- social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
523
- social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
524
- social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
525
- social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
526
- social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
527
- social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
528
- social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
529
- social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
530
- cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
531
- cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
532
- _return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
533
- story_id: 789, # Integer | A story id
534
- story_url: "story_url_example", # String | An article or webpage
535
- story_title: "story_title_example", # String | Title of the article
536
- story_body: "story_body_example", # String | Body of the article
537
- boost_by: "boost_by_example", # String | This parameter is used for boosting the result by the specified value.
538
- story_language: "auto", # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
539
- per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
565
+ id: [56],
566
+ not_id: [56],
567
+ title: "title_example",
568
+ body: "body_example",
569
+ text: "text_example",
570
+ language: ["language_example"],
571
+ not_language: ["not_language_example"],
572
+ published_at_start: "published_at_start_example",
573
+ published_at_end: "published_at_end_example",
574
+ categories_taxonomy: "categories_taxonomy_example",
575
+ categories_confident: true,
576
+ categories_id: ["categories_id_example"],
577
+ not_categories_id: ["not_categories_id_example"],
578
+ categories_level: [56],
579
+ not_categories_level: [56],
580
+ entities_title_text: ["entities_title_text_example"],
581
+ not_entities_title_text: ["not_entities_title_text_example"],
582
+ entities_title_type: ["entities_title_type_example"],
583
+ not_entities_title_type: ["not_entities_title_type_example"],
584
+ entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
585
+ not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
586
+ entities_body_text: ["entities_body_text_example"],
587
+ not_entities_body_text: ["not_entities_body_text_example"],
588
+ entities_body_type: ["entities_body_type_example"],
589
+ not_entities_body_type: ["not_entities_body_type_example"],
590
+ entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
591
+ not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
592
+ sentiment_title_polarity: "sentiment_title_polarity_example",
593
+ not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
594
+ sentiment_body_polarity: "sentiment_body_polarity_example",
595
+ not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
596
+ media_images_count_min: 56,
597
+ media_images_count_max: 56,
598
+ media_images_width_min: 56,
599
+ media_images_width_max: 56,
600
+ media_images_height_min: 56,
601
+ media_images_height_max: 56,
602
+ media_images_content_length_min: 56,
603
+ media_images_content_length_max: 56,
604
+ media_images_format: ["media_images_format_example"],
605
+ not_media_images_format: ["not_media_images_format_example"],
606
+ media_videos_count_min: 56,
607
+ media_videos_count_max: 56,
608
+ author_id: [56],
609
+ not_author_id: [56],
610
+ author_name: "author_name_example",
611
+ not_author_name: "not_author_name_example",
612
+ source_id: [56],
613
+ not_source_id: [56],
614
+ source_name: ["source_name_example"],
615
+ not_source_name: ["not_source_name_example"],
616
+ source_domain: ["source_domain_example"],
617
+ not_source_domain: ["not_source_domain_example"],
618
+ source_locations_country: ["source_locations_country_example"],
619
+ not_source_locations_country: ["not_source_locations_country_example"],
620
+ source_locations_state: ["source_locations_state_example"],
621
+ not_source_locations_state: ["not_source_locations_state_example"],
622
+ source_locations_city: ["source_locations_city_example"],
623
+ not_source_locations_city: ["not_source_locations_city_example"],
624
+ source_scopes_country: ["source_scopes_country_example"],
625
+ not_source_scopes_country: ["not_source_scopes_country_example"],
626
+ source_scopes_state: ["source_scopes_state_example"],
627
+ not_source_scopes_state: ["not_source_scopes_state_example"],
628
+ source_scopes_city: ["source_scopes_city_example"],
629
+ not_source_scopes_city: ["not_source_scopes_city_example"],
630
+ source_scopes_level: ["source_scopes_level_example"],
631
+ not_source_scopes_level: ["not_source_scopes_level_example"],
632
+ source_links_in_count_min: 56,
633
+ source_links_in_count_max: 56,
634
+ source_rankings_alexa_rank_min: 56,
635
+ source_rankings_alexa_rank_max: 56,
636
+ source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
637
+ social_shares_count_facebook_min: 56,
638
+ social_shares_count_facebook_max: 56,
639
+ social_shares_count_google_plus_min: 56,
640
+ social_shares_count_google_plus_max: 56,
641
+ social_shares_count_linkedin_min: 56,
642
+ social_shares_count_linkedin_max: 56,
643
+ social_shares_count_reddit_min: 56,
644
+ social_shares_count_reddit_max: 56,
645
+ cluster: false,
646
+ cluster_algorithm: "lingo",
647
+ _return: ["_return_example"],
648
+ story_id: 789,
649
+ story_url: "story_url_example",
650
+ story_title: "story_title_example",
651
+ story_body: "story_body_example",
652
+ boost_by: "boost_by_example",
653
+ story_language: "auto",
654
+ per_page: 3
540
655
  }
541
656
 
542
657
  begin
543
658
  #List related stories
544
659
  result = api_instance.list_related_stories(opts)
545
- p result
660
+ puts result
546
661
  rescue AylienNewsApi::ApiError => e
547
662
  puts "Exception when calling DefaultApi->list_related_stories: #{e}"
663
+ puts e.response_body
548
664
  end
549
665
  ```
550
666
 
@@ -552,25 +668,37 @@ end
552
668
 
553
669
  Name | Type | Description | Notes
554
670
  ------------- | ------------- | ------------- | -------------
555
- **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
671
+ **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
672
+ **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
556
673
  **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
557
674
  **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
558
675
  **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
559
- **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
676
+ **language** | **Array&lt;String&gt;**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
677
+ **not_language** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
560
678
  **published_at_start** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
561
679
  **published_at_end** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
562
- **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
680
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [enum: iab-qag, iptc-subjectcode]
563
681
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
564
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
565
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
566
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
567
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
568
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
569
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
570
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
571
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
572
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
573
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
682
+ **categories_id** | **Array&lt;String&gt;**| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
683
+ **not_categories_id** | **Array&lt;String&gt;**| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
684
+ **categories_level** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
685
+ **not_categories_level** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
686
+ **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
687
+ **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
688
+ **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
689
+ **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
690
+ **entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
691
+ **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
692
+ **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
693
+ **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
694
+ **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
695
+ **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
696
+ **entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
697
+ **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
698
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
699
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
700
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
701
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
574
702
  **media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
575
703
  **media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
576
704
  **media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
@@ -579,26 +707,39 @@ Name | Type | Description | Notes
579
707
  **media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
580
708
  **media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
581
709
  **media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
582
- **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
710
+ **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
711
+ **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
583
712
  **media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
584
713
  **media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
585
- **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
714
+ **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
715
+ **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
586
716
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
587
- **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
588
- **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
589
- **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
590
- **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
591
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
592
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
593
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
594
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
595
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
596
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
717
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
718
+ **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
719
+ **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
720
+ **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
721
+ **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
722
+ **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
723
+ **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
724
+ **source_locations_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
725
+ **not_source_locations_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
726
+ **source_locations_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
727
+ **not_source_locations_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
728
+ **source_locations_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
729
+ **not_source_locations_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
730
+ **source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
731
+ **not_source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
732
+ **source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
733
+ **not_source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
734
+ **source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
735
+ **not_source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
736
+ **source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
737
+ **not_source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
597
738
  **source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
598
739
  **source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
599
740
  **source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
600
741
  **source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
601
- **source_rankings_alexa_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
742
+ **source_rankings_alexa_country** | **Array&lt;String&gt;**| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
602
743
  **social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
603
744
  **social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
604
745
  **social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
@@ -608,14 +749,14 @@ Name | Type | Description | Notes
608
749
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
609
750
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
610
751
  **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to false]
611
- **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo]
612
- **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
752
+ **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo] [enum: stc, lingo, kmeans]
753
+ **_return** | **Array&lt;String&gt;**| This parameter is used for specifying return fields. | [optional] [enum: 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]
613
754
  **story_id** | **Integer**| A story id | [optional]
614
755
  **story_url** | **String**| An article or webpage | [optional]
615
756
  **story_title** | **String**| Title of the article | [optional]
616
757
  **story_body** | **String**| Body of the article | [optional]
617
- **boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
618
- **story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto]
758
+ **boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional] [enum: recency, popularity]
759
+ **story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto] [enum: auto, en, de, fr, it, es, pt]
619
760
  **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
620
761
 
621
762
  ### Return type
@@ -629,7 +770,7 @@ Name | Type | Description | Notes
629
770
  ### HTTP request headers
630
771
 
631
772
  - **Content-Type**: application/x-www-form-urlencoded
632
- - **Accept**: application/json
773
+ - **Accept**: application/json, text/xml
633
774
 
634
775
 
635
776
 
@@ -644,92 +785,115 @@ This endpoint is used for getting a list of stories.
644
785
  ```ruby
645
786
  # load the gem
646
787
  require 'aylien_news_api'
788
+
647
789
  # setup authorization
648
790
  AylienNewsApi.configure do |config|
649
- # Configure API key authorization: app_key
650
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
651
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
652
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
653
-
654
791
  # Configure API key authorization: app_id
655
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
656
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
657
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
792
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
793
+
794
+ # Configure API key authorization: app_key
795
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
658
796
  end
659
797
 
660
798
  api_instance = AylienNewsApi::DefaultApi.new
661
799
 
662
800
  opts = {
663
- id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
664
- title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
665
- body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
666
- text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
667
- language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
668
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
669
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
670
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
671
- categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
672
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
673
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
674
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
675
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
676
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
677
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
678
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
679
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
680
- sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
681
- sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
682
- media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
683
- media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
684
- media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
685
- media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
686
- media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
687
- media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
688
- media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
689
- media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
690
- media_images_format: ["media_images_format_example"], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
691
- media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
692
- media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
693
- author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
694
- author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
695
- source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
696
- source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
697
- source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
698
- source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
699
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
700
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
701
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
702
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
703
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
704
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
705
- source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
706
- source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
707
- source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
708
- source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
709
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
710
- social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
711
- social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
712
- social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
713
- social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
714
- social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
715
- social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
716
- social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
717
- social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
718
- cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
719
- cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
720
- _return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
721
- sort_by: "published_at", # String | This parameter is used for changing the order column of the results.
722
- sort_direction: "desc", # String | This parameter is used for changing the order direction of the result.
723
- cursor: "*", # String | This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
724
- per_page: 10 # Integer | This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results)
801
+ id: [56],
802
+ not_id: [56],
803
+ title: "title_example",
804
+ body: "body_example",
805
+ text: "text_example",
806
+ language: ["language_example"],
807
+ not_language: ["not_language_example"],
808
+ published_at_start: "published_at_start_example",
809
+ published_at_end: "published_at_end_example",
810
+ categories_taxonomy: "categories_taxonomy_example",
811
+ categories_confident: true,
812
+ categories_id: ["categories_id_example"],
813
+ not_categories_id: ["not_categories_id_example"],
814
+ categories_level: [56],
815
+ not_categories_level: [56],
816
+ entities_title_text: ["entities_title_text_example"],
817
+ not_entities_title_text: ["not_entities_title_text_example"],
818
+ entities_title_type: ["entities_title_type_example"],
819
+ not_entities_title_type: ["not_entities_title_type_example"],
820
+ entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
821
+ not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
822
+ entities_body_text: ["entities_body_text_example"],
823
+ not_entities_body_text: ["not_entities_body_text_example"],
824
+ entities_body_type: ["entities_body_type_example"],
825
+ not_entities_body_type: ["not_entities_body_type_example"],
826
+ entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
827
+ not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
828
+ sentiment_title_polarity: "sentiment_title_polarity_example",
829
+ not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
830
+ sentiment_body_polarity: "sentiment_body_polarity_example",
831
+ not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
832
+ media_images_count_min: 56,
833
+ media_images_count_max: 56,
834
+ media_images_width_min: 56,
835
+ media_images_width_max: 56,
836
+ media_images_height_min: 56,
837
+ media_images_height_max: 56,
838
+ media_images_content_length_min: 56,
839
+ media_images_content_length_max: 56,
840
+ media_images_format: ["media_images_format_example"],
841
+ not_media_images_format: ["not_media_images_format_example"],
842
+ media_videos_count_min: 56,
843
+ media_videos_count_max: 56,
844
+ author_id: [56],
845
+ not_author_id: [56],
846
+ author_name: "author_name_example",
847
+ not_author_name: "not_author_name_example",
848
+ source_id: [56],
849
+ not_source_id: [56],
850
+ source_name: ["source_name_example"],
851
+ not_source_name: ["not_source_name_example"],
852
+ source_domain: ["source_domain_example"],
853
+ not_source_domain: ["not_source_domain_example"],
854
+ source_locations_country: ["source_locations_country_example"],
855
+ not_source_locations_country: ["not_source_locations_country_example"],
856
+ source_locations_state: ["source_locations_state_example"],
857
+ not_source_locations_state: ["not_source_locations_state_example"],
858
+ source_locations_city: ["source_locations_city_example"],
859
+ not_source_locations_city: ["not_source_locations_city_example"],
860
+ source_scopes_country: ["source_scopes_country_example"],
861
+ not_source_scopes_country: ["not_source_scopes_country_example"],
862
+ source_scopes_state: ["source_scopes_state_example"],
863
+ not_source_scopes_state: ["not_source_scopes_state_example"],
864
+ source_scopes_city: ["source_scopes_city_example"],
865
+ not_source_scopes_city: ["not_source_scopes_city_example"],
866
+ source_scopes_level: ["source_scopes_level_example"],
867
+ not_source_scopes_level: ["not_source_scopes_level_example"],
868
+ source_links_in_count_min: 56,
869
+ source_links_in_count_max: 56,
870
+ source_rankings_alexa_rank_min: 56,
871
+ source_rankings_alexa_rank_max: 56,
872
+ source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
873
+ social_shares_count_facebook_min: 56,
874
+ social_shares_count_facebook_max: 56,
875
+ social_shares_count_google_plus_min: 56,
876
+ social_shares_count_google_plus_max: 56,
877
+ social_shares_count_linkedin_min: 56,
878
+ social_shares_count_linkedin_max: 56,
879
+ social_shares_count_reddit_min: 56,
880
+ social_shares_count_reddit_max: 56,
881
+ cluster: false,
882
+ cluster_algorithm: "lingo",
883
+ _return: ["_return_example"],
884
+ sort_by: "published_at",
885
+ sort_direction: "desc",
886
+ cursor: "*",
887
+ per_page: 10
725
888
  }
726
889
 
727
890
  begin
728
891
  #List Stories
729
892
  result = api_instance.list_stories(opts)
730
- p result
893
+ puts result
731
894
  rescue AylienNewsApi::ApiError => e
732
895
  puts "Exception when calling DefaultApi->list_stories: #{e}"
896
+ puts e.response_body
733
897
  end
734
898
  ```
735
899
 
@@ -737,25 +901,37 @@ end
737
901
 
738
902
  Name | Type | Description | Notes
739
903
  ------------- | ------------- | ------------- | -------------
740
- **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
904
+ **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
905
+ **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
741
906
  **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
742
907
  **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
743
908
  **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
744
- **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
909
+ **language** | **Array&lt;String&gt;**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
910
+ **not_language** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
745
911
  **published_at_start** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
746
912
  **published_at_end** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
747
- **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
913
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [enum: iab-qag, iptc-subjectcode]
748
914
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
749
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
750
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
751
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
752
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
753
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
754
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
755
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
756
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
757
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
758
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
915
+ **categories_id** | **Array&lt;String&gt;**| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
916
+ **not_categories_id** | **Array&lt;String&gt;**| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
917
+ **categories_level** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
918
+ **not_categories_level** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
919
+ **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
920
+ **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
921
+ **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
922
+ **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
923
+ **entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
924
+ **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
925
+ **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
926
+ **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
927
+ **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
928
+ **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
929
+ **entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
930
+ **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
931
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
932
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
933
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
934
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
759
935
  **media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
760
936
  **media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
761
937
  **media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
@@ -764,26 +940,39 @@ Name | Type | Description | Notes
764
940
  **media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
765
941
  **media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
766
942
  **media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
767
- **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
943
+ **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
944
+ **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
768
945
  **media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
769
946
  **media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
770
- **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
947
+ **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
948
+ **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
771
949
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
772
- **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
773
- **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
774
- **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
775
- **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
776
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
777
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
778
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
779
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
780
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
781
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
950
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
951
+ **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
952
+ **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
953
+ **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
954
+ **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
955
+ **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
956
+ **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
957
+ **source_locations_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
958
+ **not_source_locations_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
959
+ **source_locations_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
960
+ **not_source_locations_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
961
+ **source_locations_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
962
+ **not_source_locations_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
963
+ **source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
964
+ **not_source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
965
+ **source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
966
+ **not_source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
967
+ **source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
968
+ **not_source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
969
+ **source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
970
+ **not_source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
782
971
  **source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
783
972
  **source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
784
973
  **source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
785
974
  **source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
786
- **source_rankings_alexa_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
975
+ **source_rankings_alexa_country** | **Array&lt;String&gt;**| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
787
976
  **social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
788
977
  **social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
789
978
  **social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
@@ -793,10 +982,10 @@ Name | Type | Description | Notes
793
982
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
794
983
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
795
984
  **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to false]
796
- **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo]
797
- **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
798
- **sort_by** | **String**| This parameter is used for changing the order column of the results. | [optional] [default to published_at]
799
- **sort_direction** | **String**| This parameter is used for changing the order direction of the result. | [optional] [default to desc]
985
+ **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo] [enum: stc, lingo, kmeans]
986
+ **_return** | **Array&lt;String&gt;**| This parameter is used for specifying return fields. | [optional] [enum: 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]
987
+ **sort_by** | **String**| This parameter is used for changing the order column of the results. | [optional] [default to published_at] [enum: relevance, recency, hotness, published_at, social_shares_count, social_shares_count.facebook, social_shares_count.linkedin, social_shares_count.google_plus, social_shares_count.reddit, media.images.count, media.videos.count, source.links_in_count, source.rankings.alexa.rank, source.rankings.alexa.rank.AF, source.rankings.alexa.rank.AX, source.rankings.alexa.rank.AL, source.rankings.alexa.rank.DZ, source.rankings.alexa.rank.AS, source.rankings.alexa.rank.AD, source.rankings.alexa.rank.AO, source.rankings.alexa.rank.AI, source.rankings.alexa.rank.AQ, source.rankings.alexa.rank.AG, source.rankings.alexa.rank.AR, source.rankings.alexa.rank.AM, source.rankings.alexa.rank.AW, source.rankings.alexa.rank.AU, source.rankings.alexa.rank.AT, source.rankings.alexa.rank.AZ, source.rankings.alexa.rank.BS, source.rankings.alexa.rank.BH, source.rankings.alexa.rank.BD, source.rankings.alexa.rank.BB, source.rankings.alexa.rank.BY, source.rankings.alexa.rank.BE, source.rankings.alexa.rank.BZ, source.rankings.alexa.rank.BJ, source.rankings.alexa.rank.BM, source.rankings.alexa.rank.BT, source.rankings.alexa.rank.BO, source.rankings.alexa.rank.BQ, source.rankings.alexa.rank.BA, source.rankings.alexa.rank.BW, source.rankings.alexa.rank.BV, source.rankings.alexa.rank.BR, source.rankings.alexa.rank.IO, source.rankings.alexa.rank.BN, source.rankings.alexa.rank.BG, source.rankings.alexa.rank.BF, source.rankings.alexa.rank.BI, source.rankings.alexa.rank.KH, source.rankings.alexa.rank.CM, source.rankings.alexa.rank.CA, source.rankings.alexa.rank.CV, source.rankings.alexa.rank.KY, source.rankings.alexa.rank.CF, source.rankings.alexa.rank.TD, source.rankings.alexa.rank.CL, source.rankings.alexa.rank.CN, source.rankings.alexa.rank.CX, source.rankings.alexa.rank.CC, source.rankings.alexa.rank.CO, source.rankings.alexa.rank.KM, source.rankings.alexa.rank.CG, source.rankings.alexa.rank.CD, source.rankings.alexa.rank.CK, source.rankings.alexa.rank.CR, source.rankings.alexa.rank.CI, source.rankings.alexa.rank.HR, source.rankings.alexa.rank.CU, source.rankings.alexa.rank.CW, source.rankings.alexa.rank.CY, source.rankings.alexa.rank.CZ, source.rankings.alexa.rank.DK, source.rankings.alexa.rank.DJ, source.rankings.alexa.rank.DM, source.rankings.alexa.rank.DO, source.rankings.alexa.rank.EC, source.rankings.alexa.rank.EG, source.rankings.alexa.rank.SV, source.rankings.alexa.rank.GQ, source.rankings.alexa.rank.ER, source.rankings.alexa.rank.EE, source.rankings.alexa.rank.ET, source.rankings.alexa.rank.FK, source.rankings.alexa.rank.FO, source.rankings.alexa.rank.FJ, source.rankings.alexa.rank.FI, source.rankings.alexa.rank.FR, source.rankings.alexa.rank.GF, source.rankings.alexa.rank.PF, source.rankings.alexa.rank.TF, source.rankings.alexa.rank.GA, source.rankings.alexa.rank.GM, source.rankings.alexa.rank.GE, source.rankings.alexa.rank.DE, source.rankings.alexa.rank.GH, source.rankings.alexa.rank.GI, source.rankings.alexa.rank.GR, source.rankings.alexa.rank.GL, source.rankings.alexa.rank.GD, source.rankings.alexa.rank.GP, source.rankings.alexa.rank.GU, source.rankings.alexa.rank.GT, source.rankings.alexa.rank.GG, source.rankings.alexa.rank.GN, source.rankings.alexa.rank.GW, source.rankings.alexa.rank.GY, source.rankings.alexa.rank.HT, source.rankings.alexa.rank.HM, source.rankings.alexa.rank.VA, source.rankings.alexa.rank.HN, source.rankings.alexa.rank.HK, source.rankings.alexa.rank.HU, source.rankings.alexa.rank.IS, source.rankings.alexa.rank.IN, source.rankings.alexa.rank.ID, source.rankings.alexa.rank.IR, source.rankings.alexa.rank.IQ, source.rankings.alexa.rank.IE, source.rankings.alexa.rank.IM, source.rankings.alexa.rank.IL, source.rankings.alexa.rank.IT, source.rankings.alexa.rank.JM, source.rankings.alexa.rank.JP, source.rankings.alexa.rank.JE, source.rankings.alexa.rank.JO, source.rankings.alexa.rank.KZ, source.rankings.alexa.rank.KE, source.rankings.alexa.rank.KI, source.rankings.alexa.rank.KP, source.rankings.alexa.rank.KR, source.rankings.alexa.rank.KW, source.rankings.alexa.rank.KG, source.rankings.alexa.rank.LA, source.rankings.alexa.rank.LV, source.rankings.alexa.rank.LB, source.rankings.alexa.rank.LS, source.rankings.alexa.rank.LR, source.rankings.alexa.rank.LY, source.rankings.alexa.rank.LI, source.rankings.alexa.rank.LT, source.rankings.alexa.rank.LU, source.rankings.alexa.rank.MO, source.rankings.alexa.rank.MK, source.rankings.alexa.rank.MG, source.rankings.alexa.rank.MW, source.rankings.alexa.rank.MY, source.rankings.alexa.rank.MV, source.rankings.alexa.rank.ML, source.rankings.alexa.rank.MT, source.rankings.alexa.rank.MH, source.rankings.alexa.rank.MQ, source.rankings.alexa.rank.MR, source.rankings.alexa.rank.MU, source.rankings.alexa.rank.YT, source.rankings.alexa.rank.MX, source.rankings.alexa.rank.FM, source.rankings.alexa.rank.MD, source.rankings.alexa.rank.MC, source.rankings.alexa.rank.MN, source.rankings.alexa.rank.ME, source.rankings.alexa.rank.MS, source.rankings.alexa.rank.MA, source.rankings.alexa.rank.MZ, source.rankings.alexa.rank.MM, source.rankings.alexa.rank.NA, source.rankings.alexa.rank.NR, source.rankings.alexa.rank.NP, source.rankings.alexa.rank.NL, source.rankings.alexa.rank.NC, source.rankings.alexa.rank.NZ, source.rankings.alexa.rank.NI, source.rankings.alexa.rank.NE, source.rankings.alexa.rank.NG, source.rankings.alexa.rank.NU, source.rankings.alexa.rank.NF, source.rankings.alexa.rank.MP, source.rankings.alexa.rank.NO, source.rankings.alexa.rank.OM, source.rankings.alexa.rank.PK, source.rankings.alexa.rank.PW, source.rankings.alexa.rank.PS, source.rankings.alexa.rank.PA, source.rankings.alexa.rank.PG, source.rankings.alexa.rank.PY, source.rankings.alexa.rank.PE, source.rankings.alexa.rank.PH, source.rankings.alexa.rank.PN, source.rankings.alexa.rank.PL, source.rankings.alexa.rank.PT, source.rankings.alexa.rank.PR, source.rankings.alexa.rank.QA, source.rankings.alexa.rank.RE, source.rankings.alexa.rank.RO, source.rankings.alexa.rank.RU, source.rankings.alexa.rank.RW, source.rankings.alexa.rank.BL, source.rankings.alexa.rank.SH, source.rankings.alexa.rank.KN, source.rankings.alexa.rank.LC, source.rankings.alexa.rank.MF, source.rankings.alexa.rank.PM, source.rankings.alexa.rank.VC, source.rankings.alexa.rank.WS, source.rankings.alexa.rank.SM, source.rankings.alexa.rank.ST, source.rankings.alexa.rank.SA, source.rankings.alexa.rank.SN, source.rankings.alexa.rank.RS, source.rankings.alexa.rank.SC, source.rankings.alexa.rank.SL, source.rankings.alexa.rank.SG, source.rankings.alexa.rank.SX, source.rankings.alexa.rank.SK, source.rankings.alexa.rank.SI, source.rankings.alexa.rank.SB, source.rankings.alexa.rank.SO, source.rankings.alexa.rank.ZA, source.rankings.alexa.rank.GS, source.rankings.alexa.rank.SS, source.rankings.alexa.rank.ES, source.rankings.alexa.rank.LK, source.rankings.alexa.rank.SD, source.rankings.alexa.rank.SR, source.rankings.alexa.rank.SJ, source.rankings.alexa.rank.SZ, source.rankings.alexa.rank.SE, source.rankings.alexa.rank.CH, source.rankings.alexa.rank.SY, source.rankings.alexa.rank.TW, source.rankings.alexa.rank.TJ, source.rankings.alexa.rank.TZ, source.rankings.alexa.rank.TH, source.rankings.alexa.rank.TL, source.rankings.alexa.rank.TG, source.rankings.alexa.rank.TK, source.rankings.alexa.rank.TO, source.rankings.alexa.rank.TT, source.rankings.alexa.rank.TN, source.rankings.alexa.rank.TR, source.rankings.alexa.rank.TM, source.rankings.alexa.rank.TC, source.rankings.alexa.rank.TV, source.rankings.alexa.rank.UG, source.rankings.alexa.rank.UA, source.rankings.alexa.rank.AE, source.rankings.alexa.rank.GB, source.rankings.alexa.rank.US, source.rankings.alexa.rank.UM, source.rankings.alexa.rank.UY, source.rankings.alexa.rank.UZ, source.rankings.alexa.rank.VU, source.rankings.alexa.rank.VE, source.rankings.alexa.rank.VN, source.rankings.alexa.rank.VG, source.rankings.alexa.rank.VI, source.rankings.alexa.rank.WF, source.rankings.alexa.rank.EH, source.rankings.alexa.rank.YE, source.rankings.alexa.rank.ZM, source.rankings.alexa.rank.ZW]
988
+ **sort_direction** | **String**| This parameter is used for changing the order direction of the result. | [optional] [default to desc] [enum: asc, desc]
800
989
  **cursor** | **String**| This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results). | [optional] [default to *]
801
990
  **per_page** | **Integer**| This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results) | [optional] [default to 10]
802
991
 
@@ -811,7 +1000,7 @@ Name | Type | Description | Notes
811
1000
  ### HTTP request headers
812
1001
 
813
1002
  - **Content-Type**: application/x-www-form-urlencoded
814
- - **Accept**: application/json
1003
+ - **Accept**: application/json, text/xml
815
1004
 
816
1005
 
817
1006
 
@@ -826,86 +1015,109 @@ This endpoint is used for getting time series by stories.
826
1015
  ```ruby
827
1016
  # load the gem
828
1017
  require 'aylien_news_api'
1018
+
829
1019
  # setup authorization
830
1020
  AylienNewsApi.configure do |config|
831
- # Configure API key authorization: app_key
832
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
833
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
834
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
835
-
836
1021
  # Configure API key authorization: app_id
837
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
838
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
839
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
1022
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
1023
+
1024
+ # Configure API key authorization: app_key
1025
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
840
1026
  end
841
1027
 
842
1028
  api_instance = AylienNewsApi::DefaultApi.new
843
1029
 
844
1030
  opts = {
845
- id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
846
- title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
847
- body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
848
- text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
849
- language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
850
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
851
- categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
852
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
853
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
854
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
855
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
856
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
857
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
858
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
859
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
860
- sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
861
- sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
862
- media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
863
- media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
864
- media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
865
- media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
866
- media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
867
- media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
868
- media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
869
- media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
870
- media_images_format: ["media_images_format_example"], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
871
- media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
872
- media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
873
- author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
874
- author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
875
- source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
876
- source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
877
- source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
878
- source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
879
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
880
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
881
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
882
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
883
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
884
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
885
- source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
886
- source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
887
- source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
888
- source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
889
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
890
- social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
891
- social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
892
- social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
893
- social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
894
- social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
895
- social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
896
- social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
897
- social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
898
- published_at_start: "NOW-7DAYS/DAY", # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
899
- published_at_end: "NOW/DAY", # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
900
- period: "+1DAY" # String | The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math).
1031
+ id: [56],
1032
+ not_id: [56],
1033
+ title: "title_example",
1034
+ body: "body_example",
1035
+ text: "text_example",
1036
+ language: ["language_example"],
1037
+ not_language: ["not_language_example"],
1038
+ categories_taxonomy: "categories_taxonomy_example",
1039
+ categories_confident: true,
1040
+ categories_id: ["categories_id_example"],
1041
+ not_categories_id: ["not_categories_id_example"],
1042
+ categories_level: [56],
1043
+ not_categories_level: [56],
1044
+ entities_title_text: ["entities_title_text_example"],
1045
+ not_entities_title_text: ["not_entities_title_text_example"],
1046
+ entities_title_type: ["entities_title_type_example"],
1047
+ not_entities_title_type: ["not_entities_title_type_example"],
1048
+ entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
1049
+ not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
1050
+ entities_body_text: ["entities_body_text_example"],
1051
+ not_entities_body_text: ["not_entities_body_text_example"],
1052
+ entities_body_type: ["entities_body_type_example"],
1053
+ not_entities_body_type: ["not_entities_body_type_example"],
1054
+ entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
1055
+ not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
1056
+ sentiment_title_polarity: "sentiment_title_polarity_example",
1057
+ not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
1058
+ sentiment_body_polarity: "sentiment_body_polarity_example",
1059
+ not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
1060
+ media_images_count_min: 56,
1061
+ media_images_count_max: 56,
1062
+ media_images_width_min: 56,
1063
+ media_images_width_max: 56,
1064
+ media_images_height_min: 56,
1065
+ media_images_height_max: 56,
1066
+ media_images_content_length_min: 56,
1067
+ media_images_content_length_max: 56,
1068
+ media_images_format: ["media_images_format_example"],
1069
+ not_media_images_format: ["not_media_images_format_example"],
1070
+ media_videos_count_min: 56,
1071
+ media_videos_count_max: 56,
1072
+ author_id: [56],
1073
+ not_author_id: [56],
1074
+ author_name: "author_name_example",
1075
+ not_author_name: "not_author_name_example",
1076
+ source_id: [56],
1077
+ not_source_id: [56],
1078
+ source_name: ["source_name_example"],
1079
+ not_source_name: ["not_source_name_example"],
1080
+ source_domain: ["source_domain_example"],
1081
+ not_source_domain: ["not_source_domain_example"],
1082
+ source_locations_country: ["source_locations_country_example"],
1083
+ not_source_locations_country: ["not_source_locations_country_example"],
1084
+ source_locations_state: ["source_locations_state_example"],
1085
+ not_source_locations_state: ["not_source_locations_state_example"],
1086
+ source_locations_city: ["source_locations_city_example"],
1087
+ not_source_locations_city: ["not_source_locations_city_example"],
1088
+ source_scopes_country: ["source_scopes_country_example"],
1089
+ not_source_scopes_country: ["not_source_scopes_country_example"],
1090
+ source_scopes_state: ["source_scopes_state_example"],
1091
+ not_source_scopes_state: ["not_source_scopes_state_example"],
1092
+ source_scopes_city: ["source_scopes_city_example"],
1093
+ not_source_scopes_city: ["not_source_scopes_city_example"],
1094
+ source_scopes_level: ["source_scopes_level_example"],
1095
+ not_source_scopes_level: ["not_source_scopes_level_example"],
1096
+ source_links_in_count_min: 56,
1097
+ source_links_in_count_max: 56,
1098
+ source_rankings_alexa_rank_min: 56,
1099
+ source_rankings_alexa_rank_max: 56,
1100
+ source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
1101
+ social_shares_count_facebook_min: 56,
1102
+ social_shares_count_facebook_max: 56,
1103
+ social_shares_count_google_plus_min: 56,
1104
+ social_shares_count_google_plus_max: 56,
1105
+ social_shares_count_linkedin_min: 56,
1106
+ social_shares_count_linkedin_max: 56,
1107
+ social_shares_count_reddit_min: 56,
1108
+ social_shares_count_reddit_max: 56,
1109
+ published_at_start: "NOW-7DAYS/DAY",
1110
+ published_at_end: "NOW/DAY",
1111
+ period: "+1DAY"
901
1112
  }
902
1113
 
903
1114
  begin
904
1115
  #List time series
905
1116
  result = api_instance.list_time_series(opts)
906
- p result
1117
+ puts result
907
1118
  rescue AylienNewsApi::ApiError => e
908
1119
  puts "Exception when calling DefaultApi->list_time_series: #{e}"
1120
+ puts e.response_body
909
1121
  end
910
1122
  ```
911
1123
 
@@ -913,23 +1125,35 @@ end
913
1125
 
914
1126
  Name | Type | Description | Notes
915
1127
  ------------- | ------------- | ------------- | -------------
916
- **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
1128
+ **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
1129
+ **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
917
1130
  **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
918
1131
  **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
919
1132
  **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
920
- **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
921
- **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1133
+ **language** | **Array&lt;String&gt;**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
1134
+ **not_language** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
1135
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [enum: iab-qag, iptc-subjectcode]
922
1136
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
923
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
924
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
925
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
926
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
927
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
928
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
929
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
930
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
931
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
932
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
1137
+ **categories_id** | **Array&lt;String&gt;**| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1138
+ **not_categories_id** | **Array&lt;String&gt;**| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1139
+ **categories_level** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1140
+ **not_categories_level** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1141
+ **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1142
+ **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1143
+ **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1144
+ **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1145
+ **entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1146
+ **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1147
+ **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1148
+ **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1149
+ **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1150
+ **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1151
+ **entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1152
+ **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1153
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1154
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1155
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1156
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
933
1157
  **media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
934
1158
  **media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
935
1159
  **media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
@@ -938,26 +1162,39 @@ Name | Type | Description | Notes
938
1162
  **media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
939
1163
  **media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
940
1164
  **media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
941
- **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
1165
+ **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
1166
+ **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
942
1167
  **media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
943
1168
  **media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
944
- **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
1169
+ **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
1170
+ **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
945
1171
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
946
- **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
947
- **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
948
- **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
949
- **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
950
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
951
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
952
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
953
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
954
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
955
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1172
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
1173
+ **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
1174
+ **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
1175
+ **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1176
+ **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
1177
+ **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1178
+ **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
1179
+ **source_locations_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1180
+ **not_source_locations_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1181
+ **source_locations_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1182
+ **not_source_locations_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1183
+ **source_locations_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1184
+ **not_source_locations_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1185
+ **source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1186
+ **not_source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1187
+ **source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1188
+ **not_source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1189
+ **source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1190
+ **not_source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1191
+ **source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
1192
+ **not_source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
956
1193
  **source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
957
1194
  **source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
958
1195
  **source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
959
1196
  **source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
960
- **source_rankings_alexa_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
1197
+ **source_rankings_alexa_country** | **Array&lt;String&gt;**| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
961
1198
  **social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
962
1199
  **social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
963
1200
  **social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
@@ -981,12 +1218,12 @@ Name | Type | Description | Notes
981
1218
  ### HTTP request headers
982
1219
 
983
1220
  - **Content-Type**: application/x-www-form-urlencoded
984
- - **Accept**: application/json
1221
+ - **Accept**: application/json, text/xml
985
1222
 
986
1223
 
987
1224
 
988
1225
  # **list_trends**
989
- > Trends list_trends(opts)
1226
+ > Trends list_trends(field, opts)
990
1227
 
991
1228
  List trends
992
1229
 
@@ -996,86 +1233,110 @@ This endpoint is used for finding trends based on stories.
996
1233
  ```ruby
997
1234
  # load the gem
998
1235
  require 'aylien_news_api'
1236
+
999
1237
  # setup authorization
1000
1238
  AylienNewsApi.configure do |config|
1001
- # Configure API key authorization: app_key
1002
- config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
1003
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1004
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
1005
-
1006
1239
  # Configure API key authorization: app_id
1007
- config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
1008
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1009
- #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
1240
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'
1241
+
1242
+ # Configure API key authorization: app_key
1243
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
1010
1244
  end
1011
1245
 
1012
1246
  api_instance = AylienNewsApi::DefaultApi.new
1013
1247
 
1248
+ field = "field_example"
1249
+
1014
1250
  opts = {
1015
- id: [56], # Array<Integer> | This parameter is used for finding stories by story id.
1016
- title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
1017
- body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
1018
- text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
1019
- language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
1020
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
1021
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
1022
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1023
- categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1024
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1025
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1026
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1027
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1028
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1029
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1030
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1031
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1032
- sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
1033
- sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
1034
- media_images_count_min: 56, # Integer | This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
1035
- media_images_count_max: 56, # Integer | This parameter is used for finding stories whose number of images is less than or equal to the specified value.
1036
- media_images_width_min: 56, # Integer | This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
1037
- media_images_width_max: 56, # Integer | This parameter is used for finding stories whose width of images are less than or equal to the specified value.
1038
- media_images_height_min: 56, # Integer | This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
1039
- media_images_height_max: 56, # Integer | This parameter is used for finding stories whose height of images are less than or equal to the specified value.
1040
- media_images_content_length_min: 56, # Integer | This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
1041
- media_images_content_length_max: 56, # Integer | This parameter is used for finding stories whose images content length are less than or equal to the specified value.
1042
- media_images_format: ["media_images_format_example"], # Array<String> | This parameter is used for finding stories whose images format are the specified value.
1043
- media_videos_count_min: 56, # Integer | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
1044
- media_videos_count_max: 56, # Integer | This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
1045
- author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
1046
- author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
1047
- source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
1048
- source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
1049
- source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
1050
- source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
1051
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
1052
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
1053
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
1054
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
1055
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
1056
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
1057
- source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
1058
- source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
1059
- source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
1060
- source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
1061
- source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
1062
- social_shares_count_facebook_min: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
1063
- social_shares_count_facebook_max: 56, # Integer | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
1064
- social_shares_count_google_plus_min: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
1065
- social_shares_count_google_plus_max: 56, # Integer | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
1066
- social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
1067
- social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
1068
- social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
1069
- social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
1070
- field: "field_example" # String | This parameter is used to specify the trend field.
1251
+ id: [56],
1252
+ not_id: [56],
1253
+ title: "title_example",
1254
+ body: "body_example",
1255
+ text: "text_example",
1256
+ language: ["language_example"],
1257
+ not_language: ["not_language_example"],
1258
+ published_at_start: "published_at_start_example",
1259
+ published_at_end: "published_at_end_example",
1260
+ categories_taxonomy: "categories_taxonomy_example",
1261
+ categories_confident: true,
1262
+ categories_id: ["categories_id_example"],
1263
+ not_categories_id: ["not_categories_id_example"],
1264
+ categories_level: [56],
1265
+ not_categories_level: [56],
1266
+ entities_title_text: ["entities_title_text_example"],
1267
+ not_entities_title_text: ["not_entities_title_text_example"],
1268
+ entities_title_type: ["entities_title_type_example"],
1269
+ not_entities_title_type: ["not_entities_title_type_example"],
1270
+ entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"],
1271
+ not_entities_title_links_dbpedia: ["not_entities_title_links_dbpedia_example"],
1272
+ entities_body_text: ["entities_body_text_example"],
1273
+ not_entities_body_text: ["not_entities_body_text_example"],
1274
+ entities_body_type: ["entities_body_type_example"],
1275
+ not_entities_body_type: ["not_entities_body_type_example"],
1276
+ entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"],
1277
+ not_entities_body_links_dbpedia: ["not_entities_body_links_dbpedia_example"],
1278
+ sentiment_title_polarity: "sentiment_title_polarity_example",
1279
+ not_sentiment_title_polarity: "not_sentiment_title_polarity_example",
1280
+ sentiment_body_polarity: "sentiment_body_polarity_example",
1281
+ not_sentiment_body_polarity: "not_sentiment_body_polarity_example",
1282
+ media_images_count_min: 56,
1283
+ media_images_count_max: 56,
1284
+ media_images_width_min: 56,
1285
+ media_images_width_max: 56,
1286
+ media_images_height_min: 56,
1287
+ media_images_height_max: 56,
1288
+ media_images_content_length_min: 56,
1289
+ media_images_content_length_max: 56,
1290
+ media_images_format: ["media_images_format_example"],
1291
+ not_media_images_format: ["not_media_images_format_example"],
1292
+ media_videos_count_min: 56,
1293
+ media_videos_count_max: 56,
1294
+ author_id: [56],
1295
+ not_author_id: [56],
1296
+ author_name: "author_name_example",
1297
+ not_author_name: "not_author_name_example",
1298
+ source_id: [56],
1299
+ not_source_id: [56],
1300
+ source_name: ["source_name_example"],
1301
+ not_source_name: ["not_source_name_example"],
1302
+ source_domain: ["source_domain_example"],
1303
+ not_source_domain: ["not_source_domain_example"],
1304
+ source_locations_country: ["source_locations_country_example"],
1305
+ not_source_locations_country: ["not_source_locations_country_example"],
1306
+ source_locations_state: ["source_locations_state_example"],
1307
+ not_source_locations_state: ["not_source_locations_state_example"],
1308
+ source_locations_city: ["source_locations_city_example"],
1309
+ not_source_locations_city: ["not_source_locations_city_example"],
1310
+ source_scopes_country: ["source_scopes_country_example"],
1311
+ not_source_scopes_country: ["not_source_scopes_country_example"],
1312
+ source_scopes_state: ["source_scopes_state_example"],
1313
+ not_source_scopes_state: ["not_source_scopes_state_example"],
1314
+ source_scopes_city: ["source_scopes_city_example"],
1315
+ not_source_scopes_city: ["not_source_scopes_city_example"],
1316
+ source_scopes_level: ["source_scopes_level_example"],
1317
+ not_source_scopes_level: ["not_source_scopes_level_example"],
1318
+ source_links_in_count_min: 56,
1319
+ source_links_in_count_max: 56,
1320
+ source_rankings_alexa_rank_min: 56,
1321
+ source_rankings_alexa_rank_max: 56,
1322
+ source_rankings_alexa_country: ["source_rankings_alexa_country_example"],
1323
+ social_shares_count_facebook_min: 56,
1324
+ social_shares_count_facebook_max: 56,
1325
+ social_shares_count_google_plus_min: 56,
1326
+ social_shares_count_google_plus_max: 56,
1327
+ social_shares_count_linkedin_min: 56,
1328
+ social_shares_count_linkedin_max: 56,
1329
+ social_shares_count_reddit_min: 56,
1330
+ social_shares_count_reddit_max: 56,
1071
1331
  }
1072
1332
 
1073
1333
  begin
1074
1334
  #List trends
1075
- result = api_instance.list_trends(opts)
1076
- p result
1335
+ result = api_instance.list_trends(field, opts)
1336
+ puts result
1077
1337
  rescue AylienNewsApi::ApiError => e
1078
1338
  puts "Exception when calling DefaultApi->list_trends: #{e}"
1339
+ puts e.response_body
1079
1340
  end
1080
1341
  ```
1081
1342
 
@@ -1083,25 +1344,38 @@ end
1083
1344
 
1084
1345
  Name | Type | Description | Notes
1085
1346
  ------------- | ------------- | ------------- | -------------
1086
- **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by story id. | [optional]
1347
+ **field** | **String**| This parameter is used to specify the trend field. | [enum: author.name, source.name, source.domain, keywords, entities.title.text, entities.title.type, entities.title.links.dbpedia, entities.body.text, entities.body.type, entities.body.links.dbpedia, hashtags, categories.id, sentiment.title.polarity, sentiment.body.polarity]
1348
+ **id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by story id. | [optional]
1349
+ **not_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by story id. | [optional]
1087
1350
  **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1088
1351
  **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1089
1352
  **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1090
- **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
1353
+ **language** | **Array&lt;String&gt;**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
1354
+ **not_language** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
1091
1355
  **published_at_start** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
1092
1356
  **published_at_end** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
1093
- **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1357
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [enum: iab-qag, iptc-subjectcode]
1094
1358
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
1095
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1096
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1097
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1098
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1099
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1100
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1101
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1102
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1103
- **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
1104
- **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
1359
+ **categories_id** | **Array&lt;String&gt;**| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1360
+ **not_categories_id** | **Array&lt;String&gt;**| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1361
+ **categories_level** | **Array&lt;Integer&gt;**| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1362
+ **not_categories_level** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1363
+ **entities_title_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1364
+ **not_entities_title_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1365
+ **entities_title_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1366
+ **not_entities_title_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1367
+ **entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1368
+ **not_entities_title_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1369
+ **entities_body_text** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1370
+ **not_entities_body_text** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1371
+ **entities_body_type** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1372
+ **not_entities_body_type** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1373
+ **entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1374
+ **not_entities_body_links_dbpedia** | **Array&lt;String&gt;**| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1375
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1376
+ **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1377
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1378
+ **not_sentiment_body_polarity** | **String**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
1105
1379
  **media_images_count_min** | **Integer**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
1106
1380
  **media_images_count_max** | **Integer**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
1107
1381
  **media_images_width_min** | **Integer**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
@@ -1110,26 +1384,39 @@ Name | Type | Description | Notes
1110
1384
  **media_images_height_max** | **Integer**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
1111
1385
  **media_images_content_length_min** | **Integer**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
1112
1386
  **media_images_content_length_max** | **Integer**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
1113
- **media_images_format** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose images format are the specified value. | [optional]
1387
+ **media_images_format** | **Array&lt;String&gt;**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
1388
+ **not_media_images_format** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
1114
1389
  **media_videos_count_min** | **Integer**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
1115
1390
  **media_videos_count_max** | **Integer**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
1116
- **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
1391
+ **author_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose author id is the specified value. | [optional]
1392
+ **not_author_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
1117
1393
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
1118
- **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
1119
- **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1120
- **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1121
- **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1122
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1123
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1124
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1125
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1126
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1127
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1394
+ **not_author_name** | **String**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
1395
+ **source_id** | **Array&lt;Integer&gt;**| This parameter is used for finding stories whose source id is the specified value. | [optional]
1396
+ **not_source_id** | **Array&lt;Integer&gt;**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
1397
+ **source_name** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
1398
+ **not_source_name** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
1399
+ **source_domain** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
1400
+ **not_source_domain** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
1401
+ **source_locations_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1402
+ **not_source_locations_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1403
+ **source_locations_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1404
+ **not_source_locations_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1405
+ **source_locations_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1406
+ **not_source_locations_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1407
+ **source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1408
+ **not_source_scopes_country** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1409
+ **source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1410
+ **not_source_scopes_state** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1411
+ **source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1412
+ **not_source_scopes_city** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
1413
+ **source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
1414
+ **not_source_scopes_level** | **Array&lt;String&gt;**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
1128
1415
  **source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
1129
1416
  **source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
1130
1417
  **source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
1131
1418
  **source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
1132
- **source_rankings_alexa_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
1419
+ **source_rankings_alexa_country** | **Array&lt;String&gt;**| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
1133
1420
  **social_shares_count_facebook_min** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
1134
1421
  **social_shares_count_facebook_max** | **Integer**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
1135
1422
  **social_shares_count_google_plus_min** | **Integer**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
@@ -1138,7 +1425,6 @@ Name | Type | Description | Notes
1138
1425
  **social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
1139
1426
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
1140
1427
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
1141
- **field** | **String**| This parameter is used to specify the trend field. | [optional]
1142
1428
 
1143
1429
  ### Return type
1144
1430
 
@@ -1151,7 +1437,7 @@ Name | Type | Description | Notes
1151
1437
  ### HTTP request headers
1152
1438
 
1153
1439
  - **Content-Type**: application/x-www-form-urlencoded
1154
- - **Accept**: application/json
1440
+ - **Accept**: application/json, text/xml
1155
1441
 
1156
1442
 
1157
1443