aylien_news_api 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +5 -129
- data/aylien_news_api-0.2.0.gem +0 -0
- data/aylien_news_api.gemspec +2 -2
- data/docs/DefaultApi.md +60 -0
- data/docs/Rank.md +10 -0
- data/docs/Rankings.md +8 -0
- data/docs/Source.md +7 -2
- data/lib/aylien_news_api.rb +2 -0
- data/lib/aylien_news_api/api/default_api.rb +356 -4
- data/lib/aylien_news_api/api_client.rb +7 -2
- data/lib/aylien_news_api/configuration.rb +19 -6
- data/lib/aylien_news_api/models/entity.rb +13 -7
- data/lib/aylien_news_api/models/rank.rb +211 -0
- data/lib/aylien_news_api/models/rankings.rb +192 -0
- data/lib/aylien_news_api/models/sentiment.rb +13 -7
- data/lib/aylien_news_api/models/source.rb +56 -6
- data/lib/aylien_news_api/version.rb +1 -1
- data/spec/models/rank_spec.rb +54 -0
- data/spec/models/rankings_spec.rb +42 -0
- metadata +13 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: aa2c2f32d6124f25f96c8fa0b56767670006ce1e
|
|
4
|
+
data.tar.gz: 531931f7a468cde8ebc03c7d4a8744dbb20e0e94
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 074d9de795c0103ef021c38fbcdc354033b955d7d81a6699f70200c0d0c041b29c63998b3bc688f8c57ab225dc1a517f71435aad09ad40fdbfdcaba6556cb56b
|
|
7
|
+
data.tar.gz: 189ddf25ba97325a1b72307cb8b8e1018deb8b4df20ce9746477a1363c0c923e525493425309ee4a42e598ae1908c67e28d937199f26d9acef95fe8ee190353c
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -1,134 +1,10 @@
|
|
|
1
1
|
# AYLIEN News API
|
|
2
|
-
[](https://badge.fury.io/rb/aylien_news_api)
|
|
3
2
|
|
|
4
|
-
|
|
3
|
+
AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content.
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
Sign up at [https://newsapi.aylien.com/](https://newsapi.aylien.com/).
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
For more documentation see [https://newsapi.aylien.com/docs/](https://newsapi.aylien.com/docs/).
|
|
9
8
|
|
|
10
|
-
##
|
|
11
|
-
|
|
12
|
-
### RubyGems
|
|
13
|
-
|
|
14
|
-
Add this to the Gemfile:
|
|
15
|
-
|
|
16
|
-
gem 'aylien_news_api'
|
|
17
|
-
|
|
18
|
-
or install it directly:
|
|
19
|
-
|
|
20
|
-
gem install aylien_news_api
|
|
21
|
-
|
|
22
|
-
### Git
|
|
23
|
-
|
|
24
|
-
Add the following in the Gemfile:
|
|
25
|
-
|
|
26
|
-
gem 'aylien_news_api', :git => 'https://github.com/AYLIEN/aylien_newsapi_ruby.git'
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
## Getting Started
|
|
30
|
-
|
|
31
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
|
32
|
-
```ruby
|
|
33
|
-
# Load the gem
|
|
34
|
-
require 'aylien_news_api'
|
|
35
|
-
|
|
36
|
-
# Setup authorization
|
|
37
|
-
AylienNewsApi.configure do |config|
|
|
38
|
-
# Configure API key authorization: app_id
|
|
39
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
|
|
40
|
-
|
|
41
|
-
# Configure API key authorization: app_key
|
|
42
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
|
|
43
|
-
end
|
|
44
|
-
|
|
45
|
-
api_instance = AylienNewsApi::DefaultApi.new
|
|
46
|
-
|
|
47
|
-
opts = {
|
|
48
|
-
:title => 'trump',
|
|
49
|
-
:published_at_start => "NOW-7DAYS",
|
|
50
|
-
:published_at_end => "NOW",
|
|
51
|
-
:entities_body_links_dbpedia => [
|
|
52
|
-
'http://dbpedia.org/resource/Donald_Trump',
|
|
53
|
-
'http://dbpedia.org/resource/Hillary_Rodham_Clinton'
|
|
54
|
-
],
|
|
55
|
-
:language => ['en'],
|
|
56
|
-
:sort_by => 'social_shares_count.facebook'
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
begin
|
|
61
|
-
#List stories
|
|
62
|
-
result = api_instance.list_stories(opts)
|
|
63
|
-
puts result
|
|
64
|
-
rescue AylienNewsApi::ApiError => e
|
|
65
|
-
puts "Exception when calling DefaultApi->list_stories: #{e}"
|
|
66
|
-
end
|
|
67
|
-
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
## Documentation for API Endpoints
|
|
71
|
-
|
|
72
|
-
All URIs are relative to *https://api.newsapi.aylien.com/api/v1*
|
|
73
|
-
|
|
74
|
-
Class | Method | HTTP request | Description
|
|
75
|
-
------------ | ------------- | ------------- | -------------
|
|
76
|
-
*AylienNewsApi::DefaultApi* | [**list_autocompletes**](docs/DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
|
|
77
|
-
*AylienNewsApi::DefaultApi* | [**list_coverages**](docs/DefaultApi.md#list_coverages) | **POST** /coverages | List coverages
|
|
78
|
-
*AylienNewsApi::DefaultApi* | [**list_histograms**](docs/DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
|
|
79
|
-
*AylienNewsApi::DefaultApi* | [**list_related_stories**](docs/DefaultApi.md#list_related_stories) | **POST** /related_stories | List related stories
|
|
80
|
-
*AylienNewsApi::DefaultApi* | [**list_stories**](docs/DefaultApi.md#list_stories) | **GET** /stories | List Stories
|
|
81
|
-
*AylienNewsApi::DefaultApi* | [**list_time_series**](docs/DefaultApi.md#list_time_series) | **GET** /time_series | List time series
|
|
82
|
-
*AylienNewsApi::DefaultApi* | [**list_trends**](docs/DefaultApi.md#list_trends) | **GET** /trends | List trends
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
## Documentation for Models
|
|
86
|
-
|
|
87
|
-
- [AylienNewsApi::Author](docs/Author.md)
|
|
88
|
-
- [AylienNewsApi::Autocomplete](docs/Autocomplete.md)
|
|
89
|
-
- [AylienNewsApi::Autocompletes](docs/Autocompletes.md)
|
|
90
|
-
- [AylienNewsApi::Category](docs/Category.md)
|
|
91
|
-
- [AylienNewsApi::CategoryLinks](docs/CategoryLinks.md)
|
|
92
|
-
- [AylienNewsApi::Coverages](docs/Coverages.md)
|
|
93
|
-
- [AylienNewsApi::Entities](docs/Entities.md)
|
|
94
|
-
- [AylienNewsApi::Entity](docs/Entity.md)
|
|
95
|
-
- [AylienNewsApi::EntityLinks](docs/EntityLinks.md)
|
|
96
|
-
- [AylienNewsApi::Error](docs/Error.md)
|
|
97
|
-
- [AylienNewsApi::ErrorLinks](docs/ErrorLinks.md)
|
|
98
|
-
- [AylienNewsApi::Errors](docs/Errors.md)
|
|
99
|
-
- [AylienNewsApi::HistogramInterval](docs/HistogramInterval.md)
|
|
100
|
-
- [AylienNewsApi::Histograms](docs/Histograms.md)
|
|
101
|
-
- [AylienNewsApi::Location](docs/Location.md)
|
|
102
|
-
- [AylienNewsApi::Media](docs/Media.md)
|
|
103
|
-
- [AylienNewsApi::RelatedStories](docs/RelatedStories.md)
|
|
104
|
-
- [AylienNewsApi::Scope](docs/Scope.md)
|
|
105
|
-
- [AylienNewsApi::Sentiment](docs/Sentiment.md)
|
|
106
|
-
- [AylienNewsApi::Sentiments](docs/Sentiments.md)
|
|
107
|
-
- [AylienNewsApi::ShareCount](docs/ShareCount.md)
|
|
108
|
-
- [AylienNewsApi::ShareCounts](docs/ShareCounts.md)
|
|
109
|
-
- [AylienNewsApi::Source](docs/Source.md)
|
|
110
|
-
- [AylienNewsApi::Stories](docs/Stories.md)
|
|
111
|
-
- [AylienNewsApi::Story](docs/Story.md)
|
|
112
|
-
- [AylienNewsApi::StoryCluster](docs/StoryCluster.md)
|
|
113
|
-
- [AylienNewsApi::StoryLinks](docs/StoryLinks.md)
|
|
114
|
-
- [AylienNewsApi::Summary](docs/Summary.md)
|
|
115
|
-
- [AylienNewsApi::TimeSeries](docs/TimeSeries.md)
|
|
116
|
-
- [AylienNewsApi::TimeSeriesList](docs/TimeSeriesList.md)
|
|
117
|
-
- [AylienNewsApi::Trend](docs/Trend.md)
|
|
118
|
-
- [AylienNewsApi::Trends](docs/Trends.md)
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
## Documentation for Authorization
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
### app_id
|
|
125
|
-
|
|
126
|
-
- **Type**: API key
|
|
127
|
-
- **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
|
|
128
|
-
- **Location**: HTTP header
|
|
129
|
-
|
|
130
|
-
### app_key
|
|
131
|
-
|
|
132
|
-
- **Type**: API key
|
|
133
|
-
- **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
|
|
134
|
-
- **Location**: HTTP header
|
|
9
|
+
## Bug Reports
|
|
10
|
+
If you've got a bug report, please contact us at support@aylien.com.
|
|
Binary file
|
data/aylien_news_api.gemspec
CHANGED
|
@@ -20,9 +20,9 @@ Gem::Specification.new do |s|
|
|
|
20
20
|
s.name = "aylien_news_api"
|
|
21
21
|
s.version = AylienNewsApi::VERSION
|
|
22
22
|
s.platform = Gem::Platform::RUBY
|
|
23
|
-
s.authors = ["AYLIEN Inc.", "Hamed
|
|
23
|
+
s.authors = ["AYLIEN Inc.", "Hamed R. Nik"]
|
|
24
24
|
s.email = ["support@aylien.com", "hamed.r.nik@gmail.com"]
|
|
25
|
-
s.homepage = "https://
|
|
25
|
+
s.homepage = "https://newsapi.aylien.com/"
|
|
26
26
|
s.summary = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content"
|
|
27
27
|
s.description = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content."
|
|
28
28
|
s.license = "Apache-2.0"
|
data/docs/DefaultApi.md
CHANGED
|
@@ -137,6 +137,11 @@ opts = {
|
|
|
137
137
|
source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
138
138
|
source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
139
139
|
source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
140
|
+
source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
141
|
+
source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
142
|
+
source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
143
|
+
source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
144
|
+
source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
140
145
|
cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
|
|
141
146
|
cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
|
|
142
147
|
_return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
|
|
@@ -197,6 +202,11 @@ Name | Type | Description | Notes
|
|
|
197
202
|
**source_scopes_state** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
198
203
|
**source_scopes_city** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
199
204
|
**source_scopes_level** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
205
|
+
**source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
206
|
+
**source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
207
|
+
**source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
208
|
+
**source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
209
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
200
210
|
**cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
|
|
201
211
|
**cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. | [optional] [default to lingo]
|
|
202
212
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
|
@@ -282,6 +292,11 @@ opts = {
|
|
|
282
292
|
source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
283
293
|
source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
284
294
|
source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
295
|
+
source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
296
|
+
source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
297
|
+
source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
298
|
+
source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
299
|
+
source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
285
300
|
interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
|
|
286
301
|
interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
|
|
287
302
|
interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
|
|
@@ -336,6 +351,11 @@ Name | Type | Description | Notes
|
|
|
336
351
|
**source_scopes_state** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
337
352
|
**source_scopes_city** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
338
353
|
**source_scopes_level** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
354
|
+
**source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
355
|
+
**source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
356
|
+
**source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
357
|
+
**source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
358
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
339
359
|
**interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
|
|
340
360
|
**interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
|
|
341
361
|
**interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
|
|
@@ -415,6 +435,11 @@ opts = {
|
|
|
415
435
|
source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
416
436
|
source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
417
437
|
source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
438
|
+
source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
439
|
+
source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
440
|
+
source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
441
|
+
source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
442
|
+
source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
418
443
|
cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
|
|
419
444
|
cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
|
|
420
445
|
_return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
|
|
@@ -475,6 +500,11 @@ Name | Type | Description | Notes
|
|
|
475
500
|
**source_scopes_state** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
476
501
|
**source_scopes_city** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
477
502
|
**source_scopes_level** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
503
|
+
**source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
504
|
+
**source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
505
|
+
**source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
506
|
+
**source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
507
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
478
508
|
**cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
|
|
479
509
|
**cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. | [optional] [default to lingo]
|
|
480
510
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
|
@@ -560,6 +590,11 @@ opts = {
|
|
|
560
590
|
source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
561
591
|
source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
562
592
|
source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
593
|
+
source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
594
|
+
source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
595
|
+
source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
596
|
+
source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
597
|
+
source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
563
598
|
cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
|
|
564
599
|
cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
|
|
565
600
|
_return: ["_return_example"], # Array<String> | This parameter is used for specifying return fields.
|
|
@@ -617,6 +652,11 @@ Name | Type | Description | Notes
|
|
|
617
652
|
**source_scopes_state** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
618
653
|
**source_scopes_city** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
619
654
|
**source_scopes_level** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
655
|
+
**source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
656
|
+
**source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
657
|
+
**source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
658
|
+
**source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
659
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
620
660
|
**cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
|
|
621
661
|
**cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. | [optional] [default to lingo]
|
|
622
662
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
|
@@ -697,6 +737,11 @@ opts = {
|
|
|
697
737
|
source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
698
738
|
source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
699
739
|
source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
740
|
+
source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
741
|
+
source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
742
|
+
source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
743
|
+
source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
744
|
+
source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
700
745
|
published_at_start: "NOW-7DAYS/DAY", # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
|
701
746
|
published_at_end: "NOW/DAY", # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
|
702
747
|
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).
|
|
@@ -748,6 +793,11 @@ Name | Type | Description | Notes
|
|
|
748
793
|
**source_scopes_state** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
749
794
|
**source_scopes_city** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
750
795
|
**source_scopes_level** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
796
|
+
**source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
797
|
+
**source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
798
|
+
**source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
799
|
+
**source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
800
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
751
801
|
**published_at_start** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to NOW-7DAYS/DAY]
|
|
752
802
|
**published_at_end** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to NOW/DAY]
|
|
753
803
|
**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]
|
|
@@ -826,6 +876,11 @@ opts = {
|
|
|
826
876
|
source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
827
877
|
source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
828
878
|
source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
879
|
+
source_links_in_count_min: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
880
|
+
source_links_in_count_max: 56, # Integer | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
881
|
+
source_rankings_alexa_rank_min: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
882
|
+
source_rankings_alexa_rank_max: 56, # Integer | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
883
|
+
source_rankings_alexa_country: ["source_rankings_alexa_country_example"], # Array<String> | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
829
884
|
field: "field_example" # String | This parameter is used to specify the trend field.
|
|
830
885
|
}
|
|
831
886
|
|
|
@@ -877,6 +932,11 @@ Name | Type | Description | Notes
|
|
|
877
932
|
**source_scopes_state** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
878
933
|
**source_scopes_city** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
879
934
|
**source_scopes_level** | [**Array<String>**](String.md)| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
|
|
935
|
+
**source_links_in_count_min** | **Integer**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
936
|
+
**source_links_in_count_max** | **Integer**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
|
|
937
|
+
**source_rankings_alexa_rank_min** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
938
|
+
**source_rankings_alexa_rank_max** | **Integer**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
939
|
+
**source_rankings_alexa_country** | [**Array<String>**](String.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
|
|
880
940
|
**field** | **String**| This parameter is used to specify the trend field. | [optional]
|
|
881
941
|
|
|
882
942
|
### Return type
|
data/docs/Rank.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# AylienNewsApi::Rank
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**rank** | **Integer** | The rank | [optional]
|
|
7
|
+
**country** | **String** | The country code which the rank is in it | [optional]
|
|
8
|
+
**fetched_at** | **DateTime** | The fetched date of the rank | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/Rankings.md
ADDED
data/docs/Source.md
CHANGED
|
@@ -5,9 +5,14 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**id** | **Integer** | The source id which is a unique value | [optional]
|
|
7
7
|
**name** | **String** | The source name | [optional]
|
|
8
|
-
**
|
|
8
|
+
**title** | **String** | The title of the home page URL | [optional]
|
|
9
|
+
**description** | **String** | A general explanation about the source | [optional]
|
|
10
|
+
**links_in_count** | **Integer** | The number of websites that link to the source | [optional]
|
|
11
|
+
**home_page_url** | **String** | The home page URL of the source | [optional]
|
|
12
|
+
**domain** | **String** | The domain name of the source which is extracted from the source URL | [optional]
|
|
9
13
|
**logo_url** | **String** | A URL which points to the source logo | [optional]
|
|
10
14
|
**locations** | [**Array<Location>**](Location.md) | The source locations which are tend to be the physical locations of the source, e.g. BBC headquarter is located in London. | [optional]
|
|
11
|
-
**scopes** | [**Array<Scope>**](Scope.md) | The source scopes which is tend to be scope locations of the source, e.g. BBC scopes is international.
|
|
15
|
+
**scopes** | [**Array<Scope>**](Scope.md) | The source scopes which is tend to be scope locations of the source, e.g. BBC scopes is international. | [optional]
|
|
16
|
+
**rankings** | [**Rankings**](Rankings.md) | The web rankings of the source | [optional]
|
|
12
17
|
|
|
13
18
|
|
data/lib/aylien_news_api.rb
CHANGED
|
@@ -35,6 +35,8 @@ require 'aylien_news_api/models/histogram_interval'
|
|
|
35
35
|
require 'aylien_news_api/models/histograms'
|
|
36
36
|
require 'aylien_news_api/models/location'
|
|
37
37
|
require 'aylien_news_api/models/media'
|
|
38
|
+
require 'aylien_news_api/models/rank'
|
|
39
|
+
require 'aylien_news_api/models/rankings'
|
|
38
40
|
require 'aylien_news_api/models/related_stories'
|
|
39
41
|
require 'aylien_news_api/models/scope'
|
|
40
42
|
require 'aylien_news_api/models/sentiment'
|
|
@@ -55,10 +55,20 @@ module AylienNewsApi
|
|
|
55
55
|
end
|
|
56
56
|
# verify the required parameter 'term' is set
|
|
57
57
|
fail ArgumentError, "Missing the required parameter 'term' when calling DefaultApi.list_autocompletes" if term.nil?
|
|
58
|
+
if term.to_s.length < 1
|
|
59
|
+
fail ArgumentError, 'invalid value for "term" when calling DefaultApi.list_autocompletes, the character length must be great than or equal to 1.'
|
|
60
|
+
end
|
|
58
61
|
|
|
59
62
|
if opts[:'language'] && !['en', 'de', 'fr', 'it', 'es', 'pt'].include?(opts[:'language'])
|
|
60
63
|
fail ArgumentError, 'invalid value for "language", must be one of en, de, fr, it, es, pt'
|
|
61
64
|
end
|
|
65
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] > 100.0
|
|
66
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_autocompletes, must be smaller than or equal to 100.0.'
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] < 1.0
|
|
70
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_autocompletes, must be greater than or equal to 1.0.'
|
|
71
|
+
end
|
|
62
72
|
|
|
63
73
|
# resource path
|
|
64
74
|
local_var_path = "/autocompletes".sub('{format}','json')
|
|
@@ -138,6 +148,11 @@ module AylienNewsApi
|
|
|
138
148
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
139
149
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
140
150
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
151
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
152
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
153
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
154
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
155
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
141
156
|
# @option opts [BOOLEAN] :cluster This parameter enables clustering for the returned stories. (default to false)
|
|
142
157
|
# @option opts [String] :cluster_algorithm This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. (default to lingo)
|
|
143
158
|
# @option opts [Array<String>] :_return This parameter is used for specifying return fields.
|
|
@@ -192,6 +207,11 @@ module AylienNewsApi
|
|
|
192
207
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
193
208
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
194
209
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
210
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
211
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
212
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
213
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
214
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
195
215
|
# @option opts [BOOLEAN] :cluster This parameter enables clustering for the returned stories.
|
|
196
216
|
# @option opts [String] :cluster_algorithm This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
|
|
197
217
|
# @option opts [Array<String>] :_return This parameter is used for specifying return fields.
|
|
@@ -207,6 +227,9 @@ module AylienNewsApi
|
|
|
207
227
|
if @api_client.config.debugging
|
|
208
228
|
@api_client.config.logger.debug "Calling API: DefaultApi.list_coverages ..."
|
|
209
229
|
end
|
|
230
|
+
if opts[:'language'] && !opts[:'language'].all?{|l| ['en', 'de', 'fr', 'it', 'es', 'pt'].include?(l)}
|
|
231
|
+
fail ArgumentError, 'invalid value for "language", must be one of en, de, fr, it, es, pt'
|
|
232
|
+
end
|
|
210
233
|
if opts[:'categories_taxonomy'] && !['iab-qag', 'iptc-subjectcode'].include?(opts[:'categories_taxonomy'])
|
|
211
234
|
fail ArgumentError, 'invalid value for "categories_taxonomy", must be one of iab-qag, iptc-subjectcode'
|
|
212
235
|
end
|
|
@@ -216,13 +239,57 @@ module AylienNewsApi
|
|
|
216
239
|
if opts[:'sentiment_body_polarity'] && !['positive', 'neutral', 'negative'].include?(opts[:'sentiment_body_polarity'])
|
|
217
240
|
fail ArgumentError, 'invalid value for "sentiment_body_polarity", must be one of positive, neutral, negative'
|
|
218
241
|
end
|
|
242
|
+
if !opts[:'media_images_count_min'].nil? && opts[:'media_images_count_min'] < 0.0
|
|
243
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_min"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
if !opts[:'media_images_count_max'].nil? && opts[:'media_images_count_max'] < 0.0
|
|
247
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_max"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
if !opts[:'media_videos_count_min'].nil? && opts[:'media_videos_count_min'] < 0.0
|
|
251
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_min"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
if !opts[:'media_videos_count_max'].nil? && opts[:'media_videos_count_max'] < 0.0
|
|
255
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_max"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
if opts[:'source_scopes_level'] && !opts[:'source_scopes_level'].all?{|l| ['international', 'national', 'local'].include?(l)}
|
|
259
|
+
fail ArgumentError, 'invalid value for "source_scopes_level", must be one of international, national, local'
|
|
260
|
+
end
|
|
261
|
+
if !opts[:'source_links_in_count_min'].nil? && opts[:'source_links_in_count_min'] < 0.0
|
|
262
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_min"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
if !opts[:'source_links_in_count_max'].nil? && opts[:'source_links_in_count_max'] < 0.0
|
|
266
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_max"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
if !opts[:'source_rankings_alexa_rank_min'].nil? && opts[:'source_rankings_alexa_rank_min'] < 0.0
|
|
270
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_min"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
if !opts[:'source_rankings_alexa_rank_max'].nil? && opts[:'source_rankings_alexa_rank_max'] < 0.0
|
|
274
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_max"]" when calling DefaultApi.list_coverages, must be greater than or equal to 0.0.'
|
|
275
|
+
end
|
|
219
276
|
|
|
220
277
|
if opts[:'cluster_algorithm'] && !['stc', 'lingo', 'kmeans'].include?(opts[:'cluster_algorithm'])
|
|
221
278
|
fail ArgumentError, 'invalid value for "cluster_algorithm", must be one of stc, lingo, kmeans'
|
|
222
279
|
end
|
|
280
|
+
if opts[:'_return'] && !opts[:'_return'].all?{|l| ['id', 'title', 'body', 'summary', 'source', 'author', 'entities', 'keywords', 'hashtags', 'characters_count', 'words_count', 'sentences_count', 'paragraphs_count', 'categories', 'social_shares_count', 'media', 'sentiment', 'language', 'published_at', 'links'].include?(l)}
|
|
281
|
+
fail ArgumentError, 'invalid value for "_return", must be one of id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links'
|
|
282
|
+
end
|
|
223
283
|
if opts[:'story_language'] && !['auto', 'en', 'de', 'fr', 'it', 'es', 'pt'].include?(opts[:'story_language'])
|
|
224
284
|
fail ArgumentError, 'invalid value for "story_language", must be one of auto, en, de, fr, it, es, pt'
|
|
225
285
|
end
|
|
286
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] > 100.0
|
|
287
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_coverages, must be smaller than or equal to 100.0.'
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] < 1.0
|
|
291
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_coverages, must be greater than or equal to 1.0.'
|
|
292
|
+
end
|
|
226
293
|
|
|
227
294
|
# resource path
|
|
228
295
|
local_var_path = "/coverages".sub('{format}','json')
|
|
@@ -278,6 +345,11 @@ module AylienNewsApi
|
|
|
278
345
|
form_params["source.scopes.state[]"] = @api_client.build_collection_param(opts[:'source_scopes_state'], :multi) if !opts[:'source_scopes_state'].nil?
|
|
279
346
|
form_params["source.scopes.city[]"] = @api_client.build_collection_param(opts[:'source_scopes_city'], :multi) if !opts[:'source_scopes_city'].nil?
|
|
280
347
|
form_params["source.scopes.level[]"] = @api_client.build_collection_param(opts[:'source_scopes_level'], :multi) if !opts[:'source_scopes_level'].nil?
|
|
348
|
+
form_params["source.links_in_count.min"] = opts[:'source_links_in_count_min'] if !opts[:'source_links_in_count_min'].nil?
|
|
349
|
+
form_params["source.links_in_count.max"] = opts[:'source_links_in_count_max'] if !opts[:'source_links_in_count_max'].nil?
|
|
350
|
+
form_params["source.rankings.alexa.rank.min"] = opts[:'source_rankings_alexa_rank_min'] if !opts[:'source_rankings_alexa_rank_min'].nil?
|
|
351
|
+
form_params["source.rankings.alexa.rank.max"] = opts[:'source_rankings_alexa_rank_max'] if !opts[:'source_rankings_alexa_rank_max'].nil?
|
|
352
|
+
form_params["source.rankings.alexa.country[]"] = @api_client.build_collection_param(opts[:'source_rankings_alexa_country'], :multi) if !opts[:'source_rankings_alexa_country'].nil?
|
|
281
353
|
form_params["cluster"] = opts[:'cluster'] if !opts[:'cluster'].nil?
|
|
282
354
|
form_params["cluster.algorithm"] = opts[:'cluster_algorithm'] if !opts[:'cluster_algorithm'].nil?
|
|
283
355
|
form_params["return[]"] = @api_client.build_collection_param(opts[:'_return'], :multi) if !opts[:'_return'].nil?
|
|
@@ -343,6 +415,11 @@ module AylienNewsApi
|
|
|
343
415
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
344
416
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
345
417
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
418
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
419
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
420
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
421
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
422
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
346
423
|
# @option opts [Integer] :interval_start This parameter is used for setting the start data point of histogram intervals.
|
|
347
424
|
# @option opts [Integer] :interval_end This parameter is used for setting the end data point of histogram intervals.
|
|
348
425
|
# @option opts [Integer] :interval_width This parameter is used for setting the width of histogram intervals.
|
|
@@ -391,6 +468,11 @@ module AylienNewsApi
|
|
|
391
468
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
392
469
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
393
470
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
471
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
472
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
473
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
474
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
475
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
394
476
|
# @option opts [Integer] :interval_start This parameter is used for setting the start data point of histogram intervals.
|
|
395
477
|
# @option opts [Integer] :interval_end This parameter is used for setting the end data point of histogram intervals.
|
|
396
478
|
# @option opts [Integer] :interval_width This parameter is used for setting the width of histogram intervals.
|
|
@@ -400,6 +482,9 @@ module AylienNewsApi
|
|
|
400
482
|
if @api_client.config.debugging
|
|
401
483
|
@api_client.config.logger.debug "Calling API: DefaultApi.list_histograms ..."
|
|
402
484
|
end
|
|
485
|
+
if opts[:'language'] && !opts[:'language'].all?{|l| ['en', 'de', 'fr', 'it', 'es', 'pt'].include?(l)}
|
|
486
|
+
fail ArgumentError, 'invalid value for "language", must be one of en, de, fr, it, es, pt'
|
|
487
|
+
end
|
|
403
488
|
if opts[:'categories_taxonomy'] && !['iab-qag', 'iptc-subjectcode'].include?(opts[:'categories_taxonomy'])
|
|
404
489
|
fail ArgumentError, 'invalid value for "categories_taxonomy", must be one of iab-qag, iptc-subjectcode'
|
|
405
490
|
end
|
|
@@ -409,9 +494,43 @@ module AylienNewsApi
|
|
|
409
494
|
if opts[:'sentiment_body_polarity'] && !['positive', 'neutral', 'negative'].include?(opts[:'sentiment_body_polarity'])
|
|
410
495
|
fail ArgumentError, 'invalid value for "sentiment_body_polarity", must be one of positive, neutral, negative'
|
|
411
496
|
end
|
|
497
|
+
if !opts[:'media_images_count_min'].nil? && opts[:'media_images_count_min'] < 0.0
|
|
498
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_min"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
if !opts[:'media_images_count_max'].nil? && opts[:'media_images_count_max'] < 0.0
|
|
502
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_max"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
503
|
+
end
|
|
412
504
|
|
|
413
|
-
if opts[:'
|
|
414
|
-
fail ArgumentError, 'invalid value for "
|
|
505
|
+
if !opts[:'media_videos_count_min'].nil? && opts[:'media_videos_count_min'] < 0.0
|
|
506
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_min"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
507
|
+
end
|
|
508
|
+
|
|
509
|
+
if !opts[:'media_videos_count_max'].nil? && opts[:'media_videos_count_max'] < 0.0
|
|
510
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_max"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
511
|
+
end
|
|
512
|
+
|
|
513
|
+
if opts[:'source_scopes_level'] && !opts[:'source_scopes_level'].all?{|l| ['international', 'national', 'local'].include?(l)}
|
|
514
|
+
fail ArgumentError, 'invalid value for "source_scopes_level", must be one of international, national, local'
|
|
515
|
+
end
|
|
516
|
+
if !opts[:'source_links_in_count_min'].nil? && opts[:'source_links_in_count_min'] < 0.0
|
|
517
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_min"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
518
|
+
end
|
|
519
|
+
|
|
520
|
+
if !opts[:'source_links_in_count_max'].nil? && opts[:'source_links_in_count_max'] < 0.0
|
|
521
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_max"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
522
|
+
end
|
|
523
|
+
|
|
524
|
+
if !opts[:'source_rankings_alexa_rank_min'].nil? && opts[:'source_rankings_alexa_rank_min'] < 0.0
|
|
525
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_min"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
526
|
+
end
|
|
527
|
+
|
|
528
|
+
if !opts[:'source_rankings_alexa_rank_max'].nil? && opts[:'source_rankings_alexa_rank_max'] < 0.0
|
|
529
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_max"]" when calling DefaultApi.list_histograms, must be greater than or equal to 0.0.'
|
|
530
|
+
end
|
|
531
|
+
|
|
532
|
+
if opts[:'field'] && !['social_shares_count', 'social_shares_count.facebook', 'social_shares_count.linkedin', 'social_shares_count.reddit', 'social_shares_count.google_plus', 'characters_count', 'words_count', 'sentences_count', 'paragraphs_count', 'media.images.count', 'media.videos.count', 'source.links_in_count', 'source.rankings.alexa.rank', 'source.rankings.alexa.rank.AF', 'source.rankings.alexa.rank.AX', 'source.rankings.alexa.rank.AL', 'source.rankings.alexa.rank.DZ', 'source.rankings.alexa.rank.AS', 'source.rankings.alexa.rank.AD', 'source.rankings.alexa.rank.AO', 'source.rankings.alexa.rank.AI', 'source.rankings.alexa.rank.AQ', 'source.rankings.alexa.rank.AG', 'source.rankings.alexa.rank.AR', 'source.rankings.alexa.rank.AM', 'source.rankings.alexa.rank.AW', 'source.rankings.alexa.rank.AU', 'source.rankings.alexa.rank.AT', 'source.rankings.alexa.rank.AZ', 'source.rankings.alexa.rank.BS', 'source.rankings.alexa.rank.BH', 'source.rankings.alexa.rank.BD', 'source.rankings.alexa.rank.BB', 'source.rankings.alexa.rank.BY', 'source.rankings.alexa.rank.BE', 'source.rankings.alexa.rank.BZ', 'source.rankings.alexa.rank.BJ', 'source.rankings.alexa.rank.BM', 'source.rankings.alexa.rank.BT', 'source.rankings.alexa.rank.BO', 'source.rankings.alexa.rank.BQ', 'source.rankings.alexa.rank.BA', 'source.rankings.alexa.rank.BW', 'source.rankings.alexa.rank.BV', 'source.rankings.alexa.rank.BR', 'source.rankings.alexa.rank.IO', 'source.rankings.alexa.rank.BN', 'source.rankings.alexa.rank.BG', 'source.rankings.alexa.rank.BF', 'source.rankings.alexa.rank.BI', 'source.rankings.alexa.rank.KH', 'source.rankings.alexa.rank.CM', 'source.rankings.alexa.rank.CA', 'source.rankings.alexa.rank.CV', 'source.rankings.alexa.rank.KY', 'source.rankings.alexa.rank.CF', 'source.rankings.alexa.rank.TD', 'source.rankings.alexa.rank.CL', 'source.rankings.alexa.rank.CN', 'source.rankings.alexa.rank.CX', 'source.rankings.alexa.rank.CC', 'source.rankings.alexa.rank.CO', 'source.rankings.alexa.rank.KM', 'source.rankings.alexa.rank.CG', 'source.rankings.alexa.rank.CD', 'source.rankings.alexa.rank.CK', 'source.rankings.alexa.rank.CR', 'source.rankings.alexa.rank.CI', 'source.rankings.alexa.rank.HR', 'source.rankings.alexa.rank.CU', 'source.rankings.alexa.rank.CW', 'source.rankings.alexa.rank.CY', 'source.rankings.alexa.rank.CZ', 'source.rankings.alexa.rank.DK', 'source.rankings.alexa.rank.DJ', 'source.rankings.alexa.rank.DM', 'source.rankings.alexa.rank.DO', 'source.rankings.alexa.rank.EC', 'source.rankings.alexa.rank.EG', 'source.rankings.alexa.rank.SV', 'source.rankings.alexa.rank.GQ', 'source.rankings.alexa.rank.ER', 'source.rankings.alexa.rank.EE', 'source.rankings.alexa.rank.ET', 'source.rankings.alexa.rank.FK', 'source.rankings.alexa.rank.FO', 'source.rankings.alexa.rank.FJ', 'source.rankings.alexa.rank.FI', 'source.rankings.alexa.rank.FR', 'source.rankings.alexa.rank.GF', 'source.rankings.alexa.rank.PF', 'source.rankings.alexa.rank.TF', 'source.rankings.alexa.rank.GA', 'source.rankings.alexa.rank.GM', 'source.rankings.alexa.rank.GE', 'source.rankings.alexa.rank.DE', 'source.rankings.alexa.rank.GH', 'source.rankings.alexa.rank.GI', 'source.rankings.alexa.rank.GR', 'source.rankings.alexa.rank.GL', 'source.rankings.alexa.rank.GD', 'source.rankings.alexa.rank.GP', 'source.rankings.alexa.rank.GU', 'source.rankings.alexa.rank.GT', 'source.rankings.alexa.rank.GG', 'source.rankings.alexa.rank.GN', 'source.rankings.alexa.rank.GW', 'source.rankings.alexa.rank.GY', 'source.rankings.alexa.rank.HT', 'source.rankings.alexa.rank.HM', 'source.rankings.alexa.rank.VA', 'source.rankings.alexa.rank.HN', 'source.rankings.alexa.rank.HK', 'source.rankings.alexa.rank.HU', 'source.rankings.alexa.rank.IS', 'source.rankings.alexa.rank.IN', 'source.rankings.alexa.rank.ID', 'source.rankings.alexa.rank.IR', 'source.rankings.alexa.rank.IQ', 'source.rankings.alexa.rank.IE', 'source.rankings.alexa.rank.IM', 'source.rankings.alexa.rank.IL', 'source.rankings.alexa.rank.IT', 'source.rankings.alexa.rank.JM', 'source.rankings.alexa.rank.JP', 'source.rankings.alexa.rank.JE', 'source.rankings.alexa.rank.JO', 'source.rankings.alexa.rank.KZ', 'source.rankings.alexa.rank.KE', 'source.rankings.alexa.rank.KI', 'source.rankings.alexa.rank.KP', 'source.rankings.alexa.rank.KR', 'source.rankings.alexa.rank.KW', 'source.rankings.alexa.rank.KG', 'source.rankings.alexa.rank.LA', 'source.rankings.alexa.rank.LV', 'source.rankings.alexa.rank.LB', 'source.rankings.alexa.rank.LS', 'source.rankings.alexa.rank.LR', 'source.rankings.alexa.rank.LY', 'source.rankings.alexa.rank.LI', 'source.rankings.alexa.rank.LT', 'source.rankings.alexa.rank.LU', 'source.rankings.alexa.rank.MO', 'source.rankings.alexa.rank.MK', 'source.rankings.alexa.rank.MG', 'source.rankings.alexa.rank.MW', 'source.rankings.alexa.rank.MY', 'source.rankings.alexa.rank.MV', 'source.rankings.alexa.rank.ML', 'source.rankings.alexa.rank.MT', 'source.rankings.alexa.rank.MH', 'source.rankings.alexa.rank.MQ', 'source.rankings.alexa.rank.MR', 'source.rankings.alexa.rank.MU', 'source.rankings.alexa.rank.YT', 'source.rankings.alexa.rank.MX', 'source.rankings.alexa.rank.FM', 'source.rankings.alexa.rank.MD', 'source.rankings.alexa.rank.MC', 'source.rankings.alexa.rank.MN', 'source.rankings.alexa.rank.ME', 'source.rankings.alexa.rank.MS', 'source.rankings.alexa.rank.MA', 'source.rankings.alexa.rank.MZ', 'source.rankings.alexa.rank.MM', 'source.rankings.alexa.rank.NA', 'source.rankings.alexa.rank.NR', 'source.rankings.alexa.rank.NP', 'source.rankings.alexa.rank.NL', 'source.rankings.alexa.rank.NC', 'source.rankings.alexa.rank.NZ', 'source.rankings.alexa.rank.NI', 'source.rankings.alexa.rank.NE', 'source.rankings.alexa.rank.NG', 'source.rankings.alexa.rank.NU', 'source.rankings.alexa.rank.NF', 'source.rankings.alexa.rank.MP', 'source.rankings.alexa.rank.NO', 'source.rankings.alexa.rank.OM', 'source.rankings.alexa.rank.PK', 'source.rankings.alexa.rank.PW', 'source.rankings.alexa.rank.PS', 'source.rankings.alexa.rank.PA', 'source.rankings.alexa.rank.PG', 'source.rankings.alexa.rank.PY', 'source.rankings.alexa.rank.PE', 'source.rankings.alexa.rank.PH', 'source.rankings.alexa.rank.PN', 'source.rankings.alexa.rank.PL', 'source.rankings.alexa.rank.PT', 'source.rankings.alexa.rank.PR', 'source.rankings.alexa.rank.QA', 'source.rankings.alexa.rank.RE', 'source.rankings.alexa.rank.RO', 'source.rankings.alexa.rank.RU', 'source.rankings.alexa.rank.RW', 'source.rankings.alexa.rank.BL', 'source.rankings.alexa.rank.SH', 'source.rankings.alexa.rank.KN', 'source.rankings.alexa.rank.LC', 'source.rankings.alexa.rank.MF', 'source.rankings.alexa.rank.PM', 'source.rankings.alexa.rank.VC', 'source.rankings.alexa.rank.WS', 'source.rankings.alexa.rank.SM', 'source.rankings.alexa.rank.ST', 'source.rankings.alexa.rank.SA', 'source.rankings.alexa.rank.SN', 'source.rankings.alexa.rank.RS', 'source.rankings.alexa.rank.SC', 'source.rankings.alexa.rank.SL', 'source.rankings.alexa.rank.SG', 'source.rankings.alexa.rank.SX', 'source.rankings.alexa.rank.SK', 'source.rankings.alexa.rank.SI', 'source.rankings.alexa.rank.SB', 'source.rankings.alexa.rank.SO', 'source.rankings.alexa.rank.ZA', 'source.rankings.alexa.rank.GS', 'source.rankings.alexa.rank.SS', 'source.rankings.alexa.rank.ES', 'source.rankings.alexa.rank.LK', 'source.rankings.alexa.rank.SD', 'source.rankings.alexa.rank.SR', 'source.rankings.alexa.rank.SJ', 'source.rankings.alexa.rank.SZ', 'source.rankings.alexa.rank.SE', 'source.rankings.alexa.rank.CH', 'source.rankings.alexa.rank.SY', 'source.rankings.alexa.rank.TW', 'source.rankings.alexa.rank.TJ', 'source.rankings.alexa.rank.TZ', 'source.rankings.alexa.rank.TH', 'source.rankings.alexa.rank.TL', 'source.rankings.alexa.rank.TG', 'source.rankings.alexa.rank.TK', 'source.rankings.alexa.rank.TO', 'source.rankings.alexa.rank.TT', 'source.rankings.alexa.rank.TN', 'source.rankings.alexa.rank.TR', 'source.rankings.alexa.rank.TM', 'source.rankings.alexa.rank.TC', 'source.rankings.alexa.rank.TV', 'source.rankings.alexa.rank.UG', 'source.rankings.alexa.rank.UA', 'source.rankings.alexa.rank.AE', 'source.rankings.alexa.rank.GB', 'source.rankings.alexa.rank.US', 'source.rankings.alexa.rank.UM', 'source.rankings.alexa.rank.UY', 'source.rankings.alexa.rank.UZ', 'source.rankings.alexa.rank.VU', 'source.rankings.alexa.rank.VE', 'source.rankings.alexa.rank.VN', 'source.rankings.alexa.rank.VG', 'source.rankings.alexa.rank.VI', 'source.rankings.alexa.rank.WF', 'source.rankings.alexa.rank.EH', 'source.rankings.alexa.rank.YE', 'source.rankings.alexa.rank.ZM', 'source.rankings.alexa.rank.ZW'].include?(opts[:'field'])
|
|
533
|
+
fail ArgumentError, 'invalid value for "field", must be one of social_shares_count, social_shares_count.facebook, social_shares_count.linkedin, social_shares_count.reddit, social_shares_count.google_plus, characters_count, words_count, sentences_count, paragraphs_count, media.images.count, media.videos.count, source.links_in_count, source.rankings.alexa.rank, source.rankings.alexa.rank.AF, source.rankings.alexa.rank.AX, source.rankings.alexa.rank.AL, source.rankings.alexa.rank.DZ, source.rankings.alexa.rank.AS, source.rankings.alexa.rank.AD, source.rankings.alexa.rank.AO, source.rankings.alexa.rank.AI, source.rankings.alexa.rank.AQ, source.rankings.alexa.rank.AG, source.rankings.alexa.rank.AR, source.rankings.alexa.rank.AM, source.rankings.alexa.rank.AW, source.rankings.alexa.rank.AU, source.rankings.alexa.rank.AT, source.rankings.alexa.rank.AZ, source.rankings.alexa.rank.BS, source.rankings.alexa.rank.BH, source.rankings.alexa.rank.BD, source.rankings.alexa.rank.BB, source.rankings.alexa.rank.BY, source.rankings.alexa.rank.BE, source.rankings.alexa.rank.BZ, source.rankings.alexa.rank.BJ, source.rankings.alexa.rank.BM, source.rankings.alexa.rank.BT, source.rankings.alexa.rank.BO, source.rankings.alexa.rank.BQ, source.rankings.alexa.rank.BA, source.rankings.alexa.rank.BW, source.rankings.alexa.rank.BV, source.rankings.alexa.rank.BR, source.rankings.alexa.rank.IO, source.rankings.alexa.rank.BN, source.rankings.alexa.rank.BG, source.rankings.alexa.rank.BF, source.rankings.alexa.rank.BI, source.rankings.alexa.rank.KH, source.rankings.alexa.rank.CM, source.rankings.alexa.rank.CA, source.rankings.alexa.rank.CV, source.rankings.alexa.rank.KY, source.rankings.alexa.rank.CF, source.rankings.alexa.rank.TD, source.rankings.alexa.rank.CL, source.rankings.alexa.rank.CN, source.rankings.alexa.rank.CX, source.rankings.alexa.rank.CC, source.rankings.alexa.rank.CO, source.rankings.alexa.rank.KM, source.rankings.alexa.rank.CG, source.rankings.alexa.rank.CD, source.rankings.alexa.rank.CK, source.rankings.alexa.rank.CR, source.rankings.alexa.rank.CI, source.rankings.alexa.rank.HR, source.rankings.alexa.rank.CU, source.rankings.alexa.rank.CW, source.rankings.alexa.rank.CY, source.rankings.alexa.rank.CZ, source.rankings.alexa.rank.DK, source.rankings.alexa.rank.DJ, source.rankings.alexa.rank.DM, source.rankings.alexa.rank.DO, source.rankings.alexa.rank.EC, source.rankings.alexa.rank.EG, source.rankings.alexa.rank.SV, source.rankings.alexa.rank.GQ, source.rankings.alexa.rank.ER, source.rankings.alexa.rank.EE, source.rankings.alexa.rank.ET, source.rankings.alexa.rank.FK, source.rankings.alexa.rank.FO, source.rankings.alexa.rank.FJ, source.rankings.alexa.rank.FI, source.rankings.alexa.rank.FR, source.rankings.alexa.rank.GF, source.rankings.alexa.rank.PF, source.rankings.alexa.rank.TF, source.rankings.alexa.rank.GA, source.rankings.alexa.rank.GM, source.rankings.alexa.rank.GE, source.rankings.alexa.rank.DE, source.rankings.alexa.rank.GH, source.rankings.alexa.rank.GI, source.rankings.alexa.rank.GR, source.rankings.alexa.rank.GL, source.rankings.alexa.rank.GD, source.rankings.alexa.rank.GP, source.rankings.alexa.rank.GU, source.rankings.alexa.rank.GT, source.rankings.alexa.rank.GG, source.rankings.alexa.rank.GN, source.rankings.alexa.rank.GW, source.rankings.alexa.rank.GY, source.rankings.alexa.rank.HT, source.rankings.alexa.rank.HM, source.rankings.alexa.rank.VA, source.rankings.alexa.rank.HN, source.rankings.alexa.rank.HK, source.rankings.alexa.rank.HU, source.rankings.alexa.rank.IS, source.rankings.alexa.rank.IN, source.rankings.alexa.rank.ID, source.rankings.alexa.rank.IR, source.rankings.alexa.rank.IQ, source.rankings.alexa.rank.IE, source.rankings.alexa.rank.IM, source.rankings.alexa.rank.IL, source.rankings.alexa.rank.IT, source.rankings.alexa.rank.JM, source.rankings.alexa.rank.JP, source.rankings.alexa.rank.JE, source.rankings.alexa.rank.JO, source.rankings.alexa.rank.KZ, source.rankings.alexa.rank.KE, source.rankings.alexa.rank.KI, source.rankings.alexa.rank.KP, source.rankings.alexa.rank.KR, source.rankings.alexa.rank.KW, source.rankings.alexa.rank.KG, source.rankings.alexa.rank.LA, source.rankings.alexa.rank.LV, source.rankings.alexa.rank.LB, source.rankings.alexa.rank.LS, source.rankings.alexa.rank.LR, source.rankings.alexa.rank.LY, source.rankings.alexa.rank.LI, source.rankings.alexa.rank.LT, source.rankings.alexa.rank.LU, source.rankings.alexa.rank.MO, source.rankings.alexa.rank.MK, source.rankings.alexa.rank.MG, source.rankings.alexa.rank.MW, source.rankings.alexa.rank.MY, source.rankings.alexa.rank.MV, source.rankings.alexa.rank.ML, source.rankings.alexa.rank.MT, source.rankings.alexa.rank.MH, source.rankings.alexa.rank.MQ, source.rankings.alexa.rank.MR, source.rankings.alexa.rank.MU, source.rankings.alexa.rank.YT, source.rankings.alexa.rank.MX, source.rankings.alexa.rank.FM, source.rankings.alexa.rank.MD, source.rankings.alexa.rank.MC, source.rankings.alexa.rank.MN, source.rankings.alexa.rank.ME, source.rankings.alexa.rank.MS, source.rankings.alexa.rank.MA, source.rankings.alexa.rank.MZ, source.rankings.alexa.rank.MM, source.rankings.alexa.rank.NA, source.rankings.alexa.rank.NR, source.rankings.alexa.rank.NP, source.rankings.alexa.rank.NL, source.rankings.alexa.rank.NC, source.rankings.alexa.rank.NZ, source.rankings.alexa.rank.NI, source.rankings.alexa.rank.NE, source.rankings.alexa.rank.NG, source.rankings.alexa.rank.NU, source.rankings.alexa.rank.NF, source.rankings.alexa.rank.MP, source.rankings.alexa.rank.NO, source.rankings.alexa.rank.OM, source.rankings.alexa.rank.PK, source.rankings.alexa.rank.PW, source.rankings.alexa.rank.PS, source.rankings.alexa.rank.PA, source.rankings.alexa.rank.PG, source.rankings.alexa.rank.PY, source.rankings.alexa.rank.PE, source.rankings.alexa.rank.PH, source.rankings.alexa.rank.PN, source.rankings.alexa.rank.PL, source.rankings.alexa.rank.PT, source.rankings.alexa.rank.PR, source.rankings.alexa.rank.QA, source.rankings.alexa.rank.RE, source.rankings.alexa.rank.RO, source.rankings.alexa.rank.RU, source.rankings.alexa.rank.RW, source.rankings.alexa.rank.BL, source.rankings.alexa.rank.SH, source.rankings.alexa.rank.KN, source.rankings.alexa.rank.LC, source.rankings.alexa.rank.MF, source.rankings.alexa.rank.PM, source.rankings.alexa.rank.VC, source.rankings.alexa.rank.WS, source.rankings.alexa.rank.SM, source.rankings.alexa.rank.ST, source.rankings.alexa.rank.SA, source.rankings.alexa.rank.SN, source.rankings.alexa.rank.RS, source.rankings.alexa.rank.SC, source.rankings.alexa.rank.SL, source.rankings.alexa.rank.SG, source.rankings.alexa.rank.SX, source.rankings.alexa.rank.SK, source.rankings.alexa.rank.SI, source.rankings.alexa.rank.SB, source.rankings.alexa.rank.SO, source.rankings.alexa.rank.ZA, source.rankings.alexa.rank.GS, source.rankings.alexa.rank.SS, source.rankings.alexa.rank.ES, source.rankings.alexa.rank.LK, source.rankings.alexa.rank.SD, source.rankings.alexa.rank.SR, source.rankings.alexa.rank.SJ, source.rankings.alexa.rank.SZ, source.rankings.alexa.rank.SE, source.rankings.alexa.rank.CH, source.rankings.alexa.rank.SY, source.rankings.alexa.rank.TW, source.rankings.alexa.rank.TJ, source.rankings.alexa.rank.TZ, source.rankings.alexa.rank.TH, source.rankings.alexa.rank.TL, source.rankings.alexa.rank.TG, source.rankings.alexa.rank.TK, source.rankings.alexa.rank.TO, source.rankings.alexa.rank.TT, source.rankings.alexa.rank.TN, source.rankings.alexa.rank.TR, source.rankings.alexa.rank.TM, source.rankings.alexa.rank.TC, source.rankings.alexa.rank.TV, source.rankings.alexa.rank.UG, source.rankings.alexa.rank.UA, source.rankings.alexa.rank.AE, source.rankings.alexa.rank.GB, source.rankings.alexa.rank.US, source.rankings.alexa.rank.UM, source.rankings.alexa.rank.UY, source.rankings.alexa.rank.UZ, source.rankings.alexa.rank.VU, source.rankings.alexa.rank.VE, source.rankings.alexa.rank.VN, source.rankings.alexa.rank.VG, source.rankings.alexa.rank.VI, source.rankings.alexa.rank.WF, source.rankings.alexa.rank.EH, source.rankings.alexa.rank.YE, source.rankings.alexa.rank.ZM, source.rankings.alexa.rank.ZW'
|
|
415
534
|
end
|
|
416
535
|
# resource path
|
|
417
536
|
local_var_path = "/histograms".sub('{format}','json')
|
|
@@ -453,6 +572,11 @@ module AylienNewsApi
|
|
|
453
572
|
query_params[:'source.scopes.state[]'] = @api_client.build_collection_param(opts[:'source_scopes_state'], :multi) if !opts[:'source_scopes_state'].nil?
|
|
454
573
|
query_params[:'source.scopes.city[]'] = @api_client.build_collection_param(opts[:'source_scopes_city'], :multi) if !opts[:'source_scopes_city'].nil?
|
|
455
574
|
query_params[:'source.scopes.level[]'] = @api_client.build_collection_param(opts[:'source_scopes_level'], :multi) if !opts[:'source_scopes_level'].nil?
|
|
575
|
+
query_params[:'source.links_in_count.min'] = opts[:'source_links_in_count_min'] if !opts[:'source_links_in_count_min'].nil?
|
|
576
|
+
query_params[:'source.links_in_count.max'] = opts[:'source_links_in_count_max'] if !opts[:'source_links_in_count_max'].nil?
|
|
577
|
+
query_params[:'source.rankings.alexa.rank.min'] = opts[:'source_rankings_alexa_rank_min'] if !opts[:'source_rankings_alexa_rank_min'].nil?
|
|
578
|
+
query_params[:'source.rankings.alexa.rank.max'] = opts[:'source_rankings_alexa_rank_max'] if !opts[:'source_rankings_alexa_rank_max'].nil?
|
|
579
|
+
query_params[:'source.rankings.alexa.country[]'] = @api_client.build_collection_param(opts[:'source_rankings_alexa_country'], :multi) if !opts[:'source_rankings_alexa_country'].nil?
|
|
456
580
|
query_params[:'interval.start'] = opts[:'interval_start'] if !opts[:'interval_start'].nil?
|
|
457
581
|
query_params[:'interval.end'] = opts[:'interval_end'] if !opts[:'interval_end'].nil?
|
|
458
582
|
query_params[:'interval.width'] = opts[:'interval_width'] if !opts[:'interval_width'].nil?
|
|
@@ -526,6 +650,11 @@ module AylienNewsApi
|
|
|
526
650
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
527
651
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
528
652
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
653
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
654
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
655
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
656
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
657
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
529
658
|
# @option opts [BOOLEAN] :cluster This parameter enables clustering for the returned stories. (default to false)
|
|
530
659
|
# @option opts [String] :cluster_algorithm This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. (default to lingo)
|
|
531
660
|
# @option opts [Array<String>] :_return This parameter is used for specifying return fields.
|
|
@@ -580,6 +709,11 @@ module AylienNewsApi
|
|
|
580
709
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
581
710
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
582
711
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
712
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
713
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
714
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
715
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
716
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
583
717
|
# @option opts [BOOLEAN] :cluster This parameter enables clustering for the returned stories.
|
|
584
718
|
# @option opts [String] :cluster_algorithm This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
|
|
585
719
|
# @option opts [Array<String>] :_return This parameter is used for specifying return fields.
|
|
@@ -595,6 +729,9 @@ module AylienNewsApi
|
|
|
595
729
|
if @api_client.config.debugging
|
|
596
730
|
@api_client.config.logger.debug "Calling API: DefaultApi.list_related_stories ..."
|
|
597
731
|
end
|
|
732
|
+
if opts[:'language'] && !opts[:'language'].all?{|l| ['en', 'de', 'fr', 'it', 'es', 'pt'].include?(l)}
|
|
733
|
+
fail ArgumentError, 'invalid value for "language", must be one of en, de, fr, it, es, pt'
|
|
734
|
+
end
|
|
598
735
|
if opts[:'categories_taxonomy'] && !['iab-qag', 'iptc-subjectcode'].include?(opts[:'categories_taxonomy'])
|
|
599
736
|
fail ArgumentError, 'invalid value for "categories_taxonomy", must be one of iab-qag, iptc-subjectcode'
|
|
600
737
|
end
|
|
@@ -604,16 +741,60 @@ module AylienNewsApi
|
|
|
604
741
|
if opts[:'sentiment_body_polarity'] && !['positive', 'neutral', 'negative'].include?(opts[:'sentiment_body_polarity'])
|
|
605
742
|
fail ArgumentError, 'invalid value for "sentiment_body_polarity", must be one of positive, neutral, negative'
|
|
606
743
|
end
|
|
744
|
+
if !opts[:'media_images_count_min'].nil? && opts[:'media_images_count_min'] < 0.0
|
|
745
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_min"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
746
|
+
end
|
|
747
|
+
|
|
748
|
+
if !opts[:'media_images_count_max'].nil? && opts[:'media_images_count_max'] < 0.0
|
|
749
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_max"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
750
|
+
end
|
|
751
|
+
|
|
752
|
+
if !opts[:'media_videos_count_min'].nil? && opts[:'media_videos_count_min'] < 0.0
|
|
753
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_min"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
754
|
+
end
|
|
755
|
+
|
|
756
|
+
if !opts[:'media_videos_count_max'].nil? && opts[:'media_videos_count_max'] < 0.0
|
|
757
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_max"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
758
|
+
end
|
|
759
|
+
|
|
760
|
+
if opts[:'source_scopes_level'] && !opts[:'source_scopes_level'].all?{|l| ['international', 'national', 'local'].include?(l)}
|
|
761
|
+
fail ArgumentError, 'invalid value for "source_scopes_level", must be one of international, national, local'
|
|
762
|
+
end
|
|
763
|
+
if !opts[:'source_links_in_count_min'].nil? && opts[:'source_links_in_count_min'] < 0.0
|
|
764
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_min"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
765
|
+
end
|
|
766
|
+
|
|
767
|
+
if !opts[:'source_links_in_count_max'].nil? && opts[:'source_links_in_count_max'] < 0.0
|
|
768
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_max"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
769
|
+
end
|
|
770
|
+
|
|
771
|
+
if !opts[:'source_rankings_alexa_rank_min'].nil? && opts[:'source_rankings_alexa_rank_min'] < 0.0
|
|
772
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_min"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
773
|
+
end
|
|
774
|
+
|
|
775
|
+
if !opts[:'source_rankings_alexa_rank_max'].nil? && opts[:'source_rankings_alexa_rank_max'] < 0.0
|
|
776
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_max"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 0.0.'
|
|
777
|
+
end
|
|
607
778
|
|
|
608
779
|
if opts[:'cluster_algorithm'] && !['stc', 'lingo', 'kmeans'].include?(opts[:'cluster_algorithm'])
|
|
609
780
|
fail ArgumentError, 'invalid value for "cluster_algorithm", must be one of stc, lingo, kmeans'
|
|
610
781
|
end
|
|
782
|
+
if opts[:'_return'] && !opts[:'_return'].all?{|l| ['id', 'title', 'body', 'summary', 'source', 'author', 'entities', 'keywords', 'hashtags', 'characters_count', 'words_count', 'sentences_count', 'paragraphs_count', 'categories', 'social_shares_count', 'media', 'sentiment', 'language', 'published_at', 'links'].include?(l)}
|
|
783
|
+
fail ArgumentError, 'invalid value for "_return", must be one of id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links'
|
|
784
|
+
end
|
|
611
785
|
if opts[:'boost_by'] && !['recency', 'popularity'].include?(opts[:'boost_by'])
|
|
612
786
|
fail ArgumentError, 'invalid value for "boost_by", must be one of recency, popularity'
|
|
613
787
|
end
|
|
614
788
|
if opts[:'story_language'] && !['auto', 'en', 'de', 'fr', 'it', 'es', 'pt'].include?(opts[:'story_language'])
|
|
615
789
|
fail ArgumentError, 'invalid value for "story_language", must be one of auto, en, de, fr, it, es, pt'
|
|
616
790
|
end
|
|
791
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] > 100.0
|
|
792
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_related_stories, must be smaller than or equal to 100.0.'
|
|
793
|
+
end
|
|
794
|
+
|
|
795
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] < 1.0
|
|
796
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_related_stories, must be greater than or equal to 1.0.'
|
|
797
|
+
end
|
|
617
798
|
|
|
618
799
|
# resource path
|
|
619
800
|
local_var_path = "/related_stories".sub('{format}','json')
|
|
@@ -669,6 +850,11 @@ module AylienNewsApi
|
|
|
669
850
|
form_params["source.scopes.state[]"] = @api_client.build_collection_param(opts[:'source_scopes_state'], :multi) if !opts[:'source_scopes_state'].nil?
|
|
670
851
|
form_params["source.scopes.city[]"] = @api_client.build_collection_param(opts[:'source_scopes_city'], :multi) if !opts[:'source_scopes_city'].nil?
|
|
671
852
|
form_params["source.scopes.level[]"] = @api_client.build_collection_param(opts[:'source_scopes_level'], :multi) if !opts[:'source_scopes_level'].nil?
|
|
853
|
+
form_params["source.links_in_count.min"] = opts[:'source_links_in_count_min'] if !opts[:'source_links_in_count_min'].nil?
|
|
854
|
+
form_params["source.links_in_count.max"] = opts[:'source_links_in_count_max'] if !opts[:'source_links_in_count_max'].nil?
|
|
855
|
+
form_params["source.rankings.alexa.rank.min"] = opts[:'source_rankings_alexa_rank_min'] if !opts[:'source_rankings_alexa_rank_min'].nil?
|
|
856
|
+
form_params["source.rankings.alexa.rank.max"] = opts[:'source_rankings_alexa_rank_max'] if !opts[:'source_rankings_alexa_rank_max'].nil?
|
|
857
|
+
form_params["source.rankings.alexa.country[]"] = @api_client.build_collection_param(opts[:'source_rankings_alexa_country'], :multi) if !opts[:'source_rankings_alexa_country'].nil?
|
|
672
858
|
form_params["cluster"] = opts[:'cluster'] if !opts[:'cluster'].nil?
|
|
673
859
|
form_params["cluster.algorithm"] = opts[:'cluster_algorithm'] if !opts[:'cluster_algorithm'].nil?
|
|
674
860
|
form_params["return[]"] = @api_client.build_collection_param(opts[:'_return'], :multi) if !opts[:'_return'].nil?
|
|
@@ -734,6 +920,11 @@ module AylienNewsApi
|
|
|
734
920
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
735
921
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
736
922
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
923
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
924
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
925
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
926
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
927
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
737
928
|
# @option opts [BOOLEAN] :cluster This parameter enables clustering for the returned stories. (default to false)
|
|
738
929
|
# @option opts [String] :cluster_algorithm This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. (default to lingo)
|
|
739
930
|
# @option opts [Array<String>] :_return This parameter is used for specifying return fields.
|
|
@@ -785,6 +976,11 @@ module AylienNewsApi
|
|
|
785
976
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
786
977
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
787
978
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
979
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
980
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
981
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
982
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
983
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
788
984
|
# @option opts [BOOLEAN] :cluster This parameter enables clustering for the returned stories.
|
|
789
985
|
# @option opts [String] :cluster_algorithm This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
|
|
790
986
|
# @option opts [Array<String>] :_return This parameter is used for specifying return fields.
|
|
@@ -797,6 +993,9 @@ module AylienNewsApi
|
|
|
797
993
|
if @api_client.config.debugging
|
|
798
994
|
@api_client.config.logger.debug "Calling API: DefaultApi.list_stories ..."
|
|
799
995
|
end
|
|
996
|
+
if opts[:'language'] && !opts[:'language'].all?{|l| ['en', 'de', 'fr', 'it', 'es', 'pt'].include?(l)}
|
|
997
|
+
fail ArgumentError, 'invalid value for "language", must be one of en, de, fr, it, es, pt'
|
|
998
|
+
end
|
|
800
999
|
if opts[:'categories_taxonomy'] && !['iab-qag', 'iptc-subjectcode'].include?(opts[:'categories_taxonomy'])
|
|
801
1000
|
fail ArgumentError, 'invalid value for "categories_taxonomy", must be one of iab-qag, iptc-subjectcode'
|
|
802
1001
|
end
|
|
@@ -806,16 +1005,60 @@ module AylienNewsApi
|
|
|
806
1005
|
if opts[:'sentiment_body_polarity'] && !['positive', 'neutral', 'negative'].include?(opts[:'sentiment_body_polarity'])
|
|
807
1006
|
fail ArgumentError, 'invalid value for "sentiment_body_polarity", must be one of positive, neutral, negative'
|
|
808
1007
|
end
|
|
1008
|
+
if !opts[:'media_images_count_min'].nil? && opts[:'media_images_count_min'] < 0.0
|
|
1009
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_min"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1010
|
+
end
|
|
1011
|
+
|
|
1012
|
+
if !opts[:'media_images_count_max'].nil? && opts[:'media_images_count_max'] < 0.0
|
|
1013
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_max"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1014
|
+
end
|
|
1015
|
+
|
|
1016
|
+
if !opts[:'media_videos_count_min'].nil? && opts[:'media_videos_count_min'] < 0.0
|
|
1017
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_min"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1018
|
+
end
|
|
1019
|
+
|
|
1020
|
+
if !opts[:'media_videos_count_max'].nil? && opts[:'media_videos_count_max'] < 0.0
|
|
1021
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_max"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1022
|
+
end
|
|
1023
|
+
|
|
1024
|
+
if opts[:'source_scopes_level'] && !opts[:'source_scopes_level'].all?{|l| ['international', 'national', 'local'].include?(l)}
|
|
1025
|
+
fail ArgumentError, 'invalid value for "source_scopes_level", must be one of international, national, local'
|
|
1026
|
+
end
|
|
1027
|
+
if !opts[:'source_links_in_count_min'].nil? && opts[:'source_links_in_count_min'] < 0.0
|
|
1028
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_min"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1029
|
+
end
|
|
1030
|
+
|
|
1031
|
+
if !opts[:'source_links_in_count_max'].nil? && opts[:'source_links_in_count_max'] < 0.0
|
|
1032
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_max"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1033
|
+
end
|
|
1034
|
+
|
|
1035
|
+
if !opts[:'source_rankings_alexa_rank_min'].nil? && opts[:'source_rankings_alexa_rank_min'] < 0.0
|
|
1036
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_min"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1037
|
+
end
|
|
1038
|
+
|
|
1039
|
+
if !opts[:'source_rankings_alexa_rank_max'].nil? && opts[:'source_rankings_alexa_rank_max'] < 0.0
|
|
1040
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_max"]" when calling DefaultApi.list_stories, must be greater than or equal to 0.0.'
|
|
1041
|
+
end
|
|
809
1042
|
|
|
810
1043
|
if opts[:'cluster_algorithm'] && !['stc', 'lingo', 'kmeans'].include?(opts[:'cluster_algorithm'])
|
|
811
1044
|
fail ArgumentError, 'invalid value for "cluster_algorithm", must be one of stc, lingo, kmeans'
|
|
812
1045
|
end
|
|
813
|
-
if opts[:'
|
|
814
|
-
fail ArgumentError, 'invalid value for "
|
|
1046
|
+
if opts[:'_return'] && !opts[:'_return'].all?{|l| ['id', 'title', 'body', 'summary', 'source', 'author', 'entities', 'keywords', 'hashtags', 'characters_count', 'words_count', 'sentences_count', 'paragraphs_count', 'categories', 'social_shares_count', 'media', 'sentiment', 'language', 'published_at', 'links'].include?(l)}
|
|
1047
|
+
fail ArgumentError, 'invalid value for "_return", must be one of id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links'
|
|
1048
|
+
end
|
|
1049
|
+
if opts[:'sort_by'] && !['relevance', 'recency', 'hotness', 'published_at', 'social_shares_count', 'social_shares_count.facebook', 'social_shares_count.linkedin', 'social_shares_count.google_plus', 'social_shares_count.reddit', 'media.images.count', 'media.videos.count', 'source.links_in_count', 'source.rankings.alexa.rank', 'source.rankings.alexa.rank.AF', 'source.rankings.alexa.rank.AX', 'source.rankings.alexa.rank.AL', 'source.rankings.alexa.rank.DZ', 'source.rankings.alexa.rank.AS', 'source.rankings.alexa.rank.AD', 'source.rankings.alexa.rank.AO', 'source.rankings.alexa.rank.AI', 'source.rankings.alexa.rank.AQ', 'source.rankings.alexa.rank.AG', 'source.rankings.alexa.rank.AR', 'source.rankings.alexa.rank.AM', 'source.rankings.alexa.rank.AW', 'source.rankings.alexa.rank.AU', 'source.rankings.alexa.rank.AT', 'source.rankings.alexa.rank.AZ', 'source.rankings.alexa.rank.BS', 'source.rankings.alexa.rank.BH', 'source.rankings.alexa.rank.BD', 'source.rankings.alexa.rank.BB', 'source.rankings.alexa.rank.BY', 'source.rankings.alexa.rank.BE', 'source.rankings.alexa.rank.BZ', 'source.rankings.alexa.rank.BJ', 'source.rankings.alexa.rank.BM', 'source.rankings.alexa.rank.BT', 'source.rankings.alexa.rank.BO', 'source.rankings.alexa.rank.BQ', 'source.rankings.alexa.rank.BA', 'source.rankings.alexa.rank.BW', 'source.rankings.alexa.rank.BV', 'source.rankings.alexa.rank.BR', 'source.rankings.alexa.rank.IO', 'source.rankings.alexa.rank.BN', 'source.rankings.alexa.rank.BG', 'source.rankings.alexa.rank.BF', 'source.rankings.alexa.rank.BI', 'source.rankings.alexa.rank.KH', 'source.rankings.alexa.rank.CM', 'source.rankings.alexa.rank.CA', 'source.rankings.alexa.rank.CV', 'source.rankings.alexa.rank.KY', 'source.rankings.alexa.rank.CF', 'source.rankings.alexa.rank.TD', 'source.rankings.alexa.rank.CL', 'source.rankings.alexa.rank.CN', 'source.rankings.alexa.rank.CX', 'source.rankings.alexa.rank.CC', 'source.rankings.alexa.rank.CO', 'source.rankings.alexa.rank.KM', 'source.rankings.alexa.rank.CG', 'source.rankings.alexa.rank.CD', 'source.rankings.alexa.rank.CK', 'source.rankings.alexa.rank.CR', 'source.rankings.alexa.rank.CI', 'source.rankings.alexa.rank.HR', 'source.rankings.alexa.rank.CU', 'source.rankings.alexa.rank.CW', 'source.rankings.alexa.rank.CY', 'source.rankings.alexa.rank.CZ', 'source.rankings.alexa.rank.DK', 'source.rankings.alexa.rank.DJ', 'source.rankings.alexa.rank.DM', 'source.rankings.alexa.rank.DO', 'source.rankings.alexa.rank.EC', 'source.rankings.alexa.rank.EG', 'source.rankings.alexa.rank.SV', 'source.rankings.alexa.rank.GQ', 'source.rankings.alexa.rank.ER', 'source.rankings.alexa.rank.EE', 'source.rankings.alexa.rank.ET', 'source.rankings.alexa.rank.FK', 'source.rankings.alexa.rank.FO', 'source.rankings.alexa.rank.FJ', 'source.rankings.alexa.rank.FI', 'source.rankings.alexa.rank.FR', 'source.rankings.alexa.rank.GF', 'source.rankings.alexa.rank.PF', 'source.rankings.alexa.rank.TF', 'source.rankings.alexa.rank.GA', 'source.rankings.alexa.rank.GM', 'source.rankings.alexa.rank.GE', 'source.rankings.alexa.rank.DE', 'source.rankings.alexa.rank.GH', 'source.rankings.alexa.rank.GI', 'source.rankings.alexa.rank.GR', 'source.rankings.alexa.rank.GL', 'source.rankings.alexa.rank.GD', 'source.rankings.alexa.rank.GP', 'source.rankings.alexa.rank.GU', 'source.rankings.alexa.rank.GT', 'source.rankings.alexa.rank.GG', 'source.rankings.alexa.rank.GN', 'source.rankings.alexa.rank.GW', 'source.rankings.alexa.rank.GY', 'source.rankings.alexa.rank.HT', 'source.rankings.alexa.rank.HM', 'source.rankings.alexa.rank.VA', 'source.rankings.alexa.rank.HN', 'source.rankings.alexa.rank.HK', 'source.rankings.alexa.rank.HU', 'source.rankings.alexa.rank.IS', 'source.rankings.alexa.rank.IN', 'source.rankings.alexa.rank.ID', 'source.rankings.alexa.rank.IR', 'source.rankings.alexa.rank.IQ', 'source.rankings.alexa.rank.IE', 'source.rankings.alexa.rank.IM', 'source.rankings.alexa.rank.IL', 'source.rankings.alexa.rank.IT', 'source.rankings.alexa.rank.JM', 'source.rankings.alexa.rank.JP', 'source.rankings.alexa.rank.JE', 'source.rankings.alexa.rank.JO', 'source.rankings.alexa.rank.KZ', 'source.rankings.alexa.rank.KE', 'source.rankings.alexa.rank.KI', 'source.rankings.alexa.rank.KP', 'source.rankings.alexa.rank.KR', 'source.rankings.alexa.rank.KW', 'source.rankings.alexa.rank.KG', 'source.rankings.alexa.rank.LA', 'source.rankings.alexa.rank.LV', 'source.rankings.alexa.rank.LB', 'source.rankings.alexa.rank.LS', 'source.rankings.alexa.rank.LR', 'source.rankings.alexa.rank.LY', 'source.rankings.alexa.rank.LI', 'source.rankings.alexa.rank.LT', 'source.rankings.alexa.rank.LU', 'source.rankings.alexa.rank.MO', 'source.rankings.alexa.rank.MK', 'source.rankings.alexa.rank.MG', 'source.rankings.alexa.rank.MW', 'source.rankings.alexa.rank.MY', 'source.rankings.alexa.rank.MV', 'source.rankings.alexa.rank.ML', 'source.rankings.alexa.rank.MT', 'source.rankings.alexa.rank.MH', 'source.rankings.alexa.rank.MQ', 'source.rankings.alexa.rank.MR', 'source.rankings.alexa.rank.MU', 'source.rankings.alexa.rank.YT', 'source.rankings.alexa.rank.MX', 'source.rankings.alexa.rank.FM', 'source.rankings.alexa.rank.MD', 'source.rankings.alexa.rank.MC', 'source.rankings.alexa.rank.MN', 'source.rankings.alexa.rank.ME', 'source.rankings.alexa.rank.MS', 'source.rankings.alexa.rank.MA', 'source.rankings.alexa.rank.MZ', 'source.rankings.alexa.rank.MM', 'source.rankings.alexa.rank.NA', 'source.rankings.alexa.rank.NR', 'source.rankings.alexa.rank.NP', 'source.rankings.alexa.rank.NL', 'source.rankings.alexa.rank.NC', 'source.rankings.alexa.rank.NZ', 'source.rankings.alexa.rank.NI', 'source.rankings.alexa.rank.NE', 'source.rankings.alexa.rank.NG', 'source.rankings.alexa.rank.NU', 'source.rankings.alexa.rank.NF', 'source.rankings.alexa.rank.MP', 'source.rankings.alexa.rank.NO', 'source.rankings.alexa.rank.OM', 'source.rankings.alexa.rank.PK', 'source.rankings.alexa.rank.PW', 'source.rankings.alexa.rank.PS', 'source.rankings.alexa.rank.PA', 'source.rankings.alexa.rank.PG', 'source.rankings.alexa.rank.PY', 'source.rankings.alexa.rank.PE', 'source.rankings.alexa.rank.PH', 'source.rankings.alexa.rank.PN', 'source.rankings.alexa.rank.PL', 'source.rankings.alexa.rank.PT', 'source.rankings.alexa.rank.PR', 'source.rankings.alexa.rank.QA', 'source.rankings.alexa.rank.RE', 'source.rankings.alexa.rank.RO', 'source.rankings.alexa.rank.RU', 'source.rankings.alexa.rank.RW', 'source.rankings.alexa.rank.BL', 'source.rankings.alexa.rank.SH', 'source.rankings.alexa.rank.KN', 'source.rankings.alexa.rank.LC', 'source.rankings.alexa.rank.MF', 'source.rankings.alexa.rank.PM', 'source.rankings.alexa.rank.VC', 'source.rankings.alexa.rank.WS', 'source.rankings.alexa.rank.SM', 'source.rankings.alexa.rank.ST', 'source.rankings.alexa.rank.SA', 'source.rankings.alexa.rank.SN', 'source.rankings.alexa.rank.RS', 'source.rankings.alexa.rank.SC', 'source.rankings.alexa.rank.SL', 'source.rankings.alexa.rank.SG', 'source.rankings.alexa.rank.SX', 'source.rankings.alexa.rank.SK', 'source.rankings.alexa.rank.SI', 'source.rankings.alexa.rank.SB', 'source.rankings.alexa.rank.SO', 'source.rankings.alexa.rank.ZA', 'source.rankings.alexa.rank.GS', 'source.rankings.alexa.rank.SS', 'source.rankings.alexa.rank.ES', 'source.rankings.alexa.rank.LK', 'source.rankings.alexa.rank.SD', 'source.rankings.alexa.rank.SR', 'source.rankings.alexa.rank.SJ', 'source.rankings.alexa.rank.SZ', 'source.rankings.alexa.rank.SE', 'source.rankings.alexa.rank.CH', 'source.rankings.alexa.rank.SY', 'source.rankings.alexa.rank.TW', 'source.rankings.alexa.rank.TJ', 'source.rankings.alexa.rank.TZ', 'source.rankings.alexa.rank.TH', 'source.rankings.alexa.rank.TL', 'source.rankings.alexa.rank.TG', 'source.rankings.alexa.rank.TK', 'source.rankings.alexa.rank.TO', 'source.rankings.alexa.rank.TT', 'source.rankings.alexa.rank.TN', 'source.rankings.alexa.rank.TR', 'source.rankings.alexa.rank.TM', 'source.rankings.alexa.rank.TC', 'source.rankings.alexa.rank.TV', 'source.rankings.alexa.rank.UG', 'source.rankings.alexa.rank.UA', 'source.rankings.alexa.rank.AE', 'source.rankings.alexa.rank.GB', 'source.rankings.alexa.rank.US', 'source.rankings.alexa.rank.UM', 'source.rankings.alexa.rank.UY', 'source.rankings.alexa.rank.UZ', 'source.rankings.alexa.rank.VU', 'source.rankings.alexa.rank.VE', 'source.rankings.alexa.rank.VN', 'source.rankings.alexa.rank.VG', 'source.rankings.alexa.rank.VI', 'source.rankings.alexa.rank.WF', 'source.rankings.alexa.rank.EH', 'source.rankings.alexa.rank.YE', 'source.rankings.alexa.rank.ZM', 'source.rankings.alexa.rank.ZW'].include?(opts[:'sort_by'])
|
|
1050
|
+
fail ArgumentError, 'invalid value for "sort_by", must be one of relevance, recency, hotness, published_at, social_shares_count, social_shares_count.facebook, social_shares_count.linkedin, social_shares_count.google_plus, social_shares_count.reddit, media.images.count, media.videos.count, source.links_in_count, source.rankings.alexa.rank, source.rankings.alexa.rank.AF, source.rankings.alexa.rank.AX, source.rankings.alexa.rank.AL, source.rankings.alexa.rank.DZ, source.rankings.alexa.rank.AS, source.rankings.alexa.rank.AD, source.rankings.alexa.rank.AO, source.rankings.alexa.rank.AI, source.rankings.alexa.rank.AQ, source.rankings.alexa.rank.AG, source.rankings.alexa.rank.AR, source.rankings.alexa.rank.AM, source.rankings.alexa.rank.AW, source.rankings.alexa.rank.AU, source.rankings.alexa.rank.AT, source.rankings.alexa.rank.AZ, source.rankings.alexa.rank.BS, source.rankings.alexa.rank.BH, source.rankings.alexa.rank.BD, source.rankings.alexa.rank.BB, source.rankings.alexa.rank.BY, source.rankings.alexa.rank.BE, source.rankings.alexa.rank.BZ, source.rankings.alexa.rank.BJ, source.rankings.alexa.rank.BM, source.rankings.alexa.rank.BT, source.rankings.alexa.rank.BO, source.rankings.alexa.rank.BQ, source.rankings.alexa.rank.BA, source.rankings.alexa.rank.BW, source.rankings.alexa.rank.BV, source.rankings.alexa.rank.BR, source.rankings.alexa.rank.IO, source.rankings.alexa.rank.BN, source.rankings.alexa.rank.BG, source.rankings.alexa.rank.BF, source.rankings.alexa.rank.BI, source.rankings.alexa.rank.KH, source.rankings.alexa.rank.CM, source.rankings.alexa.rank.CA, source.rankings.alexa.rank.CV, source.rankings.alexa.rank.KY, source.rankings.alexa.rank.CF, source.rankings.alexa.rank.TD, source.rankings.alexa.rank.CL, source.rankings.alexa.rank.CN, source.rankings.alexa.rank.CX, source.rankings.alexa.rank.CC, source.rankings.alexa.rank.CO, source.rankings.alexa.rank.KM, source.rankings.alexa.rank.CG, source.rankings.alexa.rank.CD, source.rankings.alexa.rank.CK, source.rankings.alexa.rank.CR, source.rankings.alexa.rank.CI, source.rankings.alexa.rank.HR, source.rankings.alexa.rank.CU, source.rankings.alexa.rank.CW, source.rankings.alexa.rank.CY, source.rankings.alexa.rank.CZ, source.rankings.alexa.rank.DK, source.rankings.alexa.rank.DJ, source.rankings.alexa.rank.DM, source.rankings.alexa.rank.DO, source.rankings.alexa.rank.EC, source.rankings.alexa.rank.EG, source.rankings.alexa.rank.SV, source.rankings.alexa.rank.GQ, source.rankings.alexa.rank.ER, source.rankings.alexa.rank.EE, source.rankings.alexa.rank.ET, source.rankings.alexa.rank.FK, source.rankings.alexa.rank.FO, source.rankings.alexa.rank.FJ, source.rankings.alexa.rank.FI, source.rankings.alexa.rank.FR, source.rankings.alexa.rank.GF, source.rankings.alexa.rank.PF, source.rankings.alexa.rank.TF, source.rankings.alexa.rank.GA, source.rankings.alexa.rank.GM, source.rankings.alexa.rank.GE, source.rankings.alexa.rank.DE, source.rankings.alexa.rank.GH, source.rankings.alexa.rank.GI, source.rankings.alexa.rank.GR, source.rankings.alexa.rank.GL, source.rankings.alexa.rank.GD, source.rankings.alexa.rank.GP, source.rankings.alexa.rank.GU, source.rankings.alexa.rank.GT, source.rankings.alexa.rank.GG, source.rankings.alexa.rank.GN, source.rankings.alexa.rank.GW, source.rankings.alexa.rank.GY, source.rankings.alexa.rank.HT, source.rankings.alexa.rank.HM, source.rankings.alexa.rank.VA, source.rankings.alexa.rank.HN, source.rankings.alexa.rank.HK, source.rankings.alexa.rank.HU, source.rankings.alexa.rank.IS, source.rankings.alexa.rank.IN, source.rankings.alexa.rank.ID, source.rankings.alexa.rank.IR, source.rankings.alexa.rank.IQ, source.rankings.alexa.rank.IE, source.rankings.alexa.rank.IM, source.rankings.alexa.rank.IL, source.rankings.alexa.rank.IT, source.rankings.alexa.rank.JM, source.rankings.alexa.rank.JP, source.rankings.alexa.rank.JE, source.rankings.alexa.rank.JO, source.rankings.alexa.rank.KZ, source.rankings.alexa.rank.KE, source.rankings.alexa.rank.KI, source.rankings.alexa.rank.KP, source.rankings.alexa.rank.KR, source.rankings.alexa.rank.KW, source.rankings.alexa.rank.KG, source.rankings.alexa.rank.LA, source.rankings.alexa.rank.LV, source.rankings.alexa.rank.LB, source.rankings.alexa.rank.LS, source.rankings.alexa.rank.LR, source.rankings.alexa.rank.LY, source.rankings.alexa.rank.LI, source.rankings.alexa.rank.LT, source.rankings.alexa.rank.LU, source.rankings.alexa.rank.MO, source.rankings.alexa.rank.MK, source.rankings.alexa.rank.MG, source.rankings.alexa.rank.MW, source.rankings.alexa.rank.MY, source.rankings.alexa.rank.MV, source.rankings.alexa.rank.ML, source.rankings.alexa.rank.MT, source.rankings.alexa.rank.MH, source.rankings.alexa.rank.MQ, source.rankings.alexa.rank.MR, source.rankings.alexa.rank.MU, source.rankings.alexa.rank.YT, source.rankings.alexa.rank.MX, source.rankings.alexa.rank.FM, source.rankings.alexa.rank.MD, source.rankings.alexa.rank.MC, source.rankings.alexa.rank.MN, source.rankings.alexa.rank.ME, source.rankings.alexa.rank.MS, source.rankings.alexa.rank.MA, source.rankings.alexa.rank.MZ, source.rankings.alexa.rank.MM, source.rankings.alexa.rank.NA, source.rankings.alexa.rank.NR, source.rankings.alexa.rank.NP, source.rankings.alexa.rank.NL, source.rankings.alexa.rank.NC, source.rankings.alexa.rank.NZ, source.rankings.alexa.rank.NI, source.rankings.alexa.rank.NE, source.rankings.alexa.rank.NG, source.rankings.alexa.rank.NU, source.rankings.alexa.rank.NF, source.rankings.alexa.rank.MP, source.rankings.alexa.rank.NO, source.rankings.alexa.rank.OM, source.rankings.alexa.rank.PK, source.rankings.alexa.rank.PW, source.rankings.alexa.rank.PS, source.rankings.alexa.rank.PA, source.rankings.alexa.rank.PG, source.rankings.alexa.rank.PY, source.rankings.alexa.rank.PE, source.rankings.alexa.rank.PH, source.rankings.alexa.rank.PN, source.rankings.alexa.rank.PL, source.rankings.alexa.rank.PT, source.rankings.alexa.rank.PR, source.rankings.alexa.rank.QA, source.rankings.alexa.rank.RE, source.rankings.alexa.rank.RO, source.rankings.alexa.rank.RU, source.rankings.alexa.rank.RW, source.rankings.alexa.rank.BL, source.rankings.alexa.rank.SH, source.rankings.alexa.rank.KN, source.rankings.alexa.rank.LC, source.rankings.alexa.rank.MF, source.rankings.alexa.rank.PM, source.rankings.alexa.rank.VC, source.rankings.alexa.rank.WS, source.rankings.alexa.rank.SM, source.rankings.alexa.rank.ST, source.rankings.alexa.rank.SA, source.rankings.alexa.rank.SN, source.rankings.alexa.rank.RS, source.rankings.alexa.rank.SC, source.rankings.alexa.rank.SL, source.rankings.alexa.rank.SG, source.rankings.alexa.rank.SX, source.rankings.alexa.rank.SK, source.rankings.alexa.rank.SI, source.rankings.alexa.rank.SB, source.rankings.alexa.rank.SO, source.rankings.alexa.rank.ZA, source.rankings.alexa.rank.GS, source.rankings.alexa.rank.SS, source.rankings.alexa.rank.ES, source.rankings.alexa.rank.LK, source.rankings.alexa.rank.SD, source.rankings.alexa.rank.SR, source.rankings.alexa.rank.SJ, source.rankings.alexa.rank.SZ, source.rankings.alexa.rank.SE, source.rankings.alexa.rank.CH, source.rankings.alexa.rank.SY, source.rankings.alexa.rank.TW, source.rankings.alexa.rank.TJ, source.rankings.alexa.rank.TZ, source.rankings.alexa.rank.TH, source.rankings.alexa.rank.TL, source.rankings.alexa.rank.TG, source.rankings.alexa.rank.TK, source.rankings.alexa.rank.TO, source.rankings.alexa.rank.TT, source.rankings.alexa.rank.TN, source.rankings.alexa.rank.TR, source.rankings.alexa.rank.TM, source.rankings.alexa.rank.TC, source.rankings.alexa.rank.TV, source.rankings.alexa.rank.UG, source.rankings.alexa.rank.UA, source.rankings.alexa.rank.AE, source.rankings.alexa.rank.GB, source.rankings.alexa.rank.US, source.rankings.alexa.rank.UM, source.rankings.alexa.rank.UY, source.rankings.alexa.rank.UZ, source.rankings.alexa.rank.VU, source.rankings.alexa.rank.VE, source.rankings.alexa.rank.VN, source.rankings.alexa.rank.VG, source.rankings.alexa.rank.VI, source.rankings.alexa.rank.WF, source.rankings.alexa.rank.EH, source.rankings.alexa.rank.YE, source.rankings.alexa.rank.ZM, source.rankings.alexa.rank.ZW'
|
|
815
1051
|
end
|
|
816
1052
|
if opts[:'sort_direction'] && !['asc', 'desc'].include?(opts[:'sort_direction'])
|
|
817
1053
|
fail ArgumentError, 'invalid value for "sort_direction", must be one of asc, desc'
|
|
818
1054
|
end
|
|
1055
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] > 100.0
|
|
1056
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_stories, must be smaller than or equal to 100.0.'
|
|
1057
|
+
end
|
|
1058
|
+
|
|
1059
|
+
if !opts[:'per_page'].nil? && opts[:'per_page'] < 1.0
|
|
1060
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DefaultApi.list_stories, must be greater than or equal to 1.0.'
|
|
1061
|
+
end
|
|
819
1062
|
|
|
820
1063
|
# resource path
|
|
821
1064
|
local_var_path = "/stories".sub('{format}','json')
|
|
@@ -857,6 +1100,11 @@ module AylienNewsApi
|
|
|
857
1100
|
query_params[:'source.scopes.state[]'] = @api_client.build_collection_param(opts[:'source_scopes_state'], :multi) if !opts[:'source_scopes_state'].nil?
|
|
858
1101
|
query_params[:'source.scopes.city[]'] = @api_client.build_collection_param(opts[:'source_scopes_city'], :multi) if !opts[:'source_scopes_city'].nil?
|
|
859
1102
|
query_params[:'source.scopes.level[]'] = @api_client.build_collection_param(opts[:'source_scopes_level'], :multi) if !opts[:'source_scopes_level'].nil?
|
|
1103
|
+
query_params[:'source.links_in_count.min'] = opts[:'source_links_in_count_min'] if !opts[:'source_links_in_count_min'].nil?
|
|
1104
|
+
query_params[:'source.links_in_count.max'] = opts[:'source_links_in_count_max'] if !opts[:'source_links_in_count_max'].nil?
|
|
1105
|
+
query_params[:'source.rankings.alexa.rank.min'] = opts[:'source_rankings_alexa_rank_min'] if !opts[:'source_rankings_alexa_rank_min'].nil?
|
|
1106
|
+
query_params[:'source.rankings.alexa.rank.max'] = opts[:'source_rankings_alexa_rank_max'] if !opts[:'source_rankings_alexa_rank_max'].nil?
|
|
1107
|
+
query_params[:'source.rankings.alexa.country[]'] = @api_client.build_collection_param(opts[:'source_rankings_alexa_country'], :multi) if !opts[:'source_rankings_alexa_country'].nil?
|
|
860
1108
|
query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
|
|
861
1109
|
query_params[:'cluster.algorithm'] = opts[:'cluster_algorithm'] if !opts[:'cluster_algorithm'].nil?
|
|
862
1110
|
query_params[:'return[]'] = @api_client.build_collection_param(opts[:'_return'], :multi) if !opts[:'_return'].nil?
|
|
@@ -931,6 +1179,11 @@ module AylienNewsApi
|
|
|
931
1179
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
932
1180
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
933
1181
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1182
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1183
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1184
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1185
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1186
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
934
1187
|
# @option opts [String] :published_at_start 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). (default to NOW-7DAYS/DAY)
|
|
935
1188
|
# @option opts [String] :published_at_end 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). (default to NOW/DAY)
|
|
936
1189
|
# @option opts [String] :period 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). (default to +1DAY)
|
|
@@ -976,6 +1229,11 @@ module AylienNewsApi
|
|
|
976
1229
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
977
1230
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
978
1231
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1232
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1233
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1234
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1235
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1236
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
979
1237
|
# @option opts [String] :published_at_start 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).
|
|
980
1238
|
# @option opts [String] :published_at_end 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).
|
|
981
1239
|
# @option opts [String] :period 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).
|
|
@@ -984,6 +1242,9 @@ module AylienNewsApi
|
|
|
984
1242
|
if @api_client.config.debugging
|
|
985
1243
|
@api_client.config.logger.debug "Calling API: DefaultApi.list_time_series ..."
|
|
986
1244
|
end
|
|
1245
|
+
if opts[:'language'] && !opts[:'language'].all?{|l| ['en', 'de', 'fr', 'it', 'es', 'pt'].include?(l)}
|
|
1246
|
+
fail ArgumentError, 'invalid value for "language", must be one of en, de, fr, it, es, pt'
|
|
1247
|
+
end
|
|
987
1248
|
if opts[:'categories_taxonomy'] && !['iab-qag', 'iptc-subjectcode'].include?(opts[:'categories_taxonomy'])
|
|
988
1249
|
fail ArgumentError, 'invalid value for "categories_taxonomy", must be one of iab-qag, iptc-subjectcode'
|
|
989
1250
|
end
|
|
@@ -993,6 +1254,40 @@ module AylienNewsApi
|
|
|
993
1254
|
if opts[:'sentiment_body_polarity'] && !['positive', 'neutral', 'negative'].include?(opts[:'sentiment_body_polarity'])
|
|
994
1255
|
fail ArgumentError, 'invalid value for "sentiment_body_polarity", must be one of positive, neutral, negative'
|
|
995
1256
|
end
|
|
1257
|
+
if !opts[:'media_images_count_min'].nil? && opts[:'media_images_count_min'] < 0.0
|
|
1258
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_min"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1259
|
+
end
|
|
1260
|
+
|
|
1261
|
+
if !opts[:'media_images_count_max'].nil? && opts[:'media_images_count_max'] < 0.0
|
|
1262
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_max"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1263
|
+
end
|
|
1264
|
+
|
|
1265
|
+
if !opts[:'media_videos_count_min'].nil? && opts[:'media_videos_count_min'] < 0.0
|
|
1266
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_min"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1267
|
+
end
|
|
1268
|
+
|
|
1269
|
+
if !opts[:'media_videos_count_max'].nil? && opts[:'media_videos_count_max'] < 0.0
|
|
1270
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_max"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1271
|
+
end
|
|
1272
|
+
|
|
1273
|
+
if opts[:'source_scopes_level'] && !opts[:'source_scopes_level'].all?{|l| ['international', 'national', 'local'].include?(l)}
|
|
1274
|
+
fail ArgumentError, 'invalid value for "source_scopes_level", must be one of international, national, local'
|
|
1275
|
+
end
|
|
1276
|
+
if !opts[:'source_links_in_count_min'].nil? && opts[:'source_links_in_count_min'] < 0.0
|
|
1277
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_min"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1278
|
+
end
|
|
1279
|
+
|
|
1280
|
+
if !opts[:'source_links_in_count_max'].nil? && opts[:'source_links_in_count_max'] < 0.0
|
|
1281
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_max"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1282
|
+
end
|
|
1283
|
+
|
|
1284
|
+
if !opts[:'source_rankings_alexa_rank_min'].nil? && opts[:'source_rankings_alexa_rank_min'] < 0.0
|
|
1285
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_min"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1286
|
+
end
|
|
1287
|
+
|
|
1288
|
+
if !opts[:'source_rankings_alexa_rank_max'].nil? && opts[:'source_rankings_alexa_rank_max'] < 0.0
|
|
1289
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_max"]" when calling DefaultApi.list_time_series, must be greater than or equal to 0.0.'
|
|
1290
|
+
end
|
|
996
1291
|
|
|
997
1292
|
# resource path
|
|
998
1293
|
local_var_path = "/time_series".sub('{format}','json')
|
|
@@ -1032,6 +1327,11 @@ module AylienNewsApi
|
|
|
1032
1327
|
query_params[:'source.scopes.state[]'] = @api_client.build_collection_param(opts[:'source_scopes_state'], :multi) if !opts[:'source_scopes_state'].nil?
|
|
1033
1328
|
query_params[:'source.scopes.city[]'] = @api_client.build_collection_param(opts[:'source_scopes_city'], :multi) if !opts[:'source_scopes_city'].nil?
|
|
1034
1329
|
query_params[:'source.scopes.level[]'] = @api_client.build_collection_param(opts[:'source_scopes_level'], :multi) if !opts[:'source_scopes_level'].nil?
|
|
1330
|
+
query_params[:'source.links_in_count.min'] = opts[:'source_links_in_count_min'] if !opts[:'source_links_in_count_min'].nil?
|
|
1331
|
+
query_params[:'source.links_in_count.max'] = opts[:'source_links_in_count_max'] if !opts[:'source_links_in_count_max'].nil?
|
|
1332
|
+
query_params[:'source.rankings.alexa.rank.min'] = opts[:'source_rankings_alexa_rank_min'] if !opts[:'source_rankings_alexa_rank_min'].nil?
|
|
1333
|
+
query_params[:'source.rankings.alexa.rank.max'] = opts[:'source_rankings_alexa_rank_max'] if !opts[:'source_rankings_alexa_rank_max'].nil?
|
|
1334
|
+
query_params[:'source.rankings.alexa.country[]'] = @api_client.build_collection_param(opts[:'source_rankings_alexa_country'], :multi) if !opts[:'source_rankings_alexa_country'].nil?
|
|
1035
1335
|
query_params[:'published_at.start'] = opts[:'published_at_start'] if !opts[:'published_at_start'].nil?
|
|
1036
1336
|
query_params[:'published_at.end'] = opts[:'published_at_end'] if !opts[:'published_at_end'].nil?
|
|
1037
1337
|
query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
|
|
@@ -1104,6 +1404,11 @@ module AylienNewsApi
|
|
|
1104
1404
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1105
1405
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1106
1406
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1407
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1408
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1409
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1410
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1411
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1107
1412
|
# @option opts [String] :field This parameter is used to specify the trend field.
|
|
1108
1413
|
# @return [Trends]
|
|
1109
1414
|
def list_trends(opts = {})
|
|
@@ -1149,12 +1454,20 @@ module AylienNewsApi
|
|
|
1149
1454
|
# @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1150
1455
|
# @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1151
1456
|
# @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
|
|
1457
|
+
# @option opts [Integer] :source_links_in_count_min This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1458
|
+
# @option opts [Integer] :source_links_in_count_max This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count here [https://newsapi.aylien.com/docs/working-with-links-in-count](https://newsapi.aylien.com/docs/working-with-links-in-count).
|
|
1459
|
+
# @option opts [Integer] :source_rankings_alexa_rank_min This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1460
|
+
# @option opts [Integer] :source_rankings_alexa_rank_max This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1461
|
+
# @option opts [Array<String>] :source_rankings_alexa_country This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks here [https://newsapi.aylien.com/docs/working-with-alexa-ranks](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
|
|
1152
1462
|
# @option opts [String] :field This parameter is used to specify the trend field.
|
|
1153
1463
|
# @return [Array<(Trends, Fixnum, Hash)>] Trends data, response status code and response headers
|
|
1154
1464
|
def list_trends_with_http_info(opts = {})
|
|
1155
1465
|
if @api_client.config.debugging
|
|
1156
1466
|
@api_client.config.logger.debug "Calling API: DefaultApi.list_trends ..."
|
|
1157
1467
|
end
|
|
1468
|
+
if opts[:'language'] && !opts[:'language'].all?{|l| ['en', 'de', 'fr', 'it', 'es', 'pt'].include?(l)}
|
|
1469
|
+
fail ArgumentError, 'invalid value for "language", must be one of en, de, fr, it, es, pt'
|
|
1470
|
+
end
|
|
1158
1471
|
if opts[:'categories_taxonomy'] && !['iab-qag', 'iptc-subjectcode'].include?(opts[:'categories_taxonomy'])
|
|
1159
1472
|
fail ArgumentError, 'invalid value for "categories_taxonomy", must be one of iab-qag, iptc-subjectcode'
|
|
1160
1473
|
end
|
|
@@ -1164,6 +1477,40 @@ module AylienNewsApi
|
|
|
1164
1477
|
if opts[:'sentiment_body_polarity'] && !['positive', 'neutral', 'negative'].include?(opts[:'sentiment_body_polarity'])
|
|
1165
1478
|
fail ArgumentError, 'invalid value for "sentiment_body_polarity", must be one of positive, neutral, negative'
|
|
1166
1479
|
end
|
|
1480
|
+
if !opts[:'media_images_count_min'].nil? && opts[:'media_images_count_min'] < 0.0
|
|
1481
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_min"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1482
|
+
end
|
|
1483
|
+
|
|
1484
|
+
if !opts[:'media_images_count_max'].nil? && opts[:'media_images_count_max'] < 0.0
|
|
1485
|
+
fail ArgumentError, 'invalid value for "opts[:"media_images_count_max"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1486
|
+
end
|
|
1487
|
+
|
|
1488
|
+
if !opts[:'media_videos_count_min'].nil? && opts[:'media_videos_count_min'] < 0.0
|
|
1489
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_min"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1490
|
+
end
|
|
1491
|
+
|
|
1492
|
+
if !opts[:'media_videos_count_max'].nil? && opts[:'media_videos_count_max'] < 0.0
|
|
1493
|
+
fail ArgumentError, 'invalid value for "opts[:"media_videos_count_max"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1494
|
+
end
|
|
1495
|
+
|
|
1496
|
+
if opts[:'source_scopes_level'] && !opts[:'source_scopes_level'].all?{|l| ['international', 'national', 'local'].include?(l)}
|
|
1497
|
+
fail ArgumentError, 'invalid value for "source_scopes_level", must be one of international, national, local'
|
|
1498
|
+
end
|
|
1499
|
+
if !opts[:'source_links_in_count_min'].nil? && opts[:'source_links_in_count_min'] < 0.0
|
|
1500
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_min"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1501
|
+
end
|
|
1502
|
+
|
|
1503
|
+
if !opts[:'source_links_in_count_max'].nil? && opts[:'source_links_in_count_max'] < 0.0
|
|
1504
|
+
fail ArgumentError, 'invalid value for "opts[:"source_links_in_count_max"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1505
|
+
end
|
|
1506
|
+
|
|
1507
|
+
if !opts[:'source_rankings_alexa_rank_min'].nil? && opts[:'source_rankings_alexa_rank_min'] < 0.0
|
|
1508
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_min"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1509
|
+
end
|
|
1510
|
+
|
|
1511
|
+
if !opts[:'source_rankings_alexa_rank_max'].nil? && opts[:'source_rankings_alexa_rank_max'] < 0.0
|
|
1512
|
+
fail ArgumentError, 'invalid value for "opts[:"source_rankings_alexa_rank_max"]" when calling DefaultApi.list_trends, must be greater than or equal to 0.0.'
|
|
1513
|
+
end
|
|
1167
1514
|
|
|
1168
1515
|
if opts[:'field'] && !['author.name', 'source.name', 'source.domain', 'keywords', 'entities.title.text', 'entities.title.type', 'entities.title.links.dbpedia', 'entities.body.text', 'entities.body.type', 'entities.body.links.dbpedia', 'hashtags', 'categories.id', 'sentiment.title.polarity', 'sentiment.body.polarity'].include?(opts[:'field'])
|
|
1169
1516
|
fail ArgumentError, 'invalid value for "field", must be one of author.name, source.name, source.domain, keywords, entities.title.text, entities.title.type, entities.title.links.dbpedia, entities.body.text, entities.body.type, entities.body.links.dbpedia, hashtags, categories.id, sentiment.title.polarity, sentiment.body.polarity'
|
|
@@ -1208,6 +1555,11 @@ module AylienNewsApi
|
|
|
1208
1555
|
query_params[:'source.scopes.state[]'] = @api_client.build_collection_param(opts[:'source_scopes_state'], :multi) if !opts[:'source_scopes_state'].nil?
|
|
1209
1556
|
query_params[:'source.scopes.city[]'] = @api_client.build_collection_param(opts[:'source_scopes_city'], :multi) if !opts[:'source_scopes_city'].nil?
|
|
1210
1557
|
query_params[:'source.scopes.level[]'] = @api_client.build_collection_param(opts[:'source_scopes_level'], :multi) if !opts[:'source_scopes_level'].nil?
|
|
1558
|
+
query_params[:'source.links_in_count.min'] = opts[:'source_links_in_count_min'] if !opts[:'source_links_in_count_min'].nil?
|
|
1559
|
+
query_params[:'source.links_in_count.max'] = opts[:'source_links_in_count_max'] if !opts[:'source_links_in_count_max'].nil?
|
|
1560
|
+
query_params[:'source.rankings.alexa.rank.min'] = opts[:'source_rankings_alexa_rank_min'] if !opts[:'source_rankings_alexa_rank_min'].nil?
|
|
1561
|
+
query_params[:'source.rankings.alexa.rank.max'] = opts[:'source_rankings_alexa_rank_max'] if !opts[:'source_rankings_alexa_rank_max'].nil?
|
|
1562
|
+
query_params[:'source.rankings.alexa.country[]'] = @api_client.build_collection_param(opts[:'source_rankings_alexa_country'], :multi) if !opts[:'source_rankings_alexa_country'].nil?
|
|
1211
1563
|
query_params[:'field'] = opts[:'field'] if !opts[:'field'].nil?
|
|
1212
1564
|
|
|
1213
1565
|
# header parameters
|