aylien_news_api 3.0.0 → 4.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (152) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/aylien_news_api-4.3.0.gem +0 -0
  4. data/aylien_news_api.gemspec +1 -2
  5. data/docs/AggregatedSentiment.md +21 -0
  6. data/docs/Category.md +3 -1
  7. data/docs/CategoryTaxonomy.md +16 -0
  8. data/docs/DefaultApi.md +433 -51
  9. data/docs/Entity.md +11 -5
  10. data/docs/EntityLinks.md +6 -2
  11. data/docs/EntitySentiment.md +19 -0
  12. data/docs/EntitySurfaceForm.md +19 -0
  13. data/docs/ErrorLinks.md +3 -1
  14. data/docs/Histograms.md +5 -1
  15. data/docs/Logicals.md +21 -0
  16. data/docs/Media.md +2 -2
  17. data/docs/MediaFormat.md +16 -0
  18. data/docs/MediaType.md +16 -0
  19. data/docs/NestedEntity.md +33 -0
  20. data/docs/Parameter.md +127 -0
  21. data/docs/Query.md +31 -0
  22. data/docs/RelatedStories.md +5 -1
  23. data/docs/Scope.md +1 -1
  24. data/docs/ScopeLevel.md +16 -0
  25. data/docs/Sentiment.md +1 -1
  26. data/docs/SentimentPolarity.md +16 -0
  27. data/docs/Stories.md +7 -1
  28. data/docs/Story.md +3 -1
  29. data/docs/StoryLinks.md +3 -3
  30. data/docs/StoryTranslation.md +19 -0
  31. data/docs/StoryTranslations.md +1 -1
  32. data/docs/TimeSeries.md +3 -1
  33. data/docs/Trend.md +3 -1
  34. data/docs/Trends.md +5 -1
  35. data/docs/Warning.md +21 -0
  36. data/lib/aylien_news_api.rb +15 -3
  37. data/lib/aylien_news_api/api/default_api.rb +749 -160
  38. data/lib/aylien_news_api/api_client.rb +8 -6
  39. data/lib/aylien_news_api/api_error.rb +1 -1
  40. data/lib/aylien_news_api/configuration.rb +2 -2
  41. data/lib/aylien_news_api/models/aggregated_sentiment.rb +228 -0
  42. data/lib/aylien_news_api/models/author.rb +12 -2
  43. data/lib/aylien_news_api/models/autocomplete.rb +12 -2
  44. data/lib/aylien_news_api/models/autocompletes.rb +12 -2
  45. data/lib/aylien_news_api/models/category.rb +24 -39
  46. data/lib/aylien_news_api/models/category_links.rb +12 -2
  47. data/lib/aylien_news_api/models/category_taxonomy.rb +36 -0
  48. data/lib/aylien_news_api/models/cluster.rb +12 -2
  49. data/lib/aylien_news_api/models/clusters.rb +12 -2
  50. data/lib/aylien_news_api/models/coverages.rb +12 -2
  51. data/lib/aylien_news_api/models/entities.rb +12 -2
  52. data/lib/aylien_news_api/models/entity.rb +57 -41
  53. data/lib/aylien_news_api/models/entity_links.rb +37 -7
  54. data/lib/aylien_news_api/models/entity_sentiment.rb +240 -0
  55. data/lib/aylien_news_api/models/entity_surface_form.rb +219 -0
  56. data/lib/aylien_news_api/models/error.rb +12 -2
  57. data/lib/aylien_news_api/models/error_links.rb +25 -6
  58. data/lib/aylien_news_api/models/errors.rb +12 -2
  59. data/lib/aylien_news_api/models/histogram_interval.rb +12 -2
  60. data/lib/aylien_news_api/models/histograms.rb +36 -6
  61. data/lib/aylien_news_api/models/location.rb +12 -2
  62. data/lib/aylien_news_api/models/logicals.rb +230 -0
  63. data/lib/aylien_news_api/models/media.rb +14 -52
  64. data/lib/aylien_news_api/models/media_format.rb +44 -0
  65. data/lib/aylien_news_api/models/media_type.rb +36 -0
  66. data/lib/aylien_news_api/models/nested_entity.rb +278 -0
  67. data/lib/aylien_news_api/models/parameter.rb +701 -0
  68. data/lib/aylien_news_api/models/query.rb +271 -0
  69. data/lib/aylien_news_api/models/rank.rb +12 -2
  70. data/lib/aylien_news_api/models/rankings.rb +12 -2
  71. data/lib/aylien_news_api/models/related_stories.rb +36 -6
  72. data/lib/aylien_news_api/models/representative_story.rb +12 -2
  73. data/lib/aylien_news_api/models/scope.rb +13 -38
  74. data/lib/aylien_news_api/models/scope_level.rb +37 -0
  75. data/lib/aylien_news_api/models/sentiment.rb +13 -38
  76. data/lib/aylien_news_api/models/sentiment_polarity.rb +37 -0
  77. data/lib/aylien_news_api/models/sentiments.rb +12 -2
  78. data/lib/aylien_news_api/models/share_count.rb +12 -2
  79. data/lib/aylien_news_api/models/share_counts.rb +12 -2
  80. data/lib/aylien_news_api/models/source.rb +12 -2
  81. data/lib/aylien_news_api/models/stories.rb +48 -6
  82. data/lib/aylien_news_api/models/story.rb +26 -6
  83. data/lib/aylien_news_api/models/story_cluster.rb +12 -2
  84. data/lib/aylien_news_api/models/story_links.rb +26 -16
  85. data/lib/aylien_news_api/models/story_translation.rb +217 -0
  86. data/lib/aylien_news_api/models/story_translations.rb +13 -3
  87. data/lib/aylien_news_api/models/story_translations_en.rb +12 -2
  88. data/lib/aylien_news_api/models/summary.rb +12 -2
  89. data/lib/aylien_news_api/models/time_series.rb +25 -6
  90. data/lib/aylien_news_api/models/time_series_list.rb +12 -2
  91. data/lib/aylien_news_api/models/trend.rb +25 -6
  92. data/lib/aylien_news_api/models/trends.rb +36 -6
  93. data/lib/aylien_news_api/models/warning.rb +226 -0
  94. data/lib/aylien_news_api/version.rb +2 -2
  95. data/spec/api/default_api_spec.rb +73 -28
  96. data/spec/api_client_spec.rb +3 -3
  97. data/spec/configuration_spec.rb +2 -2
  98. data/spec/models/aggregated_sentiment_spec.rb +53 -0
  99. data/spec/models/author_spec.rb +2 -2
  100. data/spec/models/autocomplete_spec.rb +2 -2
  101. data/spec/models/autocompletes_spec.rb +2 -2
  102. data/spec/models/category_links_spec.rb +2 -2
  103. data/spec/models/category_spec.rb +8 -6
  104. data/spec/models/category_taxonomy_spec.rb +35 -0
  105. data/spec/models/cluster_spec.rb +2 -2
  106. data/spec/models/clusters_spec.rb +2 -2
  107. data/spec/models/coverages_spec.rb +2 -2
  108. data/spec/models/entities_spec.rb +2 -2
  109. data/spec/models/entity_links_spec.rb +8 -2
  110. data/spec/models/entity_sentiment_spec.rb +47 -0
  111. data/spec/models/entity_spec.rb +10 -4
  112. data/spec/models/entity_surface_form_spec.rb +47 -0
  113. data/spec/models/error_links_spec.rb +8 -2
  114. data/spec/models/error_spec.rb +2 -2
  115. data/spec/models/errors_spec.rb +2 -2
  116. data/spec/models/histogram_interval_spec.rb +2 -2
  117. data/spec/models/histograms_spec.rb +14 -2
  118. data/spec/models/location_spec.rb +2 -2
  119. data/spec/models/logicals_spec.rb +53 -0
  120. data/spec/models/media_format_spec.rb +35 -0
  121. data/spec/models/media_spec.rb +2 -10
  122. data/spec/models/media_type_spec.rb +35 -0
  123. data/spec/models/nested_entity_spec.rb +71 -0
  124. data/spec/models/parameter_spec.rb +371 -0
  125. data/spec/models/query_spec.rb +83 -0
  126. data/spec/models/rank_spec.rb +2 -2
  127. data/spec/models/rankings_spec.rb +2 -2
  128. data/spec/models/related_stories_spec.rb +14 -2
  129. data/spec/models/representative_story_spec.rb +2 -2
  130. data/spec/models/scope_level_spec.rb +35 -0
  131. data/spec/models/scope_spec.rb +2 -6
  132. data/spec/models/sentiment_polarity_spec.rb +35 -0
  133. data/spec/models/sentiment_spec.rb +2 -6
  134. data/spec/models/sentiments_spec.rb +2 -2
  135. data/spec/models/share_count_spec.rb +2 -2
  136. data/spec/models/share_counts_spec.rb +2 -2
  137. data/spec/models/source_spec.rb +2 -2
  138. data/spec/models/stories_spec.rb +20 -2
  139. data/spec/models/story_cluster_spec.rb +2 -2
  140. data/spec/models/story_links_spec.rb +5 -5
  141. data/spec/models/story_spec.rb +2 -2
  142. data/spec/models/story_translation_spec.rb +47 -0
  143. data/spec/models/story_translations_en_spec.rb +2 -2
  144. data/spec/models/story_translations_spec.rb +2 -2
  145. data/spec/models/summary_spec.rb +2 -2
  146. data/spec/models/time_series_list_spec.rb +2 -2
  147. data/spec/models/time_series_spec.rb +2 -2
  148. data/spec/models/trend_spec.rb +2 -2
  149. data/spec/models/trends_spec.rb +14 -2
  150. data/spec/models/warning_spec.rb +53 -0
  151. data/spec/spec_helper.rb +2 -2
  152. metadata +60 -23
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b86de43ffb6dfbd47a63091e4f8409a0a38ba03ff3cdb3f7723115f32807924d
4
- data.tar.gz: ffd457acccc7b01063d84c1856f813e391354edff0035dd15e9fff3ec3f227ab
3
+ metadata.gz: ca92c584c721c883e68363567bb58be8b88508a3dba08524891045ed216a98eb
4
+ data.tar.gz: 6037824cea9a92772db69abcd67ac26dff51a193aceb49ad9897aaae855e3e8b
5
5
  SHA512:
