aylien_news_api 4.0.0 → 4.4.0

data/docs/Entity.md

@@ -4,22 +4,30 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the entity | [optional] 
 **indices** | **Array<Array<Integer>>** | The indices of the entity text | [optional] 
 **links** | [**EntityLinks**](EntityLinks.md) |  | [optional] 
-**score** | **Float** | The entity score | [optional] 
 **text** | **String** | The entity text | [optional] 
-**types** | **Array<String>** | An array of the dbpedia types | [optional] 
+**stock_ticker** | **String** | The stock_ticker of the entity (might be null) | [optional] 
+**types** | **Array<String>** | An array of the entity types | [optional] 
+**sentiment** | [**EntitySentiment**](EntitySentiment.md) |  | [optional] 
+**surface_forms** | [**Array<EntitySurfaceForm>**](EntitySurfaceForm.md) |  | [optional] 
+**prominence_score** | **Float** | Describes how relevant an entity is to the article | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'AylienNewsApi'
 
-instance = AylienNewsApi::Entity.new(indices: null,
+instance = AylienNewsApi::Entity.new(id: null,
+                                 indices: null,
                                  links: null,
-                                 score: null,
                                  text: null,
-                                 types: null)
+                                 stock_ticker: null,
+                                 types: null,
+                                 sentiment: null,
+                                 surface_forms: null,
+                                 prominence_score: null)
 ```
 
 

data/docs/EntityLinks.md

@@ -4,14 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**dbpedia** | **String** | A dbpedia resource URL | [optional] 
+**dbpedia** | **String** | A dbpedia resource URL (deprecated) | [optional] 
+**wikipedia** | **String** | A wikipedia resource URL | [optional] 
+**wikidata** | **String** | A wikidata resource URL | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'AylienNewsApi'
 
-instance = AylienNewsApi::EntityLinks.new(dbpedia: null)
+instance = AylienNewsApi::EntityLinks.new(dbpedia: null,
+                                 wikipedia: null,
+                                 wikidata: null)
 ```
 
 

data/docs/EntitySentiment.md

@@ -0,0 +1,19 @@
+# AylienNewsApi::EntitySentiment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**polarity** | [**SentimentPolarity**](SentimentPolarity.md) |  | [optional] 
+**confidence** | **Float** | Polarity confidence of the sentiment | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::EntitySentiment.new(polarity: null,
+                                 confidence: null)
+```
+
+

data/docs/EntitySurfaceForm.md

@@ -0,0 +1,21 @@
+# AylienNewsApi::EntitySurfaceForm
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The entity text | [optional] 
+**indices** | **Array<Array<Integer>>** | The indices of the entity text | [optional] 
+**frequency** | **Integer** | Amount of entity surface form mentions in the article | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::EntitySurfaceForm.new(text: null,
+                                 indices: null,
+                                 frequency: null)
+```
+
+

data/docs/ErrorLinks.md

@@ -5,13 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **about** | **String** |  | [optional] 
+**docs** | **String** |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'AylienNewsApi'
 
-instance = AylienNewsApi::ErrorLinks.new(about: null)
+instance = AylienNewsApi::ErrorLinks.new(about: null,
+                                 docs: null)
 ```
 
 

data/docs/Logicals.md

@@ -0,0 +1,21 @@
+# AylienNewsApi::Logicals
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_and** | [**Array<AnyOfLogicalsParameter>**](AnyOfLogicalsParameter.md) |  | [optional] 
+**_or** | [**Array<AnyOfLogicalsParameter>**](AnyOfLogicalsParameter.md) |  | [optional] 
+**_not** | [**Array<AnyOfLogicalsParameter>**](AnyOfLogicalsParameter.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Logicals.new(_and: null,
+                                 _or: null,
+                                 _not: null)
+```
+
+

data/docs/NestedEntity.md

