finnhub_ruby 1.1.14 → 1.1.17

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/BondCandles.md +22 -0
  4. data/docs/BondProfile.md +58 -0
  5. data/docs/Company.md +1 -1
  6. data/docs/DefaultApi.md +382 -4
  7. data/docs/KeyCustomersSuppliers.md +4 -0
  8. data/docs/LobbyingData.md +46 -0
  9. data/docs/LobbyingResult.md +20 -0
  10. data/docs/MutualFundProfileData.md +5 -1
  11. data/docs/SectorMetric.md +20 -0
  12. data/docs/SectorMetricData.md +20 -0
  13. data/docs/UsaSpending.md +56 -0
  14. data/docs/UsaSpendingResult.md +20 -0
  15. data/finnhub_ruby-1.1.14.gem +0 -0
  16. data/finnhub_ruby-1.1.15.gem +0 -0
  17. data/finnhub_ruby-1.1.16.gem +0 -0
  18. data/lib/finnhub_ruby/api/default_api.rb +372 -8
  19. data/lib/finnhub_ruby/models/bond_candles.rb +243 -0
  20. data/lib/finnhub_ruby/models/bond_profile.rb +419 -0
  21. data/lib/finnhub_ruby/models/company.rb +1 -1
  22. data/lib/finnhub_ruby/models/key_customers_suppliers.rb +21 -1
  23. data/lib/finnhub_ruby/models/lobbying_data.rb +359 -0
  24. data/lib/finnhub_ruby/models/lobbying_result.rb +231 -0
  25. data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +24 -4
  26. data/lib/finnhub_ruby/models/sector_metric.rb +231 -0
  27. data/lib/finnhub_ruby/models/sector_metric_data.rb +229 -0
  28. data/lib/finnhub_ruby/models/usa_spending.rb +409 -0
  29. data/lib/finnhub_ruby/models/usa_spending_result.rb +231 -0
  30. data/lib/finnhub_ruby/version.rb +1 -1
  31. data/lib/finnhub_ruby.rb +8 -0
  32. data/spec/models/bond_candles_spec.rb +46 -0
  33. data/spec/models/bond_profile_spec.rb +154 -0
  34. data/spec/models/lobbying_data_spec.rb +118 -0
  35. data/spec/models/lobbying_result_spec.rb +40 -0
  36. data/spec/models/sector_metric_data_spec.rb +40 -0
  37. data/spec/models/sector_metric_spec.rb +40 -0
  38. data/spec/models/usa_spending_result_spec.rb +40 -0
  39. data/spec/models/usa_spending_spec.rb +148 -0
  40. metadata +37 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: da30940be0c21631a723ce3fefafb49bf48d79bad357b9a95d6b44124aea729a
4
- data.tar.gz: b17728b586b1368112477733e416f0d5d196688a243549255c17fb8ea2a8aaa1
3
+ metadata.gz: 840da9e6e0893fda73e5b4ee3943a54a5a5e54d9163ff43b4a7a8925e4db121a
4
+ data.tar.gz: 2cc86c1ecc481e58b0df75ada3bc472c54baf83dd20e1cffb1f185feda1ca955
5
5
  SHA512:
6
- metadata.gz: 224c15f4a06ec436c4569f47d2000a13185e52f02bf2763311e00d63523006609fbc09db5f08068c3fa41fcb05c0e7205ba961a9e37fc32f58b6a9f1322e2426
7
- data.tar.gz: e1d0cde8725213b7bf9c6b09b17d5ed1768be82c2a8b602038b9f14f2add4f73235170737aeaca4aa0aab0a8c0e0e0d7a7224b0174bbc8ce4a531468a87e338c
6
+ metadata.gz: c7cc0a9a720915e41db73ec91cfec803454ddd3962ab6bde38dc60a84a1dd4fc18b4749e903ec34f1ba0f2f6e6d4353728a141defd3137649075fe558ccd32e1
7
+ data.tar.gz: 62ab3be671f5dca7b274a361fca6695dd3c3e7fed067f716303fc561e54f81ea17bf6a1c5f0084feaece85ac5fbb2fdc13a3d62d5c355f07faf9ccaede3f470c
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # finnhub-ruby
2
2
  - API documentation: https://finnhub.io/docs/api