6
- metadata.gz: 90a3735c95c3368bf6f91d884eacd662cb15fc378fb56d1edd6394d02ac1a4149b89e1c34ce91ec03ec3a451d805b27833ff0a67744756aaccdc2eb38c0da6c6
7
- data.tar.gz: 5f6172eb9086d78731d7d58830d6ce48a84c7be42b4d082f75f0b524ac17207adb0f258f45220a1501646b649ddc8d29e611705ee55189c1958ae76208bc875b
6
+ metadata.gz: 48bcbf0f0244cad7adb639384e8829e40b866a96fad5805b131f1ae9ffc189e9c97f7faa1bfe014fd952108b81dccb93fbd1d6162da2d4bcc1a95333080b9af7
7
+ data.tar.gz: 05a5e14a00783c24907e699d389ea1d781c2a38950789c11aac98bb7fa4bfabb561d54f765f057ab794a29665801a0ac6016597f3564dfcb1726193c97ee7a37
data/Gemfile CHANGED
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '~> 12.0.0'
6
+ gem 'rake', '~> 13.0.1'
7
7
  gem 'pry-byebug'
8
8
  gem 'rubocop', '~> 0.66.0'
9
9
  end
Binary file
@@ -8,7 +8,7 @@
8
8
  The version of the OpenAPI document: 3.0
