aylien_news_api 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -4
  3. data/README.md +8 -7
  4. data/aylien_news_api.gemspec +15 -2
  5. data/docs/CategoryLinks.md +2 -2
  6. data/docs/Coverages.md +1 -0
  7. data/docs/DefaultApi.md +315 -252
  8. data/docs/Media.md +1 -1
  9. data/docs/RelatedStories.md +1 -0
  10. data/docs/Scope.md +4 -4
  11. data/docs/Story.md +5 -5
  12. data/lib/aylien_news_api/api/default_api.rb +615 -549
  13. data/lib/aylien_news_api/api_client.rb +2 -2
  14. data/lib/aylien_news_api/configuration.rb +8 -0
  15. data/lib/aylien_news_api/models/author.rb +25 -6
  16. data/lib/aylien_news_api/models/autocomplete.rb +23 -5
  17. data/lib/aylien_news_api/models/autocompletes.rb +21 -4
  18. data/lib/aylien_news_api/models/category.rb +57 -12
  19. data/lib/aylien_news_api/models/category_links.rb +25 -7
  20. data/lib/aylien_news_api/models/coverages.rb +45 -12
  21. data/lib/aylien_news_api/models/entities.rb +23 -5
  22. data/lib/aylien_news_api/models/entity.rb +49 -8
  23. data/lib/aylien_news_api/models/entity_links.rb +21 -4
  24. data/lib/aylien_news_api/models/error.rb +31 -9
  25. data/lib/aylien_news_api/models/error_links.rb +21 -4
  26. data/lib/aylien_news_api/models/errors.rb +21 -4
  27. data/lib/aylien_news_api/models/histogram_interval.rb +23 -5
  28. data/lib/aylien_news_api/models/histograms.rb +29 -8
  29. data/lib/aylien_news_api/models/location.rb +25 -6
  30. data/lib/aylien_news_api/models/media.rb +50 -9
  31. data/lib/aylien_news_api/models/related_stories.rb +43 -11
  32. data/lib/aylien_news_api/models/scope.rb +57 -14
  33. data/lib/aylien_news_api/models/sentiment.rb +69 -8
  34. data/lib/aylien_news_api/models/sentiments.rb +23 -5
  35. data/lib/aylien_news_api/models/share_count.rb +23 -5
  36. data/lib/aylien_news_api/models/share_counts.rb +27 -7
  37. data/lib/aylien_news_api/models/source.rb +31 -9
  38. data/lib/aylien_news_api/models/stories.rb +25 -6
  39. data/lib/aylien_news_api/models/story.rb +64 -28
  40. data/lib/aylien_news_api/models/story_cluster.rb +29 -8
  41. data/lib/aylien_news_api/models/story_links.rb +25 -6
  42. data/lib/aylien_news_api/models/summary.rb +21 -4
  43. data/lib/aylien_news_api/models/time_series.rb +23 -5
  44. data/lib/aylien_news_api/models/time_series_list.rb +27 -7
  45. data/lib/aylien_news_api/models/trend.rb +23 -5
  46. data/lib/aylien_news_api/models/trends.rb +23 -5
  47. data/lib/aylien_news_api/version.rb +1 -1
  48. data/spec/api_client_spec.rb +306 -0
  49. data/spec/configuration_spec.rb +39 -0
  50. data/spec/spec_helper.rb +113 -0
  51. metadata +34 -49
  52. data/Rakefile +0 -8
  53. data/aylien_news_api-0.0.1.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8037c93bfa9bd7ec8fc6ad55cc65e89ab7ba8174
4
- data.tar.gz: d2098cd0f50bacb1149aac1eb146ae6d2d95801c
3
+ metadata.gz: 43cf58c6e6a815ab918358b4e04485e23c7c0108
4
+ data.tar.gz: bc3866443b77211eaa72d638d58a28c88e93b5ca
5
5
  SHA512:
