aylien_news_api 1.0.0 → 3.0.0

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,19 @@
 # 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] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Stories.new(next_page_cursor: null,
+                                 stories: 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,11 +1,23 @@
 # AylienNewsApi::StoryLinks
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**canonical** | **String** | The story canonical URL | [optional] 
+**coverages** | **String** | The coverages URL | [optional] 
 **permalink** | **String** | The story permalink URL | [optional] 
 **related_stories** | **String** | The related stories URL | [optional] 
-**coverages** | **String** | The coverages URL | [optional] 
-**canonical** | **String** | The story canonical URL | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::StoryLinks.new(canonical: null,
+                                 coverages: null,
+                                 permalink: null,
+                                 related_stories: null)
+```
 
 

data/docs/StoryTranslations.md

@@ -0,0 +1,17 @@
+# AylienNewsApi::StoryTranslations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**en** | [**StoryTranslationsEn**](StoryTranslationsEn.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,19 @@
 # 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] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Trends.new(field: null,
+                                 trends: null)
+```
 
 

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/aylien_news_api.rb

@@ -1,17 +1,13 @@
 =begin
-Copyright 2017 Aylien, Inc. All Rights Reserved.
+#AYLIEN News API
 
-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
+#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client. 
 
-http://www.apache.org/licenses/LICENSE-2.0
+The version of the OpenAPI document: 3.0
+Contact: support@aylien.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.3-SNAPSHOT
 
-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.
 =end
 
 # Common files
@@ -26,6 +22,8 @@ require 'aylien_news_api/models/autocomplete'
 require 'aylien_news_api/models/autocompletes'
 require 'aylien_news_api/models/category'
 require 'aylien_news_api/models/category_links'
+require 'aylien_news_api/models/cluster'
+require 'aylien_news_api/models/clusters'
 require 'aylien_news_api/models/coverages'
 require 'aylien_news_api/models/entities'
 require 'aylien_news_api/models/entity'
@@ -40,6 +38,7 @@ require 'aylien_news_api/models/media'
 require 'aylien_news_api/models/rank'
 require 'aylien_news_api/models/rankings'
 require 'aylien_news_api/models/related_stories'
+require 'aylien_news_api/models/representative_story'
 require 'aylien_news_api/models/scope'
 require 'aylien_news_api/models/sentiment'
 require 'aylien_news_api/models/sentiments'
@@ -50,6 +49,8 @@ require 'aylien_news_api/models/stories'
 require 'aylien_news_api/models/story'
 require 'aylien_news_api/models/story_cluster'
 require 'aylien_news_api/models/story_links'
+require 'aylien_news_api/models/story_translations'
+require 'aylien_news_api/models/story_translations_en'
 require 'aylien_news_api/models/summary'
 require 'aylien_news_api/models/time_series'
 require 'aylien_news_api/models/time_series_list'