9
9
  Contact: support@aylien.com
10
10
  Generated by: https://openapi-generator.tech
11
- OpenAPI Generator version: 4.1.3-SNAPSHOT
11
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
12
12
 
13
13
  =end
14
14
 
@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
28
28
  s.required_ruby_version = ">= 1.9"
29
29
 
30
30
  s.add_runtime_dependency 'faraday', '>= 0.14.0'
31
- s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
31
 
33
32
  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
34
33
 
@@ -0,0 +1,21 @@
1
+ # AylienNewsApi::AggregatedSentiment
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **positive** | **Integer** | Positive sentiments count | [optional]
8
+ **neutral** | **Integer** | Neutral sentiments count | [optional]
9
+ **negative** | **Integer** | Negative sentiments count | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'AylienNewsApi'
15
+
16
+ instance = AylienNewsApi::AggregatedSentiment.new(positive: null,
17
+ neutral: null,
18
+ negative: null)
19
+ ```
20
+
21
+
@@ -6,10 +6,11 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **confident** | **Boolean** | It defines whether the extracted category is confident or not | [optional]
8
8
  **id** | **String** | The ID of the category | [optional]
9
+ **label** | **String** | The label of the category | [optional]
9
10
  **level** | **Integer** | The level of the category | [optional]
10
11
  **links** | [**CategoryLinks**](CategoryLinks.md) | | [optional]
11
12
  **score** | **Float** | The score of the category | [optional]
12
- **taxonomy** | **String** | The taxonomy of the category | [optional]
13
+ **taxonomy** | [**CategoryTaxonomy**](CategoryTaxonomy.md) | | [optional]
13
14
 
14
15
  ## Code Sample
15
16
 
@@ -18,6 +19,7 @@ require 'AylienNewsApi'
18
19
 
19
20
  instance = AylienNewsApi::Category.new(confident: null,
20
21
  id: null,
22
+ label: null,
21
23
  level: null,
22
24
  links: null,
23
25
  score: null,
@@ -0,0 +1,16 @@
1
+ # AylienNewsApi::CategoryTaxonomy
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'AylienNewsApi'
12
+
13
+ instance = AylienNewsApi::CategoryTaxonomy.new()
14
+ ```
15
+
16
+
@@ -4,17 +4,93 @@ All URIs are relative to *https://api.aylien.com/news*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**advanced_list_stories**](DefaultApi.md#advanced_list_stories) | **POST** /stories | List Stories
7
8
  [**list_autocompletes**](DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
8
9
  [**list_clusters**](DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
9
- [**list_coverages**](DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
10
10
  [**list_histograms**](DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
11
- [**list_related_stories**](DefaultApi.md#list_related_stories) | **GET** /related_stories | List related stories
11
+ [**list_related_stories_get**](DefaultApi.md#list_related_stories_get) | **GET** /related_stories |
12
+ [**list_related_stories_post**](DefaultApi.md#list_related_stories_post) | **POST** /related_stories |
12
13
  [**list_stories**](DefaultApi.md#list_stories) | **GET** /stories | List Stories
13
14
  [**list_time_series**](DefaultApi.md#list_time_series) | **GET** /time_series | List time series
14
15
  [**list_trends**](DefaultApi.md#list_trends) | **GET** /trends | List trends
15
16
 
16
17
 
17
18
 
19
+ ## advanced_list_stories
20
+
21
+ > Stories advanced_list_stories(unknown_base_type, opts)
22
+
23
+ List Stories
24
+
25
+ The stories endpoint is used to return stories based on the json query you set in your request body. The News API crawler gathers articles in near real-time and stores information about them, or metadata. Below you can see all of the query parameters, and JSON schema for the body, which you can use to narrow down your query.
26
+
27
+ ### Example
28
+
29
+ ```ruby
30
+ # load the gem
31
+ require 'aylien_news_api'
32
+ # setup authorization
33
+ AylienNewsApi.configure do |config|
34
+ # Configure API key authorization: app_id
35
+ config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
36
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
37
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
38
+
39
+ # Configure API key authorization: app_key
40
+ config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
41
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
42
+ #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
43
+ end
44
+
45
+ api_instance = AylienNewsApi::DefaultApi.new
46
+ unknown_base_type = {"$and":[{"$or":[{"body":{"$text":"Tim Cook"}},{"social.shares.count.reddit.max":{"$gte":5000,"$boost":5}}]},{"entity":{"$and":[{"name":{"$text":"Apple","$boost":2}},{"$not":[{"type":{"$eq":"Fruit"}}]}]}}]} # UNKNOWN_BASE_TYPE | /stories body schema to perform an advanced search with logical operators and nested objects.
47
+ opts = {
48
+ 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).
49
+ 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).
50
+ _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
51
+ sort_by: 'published_at', # String | This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
52
+ sort_direction: 'desc', # String | This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
53
+ cursor: '*', # String | This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
54
+ per_page: 10 # Integer | This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results)
55
+ }
56
+
57
+ begin
58
+ #List Stories
59
+ result = api_instance.advanced_list_stories(unknown_base_type, opts)
60
+ p result
61
+ rescue AylienNewsApi::ApiError => e
62
+ puts "Exception when calling DefaultApi->advanced_list_stories: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+
69
+ Name | Type | Description | Notes
70
+ ------------- | ------------- | ------------- | -------------
71
+ **unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md)| /stories body schema to perform an advanced search with logical operators and nested objects. |
72
+ **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]
73
+ **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]
74
+ **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
75
+ **sort_by** | **String**| This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to &#39;published_at&#39;]
76
+ **sort_direction** | **String**| This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to &#39;desc&#39;]
77
+ **cursor** | **String**| This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results). | [optional] [default to &#39;*&#39;]
78
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results) | [optional] [default to 10]
79
+
80
+ ### Return type
81
+
82
+ [**Stories**](Stories.md)
83
+
84
+ ### Authorization
85
+
86
+ [app_id](../README.md#app_id), [app_key](../README.md#app_key)
87
+
88
+ ### HTTP request headers
89
+
90
+ - **Content-Type**: application/json
91
+ - **Accept**: application/json, text/xml
92
+
93
+
18
94
  ## list_autocompletes
19
95
 
20
96
  > Autocompletes list_autocompletes(type, term, opts)
@@ -121,7 +197,12 @@ opts = {
121
197
  latest_story_start: 'latest_story_start_example', # String | This parameter is used for finding clusters whose publication date of its latest story 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).
122
198
  latest_story_end: 'latest_story_end_example', # String | This parameter is used for finding clusters whose publication date of its latest story 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).
123
199
  location_country: ['location_country_example'], # Array<String> | This parameter is used for finding clusters belonging to a specific country. 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).
124
- not_location_country: ['location_country_example'] # Array<String> | This parameter is used for excluding clusters belonging to a specific country. 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).
200
+ not_location_country: ['location_country_example'], # Array<String> | This parameter is used for excluding clusters belonging to a specific country. 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).
201
+ _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
202
+ sort_by: 'published_at', # String | This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
203
+ sort_direction: 'desc', # String | This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
204
+ cursor: '*', # String | This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
205
+ per_page: 10 # Integer | This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results)
125
206
  }
126
207
 
127
208
  begin
@@ -150,6 +231,11 @@ Name | Type | Description | Notes
150
231
  **latest_story_end** | **String**| This parameter is used for finding clusters whose publication date of its latest story 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]
151
232
  **location_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding clusters belonging to a specific country. 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]
152
233
  **not_location_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding clusters belonging to a specific country. 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]
234
+ **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
235
+ **sort_by** | **String**| This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to &#39;published_at&#39;]
236
+ **sort_direction** | **String**| This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to &#39;desc&#39;]
237
+ **cursor** | **String**| This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results). | [optional] [default to &#39;*&#39;]
238
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results) | [optional] [default to 10]
153
239
 
154
240
  ### Return type
155
241
 
@@ -165,13 +251,13 @@ Name | Type | Description | Notes
165
251
  - **Accept**: application/json, text/xml
166
252
 
167
253
 
168
- ## list_coverages
254
+ ## list_histograms
169
255
 
170
- > Coverages list_coverages(opts)
256
+ > Histograms list_histograms(opts)
171
257
 
172
- List coverages
258
+ List histograms
173
259
 
174
- The coverages endpoint allows you to understand the reach a document has had. For example, you can track the coverage of a press release or a Tweet based on how many times it has been mentioned in stories.
260
+ For the numerical metadata that the News API gathers (such as word counts or social shares for example), you can use the histograms endpoint to access and display this information. As this endpoint does not return actual stories, the results you are given will not count towards your story allowance provided by your subscription, so you can effectively query this endpoint free of charge.
175
261
 
176
262
  ### Example
177
263
 
@@ -201,6 +287,8 @@ opts = {
201
287
  translations_en_title: 'translations_en_title_example', # String | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
202
288
  translations_en_body: 'translations_en_body_example', # String | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
203
289
  translations_en_text: 'translations_en_text_example', # String | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
290
+ links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
291
+ not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
204
292
  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.
205
293
  not_language: ['language_example'], # Array<String> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
206
294
  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).
@@ -209,20 +297,42 @@ opts = {
209
297
  categories_confident: true, # Boolean | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
210
298
  categories_id: ['categories_id_example'], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
211
299
  not_categories_id: ['categories_id_example'], # Array<String> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
300
+ categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
301
+ not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
212
302
  categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
213
303
  not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
304
+ entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
305
+ not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
306
+ entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
307
+ not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
214
308
  entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
215
309
  not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
216
310
  entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
217
311
  not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
312
+ entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
313
+ not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
218
314
  entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
219
315
  not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
316
+ entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
317
+ not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
318
+ entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
319
+ not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
320
+ entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
321
+ not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
322
+ entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
323
+ not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
220
324
  entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
221
325
  not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
222
326
  entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
223
327
  not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
328
+ entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
329
+ not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
224
330
  entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
225
331
  not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
332
+ entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
333
+ not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
334
+ entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
335
+ not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
226
336
  sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
227
337
  not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
228
338
  sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
@@ -277,22 +387,19 @@ opts = {
277
387
  social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
278
388
  social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
279
389
  clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
280
- _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
281
- story_id: 56, # Integer | A story id
282
- story_url: 'story_url_example', # String | An article or webpage
283
- story_title: 'story_title_example', # String | Title of the article
284
- story_body: 'story_body_example', # String | Body of the article
285
- 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).
286
- 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.
287
- per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
390
+ query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
391
+ interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
392
+ interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
393
+ interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
394
+ field: 'social_shares_count' # String | This parameter is used for specifying the y-axis variable for the histogram.
288
395
  }
289
396
 
290
397
  begin
291
- #List coverages
292
- result = api_instance.list_coverages(opts)
398
+ #List histograms
399
+ result = api_instance.list_histograms(opts)
293
400
  p result
294
401
  rescue AylienNewsApi::ApiError => e
295
- puts "Exception when calling DefaultApi->list_coverages: #{e}"
402
+ puts "Exception when calling DefaultApi->list_histograms: #{e}"
296
403
  end
297
404
  ```
298
405
 
@@ -309,6 +416,8 @@ Name | Type | Description | Notes
309
416
  **translations_en_title** | **String**| This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
310
417
  **translations_en_body** | **String**| This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
311
418
  **translations_en_text** | **String**| This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
419
+ **links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on their url. | [optional]
420
+ **not_links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
312
421
  **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]
313
422
  **not_language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
314
423
  **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]
@@ -317,20 +426,42 @@ Name | Type | Description | Notes
317
426
  **categories_confident** | **Boolean**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
318
427
  **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
319
428
  **not_categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
429
+ **categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
430
+ **not_categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
320
431
  **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
321
432
  **not_categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
433
+ **entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
434
+ **not_entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
435
+ **entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
436
+ **not_entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
322
437
  **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
323
438
  **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
324
439
  **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
325
440
  **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
441
+ **entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
442
+ **not_entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
326
443
  **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
327
444
  **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
445
+ **entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
446
+ **not_entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
447
+ **entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
448
+ **not_entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
449
+ **entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
450
+ **not_entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
451
+ **entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
452
+ **not_entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
328
453
  **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
329
454
  **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
330
455
  **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
331
456
  **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
457
+ **entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
458
+ **not_entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
332
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. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
333
460
  **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
461
+ **entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
462
+ **not_entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
463
+ **entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
464
+ **not_entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
334
465
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
335
466
  **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
336
467
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
@@ -385,18 +516,15 @@ Name | Type | Description | Notes
385
516
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
386
517
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
387
518
  **clusters** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
388
- **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
389
- **story_id** | **Integer**| A story id | [optional]
390
- **story_url** | **String**| An article or webpage | [optional]
391
- **story_title** | **String**| Title of the article | [optional]
392
- **story_body** | **String**| Body of the article | [optional]
393
- **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]
394
- **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 &#39;auto&#39;]
395
- **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
519
+ **query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
520
+ **interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
521
+ **interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
522
+ **interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
523
+ **field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to &#39;social_shares_count&#39;]
396
524
 
397
525
  ### Return type
398
526
 
399
- [**Coverages**](Coverages.md)
527
+ [**Histograms**](Histograms.md)
400
528
 
401
529
  ### Authorization
402
530
 
@@ -408,13 +536,11 @@ Name | Type | Description | Notes
408
536
  - **Accept**: application/json, text/xml
409
537
 
410
538
 
411
- ## list_histograms
539
+ ## list_related_stories_get
412
540
 
413
- > Histograms list_histograms(opts)
541
+ > RelatedStories list_related_stories_get(opts)
414
542
 
415
- List histograms
416
543
 
417
- For the numerical metadata that the News API gathers (such as word counts or social shares for example), you can use the histograms endpoint to access and display this information. As this endpoint does not return actual stories, the results you are given will not count towards your story allowance provided by your subscription, so you can effectively query this endpoint free of charge.
418
544
 
419
545
  ### Example
420
546
 
@@ -444,6 +570,8 @@ opts = {
444
570
  translations_en_title: 'translations_en_title_example', # String | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
445
571
  translations_en_body: 'translations_en_body_example', # String | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
446
572
  translations_en_text: 'translations_en_text_example', # String | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
573
+ links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
574
+ not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
447
575
  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.
448
576
  not_language: ['language_example'], # Array<String> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
449
577
  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).
@@ -452,20 +580,42 @@ opts = {
452
580
  categories_confident: true, # Boolean | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
453
581
  categories_id: ['categories_id_example'], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
454
582
  not_categories_id: ['categories_id_example'], # Array<String> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
583
+ categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
584
+ not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
455
585
  categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
456
586
  not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
587
+ entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
588
+ not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
589
+ entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
590
+ not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
457
591
  entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
458
592
  not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
459
593
  entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
460
594
  not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
595
+ entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
596
+ not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
461
597
  entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
462
598
  not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
599
+ entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
600
+ not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
601
+ entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
602
+ not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
603
+ entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
604
+ not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
605
+ entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
606
+ not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
463
607
  entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
464
608
  not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
465
609
  entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
466
610
  not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
611
+ entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
612
+ not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
467
613
  entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
468
614
  not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
615
+ entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
616
+ not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
617
+ entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
618
+ not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
469
619
  sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
470
620
  not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
471
621
  sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
@@ -519,18 +669,23 @@ opts = {
519
669
  social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
520
670
  social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
521
671
  social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
522
- interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
523
- interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
524
- interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
525
- field: 'social_shares_count' # String | This parameter is used for specifying the y-axis variable for the histogram.
672
+ clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
673
+ _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
674
+ story_id: 56, # Integer | A story id
675
+ story_url: 'story_url_example', # String | An article or webpage
676
+ story_title: 'story_title_example', # String | Title of the article
677
+ story_body: 'story_body_example', # String | Body of the article
678
+ query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
679
+ boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
680
+ 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.
681
+ per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
526
682
  }
527
683
 
528
684
  begin
529
- #List histograms
530
- result = api_instance.list_histograms(opts)
685
+ result = api_instance.list_related_stories_get(opts)
531
686
  p result
532
687
  rescue AylienNewsApi::ApiError => e
533
- puts "Exception when calling DefaultApi->list_histograms: #{e}"
688
+ puts "Exception when calling DefaultApi->list_related_stories_get: #{e}"
534
689
  end
535
690
  ```
536
691
 
@@ -547,6 +702,8 @@ Name | Type | Description | Notes
547
702
  **translations_en_title** | **String**| This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
548
703
  **translations_en_body** | **String**| This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
549
704
  **translations_en_text** | **String**| This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
705
+ **links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on their url. | [optional]
706
+ **not_links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
550
707
  **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]
551
708
  **not_language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
552
709
  **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]
@@ -555,20 +712,42 @@ Name | Type | Description | Notes
555
712
  **categories_confident** | **Boolean**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
556
713
  **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
557
714
  **not_categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
715
+ **categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
716
+ **not_categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
558
717
  **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
559
718
  **not_categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
719
+ **entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
720
+ **not_entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
721
+ **entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
722
+ **not_entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
560
723
  **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
561
724
  **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
562
725
  **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
563
726
  **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
727
+ **entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
728
+ **not_entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
564
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. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
565
730
  **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
731
+ **entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
732
+ **not_entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
733
+ **entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
734
+ **not_entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
735
+ **entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
736
+ **not_entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
737
+ **entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
738
+ **not_entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
566
739
  **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
567
740
  **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
568
741
  **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
569
742
  **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
743
+ **entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
744
+ **not_entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
570
745
  **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
571
746
  **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
747
+ **entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
748
+ **not_entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
749
+ **entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
750
+ **not_entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
572
751
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
573
752
  **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
574
753
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
@@ -622,14 +801,20 @@ Name | Type | Description | Notes
622
801
  **social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
623
802
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
624
803
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
625
- **interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
626
- **interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
627
- **interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
628
- **field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to &#39;social_shares_count&#39;]
804
+ **clusters** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
805
+ **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
806
+ **story_id** | **Integer**| A story id | [optional]
807
+ **story_url** | **String**| An article or webpage | [optional]
808
+ **story_title** | **String**| Title of the article | [optional]
809
+ **story_body** | **String**| Body of the article | [optional]
810
+ **query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
811
+ **boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
812
+ **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 &#39;auto&#39;]
813
+ **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
629
814
 
630
815
  ### Return type
631
816
 
632
- [**Histograms**](Histograms.md)
817
+ [**RelatedStories**](RelatedStories.md)
633
818
 
634
819
  ### Authorization
635
820
 
@@ -641,13 +826,11 @@ Name | Type | Description | Notes
641
826
  - **Accept**: application/json, text/xml
642
827
 
643
828
 
644
- ## list_related_stories
829
+ ## list_related_stories_post
645
830
 
646
- > RelatedStories list_related_stories(opts)
831
+ > RelatedStories list_related_stories_post(opts)
647
832
 
648
- List related stories
649
833
 
650
- This endpoint is used for finding semantically similar stories based on the parameters you provide as inputs. For example, if you want to find stories similar to a Tweet or any text extract you input, the related stories endpoint will analyze the entities present and the meaning of the text, and find stories with a similar meaning. The maximum number of related stories returned is 100.
651
834
 
652
835
  ### Example
653
836
 
@@ -677,6 +860,8 @@ opts = {
677
860
  translations_en_title: 'translations_en_title_example', # String | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
678
861
  translations_en_body: 'translations_en_body_example', # String | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
679
862
  translations_en_text: 'translations_en_text_example', # String | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
863
+ links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
864
+ not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
680
865
  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.
681
866
  not_language: ['language_example'], # Array<String> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
682
867
  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).
@@ -685,20 +870,42 @@ opts = {
685
870
  categories_confident: true, # Boolean | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
686
871
  categories_id: ['categories_id_example'], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
687
872
  not_categories_id: ['categories_id_example'], # Array<String> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
873
+ categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
874
+ not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
688
875
  categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
689
876
  not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
877
+ entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
878
+ not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
879
+ entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
880
+ not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
690
881
  entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
691
882
  not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
692
883
  entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
693
884
  not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
885
+ entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
886
+ not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
694
887
  entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
695
888
  not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
889
+ entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
890
+ not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
891
+ entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
892
+ not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
893
+ entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
894
+ not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
895
+ entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
896
+ not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
696
897
  entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
697
898
  not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
698
899
  entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
699
900
  not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
901
+ entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
902
+ not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
700
903
  entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
701
904
  not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
905
+ entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
906
+ not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
907
+ entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
908
+ not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
702
909
  sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
703
910
  not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
704
911
  sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
@@ -758,17 +965,17 @@ opts = {
758
965
  story_url: 'story_url_example', # String | An article or webpage
759
966
  story_title: 'story_title_example', # String | Title of the article
760
967
  story_body: 'story_body_example', # String | Body of the article
968
+ query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
761
969
  boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
762
970
  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.
763
971
  per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
764
972
  }
765
973
 
766
974
  begin
767
- #List related stories
768
- result = api_instance.list_related_stories(opts)
975
+ result = api_instance.list_related_stories_post(opts)
769
976
  p result
770
977
  rescue AylienNewsApi::ApiError => e
771
- puts "Exception when calling DefaultApi->list_related_stories: #{e}"
978
+ puts "Exception when calling DefaultApi->list_related_stories_post: #{e}"
772
979
  end
773
980
  ```
774
981
 
@@ -785,6 +992,8 @@ Name | Type | Description | Notes
785
992
  **translations_en_title** | **String**| This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
786
993
  **translations_en_body** | **String**| This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
787
994
  **translations_en_text** | **String**| This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
995
+ **links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on their url. | [optional]
996
+ **not_links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
788
997
  **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]
789
998
  **not_language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
790
999
  **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]
@@ -793,20 +1002,42 @@ Name | Type | Description | Notes
793
1002
  **categories_confident** | **Boolean**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
794
1003
  **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
795
1004
  **not_categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1005
+ **categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1006
+ **not_categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
796
1007
  **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
797
1008
  **not_categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1009
+ **entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1010
+ **not_entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1011
+ **entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1012
+ **not_entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
798
1013
  **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
799
1014
  **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
800
1015
  **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
801
1016
  **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1017
+ **entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1018
+ **not_entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
802
1019
  **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
803
1020
  **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1021
+ **entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1022
+ **not_entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1023
+ **entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1024
+ **not_entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1025
+ **entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1026
+ **not_entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1027
+ **entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1028
+ **not_entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
804
1029
  **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
805
1030
  **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
806
1031
  **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
807
1032
  **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1033
+ **entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1034
+ **not_entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
808
1035
  **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
809
1036
  **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1037
+ **entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1038
+ **not_entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1039
+ **entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1040
+ **not_entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
810
1041
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
811
1042
  **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
812
1043
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
@@ -866,6 +1097,7 @@ Name | Type | Description | Notes
866
1097
  **story_url** | **String**| An article or webpage | [optional]
867
1098
  **story_title** | **String**| Title of the article | [optional]
868
1099
  **story_body** | **String**| Body of the article | [optional]
1100
+ **query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
869
1101
  **boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
870
1102
  **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 &#39;auto&#39;]
871
1103
  **per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
@@ -922,26 +1154,50 @@ opts = {
922
1154
  translations_en_text: 'translations_en_text_example', # String | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
923
1155
  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.
924
1156
  not_language: ['language_example'], # Array<String> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
1157
+ links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
1158
+ not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
925
1159
  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).
926
1160
  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).
927
1161
  categories_taxonomy: 'categories_taxonomy_example', # String | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
928
1162
  categories_confident: true, # Boolean | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
929
1163
  categories_id: ['categories_id_example'], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
930
1164
  not_categories_id: ['categories_id_example'], # Array<String> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1165
+ categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1166
+ not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
931
1167
  categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
932
1168
  not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1169
+ entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1170
+ not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1171
+ entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1172
+ not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
933
1173
  entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
934
1174
  not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
935
1175
  entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
936
1176
  not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1177
+ entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1178
+ not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
937
1179
  entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
938
1180
  not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1181
+ entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1182
+ not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1183
+ entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1184
+ not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1185
+ entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1186
+ not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1187
+ entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1188
+ not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
939
1189
  entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
940
1190
  not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
941
1191
  entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
942
1192
  not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1193
+ entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1194
+ not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
943
1195
  entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
944
1196
  not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1197
+ entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1198
+ not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1199
+ entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1200
+ not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
945
1201
  sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
946
1202
  not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
947
1203
  sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
@@ -997,6 +1253,7 @@ opts = {
997
1253
  social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
998
1254
  clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
999
1255
  _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
1256
+ query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
1000
1257
  sort_by: 'published_at', # String | This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
1001
1258
  sort_direction: 'desc', # String | This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
1002
1259
  cursor: '*', # String | This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
@@ -1027,26 +1284,50 @@ Name | Type | Description | Notes
1027
1284
  **translations_en_text** | **String**| This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1028
1285
  **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]
1029
1286
  **not_language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
1287
+ **links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on their url. | [optional]
1288
+ **not_links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
1030
1289
  **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]
1031
1290
  **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]
1032
1291
  **categories_taxonomy** | **String**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1033
1292
  **categories_confident** | **Boolean**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
1034
1293
  **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1035
1294
  **not_categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1295
+ **categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1296
+ **not_categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1036
1297
  **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1037
1298
  **not_categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1299
+ **entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1300
+ **not_entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1301
+ **entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1302
+ **not_entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1038
1303
  **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1039
1304
  **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1040
1305
  **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1041
1306
  **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1307
+ **entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1308
+ **not_entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1042
1309
  **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1043
1310
  **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1311
+ **entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1312
+ **not_entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1313
+ **entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1314
+ **not_entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1315
+ **entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1316
+ **not_entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1317
+ **entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1318
+ **not_entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1044
1319
  **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1045
1320
  **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1046
1321
  **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1047
1322
  **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1323
+ **entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1324
+ **not_entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1048
1325
  **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1049
1326
  **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1327
+ **entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1328
+ **not_entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1329
+ **entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1330
+ **not_entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1050
1331
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
1051
1332
  **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
1052
1333
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
@@ -1102,6 +1383,7 @@ Name | Type | Description | Notes
1102
1383
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
1103
1384
  **clusters** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
1104
1385
  **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional]
1386
+ **query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
1105
1387
  **sort_by** | **String**| This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to &#39;published_at&#39;]
1106
1388
  **sort_direction** | **String**| This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to &#39;desc&#39;]
1107
1389
  **cursor** | **String**| This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results). | [optional] [default to &#39;*&#39;]
@@ -1163,20 +1445,42 @@ opts = {
1163
1445
  categories_confident: true, # Boolean | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1164
1446
  categories_id: ['categories_id_example'], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1165
1447
  not_categories_id: ['categories_id_example'], # Array<String> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1448
+ categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1449
+ not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1166
1450
  categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1167
1451
  not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1452
+ entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1453
+ not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1454
+ entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1455
+ not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1168
1456
  entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1169
1457
  not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1170
1458
  entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1171
1459
  not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1460
+ entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1461
+ not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1172
1462
  entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1173
1463
  not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1464
+ entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1465
+ not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1466
+ entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1467
+ not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1468
+ entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1469
+ not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1470
+ entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1471
+ not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1174
1472
  entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1175
1473
  not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1176
1474
  entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1177
1475
  not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1476
+ entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1477
+ not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1178
1478
  entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1179
1479
  not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1480
+ entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1481
+ not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1482
+ entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1483
+ not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1180
1484
  sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
1181
1485
  not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
1182
1486
  sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
@@ -1230,6 +1534,8 @@ opts = {
1230
1534
  social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
1231
1535
  social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
1232
1536
  social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
1537
+ clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
1538
+ query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
1233
1539
  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).
1234
1540
  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).
1235
1541
  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).
@@ -1263,20 +1569,42 @@ Name | Type | Description | Notes
1263
1569
  **categories_confident** | **Boolean**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
1264
1570
  **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1265
1571
  **not_categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1572
+ **categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1573
+ **not_categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1266
1574
  **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1267
1575
  **not_categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1576
+ **entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1577
+ **not_entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1578
+ **entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1579
+ **not_entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1268
1580
  **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1269
1581
  **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1270
1582
  **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1271
1583
  **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1584
+ **entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1585
+ **not_entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1272
1586
  **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1273
1587
  **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1588
+ **entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1589
+ **not_entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1590
+ **entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1591
+ **not_entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1592
+ **entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1593
+ **not_entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1594
+ **entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1595
+ **not_entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1274
1596
  **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1275
1597
  **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1276
1598
  **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1277
1599
  **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1600
+ **entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1601
+ **not_entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1278
1602
  **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1279
1603
  **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1604
+ **entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1605
+ **not_entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1606
+ **entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1607
+ **not_entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1280
1608
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
1281
1609
  **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
1282
1610
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
@@ -1330,6 +1658,8 @@ Name | Type | Description | Notes
1330
1658
  **social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
1331
1659
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
1332
1660
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
1661
+ **clusters** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
1662
+ **query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
1333
1663
  **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 &#39;NOW-7DAYS/DAY&#39;]
1334
1664
  **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 &#39;NOW/DAY&#39;]
1335
1665
  **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 &#39;+1DAY&#39;]
@@ -1385,6 +1715,8 @@ opts = {
1385
1715
  translations_en_title: 'translations_en_title_example', # String | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
1386
1716
  translations_en_body: 'translations_en_body_example', # String | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
1387
1717
  translations_en_text: 'translations_en_text_example', # String | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
1718
+ links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
1719
+ not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
1388
1720
  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.
1389
1721
  not_language: ['language_example'], # Array<String> | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
1390
1722
  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).
@@ -1393,20 +1725,42 @@ opts = {
1393
1725
  categories_confident: true, # Boolean | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1394
1726
  categories_id: ['categories_id_example'], # Array<String> | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1395
1727
  not_categories_id: ['categories_id_example'], # Array<String> | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1728
+ categories_label: ['categories_label_example'], # Array<String> | This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1729
+ not_categories_label: ['categories_label_example'], # Array<String> | This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1396
1730
  categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1397
1731
  not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
1732
+ entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1733
+ not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1734
+ entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1735
+ not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1398
1736
  entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1399
1737
  not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1400
1738
  entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1401
1739
  not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1740
+ entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1741
+ not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1402
1742
  entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1403
1743
  not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1744
+ entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1745
+ not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1746
+ entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1747
+ not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1748
+ entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1749
+ not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1750
+ entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1751
+ not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1404
1752
  entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1405
1753
  not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1406
1754
  entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1407
1755
  not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1756
+ entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1757
+ not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1408
1758
  entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1409
1759
  not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1760
+ entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1761
+ not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1762
+ entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1763
+ not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
1410
1764
  sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
1411
1765
  not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
1412
1766
  sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
@@ -1459,7 +1813,9 @@ opts = {
1459
1813
  social_shares_count_linkedin_min: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
1460
1814
  social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
1461
1815
  social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
1462
- social_shares_count_reddit_max: 56 # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
1816
+ social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
1817
+ clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
1818
+ query: 'query_example' # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
1463
1819
  }
1464
1820
 
1465
1821
  begin
@@ -1485,6 +1841,8 @@ Name | Type | Description | Notes
1485
1841
  **translations_en_title** | **String**| This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1486
1842
  **translations_en_body** | **String**| This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1487
1843
  **translations_en_text** | **String**| This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
1844
+ **links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on their url. | [optional]
1845
+ **not_links_permalink** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
1488
1846
  **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]
1489
1847
  **not_language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
1490
1848
  **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]
