aylien_news_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0be76614a42729f87f38f3f2e1ae003141dc096
+  data.tar.gz: 5a335b88ce8a4b7aae8f99f9e6c025234c68e287
+SHA512:
+  metadata.gz: c3eaa2345e213ba28a09cf90f2cb7f96bf8a7a6e989bf1ac5aabb2f9cf49997c770493c88ee0cb4fc3d5e8fccaeff9f67e3703fc0c9d8fcd037404ee5f9164cd
+  data.tar.gz: d2ff1a3dcab1ca864dc17e2620a02035d16327f3122dd600038d0eab5f8a73fdead0f9d33a02216ebdca0fba7622dc8730dc3d4ae87dc66fc1aeea2dabe13540

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    aylien_news_api (0.0.1)
+      json (~> 1.4, >= 1.4.6)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.0)
+    addressable (2.4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.11)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    ethon (0.8.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.10)
+    hashdiff (0.3.0)
+    json (1.8.3)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.2)
+      ffi (>= 1.0.0)
+    typhoeus (1.0.1)
+      ethon (>= 0.8.0)
+    vcr (2.9.3)
+    webmock (1.24.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.11)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  aylien_news_api!
+  rake (~> 11.1, >= 11.1.2)
+  rspec (~> 3.2, >= 3.2.0)
+  vcr (~> 2.9, >= 2.9.3)
+  webmock (~> 1.6, >= 1.6.2)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,13 @@
+ Copyright 2016 Aylien, Inc. All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

data/README.md

