aylien_news_api 0.4.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +1 -1
  4. data/Rakefile +8 -0
  5. data/aylien_news_api.gemspec +17 -13
  6. data/docs/DefaultApi.md +897 -611
  7. data/docs/StoryLinks.md +1 -0
  8. data/lib/aylien_news_api.rb +15 -13
  9. data/lib/aylien_news_api/api/default_api.rb +861 -344
  10. data/lib/aylien_news_api/api_client.rb +18 -15
  11. data/lib/aylien_news_api/api_error.rb +22 -18
  12. data/lib/aylien_news_api/configuration.rb +15 -13
  13. data/lib/aylien_news_api/models/author.rb +15 -13
  14. data/lib/aylien_news_api/models/autocomplete.rb +15 -13
  15. data/lib/aylien_news_api/models/autocompletes.rb +15 -13
  16. data/lib/aylien_news_api/models/category.rb +15 -13
  17. data/lib/aylien_news_api/models/category_links.rb +15 -13
  18. data/lib/aylien_news_api/models/coverages.rb +15 -13
  19. data/lib/aylien_news_api/models/entities.rb +15 -13
  20. data/lib/aylien_news_api/models/entity.rb +25 -23
  21. data/lib/aylien_news_api/models/entity_links.rb +15 -13
  22. data/lib/aylien_news_api/models/error.rb +15 -13
  23. data/lib/aylien_news_api/models/error_links.rb +15 -13
  24. data/lib/aylien_news_api/models/errors.rb +15 -13
  25. data/lib/aylien_news_api/models/histogram_interval.rb +15 -13
  26. data/lib/aylien_news_api/models/histograms.rb +15 -13
  27. data/lib/aylien_news_api/models/location.rb +15 -13
  28. data/lib/aylien_news_api/models/media.rb +15 -13
  29. data/lib/aylien_news_api/models/rank.rb +15 -13
  30. data/lib/aylien_news_api/models/rankings.rb +15 -13
  31. data/lib/aylien_news_api/models/related_stories.rb +15 -13
  32. data/lib/aylien_news_api/models/scope.rb +15 -13
  33. data/lib/aylien_news_api/models/sentiment.rb +25 -23
  34. data/lib/aylien_news_api/models/sentiments.rb +15 -13
  35. data/lib/aylien_news_api/models/share_count.rb +15 -13
  36. data/lib/aylien_news_api/models/share_counts.rb +15 -13
  37. data/lib/aylien_news_api/models/source.rb +15 -13
  38. data/lib/aylien_news_api/models/stories.rb +15 -13
  39. data/lib/aylien_news_api/models/story.rb +15 -13
  40. data/lib/aylien_news_api/models/story_cluster.rb +15 -13
  41. data/lib/aylien_news_api/models/story_links.rb +29 -17
  42. data/lib/aylien_news_api/models/summary.rb +15 -13
  43. data/lib/aylien_news_api/models/time_series.rb +15 -13
  44. data/lib/aylien_news_api/models/time_series_list.rb +15 -13
  45. data/lib/aylien_news_api/models/trend.rb +15 -13
  46. data/lib/aylien_news_api/models/trends.rb +15 -13
  47. data/lib/aylien_news_api/version.rb +16 -14
  48. data/spec/api/default_api_spec.rb +463 -189
  49. data/spec/api_client_spec.rb +25 -101
  50. data/spec/configuration_spec.rb +26 -19
  51. data/spec/models/author_spec.rb +19 -29
  52. data/spec/models/autocomplete_spec.rb +18 -24
  53. data/spec/models/autocompletes_spec.rb +17 -19
  54. data/spec/models/category_links_spec.rb +18 -24
  55. data/spec/models/category_spec.rb +26 -44
  56. data/spec/models/coverages_spec.rb +27 -39
  57. data/spec/models/entities_spec.rb +18 -24
  58. data/spec/models/entity_links_spec.rb +17 -19
  59. data/spec/models/entity_spec.rb +21 -39
  60. data/spec/models/error_links_spec.rb +17 -19
  61. data/spec/models/error_spec.rb +22 -44
  62. data/spec/models/errors_spec.rb +17 -19
  63. data/spec/models/histogram_interval_spec.rb +18 -24
  64. data/spec/models/histograms_spec.rb +21 -39
  65. data/spec/models/location_spec.rb +19 -29
  66. data/spec/models/media_spec.rb +50 -24
  67. data/spec/models/rank_spec.rb +15 -13
  68. data/spec/models/rankings_spec.rb +15 -13
  69. data/spec/models/related_stories_spec.rb +26 -34
  70. data/spec/models/scope_spec.rb +24 -34
  71. data/spec/models/sentiment_spec.rb +22 -24
  72. data/spec/models/sentiments_spec.rb +18 -24
  73. data/spec/models/share_count_spec.rb +18 -24
  74. data/spec/models/share_counts_spec.rb +20 -34
  75. data/spec/models/source_spec.rb +52 -44
  76. data/spec/models/stories_spec.rb +19 -29
  77. data/spec/models/story_cluster_spec.rb +21 -39
  78. data/spec/models/story_links_spec.rb +25 -29
  79. data/spec/models/story_spec.rb +36 -114
  80. data/spec/models/summary_spec.rb +17 -19
  81. data/spec/models/time_series_list_spec.rb +20 -34
  82. data/spec/models/time_series_spec.rb +18 -24
  83. data/spec/models/trend_spec.rb +18 -24
  84. data/spec/models/trends_spec.rb +18 -24
  85. data/spec/spec_helper.rb +15 -13
  86. metadata +25 -8
  87. data/Gemfile.lock +0 -65
  88. data/LICENSE +0 -13
  89. data/aylien_news_api-0.2.0.gem +0 -0
  90. data/aylien_news_api-0.3.0.gem +0 -0
data/spec/api/default_api_spec.rb CHANGED
@@ -1,16 +1,18 @@
1
- # Copyright 2016 Aylien, Inc. All Rights Reserved.
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # http://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
1
+ =begin
2
+ Copyright 2017 Aylien, Inc. All Rights Reserved.
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ =end
14
16
 
15
17
  require 'spec_helper'
16
18
  require 'json'
@@ -28,7 +30,7 @@ describe 'DefaultApi' do
28
30
 
29
31
  describe 'test an instance of DefaultApi' do
30
32
  it 'should create an instact of DefaultApi' do
31
- @instance.should be_a(AylienNewsApi::DefaultApi)
33
+ expect(@instance).to be_instance_of(AylienNewsApi::DefaultApi)
32
34
  end
33
35
  end
34
36
 
@@ -36,109 +38,202 @@ describe 'DefaultApi' do
36
38
  # List autocompletes
37
39
  # This endpoint is used for getting list of autocompletes by providing a specific term and type.
38
40
  # @param type This parameter is used for defining the type of autocompletes.
39
- # @param term This parameter is used for finding autocomplete objects whose contains the specified value.
41
+ # @param term This parameter is used for finding autocomplete objects that contain the specified value.
40
42
  # @param [Hash] opts the optional parameters
41
43
  # @option opts [String] :language 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.
42
- # @option opts [Integer] :per_page This parameter is used for specifying number of the items in each page.
44
+ # @option opts [Integer] :per_page This parameter is used for specifying number of items in each page.
43
45
  # @return [Autocompletes]
44
46
  describe 'list_autocompletes test' do
45
47
  it "should work" do
46
- # assertion here
47
- # should be_a()
48
- # should be_nil
49
- # should ==
50
- # should_not ==
48
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
51
49
  end
52
50
  end
53
51
 
54
52
  # unit tests for list_coverages
55
53
  # List coverages
56
- # This endpoint is used for finding story coverages based on provided parameters. The number of coverages to return, up to a maximum of 100.
54
+ # This endpoint is used for finding story coverages based on the parameters provided. The maximum number of related stories returned is 100.
57
55
  # @param [Hash] opts the optional parameters
58
- # @option opts [Array<Integer>] :id This parameter is used for finding stroies by story id.
56
+ # @option opts [Array<Integer>] :id This parameter is used for finding stories by story id.
57
+ # @option opts [Array<Integer>] :not_id This parameter is used for excluding stories by story id.
59
58
  # @option opts [String] :title This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
