aylien_news_api 4.3.0 → 4.5.0

data/docs/DeprecatedEntities.md

@@ -0,0 +1,19 @@
+# AylienNewsApi::DeprecatedEntities
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | [**Array<DeprecatedEntity>**](DeprecatedEntity.md) | An array of extracted entities from the story body | [optional] 
+**title** | [**Array<DeprecatedEntity>**](DeprecatedEntity.md) | An array of extracted entities from the story title | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::DeprecatedEntities.new(body: null,
+                                 title: null)
+```
+
+

data/docs/DeprecatedEntity.md

@@ -0,0 +1,33 @@
+# AylienNewsApi::DeprecatedEntity
+
+## Properties
+
+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] 
+**text** | **String** | The entity text | [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<DeprecatedEntitySurfaceForm>**](DeprecatedEntitySurfaceForm.md) |  | [optional] 
+**prominence_score** | **Float** | Describes how relevant an entity is to the article | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::DeprecatedEntity.new(id: null,
+                                 indices: null,
+                                 links: null,
+                                 text: null,
+                                 stock_ticker: null,
+                                 types: null,
+                                 sentiment: null,
+                                 surface_forms: null,
+                                 prominence_score: null)
+```
+
+

data/docs/DeprecatedEntitySurfaceForm.md

@@ -0,0 +1,21 @@
+# AylienNewsApi::DeprecatedEntitySurfaceForm
+
+## 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::DeprecatedEntitySurfaceForm.new(text: null,
+                                 indices: null,
+                                 frequency: null)
+```
+
+

data/docs/DeprecatedRelatedStories.md

@@ -0,0 +1,27 @@
+# AylienNewsApi::DeprecatedRelatedStories
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**related_stories** | [**Array<DeprecatedStory>**](DeprecatedStory.md) | An array of related stories for the input story | [optional] 
+**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
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::DeprecatedRelatedStories.new(related_stories: null,
+                                 story_body: null,
+                                 story_language: null,
+                                 story_title: null,
+                                 published_at_end: null,
+                                 published_at_start: null)
+```
+
+

data/docs/DeprecatedStories.md

@@ -0,0 +1,25 @@
+# AylienNewsApi::DeprecatedStories
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page_cursor** | **String** | The next page cursor | [optional] 
+**stories** | [**Array<DeprecatedStory>**](DeprecatedStory.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
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::DeprecatedStories.new(next_page_cursor: null,
+                                 stories: null,
+                                 published_at_end: null,
+                                 published_at_start: null,
+                                 warnings: null)
+```
+
+

data/docs/DeprecatedStory.md

@@ -0,0 +1,61 @@
+# AylienNewsApi::DeprecatedStory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author** | [**Author**](Author.md) |  | [optional] 
+**body** | **String** | Body of the story | [optional] 
+**categories** | [**Array<Category>**](Category.md) | Suggested categories for the story | [optional] 
+**characters_count** | **Integer** | Character count of the story body | [optional] 
+**clusters** | **Array<Integer>** | An array of clusters the story is associated with | [optional] 
+**entities** | [**DeprecatedEntities**](DeprecatedEntities.md) |  | [optional] 
+**hashtags** | **Array<String>** | An array of suggested Story hashtags | [optional] 
+**id** | **Integer** | ID of the story which is a unique identification | [optional] 
+**keywords** | **Array<String>** | Extracted keywords mentioned in the story title or body | [optional] 
+**language** | **String** | Language of the story | [optional] 
+**links** | [**StoryLinks**](StoryLinks.md) |  | [optional] 
+**media** | [**Array<Media>**](Media.md) | An array of extracted media such as images and videos | [optional] 
+**paragraphs_count** | **Integer** | Paragraph count of the story body | [optional] 
+**published_at** | **DateTime** | Published date of the story | [optional] 
+**sentences_count** | **Integer** | Sentence count of the story body | [optional] 
+**sentiment** | [**Sentiments**](Sentiments.md) |  | [optional] 
+**social_shares_count** | [**ShareCounts**](ShareCounts.md) |  | [optional] 
+**source** | [**Source**](Source.md) |  | [optional] 
+**summary** | [**Summary**](Summary.md) |  | [optional] 
+**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
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::DeprecatedStory.new(author: null,
+                                 body: null,
+                                 categories: null,
+                                 characters_count: null,
+                                 clusters: null,
+                                 entities: null,
+                                 hashtags: null,
+                                 id: null,
+                                 keywords: null,
+                                 language: null,
+                                 links: null,
+                                 media: null,
+                                 paragraphs_count: null,
+                                 published_at: null,
+                                 sentences_count: null,
+                                 sentiment: null,
+                                 social_shares_count: null,
+                                 source: null,
+                                 summary: null,
+                                 title: null,
+                                 translations: null,
+                                 words_count: null,
+                                 license_type: null)
+```
+
+

data/docs/Entity.md

@@ -5,13 +5,14 @@
 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] 