@@ -0,0 +1,133 @@
+# AYLIEN News API
+[![Gem Version](https://badge.fury.io/rb/aylien_news_api.svg)](https://badge.fury.io/rb/aylien_news_api)
+
+The Ruby gem for the AYLIEN News API
+
+AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. If you haven't already done so, you will need to [sign up](https://newsapi.aylien.com/signup).
+
+## Installation
+
+### RubyGems
+
+Add this to the Gemfile:
+
+    gem 'aylien_news_api'
+
+or install it directly:
+
+	gem install aylien_news_api
+
+### Install from Git
+
+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/AYLIEN/aylien_newsapi_ruby.git'
+
+
+## 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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = {
+  :title => 'trump',
+  :published_at_start => "NOW-7DAYS",
+  :published_at_end => "NOW",
+  :entities_body_links_dbpedia => [
+    'http://dbpedia.org/resource/Donald_Trump',
+    'http://dbpedia.org/resource/Hillary_Rodham_Clinton'
+  ],
+  :language => ['en'],
+  :sort_by => 'social_shares_count.facebook'
+}
+
+
+begin
+  #List stories
+  result = api_instance.list_stories(opts)
+  puts result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_stories: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.newsapi.aylien.com/api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AylienNewsApi::DefaultApi* | [**list_autocompletes**](docs/DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
+*AylienNewsApi::DefaultApi* | [**list_coverages**](docs/DefaultApi.md#list_coverages) | **POST** /coverages | List coverages
+*AylienNewsApi::DefaultApi* | [**list_histograms**](docs/DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
+*AylienNewsApi::DefaultApi* | [**list_related_stories**](docs/DefaultApi.md#list_related_stories) | **POST** /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
+
+
+## Documentation for Models
+
+ - [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::Coverages](docs/Coverages.md)
+ - [AylienNewsApi::Entities](docs/Entities.md)
+ - [AylienNewsApi::Entity](docs/Entity.md)
+ - [AylienNewsApi::EntityLinks](docs/EntityLinks.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::Media](docs/Media.md)
+ - [AylienNewsApi::RelatedStories](docs/RelatedStories.md)
+ - [AylienNewsApi::Scope](docs/Scope.md)
+ - [AylienNewsApi::Sentiment](docs/Sentiment.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::Summary](docs/Summary.md)
+ - [AylienNewsApi::TimeSeries](docs/TimeSeries.md)
+ - [AylienNewsApi::TimeSeriesList](docs/TimeSeriesList.md)
+ - [AylienNewsApi::Trend](docs/Trend.md)
+ - [AylienNewsApi::Trends](docs/Trends.md)
+
+
+## Documentation for Authorization
+
+
+### app_key
+
+- **Type**: API key
+- **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
+- **Location**: HTTP header
+
+### app_id
+
+- **Type**: API key
+- **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/{api,models}/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/aylien_news_api.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "aylien_news_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aylien_news_api"
+  s.version     = AylienNewsApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["AYLIEN Inc.", "Hamed Ramezanian Nik"]
+  s.email       = ["support@aylien.com", "hamed.r.nik@gmail.com"]
+  s.homepage    = "https://newsapi.aylien.com/"
+  s.summary     = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content"
+  s.description = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content."
+  s.license     = "Apache-2.0"
+
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 1.4', '>= 1.4.6'
+
+  s.add_development_dependency 'rake', '~> 11.1', '>= 11.1.2'
+  s.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  s.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
+  s.add_development_dependency 'webmock', '~> 1.6', '>= 1.6.2'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Author.md

@@ -0,0 +1,10 @@
+# AylienNewsApi::Author
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | A unique identification for the author | [optional] 
+**name** | **String** | The extracted author full name | [optional] 
+**avatar_url** | **String** | A URL which points to the author avatar | [optional] 
+
+

data/docs/Autocomplete.md

@@ -0,0 +1,9 @@
+# AylienNewsApi::Autocomplete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the autocomplete | [optional] 
+**text** | **String** | Text of the autocomplete | [optional] 
+
+

data/docs/Autocompletes.md

@@ -0,0 +1,8 @@
+# AylienNewsApi::Autocompletes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**autocompletes** | [**Array<Autocomplete>**](Autocomplete.md) | An array of autocompletes | [optional] 
+
+

data/docs/Category.md

@@ -0,0 +1,13 @@
+# AylienNewsApi::Category
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the category | [optional] 
+**taxonomy** | **String** | The taxonomy of the category | [optional] 
+**level** | **Integer** | The level of the category | [optional] 
+**score** | **Float** | The score of the category | [optional] 
+**confident** | **BOOLEAN** | It defines whether the extracted category is confident or not | [optional] 
+**links** | [**CategoryLinks**](CategoryLinks.md) | Related links for the category | [optional] 
+
+

data/docs/CategoryLinks.md

@@ -0,0 +1,9 @@
+# AylienNewsApi::CategoryLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_self** | **String** | A URL points to the category | [optional] 
+**parent** | **String** | A URL points to the parent category | [optional] 
+
+

data/docs/Coverages.md

@@ -0,0 +1,12 @@
+# AylienNewsApi::Coverages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**story_title** | **String** | The input story title | [optional] 
+**story_body** | **String** | The input story body | [optional] 
+**story_published_at** | **DateTime** | The input story published date | [optional] 
+**story_language** | **String** | The input story language | [optional] 
+**coverages** | [**Array<Story>**](Story.md) | An array of coverages for the input story | [optional] 
+
+

data/docs/DefaultApi.md

@@ -0,0 +1,829 @@
+# AylienNewsApi::DefaultApi
+
+All URIs are relative to *https://api.newsapi.aylien.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_autocompletes**](DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
+[**list_coverages**](DefaultApi.md#list_coverages) | **POST** /coverages | List coverages
+[**list_histograms**](DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
+[**list_related_stories**](DefaultApi.md#list_related_stories) | **POST** /related_stories | List related stories
+[**list_stories**](DefaultApi.md#list_stories) | **GET** /stories | List Stories
+[**list_time_series**](DefaultApi.md#list_time_series) | **GET** /time_series | List time series
+[**list_trends**](DefaultApi.md#list_trends) | **GET** /trends | List trends
+
+
+# **list_autocompletes**
+> Autocompletes list_autocompletes(type, term, opts)
+
+List autocompletes
+
+This endpoint is used for getting list of autocompletes by providing a specific term and type.
+
+### Example
+```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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+type = "type_example" # String | This parameter is used for defining the type of autocompletes.
+
+term = "term_example" # String | This parameter is used for finding autocomplete objects whose contains the specified value.
+
+opts = { 
+  language: "en", # String | This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  per_page: 3 # Integer | This parameter is used for specifying number of the items in each page.
+}
+
+begin
+  #List autocompletes
+  result = api_instance.list_autocompletes(type, term, opts)
+  p result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_autocompletes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type** | **String**| This parameter is used for defining the type of autocompletes. | 
+ **term** | **String**| This parameter is used for finding autocomplete objects whose contains the specified value. | 
+ **language** | **String**| This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to en]
+ **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 3]
+
+### Return type
+
+[**Autocompletes**](Autocompletes.md)
+
+### Authorization
+
+[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json, text/xml
+
+
+
+# **list_coverages**
+> Coverages list_coverages(opts)
+
+List coverages
+
+This endpoint is used for finding story coverages based on provided parameters. The number of coverages to return, up to a maximum of 100.
+
+### Example
+```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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = { 
+  id: [56], # Array<Integer> | This parameter is used for finding stroies by story id.
+  title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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 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).
+  categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
+  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
+  categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
+  categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
+  entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
+  entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
+  entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
+  entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
+  entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
+  entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
+  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
+  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
+  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
+  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
+  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
+  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
+  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
+  source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
+  source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
+  source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
+  source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
+  source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
+  story_id: 789, # Integer | A story id
+  story_url: "story_url_example", # String | An article or webpage
+  story_title: "story_title_example", # String | Title of the article
+  story_body: "story_body_example", # String | Body of the article
+  story_published_at: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Publish date of the article. If you use url or title and body for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the [XML Schema specification (ISO 8601)](https://www.w3.org/TR/xmlschema-2/#dateTime).
+  story_language: "auto", # String | This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  per_page: 3 # Integer | This parameter is used for specifying number of the items in each page.
+}
+
+begin
+  #List coverages
+  result = api_instance.list_coverages(opts)
+  p result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_coverages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stroies by story id. | [optional] 
+ **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] 
+ **published_at_start** | **String**| This parameter is used for finding stories whose published at 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] 
+ **published_at_end** | **String**| This parameter is used for finding stories whose published at 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] 
+ **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional] 
+ **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional] 
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional] 
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional] 
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional] 
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional] 
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional] 
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional] 
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional] 
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] 
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] 
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional] 
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional] 
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional] 
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional] 
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional] 
+ **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional] 
+ **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional] 
+ **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional] 
+ **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional] 
+ **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional] 
+ **story_id** | **Integer**| A story id | [optional] 
+ **story_url** | **String**| An article or webpage | [optional] 
+ **story_title** | **String**| Title of the article | [optional] 
+ **story_body** | **String**| Body of the article | [optional] 
+ **story_published_at** | **DateTime**| Publish date of the article. If you use url or title and body for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the [XML Schema specification (ISO 8601)](https://www.w3.org/TR/xmlschema-2/#dateTime). | [optional] 
+ **story_language** | **String**| This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto]
+ **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 3]
+
+### Return type
+
+[**Coverages**](Coverages.md)
+
+### Authorization
+
+[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json, text/xml
+
+
+
+# **list_histograms**
+> Histograms list_histograms(opts)
+
+List histograms
+
+This endpoint is used for getting histograms based on the field parameter is passed.
+
+### Example
+```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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = { 
+  id: [56], # Array<Integer> | This parameter is used for finding stroies by story id.
+  title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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 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).
+  categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
+  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
+  categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
+  categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
+  entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
+  entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
+  entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
+  entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
+  entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
+  entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
+  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
+  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
+  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
+  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
+  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
+  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
+  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
+  source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
+  source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
+  source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
+  source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
+  source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
+  interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
+  interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
+  interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
+  field: "social_shares_count" # String | This parameter is used for specifying the y-axis variable for the histogram.
+}
+
+begin
+  #List histograms
+  result = api_instance.list_histograms(opts)
+  p result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_histograms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stroies by story id. | [optional] 
+ **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] 
+ **published_at_start** | **String**| This parameter is used for finding stories whose published at 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] 
+ **published_at_end** | **String**| This parameter is used for finding stories whose published at 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] 
+ **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional] 
+ **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional] 
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional] 
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional] 
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional] 
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional] 
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional] 
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional] 
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional] 
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] 
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] 
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional] 
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional] 
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional] 
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional] 
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional] 
+ **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional] 
+ **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional] 
+ **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional] 
+ **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional] 
+ **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional] 
+ **interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional] 
+ **interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional] 
+ **interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional] 
+ **field** | **String**| This parameter is used for specifying the y-axis variable for the histogram. | [optional] [default to social_shares_count]
+
+### Return type
+
+[**Histograms**](Histograms.md)
+
+### Authorization
+
+[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json, text/xml
+
+
+
+# **list_related_stories**
+> RelatedStories list_related_stories(opts)
+
+List related stories
+
+This endpoint is used for finding related stories based on provided parameters. The number of related stories to return, up to a maximum of 100.
+
+### Example
+```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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = { 
+  id: [56], # Array<Integer> | This parameter is used for finding stroies by story id.
+  title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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 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).
+  categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
+  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
+  categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
+  categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
+  entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
+  entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
+  entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
+  entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
+  entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
+  entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
+  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
+  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
+  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
+  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
+  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
+  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
+  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
+  source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
+  source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
+  source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
+  source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
+  source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
+  story_id: 789, # Integer | A story id
+  story_url: "story_url_example", # String | An article or webpage
+  story_title: "story_title_example", # String | Title of the article
+  story_body: "story_body_example", # String | Body of the article
+  boost_by: "boost_by_example", # String | This parameter is used for boosting result by the specified value.
+  story_language: "auto", # String | This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  per_page: 3 # Integer | This parameter is used for specifying number of the items in each page.
+}
+
+begin
+  #List related stories
+  result = api_instance.list_related_stories(opts)
+  p result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_related_stories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stroies by story id. | [optional] 
+ **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] 
+ **published_at_start** | **String**| This parameter is used for finding stories whose published at 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] 
+ **published_at_end** | **String**| This parameter is used for finding stories whose published at 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] 
+ **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional] 
+ **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional] 
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional] 
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional] 
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional] 
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional] 
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional] 
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional] 
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional] 
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] 
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] 
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional] 
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional] 
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional] 
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional] 
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional] 
+ **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional] 
+ **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional] 
+ **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional] 
+ **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional] 
+ **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional] 
+ **story_id** | **Integer**| A story id | [optional] 
+ **story_url** | **String**| An article or webpage | [optional] 
+ **story_title** | **String**| Title of the article | [optional] 
+ **story_body** | **String**| Body of the article | [optional] 
+ **boost_by** | **String**| This parameter is used for boosting result by the specified value. | [optional] 
+ **story_language** | **String**| This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto]
+ **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 3]
+
+### Return type
+
+[**RelatedStories**](RelatedStories.md)
+
+### Authorization
+
+[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json, text/xml
+
+
+
+# **list_stories**
+> Stories list_stories(opts)
+
+List Stories
+
+This endpoint is used for getting list of stories.
+
+### Example
+```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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = { 
+  id: [56], # Array<Integer> | This parameter is used for finding stroies by story id.
+  title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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 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).
+  categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
+  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
+  categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
+  categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
+  entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
+  entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
+  entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
+  entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
+  entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
+  entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
+  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
+  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
+  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
+  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
+  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
+  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
+  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
+  source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
+  source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
+  source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
+  source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
+  source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
+  cluster: false, # BOOLEAN | This parameter enables clustering for the returned stories.
+  cluster_algorithm: "lingo", # String | This parameter is used for specifying the clustering algorithm. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
+  _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 result.
+  sort_direction: "desc", # String | This parameter is used for changing the order direction of the result.
+  cursor: "*", # String | This parameter is used for finding a specific page.
+  per_page: 10 # Integer | This parameter is used for specifying number of the items in each page.
+}
+
+begin
+  #List Stories
+  result = api_instance.list_stories(opts)
+  p result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_stories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stroies by story id. | [optional] 
+ **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] 
+ **published_at_start** | **String**| This parameter is used for finding stories whose published at 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] 
+ **published_at_end** | **String**| This parameter is used for finding stories whose published at 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] 
+ **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional] 
+ **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional] 
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional] 
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional] 
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional] 
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional] 
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional] 
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional] 
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional] 
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] 
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] 
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional] 
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional] 
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional] 
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional] 
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional] 
+ **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional] 
+ **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional] 
+ **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional] 
+ **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional] 
+ **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional] 
+ **cluster** | **BOOLEAN**| This parameter enables clustering for the returned stories. | [optional] [default to false]
+ **cluster_algorithm** | **String**| This parameter is used for specifying the clustering algorithm. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. | [optional] [default to lingo]
+ **_return** | [**Array&lt;String&gt;**](String.md)| This parameter is used for specifying return fields. | [optional] 
+ **sort_by** | **String**| This parameter is used for changing the order column of the result. | [optional] [default to published_at]
+ **sort_direction** | **String**| This parameter is used for changing the order direction of the result. | [optional] [default to desc]
+ **cursor** | **String**| This parameter is used for finding a specific page. | [optional] [default to *]
+ **per_page** | **Integer**| This parameter is used for specifying number of the items in each page. | [optional] [default to 10]
+
+### Return type
+
+[**Stories**](Stories.md)
+
+### Authorization
+
+[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json, text/xml
+
+
+
+# **list_time_series**
+> TimeSeriesList list_time_series(opts)
+
+List time series
+
+This endpoint is used for getting time series by stories.
+
+### Example
+```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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = { 
+  id: [56], # Array<Integer> | This parameter is used for finding stroies by story id.
+  title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
+  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
+  categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
+  categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
+  entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
+  entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
+  entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
+  entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
+  entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
+  entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
+  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
+  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
+  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
+  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
+  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
+  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
+  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
+  source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
+  source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
+  source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
+  source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
+  source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
+  published_at_start: "NOW-7DAYS/DAY", # String | This parameter is used for finding stories whose published at 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).
+  published_at_end: "NOW/DAY", # String | This parameter is used for finding stories whose published at 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).
+  period: "+1DAY" # String | The size of each date range 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).
+}
+
+begin
+  #List time series
+  result = api_instance.list_time_series(opts)
+  p result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_time_series: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stroies by story id. | [optional] 
+ **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] 
+ **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional] 
+ **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional] 
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional] 
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional] 
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional] 
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional] 
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional] 
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional] 
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional] 
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] 
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] 
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional] 
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional] 
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional] 
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional] 
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional] 
+ **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional] 
+ **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional] 
+ **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional] 
+ **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional] 
+ **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional] 
+ **published_at_start** | **String**| This parameter is used for finding stories whose published at 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]
+ **published_at_end** | **String**| This parameter is used for finding stories whose published at 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]
+ **period** | **String**| The size of each date range expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are &#x60;+&#x60; following an integer number greater than 0 and one of the Date Math keywords. e.g. &#x60;+1DAY&#x60;, &#x60;+2MINUTES&#x60; and &#x60;+1MONTH&#x60;. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to +1DAY]
+
+### Return type
+
+[**TimeSeriesList**](TimeSeriesList.md)
+
+### Authorization
+
+[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json, text/xml
+
+
+
+# **list_trends**
+> Trends list_trends(opts)
+
+List trends
+
+This endpoint is used for finding news trendings based on stories resource.
+
+### Example
+```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 APP ID'
+  
+  # Configure API key authorization: app_key
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = { 
+  id: [56], # Array<Integer> | This parameter is used for finding stroies by story id.
+  title: "title_example", # String | This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  body: "body_example", # String | This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  text: "text_example", # String | This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
+  language: ["language_example"], # Array<String> | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
+  published_at_start: "published_at_start_example", # String | This parameter is used for finding stories whose published at 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 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).
+  categories_taxonomy: "categories_taxonomy_example", # String | This parameter is used for defining type of the taxonomy for the rest of categories queries.
+  categories_confident: true, # BOOLEAN | This parameter is used for finding stories whose categories are confident.
+  categories_id: ["categories_id_example"], # Array<String> | This parameter is used for finding stories whose categories id is the specified value.
+  categories_level: [56], # Array<Integer> | This parameter is used for finding stories whose categories level is the specified value.
+  entities_title_text: ["entities_title_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in title is the specified value.
+  entities_title_type: ["entities_title_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in title is the specified value.
+  entities_title_links_dbpedia: ["entities_title_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
+  entities_body_text: ["entities_body_text_example"], # Array<String> | This parameter is used for finding stories whose entities text in body is the specified value.
+  entities_body_type: ["entities_body_type_example"], # Array<String> | This parameter is used for finding stories whose entities type in body is the specified value.
+  entities_body_links_dbpedia: ["entities_body_links_dbpedia_example"], # Array<String> | This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
+  sentiment_title_polarity: "sentiment_title_polarity_example", # String | This parameter is used for finding stories whose title sentiment is the specified value.
+  sentiment_body_polarity: "sentiment_body_polarity_example", # String | This parameter is used for finding stories whose body sentiment is the specified value.
+  author_id: [56], # Array<Integer> | This parameter is used for finding stories whose author id is the specified value.
+  author_name: "author_name_example", # String | This parameter is used for finding stories whose author full name contains the specified value.
+  source_id: [56], # Array<Integer> | This parameter is used for finding stories whose source id is the specified value.
+  source_name: ["source_name_example"], # Array<String> | This parameter is used for finding stories whose source name contains the specified value.
+  source_domain: ["source_domain_example"], # Array<String> | This parameter is used for finding stories whose source domain is the specified value.
+  source_locations_country: ["source_locations_country_example"], # Array<String> | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_locations_state: ["source_locations_state_example"], # Array<String> | This parameter is used for finding stories whose source state/province is the specified value.
+  source_locations_city: ["source_locations_city_example"], # Array<String> | This parameter is used for finding stories whose source city is the specified value.
+  source_scopes_country: ["source_scopes_country_example"], # Array<String> | This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+  source_scopes_state: ["source_scopes_state_example"], # Array<String> | This parameter is used for finding stories whose source scopes state/province is the specified value.
+  source_scopes_city: ["source_scopes_city_example"], # Array<String> | This parameter is used for finding stories whose source scopes city is the specified value.
+  source_scopes_level: ["source_scopes_level_example"], # Array<String> | This parameter is used for finding stories whose source scopes level is the specified value.
+  field: "field_example" # String | This parameter is used to specify the trend field.
+}
+
+begin
+  #List trends
+  result = api_instance.list_trends(opts)
+  p result
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_trends: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stroies by story id. | [optional] 
+ **title** | **String**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **body** | **String**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **text** | **String**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional] 
+ **language** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] 
+ **published_at_start** | **String**| This parameter is used for finding stories whose published at 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] 
+ **published_at_end** | **String**| This parameter is used for finding stories whose published at 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] 
+ **categories_taxonomy** | **String**| This parameter is used for defining type of the taxonomy for the rest of categories queries. | [optional] 
+ **categories_confident** | **BOOLEAN**| This parameter is used for finding stories whose categories are confident. | [optional] [default to true]
+ **categories_id** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose categories id is the specified value. | [optional] 
+ **categories_level** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose categories level is the specified value. | [optional] 
+ **entities_title_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in title is the specified value. | [optional] 
+ **entities_title_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in title is the specified value. | [optional] 
+ **entities_title_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in title is the specified value. | [optional] 
+ **entities_body_text** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities text in body is the specified value. | [optional] 
+ **entities_body_type** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities type in body is the specified value. | [optional] 
+ **entities_body_links_dbpedia** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose entities dbpedia url in body is the specified value. | [optional] 
+ **sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] 
+ **sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] 
+ **author_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose author id is the specified value. | [optional] 
+ **author_name** | **String**| This parameter is used for finding stories whose author full name contains the specified value. | [optional] 
+ **source_id** | [**Array&lt;Integer&gt;**](Integer.md)| This parameter is used for finding stories whose source id is the specified value. | [optional] 
+ **source_name** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional] 
+ **source_domain** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional] 
+ **source_locations_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_locations_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source state/province is the specified value. | [optional] 
+ **source_locations_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source city is the specified value. | [optional] 
+ **source_scopes_country** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
+ **source_scopes_state** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes state/province is the specified value. | [optional] 
+ **source_scopes_city** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes city is the specified value. | [optional] 
+ **source_scopes_level** | [**Array&lt;String&gt;**](String.md)| This parameter is used for finding stories whose source scopes level is the specified value. | [optional] 
+ **field** | **String**| This parameter is used to specify the trend field. | [optional] 
+
+### Return type
+
+[**Trends**](Trends.md)
+
+### Authorization
+
+[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json, text/xml
+
+
+