60
59
  # @option opts [String] :body This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
61
60
  # @option opts [String] :text 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).
62
61
  # @option opts [Array<String>] :language 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.
63
- # @option opts [String] :published_at_start This parameter is used for finding stories whose published at 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).
64
- # @option opts [String] :published_at_end This parameter is used for finding stories whose published at 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).
65
- # @option opts [String] :categories_taxonomy This parameter is used for defining type of the taxonomy for the rest of categories queries.
66
- # @option opts [BOOLEAN] :categories_confident This parameter is used for finding stories whose categories are confident.
67
- # @option opts [Array<String>] :categories_id This parameter is used for finding stories whose categories id is the specified value.
68
- # @option opts [Array<Integer>] :categories_level This parameter is used for finding stories whose categories level is the specified value.
69
- # @option opts [Array<String>] :entities_title_text This parameter is used for finding stories whose entities text in title is the specified value.
70
- # @option opts [Array<String>] :entities_title_type This parameter is used for finding stories whose entities type in title is the specified value.
71
- # @option opts [Array<String>] :entities_title_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
72
- # @option opts [Array<String>] :entities_body_text This parameter is used for finding stories whose entities text in body is the specified value.
73
- # @option opts [Array<String>] :entities_body_type This parameter is used for finding stories whose entities type in body is the specified value.
74
- # @option opts [Array<String>] :entities_body_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
62
+ # @option opts [Array<String>] :not_language 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.
63
+ # @option opts [String] :published_at_start 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).
64
+ # @option opts [String] :published_at_end 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).
65
+ # @option opts [String] :categories_taxonomy 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).
66
+ # @option opts [BOOLEAN] :categories_confident 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).
67
+ # @option opts [Array<String>] :categories_id 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).
68
+ # @option opts [Array<String>] :not_categories_id 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).
69
+ # @option opts [Array<Integer>] :categories_level 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).
70
+ # @option opts [Array<Integer>] :not_categories_level 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).
71
+ # @option opts [Array<String>] :entities_title_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
72
+ # @option opts [Array<String>] :not_entities_title_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
73
+ # @option opts [Array<String>] :entities_title_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
74
+ # @option opts [Array<String>] :not_entities_title_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
75
+ # @option opts [Array<String>] :entities_title_links_dbpedia 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).
76
+ # @option opts [Array<String>] :not_entities_title_links_dbpedia 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).
77
+ # @option opts [Array<String>] :entities_body_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
78
+ # @option opts [Array<String>] :not_entities_body_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
79
+ # @option opts [Array<String>] :entities_body_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
80
+ # @option opts [Array<String>] :not_entities_body_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
81
+ # @option opts [Array<String>] :entities_body_links_dbpedia 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).
82
+ # @option opts [Array<String>] :not_entities_body_links_dbpedia 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).
75
83
  # @option opts [String] :sentiment_title_polarity This parameter is used for finding stories whose title sentiment is the specified value.
84
+ # @option opts [String] :not_sentiment_title_polarity This parameter is used for excluding stories whose title sentiment is the specified value.
76
85
  # @option opts [String] :sentiment_body_polarity This parameter is used for finding stories whose body sentiment is the specified value.
86
+ # @option opts [String] :not_sentiment_body_polarity This parameter is used for excluding stories whose body sentiment is the specified value.
87
+ # @option opts [Integer] :media_images_count_min This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
88
+ # @option opts [Integer] :media_images_count_max This parameter is used for finding stories whose number of images is less than or equal to the specified value.
89
+ # @option opts [Integer] :media_images_width_min This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
90
+ # @option opts [Integer] :media_images_width_max This parameter is used for finding stories whose width of images are less than or equal to the specified value.
91
+ # @option opts [Integer] :media_images_height_min This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
92
+ # @option opts [Integer] :media_images_height_max This parameter is used for finding stories whose height of images are less than or equal to the specified value.
93
+ # @option opts [Integer] :media_images_content_length_min This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
94
+ # @option opts [Integer] :media_images_content_length_max This parameter is used for finding stories whose images content length are less than or equal to the specified value.
95
+ # @option opts [Array<String>] :media_images_format This parameter is used for finding stories whose images format are the specified value.
96
+ # @option opts [Array<String>] :not_media_images_format This parameter is used for excluding stories whose images format are the specified value.
97
+ # @option opts [Integer] :media_videos_count_min This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
98
+ # @option opts [Integer] :media_videos_count_max This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
77
99
  # @option opts [Array<Integer>] :author_id This parameter is used for finding stories whose author id is the specified value.
100
+ # @option opts [Array<Integer>] :not_author_id This parameter is used for excluding stories whose author id is the specified value.
78
101
  # @option opts [String] :author_name This parameter is used for finding stories whose author full name contains the specified value.
102
+ # @option opts [String] :not_author_name This parameter is used for excluding stories whose author full name contains the specified value.
79
103
  # @option opts [Array<Integer>] :source_id This parameter is used for finding stories whose source id is the specified value.
104
+ # @option opts [Array<Integer>] :not_source_id This parameter is used for excluding stories whose source id is the specified value.
80
105
  # @option opts [Array<String>] :source_name This parameter is used for finding stories whose source name contains the specified value.
106
+ # @option opts [Array<String>] :not_source_name This parameter is used for excluding stories whose source name contains the specified value.
81
107
  # @option opts [Array<String>] :source_domain This parameter is used for finding stories whose source domain is the specified value.
82
- # @option opts [Array<String>] :source_locations_country 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.
83
- # @option opts [Array<String>] :source_locations_state This parameter is used for finding stories whose source state/province is the specified value.
84
- # @option opts [Array<String>] :source_locations_city This parameter is used for finding stories whose source city is the specified value.
85
- # @option opts [Array<String>] :source_scopes_country This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
86
- # @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes state/province is the specified value.
87
- # @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes city is the specified value.
88
- # @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes level is the specified value.
108
+ # @option opts [Array<String>] :not_source_domain This parameter is used for excluding stories whose source domain is the specified value.
109
+ # @option opts [Array<String>] :source_locations_country 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).
110
+ # @option opts [Array<String>] :not_source_locations_country 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).
111
+ # @option opts [Array<String>] :source_locations_state 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).
112
+ # @option opts [Array<String>] :not_source_locations_state 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).
113
+ # @option opts [Array<String>] :source_locations_city 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).
114
+ # @option opts [Array<String>] :not_source_locations_city 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).
115
+ # @option opts [Array<String>] :source_scopes_country 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).
116
+ # @option opts [Array<String>] :not_source_scopes_country 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).
117
+ # @option opts [Array<String>] :source_scopes_state 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).
118
+ # @option opts [Array<String>] :not_source_scopes_state 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).
119
+ # @option opts [Array<String>] :source_scopes_city 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).
120
+ # @option opts [Array<String>] :not_source_scopes_city 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).
121
+ # @option opts [Array<String>] :source_scopes_level 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).
122
+ # @option opts [Array<String>] :not_source_scopes_level 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).
123
+ # @option opts [Integer] :source_links_in_count_min 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).
124
+ # @option opts [Integer] :source_links_in_count_max 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).
125
+ # @option opts [Integer] :source_rankings_alexa_rank_min 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).
126
+ # @option opts [Integer] :source_rankings_alexa_rank_max 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).
127
+ # @option opts [Array<String>] :source_rankings_alexa_country 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).
128
+ # @option opts [Integer] :social_shares_count_facebook_min This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
129
+ # @option opts [Integer] :social_shares_count_facebook_max This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
130
+ # @option opts [Integer] :social_shares_count_google_plus_min This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
131
+ # @option opts [Integer] :social_shares_count_google_plus_max This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
132
+ # @option opts [Integer] :social_shares_count_linkedin_min This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
133
+ # @option opts [Integer] :social_shares_count_linkedin_max This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
134
+ # @option opts [Integer] :social_shares_count_reddit_min This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
135
+ # @option opts [Integer] :social_shares_count_reddit_max This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
136
+ # @option opts [BOOLEAN] :cluster 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).
137
+ # @option opts [String] :cluster_algorithm 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).
138
+ # @option opts [Array<String>] :_return This parameter is used for specifying return fields.
89
139
  # @option opts [Integer] :story_id A story id