6
- metadata.gz: 8be9134ea370c68fa8091d88a770f5d710fb617a62595611fbac6c973d629c8f4c50e9e227063b22ce1ba9f97478069fc6e25377d8bf992f320df7dcba389280
7
- data.tar.gz: 8db848addbf9eccb5cdf535cf30dc823dc0bff1886617379ea3c166a7999c487f2854b63e3f70fe8c0cbecdb063c7a125162c65bb1694c6b9491221728b2684c
6
+ metadata.gz: c6e8415b22f3af42361240206b3fd15e99657b76eb45ca4075b9141656cfc4bfe642ff8793f947d5ab12bb0431035bc247e475c449778432d4aab9996cb1bf96
7
+ data.tar.gz: 255e0a58ab1d34bc29fe5ac1ac3f92f2de305a583541f65a09219b62d68a3eee3a8c89bcf4050ed557195a08dec16036e5db4a8858e51288c4537582c2c84099
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- aylien_news_api (0.1.0)
4
+ aylien_news_api (0.2.0)
5
5
  json (~> 1.8, >= 1.8.3)
6
6
  typhoeus (~> 1.0, >= 1.0.1)
7
7
 
@@ -24,7 +24,6 @@ GEM
24
24
  ffi (1.9.10)
25
25
  hashdiff (0.3.0)
26
26
  json (1.8.3)
27
- rake (11.1.2)
28
27
  rspec (3.4.0)
29
28
  rspec-core (~> 3.4.0)
30
29
  rspec-expectations (~> 3.4.0)
@@ -58,10 +57,9 @@ DEPENDENCIES
58
57
  autotest-growl (~> 0.2, >= 0.2.16)
59
58
  autotest-rails-pure (~> 4.1, >= 4.1.2)
60
59
  aylien_news_api!
61
- rake (~> 11.1, >= 11.1.2)
62
60
  rspec (~> 3.4, >= 3.4.0)
63
61
  vcr (~> 3.0, >= 3.0.1)
64
62
  webmock (~> 1.24, >= 1.24.3)
65
63
 
66
64
  BUNDLED WITH
67
- 1.11.2
65
+ 1.12.4
data/README.md CHANGED
@@ -5,6 +5,8 @@ The Ruby gem for the AYLIEN News API
5
5
 
6
6
  AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. If you haven't already done so, you will need to [sign up](https://newsapi.aylien.com/signup).
7
7
 
