aylien_news_api 1.0.0 → 3.0.0

data/docs/Entities.md

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

data/docs/Entity.md

@@ -1,12 +1,25 @@
 # AylienNewsApi::Entity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**text** | **String** | The entity text | [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] 
-**links** | [**EntityLinks**](EntityLinks.md) | Related links to the entity | [optional] 
-**indices** | **Array<Array<Integer>>** | The indices of the entity text | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Entity.new(indices: null,
+                                 links: null,
+                                 score: null,
+                                 text: null,
+                                 types: null)
+```
 
 

data/docs/EntityLinks.md

@@ -1,8 +1,17 @@
 # AylienNewsApi::EntityLinks
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **dbpedia** | **String** | A dbpedia resource URL | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::EntityLinks.new(dbpedia: null)
+```
+
 

data/docs/Error.md

@@ -1,13 +1,27 @@
 # AylienNewsApi::Error
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional] 
+**detail** | **String** |  | [optional] 
 **id** | **String** |  | [optional] 
 **links** | [**ErrorLinks**](ErrorLinks.md) |  | [optional] 
 **status** | **String** |  | [optional] 
-**code** | **String** |  | [optional] 
 **title** | **String** |  | [optional] 
-**detail** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Error.new(code: null,
+                                 detail: null,
+                                 id: null,
+                                 links: null,
+                                 status: null,
+                                 title: null)
+```
 
 

data/docs/ErrorLinks.md

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

data/docs/Errors.md

@@ -1,8 +1,17 @@
 # AylienNewsApi::Errors
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **errors** | [**Array<Error>**](Error.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Errors.new(errors: null)
+```
+
 

data/docs/HistogramInterval.md

@@ -1,9 +1,19 @@
 # AylienNewsApi::HistogramInterval
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bin** | **Integer** | Histogram bin | [optional] 
 **count** | **Integer** | Histogram bin size | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::HistogramInterval.new(bin: null,
+                                 count: null)
+```
+
 

data/docs/Histograms.md

@@ -1,12 +1,25 @@
 # AylienNewsApi::Histograms
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**intervals** | [**Array<HistogramInterval>**](HistogramInterval.md) | The intervals of the histograms | [optional] 
-**interval_start** | **Integer** | The start interval of the histogram | [optional] 
+**field** | **String** |  | [optional] 
 **interval_end** | **Integer** | The end interval of the histogram | [optional] 
+**interval_start** | **Integer** | The start interval of the histogram | [optional] 
 **interval_width** | **Integer** | The width of the histogram | [optional] 
-**field** | **String** |  | [optional] 
+**intervals** | [**Array<HistogramInterval>**](HistogramInterval.md) | The intervals of the histograms | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Histograms.new(field: null,
+                                 interval_end: null,
+                                 interval_start: null,
+                                 interval_width: null,
+                                 intervals: null)
+```
 
 

data/docs/Location.md

@@ -1,10 +1,21 @@
 # AylienNewsApi::Location
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**country** | **String** | The country code of the location. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
-**state** | **String** | The state of the location | [optional] 
 **city** | **String** | The city of the location | [optional] 
+**country** | **String** | The country code of the location. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.  | [optional] 
+**state** | **String** | The state of the location | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Location.new(city: null,
+                                 country: null,
+                                 state: null)
+```
 
 

data/docs/Media.md

@@ -1,13 +1,27 @@
 # AylienNewsApi::Media
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**content_length** | **Integer** | The content length of media | [optional] 
+**format** | **String** | The format of media | [optional] 
+**height** | **Integer** | The height of media | [optional] 
 **type** | **String** | The type of media | [optional] 
 **url** | **String** | A URL which points to the media file | [optional] 
-**format** | **String** | The format of media | [optional] 
-**content_length** | **Integer** | The content length of media | [optional] 
 **width** | **Integer** | The width of media | [optional] 
-**height** | **Integer** | The height of media | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Media.new(content_length: null,
+                                 format: null,
+                                 height: null,
+                                 type: null,
+                                 url: null,
+                                 width: null)
+```
 
 

data/docs/Rank.md

@@ -1,10 +1,21 @@
 # AylienNewsApi::Rank
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**rank** | **Integer** | The rank | [optional] 
 **country** | **String** | The country code which the rank is in it | [optional] 
 **fetched_at** | **DateTime** | The fetched date of the rank | [optional] 
+**rank** | **Integer** | The rank | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Rank.new(country: null,
+                                 fetched_at: null,
+                                 rank: null)
+```
 
 

data/docs/Rankings.md

@@ -1,8 +1,17 @@
 # AylienNewsApi::Rankings
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **alexa** | [**Array<Rank>**](Rank.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Rankings.new(alexa: null)
+```
+
 

data/docs/RelatedStories.md

@@ -1,12 +1,23 @@
 # AylienNewsApi::RelatedStories
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**story_title** | **String** | The input story title | [optional] 
+**related_stories** | [**Array<Story>**](Story.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] 
-**related_stories** | [**Array<Story>**](Story.md) | An array of related stories for the input story | [optional] 
-**clusters** | [**Array<StoryCluster>**](StoryCluster.md) | An array of clusters | [optional] 
+**story_title** | **String** | The input story title | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::RelatedStories.new(related_stories: null,
+                                 story_body: null,
+                                 story_language: null,
+                                 story_title: null)
+```
 
 

data/docs/RepresentativeStory.md

@@ -0,0 +1,23 @@
+# AylienNewsApi::RepresentativeStory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the story which is a unique identification | [optional] 
+**permalink** | **String** | The story permalink URL | [optional] 
+**published_at** | **DateTime** | Published date of the story | [optional] 
+**title** | **String** | Title of the story | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::RepresentativeStory.new(id: null,
+                                 permalink: null,
+                                 published_at: null,
+                                 title: null)
+```
+
+

data/docs/Scope.md

@@ -1,11 +1,23 @@
 # AylienNewsApi::Scope
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**country** | **String** | The source scope by country code. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. | [optional] 
-**state** | **String** | The scope by state | [optional] 
 **city** | **String** | The scope by city | [optional] 
+**country** | **String** | The source scope by country code. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.  | [optional] 
 **level** | **String** | The scope by level | [optional] 
+**state** | **String** | The scope by state | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Scope.new(city: null,
+                                 country: null,
+                                 level: null,
+                                 state: null)
+```
 
 

data/docs/Sentiment.md

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

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)
+```
+