90
140
  # @option opts [String] :story_url An article or webpage
91
141
  # @option opts [String] :story_title Title of the article
92
142
  # @option opts [String] :story_body Body of the article
93
- # @option opts [DateTime] :story_published_at Publish date of the article. If you use url or title and body 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).
94
- # @option opts [String] :story_language This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
95
- # @option opts [Integer] :per_page This parameter is used for specifying number of the items in each page.
143
+ # @option opts [DateTime] :story_published_at 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).
144
+ # @option opts [String] :story_language 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.
145
+ # @option opts [Integer] :per_page This parameter is used for specifying number of items in each page.
96
146
  # @return [Coverages]
97
147
  describe 'list_coverages test' do
98
148
  it "should work" do
99
- # assertion here
100
- # should be_a()
101
- # should be_nil
102
- # should ==
103
- # should_not ==
149
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
104
150
  end
105
151
  end
106
152
 
107
153
  # unit tests for list_histograms
108
154
  # List histograms
109
- # This endpoint is used for getting histograms based on the field parameter is passed.
155
+ # This endpoint is used for getting histograms based on the &#x60;field&#x60; parameter passed to the API.
110
156
  # @param [Hash] opts the optional parameters
111
- # @option opts [Array<Integer>] :id This parameter is used for finding stroies by story id.
157
+ # @option opts [Array<Integer>] :id This parameter is used for finding stories by story id.
158
+ # @option opts [Array<Integer>] :not_id This parameter is used for excluding stories by story id.
112
159
  # @option opts [String] :title This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
113
160
  # @option opts [String] :body This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
114
161
  # @option opts [String] :text 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).
115
162
  # @option opts [Array<String>] :language 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.
116
- # @option opts [String] :published_at_start This parameter is used for finding stories whose published at 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).
117
- # @option opts [String] :published_at_end This parameter is used for finding stories whose published at 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).
118
- # @option opts [String] :categories_taxonomy This parameter is used for defining type of the taxonomy for the rest of categories queries.
119
- # @option opts [BOOLEAN] :categories_confident This parameter is used for finding stories whose categories are confident.
120
- # @option opts [Array<String>] :categories_id This parameter is used for finding stories whose categories id is the specified value.
121
- # @option opts [Array<Integer>] :categories_level This parameter is used for finding stories whose categories level is the specified value.
122
- # @option opts [Array<String>] :entities_title_text This parameter is used for finding stories whose entities text in title is the specified value.
123
- # @option opts [Array<String>] :entities_title_type This parameter is used for finding stories whose entities type in title is the specified value.
124
- # @option opts [Array<String>] :entities_title_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
125
- # @option opts [Array<String>] :entities_body_text This parameter is used for finding stories whose entities text in body is the specified value.
126
- # @option opts [Array<String>] :entities_body_type This parameter is used for finding stories whose entities type in body is the specified value.
127
- # @option opts [Array<String>] :entities_body_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
163
+ # @option opts [Array<String>] :not_language 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.
164
+ # @option opts [String] :published_at_start 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).
165
+ # @option opts [String] :published_at_end 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).
166
+ # @option opts [String] :categories_taxonomy 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).
167
+ # @option opts [BOOLEAN] :categories_confident 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).
168
+ # @option opts [Array<String>] :categories_id 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).
169
+ # @option opts [Array<String>] :not_categories_id 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).
170
+ # @option opts [Array<Integer>] :categories_level 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).
171
+ # @option opts [Array<Integer>] :not_categories_level 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).
172
+ # @option opts [Array<String>] :entities_title_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
173
+ # @option opts [Array<String>] :not_entities_title_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
174
+ # @option opts [Array<String>] :entities_title_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
175
+ # @option opts [Array<String>] :not_entities_title_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
176
+ # @option opts [Array<String>] :entities_title_links_dbpedia 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).
177
+ # @option opts [Array<String>] :not_entities_title_links_dbpedia 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).
178
+ # @option opts [Array<String>] :entities_body_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
179
+ # @option opts [Array<String>] :not_entities_body_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
180
+ # @option opts [Array<String>] :entities_body_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
181
+ # @option opts [Array<String>] :not_entities_body_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
182
+ # @option opts [Array<String>] :entities_body_links_dbpedia 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).
183
+ # @option opts [Array<String>] :not_entities_body_links_dbpedia 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).
128
184
  # @option opts [String] :sentiment_title_polarity This parameter is used for finding stories whose title sentiment is the specified value.
185
+ # @option opts [String] :not_sentiment_title_polarity This parameter is used for excluding stories whose title sentiment is the specified value.
129
186
  # @option opts [String] :sentiment_body_polarity This parameter is used for finding stories whose body sentiment is the specified value.
187
+ # @option opts [String] :not_sentiment_body_polarity This parameter is used for excluding stories whose body sentiment is the specified value.
188
+ # @option opts [Integer] :media_images_count_min This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
189
+ # @option opts [Integer] :media_images_count_max This parameter is used for finding stories whose number of images is less than or equal to the specified value.
190
+ # @option opts [Integer] :media_images_width_min This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
191
+ # @option opts [Integer] :media_images_width_max This parameter is used for finding stories whose width of images are less than or equal to the specified value.
192
+ # @option opts [Integer] :media_images_height_min This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
193
+ # @option opts [Integer] :media_images_height_max This parameter is used for finding stories whose height of images are less than or equal to the specified value.
194
+ # @option opts [Integer] :media_images_content_length_min This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
195
+ # @option opts [Integer] :media_images_content_length_max This parameter is used for finding stories whose images content length are less than or equal to the specified value.
196
+ # @option opts [Array<String>] :media_images_format This parameter is used for finding stories whose images format are the specified value.
197
+ # @option opts [Array<String>] :not_media_images_format This parameter is used for excluding stories whose images format are the specified value.
198
+ # @option opts [Integer] :media_videos_count_min This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
199
+ # @option opts [Integer] :media_videos_count_max This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
130
200
  # @option opts [Array<Integer>] :author_id This parameter is used for finding stories whose author id is the specified value.
201
+ # @option opts [Array<Integer>] :not_author_id This parameter is used for excluding stories whose author id is the specified value.
131
202
  # @option opts [String] :author_name This parameter is used for finding stories whose author full name contains the specified value.
203
+ # @option opts [String] :not_author_name This parameter is used for excluding stories whose author full name contains the specified value.
132
204
  # @option opts [Array<Integer>] :source_id This parameter is used for finding stories whose source id is the specified value.
205
+ # @option opts [Array<Integer>] :not_source_id This parameter is used for excluding stories whose source id is the specified value.
133
206
  # @option opts [Array<String>] :source_name This parameter is used for finding stories whose source name contains the specified value.
207
+ # @option opts [Array<String>] :not_source_name This parameter is used for excluding stories whose source name contains the specified value.
134
208
  # @option opts [Array<String>] :source_domain This parameter is used for finding stories whose source domain is the specified value.