-**text** | **String** | The entity text | [optional] 
-**stock_ticker** | **String** | The stock_ticker of the entity (might be null) | [optional] 
+**stock_tickers** | **Array<String>** | The stock tickers of the entity (might be empty) | [optional] 
 **types** | **Array<String>** | An array of the entity types | [optional] 
-**sentiment** | [**EntitySentiment**](EntitySentiment.md) |  | [optional] 
-**surface_forms** | [**Array<EntitySurfaceForm>**](EntitySurfaceForm.md) |  | [optional] 
+**overall_sentiment** | [**EntitySentiment**](EntitySentiment.md) |  | [optional] 
+**overall_prominence** | **Float** | Describes how relevant an entity is to the article | [optional] 
+**overall_frequency** | **Integer** | Amount of entity surface form mentions in the article | [optional] 
+**body** | [**EntityInText**](EntityInText.md) |  | [optional] 
+**title** | [**EntityInText**](EntityInText.md) |  | [optional] 
 
 ## Code Sample
 
@@ -19,13 +20,14 @@ Name | Type | Description | Notes
 require 'AylienNewsApi'
 
 instance = AylienNewsApi::Entity.new(id: null,
-                                 indices: null,
                                  links: null,
-                                 text: null,
-                                 stock_ticker: null,
+                                 stock_tickers: null,
                                  types: null,
-                                 sentiment: null,
-                                 surface_forms: null)
+                                 overall_sentiment: null,
+                                 overall_prominence: null,
+                                 overall_frequency: null,
+                                 body: null,
+                                 title: null)
 ```
 
 

data/docs/EntityInText.md

@@ -0,0 +1,19 @@
+# AylienNewsApi::EntityInText
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sentiment** | [**EntitySentiment**](EntitySentiment.md) |  | [optional] 
+**surface_forms** | [**Array<EntitySurfaceForm>**](EntitySurfaceForm.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::EntityInText.new(sentiment: null,
+                                 surface_forms: null)
+```
+
+

data/docs/EntityMention.md

@@ -0,0 +1,19 @@
+# AylienNewsApi::EntityMention
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | [**EntityMentionIndex**](EntityMentionIndex.md) |  | [optional] 
+**sentiment** | [**EntitySentiment**](EntitySentiment.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::EntityMention.new(index: null,
+                                 sentiment: null)
+```
+
+

data/docs/EntityMentionIndex.md

@@ -0,0 +1,19 @@
+# AylienNewsApi::EntityMentionIndex
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **Integer** | Start index of a single entity mention in the text (counting from 0) | 
+**_end** | **Integer** | End index of a single entity mention in the text (counting from 0) | 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::EntityMentionIndex.new(start: null,
+                                 _end: null)
+```
+
+

data/docs/EntitySurfaceForm.md

@@ -5,7 +5,8 @@
 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] 
+**mentions** | [**Array<EntityMention>**](EntityMention.md) | Mentions of the entity text | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'AylienNewsApi'
 
 instance = AylienNewsApi::EntitySurfaceForm.new(text: null,
-                                 indices: null)
+                                 frequency: null,
+                                 mentions: null)
 ```
 
 

data/docs/Story.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **categories** | [**Array<Category>**](Category.md) | Suggested categories for the story | [optional] 
 **characters_count** | **Integer** | Character count of the story body | [optional] 
 **clusters** | **Array<Integer>** | An array of clusters the story is associated with | [optional] 
-**entities** | [**Entities**](Entities.md) |  | [optional] 
+**entities** | [**Array<Entity>**](Entity.md) | An array of entities | [optional] 
 **hashtags** | **Array<String>** | An array of suggested Story hashtags | [optional] 
 **id** | **Integer** | ID of the story which is a unique identification | [optional] 
 **keywords** | **Array<String>** | Extracted keywords mentioned in the story title or body | [optional]