8
+ Visit our [interactive documentation](https://newsapi.aylien.com/docs/#swagger-ui-container) to familiarize yourself with the API.
9
+
8
10
  ## Installation
9
11
 
10
12
  ### RubyGems
@@ -17,9 +19,9 @@ or install it directly:
17
19
 
18
20
  gem install aylien_news_api
19
21
 
20
- ### Install from Git
22
+ ### Git
21
23
 
22
- If the Ruby gem is hosted at a git repository: https://github.com/AYLIEN/aylien_newsapi_ruby, then add the following in the Gemfile:
24
+ Add the following in the Gemfile:
23
25
 
24
26
  gem 'aylien_news_api', :git => 'https://github.com/AYLIEN/aylien_newsapi_ruby.git'
25
27
 
@@ -119,15 +121,14 @@ Class | Method | HTTP request | Description
119
121
  ## Documentation for Authorization
120
122
 
121
123
 
122
- ### app_key
124
+ ### app_id
123
125
 
124
126
  - **Type**: API key
125
- - **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
127
+ - **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
126
128
  - **Location**: HTTP header
127
129
 
128
- ### app_id
130
+ ### app_key
129
131
 
130
132
  - **Type**: API key
131
- - **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
133
+ - **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
132
134
  - **Location**: HTTP header
133
-
@@ -1,4 +1,18 @@
1
1
  # -*- encoding: utf-8 -*-
2
+ # Copyright 2016 Aylien, Inc. All Rights Reserved.
3
+ #
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.
15
+
2
16
  $:.push File.expand_path("../lib", __FILE__)
3
17
  require "aylien_news_api/version"
4
18
 
@@ -15,8 +29,7 @@ Gem::Specification.new do |s|
15
29
 
16
30
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
17
31
  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
18
-
19
- s.add_development_dependency 'rake', '~> 11.1', '>= 11.1.2'
32
+
20
33
  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
21
34
  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
22
35
  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **_self** | **String** | A URL points to the category | [optional]
7
- **parent** | **String** | A URL points to the parent category | [optional]
6
+ **_self** | **String** | A URL pointing to the category | [optional]
7
+ **parent** | **String** | A URL pointing to the parent category | [optional]
8
8
 
9
9
 
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
8
8
  **story_published_at** | **DateTime** | The input story published date | [optional]
9
9
  **story_language** | **String** | The input story language | [optional]
10
10
  **coverages** | [**Array<Story>**](Story.md) | An array of coverages for the input story | [optional]
11
+ **clusters** | [**Array<StoryCluster>**](StoryCluster.md) | An array of clusters | [optional]
11
12
 
12
13
 
@@ -24,7 +24,8 @@ 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
- # setup authorization
27
+
28
+ # setup authorization
28
29
  AylienNewsApi.configure do |config|
29
30
  # Configure API key authorization: app_id
30
31
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
@@ -37,11 +38,11 @@ api_instance = AylienNewsApi::DefaultApi.new
37
38
 
38
39
  type = "type_example" # String | This parameter is used for defining the type of autocompletes.
39
40
 
40
- term = "term_example" # String | This parameter is used for finding autocomplete objects whose contains the specified value.
41
+ term = "term_example" # String | This parameter is used for finding autocomplete objects that contain the specified value.
41
42
 
42
43
  opts = {
43
44
  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.
44
- per_page: 3 # Integer | This parameter is used for specifying number of the items in each page.
45
+ per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
45
46
  }
46
47
 
47
48
  begin
@@ -58,9 +59,9 @@ end
58
59
  Name | Type | Description | Notes
59
60
  ------------- | ------------- | ------------- | -------------
60
61
  **type** | **String**| This parameter is used for defining the type of autocompletes. |
61
- **term** | **String**| This parameter is used for finding autocomplete objects whose contains the specified value. |
62
+ **term** | **String**| This parameter is used for finding autocomplete objects that contain the specified value. |
62
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]
63
- **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 3]
64
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
64
65
 
65
66
  ### Return type
66
67
 
@@ -82,13 +83,14 @@ Name | Type | Description | Notes
82
83
 
83
84
  List coverages
84
85
 
85
- This endpoint is used for finding story coverages based on provided parameters. The number of coverages to return, up to a maximum of 100.
86
+ This endpoint is used for finding story coverages based on the parameters provided. The maximum number of related stories returned is 100.
86
87
 
87
88
  ### Example