135
- # @option opts [Array<String>] :source_locations_country 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.
136
- # @option opts [Array<String>] :source_locations_state This parameter is used for finding stories whose source state/province is the specified value.
137
- # @option opts [Array<String>] :source_locations_city This parameter is used for finding stories whose source city is the specified value.
138
- # @option opts [Array<String>] :source_scopes_country This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
139
- # @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes state/province is the specified value.
140
- # @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes city is the specified value.
141
- # @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes level is the specified value.
209
+ # @option opts [Array<String>] :not_source_domain This parameter is used for excluding stories whose source domain is the specified value.
210
+ # @option opts [Array<String>] :source_locations_country 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).
211
+ # @option opts [Array<String>] :not_source_locations_country 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).
212
+ # @option opts [Array<String>] :source_locations_state 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).
213
+ # @option opts [Array<String>] :not_source_locations_state 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).
214
+ # @option opts [Array<String>] :source_locations_city 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).
215
+ # @option opts [Array<String>] :not_source_locations_city 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).
216
+ # @option opts [Array<String>] :source_scopes_country 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).
217
+ # @option opts [Array<String>] :not_source_scopes_country 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).
218
+ # @option opts [Array<String>] :source_scopes_state 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).
219
+ # @option opts [Array<String>] :not_source_scopes_state 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).
220
+ # @option opts [Array<String>] :source_scopes_city 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).
221
+ # @option opts [Array<String>] :not_source_scopes_city 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).
222
+ # @option opts [Array<String>] :source_scopes_level 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).
223
+ # @option opts [Array<String>] :not_source_scopes_level 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).
224
+ # @option opts [Integer] :source_links_in_count_min 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).
225
+ # @option opts [Integer] :source_links_in_count_max 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).
226
+ # @option opts [Integer] :source_rankings_alexa_rank_min 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).
227
+ # @option opts [Integer] :source_rankings_alexa_rank_max 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).
228
+ # @option opts [Array<String>] :source_rankings_alexa_country 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).
229
+ # @option opts [Integer] :social_shares_count_facebook_min This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
230
+ # @option opts [Integer] :social_shares_count_facebook_max This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
231
+ # @option opts [Integer] :social_shares_count_google_plus_min This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
232
+ # @option opts [Integer] :social_shares_count_google_plus_max This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
233
+ # @option opts [Integer] :social_shares_count_linkedin_min This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
234
+ # @option opts [Integer] :social_shares_count_linkedin_max This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
235
+ # @option opts [Integer] :social_shares_count_reddit_min This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
236
+ # @option opts [Integer] :social_shares_count_reddit_max This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
142
237
  # @option opts [Integer] :interval_start This parameter is used for setting the start data point of histogram intervals.
143
238
  # @option opts [Integer] :interval_end This parameter is used for setting the end data point of histogram intervals.
144
239
  # @option opts [Integer] :interval_width This parameter is used for setting the width of histogram intervals.
@@ -146,117 +241,206 @@ describe 'DefaultApi' do
146
241
  # @return [Histograms]
147
242
  describe 'list_histograms test' do
148
243
  it "should work" do
149
- # assertion here
150
- # should be_a()
151
- # should be_nil
152
- # should ==
153
- # should_not ==
244
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
154
245
  end
155
246
  end
156
247
 
157
248
  # unit tests for list_related_stories
158
249
  # List related stories
159
- # This endpoint is used for finding related stories based on provided parameters. The number of related stories to return, up to a maximum of 100.
250
+ # This endpoint is used for finding related stories based on the parameters provided. The maximum number of related stories returned is 100.
160
251
  # @param [Hash] opts the optional parameters
161
- # @option opts [Array<Integer>] :id This parameter is used for finding stroies by story id.
252
+ # @option opts [Array<Integer>] :id This parameter is used for finding stories by story id.
253
+ # @option opts [Array<Integer>] :not_id This parameter is used for excluding stories by story id.
162
254
  # @option opts [String] :title This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
163
255
  # @option opts [String] :body This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
164
256
  # @option opts [String] :text 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).
165
257
  # @option opts [Array<String>] :language 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.
166
- # @option opts [String] :published_at_start This parameter is used for finding stories whose published at 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).
167
- # @option opts [String] :published_at_end This parameter is used for finding stories whose published at 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).
168
- # @option opts [String] :categories_taxonomy This parameter is used for defining type of the taxonomy for the rest of categories queries.
169
- # @option opts [BOOLEAN] :categories_confident This parameter is used for finding stories whose categories are confident.
170
- # @option opts [Array<String>] :categories_id This parameter is used for finding stories whose categories id is the specified value.
171
- # @option opts [Array<Integer>] :categories_level This parameter is used for finding stories whose categories level is the specified value.
172
- # @option opts [Array<String>] :entities_title_text This parameter is used for finding stories whose entities text in title is the specified value.
173
- # @option opts [Array<String>] :entities_title_type This parameter is used for finding stories whose entities type in title is the specified value.
174
- # @option opts [Array<String>] :entities_title_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
175
- # @option opts [Array<String>] :entities_body_text This parameter is used for finding stories whose entities text in body is the specified value.
176
- # @option opts [Array<String>] :entities_body_type This parameter is used for finding stories whose entities type in body is the specified value.
177
- # @option opts [Array<String>] :entities_body_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
258
+ # @option opts [Array<String>] :not_language 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.
259
+ # @option opts [String] :published_at_start 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).
260
+ # @option opts [String] :published_at_end 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).
261
+ # @option opts [String] :categories_taxonomy 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).
262
+ # @option opts [BOOLEAN] :categories_confident 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).
263
+ # @option opts [Array<String>] :categories_id 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).
264
+ # @option opts [Array<String>] :not_categories_id 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).
265
+ # @option opts [Array<Integer>] :categories_level 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).
266
+ # @option opts [Array<Integer>] :not_categories_level 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).
267
+ # @option opts [Array<String>] :entities_title_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
268
+ # @option opts [Array<String>] :not_entities_title_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
269
+ # @option opts [Array<String>] :entities_title_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
270
+ # @option opts [Array<String>] :not_entities_title_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
271
+ # @option opts [Array<String>] :entities_title_links_dbpedia 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).
272
+ # @option opts [Array<String>] :not_entities_title_links_dbpedia 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).
273
+ # @option opts [Array<String>] :entities_body_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
274
+ # @option opts [Array<String>] :not_entities_body_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
275
+ # @option opts [Array<String>] :entities_body_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
276
+ # @option opts [Array<String>] :not_entities_body_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
277
+ # @option opts [Array<String>] :entities_body_links_dbpedia 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).
278
+ # @option opts [Array<String>] :not_entities_body_links_dbpedia 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).
178
279
  # @option opts [String] :sentiment_title_polarity This parameter is used for finding stories whose title sentiment is the specified value.
280
+ # @option opts [String] :not_sentiment_title_polarity This parameter is used for excluding stories whose title sentiment is the specified value.
179
281
  # @option opts [String] :sentiment_body_polarity This parameter is used for finding stories whose body sentiment is the specified value.
282
+ # @option opts [String] :not_sentiment_body_polarity This parameter is used for excluding stories whose body sentiment is the specified value.
283
+ # @option opts [Integer] :media_images_count_min This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
284
+ # @option opts [Integer] :media_images_count_max This parameter is used for finding stories whose number of images is less than or equal to the specified value.
285
+ # @option opts [Integer] :media_images_width_min This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
286
+ # @option opts [Integer] :media_images_width_max This parameter is used for finding stories whose width of images are less than or equal to the specified value.
287
+ # @option opts [Integer] :media_images_height_min This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
288
+ # @option opts [Integer] :media_images_height_max This parameter is used for finding stories whose height of images are less than or equal to the specified value.
289
+ # @option opts [Integer] :media_images_content_length_min This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
290
+ # @option opts [Integer] :media_images_content_length_max This parameter is used for finding stories whose images content length are less than or equal to the specified value.
291
+ # @option opts [Array<String>] :media_images_format This parameter is used for finding stories whose images format are the specified value.
292
+ # @option opts [Array<String>] :not_media_images_format This parameter is used for excluding stories whose images format are the specified value.
293
+ # @option opts [Integer] :media_videos_count_min This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
294
+ # @option opts [Integer] :media_videos_count_max This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
180
295
  # @option opts [Array<Integer>] :author_id This parameter is used for finding stories whose author id is the specified value.
296
+ # @option opts [Array<Integer>] :not_author_id This parameter is used for excluding stories whose author id is the specified value.
181
297
  # @option opts [String] :author_name This parameter is used for finding stories whose author full name contains the specified value.
298
+ # @option opts [String] :not_author_name This parameter is used for excluding stories whose author full name contains the specified value.
182
299
  # @option opts [Array<Integer>] :source_id This parameter is used for finding stories whose source id is the specified value.
300
+ # @option opts [Array<Integer>] :not_source_id This parameter is used for excluding stories whose source id is the specified value.
183
301
  # @option opts [Array<String>] :source_name This parameter is used for finding stories whose source name contains the specified value.
302
+ # @option opts [Array<String>] :not_source_name This parameter is used for excluding stories whose source name contains the specified value.
184
303
  # @option opts [Array<String>] :source_domain This parameter is used for finding stories whose source domain is the specified value.
