aylien_news_api 5.0.1 → 5.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +96 -31
- data/aylien_news_api.gemspec +1 -1
- data/docs/Category.md +3 -3
- data/docs/CategoryLinks.md +2 -0
- data/docs/DeprecatedStory.md +6 -2
- data/docs/DunsNumber.md +17 -0
- data/docs/Entity.md +3 -1
- data/docs/Error.md +1 -1
- data/docs/ExternalIds.md +17 -0
- data/docs/Story.md +6 -2
- data/lib/aylien_news_api/api/default_api.rb +1 -1
- data/lib/aylien_news_api/api_client.rb +1 -1
- data/lib/aylien_news_api/api_error.rb +1 -1
- data/lib/aylien_news_api/configuration.rb +1 -1
- data/lib/aylien_news_api/models/aggregated_sentiment.rb +1 -1
- data/lib/aylien_news_api/models/author.rb +1 -1
- data/lib/aylien_news_api/models/autocomplete.rb +1 -1
- data/lib/aylien_news_api/models/autocompletes.rb +1 -1
- data/lib/aylien_news_api/models/category.rb +40 -14
- data/lib/aylien_news_api/models/category_links.rb +16 -2
- data/lib/aylien_news_api/models/category_taxonomy.rb +2 -1
- data/lib/aylien_news_api/models/cluster.rb +1 -1
- data/lib/aylien_news_api/models/clusters.rb +1 -1
- data/lib/aylien_news_api/models/deprecated_entities.rb +1 -1
- data/lib/aylien_news_api/models/deprecated_entity.rb +1 -1
- data/lib/aylien_news_api/models/deprecated_entity_surface_form.rb +1 -1
- data/lib/aylien_news_api/models/deprecated_related_stories.rb +1 -1
- data/lib/aylien_news_api/models/deprecated_stories.rb +1 -1
- data/lib/aylien_news_api/models/deprecated_story.rb +28 -6
- data/lib/aylien_news_api/models/duns_number.rb +206 -0
- data/lib/aylien_news_api/models/entity.rb +14 -5
- data/lib/aylien_news_api/models/entity_in_text.rb +1 -1
- data/lib/aylien_news_api/models/entity_links.rb +1 -1
- data/lib/aylien_news_api/models/entity_mention.rb +1 -1
- data/lib/aylien_news_api/models/entity_mention_index.rb +1 -1
- data/lib/aylien_news_api/models/entity_sentiment.rb +1 -1
- data/lib/aylien_news_api/models/entity_surface_form.rb +1 -1
- data/lib/aylien_news_api/models/error.rb +2 -2
- data/lib/aylien_news_api/models/error_links.rb +1 -1
- data/lib/aylien_news_api/models/errors.rb +1 -1
- data/lib/aylien_news_api/models/external_ids.rb +210 -0
- data/lib/aylien_news_api/models/histogram_interval.rb +1 -1
- data/lib/aylien_news_api/models/histograms.rb +1 -1
- data/lib/aylien_news_api/models/location.rb +1 -1
- data/lib/aylien_news_api/models/logicals.rb +1 -1
- data/lib/aylien_news_api/models/media.rb +1 -1
- data/lib/aylien_news_api/models/media_format.rb +1 -1
- data/lib/aylien_news_api/models/media_type.rb +1 -1
- data/lib/aylien_news_api/models/nested_entity.rb +1 -1
- data/lib/aylien_news_api/models/parameter.rb +1 -1
- data/lib/aylien_news_api/models/query.rb +1 -1
- data/lib/aylien_news_api/models/rank.rb +1 -1
- data/lib/aylien_news_api/models/rankings.rb +1 -1
- data/lib/aylien_news_api/models/related_stories.rb +1 -1
- data/lib/aylien_news_api/models/representative_story.rb +1 -1
- data/lib/aylien_news_api/models/scope.rb +1 -1
- data/lib/aylien_news_api/models/scope_level.rb +1 -1
- data/lib/aylien_news_api/models/sentiment.rb +1 -1
- data/lib/aylien_news_api/models/sentiment_polarity.rb +1 -1
- data/lib/aylien_news_api/models/sentiments.rb +1 -1
- data/lib/aylien_news_api/models/share_count.rb +1 -1
- data/lib/aylien_news_api/models/share_counts.rb +1 -1
- data/lib/aylien_news_api/models/source.rb +1 -1
- data/lib/aylien_news_api/models/stories.rb +1 -1
- data/lib/aylien_news_api/models/story.rb +28 -6
- data/lib/aylien_news_api/models/story_cluster.rb +1 -1
- data/lib/aylien_news_api/models/story_links.rb +1 -1
- data/lib/aylien_news_api/models/story_translation.rb +1 -1
- data/lib/aylien_news_api/models/story_translations.rb +1 -1
- data/lib/aylien_news_api/models/summary.rb +1 -1
- data/lib/aylien_news_api/models/time_series.rb +1 -1
- data/lib/aylien_news_api/models/time_series_list.rb +1 -1
- data/lib/aylien_news_api/models/trend.rb +1 -1
- data/lib/aylien_news_api/models/trends.rb +1 -1
- data/lib/aylien_news_api/models/warning.rb +1 -1
- data/lib/aylien_news_api/version.rb +2 -2
- data/lib/aylien_news_api.rb +3 -1
- data/spec/api/default_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/aggregated_sentiment_spec.rb +1 -1
- data/spec/models/author_spec.rb +1 -1
- data/spec/models/autocomplete_spec.rb +1 -1
- data/spec/models/autocompletes_spec.rb +1 -1
- data/spec/models/category_links_spec.rb +7 -1
- data/spec/models/category_spec.rb +4 -4
- data/spec/models/category_taxonomy_spec.rb +1 -1
- data/spec/models/cluster_spec.rb +1 -1
- data/spec/models/clusters_spec.rb +1 -1
- data/spec/models/deprecated_entities_spec.rb +1 -1
- data/spec/models/deprecated_entity_spec.rb +1 -1
- data/spec/models/deprecated_entity_surface_form_spec.rb +1 -1
- data/spec/models/deprecated_related_stories_spec.rb +1 -1
- data/spec/models/deprecated_stories_spec.rb +1 -1
- data/spec/models/deprecated_story_spec.rb +13 -1
- data/spec/models/duns_number_spec.rb +41 -0
- data/spec/models/entity_in_text_spec.rb +1 -1
- data/spec/models/entity_links_spec.rb +1 -1
- data/spec/models/entity_mention_index_spec.rb +1 -1
- data/spec/models/entity_mention_spec.rb +1 -1
- data/spec/models/entity_sentiment_spec.rb +1 -1
- data/spec/models/entity_spec.rb +7 -1
- data/spec/models/entity_surface_form_spec.rb +1 -1
- data/spec/models/error_links_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/errors_spec.rb +1 -1
- data/spec/models/external_ids_spec.rb +41 -0
- data/spec/models/histogram_interval_spec.rb +1 -1
- data/spec/models/histograms_spec.rb +1 -1
- data/spec/models/location_spec.rb +1 -1
- data/spec/models/logicals_spec.rb +1 -1
- data/spec/models/media_format_spec.rb +1 -1
- data/spec/models/media_spec.rb +1 -1
- data/spec/models/media_type_spec.rb +1 -1
- data/spec/models/nested_entity_spec.rb +1 -1
- data/spec/models/parameter_spec.rb +1 -1
- data/spec/models/query_spec.rb +1 -1
- data/spec/models/rank_spec.rb +1 -1
- data/spec/models/rankings_spec.rb +1 -1
- data/spec/models/related_stories_spec.rb +1 -1
- data/spec/models/representative_story_spec.rb +1 -1
- data/spec/models/scope_level_spec.rb +1 -1
- data/spec/models/scope_spec.rb +1 -1
- data/spec/models/sentiment_polarity_spec.rb +1 -1
- data/spec/models/sentiment_spec.rb +1 -1
- data/spec/models/sentiments_spec.rb +1 -1
- data/spec/models/share_count_spec.rb +1 -1
- data/spec/models/share_counts_spec.rb +1 -1
- data/spec/models/source_spec.rb +1 -1
- data/spec/models/stories_spec.rb +1 -1
- data/spec/models/story_cluster_spec.rb +1 -1
- data/spec/models/story_links_spec.rb +1 -1
- data/spec/models/story_spec.rb +13 -1
- data/spec/models/story_translation_spec.rb +1 -1
- data/spec/models/story_translations_spec.rb +1 -1
- data/spec/models/summary_spec.rb +1 -1
- data/spec/models/time_series_list_spec.rb +1 -1
- data/spec/models/time_series_spec.rb +1 -1
- data/spec/models/trend_spec.rb +1 -1
- data/spec/models/trends_spec.rb +1 -1
- data/spec/models/warning_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ed521ac7f54ea834a6201035617917fe2c9c5571e2f18a7523c040b88abe44c2
|
4
|
+
data.tar.gz: c37a76cfeb3ad403e15ca2ba642cc0d6d15ca18536eec7b8babea035b52a385c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0e262725e668e59cb8db6b930e9da543b49bd8282945d57228def074489ae90d33385a12e25baf7b573c26bfa9f5e8091de4ec1dc705870a1f32a241077da07a
|
7
|
+
data.tar.gz: b991302db8fb63eeb3f9fdc339233ebce1e17a7c2e8c8e4460944d07c40c1406f0afbf49ae5b3ea11aa6a24070e18217aa769f191632e135c275ec84b45e636e
|
data/README.md
CHANGED
@@ -1,22 +1,46 @@
|
|
1
|
-
#
|
1
|
+
# aylien_news_api
|
2
2
|
|
3
|
-
|
3
|
+
AylienNewsApi - the Ruby gem for the AYLIEN News API
|
4
4
|
|
5
|
-
|
5
|
+
The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
6
6
|
|
7
|
-
|
7
|
+
|
8
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
9
|
+
|
10
|
+
- API version: 5.2.2
|
11
|
+
- Package version: 5.2.2
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
13
|
+
For more information, please visit [https://newsapi.aylien.com/](https://newsapi.aylien.com/)
|
8
14
|
|
9
15
|
## Installation
|
10
16
|
|
11
|
-
|
17
|
+
### Build a gem
|
18
|
+
|
19
|
+
To build the Ruby code into a gem:
|
20
|
+
|
21
|
+
```shell
|
22
|
+
gem build aylien_news_api.gemspec
|
23
|
+
```
|
24
|
+
|
25
|
+
Then either install the gem locally:
|
12
26
|
|
13
|
-
|
27
|
+
```shell
|
28
|
+
gem install ./aylien_news_api-5.2.2.gem
|
29
|
+
```
|
30
|
+
|
31
|
+
(for development, run `gem install --dev ./aylien_news_api-5.2.2.gem` to install the development dependencies)
|
32
|
+
|
33
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
34
|
+
|
35
|
+
Finally add this to the Gemfile:
|
36
|
+
|
37
|
+
gem 'aylien_news_api', '~> 5.2.2'
|
14
38
|
|
15
39
|
### Install from Git
|
16
40
|
|
17
|
-
If the Ruby gem is hosted at a git repository: https://github.com/
|
41
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
18
42
|
|
19
|
-
gem 'aylien_news_api', :git => 'https://github.com/
|
43
|
+
gem 'aylien_news_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
20
44
|
|
21
45
|
### Include the Ruby code directly
|
22
46
|
|
@@ -29,39 +53,44 @@ ruby -Ilib script.rb
|
|
29
53
|
## Getting Started
|
30
54
|
|
31
55
|
Please follow the [installation](#installation) procedure and then run the following code:
|
56
|
+
|
32
57
|
```ruby
|
33
58
|
# Load the gem
|
34
59
|
require 'aylien_news_api'
|
35
60
|
|
36
61
|
# Setup authorization
|
37
62
|
AylienNewsApi.configure do |config|
|
38
|
-
|
39
|
-
config.api_key['X-AYLIEN-NewsAPI-Application-
|
63
|
+
# Configure API key authorization: app_id
|
64
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
|
65
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
66
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
|
67
|
+
|
68
|
+
# Configure API key authorization: app_key
|
69
|
+
config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
|
70
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
71
|
+
#config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
|
40
72
|
end
|
41
73
|
|
42
74
|
api_instance = AylienNewsApi::DefaultApi.new
|
43
|
-
|
75
|
+
unknown_base_type = {"$and":[{"$or":[{"body":{"$text":"Tim Cook"}},{"social.shares.count.reddit.max":{"$gte":5000,"$boost":5}}]},{"entity":{"$and":[{"name":{"$text":"Apple","$boost":2}},{"$not":[{"type":{"$eq":"Fruit"}}]}]}}]} # UNKNOWN_BASE_TYPE | /stories body schema to perform an advanced search with logical operators and nested objects.
|
44
76
|
opts = {
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
]
|
51
|
-
|
52
|
-
sort_by: 'social_shares_count.facebook'
|
77
|
+
published_at_start: 'published_at_start_example', # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
78
|
+
published_at_end: 'published_at_end_example', # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
79
|
+
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
80
|
+
sort_by: 'published_at', # String | This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
|
81
|
+
sort_direction: 'desc', # String | This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
|
82
|
+
cursor: '*', # String | This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
|
83
|
+
per_page: 10 # Integer | This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results)
|
53
84
|
}
|
54
85
|
|
55
|
-
|
56
86
|
begin
|
57
|
-
|
58
|
-
result.
|
59
|
-
|
60
|
-
end
|
87
|
+
#List Stories
|
88
|
+
result = api_instance.advanced_list_stories(unknown_base_type, opts)
|
89
|
+
p result
|
61
90
|
rescue AylienNewsApi::ApiError => e
|
62
|
-
puts "Exception when calling DefaultApi->
|
63
|
-
puts e.response_body
|
91
|
+
puts "Exception when calling DefaultApi->advanced_list_stories: #{e}"
|
64
92
|
end
|
93
|
+
|
65
94
|
```
|
66
95
|
|
67
96
|
## Documentation for API Endpoints
|
@@ -70,11 +99,12 @@ All URIs are relative to *https://api.aylien.com/news*
|
|
70
99
|
|
71
100
|
Class | Method | HTTP request | Description
|
72
101
|
------------ | ------------- | ------------- | -------------
|
102
|
+
*AylienNewsApi::DefaultApi* | [**advanced_list_stories**](docs/DefaultApi.md#advanced_list_stories) | **POST** /stories | List Stories
|
73
103
|
*AylienNewsApi::DefaultApi* | [**list_autocompletes**](docs/DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
|
74
104
|
*AylienNewsApi::DefaultApi* | [**list_clusters**](docs/DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
|
75
|
-
*AylienNewsApi::DefaultApi* | [**list_coverages**](docs/DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
|
76
105
|
*AylienNewsApi::DefaultApi* | [**list_histograms**](docs/DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
|
77
|
-
*AylienNewsApi::DefaultApi* | [**
|
106
|
+
*AylienNewsApi::DefaultApi* | [**list_related_stories_get**](docs/DefaultApi.md#list_related_stories_get) | **GET** /related_stories |
|
107
|
+
*AylienNewsApi::DefaultApi* | [**list_related_stories_post**](docs/DefaultApi.md#list_related_stories_post) | **POST** /related_stories |
|
78
108
|
*AylienNewsApi::DefaultApi* | [**list_stories**](docs/DefaultApi.md#list_stories) | **GET** /stories | List Stories
|
79
109
|
*AylienNewsApi::DefaultApi* | [**list_time_series**](docs/DefaultApi.md#list_time_series) | **GET** /time_series | List time series
|
80
110
|
*AylienNewsApi::DefaultApi* | [**list_trends**](docs/DefaultApi.md#list_trends) | **GET** /trends | List trends
|
@@ -82,30 +112,45 @@ Class | Method | HTTP request | Description
|
|
82
112
|
|
83
113
|
## Documentation for Models
|
84
114
|
|
115
|
+
- [AylienNewsApi::AggregatedSentiment](docs/AggregatedSentiment.md)
|
85
116
|
- [AylienNewsApi::Author](docs/Author.md)
|
86
117
|
- [AylienNewsApi::Autocomplete](docs/Autocomplete.md)
|
87
118
|
- [AylienNewsApi::Autocompletes](docs/Autocompletes.md)
|
88
119
|
- [AylienNewsApi::Category](docs/Category.md)
|
89
120
|
- [AylienNewsApi::CategoryLinks](docs/CategoryLinks.md)
|
121
|
+
- [AylienNewsApi::CategoryTaxonomy](docs/CategoryTaxonomy.md)
|
90
122
|
- [AylienNewsApi::Cluster](docs/Cluster.md)
|
91
123
|
- [AylienNewsApi::Clusters](docs/Clusters.md)
|
92
|
-
- [AylienNewsApi::
|
93
|
-
- [AylienNewsApi::Entities](docs/Entities.md)
|
124
|
+
- [AylienNewsApi::DunsNumber](docs/DunsNumber.md)
|
94
125
|
- [AylienNewsApi::Entity](docs/Entity.md)
|
126
|
+
- [AylienNewsApi::EntityInText](docs/EntityInText.md)
|
95
127
|
- [AylienNewsApi::EntityLinks](docs/EntityLinks.md)
|
128
|
+
- [AylienNewsApi::EntityMention](docs/EntityMention.md)
|
129
|
+
- [AylienNewsApi::EntityMentionIndex](docs/EntityMentionIndex.md)
|
130
|
+
- [AylienNewsApi::EntitySentiment](docs/EntitySentiment.md)
|
131
|
+
- [AylienNewsApi::EntitySurfaceForm](docs/EntitySurfaceForm.md)
|
96
132
|
- [AylienNewsApi::Error](docs/Error.md)
|
97
133
|
- [AylienNewsApi::ErrorLinks](docs/ErrorLinks.md)
|
98
134
|
- [AylienNewsApi::Errors](docs/Errors.md)
|
135
|
+
- [AylienNewsApi::ExternalIds](docs/ExternalIds.md)
|
99
136
|
- [AylienNewsApi::HistogramInterval](docs/HistogramInterval.md)
|
100
137
|
- [AylienNewsApi::Histograms](docs/Histograms.md)
|
101
138
|
- [AylienNewsApi::Location](docs/Location.md)
|
139
|
+
- [AylienNewsApi::Logicals](docs/Logicals.md)
|
102
140
|
- [AylienNewsApi::Media](docs/Media.md)
|
141
|
+
- [AylienNewsApi::MediaFormat](docs/MediaFormat.md)
|
142
|
+
- [AylienNewsApi::MediaType](docs/MediaType.md)
|
143
|
+
- [AylienNewsApi::NestedEntity](docs/NestedEntity.md)
|
144
|
+
- [AylienNewsApi::Parameter](docs/Parameter.md)
|
145
|
+
- [AylienNewsApi::Query](docs/Query.md)
|
103
146
|
- [AylienNewsApi::Rank](docs/Rank.md)
|
104
147
|
- [AylienNewsApi::Rankings](docs/Rankings.md)
|
105
148
|
- [AylienNewsApi::RelatedStories](docs/RelatedStories.md)
|
106
149
|
- [AylienNewsApi::RepresentativeStory](docs/RepresentativeStory.md)
|
107
150
|
- [AylienNewsApi::Scope](docs/Scope.md)
|
151
|
+
- [AylienNewsApi::ScopeLevel](docs/ScopeLevel.md)
|
108
152
|
- [AylienNewsApi::Sentiment](docs/Sentiment.md)
|
153
|
+
- [AylienNewsApi::SentimentPolarity](docs/SentimentPolarity.md)
|
109
154
|
- [AylienNewsApi::Sentiments](docs/Sentiments.md)
|
110
155
|
- [AylienNewsApi::ShareCount](docs/ShareCount.md)
|
111
156
|
- [AylienNewsApi::ShareCounts](docs/ShareCounts.md)
|
@@ -114,10 +159,30 @@ Class | Method | HTTP request | Description
|
|
114
159
|
- [AylienNewsApi::Story](docs/Story.md)
|
115
160
|
- [AylienNewsApi::StoryCluster](docs/StoryCluster.md)
|
116
161
|
- [AylienNewsApi::StoryLinks](docs/StoryLinks.md)
|
162
|
+
- [AylienNewsApi::StoryTranslation](docs/StoryTranslation.md)
|
117
163
|
- [AylienNewsApi::StoryTranslations](docs/StoryTranslations.md)
|
118
|
-
- [AylienNewsApi::StoryTranslationsEn](docs/StoryTranslationsEn.md)
|
119
164
|
- [AylienNewsApi::Summary](docs/Summary.md)
|
120
165
|
- [AylienNewsApi::TimeSeries](docs/TimeSeries.md)
|
121
166
|
- [AylienNewsApi::TimeSeriesList](docs/TimeSeriesList.md)
|
122
167
|
- [AylienNewsApi::Trend](docs/Trend.md)
|
123
168
|
- [AylienNewsApi::Trends](docs/Trends.md)
|
169
|
+
- [AylienNewsApi::Warning](docs/Warning.md)
|
170
|
+
|
171
|
+
|
172
|
+
## Documentation for Authorization
|
173
|
+
|
174
|
+
|
175
|
+
### app_id
|
176
|
+
|
177
|
+
|
178
|
+
- **Type**: API key
|
179
|
+
- **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
|
180
|
+
- **Location**: HTTP header
|
181
|
+
|
182
|
+
### app_key
|
183
|
+
|
184
|
+
|
185
|
+
- **Type**: API key
|
186
|
+
- **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
|
187
|
+
- **Location**: HTTP header
|
188
|
+
|
data/aylien_news_api.gemspec
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
7
7
|
|
8
|
-
The version of the OpenAPI document: 5.
|
8
|
+
The version of the OpenAPI document: 5.2.2
|
9
9
|
Contact: support@aylien.com
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
11
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
data/docs/Category.md
CHANGED
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
|
|
8
8
|
**id** | **String** | The ID of the category | [optional]
|
9
9
|
**label** | **String** | The label of the category | [optional]
|
10
10
|
**level** | **Integer** | The level of the category | [optional]
|
11
|
-
**links** | [**CategoryLinks**](CategoryLinks.md) | | [optional]
|
12
11
|
**score** | **Float** | The score of the category | [optional]
|
13
12
|
**taxonomy** | [**CategoryTaxonomy**](CategoryTaxonomy.md) | | [optional]
|
13
|
+
**links** | [**CategoryLinks**](CategoryLinks.md) | | [optional]
|
14
14
|
|
15
15
|
## Code Sample
|
16
16
|
|
@@ -21,9 +21,9 @@ instance = AylienNewsApi::Category.new(confident: null,
|
|
21
21
|
id: null,
|
22
22
|
label: null,
|
23
23
|
level: null,
|
24
|
-
links: null,
|
25
24
|
score: null,
|
26
|
-
taxonomy: null
|
25
|
+
taxonomy: null,
|
26
|
+
links: null)
|
27
27
|
```
|
28
28
|
|
29
29
|
|
data/docs/CategoryLinks.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**parent** | **String** | A URL pointing to the parent category | [optional]
|
8
|
+
**parents** | **Array<String>** | A collection of URLs pointing to the category parents | [optional]
|
8
9
|
**_self** | **String** | A URL pointing to the category | [optional]
|
9
10
|
|
10
11
|
## Code Sample
|
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'AylienNewsApi'
|
14
15
|
|
15
16
|
instance = AylienNewsApi::CategoryLinks.new(parent: null,
|
17
|
+
parents: null,
|
16
18
|
_self: null)
|
17
19
|
```
|
18
20
|
|
data/docs/DeprecatedStory.md
CHANGED
@@ -17,7 +17,8 @@ Name | Type | Description | Notes
|
|
17
17
|
**links** | [**StoryLinks**](StoryLinks.md) | | [optional]
|
18
18
|
**media** | [**Array<Media>**](Media.md) | An array of extracted media such as images and videos | [optional]
|
19
19
|
**paragraphs_count** | **Integer** | Paragraph count of the story body | [optional]
|
20
|
-
**
|
20
|
+
**published_datetime** | **DateTime** | Publication time of the story, if available, otherwise time of acquisition | [optional]
|
21
|
+
**published_at** | **DateTime** | Acquisition time of the story | [optional]
|
21
22
|
**sentences_count** | **Integer** | Sentence count of the story body | [optional]
|
22
23
|
**sentiment** | [**Sentiments**](Sentiments.md) | | [optional]
|
23
24
|
**social_shares_count** | [**ShareCounts**](ShareCounts.md) | | [optional]
|
@@ -27,6 +28,7 @@ Name | Type | Description | Notes
|
|
27
28
|
**translations** | [**StoryTranslations**](StoryTranslations.md) | | [optional]
|
28
29
|
**words_count** | **Integer** | Word count of the story body | [optional]
|
29
30
|
**license_type** | **Integer** | License type of the story | [optional]
|
31
|
+
**industries** | [**Array<Category>**](Category.md) | An array of industries categories | [optional]
|
30
32
|
|
31
33
|
## Code Sample
|
32
34
|
|
@@ -46,6 +48,7 @@ instance = AylienNewsApi::DeprecatedStory.new(author: null,
|
|
46
48
|
links: null,
|
47
49
|
media: null,
|
48
50
|
paragraphs_count: null,
|
51
|
+
published_datetime: null,
|
49
52
|
published_at: null,
|
50
53
|
sentences_count: null,
|
51
54
|
sentiment: null,
|
@@ -55,7 +58,8 @@ instance = AylienNewsApi::DeprecatedStory.new(author: null,
|
|
55
58
|
title: null,
|
56
59
|
translations: null,
|
57
60
|
words_count: null,
|
58
|
-
license_type: null
|
61
|
+
license_type: null,
|
62
|
+
industries: null)
|
59
63
|
```
|
60
64
|
|
61
65
|
|
data/docs/DunsNumber.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# AylienNewsApi::DunsNumber
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'AylienNewsApi'
|
13
|
+
|
14
|
+
instance = AylienNewsApi::DunsNumber.new(id: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/Entity.md
CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**overall_frequency** | **Integer** | Amount of entity surface form mentions in the article | [optional]
|
14
14
|
**body** | [**EntityInText**](EntityInText.md) | | [optional]
|
15
15
|
**title** | [**EntityInText**](EntityInText.md) | | [optional]
|
16
|
+
**external_ids** | [**ExternalIds**](ExternalIds.md) | | [optional]
|
16
17
|
|
17
18
|
## Code Sample
|
18
19
|
|
@@ -27,7 +28,8 @@ instance = AylienNewsApi::Entity.new(id: null,
|
|
27
28
|
overall_prominence: null,
|
28
29
|
overall_frequency: null,
|
29
30
|
body: null,
|
30
|
-
title: null
|
31
|
+
title: null,
|
32
|
+
external_ids: null)
|
31
33
|
```
|
32
34
|
|
33
35
|
|
data/docs/Error.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**detail** | **String** | | [optional]
|
9
9
|
**id** | **String** | | [optional]
|
10
10
|
**links** | [**ErrorLinks**](ErrorLinks.md) | | [optional]
|
11
|
-
**status** | **
|
11
|
+
**status** | **Float** | | [optional]
|
12
12
|
**title** | **String** | | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|
data/docs/ExternalIds.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# AylienNewsApi::ExternalIds
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**duns** | [**Array<DunsNumber>**](DunsNumber.md) | DUNS number(s) of the entity | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'AylienNewsApi'
|
13
|
+
|
14
|
+
instance = AylienNewsApi::ExternalIds.new(duns: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/Story.md
CHANGED
@@ -17,7 +17,8 @@ Name | Type | Description | Notes
|
|
17
17
|
**links** | [**StoryLinks**](StoryLinks.md) | | [optional]
|
18
18
|
**media** | [**Array<Media>**](Media.md) | An array of extracted media such as images and videos | [optional]
|
19
19
|
**paragraphs_count** | **Integer** | Paragraph count of the story body | [optional]
|
20
|
-
**
|
20
|
+
**published_datetime** | **DateTime** | Publication time of the story, if available, otherwise time of acquisition | [optional]
|
21
|
+
**published_at** | **DateTime** | Acquisition time of the story | [optional]
|
21
22
|
**sentences_count** | **Integer** | Sentence count of the story body | [optional]
|
22
23
|
**sentiment** | [**Sentiments**](Sentiments.md) | | [optional]
|
23
24
|
**social_shares_count** | [**ShareCounts**](ShareCounts.md) | | [optional]
|
@@ -27,6 +28,7 @@ Name | Type | Description | Notes
|
|
27
28
|
**translations** | [**StoryTranslations**](StoryTranslations.md) | | [optional]
|
28
29
|
**words_count** | **Integer** | Word count of the story body | [optional]
|
29
30
|
**license_type** | **Integer** | License type of the story | [optional]
|
31
|
+
**industries** | [**Array<Category>**](Category.md) | An array of industries categories | [optional]
|
30
32
|
|
31
33
|
## Code Sample
|
32
34
|
|
@@ -46,6 +48,7 @@ instance = AylienNewsApi::Story.new(author: null,
|
|
46
48
|
links: null,
|
47
49
|
media: null,
|
48
50
|
paragraphs_count: null,
|
51
|
+
published_datetime: null,
|
49
52
|
published_at: null,
|
50
53
|
sentences_count: null,
|
51
54
|
sentiment: null,
|
@@ -55,7 +58,8 @@ instance = AylienNewsApi::Story.new(author: null,
|
|
55
58
|
title: null,
|
56
59
|
translations: null,
|
57
60
|
words_count: null,
|
58
|
-
license_type: null
|
61
|
+
license_type: null,
|
62
|
+
industries: null)
|
59
63
|
```
|
60
64
|
|
61
65
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 5.
|
6
|
+
The version of the OpenAPI document: 5.2.2
|
7
7
|
Contact: support@aylien.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
@@ -26,13 +26,13 @@ module AylienNewsApi
|
|
26
26
|
# The level of the category
|
27
27
|
attr_accessor :level
|
28
28
|
|
29
|
-
attr_accessor :links
|
30
|
-
|
31
29
|
# The score of the category
|
32
30
|
attr_accessor :score
|
33
31
|
|
34
32
|
attr_accessor :taxonomy
|
35
33
|
|
34
|
+
attr_accessor :links
|
35
|
+
|
36
36
|
# Attribute mapping from ruby-style variable name to JSON key.
|
37
37
|
def self.attribute_map
|
38
38
|
{
|
@@ -40,9 +40,9 @@ module AylienNewsApi
|
|
40
40
|
:'id' => :'id',
|
41
41
|
:'label' => :'label',
|
42
42
|
:'level' => :'level',
|
43
|
-
:'links' => :'links',
|
44
43
|
:'score' => :'score',
|
45
|
-
:'taxonomy' => :'taxonomy'
|
44
|
+
:'taxonomy' => :'taxonomy',
|
45
|
+
:'links' => :'links'
|
46
46
|
}
|
47
47
|
end
|
48
48
|
|
@@ -53,15 +53,17 @@ module AylienNewsApi
|
|
53
53
|
:'id' => :'String',
|
54
54
|
:'label' => :'String',
|
55
55
|
:'level' => :'Integer',
|
56
|
-
:'links' => :'CategoryLinks',
|
57
56
|
:'score' => :'Float',
|
58
|
-
:'taxonomy' => :'CategoryTaxonomy'
|
57
|
+
:'taxonomy' => :'CategoryTaxonomy',
|
58
|
+
:'links' => :'CategoryLinks'
|
59
59
|
}
|
60
60
|
end
|
61
61
|
|
62
62
|
# List of attributes with nullable: true
|
63
63
|
def self.openapi_nullable
|
64
64
|
Set.new([
|
65
|
+
:'confident',
|
66
|
+
:'level',
|
65
67
|
])
|
66
68
|
end
|
67
69
|
|
@@ -96,10 +98,6 @@ module AylienNewsApi
|
|
96
98
|
self.level = attributes[:'level']
|
97
99
|
end
|
98
100
|
|
99
|
-
if attributes.key?(:'links')
|
100
|
-
self.links = attributes[:'links']
|
101
|
-
end
|
102
|
-
|
103
101
|
if attributes.key?(:'score')
|
104
102
|
self.score = attributes[:'score']
|
105
103
|
end
|
@@ -107,21 +105,49 @@ module AylienNewsApi
|
|
107
105
|
if attributes.key?(:'taxonomy')
|
108
106
|
self.taxonomy = attributes[:'taxonomy']
|
109
107
|
end
|
108
|
+
|
109
|
+
if attributes.key?(:'links')
|
110
|
+
self.links = attributes[:'links']
|
111
|
+
end
|
110
112
|
end
|
111
113
|
|
112
114
|
# Show invalid properties with the reasons. Usually used together with valid?
|
113
115
|
# @return Array for valid properties with the reasons
|
114
116
|
def list_invalid_properties
|
115
117
|
invalid_properties = Array.new
|
118
|
+
if !@score.nil? && @score > 1
|
119
|
+
invalid_properties.push('invalid value for "score", must be smaller than or equal to 1.')
|
120
|
+
end
|
121
|
+
|
122
|
+
if !@score.nil? && @score < 0
|
123
|
+
invalid_properties.push('invalid value for "score", must be greater than or equal to 0.')
|
124
|
+
end
|
125
|
+
|
116
126
|
invalid_properties
|
117
127
|
end
|
118
128
|
|
119
129
|
# Check to see if the all the properties in the model are valid
|
120
130
|
# @return true if the model is valid
|
121
131
|
def valid?
|
132
|
+
return false if !@score.nil? && @score > 1
|
133
|
+
return false if !@score.nil? && @score < 0
|
122
134
|
true
|
123
135
|
end
|
124
136
|
|
137
|
+
# Custom attribute writer method with validation
|
138
|
+
# @param [Object] score Value to be assigned
|
139
|
+
def score=(score)
|
140
|
+
if !score.nil? && score > 1
|
141
|
+
fail ArgumentError, 'invalid value for "score", must be smaller than or equal to 1.'
|
142
|
+
end
|
143
|
+
|
144
|
+
if !score.nil? && score < 0
|
145
|
+
fail ArgumentError, 'invalid value for "score", must be greater than or equal to 0.'
|
146
|
+
end
|
147
|
+
|
148
|
+
@score = score
|
149
|
+
end
|
150
|
+
|
125
151
|
# Checks equality by comparing each attribute.
|
126
152
|
# @param [Object] Object to be compared
|
127
153
|
def ==(o)
|
@@ -131,9 +157,9 @@ module AylienNewsApi
|
|
131
157
|
id == o.id &&
|
132
158
|
label == o.label &&
|
133
159
|
level == o.level &&
|
134
|
-
links == o.links &&
|
135
160
|
score == o.score &&
|
136
|
-
taxonomy == o.taxonomy
|
161
|
+
taxonomy == o.taxonomy &&
|
162
|
+
links == o.links
|
137
163
|
end
|
138
164
|
|
139
165
|
# @see the `==` method
|
@@ -145,7 +171,7 @@ module AylienNewsApi
|
|
145
171
|
# Calculates hash code according to all attributes.
|
146
172
|
# @return [Integer] Hash code
|
147
173
|
def hash
|
148
|
-
[confident, id, label, level,
|
174
|
+
[confident, id, label, level, score, taxonomy, links].hash
|
149
175
|
end
|
150
176
|
|
151
177
|
# Builds the object from hash
|