aylien_news_api 3.0.0 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/aylien_news_api.gemspec +1 -2
- data/docs/Category.md +3 -1
- data/docs/CategoryTaxonomy.md +16 -0
- data/docs/DefaultApi.md +105 -51
- data/docs/Histograms.md +5 -1
- data/docs/Media.md +2 -2
- data/docs/MediaFormat.md +16 -0
- data/docs/MediaType.md +16 -0
- data/docs/Scope.md +1 -1
- data/docs/ScopeLevel.md +16 -0
- data/docs/Sentiment.md +1 -1
- data/docs/SentimentPolarity.md +16 -0
- data/docs/Stories.md +5 -1
- data/docs/StoryLinks.md +3 -3
- data/docs/StoryTranslation.md +19 -0
- data/docs/StoryTranslations.md +1 -1
- data/docs/Trends.md +5 -1
- data/lib/aylien_news_api.rb +7 -3
- data/lib/aylien_news_api/api/default_api.rb +265 -159
- data/lib/aylien_news_api/api_client.rb +8 -6
- data/lib/aylien_news_api/api_error.rb +1 -1
- data/lib/aylien_news_api/configuration.rb +2 -2
- data/lib/aylien_news_api/models/author.rb +12 -2
- data/lib/aylien_news_api/models/autocomplete.rb +12 -2
- data/lib/aylien_news_api/models/autocompletes.rb +12 -2
- data/lib/aylien_news_api/models/category.rb +24 -39
- data/lib/aylien_news_api/models/category_links.rb +12 -2
- data/lib/aylien_news_api/models/category_taxonomy.rb +36 -0
- data/lib/aylien_news_api/models/cluster.rb +12 -2
- data/lib/aylien_news_api/models/clusters.rb +12 -2
- data/lib/aylien_news_api/models/coverages.rb +12 -2
- data/lib/aylien_news_api/models/entities.rb +12 -2
- data/lib/aylien_news_api/models/entity.rb +12 -2
- data/lib/aylien_news_api/models/entity_links.rb +12 -2
- data/lib/aylien_news_api/models/error.rb +12 -2
- data/lib/aylien_news_api/models/error_links.rb +12 -2
- data/lib/aylien_news_api/models/errors.rb +12 -2
- data/lib/aylien_news_api/models/histogram_interval.rb +12 -2
- data/lib/aylien_news_api/models/histograms.rb +36 -6
- data/lib/aylien_news_api/models/location.rb +12 -2
- data/lib/aylien_news_api/models/media.rb +14 -52
- data/lib/aylien_news_api/models/media_format.rb +44 -0
- data/lib/aylien_news_api/models/media_type.rb +36 -0
- data/lib/aylien_news_api/models/rank.rb +12 -2
- data/lib/aylien_news_api/models/rankings.rb +12 -2
- data/lib/aylien_news_api/models/related_stories.rb +12 -2
- data/lib/aylien_news_api/models/representative_story.rb +12 -2
- data/lib/aylien_news_api/models/scope.rb +13 -38
- data/lib/aylien_news_api/models/scope_level.rb +37 -0
- data/lib/aylien_news_api/models/sentiment.rb +13 -38
- data/lib/aylien_news_api/models/sentiment_polarity.rb +37 -0
- data/lib/aylien_news_api/models/sentiments.rb +12 -2
- data/lib/aylien_news_api/models/share_count.rb +12 -2
- data/lib/aylien_news_api/models/share_counts.rb +12 -2
- data/lib/aylien_news_api/models/source.rb +12 -2
- data/lib/aylien_news_api/models/stories.rb +36 -6
- data/lib/aylien_news_api/models/story.rb +12 -2
- data/lib/aylien_news_api/models/story_cluster.rb +12 -2
- data/lib/aylien_news_api/models/story_links.rb +26 -16
- data/lib/aylien_news_api/models/story_translation.rb +217 -0
- data/lib/aylien_news_api/models/story_translations.rb +13 -3
- data/lib/aylien_news_api/models/story_translations_en.rb +12 -2
- data/lib/aylien_news_api/models/summary.rb +12 -2
- data/lib/aylien_news_api/models/time_series.rb +12 -2
- data/lib/aylien_news_api/models/time_series_list.rb +12 -2
- data/lib/aylien_news_api/models/trend.rb +12 -2
- data/lib/aylien_news_api/models/trends.rb +36 -6
- data/lib/aylien_news_api/version.rb +2 -2
- data/spec/api/default_api_spec.rb +54 -28
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/author_spec.rb +2 -2
- data/spec/models/autocomplete_spec.rb +2 -2
- data/spec/models/autocompletes_spec.rb +2 -2
- data/spec/models/category_links_spec.rb +2 -2
- data/spec/models/category_spec.rb +8 -6
- data/spec/models/category_taxonomy_spec.rb +35 -0
- data/spec/models/cluster_spec.rb +2 -2
- data/spec/models/clusters_spec.rb +2 -2
- data/spec/models/coverages_spec.rb +2 -2
- data/spec/models/entities_spec.rb +2 -2
- data/spec/models/entity_links_spec.rb +2 -2
- data/spec/models/entity_spec.rb +2 -2
- data/spec/models/error_links_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/errors_spec.rb +2 -2
- data/spec/models/histogram_interval_spec.rb +2 -2
- data/spec/models/histograms_spec.rb +14 -2
- data/spec/models/location_spec.rb +2 -2
- data/spec/models/media_format_spec.rb +35 -0
- data/spec/models/media_spec.rb +2 -10
- data/spec/models/media_type_spec.rb +35 -0
- data/spec/models/rank_spec.rb +2 -2
- data/spec/models/rankings_spec.rb +2 -2
- data/spec/models/related_stories_spec.rb +2 -2
- data/spec/models/representative_story_spec.rb +2 -2
- data/spec/models/scope_level_spec.rb +35 -0
- data/spec/models/scope_spec.rb +2 -6
- data/spec/models/sentiment_polarity_spec.rb +35 -0
- data/spec/models/sentiment_spec.rb +2 -6
- data/spec/models/sentiments_spec.rb +2 -2
- data/spec/models/share_count_spec.rb +2 -2
- data/spec/models/share_counts_spec.rb +2 -2
- data/spec/models/source_spec.rb +2 -2
- data/spec/models/stories_spec.rb +14 -2
- data/spec/models/story_cluster_spec.rb +2 -2
- data/spec/models/story_links_spec.rb +5 -5
- data/spec/models/story_spec.rb +2 -2
- data/spec/models/story_translation_spec.rb +47 -0
- data/spec/models/story_translations_en_spec.rb +2 -2
- data/spec/models/story_translations_spec.rb +2 -2
- data/spec/models/summary_spec.rb +2 -2
- data/spec/models/time_series_list_spec.rb +2 -2
- data/spec/models/time_series_spec.rb +2 -2
- data/spec/models/trend_spec.rb +2 -2
- data/spec/models/trends_spec.rb +14 -2
- data/spec/spec_helper.rb +2 -2
- metadata +27 -23
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 49747d64a222470fc36e5962a1d62838fbffe4be02d1a434a4347ed962546d03
|
4
|
+
data.tar.gz: '02586f0009083761258e5bf44a603ae94f6f6a6303cb85a603f33a927a4818ae'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1e84be4e7946ae32e0a8285a9b5fc4147b95491e875618e819962dbbb56e3a1401cc20f53e995f3251f42e95c56d777c30659d811784f451468588c8f86ba874
|
7
|
+
data.tar.gz: '0935c028ce823eea885b9891850f9cb3535ecfc8016ac962a921bc1ba72a961636d19ce63d3145ec2ae2935e5ace78555c1db8a1efe5966e2767ec3009e11dbe'
|
data/Gemfile
CHANGED
data/aylien_news_api.gemspec
CHANGED
@@ -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:
|
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
|
|
data/docs/Category.md
CHANGED
@@ -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** | **
|
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
|
+
|
data/docs/DefaultApi.md
CHANGED
@@ -6,9 +6,9 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**list_autocompletes**](DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
|
8
8
|
[**list_clusters**](DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
|
9
|
-
[**list_coverages**](DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
|
10
9
|
[**list_histograms**](DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
|
11
|
-
[**
|
10
|
+
[**list_related_stories_get**](DefaultApi.md#list_related_stories_get) | **GET** /related_stories |
|
11
|
+
[**list_related_stories_post**](DefaultApi.md#list_related_stories_post) | **POST** /related_stories |
|
12
12
|
[**list_stories**](DefaultApi.md#list_stories) | **GET** /stories | List Stories
|
13
13
|
[**list_time_series**](DefaultApi.md#list_time_series) | **GET** /time_series | List time series
|
14
14
|
[**list_trends**](DefaultApi.md#list_trends) | **GET** /trends | List trends
|
@@ -121,7 +121,12 @@ opts = {
|
|
121
121
|
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
122
|
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
123
|
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).
|
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).
|
125
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
126
|
+
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).
|
127
|
+
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).
|
128
|
+
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).
|
129
|
+
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
130
|
}
|
126
131
|
|
127
132
|
begin
|
@@ -150,6 +155,11 @@ Name | Type | Description | Notes
|
|
150
155
|
**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
156
|
**location_country** | [**Array<String>**](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
157
|
**not_location_country** | [**Array<String>**](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]
|
158
|
+
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
159
|
+
**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 'published_at']
|
160
|
+
**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 'desc']
|
161
|
+
**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 '*']
|
162
|
+
**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
163
|
|
154
164
|
### Return type
|
155
165
|
|
@@ -165,13 +175,13 @@ Name | Type | Description | Notes
|
|
165
175
|
- **Accept**: application/json, text/xml
|
166
176
|
|
167
177
|
|
168
|
-
##
|
178
|
+
## list_histograms
|
169
179
|
|
170
|
-
>
|
180
|
+
> Histograms list_histograms(opts)
|
171
181
|
|
172
|
-
List
|
182
|
+
List histograms
|
173
183
|
|
174
|
-
|
184
|
+
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
185
|
|
176
186
|
### Example
|
177
187
|
|
@@ -201,6 +211,8 @@ opts = {
|
|
201
211
|
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
212
|
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
213
|
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).
|
214
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
215
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
204
216
|
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
217
|
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
218
|
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,6 +221,8 @@ opts = {
|
|
209
221
|
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
222
|
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
223
|
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).
|
224
|
+
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).
|
225
|
+
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
226
|
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
227
|
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).
|
214
228
|
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).
|
@@ -277,22 +291,18 @@ opts = {
|
|
277
291
|
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
292
|
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
293
|
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
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
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.
|
294
|
+
interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
|
295
|
+
interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
|
296
|
+
interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
|
297
|
+
field: 'social_shares_count' # String | This parameter is used for specifying the y-axis variable for the histogram.
|
288
298
|
}
|
289
299
|
|
290
300
|
begin
|
291
|
-
#List
|
292
|
-
result = api_instance.
|
301
|
+
#List histograms
|
302
|
+
result = api_instance.list_histograms(opts)
|
293
303
|
p result
|
294
304
|
rescue AylienNewsApi::ApiError => e
|
295
|
-
puts "Exception when calling DefaultApi->
|
305
|
+
puts "Exception when calling DefaultApi->list_histograms: #{e}"
|
296
306
|
end
|
297
307
|
```
|
298
308
|
|
@@ -309,6 +319,8 @@ Name | Type | Description | Notes
|
|
309
319
|
**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
320
|
**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
321
|
**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]
|
322
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
323
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
312
324
|
**language** | [**Array<String>**](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
325
|
**not_language** | [**Array<String>**](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
326
|
**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,6 +329,8 @@ Name | Type | Description | Notes
|
|
317
329
|
**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
330
|
**categories_id** | [**Array<String>**](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
331
|
**not_categories_id** | [**Array<String>**](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]
|
332
|
+
**categories_label** | [**Array<String>**](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]
|
333
|
+
**not_categories_label** | [**Array<String>**](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
334
|
**categories_level** | [**Array<Integer>**](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
335
|
**not_categories_level** | [**Array<Integer>**](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]
|
322
336
|
**entities_title_text** | [**Array<String>**](String.md)| 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). | [optional]
|
@@ -385,18 +399,14 @@ Name | Type | Description | Notes
|
|
385
399
|
**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
400
|
**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
401
|
**clusters** | [**Array<String>**](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
|
-
**
|
389
|
-
**
|
390
|
-
**
|
391
|
-
**
|
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 'auto']
|
395
|
-
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
402
|
+
**interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
|
403
|
+
**interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
|
404
|
+
**interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
|
405
|
+
**field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to 'social_shares_count']
|
396
406
|
|
397
407
|
### Return type
|
398
408
|
|
399
|
-
[**
|
409
|
+
[**Histograms**](Histograms.md)
|
400
410
|
|
401
411
|
### Authorization
|
402
412
|
|
@@ -408,13 +418,11 @@ Name | Type | Description | Notes
|
|
408
418
|
- **Accept**: application/json, text/xml
|
409
419
|
|
410
420
|
|
411
|
-
##
|
421
|
+
## list_related_stories_get
|
412
422
|
|
413
|
-
>
|
423
|
+
> RelatedStories list_related_stories_get(opts)
|
414
424
|
|
415
|
-
List histograms
|
416
425
|
|
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
426
|
|
419
427
|
### Example
|
420
428
|
|
@@ -444,6 +452,8 @@ opts = {
|
|
444
452
|
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
453
|
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
454
|
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).
|
455
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
456
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
447
457
|
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
458
|
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
459
|
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,6 +462,8 @@ opts = {
|
|
452
462
|
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
463
|
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
464
|
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).
|
465
|
+
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).
|
466
|
+
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
467
|
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
468
|
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).
|
457
469
|
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).
|
@@ -519,18 +531,22 @@ opts = {
|
|
519
531
|
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
532
|
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
533
|
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
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
534
|
+
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).
|
535
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
536
|
+
story_id: 56, # Integer | A story id
|
537
|
+
story_url: 'story_url_example', # String | An article or webpage
|
538
|
+
story_title: 'story_title_example', # String | Title of the article
|
539
|
+
story_body: 'story_body_example', # String | Body of the article
|
540
|
+
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
541
|
+
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.
|
542
|
+
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
526
543
|
}
|
527
544
|
|
528
545
|
begin
|
529
|
-
|
530
|
-
result = api_instance.list_histograms(opts)
|
546
|
+
result = api_instance.list_related_stories_get(opts)
|
531
547
|
p result
|
532
548
|
rescue AylienNewsApi::ApiError => e
|
533
|
-
puts "Exception when calling DefaultApi->
|
549
|
+
puts "Exception when calling DefaultApi->list_related_stories_get: #{e}"
|
534
550
|
end
|
535
551
|
```
|
536
552
|
|
@@ -547,6 +563,8 @@ Name | Type | Description | Notes
|
|
547
563
|
**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
564
|
**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
565
|
**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]
|
566
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
567
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
550
568
|
**language** | [**Array<String>**](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
569
|
**not_language** | [**Array<String>**](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
570
|
**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,6 +573,8 @@ Name | Type | Description | Notes
|
|
555
573
|
**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
574
|
**categories_id** | [**Array<String>**](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
575
|
**not_categories_id** | [**Array<String>**](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]
|
576
|
+
**categories_label** | [**Array<String>**](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]
|
577
|
+
**not_categories_label** | [**Array<String>**](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
578
|
**categories_level** | [**Array<Integer>**](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
579
|
**not_categories_level** | [**Array<Integer>**](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]
|
560
580
|
**entities_title_text** | [**Array<String>**](String.md)| 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). | [optional]
|
@@ -622,14 +642,19 @@ Name | Type | Description | Notes
|
|
622
642
|
**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
643
|
**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
644
|
**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
|
-
**
|
626
|
-
**
|
627
|
-
**
|
628
|
-
**
|
645
|
+
**clusters** | [**Array<String>**](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]
|
646
|
+
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
647
|
+
**story_id** | **Integer**| A story id | [optional]
|
648
|
+
**story_url** | **String**| An article or webpage | [optional]
|
649
|
+
**story_title** | **String**| Title of the article | [optional]
|
650
|
+
**story_body** | **String**| Body of the article | [optional]
|
651
|
+
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
652
|
+
**story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to 'auto']
|
653
|
+
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
629
654
|
|
630
655
|
### Return type
|
631
656
|
|
632
|
-
[**
|
657
|
+
[**RelatedStories**](RelatedStories.md)
|
633
658
|
|
634
659
|
### Authorization
|
635
660
|
|
@@ -641,13 +666,11 @@ Name | Type | Description | Notes
|
|
641
666
|
- **Accept**: application/json, text/xml
|
642
667
|
|
643
668
|
|
644
|
-
##
|
669
|
+
## list_related_stories_post
|
645
670
|
|
646
|
-
> RelatedStories
|
671
|
+
> RelatedStories list_related_stories_post(opts)
|
647
672
|
|
648
|
-
List related stories
|
649
673
|
|
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
674
|
|
652
675
|
### Example
|
653
676
|
|
@@ -677,6 +700,8 @@ opts = {
|
|
677
700
|
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
701
|
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
702
|
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).
|
703
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
704
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
680
705
|
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
706
|
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
707
|
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,6 +710,8 @@ opts = {
|
|
685
710
|
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
711
|
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
712
|
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).
|
713
|
+
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).
|
714
|
+
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
715
|
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
716
|
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).
|
690
717
|
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).
|
@@ -764,11 +791,10 @@ opts = {
|
|
764
791
|
}
|
765
792
|
|
766
793
|
begin
|
767
|
-
|
768
|
-
result = api_instance.list_related_stories(opts)
|
794
|
+
result = api_instance.list_related_stories_post(opts)
|
769
795
|
p result
|
770
796
|
rescue AylienNewsApi::ApiError => e
|
771
|
-
puts "Exception when calling DefaultApi->
|
797
|
+
puts "Exception when calling DefaultApi->list_related_stories_post: #{e}"
|
772
798
|
end
|
773
799
|
```
|
774
800
|
|
@@ -785,6 +811,8 @@ Name | Type | Description | Notes
|
|
785
811
|
**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
812
|
**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
813
|
**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]
|
814
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
815
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
788
816
|
**language** | [**Array<String>**](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
817
|
**not_language** | [**Array<String>**](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
818
|
**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,6 +821,8 @@ Name | Type | Description | Notes
|
|
793
821
|
**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
822
|
**categories_id** | [**Array<String>**](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
823
|
**not_categories_id** | [**Array<String>**](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]
|
824
|
+
**categories_label** | [**Array<String>**](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]
|
825
|
+
**not_categories_label** | [**Array<String>**](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
826
|
**categories_level** | [**Array<Integer>**](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
827
|
**not_categories_level** | [**Array<Integer>**](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]
|
798
828
|
**entities_title_text** | [**Array<String>**](String.md)| 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). | [optional]
|
@@ -922,12 +952,16 @@ opts = {
|
|
922
952
|
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
953
|
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
954
|
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.
|
955
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
956
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
925
957
|
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
958
|
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
959
|
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
960
|
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
961
|
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
962
|
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).
|
963
|
+
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).
|
964
|
+
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
965
|
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
966
|
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).
|
933
967
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
@@ -1027,12 +1061,16 @@ Name | Type | Description | Notes
|
|
1027
1061
|
**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
1062
|
**language** | [**Array<String>**](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
1063
|
**not_language** | [**Array<String>**](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]
|
1064
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
1065
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
1030
1066
|
**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
1067
|
**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
1068
|
**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
1069
|
**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
1070
|
**categories_id** | [**Array<String>**](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
1071
|
**not_categories_id** | [**Array<String>**](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]
|
1072
|
+
**categories_label** | [**Array<String>**](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]
|
1073
|
+
**not_categories_label** | [**Array<String>**](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
1074
|
**categories_level** | [**Array<Integer>**](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
1075
|
**not_categories_level** | [**Array<Integer>**](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]
|
1038
1076
|
**entities_title_text** | [**Array<String>**](String.md)| 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). | [optional]
|
@@ -1163,6 +1201,8 @@ opts = {
|
|
1163
1201
|
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
1202
|
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
1203
|
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).
|
1204
|
+
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).
|
1205
|
+
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
1206
|
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
1207
|
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).
|
1168
1208
|
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).
|
@@ -1230,6 +1270,7 @@ opts = {
|
|
1230
1270
|
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
1271
|
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
1272
|
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.
|
1273
|
+
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).
|
1233
1274
|
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
1275
|
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
1276
|
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,6 +1304,8 @@ Name | Type | Description | Notes
|
|
1263
1304
|
**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
1305
|
**categories_id** | [**Array<String>**](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
1306
|
**not_categories_id** | [**Array<String>**](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]
|
1307
|
+
**categories_label** | [**Array<String>**](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]
|
1308
|
+
**not_categories_label** | [**Array<String>**](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
1309
|
**categories_level** | [**Array<Integer>**](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
1310
|
**not_categories_level** | [**Array<Integer>**](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]
|
1268
1311
|
**entities_title_text** | [**Array<String>**](String.md)| 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). | [optional]
|
@@ -1330,6 +1373,7 @@ Name | Type | Description | Notes
|
|
1330
1373
|
**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
1374
|
**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
1375
|
**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]
|
1376
|
+
**clusters** | [**Array<String>**](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]
|
1333
1377
|
**published_at_start** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to 'NOW-7DAYS/DAY']
|
1334
1378
|
**published_at_end** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to 'NOW/DAY']
|
1335
1379
|
**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 `+` 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). | [optional] [default to '+1DAY']
|
@@ -1385,6 +1429,8 @@ opts = {
|
|
1385
1429
|
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
1430
|
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
1431
|
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).
|
1432
|
+
links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to find stories based on their url.
|
1433
|
+
not_links_permalink: ['links_permalink_example'], # Array<String> | This parameter is used to exclude stories based on their url.
|
1388
1434
|
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
1435
|
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
1436
|
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,6 +1439,8 @@ opts = {
|
|
1393
1439
|
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
1440
|
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
1441
|
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).
|
1442
|
+
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).
|
1443
|
+
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
1444
|
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
1445
|
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).
|
1398
1446
|
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).
|
@@ -1459,7 +1507,8 @@ opts = {
|
|
1459
1507
|
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
1508
|
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
1509
|
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.
|
1510
|
+
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.
|
1511
|
+
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).
|
1463
1512
|
}
|
1464
1513
|
|
1465
1514
|
begin
|
@@ -1485,6 +1534,8 @@ Name | Type | Description | Notes
|
|
1485
1534
|
**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
1535
|
**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
1536
|
**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]
|
1537
|
+
**links_permalink** | [**Array<String>**](String.md)| This parameter is used to find stories based on their url. | [optional]
|
1538
|
+
**not_links_permalink** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on their url. | [optional]
|
1488
1539
|
**language** | [**Array<String>**](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
1540
|
**not_language** | [**Array<String>**](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
1541
|
**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,6 +1544,8 @@ Name | Type | Description | Notes
|
|
1493
1544
|
**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
1545
|
**categories_id** | [**Array<String>**](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
1546
|
**not_categories_id** | [**Array<String>**](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]
|
1547
|
+
**categories_label** | [**Array<String>**](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]
|
1548
|
+
**not_categories_label** | [**Array<String>**](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
1549
|
**categories_level** | [**Array<Integer>**](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
1550
|
**not_categories_level** | [**Array<Integer>**](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]
|
1498
1551
|
**entities_title_text** | [**Array<String>**](String.md)| 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). | [optional]
|
@@ -1560,6 +1613,7 @@ Name | Type | Description | Notes
|
|
1560
1613
|
**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
1614
|
**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
1615
|
**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]
|
1616
|
+
**clusters** | [**Array<String>**](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]
|
1563
1617
|
|
1564
1618
|
### Return type
|
1565
1619
|
|