185
- # @option opts [Array<String>] :source_locations_country 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.
186
- # @option opts [Array<String>] :source_locations_state This parameter is used for finding stories whose source state/province is the specified value.
187
- # @option opts [Array<String>] :source_locations_city This parameter is used for finding stories whose source city is the specified value.
188
- # @option opts [Array<String>] :source_scopes_country This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
189
- # @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes state/province is the specified value.
190
- # @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes city is the specified value.
191
- # @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes level is the specified value.
304
+ # @option opts [Array<String>] :not_source_domain This parameter is used for excluding stories whose source domain is the specified value.
305
+ # @option opts [Array<String>] :source_locations_country 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).
306
+ # @option opts [Array<String>] :not_source_locations_country 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).
307
+ # @option opts [Array<String>] :source_locations_state 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).
308
+ # @option opts [Array<String>] :not_source_locations_state 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).
309
+ # @option opts [Array<String>] :source_locations_city 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).
310
+ # @option opts [Array<String>] :not_source_locations_city 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).
311
+ # @option opts [Array<String>] :source_scopes_country 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).
312
+ # @option opts [Array<String>] :not_source_scopes_country 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).
313
+ # @option opts [Array<String>] :source_scopes_state 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).
314
+ # @option opts [Array<String>] :not_source_scopes_state 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).
315
+ # @option opts [Array<String>] :source_scopes_city 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).
316
+ # @option opts [Array<String>] :not_source_scopes_city 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).
317
+ # @option opts [Array<String>] :source_scopes_level 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).
318
+ # @option opts [Array<String>] :not_source_scopes_level 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).
319
+ # @option opts [Integer] :source_links_in_count_min 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).
320
+ # @option opts [Integer] :source_links_in_count_max 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).
321
+ # @option opts [Integer] :source_rankings_alexa_rank_min 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).
322
+ # @option opts [Integer] :source_rankings_alexa_rank_max 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).
323
+ # @option opts [Array<String>] :source_rankings_alexa_country 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).
324
+ # @option opts [Integer] :social_shares_count_facebook_min This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
325
+ # @option opts [Integer] :social_shares_count_facebook_max This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
326
+ # @option opts [Integer] :social_shares_count_google_plus_min This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
327
+ # @option opts [Integer] :social_shares_count_google_plus_max This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
328
+ # @option opts [Integer] :social_shares_count_linkedin_min This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
329
+ # @option opts [Integer] :social_shares_count_linkedin_max This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
330
+ # @option opts [Integer] :social_shares_count_reddit_min This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
331
+ # @option opts [Integer] :social_shares_count_reddit_max This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
332
+ # @option opts [BOOLEAN] :cluster 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).
333
+ # @option opts [String] :cluster_algorithm 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).
334
+ # @option opts [Array<String>] :_return This parameter is used for specifying return fields.
192
335
  # @option opts [Integer] :story_id A story id
193
336
  # @option opts [String] :story_url An article or webpage
194
337
  # @option opts [String] :story_title Title of the article
195
338
  # @option opts [String] :story_body Body of the article
196
- # @option opts [String] :boost_by This parameter is used for boosting result by the specified value.
197
- # @option opts [String] :story_language This parameter is used for setting language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
198
- # @option opts [Integer] :per_page This parameter is used for specifying number of the items in each page.
339
+ # @option opts [String] :boost_by This parameter is used for boosting the result by the specified value.
340
+ # @option opts [String] :story_language 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.
341
+ # @option opts [Integer] :per_page This parameter is used for specifying number of items in each page.
199
342
  # @return [RelatedStories]
200
343
  describe 'list_related_stories test' do
201
344
  it "should work" do
202
- # assertion here
203
- # should be_a()
204
- # should be_nil
205
- # should ==
206
- # should_not ==
345
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
207
346
  end
208
347
  end
209
348
 
210
349
  # unit tests for list_stories
211
350
  # List Stories
212
- # This endpoint is used for getting list of stories.
351
+ # This endpoint is used for getting a list of stories.
213
352
  # @param [Hash] opts the optional parameters
214
- # @option opts [Array<Integer>] :id This parameter is used for finding stroies by story id.
353
+ # @option opts [Array<Integer>] :id This parameter is used for finding stories by story id.
354
+ # @option opts [Array<Integer>] :not_id This parameter is used for excluding stories by story id.
215
355
  # @option opts [String] :title This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
216
356
  # @option opts [String] :body This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
217
357
  # @option opts [String] :text 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).
218
358
  # @option opts [Array<String>] :language 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.
219
- # @option opts [String] :published_at_start This parameter is used for finding stories whose published at 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).
220
- # @option opts [String] :published_at_end This parameter is used for finding stories whose published at 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).
221
- # @option opts [String] :categories_taxonomy This parameter is used for defining type of the taxonomy for the rest of categories queries.
222
- # @option opts [BOOLEAN] :categories_confident This parameter is used for finding stories whose categories are confident.
223
- # @option opts [Array<String>] :categories_id This parameter is used for finding stories whose categories id is the specified value.
224
- # @option opts [Array<Integer>] :categories_level This parameter is used for finding stories whose categories level is the specified value.
225
- # @option opts [Array<String>] :entities_title_text This parameter is used for finding stories whose entities text in title is the specified value.
226
- # @option opts [Array<String>] :entities_title_type This parameter is used for finding stories whose entities type in title is the specified value.
227
- # @option opts [Array<String>] :entities_title_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
228
- # @option opts [Array<String>] :entities_body_text This parameter is used for finding stories whose entities text in body is the specified value.
229
- # @option opts [Array<String>] :entities_body_type This parameter is used for finding stories whose entities type in body is the specified value.
230
- # @option opts [Array<String>] :entities_body_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
359
+ # @option opts [Array<String>] :not_language 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.
360
+ # @option opts [String] :published_at_start 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).
361
+ # @option opts [String] :published_at_end 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).
362
+ # @option opts [String] :categories_taxonomy 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).
363
+ # @option opts [BOOLEAN] :categories_confident 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).
364
+ # @option opts [Array<String>] :categories_id 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).
365
+ # @option opts [Array<String>] :not_categories_id 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).
366
+ # @option opts [Array<Integer>] :categories_level 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).
367
+ # @option opts [Array<Integer>] :not_categories_level 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).
368
+ # @option opts [Array<String>] :entities_title_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
369
+ # @option opts [Array<String>] :not_entities_title_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
370
+ # @option opts [Array<String>] :entities_title_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
371
+ # @option opts [Array<String>] :not_entities_title_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
372
+ # @option opts [Array<String>] :entities_title_links_dbpedia 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).
373
+ # @option opts [Array<String>] :not_entities_title_links_dbpedia 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).
374
+ # @option opts [Array<String>] :entities_body_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
375
+ # @option opts [Array<String>] :not_entities_body_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
376
+ # @option opts [Array<String>] :entities_body_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
377
+ # @option opts [Array<String>] :not_entities_body_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
378
+ # @option opts [Array<String>] :entities_body_links_dbpedia 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).
379
+ # @option opts [Array<String>] :not_entities_body_links_dbpedia 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).
231
380
  # @option opts [String] :sentiment_title_polarity This parameter is used for finding stories whose title sentiment is the specified value.
381
+ # @option opts [String] :not_sentiment_title_polarity This parameter is used for excluding stories whose title sentiment is the specified value.
232
382
  # @option opts [String] :sentiment_body_polarity This parameter is used for finding stories whose body sentiment is the specified value.
383
+ # @option opts [String] :not_sentiment_body_polarity This parameter is used for excluding stories whose body sentiment is the specified value.
384
+ # @option opts [Integer] :media_images_count_min This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
385
+ # @option opts [Integer] :media_images_count_max This parameter is used for finding stories whose number of images is less than or equal to the specified value.
386
+ # @option opts [Integer] :media_images_width_min This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
387
+ # @option opts [Integer] :media_images_width_max This parameter is used for finding stories whose width of images are less than or equal to the specified value.
388
+ # @option opts [Integer] :media_images_height_min This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
389
+ # @option opts [Integer] :media_images_height_max This parameter is used for finding stories whose height of images are less than or equal to the specified value.
390
+ # @option opts [Integer] :media_images_content_length_min This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
391
+ # @option opts [Integer] :media_images_content_length_max This parameter is used for finding stories whose images content length are less than or equal to the specified value.
392
+ # @option opts [Array<String>] :media_images_format This parameter is used for finding stories whose images format are the specified value.
393
+ # @option opts [Array<String>] :not_media_images_format This parameter is used for excluding stories whose images format are the specified value.
394
+ # @option opts [Integer] :media_videos_count_min This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
395
+ # @option opts [Integer] :media_videos_count_max This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
233
396
  # @option opts [Array<Integer>] :author_id This parameter is used for finding stories whose author id is the specified value.