@@ -1493,20 +1851,42 @@ Name | Type | Description | Notes
1493
1851
  **categories_confident** | **Boolean**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
1494
1852
  **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1495
1853
  **not_categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1854
+ **categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1855
+ **not_categories_label** | [**Array&lt;String&gt;**](String.md)| This parameter is used for excluding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1496
1856
  **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1497
1857
  **not_categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
1858
+ **entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1859
+ **not_entities_title_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1860
+ **entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1861
+ **not_entities_title_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1498
1862
  **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1499
1863
  **not_entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1500
1864
  **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1501
1865
  **not_entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1866
+ **entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1867
+ **not_entities_title_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1502
1868
  **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1503
1869
  **not_entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1870
+ **entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1871
+ **not_entities_title_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1872
+ **entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1873
+ **not_entities_title_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1874
+ **entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1875
+ **not_entities_body_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;id&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1876
+ **entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1877
+ **not_entities_body_surface_forms_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;surface_form&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1504
1878
  **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1505
1879
  **not_entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1506
1880
  **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1507
1881
  **not_entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1882
+ **entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1883
+ **not_entities_body_stock_ticker** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities &#x60;stock_ticker&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1508
1884
  **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1509
1885
  **not_entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1886
+ **entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1887
+ **not_entities_body_links_wikipedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1888
+ **entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1889
+ **not_entities_body_links_wikidata** | [**Array&lt;String&gt;**](String.md)| This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
1510
1890
  **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
1511
1891
  **not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
1512
1892
  **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
@@ -1560,6 +1940,8 @@ Name | Type | Description | Notes
1560
1940
  **social_shares_count_linkedin_max** | **Integer**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
1561
1941
  **social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
1562
1942
  **social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
1943
+ **clusters** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
1944
+ **query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
1563
1945
 
1564
1946
  ### Return type
1565
1947