aylien_news_api 0.3.0 → 4.1.0

data/docs/SentimentPolarity.md

@@ -0,0 +1,16 @@
+# AylienNewsApi::SentimentPolarity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::SentimentPolarity.new()
+```
+
+

data/docs/Sentiments.md

@@ -1,9 +1,19 @@
 # AylienNewsApi::Sentiments
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | [**Sentiment**](Sentiment.md) | The sentiment for the story title | [optional] 
-**body** | [**Sentiment**](Sentiment.md) | The sentiment for the story body | [optional] 
+**body** | [**Sentiment**](Sentiment.md) |  | [optional] 
+**title** | [**Sentiment**](Sentiment.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Sentiments.new(body: null,
+                                 title: null)
+```
 
 

data/docs/ShareCount.md

@@ -1,9 +1,19 @@
 # AylienNewsApi::ShareCount
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **count** | **Integer** | The number of shares | [optional] 
 **fetched_at** | **DateTime** | The fetched date of the shares | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::ShareCount.new(count: null,
+                                 fetched_at: null)
+```
+
 

data/docs/ShareCounts.md

@@ -1,6 +1,7 @@
 # AylienNewsApi::ShareCounts
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **facebook** | [**Array<ShareCount>**](ShareCount.md) | Facebook shares count | [optional] 
@@ -8,4 +9,15 @@ Name | Type | Description | Notes
 **linkedin** | [**Array<ShareCount>**](ShareCount.md) | LinkedIn shares count | [optional] 
 **reddit** | [**Array<ShareCount>**](ShareCount.md) | Reddit shares count | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::ShareCounts.new(facebook: null,
+                                 google_plus: null,
+                                 linkedin: null,
+                                 reddit: null)
+```
+
 

data/docs/Source.md

@@ -1,18 +1,37 @@
 # AylienNewsApi::Source
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | The source id which is a unique value | [optional] 
-**name** | **String** | The source name | [optional] 
-**title** | **String** | The title of the home page URL | [optional] 
 **description** | **String** | A general explanation about the source | [optional] 
-**links_in_count** | **Integer** | The number of websites that link to the source | [optional] 
-**home_page_url** | **String** | The home page URL of the source | [optional] 
 **domain** | **String** | The domain name of the source which is extracted from the source URL | [optional] 
+**home_page_url** | **String** | The home page URL of the source | [optional] 
+**id** | **Integer** | The source id which is a unique value | [optional] 
+**links_in_count** | **Integer** | The number of websites that link to the source | [optional] 
+**locations** | [**Array<Location>**](Location.md) | The source locations which are tend to be the physical locations of the source, e.g. BBC headquarter is located in London.  | [optional] 
 **logo_url** | **String** | A URL which points to the source logo | [optional] 
-**locations** | [**Array<Location>**](Location.md) | The source locations which are tend to be the physical locations of the source, e.g. BBC headquarter is located in London. | [optional] 
-**scopes** | [**Array<Scope>**](Scope.md) | The source scopes which is tend to be scope locations of the source, e.g. BBC scopes is international. | [optional] 
-**rankings** | [**Rankings**](Rankings.md) | The web rankings of the source | [optional] 
+**name** | **String** | The source name | [optional] 
+**rankings** | [**Rankings**](Rankings.md) |  | [optional] 
+**scopes** | [**Array<Scope>**](Scope.md) | The source scopes which is tend to be scope locations of the source, e.g. BBC scopes is international.  | [optional] 
+**title** | **String** | The title of the home page URL | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Source.new(description: null,
+                                 domain: null,
+                                 home_page_url: null,
+                                 id: null,
+                                 links_in_count: null,
+                                 locations: null,
+                                 logo_url: null,
+                                 name: null,
+                                 rankings: null,
+                                 scopes: null,
+                                 title: null)
+```
 
 

data/docs/Stories.md

@@ -1,10 +1,25 @@
 # AylienNewsApi::Stories
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**stories** | [**Array<Story>**](Story.md) | An array of stories | [optional] 
-**clusters** | [**Array<StoryCluster>**](StoryCluster.md) | An array of clusters | [optional] 
 **next_page_cursor** | **String** | The next page cursor | [optional] 
+**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
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Stories.new(next_page_cursor: null,
+                                 stories: null,
+                                 published_at_end: null,
+                                 published_at_start: null,
+                                 warnings: null)
+```
 
 

data/docs/Story.md

@@ -1,27 +1,59 @@
 # AylienNewsApi::Story
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | ID of the story which is a unique identification | [optional] 
-**title** | **String** | Title of the story | [optional] 
+**author** | [**Author**](Author.md) |  | [optional] 
 **body** | **String** | Body of the story | [optional] 
-**summary** | [**Summary**](Summary.md) | The suggested story summary | [optional] 
-**source** | [**Source**](Source.md) | The story source | [optional] 
-**author** | [**Author**](Author.md) | The story author | [optional] 
-**entities** | [**Entities**](Entities.md) | Extracted entities from the story title or body | [optional] 
-**keywords** | **Array<String>** | Extracted keywords mentioned in the story title or body | [optional] 
-**hashtags** | **Array<String>** | An array of suggested Story hashtags | [optional] 
-**characters_count** | **Integer** | Character count of the story body | [optional] 
-**words_count** | **Integer** | Word count of the story body | [optional] 
-**sentences_count** | **Integer** | Sentence count of the story body | [optional] 
-**paragraphs_count** | **Integer** | Paragraph count of the story body | [optional] 
 **categories** | [**Array<Category>**](Category.md) | Suggested categories for the story | [optional] 