3
3
  - API version: 1.0.0
4
- - Package version: 1.1.13
4
+ - Package version: 1.1.17
5
5
 
6
6
  ## Installation
7
7
  https://rubygems.org/gems/finnhub_ruby
@@ -13,7 +13,7 @@ gem install finnhub_ruby
13
13
  or in your Gemfile
14
14
 
15
15
  ```ruby
16
- gem 'finnhub_ruby', '~> 1.1.13'
16
+ gem 'finnhub_ruby', '~> 1.1.17'
17
17
  ```
18
18
 
19
19
  ## Getting Started
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::BondCandles
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **c** | **Array<Float>** | List of close prices for returned candles. | [optional] |
8
+ | **t** | **Array<Integer>** | List of timestamp for returned candles. | [optional] |
9
+ | **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::BondCandles.new(
17
+ c: null,
18
+ t: null,
19
+ s: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,58 @@
1
+ # FinnhubRuby::BondProfile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **isin** | **String** | ISIN. | [optional] |
8
+ | **cusip** | **String** | Cusip. | [optional] |
9
+ | **figi** | **String** | FIGI. | [optional] |
10
+ | **coupon** | **Float** | Coupon. | [optional] |
11
+ | **maturity_date** | **String** | Period. | [optional] |
12
+ | **offering_price** | **Float** | Offering price. | [optional] |
13
+ | **issue_date** | **String** | Issue date. | [optional] |
14
+ | **bond_type** | **String** | Bond type. | [optional] |
15
+ | **debt_type** | **String** | Bond type. | [optional] |
16
+ | **industry_group** | **String** | Industry. | [optional] |
17
+ | **industry_sub_group** | **String** | Sub-Industry. | [optional] |
18
+ | **asset** | **String** | Asset. | [optional] |
19
+ | **asset_type** | **String** | Asset. | [optional] |
20
+ | **dated_date** | **String** | Dated date. | [optional] |
21
+ | **first_coupon_date** | **String** | First coupon date. | [optional] |
22
+ | **original_offering** | **Float** | Offering amount. | [optional] |
23
+ | **amount_outstanding** | **Float** | Outstanding amount. | [optional] |
24
+ | **payment_frequency** | **String** | Payment frequency. | [optional] |
25
+ | **security_level** | **String** | Security level. | [optional] |
26
+ | **callable** | **Boolean** | Callable. | [optional] |
27
+ | **coupon_type** | **String** | Coupon type. | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'finnhub_ruby'
33
+
34
+ instance = FinnhubRuby::BondProfile.new(
35
+ isin: null,
36
+ cusip: null,
37
+ figi: null,
38
+ coupon: null,
39
+ maturity_date: null,
40
+ offering_price: null,
41
+ issue_date: null,
42
+ bond_type: null,
43
+ debt_type: null,
44
+ industry_group: null,
45
+ industry_sub_group: null,
46
+ asset: null,
47
+ asset_type: null,
48
+ dated_date: null,
49
+ first_coupon_date: null,
50
+ original_offering: null,
51
+ amount_outstanding: null,
52
+ payment_frequency: null,
53
+ security_level: null,
54
+ callable: null,
55
+ coupon_type: null
56
+ )
57
+ ```
58
+
data/docs/Company.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **name** | **String** | Executive name | [optional] |
8
8
  | **age** | **Integer** | Age | [optional] |
9
9
  | **title** | **String** | Title | [optional] |
10
- | **since** | **String** | Year appointed | [optional] |
10
+ | **since** | **String** | Year first appointed as executive/director of the company | [optional] |
11
11
  | **sex** | **String** | Sex | [optional] |
12
12
  | **compensation** | **Integer** | Total compensation | [optional] |
13
13
  | **currency** | **String** | Compensation currency | [optional] |
data/docs/DefaultApi.md CHANGED
@@ -5,6 +5,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators |
8
+ | [**bond_price**](DefaultApi.md#bond_price) | **GET** /bond/price | Bond price data |
9
+ | [**bond_profile**](DefaultApi.md#bond_profile) | **GET** /bond/profile | Bond Profile |
8
10
  | [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
9
11
  | [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
10
12
  | [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
@@ -62,16 +64,19 @@ All URIs are relative to *https://finnhub.io/api/v1*
62
64
  | [**quote**](DefaultApi.md#quote) | **GET** /quote | Quote |
63
65
  | [**recommendation_trends**](DefaultApi.md#recommendation_trends) | **GET** /stock/recommendation | Recommendation Trends |
64
66
  | [**revenue_breakdown**](DefaultApi.md#revenue_breakdown) | **GET** /stock/revenue-breakdown | Revenue Breakdown |
67
+ | [**sector_metric**](DefaultApi.md#sector_metric) | **GET** /sector/metrics | Sector Metrics |
65
68
  | [**similarity_index**](DefaultApi.md#similarity_index) | **GET** /stock/similarity-index | Similarity Index |
66
69
  | [**social_sentiment**](DefaultApi.md#social_sentiment) | **GET** /stock/social-sentiment | Social Sentiment |
67
70
  | [**stock_basic_dividends**](DefaultApi.md#stock_basic_dividends) | **GET** /stock/dividend2 | Dividends 2 (Basic) |
68
71
  | [**stock_bidask**](DefaultApi.md#stock_bidask) | **GET** /stock/bidask | Last Bid-Ask |
69
72
  | [**stock_candles**](DefaultApi.md#stock_candles) | **GET** /stock/candle | Stock Candles |
70
73
  | [**stock_dividends**](DefaultApi.md#stock_dividends) | **GET** /stock/dividend | Dividends |
74
+ | [**stock_lobbying**](DefaultApi.md#stock_lobbying) | **GET** /stock/lobbying | Senate Lobbying |
71
75
  | [**stock_nbbo**](DefaultApi.md#stock_nbbo) | **GET** /stock/bbo | Historical NBBO |
72
76
  | [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits |
73
77
  | [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol |
74
78
  | [**stock_tick**](DefaultApi.md#stock_tick) | **GET** /stock/tick | Tick Data |
79
+ | [**stock_usa_spending**](DefaultApi.md#stock_usa_spending) | **GET** /stock/usa-spending | USA Spending |
75
80
  | [**stock_uspto_patent**](DefaultApi.md#stock_uspto_patent) | **GET** /stock/uspto-patent | USPTO Patents |
76
81
  | [**stock_visa_application**](DefaultApi.md#stock_visa_application) | **GET** /stock/visa-application | H1-B Visa Application |
77
82
  | [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
@@ -156,6 +161,158 @@ end
156
161
  - **Accept**: application/json
157
162
 
158
163
 
164
+ ## bond_price
165
+
166
+ > <BondCandles> bond_price(isin, from, to)
167
+
168
+ Bond price data
169
+
170
+ Get end-of-day bond's price data.
171
+
172
+ ### Examples
173
+
174
+ ```ruby
175
+ require 'time'
176
+ require 'finnhub_ruby'
177
+ # setup authorization
178
+ FinnhubRuby.configure do |config|
179
+ # Configure API key authorization: api_key
180
+ config.api_key['api_key'] = 'YOUR API KEY'
181
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
182
+ # config.api_key_prefix['api_key'] = 'Bearer'
183
+ end
184
+
185
+ api_instance = FinnhubRuby::DefaultApi.new
186
+ isin = 'isin_example' # String | ISIN.
187
+ from = 789 # Integer | UNIX timestamp. Interval initial value.
188
+ to = 789 # Integer | UNIX timestamp. Interval end value.
189
+
190
+ begin
191
+ # Bond price data
192
+ result = api_instance.bond_price(isin, from, to)
193
+ p result
194
+ rescue FinnhubRuby::ApiError => e
195
+ puts "Error when calling DefaultApi->bond_price: #{e}"
196
+ end
197
+ ```
198
+
199
+ #### Using the bond_price_with_http_info variant
200
+
201
+ This returns an Array which contains the response data, status code and headers.
202
+
203
+ > <Array(<BondCandles>, Integer, Hash)> bond_price_with_http_info(isin, from, to)
204
+
205
+ ```ruby
206
+ begin
207
+ # Bond price data
208
+ data, status_code, headers = api_instance.bond_price_with_http_info(isin, from, to)
209
+ p status_code # => 2xx
210
+ p headers # => { ... }
211
+ p data # => <BondCandles>
212
+ rescue FinnhubRuby::ApiError => e
213
+ puts "Error when calling DefaultApi->bond_price_with_http_info: #{e}"
214
+ end
215
+ ```
216
+
217
+ ### Parameters
218
+
219
+ | Name | Type | Description | Notes |
220
+ | ---- | ---- | ----------- | ----- |
221
+ | **isin** | **String** | ISIN. | |
222
+ | **from** | **Integer** | UNIX timestamp. Interval initial value. | |
223
+ | **to** | **Integer** | UNIX timestamp. Interval end value. | |
224
+
225
+ ### Return type
226
+
227
+ [**BondCandles**](BondCandles.md)
228
+
229
+ ### Authorization
230
+
231
+ [api_key](../README.md#api_key)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: Not defined
236
+ - **Accept**: application/json
237
+
238
+
239
+ ## bond_profile
240
+
241
+ > <BondProfile> bond_profile(opts)
242
+
243
+ Bond Profile
244
+
245
+ Get general information of a bond. You can query by FIGI, ISIN or CUSIP
246
+
247
+ ### Examples
248
+
249
+ ```ruby
250
+ require 'time'
251
+ require 'finnhub_ruby'
252
+ # setup authorization
253
+ FinnhubRuby.configure do |config|
254
+ # Configure API key authorization: api_key
255
+ config.api_key['api_key'] = 'YOUR API KEY'
256
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
257
+ # config.api_key_prefix['api_key'] = 'Bearer'
258
+ end
259
+
260
+ api_instance = FinnhubRuby::DefaultApi.new
261
+ opts = {
262
+ isin: 'isin_example', # String | ISIN
263
+ cusip: 'cusip_example', # String | CUSIP
264
+ figi: 'figi_example' # String | FIGI
265
+ }
266
+
267
+ begin
268
+ # Bond Profile
269
+ result = api_instance.bond_profile(opts)
270
+ p result
271
+ rescue FinnhubRuby::ApiError => e
272
+ puts "Error when calling DefaultApi->bond_profile: #{e}"
273
+ end
274
+ ```
275
+
276
+ #### Using the bond_profile_with_http_info variant
277
+
278
+ This returns an Array which contains the response data, status code and headers.
279
+
280
+ > <Array(<BondProfile>, Integer, Hash)> bond_profile_with_http_info(opts)
281
+
282
+ ```ruby
283
+ begin
284
+ # Bond Profile
285
+ data, status_code, headers = api_instance.bond_profile_with_http_info(opts)
286
+ p status_code # => 2xx
287
+ p headers # => { ... }
288
+ p data # => <BondProfile>
289
+ rescue FinnhubRuby::ApiError => e
290
+ puts "Error when calling DefaultApi->bond_profile_with_http_info: #{e}"
291
+ end
292
+ ```
293
+
294
+ ### Parameters
295
+
296
+ | Name | Type | Description | Notes |
297
+ | ---- | ---- | ----------- | ----- |
298
+ | **isin** | **String** | ISIN | [optional] |
299
+ | **cusip** | **String** | CUSIP | [optional] |
300
+ | **figi** | **String** | FIGI | [optional] |
301
+
302
+ ### Return type
303
+
304
+ [**BondProfile**](BondProfile.md)
305
+
306
+ ### Authorization
307
+
308
+ [api_key](../README.md#api_key)
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: Not defined
313
+ - **Accept**: application/json
314
+
315
+
159
316
  ## company_basic_financials
160
317
 
161
318
  > <BasicFinancials> company_basic_financials(symbol, metric)
@@ -3173,7 +3330,7 @@ end
3173
3330
 
3174
3331
  International Filings
3175
3332
 
3176
- List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
3333
+ List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage. Enterprise clients who need access to the full filings for global markets should contact us for the access.
3177
3334
 
3178
3335
  ### Examples
3179
3336
 
@@ -3538,7 +3695,7 @@ end
3538
3695
 
3539
3696
  Mutual Funds Holdings
3540
3697
 
3541
- Get full Mutual Funds holdings/constituents.
3698
+ Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
3542
3699
 
3543
3700
  ### Examples
3544
3701
 
@@ -3615,7 +3772,7 @@ end
3615
3772
 
3616
3773
  Mutual Funds Profile
3617
3774
 
3618
- Get mutual funds profile information. This endpoint covers US mutual funds only.
3775
+ Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
3619
3776
 
3620
3777
  ### Examples
3621
3778
 
@@ -3980,7 +4137,7 @@ end
3980
4137
 
3981
4138
  Major Press Releases
3982
4139
 
3983
- Get latest major press releases of a company. This data can be used to highlight the most significant events comprised of mostly press releases sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire, Newsfile, and PRNewswire.
4140
+ <p>Get latest major press releases of a company. This data can be used to highlight the most significant events comprised of mostly press releases sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire, Newsfile, and PRNewswire.</p><p>Full-text press releases data is available for Enterprise clients. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
3984
4141
 
3985
4142
  ### Examples
3986
4143
 
@@ -4339,6 +4496,77 @@ end
4339
4496
  - **Accept**: application/json
4340
4497
 
4341
4498
 
4499
+ ## sector_metric
4500
+
4501
+ > <SectorMetric> sector_metric(region)
4502
+
4503
+ Sector Metrics
4504
+
4505
+ Get ratios for different sectors and regions/indices.
4506
+
4507
+ ### Examples
4508
+
4509
+ ```ruby
4510
+ require 'time'
4511
+ require 'finnhub_ruby'
4512
+ # setup authorization
4513
+ FinnhubRuby.configure do |config|
4514
+ # Configure API key authorization: api_key
4515
+ config.api_key['api_key'] = 'YOUR API KEY'
4516
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4517
+ # config.api_key_prefix['api_key'] = 'Bearer'
4518
+ end
4519
+
4520
+ api_instance = FinnhubRuby::DefaultApi.new
4521
+ region = 'region_example' # String | Region. A list of supported values for this field can be found <a href=\"https://docs.google.com/spreadsheets/d/1afedyv7yWJ-z7pMjaAZK-f6ENY3mI3EBCk95QffpoHw/edit?usp=sharing\" target=\"_blank\">here</a>.
4522
+
4523
+ begin
4524
+ # Sector Metrics
4525
+ result = api_instance.sector_metric(region)
4526
+ p result
4527
+ rescue FinnhubRuby::ApiError => e
4528
+ puts "Error when calling DefaultApi->sector_metric: #{e}"
4529
+ end
4530
+ ```
4531
+
4532
+ #### Using the sector_metric_with_http_info variant
4533
+
4534
+ This returns an Array which contains the response data, status code and headers.
4535
+
4536
+ > <Array(<SectorMetric>, Integer, Hash)> sector_metric_with_http_info(region)
4537
+
4538
+ ```ruby
4539
+ begin
4540
+ # Sector Metrics
4541
+ data, status_code, headers = api_instance.sector_metric_with_http_info(region)
4542
+ p status_code # => 2xx
4543
+ p headers # => { ... }
4544
+ p data # => <SectorMetric>
4545
+ rescue FinnhubRuby::ApiError => e
4546
+ puts "Error when calling DefaultApi->sector_metric_with_http_info: #{e}"
4547
+ end
4548
+ ```
4549
+
4550
+ ### Parameters
4551
+
4552
+ | Name | Type | Description | Notes |
4553
+ | ---- | ---- | ----------- | ----- |
4554
+ | **region** | **String** | Region. A list of supported values for this field can be found &lt;a href&#x3D;\&quot;https://docs.google.com/spreadsheets/d/1afedyv7yWJ-z7pMjaAZK-f6ENY3mI3EBCk95QffpoHw/edit?usp&#x3D;sharing\&quot; target&#x3D;\&quot;_blank\&quot;&gt;here&lt;/a&gt;. | |
4555
+
4556
+ ### Return type
4557
+
4558
+ [**SectorMetric**](SectorMetric.md)
4559
+
4560
+ ### Authorization
4561
+
4562
+ [api_key](../README.md#api_key)
4563
+
4564
+ ### HTTP request headers
4565
+
4566
+ - **Content-Type**: Not defined
4567
+ - **Accept**: application/json
4568
+
4569
+
4342
4570
  ## similarity_index
4343
4571
 
4344
4572
  > <SimilarityIndex> similarity_index(opts)
@@ -4787,6 +5015,81 @@ end
4787
5015
  - **Accept**: application/json
4788
5016
 
4789
5017
 
5018
+ ## stock_lobbying
5019
+
5020
+ > <LobbyingResult> stock_lobbying(symbol, from, to)
5021
+
5022
+ Senate Lobbying
5023
+
5024
+ Get a list of reported lobbying activities in the Senate and the House.
5025
+
5026
+ ### Examples
5027
+
5028
+ ```ruby
5029
+ require 'time'
5030
+ require 'finnhub_ruby'
5031
+ # setup authorization
5032
+ FinnhubRuby.configure do |config|
5033
+ # Configure API key authorization: api_key
5034
+ config.api_key['api_key'] = 'YOUR API KEY'
5035
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5036
+ # config.api_key_prefix['api_key'] = 'Bearer'
5037
+ end
5038
+
5039
+ api_instance = FinnhubRuby::DefaultApi.new
5040
+ symbol = 'symbol_example' # String | Symbol.
5041
+ from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
5042
+ to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
5043
+
5044
+ begin
5045
+ # Senate Lobbying
5046
+ result = api_instance.stock_lobbying(symbol, from, to)
5047
+ p result
5048
+ rescue FinnhubRuby::ApiError => e
5049
+ puts "Error when calling DefaultApi->stock_lobbying: #{e}"
5050
+ end
5051
+ ```
5052
+
5053
+ #### Using the stock_lobbying_with_http_info variant
5054
+
5055
+ This returns an Array which contains the response data, status code and headers.
5056
+
5057
+ > <Array(<LobbyingResult>, Integer, Hash)> stock_lobbying_with_http_info(symbol, from, to)
5058
+
5059
+ ```ruby
5060
+ begin
5061
+ # Senate Lobbying
5062
+ data, status_code, headers = api_instance.stock_lobbying_with_http_info(symbol, from, to)
5063
+ p status_code # => 2xx
5064
+ p headers # => { ... }
5065
+ p data # => <LobbyingResult>
5066
+ rescue FinnhubRuby::ApiError => e
5067
+ puts "Error when calling DefaultApi->stock_lobbying_with_http_info: #{e}"
5068
+ end
5069
+ ```
5070
+
5071
+ ### Parameters
5072
+
5073
+ | Name | Type | Description | Notes |
5074
+ | ---- | ---- | ----------- | ----- |
5075
+ | **symbol** | **String** | Symbol. | |
5076
+ | **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | |
5077
+ | **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | |
5078
+
5079
+ ### Return type
5080
+
5081
+ [**LobbyingResult**](LobbyingResult.md)
5082
+
5083
+ ### Authorization
5084
+
5085
+ [api_key](../README.md#api_key)
5086
+
5087
+ ### HTTP request headers
5088
+
5089
+ - **Content-Type**: Not defined
5090
+ - **Accept**: application/json
5091
+
5092
+
4790
5093
  ## stock_nbbo
4791
5094
 
4792
5095
  > <HistoricalNBBO> stock_nbbo(symbol, date, limit, skip)
@@ -5095,6 +5398,81 @@ end
5095
5398
  - **Accept**: application/json
5096
5399
 
5097
5400
 
5401
+ ## stock_usa_spending
5402
+
5403
+ > <UsaSpendingResult> stock_usa_spending(symbol, from, to)
5404
+
5405
+ USA Spending
5406
+
5407
+ Get a list of government's spending activities from USASpending dataset for public companies. This dataset can help you identify companies that win big government contracts which is extremely important for industries such as Defense, Aerospace, and Education.
5408
+
5409
+ ### Examples
5410
+
5411
+ ```ruby
5412
+ require 'time'
5413
+ require 'finnhub_ruby'
5414
+ # setup authorization
5415
+ FinnhubRuby.configure do |config|
5416
+ # Configure API key authorization: api_key
5417
+ config.api_key['api_key'] = 'YOUR API KEY'
5418
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5419
+ # config.api_key_prefix['api_key'] = 'Bearer'
5420
+ end
5421
+
5422
+ api_instance = FinnhubRuby::DefaultApi.new
5423
+ symbol = 'symbol_example' # String | Symbol.
5424
+ from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>
5425
+ to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>
5426
+
5427
+ begin
5428
+ # USA Spending
5429
+ result = api_instance.stock_usa_spending(symbol, from, to)
5430
+ p result
5431
+ rescue FinnhubRuby::ApiError => e
5432
+ puts "Error when calling DefaultApi->stock_usa_spending: #{e}"
5433
+ end
5434
+ ```
5435
+
5436
+ #### Using the stock_usa_spending_with_http_info variant
5437
+
5438
+ This returns an Array which contains the response data, status code and headers.
5439
+
5440
+ > <Array(<UsaSpendingResult>, Integer, Hash)> stock_usa_spending_with_http_info(symbol, from, to)
5441
+
5442
+ ```ruby
5443
+ begin
5444
+ # USA Spending
5445
+ data, status_code, headers = api_instance.stock_usa_spending_with_http_info(symbol, from, to)
5446
+ p status_code # => 2xx
5447
+ p headers # => { ... }
5448
+ p data # => <UsaSpendingResult>
5449
+ rescue FinnhubRuby::ApiError => e
5450
+ puts "Error when calling DefaultApi->stock_usa_spending_with_http_info: #{e}"
5451
+ end
5452
+ ```
5453
+
5454
+ ### Parameters
5455
+
5456
+ | Name | Type | Description | Notes |
5457
+ | ---- | ---- | ----------- | ----- |
5458
+ | **symbol** | **String** | Symbol. | |
5459
+ | **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter for &lt;code&gt;actionDate&lt;/code&gt; | |
5460
+ | **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter for &lt;code&gt;actionDate&lt;/code&gt; | |
5461
+
5462
+ ### Return type
5463
+
5464
+ [**UsaSpendingResult**](UsaSpendingResult.md)
5465
+
5466
+ ### Authorization
5467
+
5468
+ [api_key](../README.md#api_key)
5469
+
5470
+ ### HTTP request headers
5471
+
5472
+ - **Content-Type**: Not defined
5473
+ - **Accept**: application/json
5474
+
5475
+
5098
5476
  ## stock_uspto_patent
5099
5477
 
5100
5478
  > <UsptoPatentResult> stock_uspto_patent(symbol, from, to)
@@ -6,6 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **symbol** | **String** | Symbol | [optional] |
8
8
  | **name** | **String** | Name | [optional] |
9
+ | **country** | **String** | Country | [optional] |
10
+ | **industry** | **String** | Industry | [optional] |
9
11
  | **customer** | **Boolean** | Whether the company is a customer. | [optional] |
10
12
  | **supplier** | **Boolean** | Whether the company is a supplier | [optional] |
11
13
  | **one_month_correlation** | **Float** | 1-month price correlation | [optional] |
@@ -23,6 +25,8 @@ require 'finnhub_ruby'
23
25
  instance = FinnhubRuby::KeyCustomersSuppliers.new(
24
26
  symbol: null,
25
27
  name: null,
28
+ country: null,
29
+ industry: null,
26
30
  customer: null,
27
31
  supplier: null,
28
32
  one_month_correlation: null,
@@ -0,0 +1,46 @@
1
+ # FinnhubRuby::LobbyingData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol. | [optional] |
8
+ | **name** | **String** | Company&#39;s name. | [optional] |
9
+ | **description** | **String** | Description. | [optional] |
10
+ | **country** | **String** | Country. | [optional] |
11
+ | **year** | **Integer** | Year. | [optional] |
12
+ | **period** | **String** | Period. | [optional] |
13
+ | **income** | **Float** | Income reported by lobbying firms. | [optional] |
14
+ | **expenses** | **Float** | Expenses reported by the company. | [optional] |
15
+ | **document_url** | **String** | Document&#39;s URL. | [optional] |
16
+ | **posted_name** | **String** | Posted name. | [optional] |
17
+ | **date** | **String** | Date. | [optional] |
18
+ | **client_id** | **String** | Client ID. | [optional] |
19
+ | **registrant_id** | **String** | Registrant ID. | [optional] |
20
+ | **senate_id** | **String** | Senate ID. | [optional] |
21
+ | **houseregistrant_id** | **String** | House registrant ID. | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'finnhub_ruby'
27
+
28
+ instance = FinnhubRuby::LobbyingData.new(
29
+ symbol: null,
30
+ name: null,
31
+ description: null,
32
+ country: null,
33
+ year: null,
34
+ period: null,
35
+ income: null,
36
+ expenses: null,
37
+ document_url: null,
38
+ posted_name: null,
39
+ date: null,
40
+ client_id: null,
41
+ registrant_id: null,
42
+ senate_id: null,
43
+ houseregistrant_id: null
44
+ )
45
+ ```
46
+
@@ -0,0 +1,20 @@
1
+ # FinnhubRuby::LobbyingResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol. | [optional] |
8
+ | **data** | [**Array&lt;LobbyingData&gt;**](LobbyingData.md) | Array of lobbying activities. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'finnhub_ruby'
14
+
15
+ instance = FinnhubRuby::LobbyingResult.new(
16
+ symbol: null,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -29,6 +29,8 @@
29
29
  | **series_name** | **String** | Fund&#39;s series name. | [optional] |
30
30
  | **class_id** | **String** | Class ID. | [optional] |
31
31
  | **class_name** | **String** | Class name. | [optional] |
32
+ | **sfdr_classification** | **String** | SFDR classification for EU funds. Under the new classifications, a fund&#39;s strategy will labeled under either Article 6, 8 or 9. Article 6 covers funds which do not integrate any kind of sustainability into the investment process. Article 8, also known as ‘environmental and socially promoting’, applies “… where a financial product promotes, among other characteristics, environmental or social characteristics, or a combination of those characteristics, provided that the companies in which the investments are made follow good governance practices.”. Article 9, also known as ‘products targeting sustainable investments’, covers products targeting bespoke sustainable investments and applies “… where a financial product has sustainable investment as its objective and an index has been designated as a reference benchmark.” | [optional] |
33
+ | **currency** | **String** | Fund&#39;s currency | [optional] |
32
34
 
33
35
  ## Example
34
36
 
@@ -60,7 +62,9 @@ instance = FinnhubRuby::MutualFundProfileData.new(
60
62
  series_id: null,
61
63
  series_name: null,
62
64
  class_id: null,
63
- class_name: null
65
+ class_name: null,
66
+ sfdr_classification: null,
67
+ currency: null
64
68
  )
65
69
  ```
66
70