88
89
  ```ruby
89
90
  # load the gem
90
91
  require 'aylien_news_api'
91
- # setup authorization
92
+
93
+ # setup authorization
92
94
  AylienNewsApi.configure do |config|
93
95
  # Configure API key authorization: app_id
94
96
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
@@ -105,40 +107,46 @@ opts = {
105
107
  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).
106
108
  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).
107
109
  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.
108
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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).
109
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at 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).
110
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
110
+ 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).
111
+ 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).
112
+ categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries.
111
113
  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
112
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
113
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
114
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
115
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
116
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
117
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
118
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
119
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
114
+ categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id.
115
+ categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level.
116
+ 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.
117
+ 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.
118
+ 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.
119
+ 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.
120
+ 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.
121
+ 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.
120
122
  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
121
123
  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
124
+ 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.
125
+ 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.
126
+ 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.
127
+ 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.
122
128
  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
123
129
  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
124
130
  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
125
131
  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
126
132
  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
127
- 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.
128
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
129
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
130
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
131
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
132
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
133
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
133
+ 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).
134
+ 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).
135
+ 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).
136
+ 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).
137
+ 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).
138
+ 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).
139
+ 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).
140
+ cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
141
+ 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.
134
142
  _return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
135
143
  story_id: 789, # Integer | A story id
136
144
  story_url: "story_url_example", # String | An article or webpage
137
145
  story_title: "story_title_example", # String | Title of the article
138
146
  story_body: "story_body_example", # String | Body of the article
139
- story_published_at: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Publish date of the article. If you use url or title and body 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).
140
- story_language: "auto", # String | This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
141
- per_page: 3 # Integer | This parameter is used for specifying number of the items in each page.
147
+ 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).
148
+ 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.
149
+ per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
142
150
  }
143
151
 
144
152
  begin
@@ -159,40 +167,46 @@ Name | Type | Description | Notes
159
167
  **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]
160
168
  **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]
161
169
  **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]
162
- **published_at_start** | **String**| This parameter is used for finding stories whose published at 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]
163
- **published_at_end** | **String**| This parameter is used for finding stories whose published at 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]
164
- **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional]
170
+ **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]
171
+ **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]
172
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. | [optional]
165
173
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
166
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional]
167
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional]
168
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional]
169
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional]
170
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional]
171
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional]
172
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional]
173
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional]
174
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. | [optional]
175
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. | [optional]
176
+ **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. | [optional]
177
+ **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. | [optional]
178
+ **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. | [optional]
179
+ **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. | [optional]
180
+ **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. | [optional]
181
+ **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. | [optional]
174
182
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
175
183
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
184
+ **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]
185
+ **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]
186
+ **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]
187
+ **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]
176
188
  **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
177
189
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
178
190
  **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
179
191
  **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
180
192
  **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
181
- **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. | [optional]
182
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional]
183
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional]
184
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional]
185
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional]
186
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional]
187
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional]
193
+ **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]
194
+ **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]
195
+ **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]
196
+ **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]
197
+ **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]
198
+ **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]
199
+ **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]
200
+ **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
201
+ **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. | [optional] [default to lingo]
188
202
  **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
189
203
  **story_id** | **Integer**| A story id | [optional]
190
204
  **story_url** | **String**| An article or webpage | [optional]
191
205
  **story_title** | **String**| Title of the article | [optional]
192
206
  **story_body** | **String**| Body of the article | [optional]
193
- **story_published_at** | **DateTime**| Publish date of the article. If you use url or title and body 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]
194
- **story_language** | **String**| This parameter is used for setting 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]
195
- **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 3]
207
+ **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]
208
+ **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]
209
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
196
210
 
197
211
  ### Return type
198
212
 
@@ -214,13 +228,14 @@ Name | Type | Description | Notes
214
228
 
215
229
  List histograms
216
230
 
217
- This endpoint is used for getting histograms based on the field parameter is passed.
231
+ This endpoint is used for getting histograms based on the `field` parameter passed to the API.
218
232
 
219
233
  ### Example
220
234
  ```ruby
221
235
  # load the gem
222
236
  require 'aylien_news_api'
223
- # setup authorization
237
+
238
+ # setup authorization
224
239
  AylienNewsApi.configure do |config|
225
240
  # Configure API key authorization: app_id
226
241
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
@@ -237,32 +252,36 @@ opts = {
237
252
  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).
238
253
  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).
239
254
  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.
240
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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).
241
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at 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).
242
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
255
+ 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).
256
+ 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).
257
+ categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries.
243
258
  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
244
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
245
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
246
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
247
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
248
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
249
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
250
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
251
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
259
+ categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id.
260
+ categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level.
261
+ 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.
262
+ 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.
263
+ 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.
264
+ 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.
265
+ 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.
266
+ 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.
252
267
  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
253
268
  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
269
+ 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.
270
+ 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.
271
+ 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.
272
+ 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.
254
273
  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
255
274
  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
256
275
  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
257
276
  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
258
277
  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
259
- 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.
260
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
261
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
262
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
263
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
264
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
265
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
278
+ 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).
279
+ 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).
280
+ 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).
281
+ 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).
282
+ 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).
283
+ 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).
284
+ 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).
266
285
  interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
267
286
  interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
268
287
  interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
@@ -287,32 +306,36 @@ Name | Type | Description | Notes
287
306
  **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]
288
307
  **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]
289
308
  **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]