397
+ # @option opts [Array<Integer>] :not_author_id This parameter is used for excluding stories whose author id is the specified value.
234
398
  # @option opts [String] :author_name This parameter is used for finding stories whose author full name contains the specified value.
399
+ # @option opts [String] :not_author_name This parameter is used for excluding stories whose author full name contains the specified value.
235
400
  # @option opts [Array<Integer>] :source_id This parameter is used for finding stories whose source id is the specified value.
401
+ # @option opts [Array<Integer>] :not_source_id This parameter is used for excluding stories whose source id is the specified value.
236
402
  # @option opts [Array<String>] :source_name This parameter is used for finding stories whose source name contains the specified value.
403
+ # @option opts [Array<String>] :not_source_name This parameter is used for excluding stories whose source name contains the specified value.
237
404
  # @option opts [Array<String>] :source_domain This parameter is used for finding stories whose source domain is the specified value.
238
- # @option opts [Array<String>] :source_locations_country 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.
239
- # @option opts [Array<String>] :source_locations_state This parameter is used for finding stories whose source state/province is the specified value.
240
- # @option opts [Array<String>] :source_locations_city This parameter is used for finding stories whose source city is the specified value.
241
- # @option opts [Array<String>] :source_scopes_country This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
242
- # @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes state/province is the specified value.
243
- # @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes city is the specified value.
244
- # @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes level is the specified value.
245
- # @option opts [BOOLEAN] :cluster This parameter enables clustering for the returned stories.
246
- # @option opts [String] :cluster_algorithm This parameter is used for specifying the clustering algorithm. It supprts STC, Lingo and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithms.
405
+ # @option opts [Array<String>] :not_source_domain This parameter is used for excluding stories whose source domain is the specified value.
406
+ # @option opts [Array<String>] :source_locations_country 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).
407
+ # @option opts [Array<String>] :not_source_locations_country 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).
408
+ # @option opts [Array<String>] :source_locations_state 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).
409
+ # @option opts [Array<String>] :not_source_locations_state 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).
410
+ # @option opts [Array<String>] :source_locations_city 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).
411
+ # @option opts [Array<String>] :not_source_locations_city 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).
412
+ # @option opts [Array<String>] :source_scopes_country 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).
413
+ # @option opts [Array<String>] :not_source_scopes_country 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).
414
+ # @option opts [Array<String>] :source_scopes_state 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).
415
+ # @option opts [Array<String>] :not_source_scopes_state 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).
416
+ # @option opts [Array<String>] :source_scopes_city 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).
417
+ # @option opts [Array<String>] :not_source_scopes_city 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).
418
+ # @option opts [Array<String>] :source_scopes_level 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).
419
+ # @option opts [Array<String>] :not_source_scopes_level 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).
420
+ # @option opts [Integer] :source_links_in_count_min 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).
421
+ # @option opts [Integer] :source_links_in_count_max 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).
422
+ # @option opts [Integer] :source_rankings_alexa_rank_min 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).
423
+ # @option opts [Integer] :source_rankings_alexa_rank_max 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).
424
+ # @option opts [Array<String>] :source_rankings_alexa_country 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).
425
+ # @option opts [Integer] :social_shares_count_facebook_min This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
426
+ # @option opts [Integer] :social_shares_count_facebook_max This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
427
+ # @option opts [Integer] :social_shares_count_google_plus_min This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
428
+ # @option opts [Integer] :social_shares_count_google_plus_max This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
429
+ # @option opts [Integer] :social_shares_count_linkedin_min This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
430
+ # @option opts [Integer] :social_shares_count_linkedin_max This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
431
+ # @option opts [Integer] :social_shares_count_reddit_min This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
432
+ # @option opts [Integer] :social_shares_count_reddit_max This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
433
+ # @option opts [BOOLEAN] :cluster 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).
434
+ # @option opts [String] :cluster_algorithm 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).
247
435
  # @option opts [Array<String>] :_return This parameter is used for specifying return fields.
248
- # @option opts [String] :sort_by This parameter is used for changing the order column of the result.
436
+ # @option opts [String] :sort_by This parameter is used for changing the order column of the results.
249
437
  # @option opts [String] :sort_direction This parameter is used for changing the order direction of the result.
250
- # @option opts [String] :cursor This parameter is used for finding a specific page.
251
- # @option opts [Integer] :per_page This parameter is used for specifying number of the items in each page.
438
+ # @option opts [String] :cursor This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
439
+ # @option opts [Integer] :per_page This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results)
252
440
  # @return [Stories]
253
441
  describe 'list_stories test' do
254
442
  it "should work" do
255
- # assertion here
256
- # should be_a()
257
- # should be_nil
258
- # should ==
259
- # should_not ==
443
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
260
444
  end
261
445
  end
262
446
 
@@ -264,93 +448,183 @@ describe 'DefaultApi' do
264
448
  # List time series
265
449
  # This endpoint is used for getting time series by stories.
266
450
  # @param [Hash] opts the optional parameters
267
- # @option opts [Array<Integer>] :id This parameter is used for finding stroies by story id.
451
+ # @option opts [Array<Integer>] :id This parameter is used for finding stories by story id.
452
+ # @option opts [Array<Integer>] :not_id This parameter is used for excluding stories by story id.
268
453
  # @option opts [String] :title This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
269
454
  # @option opts [String] :body This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
270
455
  # @option opts [String] :text 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).
271
456
  # @option opts [Array<String>] :language 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.
272
- # @option opts [String] :categories_taxonomy This parameter is used for defining type of the taxonomy for the rest of categories queries.
273
- # @option opts [BOOLEAN] :categories_confident This parameter is used for finding stories whose categories are confident.
274
- # @option opts [Array<String>] :categories_id This parameter is used for finding stories whose categories id is the specified value.
275
- # @option opts [Array<Integer>] :categories_level This parameter is used for finding stories whose categories level is the specified value.
276
- # @option opts [Array<String>] :entities_title_text This parameter is used for finding stories whose entities text in title is the specified value.
277
- # @option opts [Array<String>] :entities_title_type This parameter is used for finding stories whose entities type in title is the specified value.
278
- # @option opts [Array<String>] :entities_title_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
279
- # @option opts [Array<String>] :entities_body_text This parameter is used for finding stories whose entities text in body is the specified value.
280
- # @option opts [Array<String>] :entities_body_type This parameter is used for finding stories whose entities type in body is the specified value.
281
- # @option opts [Array<String>] :entities_body_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
457
+ # @option opts [Array<String>] :not_language 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.
458
+ # @option opts [String] :categories_taxonomy 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).
459
+ # @option opts [BOOLEAN] :categories_confident 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).
460
+ # @option opts [Array<String>] :categories_id 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).
461
+ # @option opts [Array<String>] :not_categories_id 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).
462
+ # @option opts [Array<Integer>] :categories_level 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).
463
+ # @option opts [Array<Integer>] :not_categories_level 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).
464
+ # @option opts [Array<String>] :entities_title_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
465
+ # @option opts [Array<String>] :not_entities_title_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
466
+ # @option opts [Array<String>] :entities_title_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
467
+ # @option opts [Array<String>] :not_entities_title_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
468
+ # @option opts [Array<String>] :entities_title_links_dbpedia 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).
469
+ # @option opts [Array<String>] :not_entities_title_links_dbpedia 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).
470
+ # @option opts [Array<String>] :entities_body_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
471
+ # @option opts [Array<String>] :not_entities_body_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
472
+ # @option opts [Array<String>] :entities_body_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
473
+ # @option opts [Array<String>] :not_entities_body_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
474
+ # @option opts [Array<String>] :entities_body_links_dbpedia 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).
475
+ # @option opts [Array<String>] :not_entities_body_links_dbpedia 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).
282
476
  # @option opts [String] :sentiment_title_polarity This parameter is used for finding stories whose title sentiment is the specified value.