-**social_shares_count** | [**ShareCounts**](ShareCounts.md) | Social shares count for the story | [optional] 
-**media** | [**Array<Media>**](Media.md) | An array of extracted media such as images and videos | [optional] 
-**sentiment** | [**Sentiments**](Sentiments.md) | Suggested sentiments for the story title or body | [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] 
+**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] 
-**links** | [**StoryLinks**](StoryLinks.md) | Links which is related to 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] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Story.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)
+```
 
 

data/docs/StoryCluster.md

@@ -1,12 +1,25 @@
 # AylienNewsApi::StoryCluster
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | A unique identification for the cluster | [optional] 
 **phrases** | **Array<String>** | Suggested labels for the cluster | [optional] 
+**score** | **Float** | The cluster score | [optional] 
 **size** | **Integer** | Size of the cluster | [optional] 
 **stories** | **Array<Integer>** | Story ids which are in the cluster | [optional] 
-**score** | **Float** | The cluster score | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::StoryCluster.new(id: null,
+                                 phrases: null,
+                                 score: null,
+                                 size: null,
+                                 stories: null)
+```
 
 

data/docs/StoryLinks.md

@@ -1,10 +1,23 @@
 # AylienNewsApi::StoryLinks
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**canonical** | **String** | The story canonical URL | [optional] 
 **permalink** | **String** | The story permalink URL | [optional] 
 **related_stories** | **String** | The related stories URL | [optional] 
-**coverages** | **String** | The coverages URL | [optional] 
+**clusters** | **String** | The clusters endpoint URL for this story | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::StoryLinks.new(canonical: null,
+                                 permalink: null,
+                                 related_stories: null,
+                                 clusters: null)
+```
 
 

data/docs/StoryTranslation.md

@@ -0,0 +1,19 @@
+# AylienNewsApi::StoryTranslation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** | Translation of body | [optional] 
+**title** | **String** | Translation of title | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::StoryTranslation.new(body: null,
+                                 title: null)
+```
+
+

data/docs/StoryTranslations.md

@@ -0,0 +1,17 @@
+# AylienNewsApi::StoryTranslations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**en** | [**StoryTranslation**](StoryTranslation.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::StoryTranslations.new(en: null)
+```
+
+

data/docs/StoryTranslationsEn.md

@@ -0,0 +1,21 @@
+# AylienNewsApi::StoryTranslationsEn
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** | Translation of body | [optional] 
+**text** | **String** | Translation of a concatenation of title and body | [optional] 
+**title** | **String** | Translation of title | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::StoryTranslationsEn.new(body: null,
+                                 text: null,
+                                 title: null)
+```
+
+

data/docs/Summary.md

@@ -1,8 +1,17 @@
 # AylienNewsApi::Summary
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **sentences** | **Array<String>** | An array of the suggested summary sentences | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Summary.new(sentences: null)
+```
+
 

data/docs/TimeSeries.md

@@ -1,9 +1,19 @@
 # AylienNewsApi::TimeSeries
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**published_at** | **DateTime** | The published date of the time series bin | [optional] 
 **count** | **Integer** | The count of time series bin | [optional] 
+**published_at** | **DateTime** | The published date of the time series bin | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::TimeSeries.new(count: null,
+                                 published_at: null)
+```
 
 

data/docs/TimeSeriesList.md

@@ -1,11 +1,23 @@
 # AylienNewsApi::TimeSeriesList
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**time_series** | [**Array<TimeSeries>**](TimeSeries.md) | An array of time series | [optional] 
-**period** | **String** | The size of each date range expressed as an interval to be added to the lower bound. | [optional] 
-**published_at_start** | **DateTime** | The start published date of the time series | [optional] 
+**period** | **String** | The size of each date range expressed as an interval to be added to the lower bound.  | [optional] 
 **published_at_end** | **DateTime** | The end published date of the time series | [optional] 
+**published_at_start** | **DateTime** | The start published date of the time series | [optional] 
+**time_series** | [**Array<TimeSeries>**](TimeSeries.md) | An array of time series | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::TimeSeriesList.new(period: null,
+                                 published_at_end: null,
+                                 published_at_start: null,
+                                 time_series: null)
+```
 
 

data/docs/Trend.md

@@ -1,9 +1,19 @@
 # AylienNewsApi::Trend
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | **String** | The value of the trend | [optional] 
 **count** | **Integer** | The count of the trend | [optional] 
+**value** | **String** | The value of the trend | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Trend.new(count: null,
+                                 value: null)
+```
 
 

data/docs/Trends.md

@@ -1,9 +1,23 @@
 # AylienNewsApi::Trends
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**trends** | [**Array<Trend>**](Trend.md) | An array of trends | [optional] 
 **field** | **String** | The field of trends | [optional] 
+**trends** | [**Array<Trend>**](Trend.md) | An array of trends | [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::Trends.new(field: null,
+                                 trends: null,
+                                 published_at_end: null,
+                                 published_at_start: null)
+```