@@ -0,0 +1,33 @@
+# AylienNewsApi::NestedEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**Query**](Query.md) |  | [optional] 
+**name** | [**Query**](Query.md) |  | [optional] 
+**surface_forms_text** | [**Query**](Query.md) |  | [optional] 
+**sentiment** | [**Query**](Query.md) |  | [optional] 
+**element** | [**Query**](Query.md) |  | [optional] 
+**links_wikipedia** | [**Query**](Query.md) |  | [optional] 
+**links_wikidata** | [**Query**](Query.md) |  | [optional] 
+**stock_ticker** | [**Query**](Query.md) |  | [optional] 
+**type** | [**Query**](Query.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::NestedEntity.new(id: null,
+                                 name: null,
+                                 surface_forms_text: null,
+                                 sentiment: null,
+                                 element: null,
+                                 links_wikipedia: null,
+                                 links_wikidata: null,
+                                 stock_ticker: null,
+                                 type: null)
+```
+
+

data/docs/Parameter.md

@@ -0,0 +1,127 @@
+# AylienNewsApi::Parameter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author_id** | [**Query**](Query.md) |  | [optional] 
+**author_name** | [**Query**](Query.md) |  | [optional] 
+**body** | [**Query**](Query.md) |  | [optional] 
+**categories_confident** | [**Query**](Query.md) |  | [optional] 
+**categories_id** | [**Query**](Query.md) |  | [optional] 
+**categories_level** | [**Query**](Query.md) |  | [optional] 
+**categories_taxonomy** | [**Query**](Query.md) |  | [optional] 
+**clusters** | [**Query**](Query.md) |  | [optional] 
+**links_permalink** | [**Query**](Query.md) |  | [optional] 
+**entities_body_links_dbpedia** | [**Query**](Query.md) |  | [optional] 
+**entities_body_text** | [**Query**](Query.md) |  | [optional] 
+**entities_body_type** | [**Query**](Query.md) |  | [optional] 
+**entities_title_links_dbpedia** | [**Query**](Query.md) |  | [optional] 
+**entities_title_text** | [**Query**](Query.md) |  | [optional] 
+**entities_title_type** | [**Query**](Query.md) |  | [optional] 
+**id** | [**Query**](Query.md) |  | [optional] 
+**language** | [**Query**](Query.md) |  | [optional] 
+**media_images_content_length_max** | [**Query**](Query.md) |  | [optional] 
+**media_images_content_length_min** | [**Query**](Query.md) |  | [optional] 
+**media_images_count_max** | [**Query**](Query.md) |  | [optional] 
+**media_images_count_min** | [**Query**](Query.md) |  | [optional] 
+**media_images_format** | [**Query**](Query.md) |  | [optional] 
+**media_images_height_max** | [**Query**](Query.md) |  | [optional] 
+**media_images_height_min** | [**Query**](Query.md) |  | [optional] 
+**media_images_width_max** | [**Query**](Query.md) |  | [optional] 
+**media_images_width_min** | [**Query**](Query.md) |  | [optional] 
+**media_videos_count_max** | [**Query**](Query.md) |  | [optional] 
+**media_videos_count_min** | [**Query**](Query.md) |  | [optional] 
+**sentiment_body_polarity** | [**Query**](Query.md) |  | [optional] 
+**sentiment_title_polarity** | [**Query**](Query.md) |  | [optional] 
+**social_shares_count_facebook_max** | [**Query**](Query.md) |  | [optional] 
+**social_shares_count_facebook_min** | [**Query**](Query.md) |  | [optional] 
+**social_shares_count_reddit_max** | [**Query**](Query.md) |  | [optional] 
+**social_shares_count_reddit_min** | [**Query**](Query.md) |  | [optional] 
+**source_domain** | [**Query**](Query.md) |  | [optional] 
+**source_id** | [**Query**](Query.md) |  | [optional] 
+**source_links_in_count_max** | [**Query**](Query.md) |  | [optional] 
+**source_links_in_count_min** | [**Query**](Query.md) |  | [optional] 
+**source_locations_city** | [**Query**](Query.md) |  | [optional] 
+**source_locations_country** | [**Query**](Query.md) |  | [optional] 
+**source_locations_state** | [**Query**](Query.md) |  | [optional] 
+**source_rankings_alexa_country** | [**Query**](Query.md) |  | [optional] 
+**source_rankings_alexa_rank_max** | [**Query**](Query.md) |  | [optional] 
+**source_rankings_alexa_rank_min** | [**Query**](Query.md) |  | [optional] 
+**source_scopes_city** | [**Query**](Query.md) |  | [optional] 
+**source_scopes_country** | [**Query**](Query.md) |  | [optional] 
+**source_scopes_level** | [**Query**](Query.md) |  | [optional] 
+**source_scopes_state** | [**Query**](Query.md) |  | [optional] 
+**story_url** | [**Query**](Query.md) |  | [optional] 
+**story_language** | [**Query**](Query.md) |  | [optional] 
+**text** | [**Query**](Query.md) |  | [optional] 
+**title** | [**Query**](Query.md) |  | [optional] 
+**translations_en_body** | [**Query**](Query.md) |  | [optional] 
+**translations_en_text** | [**Query**](Query.md) |  | [optional] 
+**translations_en_title** | [**Query**](Query.md) |  | [optional] 
+**entity** | [**OneOfNestedEntityLogicals**](OneOfNestedEntityLogicals.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Parameter.new(author_id: null,
+                                 author_name: null,
+                                 body: null,
+                                 categories_confident: null,
+                                 categories_id: null,
+                                 categories_level: null,
+                                 categories_taxonomy: null,
+                                 clusters: null,
+                                 links_permalink: null,
+                                 entities_body_links_dbpedia: null,
+                                 entities_body_text: null,
+                                 entities_body_type: null,
+                                 entities_title_links_dbpedia: null,
+                                 entities_title_text: null,
+                                 entities_title_type: null,
+                                 id: null,
+                                 language: null,
+                                 media_images_content_length_max: null,
+                                 media_images_content_length_min: null,
+                                 media_images_count_max: null,
+                                 media_images_count_min: null,
+                                 media_images_format: null,
+                                 media_images_height_max: null,
+                                 media_images_height_min: null,
+                                 media_images_width_max: null,
+                                 media_images_width_min: null,
+                                 media_videos_count_max: null,
+                                 media_videos_count_min: null,
+                                 sentiment_body_polarity: null,
+                                 sentiment_title_polarity: null,
+                                 social_shares_count_facebook_max: null,
+                                 social_shares_count_facebook_min: null,
+                                 social_shares_count_reddit_max: null,
+                                 social_shares_count_reddit_min: null,
+                                 source_domain: null,
+                                 source_id: null,
+                                 source_links_in_count_max: null,
+                                 source_links_in_count_min: null,
+                                 source_locations_city: null,
+                                 source_locations_country: null,
+                                 source_locations_state: null,
+                                 source_rankings_alexa_country: null,
+                                 source_rankings_alexa_rank_max: null,
+                                 source_rankings_alexa_rank_min: null,
+                                 source_scopes_city: null,
+                                 source_scopes_country: null,
+                                 source_scopes_level: null,
+                                 source_scopes_state: null,
+                                 story_url: null,
+                                 story_language: null,
+                                 text: null,
+                                 title: null,
+                                 translations_en_body: null,
+                                 translations_en_text: null,
+                                 translations_en_title: null,
+                                 entity: null)
+```
+
+

data/docs/Query.md

@@ -0,0 +1,31 @@
+# AylienNewsApi::Query
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eq** | [**OneOfstringnumber**](OneOfstringnumber.md) |  | [optional] 
+**text** | [**OneOfstringnumber**](OneOfstringnumber.md) |  | [optional] 
+**_in** | [**Array<OneOfstringnumber>**](OneOfstringnumber.md) |  | [optional] 
+**gt** | **Float** |  | [optional] 
+**gte** | **Float** |  | [optional] 
+**lt** | **Float** |  | [optional] 
+**lte** | **Float** |  | [optional] 
+**boost** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Query.new(eq: null,
+                                 text: null,
+                                 _in: null,
+                                 gt: null,
+                                 gte: null,
+                                 lt: null,
+                                 lte: null,
+                                 boost: null)
+```
+
+

data/docs/RelatedStories.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **story_body** | **String** | The input story body | [optional] 
 **story_language** | **String** | The input story language | [optional] 
 **story_title** | **String** | The input story title | [optional] 
+**published_at_end** | **DateTime** | The end of a period in which searched stories were published | [optional] 
+**published_at_start** | **DateTime** | The start of a period in which searched stories were published | [optional] 
 
 ## Code Sample
 
@@ -17,7 +19,9 @@ require 'AylienNewsApi'
 instance = AylienNewsApi::RelatedStories.new(related_stories: null,
                                  story_body: null,
                                  story_language: null,
-                                 story_title: null)
+                                 story_title: null,
+                                 published_at_end: null,
+                                 published_at_start: null)
 ```
 
 

data/docs/Stories.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **stories** | [**Array<Story>**](Story.md) | An array of stories | [optional] 
 **published_at_end** | **DateTime** | The end of a period in which searched stories were published | [optional] 
 **published_at_start** | **DateTime** | The start of a period in which searched stories were published | [optional] 
+**warnings** | [**Array<Warning>**](Warning.md) | Notifies about possible issues that occurred when searching for stories | [optional] 
 
 ## Code Sample
 
@@ -17,7 +18,8 @@ require 'AylienNewsApi'
 instance = AylienNewsApi::Stories.new(next_page_cursor: null,
                                  stories: null,
                                  published_at_end: null,
-                                 published_at_start: null)
+                                 published_at_start: null,
+                                 warnings: null)
 ```
 
 

data/docs/Story.md

@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **title** | **String** | Title of the story | [optional] 
 **translations** | [**StoryTranslations**](StoryTranslations.md) |  | [optional] 
 **words_count** | **Integer** | Word count of the story body | [optional] 
+**license_type** | **Integer** | License type of the story | [optional] 
 
 ## Code Sample
 
@@ -53,7 +54,8 @@ instance = AylienNewsApi::Story.new(author: null,
                                  summary: null,
                                  title: null,
                                  translations: null,
-                                 words_count: null)
+                                 words_count: null,
+                                 license_type: null)
 ```
 
 

data/docs/TimeSeries.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **count** | **Integer** | The count of time series bin | [optional] 
 **published_at** | **DateTime** | The published date of the time series bin | [optional] 
+**sentiment** | [**AggregatedSentiment**](AggregatedSentiment.md) |  | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'AylienNewsApi'
 
 instance = AylienNewsApi::TimeSeries.new(count: null,
-                                 published_at: null)
+                                 published_at: null,
+                                 sentiment: null)
 ```
 
 

data/docs/Trend.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **count** | **Integer** | The count of the trend | [optional] 
 **value** | **String** | The value of the trend | [optional] 
+**sentiment** | [**AggregatedSentiment**](AggregatedSentiment.md) |  | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'AylienNewsApi'
 
 instance = AylienNewsApi::Trend.new(count: null,
-                                 value: null)
+                                 value: null,
+                                 sentiment: null)
 ```
 
 

data/docs/Warning.md

@@ -0,0 +1,21 @@
+# AylienNewsApi::Warning
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The identfier of the warning, represents its origin. | [optional] 
+**links** | [**ErrorLinks**](ErrorLinks.md) |  | [optional] 
+**detail** | **String** | The detailed description of the warning. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Warning.new(id: null,
+                                 links: null,
+                                 detail: null)
+```
+
+