From dd4c1a8ca6e41409063c16d6623a54c9dbad5103 Mon Sep 17 00:00:00 2001
From: Graham Rhodes <1964861+grahamar@users.noreply.github.com>
Date: Tue, 29 Oct 2019 12:50:30 +0000
Subject: [PATCH] feat: Introduce clustering and machine translation
*Breaking changes are included*
---
Aylien.NewsApi.nuspec | 32 -
Aylien.NewsApi.sln | 20 +-
LICENSE | 201 -
README.md | 148 +-
build.sh | 43 -
docs/Author.md | 10 +-
docs/Autocomplete.md | 6 +-
docs/Autocompletes.md | 6 +-
docs/Category.md | 14 +-
docs/CategoryLinks.md | 8 +-
docs/Cluster.md | 19 +
docs/Clusters.md | 15 +
docs/Coverages.md | 13 +-
docs/DefaultApi.md | 3121 ++--
docs/Entities.md | 8 +-
docs/Entity.md | 12 +-
docs/EntityLinks.md | 6 +-
docs/Error.md | 10 +-
docs/ErrorLinks.md | 6 +-
docs/Errors.md | 6 +-
docs/HistogramInterval.md | 10 +-
docs/Histograms.md | 14 +-
docs/Location.md | 10 +-
docs/Media.md | 14 +-
docs/Rank.md | 10 +-
docs/Rankings.md | 6 +-
docs/RelatedStories.md | 11 +-
docs/RepresentativeStory.md | 16 +
docs/Scope.md | 10 +-
docs/Sentiment.md | 8 +-
docs/Sentiments.md | 10 +-
docs/ShareCount.md | 10 +-
docs/ShareCounts.md | 6 +-
docs/Source.md | 22 +-
docs/Stories.md | 9 +-
docs/Story.md | 42 +-
docs/StoryCluster.md | 14 +-
docs/StoryLinks.md | 10 +-
docs/StoryTranslations.md | 13 +
docs/StoryTranslationsEn.md | 15 +
docs/Summary.md | 6 +-
docs/TimeSeries.md | 10 +-
docs/TimeSeriesList.md | 12 +-
docs/Trend.md | 8 +-
docs/Trends.md | 8 +-
.../Aylien.NewsApi/Api/DefaultApi.cs | 12584 ++++++++--------
src/Aylien.NewsApi/Aylien.NewsApi.csproj | 54 +
.../Aylien.NewsApi/Client/ApiClient.cs | 195 +-
.../Aylien.NewsApi/Client/ApiException.cs | 26 +-
.../Aylien.NewsApi/Client/ApiResponse.cs | 26 +-
src/Aylien.NewsApi/Client/Configuration.cs | 446 +
src/Aylien.NewsApi/Client/ExceptionFactory.cs | 24 +
.../Client/GlobalConfiguration.cs | 34 +
.../Aylien.NewsApi/Client/IApiAccessor.cs | 28 +-
.../Client/IReadableConfiguration.cs | 94 +
.../Client/OpenAPIDateConverter.cs | 30 +
.../Aylien.NewsApi/Model/Author.cs | 117 +-
.../Aylien.NewsApi/Model/Autocomplete.cs | 86 +-
.../Aylien.NewsApi/Model/Autocompletes.cs | 72 +-
.../Aylien.NewsApi/Model/Category.cs | 189 +-
.../Aylien.NewsApi/Model/CategoryLinks.cs | 102 +-
src/Aylien.NewsApi/Model/Cluster.cs | 213 +
src/Aylien.NewsApi/Model/Clusters.cs | 148 +
src/Aylien.NewsApi/Model/Coverages.cs | 182 +
.../Aylien.NewsApi/Model/Entities.cs | 104 +-
src/Aylien.NewsApi/Model/Entity.cs | 182 +
.../Aylien.NewsApi/Model/EntityLinks.cs | 73 +-
.../csharp => }/Aylien.NewsApi/Model/Error.cs | 166 +-
.../Aylien.NewsApi/Model/ErrorLinks.cs | 73 +-
.../Aylien.NewsApi/Model/Errors.cs | 72 +-
.../Aylien.NewsApi/Model/HistogramInterval.cs | 90 +-
.../Aylien.NewsApi/Model/Histograms.cs | 168 +-
.../Aylien.NewsApi/Model/Location.cs | 119 +-
.../csharp => }/Aylien.NewsApi/Model/Media.cs | 290 +-
.../csharp => }/Aylien.NewsApi/Model/Rank.cs | 117 +-
.../Aylien.NewsApi/Model/Rankings.cs | 72 +-
src/Aylien.NewsApi/Model/RelatedStories.cs | 165 +
.../Model/RepresentativeStory.cs | 164 +
.../csharp => }/Aylien.NewsApi/Model/Scope.cs | 154 +-
.../Aylien.NewsApi/Model/Sentiment.cs | 118 +-
src/Aylien.NewsApi/Model/Sentiments.cs | 128 +
.../Aylien.NewsApi/Model/ShareCount.cs | 90 +-
.../Aylien.NewsApi/Model/ShareCounts.cs | 108 +-
.../Aylien.NewsApi/Model/Source.cs | 302 +-
src/Aylien.NewsApi/Model/Stories.cs | 131 +
src/Aylien.NewsApi/Model/Story.cs | 467 +
.../Aylien.NewsApi/Model/StoryCluster.cs | 147 +-
.../Aylien.NewsApi/Model/StoryLinks.cs | 144 +-
src/Aylien.NewsApi/Model/StoryTranslations.cs | 112 +
.../Model/StoryTranslationsEn.cs | 147 +
.../Aylien.NewsApi/Model/Summary.cs | 72 +-
.../Aylien.NewsApi/Model/TimeSeries.cs | 104 +-
.../Aylien.NewsApi/Model/TimeSeriesList.cs | 147 +-
.../csharp => }/Aylien.NewsApi/Model/Trend.cs | 102 +-
.../Aylien.NewsApi/Model/Trends.cs | 103 +-
src/Aylien.NewsApi/Properties/AssemblyInfo.cs | 32 +
src/Aylien.NewsApi/project.json | 12 +
.../Aylien.NewsApi/Aylien.NewsApi.csproj | 78 -
.../Aylien.NewsApi/Client/Configuration.cs | 342 -
.../Aylien.NewsApi/Client/ExceptionFactory.cs | 32 -
.../csharp/Aylien.NewsApi/Model/Coverages.cs | 210 -
.../csharp/Aylien.NewsApi/Model/Entity.cs | 206 -
.../Aylien.NewsApi/Model/RelatedStories.cs | 194 -
.../csharp/Aylien.NewsApi/Model/Sentiments.cs | 146 -
.../csharp/Aylien.NewsApi/Model/Stories.cs | 162 -
src/main/csharp/Aylien.NewsApi/Model/Story.cs | 434 -
.../Aylien.NewsApi/Properties/AssemblyInfo.cs | 53 -
.../csharp/Aylien.NewsApi/packages.config | 5 -
108 files changed, 12329 insertions(+), 12666 deletions(-)
delete mode 100644 Aylien.NewsApi.nuspec
delete mode 100644 LICENSE
delete mode 100644 build.sh
create mode 100644 docs/Cluster.md
create mode 100644 docs/Clusters.md
create mode 100644 docs/RepresentativeStory.md
create mode 100644 docs/StoryTranslations.md
create mode 100644 docs/StoryTranslationsEn.md
rename src/{main/csharp => }/Aylien.NewsApi/Api/DefaultApi.cs (51%)
create mode 100644 src/Aylien.NewsApi/Aylien.NewsApi.csproj
rename src/{main/csharp => }/Aylien.NewsApi/Client/ApiClient.cs (70%)
rename src/{main/csharp => }/Aylien.NewsApi/Client/ApiException.cs (73%)
rename src/{main/csharp => }/Aylien.NewsApi/Client/ApiResponse.cs (68%)
create mode 100644 src/Aylien.NewsApi/Client/Configuration.cs
create mode 100644 src/Aylien.NewsApi/Client/ExceptionFactory.cs
create mode 100644 src/Aylien.NewsApi/Client/GlobalConfiguration.cs
rename src/{main/csharp => }/Aylien.NewsApi/Client/IApiAccessor.cs (58%)
create mode 100644 src/Aylien.NewsApi/Client/IReadableConfiguration.cs
create mode 100644 src/Aylien.NewsApi/Client/OpenAPIDateConverter.cs
rename src/{main/csharp => }/Aylien.NewsApi/Model/Author.cs (53%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Autocomplete.cs (55%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Autocompletes.cs (55%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Category.cs (52%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/CategoryLinks.cs (55%)
create mode 100644 src/Aylien.NewsApi/Model/Cluster.cs
create mode 100644 src/Aylien.NewsApi/Model/Clusters.cs
create mode 100644 src/Aylien.NewsApi/Model/Coverages.cs
rename src/{main/csharp => }/Aylien.NewsApi/Model/Entities.cs (56%)
create mode 100644 src/Aylien.NewsApi/Model/Entity.cs
rename src/{main/csharp => }/Aylien.NewsApi/Model/EntityLinks.cs (53%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Error.cs (51%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/ErrorLinks.cs (53%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Errors.cs (53%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/HistogramInterval.cs (53%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Histograms.cs (51%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Location.cs (54%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Media.cs (55%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Rank.cs (52%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Rankings.cs (54%)
create mode 100644 src/Aylien.NewsApi/Model/RelatedStories.cs
create mode 100644 src/Aylien.NewsApi/Model/RepresentativeStory.cs
rename src/{main/csharp => }/Aylien.NewsApi/Model/Scope.cs (55%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Sentiment.cs (50%)
create mode 100644 src/Aylien.NewsApi/Model/Sentiments.cs
rename src/{main/csharp => }/Aylien.NewsApi/Model/ShareCount.cs (51%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/ShareCounts.cs (55%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Source.cs (53%)
create mode 100644 src/Aylien.NewsApi/Model/Stories.cs
create mode 100644 src/Aylien.NewsApi/Model/Story.cs
rename src/{main/csharp => }/Aylien.NewsApi/Model/StoryCluster.cs (53%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/StoryLinks.cs (52%)
create mode 100644 src/Aylien.NewsApi/Model/StoryTranslations.cs
create mode 100644 src/Aylien.NewsApi/Model/StoryTranslationsEn.cs
rename src/{main/csharp => }/Aylien.NewsApi/Model/Summary.cs (55%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/TimeSeries.cs (52%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/TimeSeriesList.cs (52%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Trend.cs (52%)
rename src/{main/csharp => }/Aylien.NewsApi/Model/Trends.cs (54%)
create mode 100644 src/Aylien.NewsApi/Properties/AssemblyInfo.cs
create mode 100644 src/Aylien.NewsApi/project.json
delete mode 100644 src/main/csharp/Aylien.NewsApi/Aylien.NewsApi.csproj
delete mode 100644 src/main/csharp/Aylien.NewsApi/Client/Configuration.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Client/ExceptionFactory.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Model/Coverages.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Model/Entity.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Model/RelatedStories.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Model/Sentiments.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Model/Stories.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Model/Story.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/Properties/AssemblyInfo.cs
delete mode 100644 src/main/csharp/Aylien.NewsApi/packages.config
diff --git a/Aylien.NewsApi.nuspec b/Aylien.NewsApi.nuspec
deleted file mode 100644
index ffc5b83..0000000
--- a/Aylien.NewsApi.nuspec
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-
- 2.0.0
- Aylien.NewsApi
- Aylien.NewsApi
- Aylien News API library for .NET
- Aylien Inc., Hamed Ramezanian Nik
- Aylien Inc.
- https://github.com/AYLIEN/aylien_newsapi_csharp/blob/master/LICENSE
- https://newsapi.aylien.com/
- true
- Copyright AYLIEN Inc. 2017
- See GitHub for details of commits since previous version.
- Aylien News API
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/Aylien.NewsApi.sln b/Aylien.NewsApi.sln
index 0eaed93..ad4160a 100644
--- a/Aylien.NewsApi.sln
+++ b/Aylien.NewsApi.sln
@@ -1,8 +1,8 @@
Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Express 2013 for Windows Desktop
-VisualStudioVersion = 12.0.31101.0
+# Visual Studio 14
+VisualStudioVersion = 14.0.25420.1
MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aylien.NewsApi", "src\main\csharp\Aylien.NewsApi\Aylien.NewsApi.csproj", "{C9AB4D14-F827-4E0E-B7B5-48AC4E4855AC}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aylien.NewsApi", "src\Aylien.NewsApi\Aylien.NewsApi.csproj", "{26CEEA81-E9A7-4904-BEBC-A3DBBF11F1A3}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -10,12 +10,16 @@ Global
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
- {C9AB4D14-F827-4E0E-B7B5-48AC4E4855AC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
- {C9AB4D14-F827-4E0E-B7B5-48AC4E4855AC}.Debug|Any CPU.Build.0 = Debug|Any CPU
- {C9AB4D14-F827-4E0E-B7B5-48AC4E4855AC}.Release|Any CPU.ActiveCfg = Release|Any CPU
- {C9AB4D14-F827-4E0E-B7B5-48AC4E4855AC}.Release|Any CPU.Build.0 = Release|Any CPU
+ {26CEEA81-E9A7-4904-BEBC-A3DBBF11F1A3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {26CEEA81-E9A7-4904-BEBC-A3DBBF11F1A3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {26CEEA81-E9A7-4904-BEBC-A3DBBF11F1A3}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {26CEEA81-E9A7-4904-BEBC-A3DBBF11F1A3}.Release|Any CPU.Build.0 = Release|Any CPU
+ {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
-EndGlobal
+EndGlobal
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index 8dada3e..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,201 +0,0 @@
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "{}"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright {yyyy} {name of copyright owner}
-
- 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
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- 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.
diff --git a/README.md b/README.md
index b6f41bf..4306356 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,150 @@
-# AYLIEN News API
+# AYLIEN News API - C# SDK
-AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content.
+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.
Sign up at [https://newsapi.aylien.com/](https://newsapi.aylien.com/).
For more documentation see [https://newsapi.aylien.com/docs/](https://newsapi.aylien.com/docs/).
-## Bug Reports
-If you've got a bug report, please contact us at support@aylien.com.
+## Frameworks supported
+- .NET 4.0 or later
+- Windows Phone 7.1 (Mango)
+
+## Dependencies
+- [FubarCoder](https://www.nuget.org/packages/FubarCoder.RestSharp.Portable.HttpClient) - 4.0.8 or later
+- [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/) - 12.0.2 or later
+
+The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
+```
+Install-Package FubarCoder.RestSharp.Portable.HttpClient
+Install-Package Newtonsoft.Json
+```
+
+NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742)
+
+## Installation
+Run the following command to generate the DLL
+- [Mac/Linux] `/bin/sh build.sh`
+- [Windows] `build.bat`
+
+Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces:
+```csharp
+using Aylien.NewsApi.Api;
+using Aylien.NewsApi.Client;
+using Aylien.NewsApi.Model;
+```
+
+## Getting Started
+
+```csharp
+using System;
+using Aylien.NewsApi.Api;
+using Aylien.NewsApi.Client;
+using Aylien.NewsApi.Model;
+using System.Collections.Generic;
+
+namespace GettingStartedExample
+{
+ class Program
+ {
+ static void Main(string[] args)
+ {
+ // Configure API key authorization: app_id
+ var apiId = System.Environment.GetEnvironmentVariable("X-AYLIEN-NewsAPI-Application-ID");
+ Configuration.Default.ApiKey.Add("X-AYLIEN-NewsAPI-Application-ID", apiId);
+
+ // Configure API key authorization: app_key
+ var apiKey = System.Environment.GetEnvironmentVariable("X-AYLIEN-NewsAPI-Application-Key");
+ Configuration.Default.ApiKey.Add("X-AYLIEN-NewsAPI-Application-Key", apiKey);
+
+ var apiInstance = new DefaultApi();
+
+ try
+ {
+ // List stories
+ Stories storiesResponse = apiInstance.ListStories(
+ title: "trump",
+ publishedAtStart: "NOW-7DAYS",
+ publishedAtEnd: "NOW",
+ language: new List { "en" },
+ notLanguage: new List { "it", "es" },
+ entitiesBodyLinksDbpedia: new List {
+ "http://dbpedia.org/resource/Donald_Trump",
+ "http://dbpedia.org/resource/Hillary_Rodham_Clinton"
+ },
+ sortBy: "social_shares_count.facebook"
+ );
+
+ foreach (var story in storiesResponse._Stories)
+ {
+ Console.WriteLine(story.Title + " / " + story.Source.Name);
+ }
+ }
+ catch (Exception e)
+ {
+ Console.WriteLine("Exception when calling DefaultApi.ListStories: " + e.Message);
+ }
+ }
+ }
+}
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.aylien.com/news*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DefaultApi* | [**ListAutocompletes**](docs/DefaultApi.md#listautocompletes) | **GET** /autocompletes | List autocompletes
+*DefaultApi* | [**ListClusters**](docs/DefaultApi.md#listclusters) | **GET** /clusters | List Clusters
+*DefaultApi* | [**ListCoverages**](docs/DefaultApi.md#listcoverages) | **GET** /coverages | List coverages
+*DefaultApi* | [**ListHistograms**](docs/DefaultApi.md#listhistograms) | **GET** /histograms | List histograms
+*DefaultApi* | [**ListRelatedStories**](docs/DefaultApi.md#listrelatedstories) | **GET** /related_stories | List related stories
+*DefaultApi* | [**ListStories**](docs/DefaultApi.md#liststories) | **GET** /stories | List Stories
+*DefaultApi* | [**ListTimeSeries**](docs/DefaultApi.md#listtimeseries) | **GET** /time_series | List time series
+*DefaultApi* | [**ListTrends**](docs/DefaultApi.md#listtrends) | **GET** /trends | List trends
+
+
+
+## Documentation for Models
+
+ - [Model.Author](docs/Author.md)
+ - [Model.Autocomplete](docs/Autocomplete.md)
+ - [Model.Autocompletes](docs/Autocompletes.md)
+ - [Model.Category](docs/Category.md)
+ - [Model.CategoryLinks](docs/CategoryLinks.md)
+ - [Model.Cluster](docs/Cluster.md)
+ - [Model.Clusters](docs/Clusters.md)
+ - [Model.Coverages](docs/Coverages.md)
+ - [Model.Entities](docs/Entities.md)
+ - [Model.Entity](docs/Entity.md)
+ - [Model.EntityLinks](docs/EntityLinks.md)
+ - [Model.Error](docs/Error.md)
+ - [Model.ErrorLinks](docs/ErrorLinks.md)
+ - [Model.Errors](docs/Errors.md)
+ - [Model.HistogramInterval](docs/HistogramInterval.md)
+ - [Model.Histograms](docs/Histograms.md)
+ - [Model.Location](docs/Location.md)
+ - [Model.Media](docs/Media.md)
+ - [Model.Rank](docs/Rank.md)
+ - [Model.Rankings](docs/Rankings.md)
+ - [Model.RelatedStories](docs/RelatedStories.md)
+ - [Model.RepresentativeStory](docs/RepresentativeStory.md)
+ - [Model.Scope](docs/Scope.md)
+ - [Model.Sentiment](docs/Sentiment.md)
+ - [Model.Sentiments](docs/Sentiments.md)
+ - [Model.ShareCount](docs/ShareCount.md)
+ - [Model.ShareCounts](docs/ShareCounts.md)
+ - [Model.Source](docs/Source.md)
+ - [Model.Stories](docs/Stories.md)
+ - [Model.Story](docs/Story.md)
+ - [Model.StoryCluster](docs/StoryCluster.md)
+ - [Model.StoryLinks](docs/StoryLinks.md)
+ - [Model.StoryTranslations](docs/StoryTranslations.md)
+ - [Model.StoryTranslationsEn](docs/StoryTranslationsEn.md)
+ - [Model.Summary](docs/Summary.md)
+ - [Model.TimeSeries](docs/TimeSeries.md)
+ - [Model.TimeSeriesList](docs/TimeSeriesList.md)
+ - [Model.Trend](docs/Trend.md)
+ - [Model.Trends](docs/Trends.md)
+
diff --git a/build.sh b/build.sh
deleted file mode 100644
index d8837c9..0000000
--- a/build.sh
+++ /dev/null
@@ -1,43 +0,0 @@
-#!/usr/bin/env bash
-#
-# Copyright 2017 Aylien, Inc. All Rights Reserved.
-
-# 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
-
-# http://www.apache.org/licenses/LICENSE-2.0
-
-# 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.
-
-frameworkVersion=net45
-netfx=${frameworkVersion#net}
-
-wget -nc https://nuget.org/nuget.exe;
-cert-sync --import --sync
-mono nuget.exe install ./src/main/csharp/Aylien.NewsApi/packages.config -o vendor;
-mkdir -p bin;
-
-mkdir bin/${frameworkVersion}
-
-# Rename RestSharp net4 to net40
-if [ ! -d "vendor/RestSharp.105.2.3/lib/${frameworkVersion}" ]; then
- mv "vendor/RestSharp.105.2.3/lib/net4" "vendor/RestSharp.105.2.3/lib/${frameworkVersion}"
-fi
-
-cp vendor/Newtonsoft.Json.8.0.3/lib/${frameworkVersion}/Newtonsoft.Json.dll bin/${frameworkVersion}/Newtonsoft.Json.dll;
-cp vendor/RestSharp.105.2.3/lib/${frameworkVersion}/RestSharp.dll bin/${frameworkVersion}/RestSharp.dll;
-
-mcs -sdk:${netfx} -r:bin/${frameworkVersion}/Newtonsoft.Json.dll,\
-bin/${frameworkVersion}/RestSharp.dll,\
-System.ComponentModel.DataAnnotations.dll,\
-System.Runtime.Serialization.dll \
--target:library \
--out:bin/${frameworkVersion}/Aylien.NewsApi.dll \
--recurse:'src/*.cs' \
--doc:bin/${frameworkVersion}/Aylien.NewsApi.xml \
--platform:anycpu
\ No newline at end of file
diff --git a/docs/Author.md b/docs/Author.md
index 79570d7..df313e9 100644
--- a/docs/Author.md
+++ b/docs/Author.md
@@ -1,11 +1,15 @@
+
# Aylien.NewsApi.Model.Author
+
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Id** | **long?** | A unique identification for the author | [optional]
-**Name** | **string** | The extracted author full name | [optional]
**AvatarUrl** | **string** | A URL which points to the author avatar | [optional]
+**Id** | **long** | A unique identification for the author | [optional]
+**Name** | **string** | The extracted author full name | [optional]
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
diff --git a/docs/Autocomplete.md b/docs/Autocomplete.md
index e37ea90..8b7f766 100644
--- a/docs/Autocomplete.md
+++ b/docs/Autocomplete.md
@@ -1,4 +1,6 @@
+
# Aylien.NewsApi.Model.Autocomplete
+
## Properties
Name | Type | Description | Notes
@@ -6,5 +8,7 @@ Name | Type | Description | Notes
**Id** | **string** | ID of the autocomplete | [optional]
**Text** | **string** | Text of the autocomplete | [optional]
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
diff --git a/docs/Autocompletes.md b/docs/Autocompletes.md
index 6bb1135..1cccdcb 100644
--- a/docs/Autocompletes.md
+++ b/docs/Autocompletes.md
@@ -1,9 +1,13 @@
+
# Aylien.NewsApi.Model.Autocompletes
+
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_Autocompletes** | [**List<Autocomplete>**](Autocomplete.md) | An array of autocompletes | [optional]
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
diff --git a/docs/Category.md b/docs/Category.md
index 213c088..23d0aab 100644
--- a/docs/Category.md
+++ b/docs/Category.md
@@ -1,14 +1,18 @@
+
# Aylien.NewsApi.Model.Category
+
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
+**Confident** | **bool** | It defines whether the extracted category is confident or not | [optional]
**Id** | **string** | The ID of the category | [optional]
+**Level** | **int** | The level of the category | [optional]
+**Links** | [**CategoryLinks**](CategoryLinks.md) | | [optional]
+**Score** | **double** | The score of the category | [optional]
**Taxonomy** | **string** | The taxonomy of the category | [optional]
-**Level** | **int?** | The level of the category | [optional]
-**Score** | **double?** | The score of the category | [optional]
-**Confident** | **bool?** | It defines whether the extracted category is confident or not | [optional]
-**Links** | [**CategoryLinks**](CategoryLinks.md) | Related links for the category | [optional]
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
diff --git a/docs/CategoryLinks.md b/docs/CategoryLinks.md
index 0cee533..dab6b20 100644
--- a/docs/CategoryLinks.md
+++ b/docs/CategoryLinks.md
@@ -1,10 +1,14 @@
+
# Aylien.NewsApi.Model.CategoryLinks
+
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Self** | **string** | A URL pointing to the category | [optional]
**Parent** | **string** | A URL pointing to the parent category | [optional]
+**Self** | **string** | A URL pointing to the category | [optional]
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
diff --git a/docs/Cluster.md b/docs/Cluster.md
new file mode 100644
index 0000000..425b6f3
--- /dev/null
+++ b/docs/Cluster.md
@@ -0,0 +1,19 @@
+
+# Aylien.NewsApi.Model.Cluster
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**EarliestStory** | **DateTime** | Publication date of the earliest story in cluster | [optional]
+**Id** | **long** | ID of the cluster which is a unique identification | [optional]
+**LatestStory** | **DateTime** | Publication date of the latest story in cluster | [optional]
+**Location** | [**Location**](Location.md) | | [optional]
+**RepresentativeStory** | [**RepresentativeStory**](RepresentativeStory.md) | | [optional]
+**StoryCount** | **int** | Number of stories associated with the cluster | [optional]
+**Time** | **DateTime** | Time of the event | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
+
diff --git a/docs/Clusters.md b/docs/Clusters.md
new file mode 100644
index 0000000..0640f7f
--- /dev/null
+++ b/docs/Clusters.md
@@ -0,0 +1,15 @@
+
+# Aylien.NewsApi.Model.Clusters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ClusterCount** | **long** | The total number of clusters | [optional]
+**_Clusters** | [**List<Cluster>**](Cluster.md) | An array of clusters | [optional]
+**NextPageCursor** | **string** | The next page cursor | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
+
diff --git a/docs/Coverages.md b/docs/Coverages.md
index 5e903e0..ff5a86e 100644
--- a/docs/Coverages.md
+++ b/docs/Coverages.md
@@ -1,14 +1,17 @@
+
# Aylien.NewsApi.Model.Coverages
+
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**StoryTitle** | **string** | The input story title | [optional]
+**_Coverages** | [**List<Story>**](Story.md) | An array of coverages for the input story | [optional]
**StoryBody** | **string** | The input story body | [optional]
-**StoryPublishedAt** | **DateTime?** | The input story published date | [optional]
**StoryLanguage** | **string** | The input story language | [optional]
-**_Coverages** | [**List<Story>**](Story.md) | An array of coverages for the input story | [optional]
-**Clusters** | [**List<StoryCluster>**](StoryCluster.md) | An array of clusters | [optional]
+**StoryPublishedAt** | **DateTime** | The input story published date | [optional]
+**StoryTitle** | **string** | The input story title | [optional]
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to README]](../README.md)
diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md
index d9981d8..f4e605c 100644
--- a/docs/DefaultApi.md
+++ b/docs/DefaultApi.md
@@ -1,29 +1,32 @@
# Aylien.NewsApi.Api.DefaultApi
-All URIs are relative to *https://api.newsapi.aylien.com/api/v1*
+All URIs are relative to *https://api.aylien.com/news*
Method | HTTP request | Description
------------- | ------------- | -------------
[**ListAutocompletes**](DefaultApi.md#listautocompletes) | **GET** /autocompletes | List autocompletes
-[**ListCoverages**](DefaultApi.md#listcoverages) | **POST** /coverages | List coverages
+[**ListClusters**](DefaultApi.md#listclusters) | **GET** /clusters | List Clusters
+[**ListCoverages**](DefaultApi.md#listcoverages) | **GET** /coverages | List coverages
[**ListHistograms**](DefaultApi.md#listhistograms) | **GET** /histograms | List histograms
-[**ListRelatedStories**](DefaultApi.md#listrelatedstories) | **POST** /related_stories | List related stories
+[**ListRelatedStories**](DefaultApi.md#listrelatedstories) | **GET** /related_stories | List related stories
[**ListStories**](DefaultApi.md#liststories) | **GET** /stories | List Stories
[**ListTimeSeries**](DefaultApi.md#listtimeseries) | **GET** /time_series | List time series
[**ListTrends**](DefaultApi.md#listtrends) | **GET** /trends | List trends
-
-# **ListAutocompletes**
+
+## ListAutocompletes
+
> Autocompletes ListAutocompletes (string type, string term, string language = null, int? perPage = null)
List autocompletes
-This endpoint is used for getting list of autocompletes by providing a specific term and type.
+The autocompletes endpoint a string of characters provided to it, and then returns suggested terms that are the most likely full words or strings. The terms returned by the News API are based on parameters the type parameters you can see below. For example, if you provide the autocompletes endpoint with the term `New York C` and select the type `dbpedia_resources`, the API will return links to the DBpedia resources `New_York_City`, `New_York_City_Subway`, `New_York_City_Police_Department`, and so on.
### Example
+
```csharp
-using System;
+using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
@@ -33,35 +36,35 @@ namespace Example
{
public class ListAutocompletesExample
{
- static void Main(string[] args)
+ public static void Main()
{
+ Configuration.Default.BasePath = "https://api.aylien.com/news";
// Configure API key authorization: app_id
- Configuration.Default.ApiKey.Add("X-AYLIEN-NewsAPI-Application-ID", "YOUR_APP_ID");
-
+ Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
+ // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+ // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
// Configure API key authorization: app_key
- Configuration.Default.ApiKey.Add("X-AYLIEN-NewsAPI-Application-Key", "YOUR_APP_KEY");
-
- var apiInstance = new DefaultApi();
+ Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
+ // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+ // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");
- var type = type_example;
- var term = term_example;
- var language = language_example;
- var perPage = 56;
+ var apiInstance = new DefaultApi(Configuration.Default);
+ var type = source_names; // string | This parameter is used for defining the type of autocompletes.
+ var term = News; // string | This parameter is used for finding autocomplete objects that contain the specified value.
+ var language = language_example; // string | This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. (optional) (default to en)
+ var perPage = 56; // int? | This parameter is used for specifying number of items in each page. (optional) (default to 3)
try
{
// List autocompletes
- Autocompletes result = apiInstance.ListAutocompletes(
- type: type,
- term: term,
- language: language,
- perPage: perPage
- );
+ Autocompletes result = apiInstance.ListAutocompletes(type, term, language, perPage);
Debug.WriteLine(result);
}
- catch (Exception e)
+ catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListAutocompletes: " + e.Message );
+ Debug.Print("Status Code: "+ e.ErrorCode);
+ Debug.Print(e.StackTrace);
}
}
}
@@ -70,12 +73,13 @@ namespace Example
### Parameters
+
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **type** | **string**| This parameter is used for defining the type of autocompletes. | [enum: source_names, source_domains, entity_types, dbpedia_resources]
- **term** | **string**| This parameter is used for finding autocomplete objects that contain the specified value. |
- **language** | **string**| This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to en] [enum: en, de, fr, it, es, pt]
- **perPage** | **int?**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
+ **type** | **string**| This parameter is used for defining the type of autocompletes. |
+ **term** | **string**| This parameter is used for finding autocomplete objects that contain the specified value. |
+ **language** | **string**| This parameter is used for autocompletes whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to en]
+ **perPage** | **int?**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
### Return type
@@ -83,26 +87,152 @@ Name | Type | Description | Notes
### Authorization
-[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+[app_id](../README.md#app_id), [app_key](../README.md#app_key)
### HTTP request headers
- - **Content-Type**: application/x-www-form-urlencoded
- - **Accept**: application/json, text/xml
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | An object including an array of autocompletes | * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
|
+| **401** | Unauthorized | - |
+| **404** | Not Found | - |
+| **422** | Unprocessable Entity | - |
+| **492** | Too Many Requests | * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
|
+| **500** | Internal Server Error | - |
+
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
+
+
+## ListClusters
+
+> Clusters ListClusters (List id = null, List notId = null, int? storyCountMin = null, int? storyCountMax = null, string timeStart = null, string timeEnd = null, string earliestStoryStart = null, string earliestStoryEnd = null, string latestStoryStart = null, string latestStoryEnd = null, List locationCountry = null, List notLocationCountry = null)
+
+List Clusters
+
+The clusters endpoint is used to return clusters based on parameters you set in your query.
+
+### Example
+
+```csharp
+using System.Collections.Generic;
+using System.Diagnostics;
+using Aylien.NewsApi.Api;
+using Aylien.NewsApi.Client;
+using Aylien.NewsApi.Model;
+
+namespace Example
+{
+ public class ListClustersExample
+ {
+ public static void Main()
+ {
+ Configuration.Default.BasePath = "https://api.aylien.com/news";
+ // Configure API key authorization: app_id
+ Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
+ // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+ // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
+ // Configure API key authorization: app_key
+ Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
+ // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+ // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");
+
+ var apiInstance = new DefaultApi(Configuration.Default);
+ var id = new List(); // List | This parameter is used for finding clusters by cluster id. (optional)
+ var notId = new List(); // List | This parameter is used for excluding clusters by cluster id. (optional)
+ var storyCountMin = 56; // int? | This parameter is used for finding clusters with more than or equal to a specific amount of stories associated with them. (optional)
+ var storyCountMax = 56; // int? | This parameter is used for finding clusters with less than or equal to a specific amount of stories associated with them. (optional)
+ var timeStart = timeStart_example; // string | This parameter is used for finding clusters whose creation time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var timeEnd = timeEnd_example; // string | This parameter is used for finding clusters whose creation time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var earliestStoryStart = earliestStoryStart_example; // string | This parameter is used for finding clusters whose publication date of its earliest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var earliestStoryEnd = earliestStoryEnd_example; // string | This parameter is used for finding clusters whose publication date of its earliest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var latestStoryStart = latestStoryStart_example; // string | This parameter is used for finding clusters whose publication date of its latest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var latestStoryEnd = latestStoryEnd_example; // string | This parameter is used for finding clusters whose publication date of its latest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var locationCountry = new List(); // List | This parameter is used for finding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notLocationCountry = new List(); // List | This parameter is used for excluding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+
+ try
+ {
+ // List Clusters
+ Clusters result = apiInstance.ListClusters(id, notId, storyCountMin, storyCountMax, timeStart, timeEnd, earliestStoryStart, earliestStoryEnd, latestStoryStart, latestStoryEnd, locationCountry, notLocationCountry);
+ Debug.WriteLine(result);
+ }
+ catch (ApiException e)
+ {
+ Debug.Print("Exception when calling DefaultApi.ListClusters: " + e.Message );
+ Debug.Print("Status Code: "+ e.ErrorCode);
+ Debug.Print(e.StackTrace);
+ }
+ }
+ }
+}
+```
+
+### Parameters
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **ListCoverages**
-> Coverages ListCoverages (List id = null, List notId = null, string title = null, string body = null, string text = null, List language = null, List notLanguage = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null, bool? cluster = null, string clusterAlgorithm = null, List _return = null, long? storyId = null, string storyUrl = null, string storyTitle = null, string storyBody = null, DateTime? storyPublishedAt = null, string storyLanguage = null, int? perPage = null)
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**List<long>**](long.md)| This parameter is used for finding clusters by cluster id. | [optional]
+ **notId** | [**List<long>**](long.md)| This parameter is used for excluding clusters by cluster id. | [optional]
+ **storyCountMin** | **int?**| This parameter is used for finding clusters with more than or equal to a specific amount of stories associated with them. | [optional]
+ **storyCountMax** | **int?**| This parameter is used for finding clusters with less than or equal to a specific amount of stories associated with them. | [optional]
+ **timeStart** | **string**| This parameter is used for finding clusters whose creation time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **timeEnd** | **string**| This parameter is used for finding clusters whose creation time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **earliestStoryStart** | **string**| This parameter is used for finding clusters whose publication date of its earliest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **earliestStoryEnd** | **string**| This parameter is used for finding clusters whose publication date of its earliest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **latestStoryStart** | **string**| This parameter is used for finding clusters whose publication date of its latest story is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **latestStoryEnd** | **string**| This parameter is used for finding clusters whose publication date of its latest story is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **locationCountry** | [**List<string>**](string.md)| This parameter is used for finding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notLocationCountry** | [**List<string>**](string.md)| This parameter is used for excluding clusters belonging to a specific country. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+
+### Return type
+
+[**Clusters**](Clusters.md)
+
+### Authorization
+
+[app_id](../README.md#app_id), [app_key](../README.md#app_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | An object including an array of clusters | * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
|
+| **401** | Unauthorized | - |
+| **404** | Not Found | - |
+| **422** | Unprocessable Entity | - |
+| **492** | Too Many Requests | * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
|
+| **500** | Internal Server Error | - |
+
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
+
+
+## ListCoverages
+
+> Coverages ListCoverages (List id = null, List notId = null, string title = null, string body = null, string text = null, string translationsEnTitle = null, string translationsEnBody = null, string translationsEnText = null, List language = null, List notLanguage = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List notEntitiesTitleLinksDbpedia = null, List entitiesBodyText = null, List notEntitiesBodyText = null, List entitiesBodyType = null, List notEntitiesBodyType = null, List entitiesBodyLinksDbpedia = null, List notEntitiesBodyLinksDbpedia = null, string sentimentTitlePolarity = null, string notSentimentTitlePolarity = null, string sentimentBodyPolarity = null, string notSentimentBodyPolarity = null, int? mediaImagesCountMin = null, int? mediaImagesCountMax = null, int? mediaImagesWidthMin = null, int? mediaImagesWidthMax = null, int? mediaImagesHeightMin = null, int? mediaImagesHeightMax = null, int? mediaImagesContentLengthMin = null, int? mediaImagesContentLengthMax = null, List mediaImagesFormat = null, List notMediaImagesFormat = null, int? mediaVideosCountMin = null, int? mediaVideosCountMax = null, List authorId = null, List notAuthorId = null, string authorName = null, string notAuthorName = null, List sourceId = null, List notSourceId = null, List sourceName = null, List notSourceName = null, List sourceDomain = null, List notSourceDomain = null, List sourceLocationsCountry = null, List notSourceLocationsCountry = null, List sourceLocationsState = null, List notSourceLocationsState = null, List sourceLocationsCity = null, List notSourceLocationsCity = null, List sourceScopesCountry = null, List notSourceScopesCountry = null, List sourceScopesState = null, List notSourceScopesState = null, List sourceScopesCity = null, List notSourceScopesCity = null, List sourceScopesLevel = null, List notSourceScopesLevel = null, int? sourceLinksInCountMin = null, int? sourceLinksInCountMax = null, int? sourceRankingsAlexaRankMin = null, int? sourceRankingsAlexaRankMax = null, List sourceRankingsAlexaCountry = null, int? socialSharesCountFacebookMin = null, int? socialSharesCountFacebookMax = null, int? socialSharesCountGooglePlusMin = null, int? socialSharesCountGooglePlusMax = null, int? socialSharesCountLinkedinMin = null, int? socialSharesCountLinkedinMax = null, int? socialSharesCountRedditMin = null, int? socialSharesCountRedditMax = null, List clusters = null, List _return = null, long? storyId = null, string storyUrl = null, string storyTitle = null, string storyBody = null, DateTime? storyPublishedAt = null, string storyLanguage = null, int? perPage = null)
List coverages
-This endpoint is used for finding story coverages based on the parameters provided. The maximum number of related stories returned is 100.
+The coverages endpoint allows you to understand the reach a document has had. For example, you can track the coverage of a press release or a Tweet based on how many times it has been mentioned in stories.
### Example
+
```csharp
-using System;
+using System.Collections.Generic;
using System.Diagnostics;
using Aylien.NewsApi.Api;
using Aylien.NewsApi.Client;
@@ -112,207 +242,123 @@ namespace Example
{
public class ListCoveragesExample
{
- static void Main(string[] args)
+ public static void Main()
{
+ Configuration.Default.BasePath = "https://api.aylien.com/news";
// Configure API key authorization: app_id
- Configuration.Default.ApiKey.Add("X-AYLIEN-NewsAPI-Application-ID", "YOUR_APP_ID");
-
+ Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-ID", "YOUR_API_KEY");
+ // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+ // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-ID", "Bearer");
// Configure API key authorization: app_key
- Configuration.Default.ApiKey.Add("X-AYLIEN-NewsAPI-Application-Key", "YOUR_APP_KEY");
-
- var apiInstance = new DefaultApi();
-
- var id = new List();
- var notId = new List();
- var title = title_example;
- var body = body_example;
- var text = text_example;
- var language = new List();
- var notLanguage = new List();
- var publishedAtStart = publishedAtStart_example;
- var publishedAtEnd = publishedAtEnd_example;
- var categoriesTaxonomy = categoriesTaxonomy_example;
- var categoriesConfident = true;
- var categoriesId = new List();
- var notCategoriesId = new List();
- var categoriesLevel = new List();
- var notCategoriesLevel = new List();
- var entitiesTitleText = new List();
- var notEntitiesTitleText = new List();
- var entitiesTitleType = new List();
- var notEntitiesTitleType = new List();
- var entitiesTitleLinksDbpedia = new List();
- var notEntitiesTitleLinksDbpedia = new List();
- var entitiesBodyText = new List();
- var notEntitiesBodyText = new List();
- var entitiesBodyType = new List();
- var notEntitiesBodyType = new List();
- var entitiesBodyLinksDbpedia = new List();
- var notEntitiesBodyLinksDbpedia = new List();
- var sentimentTitlePolarity = sentimentTitlePolarity_example;
- var notSentimentTitlePolarity = notSentimentTitlePolarity_example;
- var sentimentBodyPolarity = sentimentBodyPolarity_example;
- var notSentimentBodyPolarity = notSentimentBodyPolarity_example;
- var mediaImagesCountMin = 56;
- var mediaImagesCountMax = 56;
- var mediaImagesWidthMin = 56;
- var mediaImagesWidthMax = 56;
- var mediaImagesHeightMin = 56;
- var mediaImagesHeightMax = 56;
- var mediaImagesContentLengthMin = 56;
- var mediaImagesContentLengthMax = 56;
- var mediaImagesFormat = new List();
- var notMediaImagesFormat = new List();
- var mediaVideosCountMin = 56;
- var mediaVideosCountMax = 56;
- var authorId = new List();
- var notAuthorId = new List();
- var authorName = authorName_example;
- var notAuthorName = notAuthorName_example;
- var sourceId = new List();
- var notSourceId = new List();
- var sourceName = new List();
- var notSourceName = new List();
- var sourceDomain = new List();
- var notSourceDomain = new List();
- var sourceLocationsCountry = new List();
- var notSourceLocationsCountry = new List();
- var sourceLocationsState = new List();
- var notSourceLocationsState = new List();
- var sourceLocationsCity = new List();
- var notSourceLocationsCity = new List();
- var sourceScopesCountry = new List();
- var notSourceScopesCountry = new List();
- var sourceScopesState = new List();
- var notSourceScopesState = new List();
- var sourceScopesCity = new List();
- var notSourceScopesCity = new List();
- var sourceScopesLevel = new List();
- var notSourceScopesLevel = new List();
- var sourceLinksInCountMin = 56;
- var sourceLinksInCountMax = 56;
- var sourceRankingsAlexaRankMin = 56;
- var sourceRankingsAlexaRankMax = 56;
- var sourceRankingsAlexaCountry = new List();
- var socialSharesCountFacebookMin = 56;
- var socialSharesCountFacebookMax = 56;
- var socialSharesCountGooglePlusMin = 56;
- var socialSharesCountGooglePlusMax = 56;
- var socialSharesCountLinkedinMin = 56;
- var socialSharesCountLinkedinMax = 56;
- var socialSharesCountRedditMin = 56;
- var socialSharesCountRedditMax = 56;
- var cluster = true;
- var clusterAlgorithm = clusterAlgorithm_example;
- var _return = new List();
- var storyId = 789;
- var storyUrl = storyUrl_example;
- var storyTitle = storyTitle_example;
- var storyBody = storyBody_example;
- var storyPublishedAt = 2013-10-20T19:20:30+01:00;
- var storyLanguage = storyLanguage_example;
- var perPage = 56;
+ Configuration.Default.AddApiKey("X-AYLIEN-NewsAPI-Application-Key", "YOUR_API_KEY");
+ // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+ // Configuration.Default.AddApiKeyPrefix("X-AYLIEN-NewsAPI-Application-Key", "Bearer");
+
+ var apiInstance = new DefaultApi(Configuration.Default);
+ var id = new List(); // List | This parameter is used for finding stories by story id. (optional)
+ var notId = new List(); // List | This parameter is used for excluding stories by story id. (optional)
+ var title = title_example; // string | This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). (optional)
+ var body = body_example; // string | This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). (optional)
+ var text = text_example; // string | This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). (optional)
+ var translationsEnTitle = translationsEnTitle_example; // string | This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). (optional)
+ var translationsEnBody = translationsEnBody_example; // string | This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). (optional)
+ var translationsEnText = translationsEnText_example; // string | This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). (optional)
+ var language = language_example; // List | This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. (optional)
+ var notLanguage = language_example; // List | This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. (optional)
+ var publishedAtStart = publishedAtStart_example; // string | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var publishedAtEnd = publishedAtEnd_example; // string | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). (optional)
+ var categoriesTaxonomy = categoriesTaxonomy_example; // string | This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). (optional)
+ var categoriesConfident = true; // bool? | This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). (optional) (default to true)
+ var categoriesId = new List(); // List | This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). (optional)
+ var notCategoriesId = new List(); // List | This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). (optional)
+ var categoriesLevel = new List(); // List | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). (optional)
+ var notCategoriesLevel = new List(); // List | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). (optional)
+ var entitiesTitleText = new List(); // List | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var notEntitiesTitleText = new List(); // List | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var entitiesTitleType = new List(); // List | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var notEntitiesTitleType = new List(); // List | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var entitiesTitleLinksDbpedia = new List(); // List | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var notEntitiesTitleLinksDbpedia = new List(); // List | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var entitiesBodyText = new List(); // List | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var notEntitiesBodyText = new List(); // List | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var entitiesBodyType = new List(); // List | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var notEntitiesBodyType = new List(); // List | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var entitiesBodyLinksDbpedia = new List(); // List | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var notEntitiesBodyLinksDbpedia = new List(); // List | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). (optional)
+ var sentimentTitlePolarity = sentimentTitlePolarity_example; // string | This parameter is used for finding stories whose title sentiment is the specified value. (optional)
+ var notSentimentTitlePolarity = sentimentTitlePolarity_example; // string | This parameter is used for excluding stories whose title sentiment is the specified value. (optional)
+ var sentimentBodyPolarity = sentimentBodyPolarity_example; // string | This parameter is used for finding stories whose body sentiment is the specified value. (optional)
+ var notSentimentBodyPolarity = sentimentBodyPolarity_example; // string | This parameter is used for excluding stories whose body sentiment is the specified value. (optional)
+ var mediaImagesCountMin = 56; // int? | This parameter is used for finding stories whose number of images is greater than or equal to the specified value. (optional)
+ var mediaImagesCountMax = 56; // int? | This parameter is used for finding stories whose number of images is less than or equal to the specified value. (optional)
+ var mediaImagesWidthMin = 56; // int? | This parameter is used for finding stories whose width of images are greater than or equal to the specified value. (optional)
+ var mediaImagesWidthMax = 56; // int? | This parameter is used for finding stories whose width of images are less than or equal to the specified value. (optional)
+ var mediaImagesHeightMin = 56; // int? | This parameter is used for finding stories whose height of images are greater than or equal to the specified value. (optional)
+ var mediaImagesHeightMax = 56; // int? | This parameter is used for finding stories whose height of images are less than or equal to the specified value. (optional)
+ var mediaImagesContentLengthMin = 56; // int? | This parameter is used for finding stories whose images content length are greater than or equal to the specified value. (optional)
+ var mediaImagesContentLengthMax = 56; // int? | This parameter is used for finding stories whose images content length are less than or equal to the specified value. (optional)
+ var mediaImagesFormat = mediaImagesFormat_example; // List | This parameter is used for finding stories whose images format are the specified value. (optional)
+ var notMediaImagesFormat = mediaImagesFormat_example; // List | This parameter is used for excluding stories whose images format are the specified value. (optional)
+ var mediaVideosCountMin = 56; // int? | This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. (optional)
+ var mediaVideosCountMax = 56; // int? | This parameter is used for finding stories whose number of videos is less than or equal to the specified value. (optional)
+ var authorId = new List(); // List | This parameter is used for finding stories whose author id is the specified value. (optional)
+ var notAuthorId = new List(); // List | This parameter is used for excluding stories whose author id is the specified value. (optional)
+ var authorName = authorName_example; // string | This parameter is used for finding stories whose author full name contains the specified value. (optional)
+ var notAuthorName = authorName_example; // string | This parameter is used for excluding stories whose author full name contains the specified value. (optional)
+ var sourceId = new List(); // List | This parameter is used for finding stories whose source id is the specified value. (optional)
+ var notSourceId = new List(); // List | This parameter is used for excluding stories whose source id is the specified value. (optional)
+ var sourceName = new List(); // List | This parameter is used for finding stories whose source name contains the specified value. (optional)
+ var notSourceName = new List(); // List | This parameter is used for excluding stories whose source name contains the specified value. (optional)
+ var sourceDomain = new List(); // List | This parameter is used for finding stories whose source domain is the specified value. (optional)
+ var notSourceDomain = new List(); // List | This parameter is used for excluding stories whose source domain is the specified value. (optional)
+ var sourceLocationsCountry = new List(); // List | This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notSourceLocationsCountry = new List(); // List | This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var sourceLocationsState = new List(); // List | This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notSourceLocationsState = new List(); // List | This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var sourceLocationsCity = new List(); // List | This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notSourceLocationsCity = new List(); // List | This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var sourceScopesCountry = new List(); // List | This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notSourceScopesCountry = new List(); // List | This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var sourceScopesState = new List(); // List | This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notSourceScopesState = new List(); // List | This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var sourceScopesCity = new List(); // List | This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notSourceScopesCity = new List(); // List | This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var sourceScopesLevel = sourceScopesLevel_example; // List | This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var notSourceScopesLevel = sourceScopesLevel_example; // List | This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). (optional)
+ var sourceLinksInCountMin = 56; // int? | This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). (optional)
+ var sourceLinksInCountMax = 56; // int? | This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). (optional)
+ var sourceRankingsAlexaRankMin = 56; // int? | This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). (optional)
+ var sourceRankingsAlexaRankMax = 56; // int? | This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). (optional)
+ var sourceRankingsAlexaCountry = new List(); // List | This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). (optional)
+ var socialSharesCountFacebookMin = 56; // int? | This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. (optional)
+ var socialSharesCountFacebookMax = 56; // int? | This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. (optional)
+ var socialSharesCountGooglePlusMin = 56; // int? | This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. (optional)
+ var socialSharesCountGooglePlusMax = 56; // int? | This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. (optional)
+ var socialSharesCountLinkedinMin = 56; // int? | This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. (optional)
+ var socialSharesCountLinkedinMax = 56; // int? | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. (optional)
+ var socialSharesCountRedditMin = 56; // int? | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. (optional)
+ var socialSharesCountRedditMax = 56; // int? | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. (optional)
+ var clusters = new List(); // List | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). (optional)
+ var _return = _return_example; // List | This parameter is used for specifying return fields. (optional)
+ var storyId = 789; // long? | A story id (optional)
+ var storyUrl = storyUrl_example; // string | An article or webpage (optional)
+ var storyTitle = storyTitle_example; // string | Title of the article (optional)
+ var storyBody = storyBody_example; // string | Body of the article (optional)
+ var storyPublishedAt = 2013-10-20T19:20:30+01:00; // DateTime? | Publish date of the article. If you use a url or title and body of an article for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the [XML Schema specification (ISO 8601)](https://www.w3.org/TR/xmlschema-2/#dateTime). (optional)
+ var storyLanguage = storyLanguage_example; // string | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. (optional) (default to auto)
+ var perPage = 56; // int? | This parameter is used for specifying number of items in each page. (optional) (default to 3)
try
{
// List coverages
- Coverages result = apiInstance.ListCoverages(
- id: id,
- notId: notId,
- title: title,
- body: body,
- text: text,
- language: language,
- notLanguage: notLanguage,
- publishedAtStart: publishedAtStart,
- publishedAtEnd: publishedAtEnd,
- categoriesTaxonomy: categoriesTaxonomy,
- categoriesConfident: categoriesConfident,
- categoriesId: categoriesId,
- notCategoriesId: notCategoriesId,
- categoriesLevel: categoriesLevel,
- notCategoriesLevel: notCategoriesLevel,
- entitiesTitleText: entitiesTitleText,
- notEntitiesTitleText: notEntitiesTitleText,
- entitiesTitleType: entitiesTitleType,
- notEntitiesTitleType: notEntitiesTitleType,
- entitiesTitleLinksDbpedia: entitiesTitleLinksDbpedia,
- notEntitiesTitleLinksDbpedia: notEntitiesTitleLinksDbpedia,
- entitiesBodyText: entitiesBodyText,
- notEntitiesBodyText: notEntitiesBodyText,
- entitiesBodyType: entitiesBodyType,
- notEntitiesBodyType: notEntitiesBodyType,
- entitiesBodyLinksDbpedia: entitiesBodyLinksDbpedia,
- notEntitiesBodyLinksDbpedia: notEntitiesBodyLinksDbpedia,
- sentimentTitlePolarity: sentimentTitlePolarity,
- notSentimentTitlePolarity: notSentimentTitlePolarity,
- sentimentBodyPolarity: sentimentBodyPolarity,
- notSentimentBodyPolarity: notSentimentBodyPolarity,
- mediaImagesCountMin: mediaImagesCountMin,
- mediaImagesCountMax: mediaImagesCountMax,
- mediaImagesWidthMin: mediaImagesWidthMin,
- mediaImagesWidthMax: mediaImagesWidthMax,
- mediaImagesHeightMin: mediaImagesHeightMin,
- mediaImagesHeightMax: mediaImagesHeightMax,
- mediaImagesContentLengthMin: mediaImagesContentLengthMin,
- mediaImagesContentLengthMax: mediaImagesContentLengthMax,
- mediaImagesFormat: mediaImagesFormat,
- notMediaImagesFormat: notMediaImagesFormat,
- mediaVideosCountMin: mediaVideosCountMin,
- mediaVideosCountMax: mediaVideosCountMax,
- authorId: authorId,
- notAuthorId: notAuthorId,
- authorName: authorName,
- notAuthorName: notAuthorName,
- sourceId: sourceId,
- notSourceId: notSourceId,
- sourceName: sourceName,
- notSourceName: notSourceName,
- sourceDomain: sourceDomain,
- notSourceDomain: notSourceDomain,
- sourceLocationsCountry: sourceLocationsCountry,
- notSourceLocationsCountry: notSourceLocationsCountry,
- sourceLocationsState: sourceLocationsState,
- notSourceLocationsState: notSourceLocationsState,
- sourceLocationsCity: sourceLocationsCity,
- notSourceLocationsCity: notSourceLocationsCity,
- sourceScopesCountry: sourceScopesCountry,
- notSourceScopesCountry: notSourceScopesCountry,
- sourceScopesState: sourceScopesState,
- notSourceScopesState: notSourceScopesState,
- sourceScopesCity: sourceScopesCity,
- notSourceScopesCity: notSourceScopesCity,
- sourceScopesLevel: sourceScopesLevel,
- notSourceScopesLevel: notSourceScopesLevel,
- sourceLinksInCountMin: sourceLinksInCountMin,
- sourceLinksInCountMax: sourceLinksInCountMax,
- sourceRankingsAlexaRankMin: sourceRankingsAlexaRankMin,
- sourceRankingsAlexaRankMax: sourceRankingsAlexaRankMax,
- sourceRankingsAlexaCountry: sourceRankingsAlexaCountry,
- socialSharesCountFacebookMin: socialSharesCountFacebookMin,
- socialSharesCountFacebookMax: socialSharesCountFacebookMax,
- socialSharesCountGooglePlusMin: socialSharesCountGooglePlusMin,
- socialSharesCountGooglePlusMax: socialSharesCountGooglePlusMax,
- socialSharesCountLinkedinMin: socialSharesCountLinkedinMin,
- socialSharesCountLinkedinMax: socialSharesCountLinkedinMax,
- socialSharesCountRedditMin: socialSharesCountRedditMin,
- socialSharesCountRedditMax: socialSharesCountRedditMax,
- cluster: cluster,
- clusterAlgorithm: clusterAlgorithm,
- _return: _return,
- storyId: storyId,
- storyUrl: storyUrl,
- storyTitle: storyTitle,
- storyBody: storyBody,
- storyPublishedAt: storyPublishedAt,
- storyLanguage: storyLanguage,
- perPage: perPage
- );
+ Coverages result = apiInstance.ListCoverages(id, notId, title, body, text, translationsEnTitle, translationsEnBody, translationsEnText, language, notLanguage, publishedAtStart, publishedAtEnd, categoriesTaxonomy, categoriesConfident, categoriesId, notCategoriesId, categoriesLevel, notCategoriesLevel, entitiesTitleText, notEntitiesTitleText, entitiesTitleType, notEntitiesTitleType, entitiesTitleLinksDbpedia, notEntitiesTitleLinksDbpedia, entitiesBodyText, notEntitiesBodyText, entitiesBodyType, notEntitiesBodyType, entitiesBodyLinksDbpedia, notEntitiesBodyLinksDbpedia, sentimentTitlePolarity, notSentimentTitlePolarity, sentimentBodyPolarity, notSentimentBodyPolarity, mediaImagesCountMin, mediaImagesCountMax, mediaImagesWidthMin, mediaImagesWidthMax, mediaImagesHeightMin, mediaImagesHeightMax, mediaImagesContentLengthMin, mediaImagesContentLengthMax, mediaImagesFormat, notMediaImagesFormat, mediaVideosCountMin, mediaVideosCountMax, authorId, notAuthorId, authorName, notAuthorName, sourceId, notSourceId, sourceName, notSourceName, sourceDomain, notSourceDomain, sourceLocationsCountry, notSourceLocationsCountry, sourceLocationsState, notSourceLocationsState, sourceLocationsCity, notSourceLocationsCity, sourceScopesCountry, notSourceScopesCountry, sourceScopesState, notSourceScopesState, sourceScopesCity, notSourceScopesCity, sourceScopesLevel, notSourceScopesLevel, sourceLinksInCountMin, sourceLinksInCountMax, sourceRankingsAlexaRankMin, sourceRankingsAlexaRankMax, sourceRankingsAlexaCountry, socialSharesCountFacebookMin, socialSharesCountFacebookMax, socialSharesCountGooglePlusMin, socialSharesCountGooglePlusMax, socialSharesCountLinkedinMin, socialSharesCountLinkedinMax, socialSharesCountRedditMin, socialSharesCountRedditMax, clusters, _return, storyId, storyUrl, storyTitle, storyBody, storyPublishedAt, storyLanguage, perPage);
Debug.WriteLine(result);
}
- catch (Exception e)
+ catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListCoverages: " + e.Message );
+ Debug.Print("Status Code: "+ e.ErrorCode);
+ Debug.Print(e.StackTrace);
}
}
}
@@ -321,98 +367,101 @@ namespace Example
### Parameters
+
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **List<long?>**| This parameter is used for finding stories by story id. | [optional]
- **notId** | **List<long?>**| This parameter is used for excluding stories by story id. | [optional]
- **title** | **string**| This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
- **body** | **string**| This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
- **text** | **string**| This parameter is used for finding stories whose title or body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
- **language** | **List<string>**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
- **notLanguage** | **List<string>**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [enum: en, de, fr, it, es, pt]
- **publishedAtStart** | **string**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
- **publishedAtEnd** | **string**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
- **categoriesTaxonomy** | **string**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [enum: iab-qag, iptc-subjectcode]
- **categoriesConfident** | **bool?**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
- **categoriesId** | **List<string>**| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
- **notCategoriesId** | **List<string>**| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
- **categoriesLevel** | **List<int?>**| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
- **notCategoriesLevel** | **List<int?>**| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
- **entitiesTitleText** | **List<string>**| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **notEntitiesTitleText** | **List<string>**| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **entitiesTitleType** | **List<string>**| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **notEntitiesTitleType** | **List<string>**| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **entitiesTitleLinksDbpedia** | **List<string>**| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **notEntitiesTitleLinksDbpedia** | **List<string>**| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **entitiesBodyText** | **List<string>**| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **notEntitiesBodyText** | **List<string>**| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **entitiesBodyType** | **List<string>**| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **notEntitiesBodyType** | **List<string>**| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **entitiesBodyLinksDbpedia** | **List<string>**| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **notEntitiesBodyLinksDbpedia** | **List<string>**| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
- **sentimentTitlePolarity** | **string**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
- **notSentimentTitlePolarity** | **string**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
- **sentimentBodyPolarity** | **string**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
- **notSentimentBodyPolarity** | **string**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional] [enum: positive, neutral, negative]
- **mediaImagesCountMin** | **int?**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
- **mediaImagesCountMax** | **int?**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
- **mediaImagesWidthMin** | **int?**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
- **mediaImagesWidthMax** | **int?**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
- **mediaImagesHeightMin** | **int?**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
- **mediaImagesHeightMax** | **int?**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
- **mediaImagesContentLengthMin** | **int?**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
- **mediaImagesContentLengthMax** | **int?**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
- **mediaImagesFormat** | **List<string>**| This parameter is used for finding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
- **notMediaImagesFormat** | **List<string>**| This parameter is used for excluding stories whose images format are the specified value. | [optional] [enum: BMP, GIF, JPEG, PNG, TIFF, PSD, ICO, CUR, WEBP, SVG]
- **mediaVideosCountMin** | **int?**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
- **mediaVideosCountMax** | **int?**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
- **authorId** | **List<int?>**| This parameter is used for finding stories whose author id is the specified value. | [optional]
- **notAuthorId** | **List<int?>**| This parameter is used for excluding stories whose author id is the specified value. | [optional]
- **authorName** | **string**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
- **notAuthorName** | **string**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
- **sourceId** | **List<int?>**| This parameter is used for finding stories whose source id is the specified value. | [optional]
- **notSourceId** | **List<int?>**| This parameter is used for excluding stories whose source id is the specified value. | [optional]
- **sourceName** | **List<string>**| This parameter is used for finding stories whose source name contains the specified value. | [optional]
- **notSourceName** | **List<string>**| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
- **sourceDomain** | **List<string>**| This parameter is used for finding stories whose source domain is the specified value. | [optional]
- **notSourceDomain** | **List<string>**| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
- **sourceLocationsCountry** | **List<string>**| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **notSourceLocationsCountry** | **List<string>**| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **sourceLocationsState** | **List<string>**| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **notSourceLocationsState** | **List<string>**| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **sourceLocationsCity** | **List<string>**| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **notSourceLocationsCity** | **List<string>**| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **sourceScopesCountry** | **List<string>**| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **notSourceScopesCountry** | **List<string>**| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **sourceScopesState** | **List<string>**| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **notSourceScopesState** | **List<string>**| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **sourceScopesCity** | **List<string>**| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **notSourceScopesCity** | **List<string>**| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
- **sourceScopesLevel** | **List<string>**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
- **notSourceScopesLevel** | **List<string>**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional] [enum: international, national, local]
- **sourceLinksInCountMin** | **int?**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
- **sourceLinksInCountMax** | **int?**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
- **sourceRankingsAlexaRankMin** | **int?**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
- **sourceRankingsAlexaRankMax** | **int?**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
- **sourceRankingsAlexaCountry** | **List<string>**| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
- **socialSharesCountFacebookMin** | **int?**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
- **socialSharesCountFacebookMax** | **int?**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
- **socialSharesCountGooglePlusMin** | **int?**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
- **socialSharesCountGooglePlusMax** | **int?**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
- **socialSharesCountLinkedinMin** | **int?**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
- **socialSharesCountLinkedinMax** | **int?**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
- **socialSharesCountRedditMin** | **int?**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
- **socialSharesCountRedditMax** | **int?**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
- **cluster** | **bool?**| This parameter enables clustering for the returned stories. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to false]
- **clusterAlgorithm** | **string**| This parameter is used for specifying the clustering algorithm you wish to use. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms. You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional] [default to lingo] [enum: stc, lingo, kmeans]
- **_return** | **List<string>**| This parameter is used for specifying return fields. | [optional] [enum: id, title, body, summary, source, author, entities, keywords, hashtags, characters_count, words_count, sentences_count, paragraphs_count, categories, social_shares_count, media, sentiment, language, published_at, links]
+ **id** | [**List<long>**](long.md)| This parameter is used for finding stories by story id. | [optional]
+ **notId** | [**List<long>**](long.md)| This parameter is used for excluding stories by story id. | [optional]
+ **title** | **string**| This parameter is used for finding stories whose title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
+ **body** | **string**| This parameter is used for finding stories whose body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
+ **text** | **string**| This parameter is used for finding stories whose title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
+ **translationsEnTitle** | **string**| This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
+ **translationsEnBody** | **string**| This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
+ **translationsEnText** | **string**| This parameter is used for finding stories whose translation title or body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators). | [optional]
+ **language** | **List<string>**| This parameter is used for finding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
+ **notLanguage** | **List<string>**| This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional]
+ **publishedAtStart** | **string**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **publishedAtEnd** | **string**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional]
+ **categoriesTaxonomy** | **string**| This parameter is used for defining the type of the taxonomy for the rest of the categories queries. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
+ **categoriesConfident** | **bool?**| This parameter is used for finding stories whose categories are confident. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional] [default to true]
+ **categoriesId** | [**List<string>**](string.md)| This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
+ **notCategoriesId** | [**List<string>**](string.md)| This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
+ **categoriesLevel** | [**List<int>**](int.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
+ **notCategoriesLevel** | [**List<int>**](int.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
+ **entitiesTitleText** | [**List<string>**](string.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **notEntitiesTitleText** | [**List<string>**](string.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **entitiesTitleType** | [**List<string>**](string.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **notEntitiesTitleType** | [**List<string>**](string.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **entitiesTitleLinksDbpedia** | [**List<string>**](string.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **notEntitiesTitleLinksDbpedia** | [**List<string>**](string.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **entitiesBodyText** | [**List<string>**](string.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **notEntitiesBodyText** | [**List<string>**](string.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **entitiesBodyType** | [**List<string>**](string.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **notEntitiesBodyType** | [**List<string>**](string.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **entitiesBodyLinksDbpedia** | [**List<string>**](string.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **notEntitiesBodyLinksDbpedia** | [**List<string>**](string.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
+ **sentimentTitlePolarity** | **string**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
+ **notSentimentTitlePolarity** | **string**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
+ **sentimentBodyPolarity** | **string**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
+ **notSentimentBodyPolarity** | **string**| This parameter is used for excluding stories whose body sentiment is the specified value. | [optional]
+ **mediaImagesCountMin** | **int?**| This parameter is used for finding stories whose number of images is greater than or equal to the specified value. | [optional]
+ **mediaImagesCountMax** | **int?**| This parameter is used for finding stories whose number of images is less than or equal to the specified value. | [optional]
+ **mediaImagesWidthMin** | **int?**| This parameter is used for finding stories whose width of images are greater than or equal to the specified value. | [optional]
+ **mediaImagesWidthMax** | **int?**| This parameter is used for finding stories whose width of images are less than or equal to the specified value. | [optional]
+ **mediaImagesHeightMin** | **int?**| This parameter is used for finding stories whose height of images are greater than or equal to the specified value. | [optional]
+ **mediaImagesHeightMax** | **int?**| This parameter is used for finding stories whose height of images are less than or equal to the specified value. | [optional]
+ **mediaImagesContentLengthMin** | **int?**| This parameter is used for finding stories whose images content length are greater than or equal to the specified value. | [optional]
+ **mediaImagesContentLengthMax** | **int?**| This parameter is used for finding stories whose images content length are less than or equal to the specified value. | [optional]
+ **mediaImagesFormat** | **List<string>**| This parameter is used for finding stories whose images format are the specified value. | [optional]
+ **notMediaImagesFormat** | **List<string>**| This parameter is used for excluding stories whose images format are the specified value. | [optional]
+ **mediaVideosCountMin** | **int?**| This parameter is used for finding stories whose number of videos is greater than or equal to the specified value. | [optional]
+ **mediaVideosCountMax** | **int?**| This parameter is used for finding stories whose number of videos is less than or equal to the specified value. | [optional]
+ **authorId** | [**List<int>**](int.md)| This parameter is used for finding stories whose author id is the specified value. | [optional]
+ **notAuthorId** | [**List<int>**](int.md)| This parameter is used for excluding stories whose author id is the specified value. | [optional]
+ **authorName** | **string**| This parameter is used for finding stories whose author full name contains the specified value. | [optional]
+ **notAuthorName** | **string**| This parameter is used for excluding stories whose author full name contains the specified value. | [optional]
+ **sourceId** | [**List<int>**](int.md)| This parameter is used for finding stories whose source id is the specified value. | [optional]
+ **notSourceId** | [**List<int>**](int.md)| This parameter is used for excluding stories whose source id is the specified value. | [optional]
+ **sourceName** | [**List<string>**](string.md)| This parameter is used for finding stories whose source name contains the specified value. | [optional]
+ **notSourceName** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source name contains the specified value. | [optional]
+ **sourceDomain** | [**List<string>**](string.md)| This parameter is used for finding stories whose source domain is the specified value. | [optional]
+ **notSourceDomain** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source domain is the specified value. | [optional]
+ **sourceLocationsCountry** | [**List<string>**](string.md)| This parameter is used for finding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notSourceLocationsCountry** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **sourceLocationsState** | [**List<string>**](string.md)| This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notSourceLocationsState** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **sourceLocationsCity** | [**List<string>**](string.md)| This parameter is used for finding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notSourceLocationsCity** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source city is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **sourceScopesCountry** | [**List<string>**](string.md)| This parameter is used for finding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notSourceScopesCountry** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source scopes is the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **sourceScopesState** | [**List<string>**](string.md)| This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notSourceScopesState** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **sourceScopesCity** | [**List<string>**](string.md)| This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notSourceScopesCity** | [**List<string>**](string.md)| This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **sourceScopesLevel** | **List<string>**| This parameter is used for finding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **notSourceScopesLevel** | **List<string>**| This parameter is used for excluding stories whose source scopes is the specified level value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations). | [optional]
+ **sourceLinksInCountMin** | **int?**| This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
+ **sourceLinksInCountMax** | **int?**| This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count). | [optional]
+ **sourceRankingsAlexaRankMin** | **int?**| This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
+ **sourceRankingsAlexaRankMax** | **int?**| This parameter is used for finding stories from sources whose Alexa rank is less than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
+ **sourceRankingsAlexaCountry** | [**List<string>**](string.md)| This parameter is used for finding stories from sources whose Alexa rank is in the specified country value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks). | [optional]
+ **socialSharesCountFacebookMin** | **int?**| This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value. | [optional]
+ **socialSharesCountFacebookMax** | **int?**| This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value. | [optional]
+ **socialSharesCountGooglePlusMin** | **int?**| This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value. | [optional]
+ **socialSharesCountGooglePlusMax** | **int?**| This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value. | [optional]
+ **socialSharesCountLinkedinMin** | **int?**| This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value. | [optional]
+ **socialSharesCountLinkedinMax** | **int?**| This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value. | [optional]
+ **socialSharesCountRedditMin** | **int?**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
+ **socialSharesCountRedditMax** | **int?**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
+ **clusters** | [**List<string>**](string.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
+ **_return** | **List<string>**| This parameter is used for specifying return fields. | [optional]
**storyId** | **long?**| A story id | [optional]
**storyUrl** | **string**| An article or webpage | [optional]
**storyTitle** | **string**| Title of the article | [optional]
**storyBody** | **string**| Body of the article | [optional]
- **storyPublishedAt** | **DateTime?**| Publish date of the article. If you use a url or title and body of an article for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the [XML Schema specification (ISO 8601)](https://www.w3.org/TR/xmlschema-2/#dateTime). | [optional]
- **storyLanguage** | **string**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto] [enum: auto, en, de, fr, it, es, pt]
- **perPage** | **int?**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
+ **storyPublishedAt** | **DateTime?**| Publish date of the article. If you use a url or title and body of an article for getting coverages, this parameter is required. The format used is a restricted form of the canonical representation of dateTime in the [XML Schema specification (ISO 8601)](https://www.w3.org/TR/xmlschema-2/#dateTime). | [optional]
+ **storyLanguage** | **string**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to auto]
+ **perPage** | **int?**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
### Return type
@@ -420,26 +469,41 @@ Name | Type | Description | Notes
### Authorization
-[app_key](../README.md#app_key), [app_id](../README.md#app_id)
+[app_id](../README.md#app_id), [app_key](../README.md#app_key)
### HTTP request headers
- - **Content-Type**: application/x-www-form-urlencoded
- - **Accept**: application/json, text/xml
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | An object including an array of coverages | * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
|
+| **401** | Unauthorized | - |
+| **404** | Not Found | - |
+| **422** | Unprocessable Entity | - |
+| **492** | Too Many Requests | * X-RateLimit-Limit - The number of allowed requests in the current period.
* X-RateLimit-Remaining - The number of remaining requests in the current period.
* X-RateLimit-Reset - The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
|
+| **500** | Internal Server Error | - |
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
-
-# **ListHistograms**
-> Histograms ListHistograms (List id = null, List notId = null, string title = null, string body = null, string text = null, List language = null, List notLanguage = null, string publishedAtStart = null, string publishedAtEnd = null, string categoriesTaxonomy = null, bool? categoriesConfident = null, List categoriesId = null, List notCategoriesId = null, List categoriesLevel = null, List notCategoriesLevel = null, List entitiesTitleText = null, List notEntitiesTitleText = null, List entitiesTitleType = null, List notEntitiesTitleType = null, List entitiesTitleLinksDbpedia = null, List