290
- **published_at_start** | **String**| This parameter is used for finding stories whose published at 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]
291
- **published_at_end** | **String**| This parameter is used for finding stories whose published at 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]
292
- **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional]
309
+ **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]
310
+ **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]
311
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. | [optional]
293
312
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
294
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional]
295
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional]
296
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional]
297
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional]
298
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional]
299
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional]
300
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional]
301
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional]
313
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. | [optional]
314
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. | [optional]
315
+ **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. | [optional]
316
+ **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. | [optional]
317
+ **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. | [optional]
318
+ **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. | [optional]
319
+ **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. | [optional]
320
+ **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. | [optional]
302
321
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
303
322
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
323
+ **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]
324
+ **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]
325
+ **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]
326
+ **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]
304
327
  **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
305
328
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
306
329
  **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
307
330
  **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
308
331
  **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
309
- **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. | [optional]
310
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional]
311
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional]
312
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional]
313
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional]
314
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional]
315
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional]
332
+ **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]
333
+ **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]
334
+ **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]
335
+ **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]
336
+ **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]
337
+ **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]
338
+ **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]
316
339
  **interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
317
340
  **interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
318
341
  **interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
@@ -338,13 +361,14 @@ Name | Type | Description | Notes
338
361
 
339
362
  List related stories
340
363
 
341
- This endpoint is used for finding related stories based on provided parameters. The number of related stories to return, up to a maximum of 100.
364
+ This endpoint is used for finding related stories based on the parameters provided. The maximum number of related stories returned is 100.
342
365
 
343
366
  ### Example
344
367
  ```ruby
345
368
  # load the gem
346
369
  require 'aylien_news_api'
347
- # setup authorization
370
+
371
+ # setup authorization
348
372
  AylienNewsApi.configure do |config|
349
373
  # Configure API key authorization: app_id
350
374
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
@@ -361,40 +385,46 @@ opts = {
361
385
  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).
362
386
  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).
363
387
  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.
364
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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).
365
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at 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).
366
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
388
+ 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).
389
+ 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).
390
+ categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries.
367
391
  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
368
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
369
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
370
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
371
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
372
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
373
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
374
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
375
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
392
+ categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id.
393
+ categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level.
394
+ 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.
395
+ 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.
396
+ 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.
397
+ 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.
398
+ 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.
399
+ 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.
376
400
  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
377
401
  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
402
+ 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.
403
+ 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.
404
+ 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.
405
+ 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.
378
406
  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
379
407
  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
380
408
  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
381
409
  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
382
410
  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
383
- 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.
384
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
385
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
386
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
387
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
388
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
389
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
411
+ 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).
412
+ 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).
413
+ 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).
414
+ 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).
415
+ 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).
416
+ 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).
417
+ 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).
418
+ cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
419
+ 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.
390
420
  _return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
391
421
  story_id: 789, # Integer | A story id
392
422
  story_url: "story_url_example", # String | An article or webpage
393
423
  story_title: "story_title_example", # String | Title of the article
394
424
  story_body: "story_body_example", # String | Body of the article
395
- boost_by: "boost_by_example", # String | This parameter is used for boosting result by the specified value.
396
- story_language: "auto", # String | This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
397
- per_page: 3 # Integer | This parameter is used for specifying number of the items in each page.
425
+ boost_by: "boost_by_example", # String | This parameter is used for boosting the result by the specified value.
426
+ 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.
427
+ per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
398
428
  }
399
429
 
400
430
  begin
@@ -415,40 +445,46 @@ Name | Type | Description | Notes
415
445
  **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]
416
446
  **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]
417
447
  **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]
418
- **published_at_start** | **String**| This parameter is used for finding stories whose published at 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]
419
- **published_at_end** | **String**| This parameter is used for finding stories whose published at 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]
420
- **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional]
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]
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]
450
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. | [optional]
421
451
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
422
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional]
423
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional]
424
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional]
425
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional]
426
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional]
427
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional]
428
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional]
429
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional]
452
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. | [optional]
453
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. | [optional]
454
+ **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. | [optional]
455
+ **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. | [optional]
456
+ **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. | [optional]
457
+ **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. | [optional]
458
+ **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. | [optional]
459
+ **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. | [optional]
430
460
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
431
461
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
462
+ **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]
463
+ **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]
464
+ **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]
465
+ **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]
432
466
  **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
433
467
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
434
468
  **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
435
469
  **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
436
470
  **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
437
- **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. | [optional]
438
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional]
439
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional]
440
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional]
441
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional]
442
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional]
443
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional]
471
+ **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]
472
+ **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]
473
+ **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]
474
+ **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]
475
+ **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]
476
+ **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]
477
+ **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]
478
+ **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
479
+ **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. | [optional] [default to lingo]
444
480
  **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
445
481
  **story_id** | **Integer**| A story id | [optional]
446
482
  **story_url** | **String**| An article or webpage | [optional]
447
483
  **story_title** | **String**| Title of the article | [optional]
448
484
  **story_body** | **String**| Body of the article | [optional]
449
- **boost_by** | **String**| This parameter is used for boosting result by the specified value. | [optional]
450
- **story_language** | **String**| This parameter is used for setting 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]
451
- **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 3]
485
+ **boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
486
+ **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]
487
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
452
488
 
453
489
  ### Return type
454
490
 
@@ -470,13 +506,14 @@ Name | Type | Description | Notes
470
506
 
471
507
  List Stories
472
508
 
473
- This endpoint is used for getting list of stories.
509
+ This endpoint is used for getting a list of stories.
474
510
 
475
511
  ### Example
476
512
  ```ruby
