aylien_news_api 4.7.4 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a6ecea5dd7dabb878d272622553d60bdadb008e915fabbc00b81175ba96721d
-  data.tar.gz: 60b0ae38e3396a1af2c0da577c8350e8199ae12036a2af66c82f06fb024eaae3
+  metadata.gz: b19f4ae2c8b345c9b791e50815ceb528466257248836ff5c90a288e259df5c3c
+  data.tar.gz: eb8aa79891648467d88b7505dd4a9cec2ef570dda2f1dd8efe9238665c00399b
 SHA512:
-  metadata.gz: 99ddca6ae7aedb8852a382555e04772cab71df3ba58aa22b9c8f7fd4c5f0a48f1e8cb4db03579408b8085e06fde6a664dc29a3f4e37d1ca3c847e34be20b3e34
-  data.tar.gz: f9d1896054628711387166955045ab21237524fdee1d135902971fe25894072c35075ffb008160f7785fdf0d97cb191fb8aa445d0ff96b2551d1d6f8e8ff0c35
+  metadata.gz: 91e6217396810c61419a085d74b2e9a86174873c7b68b83cc61b8c80af347327ff8ab41388627ad3695463b0124b8b679bbbe97b6cfb3f7983f3b35c6356b82c
+  data.tar.gz: af0651c8e6d4ae1839a070707c175f3b757cf2de6f54972166bbf01865969fff4afb427442eecf96a9cafbdf15f245b1c18cb4e620a57bbc723fafb78a5bb216

data/README.md

@@ -1,46 +1,22 @@
-# aylien_news_api
+# AYLIEN News API - Ruby SDK
 
-AylienNewsApi - the Ruby gem for the AYLIEN News API
+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. 
 
-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.
+Sign up at [https://newsapi.aylien.com/](https://newsapi.aylien.com/).
 
-
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 4.7.4
-- Package version: 4.7.4
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [https://newsapi.aylien.com/](https://newsapi.aylien.com/)
+For more documentation see [https://newsapi.aylien.com/docs/](https://newsapi.aylien.com/docs/).
 
 ## Installation
 
-### Build a gem
-
-To build the Ruby code into a gem:
-
-```shell
-gem build aylien_news_api.gemspec
-```
-
-Then either install the gem locally:
+Add this to the Gemfile:
 
-```shell
-gem install ./aylien_news_api-4.7.4.gem
-```
-
-(for development, run `gem install --dev ./aylien_news_api-4.7.4.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-
-Finally add this to the Gemfile:
-
-    gem 'aylien_news_api', '~> 4.7.4'
+    gem 'aylien_news_api', '~> 3.0.0'
 
 ### Install from Git
 
-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:
+If the Ruby gem is hosted at a git repository: https://github.com/aylien/aylien_newsapi_ruby, then add the following in the Gemfile:
 
-    gem 'aylien_news_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+    gem 'aylien_news_api', :git => 'https://github.com/aylien/aylien_newsapi_ruby.git'
 
 ### Include the Ruby code directly
 
@@ -53,44 +29,39 @@ ruby -Ilib script.rb
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
-
 ```ruby
 # Load the gem
 require 'aylien_news_api'
 
 # Setup authorization
 AylienNewsApi.configure do |config|
-  # Configure API key authorization: app_id
-  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'Bearer'
-
-  # Configure API key authorization: app_key
-  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-AYLIEN-NewsAPI-Application-Key'] = 'Bearer'
+  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = ENV['NEWSAPI_APP_ID']
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = ENV['NEWSAPI_APP_KEY']
 end
 
 api_instance = AylienNewsApi::DefaultApi.new
-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. 
+
 opts = {
-  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). 
-  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). 
-  _return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
-  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). 
-  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). 
-  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). 
-  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) 
+  title: 'trump',
+  published_at_start: "NOW-7DAYS",
+  published_at_end: "NOW",
+  entities_body_links_dbpedia: [
+    'http://dbpedia.org/resource/Donald_Trump',
+  ],
+  not_language: ['en'],
+  sort_by: 'social_shares_count.facebook'
 }
 
+
 begin
-  #List Stories
-  result = api_instance.advanced_list_stories(unknown_base_type, opts)
-  p result
+  result = api_instance.list_stories(opts)
+  result.stories.each do |story|
+    puts "#{story.title} / #{story.source.name}"
+  end
 rescue AylienNewsApi::ApiError => e
