finnhub_ruby 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +201 -0
- data/README.md +164 -0
- data/Rakefile +10 -0
- data/docs/AggregateIndicators.md +19 -0
- data/docs/BasicFinancials.md +21 -0
- data/docs/Company.md +29 -0
- data/docs/CompanyExecutive.md +19 -0
- data/docs/CompanyNewsStatistics.md +21 -0
- data/docs/CompanyProfile.md +71 -0
- data/docs/CompanyProfile2.md +39 -0
- data/docs/CountryMetadata.md +27 -0
- data/docs/CovidInfo.md +23 -0
- data/docs/CryptoCandles.md +29 -0
- data/docs/CryptoSymbol.md +21 -0
- data/docs/DefaultApi.md +2662 -0
- data/docs/Development.md +23 -0
- data/docs/Dividends.md +31 -0
- data/docs/EarningEstimate.md +25 -0
- data/docs/EarningRelease.md +33 -0
- data/docs/EarningResult.md +23 -0
- data/docs/EarningsCalendar.md +17 -0
- data/docs/EarningsCallTranscripts.md +33 -0
- data/docs/EarningsCallTranscriptsList.md +19 -0
- data/docs/EarningsEstimates.md +21 -0
- data/docs/EconomicCalendar.md +17 -0
- data/docs/EconomicCode.md +23 -0
- data/docs/EconomicData.md +19 -0
- data/docs/EconomicEvent.md +31 -0
- data/docs/Estimate.md +25 -0
- data/docs/Filing.md +31 -0
- data/docs/FinancialStatements.md +19 -0
- data/docs/FinancialsAsReported.md +21 -0
- data/docs/ForexCandles.md +29 -0
- data/docs/ForexSymbol.md +21 -0
- data/docs/Forexrates.md +19 -0
- data/docs/FundOwnership.md +19 -0
- data/docs/IPOCalendar.md +17 -0
- data/docs/IPOEvent.md +31 -0
- data/docs/Indicator.md +21 -0
- data/docs/Investor.md +23 -0
- data/docs/InvestorsOwnership.md +19 -0
- data/docs/LastBidAsk.md +25 -0
- data/docs/MajorDevelopments.md +19 -0
- data/docs/News.md +33 -0
- data/docs/NewsSentiment.md +27 -0
- data/docs/PatternRecognition.md +17 -0
- data/docs/PriceTarget.md +27 -0
- data/docs/Quote.md +25 -0
- data/docs/RecommendationTrend.md +29 -0
- data/docs/Report.md +37 -0
- data/docs/RevenueEstimates.md +21 -0
- data/docs/Sentiment.md +19 -0
- data/docs/Split.md +23 -0
- data/docs/Stock.md +21 -0
- data/docs/StockCandles.md +29 -0
- data/docs/StockTranscripts.md +25 -0
- data/docs/SupportResistance.md +17 -0
- data/docs/TechnicalAnalysis.md +19 -0
- data/docs/TickData.md +31 -0
- data/docs/TranscriptContent.md +19 -0
- data/docs/TranscriptParticipant.md +19 -0
- data/docs/Trend.md +17 -0
- data/docs/UpgradeDowngrade.md +27 -0
- data/finnhub_ruby-0.0.1.gem +0 -0
- data/finnhub_ruby-0.0.2.gem +0 -0
- data/finnhub_ruby.gemspec +39 -0
- data/git_push.sh +58 -0
- data/lib/finnhub_ruby.rb +99 -0
- data/lib/finnhub_ruby/api/default_api.rb +3142 -0
- data/lib/finnhub_ruby/api_client.rb +389 -0
- data/lib/finnhub_ruby/api_error.rb +57 -0
- data/lib/finnhub_ruby/configuration.rb +248 -0
- data/lib/finnhub_ruby/models/aggregate_indicators.rb +215 -0
- data/lib/finnhub_ruby/models/basic_financials.rb +226 -0
- data/lib/finnhub_ruby/models/company.rb +267 -0
- data/lib/finnhub_ruby/models/company_executive.rb +219 -0
- data/lib/finnhub_ruby/models/company_news_statistics.rb +227 -0
- data/lib/finnhub_ruby/models/company_profile.rb +477 -0
- data/lib/finnhub_ruby/models/company_profile2.rb +317 -0
- data/lib/finnhub_ruby/models/country_metadata.rb +257 -0
- data/lib/finnhub_ruby/models/covid_info.rb +237 -0
- data/lib/finnhub_ruby/models/crypto_candles.rb +279 -0
- data/lib/finnhub_ruby/models/crypto_symbol.rb +227 -0
- data/lib/finnhub_ruby/models/development.rb +237 -0
- data/lib/finnhub_ruby/models/dividends.rb +277 -0
- data/lib/finnhub_ruby/models/earning_estimate.rb +247 -0
- data/lib/finnhub_ruby/models/earning_release.rb +287 -0
- data/lib/finnhub_ruby/models/earning_result.rb +237 -0
- data/lib/finnhub_ruby/models/earnings_calendar.rb +209 -0
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +291 -0
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +219 -0
- data/lib/finnhub_ruby/models/earnings_estimates.rb +229 -0
- data/lib/finnhub_ruby/models/economic_calendar.rb +209 -0
- data/lib/finnhub_ruby/models/economic_code.rb +237 -0
- data/lib/finnhub_ruby/models/economic_data.rb +219 -0
- data/lib/finnhub_ruby/models/economic_event.rb +277 -0
- data/lib/finnhub_ruby/models/estimate.rb +247 -0
- data/lib/finnhub_ruby/models/filing.rb +277 -0
- data/lib/finnhub_ruby/models/financial_statements.rb +219 -0
- data/lib/finnhub_ruby/models/financials_as_reported.rb +229 -0
- data/lib/finnhub_ruby/models/forex_candles.rb +279 -0
- data/lib/finnhub_ruby/models/forex_symbol.rb +227 -0
- data/lib/finnhub_ruby/models/forexrates.rb +216 -0
- data/lib/finnhub_ruby/models/fund_ownership.rb +219 -0
- data/lib/finnhub_ruby/models/indicator.rb +227 -0
- data/lib/finnhub_ruby/models/investor.rb +237 -0
- data/lib/finnhub_ruby/models/investors_ownership.rb +219 -0
- data/lib/finnhub_ruby/models/ipo_calendar.rb +209 -0
- data/lib/finnhub_ruby/models/ipo_event.rb +277 -0
- data/lib/finnhub_ruby/models/last_bid_ask.rb +247 -0
- data/lib/finnhub_ruby/models/major_developments.rb +219 -0
- data/lib/finnhub_ruby/models/news.rb +287 -0
- data/lib/finnhub_ruby/models/news_sentiment.rb +255 -0
- data/lib/finnhub_ruby/models/pattern_recognition.rb +209 -0
- data/lib/finnhub_ruby/models/price_target.rb +257 -0
- data/lib/finnhub_ruby/models/quote.rb +247 -0
- data/lib/finnhub_ruby/models/recommendation_trend.rb +267 -0
- data/lib/finnhub_ruby/models/report.rb +306 -0
- data/lib/finnhub_ruby/models/revenue_estimates.rb +229 -0
- data/lib/finnhub_ruby/models/sentiment.rb +217 -0
- data/lib/finnhub_ruby/models/split.rb +237 -0
- data/lib/finnhub_ruby/models/stock.rb +227 -0
- data/lib/finnhub_ruby/models/stock_candles.rb +279 -0
- data/lib/finnhub_ruby/models/stock_transcripts.rb +247 -0
- data/lib/finnhub_ruby/models/support_resistance.rb +209 -0
- data/lib/finnhub_ruby/models/technical_analysis.rb +216 -0
- data/lib/finnhub_ruby/models/tick_data.rb +285 -0
- data/lib/finnhub_ruby/models/transcript_content.rb +219 -0
- data/lib/finnhub_ruby/models/transcript_participant.rb +217 -0
- data/lib/finnhub_ruby/models/trend.rb +207 -0
- data/lib/finnhub_ruby/models/upgrade_downgrade.rb +257 -0
- data/lib/finnhub_ruby/version.rb +15 -0
- data/release.sh +2 -0
- data/spec/api/default_api_spec.rb +638 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/aggregate_indicators_spec.rb +47 -0
- data/spec/models/basic_financials_spec.rb +53 -0
- data/spec/models/company_executive_spec.rb +47 -0
- data/spec/models/company_news_statistics_spec.rb +53 -0
- data/spec/models/company_profile2_spec.rb +107 -0
- data/spec/models/company_profile_spec.rb +203 -0
- data/spec/models/company_spec.rb +77 -0
- data/spec/models/country_metadata_spec.rb +71 -0
- data/spec/models/covid_info_spec.rb +59 -0
- data/spec/models/crypto_candles_spec.rb +77 -0
- data/spec/models/crypto_symbol_spec.rb +53 -0
- data/spec/models/development_spec.rb +59 -0
- data/spec/models/dividends_spec.rb +83 -0
- data/spec/models/earning_estimate_spec.rb +65 -0
- data/spec/models/earning_release_spec.rb +89 -0
- data/spec/models/earning_result_spec.rb +59 -0
- data/spec/models/earnings_calendar_spec.rb +41 -0
- data/spec/models/earnings_call_transcripts_list_spec.rb +47 -0
- data/spec/models/earnings_call_transcripts_spec.rb +89 -0
- data/spec/models/earnings_estimates_spec.rb +53 -0
- data/spec/models/economic_calendar_spec.rb +41 -0
- data/spec/models/economic_code_spec.rb +59 -0
- data/spec/models/economic_data_spec.rb +47 -0
- data/spec/models/economic_event_spec.rb +83 -0
- data/spec/models/estimate_spec.rb +65 -0
- data/spec/models/filing_spec.rb +83 -0
- data/spec/models/financial_statements_spec.rb +47 -0
- data/spec/models/financials_as_reported_spec.rb +53 -0
- data/spec/models/forex_candles_spec.rb +77 -0
- data/spec/models/forex_symbol_spec.rb +53 -0
- data/spec/models/forexrates_spec.rb +47 -0
- data/spec/models/fund_ownership_spec.rb +47 -0
- data/spec/models/indicator_spec.rb +53 -0
- data/spec/models/investor_spec.rb +59 -0
- data/spec/models/investors_ownership_spec.rb +47 -0
- data/spec/models/ipo_calendar_spec.rb +41 -0
- data/spec/models/ipo_event_spec.rb +83 -0
- data/spec/models/last_bid_ask_spec.rb +65 -0
- data/spec/models/major_developments_spec.rb +47 -0
- data/spec/models/news_sentiment_spec.rb +71 -0
- data/spec/models/news_spec.rb +89 -0
- data/spec/models/pattern_recognition_spec.rb +41 -0
- data/spec/models/price_target_spec.rb +71 -0
- data/spec/models/quote_spec.rb +65 -0
- data/spec/models/recommendation_trend_spec.rb +77 -0
- data/spec/models/report_spec.rb +101 -0
- data/spec/models/revenue_estimates_spec.rb +53 -0
- data/spec/models/sentiment_spec.rb +47 -0
- data/spec/models/split_spec.rb +59 -0
- data/spec/models/stock_candles_spec.rb +77 -0
- data/spec/models/stock_spec.rb +53 -0
- data/spec/models/stock_transcripts_spec.rb +65 -0
- data/spec/models/support_resistance_spec.rb +41 -0
- data/spec/models/technical_analysis_spec.rb +47 -0
- data/spec/models/tick_data_spec.rb +83 -0
- data/spec/models/transcript_content_spec.rb +47 -0
- data/spec/models/transcript_participant_spec.rb +47 -0
- data/spec/models/trend_spec.rb +41 -0
- data/spec/models/upgrade_downgrade_spec.rb +71 -0
- data/spec/spec_helper.rb +111 -0
- data/test.rb +139 -0
- metadata +364 -0
@@ -0,0 +1,257 @@
|
|
1
|
+
=begin
|
2
|
+
#Finnhub API
|
3
|
+
|
4
|
+
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module FinnhubRuby
|
16
|
+
class UpgradeDowngrade
|
17
|
+
# Company symbol.
|
18
|
+
attr_accessor :symbol
|
19
|
+
|
20
|
+
# Upgrade/downgrade time in UNIX timestamp.
|
21
|
+
attr_accessor :grade_time
|
22
|
+
|
23
|
+
# From grade.
|
24
|
+
attr_accessor :from_grade
|
25
|
+
|
26
|
+
# To grade.
|
27
|
+
attr_accessor :to_grade
|
28
|
+
|
29
|
+
# Company/analyst who did the upgrade/downgrade.
|
30
|
+
attr_accessor :company
|
31
|
+
|
32
|
+
# Action can take any of the following values: <code>up(upgrade), down(downgrade), main(maintains), init(initiate), reit(reiterate)</code>.
|
33
|
+
attr_accessor :action
|
34
|
+
|
35
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
36
|
+
def self.attribute_map
|
37
|
+
{
|
38
|
+
:'symbol' => :'symbol',
|
39
|
+
:'grade_time' => :'gradeTime',
|
40
|
+
:'from_grade' => :'fromGrade',
|
41
|
+
:'to_grade' => :'toGrade',
|
42
|
+
:'company' => :'company',
|
43
|
+
:'action' => :'action'
|
44
|
+
}
|
45
|
+
end
|
46
|
+
|
47
|
+
# Attribute type mapping.
|
48
|
+
def self.openapi_types
|
49
|
+
{
|
50
|
+
:'symbol' => :'String',
|
51
|
+
:'grade_time' => :'Integer',
|
52
|
+
:'from_grade' => :'String',
|
53
|
+
:'to_grade' => :'String',
|
54
|
+
:'company' => :'String',
|
55
|
+
:'action' => :'String'
|
56
|
+
}
|
57
|
+
end
|
58
|
+
|
59
|
+
# List of attributes with nullable: true
|
60
|
+
def self.openapi_nullable
|
61
|
+
Set.new([
|
62
|
+
])
|
63
|
+
end
|
64
|
+
|
65
|
+
# Initializes the object
|
66
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
67
|
+
def initialize(attributes = {})
|
68
|
+
if (!attributes.is_a?(Hash))
|
69
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::UpgradeDowngrade` initialize method"
|
70
|
+
end
|
71
|
+
|
72
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
73
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
74
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
75
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FinnhubRuby::UpgradeDowngrade`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
76
|
+
end
|
77
|
+
h[k.to_sym] = v
|
78
|
+
}
|
79
|
+
|
80
|
+
if attributes.key?(:'symbol')
|
81
|
+
self.symbol = attributes[:'symbol']
|
82
|
+
end
|
83
|
+
|
84
|
+
if attributes.key?(:'grade_time')
|
85
|
+
self.grade_time = attributes[:'grade_time']
|
86
|
+
end
|
87
|
+
|
88
|
+
if attributes.key?(:'from_grade')
|
89
|
+
self.from_grade = attributes[:'from_grade']
|
90
|
+
end
|
91
|
+
|
92
|
+
if attributes.key?(:'to_grade')
|
93
|
+
self.to_grade = attributes[:'to_grade']
|
94
|
+
end
|
95
|
+
|
96
|
+
if attributes.key?(:'company')
|
97
|
+
self.company = attributes[:'company']
|
98
|
+
end
|
99
|
+
|
100
|
+
if attributes.key?(:'action')
|
101
|
+
self.action = attributes[:'action']
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
106
|
+
# @return Array for valid properties with the reasons
|
107
|
+
def list_invalid_properties
|
108
|
+
invalid_properties = Array.new
|
109
|
+
invalid_properties
|
110
|
+
end
|
111
|
+
|
112
|
+
# Check to see if the all the properties in the model are valid
|
113
|
+
# @return true if the model is valid
|
114
|
+
def valid?
|
115
|
+
true
|
116
|
+
end
|
117
|
+
|
118
|
+
# Checks equality by comparing each attribute.
|
119
|
+
# @param [Object] Object to be compared
|
120
|
+
def ==(o)
|
121
|
+
return true if self.equal?(o)
|
122
|
+
self.class == o.class &&
|
123
|
+
symbol == o.symbol &&
|
124
|
+
grade_time == o.grade_time &&
|
125
|
+
from_grade == o.from_grade &&
|
126
|
+
to_grade == o.to_grade &&
|
127
|
+
company == o.company &&
|
128
|
+
action == o.action
|
129
|
+
end
|
130
|
+
|
131
|
+
# @see the `==` method
|
132
|
+
# @param [Object] Object to be compared
|
133
|
+
def eql?(o)
|
134
|
+
self == o
|
135
|
+
end
|
136
|
+
|
137
|
+
# Calculates hash code according to all attributes.
|
138
|
+
# @return [Integer] Hash code
|
139
|
+
def hash
|
140
|
+
[symbol, grade_time, from_grade, to_grade, company, action].hash
|
141
|
+
end
|
142
|
+
|
143
|
+
# Builds the object from hash
|
144
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
145
|
+
# @return [Object] Returns the model itself
|
146
|
+
def self.build_from_hash(attributes)
|
147
|
+
new.build_from_hash(attributes)
|
148
|
+
end
|
149
|
+
|
150
|
+
# Builds the object from hash
|
151
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
152
|
+
# @return [Object] Returns the model itself
|
153
|
+
def build_from_hash(attributes)
|
154
|
+
return nil unless attributes.is_a?(Hash)
|
155
|
+
self.class.openapi_types.each_pair do |key, type|
|
156
|
+
if type =~ /\AArray<(.*)>/i
|
157
|
+
# check to ensure the input is an array given that the attribute
|
158
|
+
# is documented as an array but the input is not
|
159
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
160
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
161
|
+
end
|
162
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
163
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
164
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
165
|
+
end
|
166
|
+
|
167
|
+
self
|
168
|
+
end
|
169
|
+
|
170
|
+
# Deserializes the data based on type
|
171
|
+
# @param string type Data type
|
172
|
+
# @param string value Value to be deserialized
|
173
|
+
# @return [Object] Deserialized data
|
174
|
+
def _deserialize(type, value)
|
175
|
+
case type.to_sym
|
176
|
+
when :DateTime
|
177
|
+
DateTime.parse(value)
|
178
|
+
when :Date
|
179
|
+
Date.parse(value)
|
180
|
+
when :String
|
181
|
+
value.to_s
|
182
|
+
when :Integer
|
183
|
+
value.to_i
|
184
|
+
when :Float
|
185
|
+
value.to_f
|
186
|
+
when :Boolean
|
187
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
188
|
+
true
|
189
|
+
else
|
190
|
+
false
|
191
|
+
end
|
192
|
+
when :Object
|
193
|
+
# generic object (usually a Hash), return directly
|
194
|
+
value
|
195
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
196
|
+
inner_type = Regexp.last_match[:inner_type]
|
197
|
+
value.map { |v| _deserialize(inner_type, v) }
|
198
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
199
|
+
k_type = Regexp.last_match[:k_type]
|
200
|
+
v_type = Regexp.last_match[:v_type]
|
201
|
+
{}.tap do |hash|
|
202
|
+
value.each do |k, v|
|
203
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
204
|
+
end
|
205
|
+
end
|
206
|
+
else # model
|
207
|
+
FinnhubRuby.const_get(type).build_from_hash(value)
|
208
|
+
end
|
209
|
+
end
|
210
|
+
|
211
|
+
# Returns the string representation of the object
|
212
|
+
# @return [String] String presentation of the object
|
213
|
+
def to_s
|
214
|
+
to_hash.to_s
|
215
|
+
end
|
216
|
+
|
217
|
+
# to_body is an alias to to_hash (backward compatibility)
|
218
|
+
# @return [Hash] Returns the object in the form of hash
|
219
|
+
def to_body
|
220
|
+
to_hash
|
221
|
+
end
|
222
|
+
|
223
|
+
# Returns the object in the form of hash
|
224
|
+
# @return [Hash] Returns the object in the form of hash
|
225
|
+
def to_hash
|
226
|
+
hash = {}
|
227
|
+
self.class.attribute_map.each_pair do |attr, param|
|
228
|
+
value = self.send(attr)
|
229
|
+
if value.nil?
|
230
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
231
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
232
|
+
end
|
233
|
+
|
234
|
+
hash[param] = _to_hash(value)
|
235
|
+
end
|
236
|
+
hash
|
237
|
+
end
|
238
|
+
|
239
|
+
# Outputs non-array value in the form of hash
|
240
|
+
# For object, use to_hash. Otherwise, just return the value
|
241
|
+
# @param [Object] value Any valid value
|
242
|
+
# @return [Hash] Returns the value in the form of hash
|
243
|
+
def _to_hash(value)
|
244
|
+
if value.is_a?(Array)
|
245
|
+
value.compact.map { |v| _to_hash(v) }
|
246
|
+
elsif value.is_a?(Hash)
|
247
|
+
{}.tap do |hash|
|
248
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
249
|
+
end
|
250
|
+
elsif value.respond_to? :to_hash
|
251
|
+
value.to_hash
|
252
|
+
else
|
253
|
+
value
|
254
|
+
end
|
255
|
+
end
|
256
|
+
end
|
257
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
=begin
|
2
|
+
#Finnhub API
|
3
|
+
|
4
|
+
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
module FinnhubRuby
|
14
|
+
VERSION = '1.0.0'
|
15
|
+
end
|
data/release.sh
ADDED
@@ -0,0 +1,638 @@
|
|
1
|
+
=begin
|
2
|
+
#Finnhub API
|
3
|
+
|
4
|
+
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for FinnhubRuby::DefaultApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'DefaultApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = FinnhubRuby::DefaultApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of DefaultApi' do
|
30
|
+
it 'should create an instance of DefaultApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(FinnhubRuby::DefaultApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for aggregate_indicator
|
36
|
+
# Aggregate Indicators
|
37
|
+
# Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v.
|
38
|
+
# @param symbol symbol
|
39
|
+
# @param resolution Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [AggregateIndicators]
|
42
|
+
describe 'aggregate_indicator test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for company_basic_financials
|
49
|
+
# Basic Financials
|
50
|
+
# Get company basic financials such as margin, P/E ratio, 52-week high/low etc.
|
51
|
+
# @param symbol Symbol of the company: AAPL.
|
52
|
+
# @param metric Metric type. Can be 1 of the following values <code>all, price, valuation, margin</code>
|
53
|
+
# @param [Hash] opts the optional parameters
|
54
|
+
# @return [BasicFinancials]
|
55
|
+
describe 'company_basic_financials test' do
|
56
|
+
it 'should work' do
|
57
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
# unit tests for company_earnings
|
62
|
+
# Earnings Surprises
|
63
|
+
# Get company historical quarterly earnings surprise going back to 2000.
|
64
|
+
# @param symbol Symbol of the company: AAPL.
|
65
|
+
# @param [Hash] opts the optional parameters
|
66
|
+
# @option opts [Integer] :limit Limit number of period returned. Leave blank to get the full history.
|
67
|
+
# @return [Array<EarningResult>]
|
68
|
+
describe 'company_earnings test' do
|
69
|
+
it 'should work' do
|
70
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# unit tests for company_eps_estimates
|
75
|
+
# Earnings Estimates
|
76
|
+
# Get company's EPS estimates.
|
77
|
+
# @param symbol Symbol of the company: AAPL.
|
78
|
+
# @param [Hash] opts the optional parameters
|
79
|
+
# @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
80
|
+
# @return [EarningsEstimates]
|
81
|
+
describe 'company_eps_estimates test' do
|
82
|
+
it 'should work' do
|
83
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# unit tests for company_executive
|
88
|
+
# Company Executive
|
89
|
+
# Get a list of company's executives and members of the Board.
|
90
|
+
# @param symbol Symbol of the company: AAPL.
|
91
|
+
# @param [Hash] opts the optional parameters
|
92
|
+
# @return [CompanyExecutive]
|
93
|
+
describe 'company_executive test' do
|
94
|
+
it 'should work' do
|
95
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
# unit tests for company_news
|
100
|
+
# Company News
|
101
|
+
# List latest company news by symbol. This endpoint is only available for North American companies.
|
102
|
+
# @param symbol Company symbol.
|
103
|
+
# @param from From date <code>YYYY-MM-DD</code>.
|
104
|
+
# @param to To date <code>YYYY-MM-DD</code>.
|
105
|
+
# @param [Hash] opts the optional parameters
|
106
|
+
# @return [Array<News>]
|
107
|
+
describe 'company_news test' do
|
108
|
+
it 'should work' do
|
109
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
# unit tests for company_peers
|
114
|
+
# Peers
|
115
|
+
# Get company peers. Return a list of peers in the same country and GICS sub-industry
|
116
|
+
# @param symbol Symbol of the company: AAPL.
|
117
|
+
# @param [Hash] opts the optional parameters
|
118
|
+
# @return [Array<String>]
|
119
|
+
describe 'company_peers test' do
|
120
|
+
it 'should work' do
|
121
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
# unit tests for company_profile
|
126
|
+
# Company Profile
|
127
|
+
# Get general information of a company. You can query by symbol, ISIN or CUSIP
|
128
|
+
# @param [Hash] opts the optional parameters
|
129
|
+
# @option opts [String] :symbol Symbol of the company: AAPL e.g.
|
130
|
+
# @option opts [String] :isin ISIN
|
131
|
+
# @option opts [String] :cusip CUSIP
|
132
|
+
# @return [CompanyProfile]
|
133
|
+
describe 'company_profile test' do
|
134
|
+
it 'should work' do
|
135
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
136
|
+
end
|
137
|
+
end
|
138
|
+
|
139
|
+
# unit tests for company_profile2
|
140
|
+
# Company Profile 2
|
141
|
+
# Get general information of a company. You can query by symbol, ISIN or CUSIP. This is the free version of <a href=\"#company-profile\">Company Profile</a>.
|
142
|
+
# @param [Hash] opts the optional parameters
|
143
|
+
# @option opts [String] :symbol Symbol of the company: AAPL e.g.
|
144
|
+
# @option opts [String] :isin ISIN
|
145
|
+
# @option opts [String] :cusip CUSIP
|
146
|
+
# @return [CompanyProfile2]
|
147
|
+
describe 'company_profile2 test' do
|
148
|
+
it 'should work' do
|
149
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
# unit tests for company_revenue_estimates
|
154
|
+
# Revenue Estimates
|
155
|
+
# Get company's revenue estimates.
|
156
|
+
# @param symbol Symbol of the company: AAPL.
|
157
|
+
# @param [Hash] opts the optional parameters
|
158
|
+
# @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
159
|
+
# @return [RevenueEstimates]
|
160
|
+
describe 'company_revenue_estimates test' do
|
161
|
+
it 'should work' do
|
162
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# unit tests for country
|
167
|
+
# Country Metadata
|
168
|
+
# List all countries and metadata.
|
169
|
+
# @param [Hash] opts the optional parameters
|
170
|
+
# @return [Array<CountryMetadata>]
|
171
|
+
describe 'country test' do
|
172
|
+
it 'should work' do
|
173
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
# unit tests for covid19
|
178
|
+
# COVID-19
|
179
|
+
# Get real-time updates on the number of COVID-19 (Corona virus) cases in the US with a state-by-state breakdown. Data is sourced from CDC and reputable sources. You can also access this API <a href=\"https://rapidapi.com/Finnhub/api/finnhub-real-time-covid-19\" target=\"_blank\" rel=\"nofollow\">here</a>
|
180
|
+
# @param [Hash] opts the optional parameters
|
181
|
+
# @return [Array<CovidInfo>]
|
182
|
+
describe 'covid19 test' do
|
183
|
+
it 'should work' do
|
184
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
185
|
+
end
|
186
|
+
end
|
187
|
+
|
188
|
+
# unit tests for crypto_candles
|
189
|
+
# Crypto Candles
|
190
|
+
# Get candlestick data for crypto symbols.
|
191
|
+
# @param symbol Use symbol returned in <code>/crypto/symbol</code> endpoint for this field.
|
192
|
+
# @param resolution Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
193
|
+
# @param from UNIX timestamp. Interval initial value.
|
194
|
+
# @param to UNIX timestamp. Interval end value.
|
195
|
+
# @param [Hash] opts the optional parameters
|
196
|
+
# @return [CryptoCandles]
|
197
|
+
describe 'crypto_candles test' do
|
198
|
+
it 'should work' do
|
199
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
# unit tests for crypto_exchanges
|
204
|
+
# Crypto Exchanges
|
205
|
+
# List supported crypto exchanges
|
206
|
+
# @param [Hash] opts the optional parameters
|
207
|
+
# @return [Array<String>]
|
208
|
+
describe 'crypto_exchanges test' do
|
209
|
+
it 'should work' do
|
210
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
211
|
+
end
|
212
|
+
end
|
213
|
+
|
214
|
+
# unit tests for crypto_symbols
|
215
|
+
# Crypto Symbol
|
216
|
+
# List supported crypto symbols by exchange
|
217
|
+
# @param exchange Exchange you want to get the list of symbols from.
|
218
|
+
# @param [Hash] opts the optional parameters
|
219
|
+
# @return [Array<CryptoSymbol>]
|
220
|
+
describe 'crypto_symbols test' do
|
221
|
+
it 'should work' do
|
222
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
223
|
+
end
|
224
|
+
end
|
225
|
+
|
226
|
+
# unit tests for earnings_calendar
|
227
|
+
# Earnings Calendar
|
228
|
+
# Get historical and coming earnings release dating back to 2003. You can setup <a href=\"#webhook\">webhook</a> to receive real-time earnings update.
|
229
|
+
# @param [Hash] opts the optional parameters
|
230
|
+
# @option opts [Date] :from From date: 2020-03-15.
|
231
|
+
# @option opts [Date] :to To date: 2020-03-16.
|
232
|
+
# @option opts [String] :symbol Filter by symbol: AAPL.
|
233
|
+
# @option opts [AnyType] :international Set to <code>true</code> to include international markets. Default value is <code>false</code>
|
234
|
+
# @return [EarningsCalendar]
|
235
|
+
describe 'earnings_calendar test' do
|
236
|
+
it 'should work' do
|
237
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
241
|
+
# unit tests for economic_code
|
242
|
+
# Economic Code
|
243
|
+
# List codes of supported economic data.
|
244
|
+
# @param [Hash] opts the optional parameters
|
245
|
+
# @return [Array<EconomicCode>]
|
246
|
+
describe 'economic_code test' do
|
247
|
+
it 'should work' do
|
248
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
249
|
+
end
|
250
|
+
end
|
251
|
+
|
252
|
+
# unit tests for economic_data
|
253
|
+
# Economic Data
|
254
|
+
# Get economic data.
|
255
|
+
# @param code Economic code.
|
256
|
+
# @param [Hash] opts the optional parameters
|
257
|
+
# @return [EconomicData]
|
258
|
+
describe 'economic_data test' do
|
259
|
+
it 'should work' do
|
260
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
261
|
+
end
|
262
|
+
end
|
263
|
+
|
264
|
+
# unit tests for filings
|
265
|
+
# Filings
|
266
|
+
# List company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/sec-filings\" target=\"_blank\">Kaggle SEC Filings database</a>.
|
267
|
+
# @param [Hash] opts the optional parameters
|
268
|
+
# @option opts [String] :symbol Symbol. Leave <code>symbol</code>,<code>cik</code> and <code>accessNumber</code> empty to list latest filings.
|
269
|
+
# @option opts [String] :cik CIK.
|
270
|
+
# @option opts [String] :access_number Access number of a specific report you want to retrieve data from.
|
271
|
+
# @option opts [String] :form Filter by form. You can use this value <code>NT 10-K</code> to find non-timely filings for a company.
|
272
|
+
# @option opts [Date] :from From date: 2020-03-15.
|
273
|
+
# @option opts [Date] :to To date: 2020-03-16.
|
274
|
+
# @return [Array<Filing>]
|
275
|
+
describe 'filings test' do
|
276
|
+
it 'should work' do
|
277
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
278
|
+
end
|
279
|
+
end
|
280
|
+
|
281
|
+
# unit tests for financials
|
282
|
+
# Financial Statements
|
283
|
+
# Get standardized balance sheet, income statement and cash flow for global companies going back 30+ years.
|
284
|
+
# @param symbol Symbol of the company: AAPL.
|
285
|
+
# @param statement Statement can take 1 of these values <code>bs, ic, cf</code> for Balance Sheet, Income Statement, Cash Flow respectively.
|
286
|
+
# @param freq Frequency can take 1 of these values <code>annual, quarterly, ttm, ytd</code>. TTM (Trailing Twelve Months) option is available for Income Statement and Cash Flow. YTD (Year To Date) option is only available for Cash Flow.
|
287
|
+
# @param [Hash] opts the optional parameters
|
288
|
+
# @return [FinancialStatements]
|
289
|
+
describe 'financials test' do
|
290
|
+
it 'should work' do
|
291
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
292
|
+
end
|
293
|
+
end
|
294
|
+
|
295
|
+
# unit tests for financials_reported
|
296
|
+
# Financials As Reported
|
297
|
+
# Get financials as reported. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/reported-financials\" target=\"_blank\">Kaggle SEC Financials database</a>.
|
298
|
+
# @param [Hash] opts the optional parameters
|
299
|
+
# @option opts [String] :symbol Symbol.
|
300
|
+
# @option opts [String] :cik CIK.
|
301
|
+
# @option opts [String] :access_number Access number of a specific report you want to retrieve financials from.
|
302
|
+
# @option opts [String] :freq Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
|
303
|
+
# @return [FinancialsAsReported]
|
304
|
+
describe 'financials_reported test' do
|
305
|
+
it 'should work' do
|
306
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
307
|
+
end
|
308
|
+
end
|
309
|
+
|
310
|
+
# unit tests for forex_candles
|
311
|
+
# Forex Candles
|
312
|
+
# Get candlestick data for forex symbols.
|
313
|
+
# @param symbol Use symbol returned in <code>/forex/symbol</code> endpoint for this field.
|
314
|
+
# @param resolution Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
315
|
+
# @param from UNIX timestamp. Interval initial value.
|
316
|
+
# @param to UNIX timestamp. Interval end value.
|
317
|
+
# @param [Hash] opts the optional parameters
|
318
|
+
# @return [ForexCandles]
|
319
|
+
describe 'forex_candles test' do
|
320
|
+
it 'should work' do
|
321
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
322
|
+
end
|
323
|
+
end
|
324
|
+
|
325
|
+
# unit tests for forex_exchanges
|
326
|
+
# Forex Exchanges
|
327
|
+
# List supported forex exchanges
|
328
|
+
# @param [Hash] opts the optional parameters
|
329
|
+
# @return [Array<String>]
|
330
|
+
describe 'forex_exchanges test' do
|
331
|
+
it 'should work' do
|
332
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
333
|
+
end
|
334
|
+
end
|
335
|
+
|
336
|
+
# unit tests for forex_rates
|
337
|
+
# Forex rates
|
338
|
+
# Get rates for all forex pairs. Ideal for currency conversion
|
339
|
+
# @param [Hash] opts the optional parameters
|
340
|
+
# @option opts [String] :base Base currency. Default to EUR.
|
341
|
+
# @return [Forexrates]
|
342
|
+
describe 'forex_rates test' do
|
343
|
+
it 'should work' do
|
344
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
345
|
+
end
|
346
|
+
end
|
347
|
+
|
348
|
+
# unit tests for forex_symbols
|
349
|
+
# Forex Symbol
|
350
|
+
# List supported forex symbols.
|
351
|
+
# @param exchange Exchange you want to get the list of symbols from.
|
352
|
+
# @param [Hash] opts the optional parameters
|
353
|
+
# @return [Array<ForexSymbol>]
|
354
|
+
describe 'forex_symbols test' do
|
355
|
+
it 'should work' do
|
356
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
357
|
+
end
|
358
|
+
end
|
359
|
+
|
360
|
+
# unit tests for fund_ownership
|
361
|
+
# Fund Ownership
|
362
|
+
# Get a full list fund and institutional investors of a company in descending order of the number of shares held.
|
363
|
+
# @param symbol Symbol of the company: AAPL.
|
364
|
+
# @param [Hash] opts the optional parameters
|
365
|
+
# @option opts [Integer] :limit Limit number of results. Leave empty to get the full list.
|
366
|
+
# @return [FundOwnership]
|
367
|
+
describe 'fund_ownership test' do
|
368
|
+
it 'should work' do
|
369
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
370
|
+
end
|
371
|
+
end
|
372
|
+
|
373
|
+
# unit tests for general_news
|
374
|
+
# General News
|
375
|
+
# Get latest market news.
|
376
|
+
# @param category This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
377
|
+
# @param [Hash] opts the optional parameters
|
378
|
+
# @option opts [String] :min_id Use this field to get only news after this ID. Default to 0
|
379
|
+
# @return [Array<News>]
|
380
|
+
describe 'general_news test' do
|
381
|
+
it 'should work' do
|
382
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
383
|
+
end
|
384
|
+
end
|
385
|
+
|
386
|
+
# unit tests for investors_ownership
|
387
|
+
# Investors Ownership
|
388
|
+
# Get a full list of shareholders/investors of a company in descending order of the number of shares held.
|
389
|
+
# @param symbol Symbol of the company: AAPL.
|
390
|
+
# @param [Hash] opts the optional parameters
|
391
|
+
# @option opts [Integer] :limit Limit number of results. Leave empty to get the full list.
|
392
|
+
# @return [InvestorsOwnership]
|
393
|
+
describe 'investors_ownership test' do
|
394
|
+
it 'should work' do
|
395
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
396
|
+
end
|
397
|
+
end
|
398
|
+
|
399
|
+
# unit tests for ipo_calendar
|
400
|
+
# IPO Calendar
|
401
|
+
# Get recent and coming IPO.
|
402
|
+
# @param from From date: 2020-03-15.
|
403
|
+
# @param to To date: 2020-03-16.
|
404
|
+
# @param [Hash] opts the optional parameters
|
405
|
+
# @return [IPOCalendar]
|
406
|
+
describe 'ipo_calendar test' do
|
407
|
+
it 'should work' do
|
408
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
409
|
+
end
|
410
|
+
end
|
411
|
+
|
412
|
+
# unit tests for major_developments
|
413
|
+
# Major Developments
|
414
|
+
# List latest major developments of a company going back 20 years with 12M+ data points. This data can be used to highlight the most significant events.
|
415
|
+
# @param symbol Company symbol.
|
416
|
+
# @param [Hash] opts the optional parameters
|
417
|
+
# @option opts [Date] :from From time: 2020-01-01.
|
418
|
+
# @option opts [Date] :to To time: 2020-01-05.
|
419
|
+
# @return [MajorDevelopments]
|
420
|
+
describe 'major_developments test' do
|
421
|
+
it 'should work' do
|
422
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
423
|
+
end
|
424
|
+
end
|
425
|
+
|
426
|
+
# unit tests for news_sentiment
|
427
|
+
# News Sentiment
|
428
|
+
# Get company's news sentiment and statistics. This endpoint is only available for US companies.
|
429
|
+
# @param symbol Company symbol.
|
430
|
+
# @param [Hash] opts the optional parameters
|
431
|
+
# @return [NewsSentiment]
|
432
|
+
describe 'news_sentiment test' do
|
433
|
+
it 'should work' do
|
434
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
435
|
+
end
|
436
|
+
end
|
437
|
+
|
438
|
+
# unit tests for pattern_recognition
|
439
|
+
# Pattern Recognition
|
440
|
+
# Run pattern recognition algorithm on a symbol. Support double top/bottom, triple top/bottom, head and shoulders, triangle, wedge, channel, flag, and candlestick patterns.
|
441
|
+
# @param symbol Symbol
|
442
|
+
# @param resolution Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
443
|
+
# @param [Hash] opts the optional parameters
|
444
|
+
# @return [PatternRecognition]
|
445
|
+
describe 'pattern_recognition test' do
|
446
|
+
it 'should work' do
|
447
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
448
|
+
end
|
449
|
+
end
|
450
|
+
|
451
|
+
# unit tests for price_target
|
452
|
+
# Price Target
|
453
|
+
# Get latest price target consensus.
|
454
|
+
# @param symbol Symbol of the company: AAPL.
|
455
|
+
# @param [Hash] opts the optional parameters
|
456
|
+
# @return [PriceTarget]
|
457
|
+
describe 'price_target test' do
|
458
|
+
it 'should work' do
|
459
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
460
|
+
end
|
461
|
+
end
|
462
|
+
|
463
|
+
# unit tests for quote
|
464
|
+
# Quote
|
465
|
+
# <p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time update.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
|
466
|
+
# @param symbol Symbol
|
467
|
+
# @param [Hash] opts the optional parameters
|
468
|
+
# @return [Quote]
|
469
|
+
describe 'quote test' do
|
470
|
+
it 'should work' do
|
471
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
472
|
+
end
|
473
|
+
end
|
474
|
+
|
475
|
+
# unit tests for recommendation_trends
|
476
|
+
# Recommendation Trends
|
477
|
+
# Get latest analyst recommendation trends for a company.
|
478
|
+
# @param symbol Symbol of the company: AAPL.
|
479
|
+
# @param [Hash] opts the optional parameters
|
480
|
+
# @return [Array<RecommendationTrend>]
|
481
|
+
describe 'recommendation_trends test' do
|
482
|
+
it 'should work' do
|
483
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
484
|
+
end
|
485
|
+
end
|
486
|
+
|
487
|
+
# unit tests for stock_bidask
|
488
|
+
# Last Bid-Ask
|
489
|
+
# Get last bid/ask data for US stocks.
|
490
|
+
# @param symbol Symbol.
|
491
|
+
# @param [Hash] opts the optional parameters
|
492
|
+
# @return [LastBidAsk]
|
493
|
+
describe 'stock_bidask test' do
|
494
|
+
it 'should work' do
|
495
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
496
|
+
end
|
497
|
+
end
|
498
|
+
|
499
|
+
# unit tests for stock_candles
|
500
|
+
# Stock Candles
|
501
|
+
# <p>Get candlestick data for stocks going back 25 years for US stocks.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
|
502
|
+
# @param symbol Symbol.
|
503
|
+
# @param resolution Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
504
|
+
# @param from UNIX timestamp. Interval initial value.
|
505
|
+
# @param to UNIX timestamp. Interval end value.
|
506
|
+
# @param [Hash] opts the optional parameters
|
507
|
+
# @option opts [String] :adjusted By default, <code>adjusted=false</code>. Use <code>true</code> to get adjusted data.
|
508
|
+
# @return [StockCandles]
|
509
|
+
describe 'stock_candles test' do
|
510
|
+
it 'should work' do
|
511
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
512
|
+
end
|
513
|
+
end
|
514
|
+
|
515
|
+
# unit tests for stock_dividends
|
516
|
+
# Dividends
|
517
|
+
# Get dividends data for common stocks going back 30 years.
|
518
|
+
# @param symbol Symbol.
|
519
|
+
# @param from YYYY-MM-DD.
|
520
|
+
# @param to YYYY-MM-DD.
|
521
|
+
# @param [Hash] opts the optional parameters
|
522
|
+
# @return [Array<Dividends>]
|
523
|
+
describe 'stock_dividends test' do
|
524
|
+
it 'should work' do
|
525
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
526
|
+
end
|
527
|
+
end
|
528
|
+
|
529
|
+
# unit tests for stock_splits
|
530
|
+
# Splits
|
531
|
+
# Get splits data for stocks.
|
532
|
+
# @param symbol Symbol.
|
533
|
+
# @param from YYYY-MM-DD.
|
534
|
+
# @param to YYYY-MM-DD.
|
535
|
+
# @param [Hash] opts the optional parameters
|
536
|
+
# @return [Array<Split>]
|
537
|
+
describe 'stock_splits test' do
|
538
|
+
it 'should work' do
|
539
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
540
|
+
end
|
541
|
+
end
|
542
|
+
|
543
|
+
# unit tests for stock_symbols
|
544
|
+
# Stock Symbol
|
545
|
+
# List supported stocks.
|
546
|
+
# @param exchange Exchange you want to get the list of symbols from. List of exchanges with fundamental data can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.
|
547
|
+
# @param [Hash] opts the optional parameters
|
548
|
+
# @return [Array<Stock>]
|
549
|
+
describe 'stock_symbols test' do
|
550
|
+
it 'should work' do
|
551
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
552
|
+
end
|
553
|
+
end
|
554
|
+
|
555
|
+
# unit tests for stock_tick
|
556
|
+
# Tick Data
|
557
|
+
# <p>Get historical tick data for US stocks from all 13 exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server. Data is updated at the end of each trading day.</p><p>Tick data from 1985 is available for Enterprise clients. <a href=\"mailto:support@finnhub.io\">Contact us</a> to learn more.</p>
|
558
|
+
# @param symbol Symbol.
|
559
|
+
# @param date Date: 2020-04-02.
|
560
|
+
# @param limit Limit number of ticks returned. Maximum value: <code>25000</code>
|
561
|
+
# @param skip Number of ticks to skip. Use this parameter to loop through the entire data.
|
562
|
+
# @param [Hash] opts the optional parameters
|
563
|
+
# @return [TickData]
|
564
|
+
describe 'stock_tick test' do
|
565
|
+
it 'should work' do
|
566
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
567
|
+
end
|
568
|
+
end
|
569
|
+
|
570
|
+
# unit tests for support_resistance
|
571
|
+
# Support/Resistance
|
572
|
+
# Get support and resistance levels for a symbol.
|
573
|
+
# @param symbol Symbol
|
574
|
+
# @param resolution Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
575
|
+
# @param [Hash] opts the optional parameters
|
576
|
+
# @return [SupportResistance]
|
577
|
+
describe 'support_resistance test' do
|
578
|
+
it 'should work' do
|
579
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
580
|
+
end
|
581
|
+
end
|
582
|
+
|
583
|
+
# unit tests for technical_indicator
|
584
|
+
# Technical Indicators
|
585
|
+
# Return technical indicator with price data. List of supported indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.
|
586
|
+
# @param symbol symbol
|
587
|
+
# @param resolution Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
588
|
+
# @param from UNIX timestamp. Interval initial value.
|
589
|
+
# @param to UNIX timestamp. Interval end value.
|
590
|
+
# @param indicator Indicator name. Full list can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.
|
591
|
+
# @param [Hash] opts the optional parameters
|
592
|
+
# @option opts [Object] :indicator_fields Check out <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">this page</a> to see which indicators and params are supported.
|
593
|
+
# @return [Object]
|
594
|
+
describe 'technical_indicator test' do
|
595
|
+
it 'should work' do
|
596
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
597
|
+
end
|
598
|
+
end
|
599
|
+
|
600
|
+
# unit tests for transcripts
|
601
|
+
# Earnings Call Transcripts
|
602
|
+
# <p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US companies. <p>17+ years of data is available with 170,000+ audio which add up to 6TB in size.</p>
|
603
|
+
# @param id Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
604
|
+
# @param [Hash] opts the optional parameters
|
605
|
+
# @return [EarningsCallTranscripts]
|
606
|
+
describe 'transcripts test' do
|
607
|
+
it 'should work' do
|
608
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
609
|
+
end
|
610
|
+
end
|
611
|
+
|
612
|
+
# unit tests for transcripts_list
|
613
|
+
# Earnings Call Transcripts List
|
614
|
+
# List earnings call transcripts' metadata. This endpoint is only available for US companies.
|
615
|
+
# @param symbol Company symbol: AAPL. Leave empty to list the latest transcripts
|
616
|
+
# @param [Hash] opts the optional parameters
|
617
|
+
# @return [EarningsCallTranscriptsList]
|
618
|
+
describe 'transcripts_list test' do
|
619
|
+
it 'should work' do
|
620
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
621
|
+
end
|
622
|
+
end
|
623
|
+
|
624
|
+
# unit tests for upgrade_downgrade
|
625
|
+
# Stock Upgrade/Downgrade
|
626
|
+
# Get latest stock upgrade and downgrade.
|
627
|
+
# @param [Hash] opts the optional parameters
|
628
|
+
# @option opts [String] :symbol Symbol of the company: AAPL. If left blank, the API will return latest stock upgrades/downgrades.
|
629
|
+
# @option opts [Date] :from From date: 2000-03-15.
|
630
|
+
# @option opts [Date] :to To date: 2020-03-16.
|
631
|
+
# @return [Array<UpgradeDowngrade>]
|
632
|
+
describe 'upgrade_downgrade test' do
|
633
|
+
it 'should work' do
|
634
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
635
|
+
end
|
636
|
+
end
|
637
|
+
|
638
|
+
end
|