477
513
  # load the gem
478
514
  require 'aylien_news_api'
479
- # setup authorization
515
+
516
+ # setup authorization
480
517
  AylienNewsApi.configure do |config|
481
518
  # Configure API key authorization: app_id
482
519
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
@@ -493,39 +530,43 @@ opts = {
493
530
  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).
494
531
  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).
495
532
  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.
496
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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).
497
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at 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).
498
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
533
+ 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).
534
+ 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).
535
+ categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries.
499
536
  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
500
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
501
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
502
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
503
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
504
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
505
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
506
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
507
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
537
+ categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id.
538
+ categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level.
539
+ 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.
540
+ 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.
541
+ 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.
542
+ 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.
543
+ 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.
544
+ 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.
508
545
  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
509
546
  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
547
+ 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.
548
+ 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.
549
+ 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.
550
+ 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.
510
551
  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
511
552
  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
512
553
  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
513
554
  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
514
555
  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
515
- 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.
516
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
517
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
518
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
519
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
520
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
521
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
556
+ 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).
557
+ 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).
558
+ 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).
559
+ 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).
560
+ 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).
561
+ 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).
562
+ 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).
522
563
  cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
523
- cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
564
+ 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.
524
565
  _return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
525
- sort_by: "published_at", # String | This parameter is used for changing the order column of the result.
566
+ sort_by: "published_at", # String | This parameter is used for changing the order column of the results.
526
567
  sort_direction: "desc", # String | This parameter is used for changing the order direction of the result.
527
568
  cursor: "*", # String | This parameter is used for finding a specific page.
528
- per_page: 10 # Integer | This parameter is used for specifying number of the items in each page.
569
+ per_page: 10 # Integer | This parameter is used for specifying number of items in each page.
529
570
  }
530
571
 
531
572
  begin
@@ -546,39 +587,43 @@ Name | Type | Description | Notes
546
587
  **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]
547
588
  **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]
548
589
  **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]
549
- **published_at_start** | **String**| This parameter is used for finding stories whose published at 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]
550
- **published_at_end** | **String**| This parameter is used for finding stories whose published at 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]
551
- **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional]
590
+ **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]
591
+ **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]
592
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. | [optional]
552
593
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
553
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional]
554
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional]
555
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional]
556
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional]
557
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional]
558
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional]
559
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional]
560
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional]
594
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. | [optional]
595
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. | [optional]
596
+ **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. | [optional]
597
+ **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. | [optional]
598
+ **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. | [optional]
599
+ **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. | [optional]
600
+ **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. | [optional]
601
+ **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. | [optional]
561
602
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
562
603
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
604
+ **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]
605
+ **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]
606
+ **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]
607
+ **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]
563
608
  **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