-  puts "Exception when calling DefaultApi->advanced_list_stories: #{e}"
+  puts "Exception when calling DefaultApi->list_stories: #{e}"
+  puts e.response_body
 end
-
 ```
 
 ## Documentation for API Endpoints
@@ -99,12 +70,11 @@ All URIs are relative to *https://api.aylien.com/news*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*AylienNewsApi::DefaultApi* | [**advanced_list_stories**](docs/DefaultApi.md#advanced_list_stories) | **POST** /stories | List Stories
 *AylienNewsApi::DefaultApi* | [**list_autocompletes**](docs/DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
 *AylienNewsApi::DefaultApi* | [**list_clusters**](docs/DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
+*AylienNewsApi::DefaultApi* | [**list_coverages**](docs/DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
 *AylienNewsApi::DefaultApi* | [**list_histograms**](docs/DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
-*AylienNewsApi::DefaultApi* | [**list_related_stories_get**](docs/DefaultApi.md#list_related_stories_get) | **GET** /related_stories | 
-*AylienNewsApi::DefaultApi* | [**list_related_stories_post**](docs/DefaultApi.md#list_related_stories_post) | **POST** /related_stories | 
+*AylienNewsApi::DefaultApi* | [**list_related_stories**](docs/DefaultApi.md#list_related_stories) | **GET** /related_stories | List related stories
 *AylienNewsApi::DefaultApi* | [**list_stories**](docs/DefaultApi.md#list_stories) | **GET** /stories | List Stories
 *AylienNewsApi::DefaultApi* | [**list_time_series**](docs/DefaultApi.md#list_time_series) | **GET** /time_series | List time series
 *AylienNewsApi::DefaultApi* | [**list_trends**](docs/DefaultApi.md#list_trends) | **GET** /trends | List trends
@@ -112,78 +82,42 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
- - [AylienNewsApi::AggregatedSentiment](docs/AggregatedSentiment.md)
  - [AylienNewsApi::Author](docs/Author.md)
  - [AylienNewsApi::Autocomplete](docs/Autocomplete.md)
  - [AylienNewsApi::Autocompletes](docs/Autocompletes.md)
  - [AylienNewsApi::Category](docs/Category.md)
  - [AylienNewsApi::CategoryLinks](docs/CategoryLinks.md)
- - [AylienNewsApi::CategoryTaxonomy](docs/CategoryTaxonomy.md)
  - [AylienNewsApi::Cluster](docs/Cluster.md)
  - [AylienNewsApi::Clusters](docs/Clusters.md)
- - [AylienNewsApi::DeprecatedEntities](docs/DeprecatedEntities.md)
- - [AylienNewsApi::DeprecatedEntity](docs/DeprecatedEntity.md)
- - [AylienNewsApi::DeprecatedEntitySurfaceForm](docs/DeprecatedEntitySurfaceForm.md)
- - [AylienNewsApi::DeprecatedRelatedStories](docs/DeprecatedRelatedStories.md)
- - [AylienNewsApi::DeprecatedStories](docs/DeprecatedStories.md)
- - [AylienNewsApi::DeprecatedStory](docs/DeprecatedStory.md)
+ - [AylienNewsApi::Coverages](docs/Coverages.md)
+ - [AylienNewsApi::Entities](docs/Entities.md)
  - [AylienNewsApi::Entity](docs/Entity.md)
- - [AylienNewsApi::EntityInText](docs/EntityInText.md)
  - [AylienNewsApi::EntityLinks](docs/EntityLinks.md)
- - [AylienNewsApi::EntityMention](docs/EntityMention.md)
- - [AylienNewsApi::EntityMentionIndex](docs/EntityMentionIndex.md)
- - [AylienNewsApi::EntitySentiment](docs/EntitySentiment.md)
- - [AylienNewsApi::EntitySurfaceForm](docs/EntitySurfaceForm.md)
  - [AylienNewsApi::Error](docs/Error.md)
  - [AylienNewsApi::ErrorLinks](docs/ErrorLinks.md)
  - [AylienNewsApi::Errors](docs/Errors.md)
  - [AylienNewsApi::HistogramInterval](docs/HistogramInterval.md)
  - [AylienNewsApi::Histograms](docs/Histograms.md)
  - [AylienNewsApi::Location](docs/Location.md)
- - [AylienNewsApi::Logicals](docs/Logicals.md)
  - [AylienNewsApi::Media](docs/Media.md)
- - [AylienNewsApi::MediaFormat](docs/MediaFormat.md)
- - [AylienNewsApi::MediaType](docs/MediaType.md)
- - [AylienNewsApi::NestedEntity](docs/NestedEntity.md)
- - [AylienNewsApi::Parameter](docs/Parameter.md)
- - [AylienNewsApi::Query](docs/Query.md)
  - [AylienNewsApi::Rank](docs/Rank.md)
  - [AylienNewsApi::Rankings](docs/Rankings.md)
+ - [AylienNewsApi::RelatedStories](docs/RelatedStories.md)
  - [AylienNewsApi::RepresentativeStory](docs/RepresentativeStory.md)
  - [AylienNewsApi::Scope](docs/Scope.md)
- - [AylienNewsApi::ScopeLevel](docs/ScopeLevel.md)
  - [AylienNewsApi::Sentiment](docs/Sentiment.md)
- - [AylienNewsApi::SentimentPolarity](docs/SentimentPolarity.md)
  - [AylienNewsApi::Sentiments](docs/Sentiments.md)
  - [AylienNewsApi::ShareCount](docs/ShareCount.md)
  - [AylienNewsApi::ShareCounts](docs/ShareCounts.md)
  - [AylienNewsApi::Source](docs/Source.md)
+ - [AylienNewsApi::Stories](docs/Stories.md)
+ - [AylienNewsApi::Story](docs/Story.md)
  - [AylienNewsApi::StoryCluster](docs/StoryCluster.md)
  - [AylienNewsApi::StoryLinks](docs/StoryLinks.md)
- - [AylienNewsApi::StoryTranslation](docs/StoryTranslation.md)
  - [AylienNewsApi::StoryTranslations](docs/StoryTranslations.md)
+ - [AylienNewsApi::StoryTranslationsEn](docs/StoryTranslationsEn.md)
  - [AylienNewsApi::Summary](docs/Summary.md)
  - [AylienNewsApi::TimeSeries](docs/TimeSeries.md)
  - [AylienNewsApi::TimeSeriesList](docs/TimeSeriesList.md)
  - [AylienNewsApi::Trend](docs/Trend.md)
  - [AylienNewsApi::Trends](docs/Trends.md)
- - [AylienNewsApi::Warning](docs/Warning.md)
-
-
-## Documentation for Authorization
-
-
-### app_id
-
-
-- **Type**: API key
-- **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
-- **Location**: HTTP header
-
-### app_key
-
-
-- **Type**: API key
-- **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
-- **Location**: HTTP header
-

data/aylien_news_api.gemspec

@@ -5,7 +5,7 @@
 
 #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. 
 
-The version of the OpenAPI document: 4.7.4
+The version of the OpenAPI document: 5.0
 Contact: support@aylien.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0-SNAPSHOT

data/docs/Category.md

@@ -8,9 +8,9 @@ Name | Type | Description | Notes
 **id** | **String** | The ID of the category | [optional] 
 **label** | **String** | The label of the category | [optional] 
 **level** | **Integer** | The level of the category | [optional] 
+**links** | [**CategoryLinks**](CategoryLinks.md) |  | [optional] 
 **score** | **Float** | The score of the category | [optional] 
 **taxonomy** | [**CategoryTaxonomy**](CategoryTaxonomy.md) |  | [optional] 
-**links** | [**CategoryLinks**](CategoryLinks.md) |  | [optional] 
 
 ## Code Sample
 
@@ -21,9 +21,9 @@ instance = AylienNewsApi::Category.new(confident: null,
                                  id: null,
                                  label: null,
                                  level: null,
+                                 links: null,
                                  score: null,
-                                 taxonomy: null,
-                                 links: null)
+                                 taxonomy: null)
 ```
 
 

data/docs/CategoryLinks.md

@@ -5,7 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **parent** | **String** | A URL pointing to the parent category | [optional] 
-**parents** | **Array<String>** | A collection of URLs pointing to the category parents | [optional] 
 **_self** | **String** | A URL pointing to the category | [optional] 
 
 ## Code Sample
@@ -14,7 +13,6 @@ Name | Type | Description | Notes
 require 'AylienNewsApi'
 
 instance = AylienNewsApi::CategoryLinks.new(parent: null,
-                                 parents: null,
                                  _self: null)
 ```