477
+ # @option opts [String] :not_sentiment_title_polarity This parameter is used for excluding stories whose title sentiment is the specified value.
283
478
  # @option opts [String] :sentiment_body_polarity This parameter is used for finding stories whose body sentiment is the specified value.
479
+ # @option opts [String] :not_sentiment_body_polarity This parameter is used for excluding stories whose body sentiment is the specified value.
480
+ # @option opts [Integer] :media_images_count_min This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
481
+ # @option opts [Integer] :media_images_count_max This parameter is used for finding stories whose number of images is less than or equal to the specified value.
482
+ # @option opts [Integer] :media_images_width_min This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
483
+ # @option opts [Integer] :media_images_width_max This parameter is used for finding stories whose width of images are less than or equal to the specified value.
484
+ # @option opts [Integer] :media_images_height_min This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
485
+ # @option opts [Integer] :media_images_height_max This parameter is used for finding stories whose height of images are less than or equal to the specified value.
486
+ # @option opts [Integer] :media_images_content_length_min This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
487
+ # @option opts [Integer] :media_images_content_length_max This parameter is used for finding stories whose images content length are less than or equal to the specified value.
488
+ # @option opts [Array<String>] :media_images_format This parameter is used for finding stories whose images format are the specified value.
489
+ # @option opts [Array<String>] :not_media_images_format This parameter is used for excluding stories whose images format are the specified value.
490
+ # @option opts [Integer] :media_videos_count_min This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
491
+ # @option opts [Integer] :media_videos_count_max This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
284
492
  # @option opts [Array<Integer>] :author_id This parameter is used for finding stories whose author id is the specified value.
493
+ # @option opts [Array<Integer>] :not_author_id This parameter is used for excluding stories whose author id is the specified value.
285
494
  # @option opts [String] :author_name This parameter is used for finding stories whose author full name contains the specified value.
495
+ # @option opts [String] :not_author_name This parameter is used for excluding stories whose author full name contains the specified value.
286
496
  # @option opts [Array<Integer>] :source_id This parameter is used for finding stories whose source id is the specified value.
497
+ # @option opts [Array<Integer>] :not_source_id This parameter is used for excluding stories whose source id is the specified value.
287
498
  # @option opts [Array<String>] :source_name This parameter is used for finding stories whose source name contains the specified value.
499
+ # @option opts [Array<String>] :not_source_name This parameter is used for excluding stories whose source name contains the specified value.
288
500
  # @option opts [Array<String>] :source_domain This parameter is used for finding stories whose source domain is the specified value.
289
- # @option opts [Array<String>] :source_locations_country 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.
290
- # @option opts [Array<String>] :source_locations_state This parameter is used for finding stories whose source state/province is the specified value.
291
- # @option opts [Array<String>] :source_locations_city This parameter is used for finding stories whose source city is the specified value.
292
- # @option opts [Array<String>] :source_scopes_country This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
293
- # @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes state/province is the specified value.
294
- # @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes city is the specified value.
295
- # @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes level is the specified value.
296
- # @option opts [String] :published_at_start This parameter is used for finding stories whose published at 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).
297
- # @option opts [String] :published_at_end This parameter is used for finding stories whose published at 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).
298
- # @option opts [String] :period The size of each date range expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are &#x60;+&#x60; following an integer number greater than 0 and one of the Date Math keywords. e.g. &#x60;+1DAY&#x60;, &#x60;+2MINUTES&#x60; and &#x60;+1MONTH&#x60;. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math).
501
+ # @option opts [Array<String>] :not_source_domain This parameter is used for excluding stories whose source domain is the specified value.
502
+ # @option opts [Array<String>] :source_locations_country 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).
503
+ # @option opts [Array<String>] :not_source_locations_country 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).
504
+ # @option opts [Array<String>] :source_locations_state 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).
505
+ # @option opts [Array<String>] :not_source_locations_state 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).
506
+ # @option opts [Array<String>] :source_locations_city 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).
507
+ # @option opts [Array<String>] :not_source_locations_city 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).
508
+ # @option opts [Array<String>] :source_scopes_country 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).
509
+ # @option opts [Array<String>] :not_source_scopes_country 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).
510
+ # @option opts [Array<String>] :source_scopes_state 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).
511
+ # @option opts [Array<String>] :not_source_scopes_state 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).
512
+ # @option opts [Array<String>] :source_scopes_city 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).
513
+ # @option opts [Array<String>] :not_source_scopes_city 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).
514
+ # @option opts [Array<String>] :source_scopes_level 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).
515
+ # @option opts [Array<String>] :not_source_scopes_level 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).
516
+ # @option opts [Integer] :source_links_in_count_min 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).
517
+ # @option opts [Integer] :source_links_in_count_max 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).
518
+ # @option opts [Integer] :source_rankings_alexa_rank_min 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).
519
+ # @option opts [Integer] :source_rankings_alexa_rank_max 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).
520
+ # @option opts [Array<String>] :source_rankings_alexa_country 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).
521
+ # @option opts [Integer] :social_shares_count_facebook_min This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
522
+ # @option opts [Integer] :social_shares_count_facebook_max This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
523
+ # @option opts [Integer] :social_shares_count_google_plus_min This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
524
+ # @option opts [Integer] :social_shares_count_google_plus_max This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
525
+ # @option opts [Integer] :social_shares_count_linkedin_min This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
526
+ # @option opts [Integer] :social_shares_count_linkedin_max This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
527
+ # @option opts [Integer] :social_shares_count_reddit_min This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
528
+ # @option opts [Integer] :social_shares_count_reddit_max This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
529
+ # @option opts [String] :published_at_start 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).
530
+ # @option opts [String] :published_at_end 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).
531
+ # @option opts [String] :period The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are &#x60;+&#x60; following an integer number greater than 0 and one of the Date Math keywords. e.g. &#x60;+1DAY&#x60;, &#x60;+2MINUTES&#x60; and &#x60;+1MONTH&#x60;. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math).
299
532
  # @return [TimeSeriesList]
300
533
  describe 'list_time_series test' do
301
534
  it "should work" do
302
- # assertion here
303
- # should be_a()
304
- # should be_nil
305
- # should ==
306
- # should_not ==
535
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
307
536
  end
308
537
  end
309
538
 
310
539
  # unit tests for list_trends
311
540
  # List trends
312
- # This endpoint is used for finding news trendings based on stories resource.
541
+ # This endpoint is used for finding trends based on stories.
542
+ # @param field This parameter is used to specify the trend field.
313
543
  # @param [Hash] opts the optional parameters
314
- # @option opts [Array<Integer>] :id This parameter is used for finding stroies by story id.
544
+ # @option opts [Array<Integer>] :id This parameter is used for finding stories by story id.
545
+ # @option opts [Array<Integer>] :not_id This parameter is used for excluding stories by story id.
315
546
  # @option opts [String] :title This parameter is used for finding stories whose title contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
316
547
  # @option opts [String] :body This parameter is used for finding stories whose body contains a specfic keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
317
548
  # @option opts [String] :text 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).
318
549
  # @option opts [Array<String>] :language 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.