564
609
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
565
610
  **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
566
611
  **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
567
612
  **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
568
- **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. | [optional]
569
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional]
570
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional]
571
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional]
572
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional]
573
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional]
574
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional]
613
+ **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]
614
+ **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]
615
+ **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]
616
+ **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]
617
+ **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]
618
+ **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]
619
+ **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]
575
620
  **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
576
- **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. | [optional] [default to lingo]
621
+ **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. | [optional] [default to lingo]
577
622
  **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
578
- **sort_by** | **String**| This parameter is used for changing the order column of the result. | [optional] [default to published_at]
623
+ **sort_by** | **String**| This parameter is used for changing the order column of the results. | [optional] [default to published_at]
579
624
  **sort_direction** | **String**| This parameter is used for changing the order direction of the result. | [optional] [default to desc]
580
625
  **cursor** | **String**| This parameter is used for finding a specific page. | [optional] [default to *]
581
- **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 10]
626
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 10]
582
627
 
583
628
  ### Return type
584
629
 
@@ -606,7 +651,8 @@ This endpoint is used for getting time series by stories.
606
651
  ```ruby
607
652
  # load the gem
608
653
  require 'aylien_news_api'
609
- # setup authorization
654
+
655
+ # setup authorization
610
656
  AylienNewsApi.configure do |config|
611
657
  # Configure API key authorization: app_id
612
658
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
@@ -623,33 +669,37 @@ opts = {
623
669
  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).
624
670
  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).
625
671
  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.
626
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
672
+ categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries.
627
673
  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
628
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
629
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
630
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
631
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
632
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
633
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
634
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
635
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
674
+ categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id.
675
+ categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level.
676
+ 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.
677
+ 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.
678
+ 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.
679
+ 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.
680
+ 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.
681
+ 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.
636
682
  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
637
683
  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
684
+ 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.
685
+ 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.
686
+ 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.
687
+ 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.
638
688
  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
639
689
  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
640
690
  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
641
691
  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
642
692
  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
643
- 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.
644
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
645
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
646
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
647
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
648
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
649
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
650
- published_at_start: "NOW-7DAYS/DAY", # String | This parameter is used for finding stories whose published at 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).
651
- published_at_end: "NOW/DAY", # String | This parameter is used for finding stories whose published at 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).
652
- period: "+1DAY" # String | The size of each date range 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).
693
+ 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).
694
+ 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).
695
+ 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).
696
+ 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).
697
+ 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).
698
+ 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).
699
+ 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).
700
+ 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).
701
+ 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).
702
+ 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).
653
703
  }
654
704
 
655
705
  begin
@@ -670,33 +720,37 @@ Name | Type | Description | Notes
670
720
  **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]
671
721
  **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]
672
722
  **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]
673
- **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional]
723
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. | [optional]
674
724
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
675
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional]
676
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional]
677
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional]
678
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional]
679
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional]
680
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional]
681
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional]
682
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional]
725
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. | [optional]
726
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. | [optional]
727
+ **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. | [optional]
728
+ **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. | [optional]
729
+ **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. | [optional]
730
+ **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. | [optional]
731
+ **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. | [optional]
732
+ **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. | [optional]
683
733
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
684
734
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
735
+ **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]
736
+ **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]
737
+ **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]
738
+ **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]
685
739
  **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
686
740
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
687
741
  **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
688
742
  **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
689
743
  **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
690
- **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. | [optional]
691
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional]
692
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional]
693
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional]
694
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional]
695
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional]
696
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional]
697
- **published_at_start** | **String**| This parameter is used for finding stories whose published at 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] [default to NOW-7DAYS/DAY]
698
- **published_at_end** | **String**| This parameter is used for finding stories whose published at 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] [default to NOW/DAY]
699
- **period** | **String**| The size of each date range expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are &#x60;+&#x60; following an integer number greater than 0 and one of the Date Math keywords. e.g. &#x60;+1DAY&#x60;, &#x60;+2MINUTES&#x60; and &#x60;+1MONTH&#x60;. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to +1DAY]
744
+ **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]
745
+ **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]
746
+ **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]
747
+ **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]
748
+ **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]
749
+ **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]
750
+ **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]
751
+ **published_at_start** | **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] [default to NOW-7DAYS/DAY]
752
+ **published_at_end** | **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] [default to NOW/DAY]
753
+ **period** | **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 &#x60;+&#x60; following an integer number greater than 0 and one of the Date Math keywords. e.g. &#x60;+1DAY&#x60;, &#x60;+2MINUTES&#x60; and &#x60;+1MONTH&#x60;. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to +1DAY]
700
754
 
701
755
  ### Return type
702
756
 
@@ -718,13 +772,14 @@ Name | Type | Description | Notes
718
772
 
719
773
  List trends
720
774
 
721
- This endpoint is used for finding news trendings based on stories resource.
775
+ This endpoint is used for finding trends based on stories.
722
776
 
723
777
  ### Example
724
778
  ```ruby