319
- # @option opts [String] :published_at_start This parameter is used for finding stories whose published at 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).
320
- # @option opts [String] :published_at_end This parameter is used for finding stories whose published at 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).
321
- # @option opts [String] :categories_taxonomy This parameter is used for defining type of the taxonomy for the rest of categories queries.
322
- # @option opts [BOOLEAN] :categories_confident This parameter is used for finding stories whose categories are confident.
323
- # @option opts [Array<String>] :categories_id This parameter is used for finding stories whose categories id is the specified value.
324
- # @option opts [Array<Integer>] :categories_level This parameter is used for finding stories whose categories level is the specified value.
325
- # @option opts [Array<String>] :entities_title_text This parameter is used for finding stories whose entities text in title is the specified value.
326
- # @option opts [Array<String>] :entities_title_type This parameter is used for finding stories whose entities type in title is the specified value.
327
- # @option opts [Array<String>] :entities_title_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in title is the specified value.
328
- # @option opts [Array<String>] :entities_body_text This parameter is used for finding stories whose entities text in body is the specified value.
329
- # @option opts [Array<String>] :entities_body_type This parameter is used for finding stories whose entities type in body is the specified value.
330
- # @option opts [Array<String>] :entities_body_links_dbpedia This parameter is used for finding stories whose entities dbpedia url in body is the specified value.
550
+ # @option opts [Array<String>] :not_language 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.
551
+ # @option opts [String] :published_at_start 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).
552
+ # @option opts [String] :published_at_end 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).
553
+ # @option opts [String] :categories_taxonomy 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).
554
+ # @option opts [BOOLEAN] :categories_confident 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).
555
+ # @option opts [Array<String>] :categories_id 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).
556
+ # @option opts [Array<String>] :not_categories_id 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).
557
+ # @option opts [Array<Integer>] :categories_level 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).
558
+ # @option opts [Array<Integer>] :not_categories_level 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).
559
+ # @option opts [Array<String>] :entities_title_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
560
+ # @option opts [Array<String>] :not_entities_title_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
561
+ # @option opts [Array<String>] :entities_title_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
562
+ # @option opts [Array<String>] :not_entities_title_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
563
+ # @option opts [Array<String>] :entities_title_links_dbpedia 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).
564
+ # @option opts [Array<String>] :not_entities_title_links_dbpedia 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).
565
+ # @option opts [Array<String>] :entities_body_text This parameter is used to find stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
566
+ # @option opts [Array<String>] :not_entities_body_text This parameter is used to exclude stories based on the specified entities &#x60;text&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
567
+ # @option opts [Array<String>] :entities_body_type This parameter is used to find stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
568
+ # @option opts [Array<String>] :not_entities_body_type This parameter is used to exclude stories based on the specified entities &#x60;type&#x60; in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
569
+ # @option opts [Array<String>] :entities_body_links_dbpedia 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).
570
+ # @option opts [Array<String>] :not_entities_body_links_dbpedia 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).
331
571
  # @option opts [String] :sentiment_title_polarity This parameter is used for finding stories whose title sentiment is the specified value.
572
+ # @option opts [String] :not_sentiment_title_polarity This parameter is used for excluding stories whose title sentiment is the specified value.
332
573
  # @option opts [String] :sentiment_body_polarity This parameter is used for finding stories whose body sentiment is the specified value.
574
+ # @option opts [String] :not_sentiment_body_polarity This parameter is used for excluding stories whose body sentiment is the specified value.
575
+ # @option opts [Integer] :media_images_count_min This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
576
+ # @option opts [Integer] :media_images_count_max This parameter is used for finding stories whose number of images is less than or equal to the specified value.
577
+ # @option opts [Integer] :media_images_width_min This parameter is used for finding stories whose width of images are greater than or equal to the specified value.
578
+ # @option opts [Integer] :media_images_width_max This parameter is used for finding stories whose width of images are less than or equal to the specified value.
579
+ # @option opts [Integer] :media_images_height_min This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
580
+ # @option opts [Integer] :media_images_height_max This parameter is used for finding stories whose height of images are less than or equal to the specified value.
581
+ # @option opts [Integer] :media_images_content_length_min This parameter is used for finding stories whose images content length are greater than or equal to the specified value.
582
+ # @option opts [Integer] :media_images_content_length_max This parameter is used for finding stories whose images content length are less than or equal to the specified value.
583
+ # @option opts [Array<String>] :media_images_format This parameter is used for finding stories whose images format are the specified value.
584
+ # @option opts [Array<String>] :not_media_images_format This parameter is used for excluding stories whose images format are the specified value.
585
+ # @option opts [Integer] :media_videos_count_min This parameter is used for finding stories whose number of videos is greater than or equal to the specified value.
586
+ # @option opts [Integer] :media_videos_count_max This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
333
587
  # @option opts [Array<Integer>] :author_id This parameter is used for finding stories whose author id is the specified value.
588
+ # @option opts [Array<Integer>] :not_author_id This parameter is used for excluding stories whose author id is the specified value.
334
589
  # @option opts [String] :author_name This parameter is used for finding stories whose author full name contains the specified value.
590
+ # @option opts [String] :not_author_name This parameter is used for excluding stories whose author full name contains the specified value.
335
591
  # @option opts [Array<Integer>] :source_id This parameter is used for finding stories whose source id is the specified value.
592
+ # @option opts [Array<Integer>] :not_source_id This parameter is used for excluding stories whose source id is the specified value.
336
593
  # @option opts [Array<String>] :source_name This parameter is used for finding stories whose source name contains the specified value.
594
+ # @option opts [Array<String>] :not_source_name This parameter is used for excluding stories whose source name contains the specified value.
337
595
  # @option opts [Array<String>] :source_domain This parameter is used for finding stories whose source domain is the specified value.
338
- # @option opts [Array<String>] :source_locations_country 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.
339
- # @option opts [Array<String>] :source_locations_state This parameter is used for finding stories whose source state/province is the specified value.
340
- # @option opts [Array<String>] :source_locations_city This parameter is used for finding stories whose source city is the specified value.
341
- # @option opts [Array<String>] :source_scopes_country This parameter is used for finding stories whose source scopes country is the specified value. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
342
- # @option opts [Array<String>] :source_scopes_state This parameter is used for finding stories whose source scopes state/province is the specified value.
343
- # @option opts [Array<String>] :source_scopes_city This parameter is used for finding stories whose source scopes city is the specified value.
344
- # @option opts [Array<String>] :source_scopes_level This parameter is used for finding stories whose source scopes level is the specified value.
345
- # @option opts [String] :field This parameter is used to specify the trend field.
596
+ # @option opts [Array<String>] :not_source_domain This parameter is used for excluding stories whose source domain is the specified value.
597
+ # @option opts [Array<String>] :source_locations_country 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).
598
+ # @option opts [Array<String>] :not_source_locations_country 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).
599
+ # @option opts [Array<String>] :source_locations_state 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).
600
+ # @option opts [Array<String>] :not_source_locations_state 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).
601
+ # @option opts [Array<String>] :source_locations_city 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).
602
+ # @option opts [Array<String>] :not_source_locations_city 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).
603
+ # @option opts [Array<String>] :source_scopes_country 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).
604
+ # @option opts [Array<String>] :not_source_scopes_country 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).
605
+ # @option opts [Array<String>] :source_scopes_state 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).
606
+ # @option opts [Array<String>] :not_source_scopes_state 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).
607
+ # @option opts [Array<String>] :source_scopes_city 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).
608
+ # @option opts [Array<String>] :not_source_scopes_city 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).
609
+ # @option opts [Array<String>] :source_scopes_level 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).
610
+ # @option opts [Array<String>] :not_source_scopes_level 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).
611
+ # @option opts [Integer] :source_links_in_count_min 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).
612
+ # @option opts [Integer] :source_links_in_count_max 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).
613
+ # @option opts [Integer] :source_rankings_alexa_rank_min 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).
614
+ # @option opts [Integer] :source_rankings_alexa_rank_max 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).
615
+ # @option opts [Array<String>] :source_rankings_alexa_country 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).
616
+ # @option opts [Integer] :social_shares_count_facebook_min This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
617
+ # @option opts [Integer] :social_shares_count_facebook_max This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
618
+ # @option opts [Integer] :social_shares_count_google_plus_min This parameter is used for finding stories whose Google+ social shares count is greater than or equal to the specified value.
619
+ # @option opts [Integer] :social_shares_count_google_plus_max This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
620
+ # @option opts [Integer] :social_shares_count_linkedin_min This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
621
+ # @option opts [Integer] :social_shares_count_linkedin_max This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
622
+ # @option opts [Integer] :social_shares_count_reddit_min This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
623
+ # @option opts [Integer] :social_shares_count_reddit_max This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
346
624
  # @return [Trends]
347
625
  describe 'list_trends test' do
348
626
  it "should work" do
349
- # assertion here
350
- # should be_a()
351
- # should be_nil
352
- # should ==
353
- # should_not ==
627
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
354
628
  end
355
629
  end
356
630