725
779
  # load the gem
726
780
  require 'aylien_news_api'
727
- # setup authorization
781
+
782
+ # setup authorization
728
783
  AylienNewsApi.configure do |config|
729
784
  # Configure API key authorization: app_id
730
785
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
@@ -741,32 +796,36 @@ opts = {
741
796
  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).
742
797
  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).
743
798
  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.
744
- published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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).
745
- published_at_end: "published_at_end_example", # String | This parameter is used for finding stories whose published at 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).
746
- categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
799
+ 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).
800
+ 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).
801
+ categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries.
747
802
  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
748
- categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
749
- categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
750
- entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
751
- entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
752
- entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
753
- entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
754
- entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
755
- entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
803
+ categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories by categories id.
804
+ categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level.
805
+ 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.
806
+ 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.
807
+ 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.
808
+ 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.
809
+ 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.
810
+ 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.
756
811
  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
757
812
  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
813
+ 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.
814
+ 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.
815
+ 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.
816
+ 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.
758
817
  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
759
818
  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
760
819
  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
761
820
  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
762
821
  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
763
- 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.
764
- source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
765
- source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
766
- source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
767
- source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
768
- source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
769
- source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
822
+ 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).
823
+ 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).
824
+ 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).
825
+ 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).
826
+ 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).
827
+ 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).
828
+ 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).
770
829
  field: "field_example" # String | This parameter is used to specify the trend field.
771
830
  }
772
831
 
@@ -788,32 +847,36 @@ Name | Type | Description | Notes
788
847
  **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]
789
848
  **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]
790
849
  **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]
791
- **published_at_start** | **String**| This parameter is used for finding stories whose published at 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]
792
- **published_at_end** | **String**| This parameter is used for finding stories whose published at 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]
793
- **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional]
850
+ **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]
851
+ **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]
852
+ **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. | [optional]
794
853
  **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
795
- **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional]
796
- **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional]
797
- **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional]
798
- **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional]
799
- **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional]
800
- **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional]
801
- **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional]
802
- **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional]
854
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. | [optional]
855
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. | [optional]
856
+ **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. | [optional]
857
+ **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. | [optional]
858
+ **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. | [optional]
859
+ **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. | [optional]
860
+ **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. | [optional]
861
+ **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. | [optional]
803
862
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
804
863
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
864
+ **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]
865
+ **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]
866
+ **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]
867
+ **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]
805
868
  **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
806
869
  **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
807
870
  **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
808
871
  **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
809
872
  **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
810
- **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. | [optional]
811
- **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional]
812
- **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional]
813
- **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional]
814
- **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional]
815
- **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional]
816
- **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional]
873
+ **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]
874
+ **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]
875
+ **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]
876
+ **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]
877
+ **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]
878
+ **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]
879
+ **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]
817
880
  **field** | **String**| This parameter is used to specify the trend field. | [optional]
818
881
 
819
882
  ### Return type