finnhub_ruby 1.1.9 → 1.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +17 -3
- data/docs/CryptoProfile.md +38 -0
- data/docs/DefaultApi.md +396 -11
- data/docs/EbitEstimates.md +22 -0
- data/docs/EbitEstimatesInfo.md +26 -0
- data/docs/EbitdaEstimates.md +22 -0
- data/docs/EbitdaEstimatesInfo.md +26 -0
- data/docs/MutualFundProfileData.md +9 -1
- data/docs/StockSymbol.md +7 -1
- data/docs/Transactions.md +2 -0
- data/docs/UsptoPatent.md +34 -0
- data/docs/UsptoPatentResult.md +20 -0
- data/docs/VisaApplication.md +62 -0
- data/docs/VisaApplicationResult.md +20 -0
- data/finnhub_ruby-1.1.10.gem +0 -0
- data/finnhub_ruby-1.1.11.gem +0 -0
- data/finnhub_ruby-1.1.12.gem +0 -0
- data/finnhub_ruby-1.1.9.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +369 -6
- data/lib/finnhub_ruby/models/crypto_profile.rb +319 -0
- data/lib/finnhub_ruby/models/ebit_estimates.rb +241 -0
- data/lib/finnhub_ruby/models/ebit_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/ebitda_estimates.rb +241 -0
- data/lib/finnhub_ruby/models/ebitda_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +44 -4
- data/lib/finnhub_ruby/models/stock_symbol.rb +34 -4
- data/lib/finnhub_ruby/models/transactions.rb +11 -1
- data/lib/finnhub_ruby/models/uspto_patent.rb +301 -0
- data/lib/finnhub_ruby/models/uspto_patent_result.rb +231 -0
- data/lib/finnhub_ruby/models/visa_application.rb +439 -0
- data/lib/finnhub_ruby/models/visa_application_result.rb +231 -0
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +9 -0
- data/spec/models/crypto_profile_spec.rb +94 -0
- data/spec/models/ebit_estimates_info_spec.rb +58 -0
- data/spec/models/ebit_estimates_spec.rb +46 -0
- data/spec/models/ebitda_estimates_info_spec.rb +58 -0
- data/spec/models/ebitda_estimates_spec.rb +46 -0
- data/spec/models/uspto_patent_result_spec.rb +40 -0
- data/spec/models/uspto_patent_spec.rb +82 -0
- data/spec/models/visa_application_result_spec.rb +40 -0
- data/spec/models/visa_application_spec.rb +166 -0
- metadata +42 -2
@@ -0,0 +1,26 @@
|
|
1
|
+
# FinnhubRuby::EbitdaEstimatesInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ebitda_avg** | **Float** | Average EBITDA estimates including Finnhub's proprietary estimates. | [optional] |
|
8
|
+
| **ebitda_high** | **Float** | Highest estimate. | [optional] |
|
9
|
+
| **ebitda_low** | **Float** | Lowest estimate. | [optional] |
|
10
|
+
| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
|
11
|
+
| **period** | **Date** | Period. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'finnhub_ruby'
|
17
|
+
|
18
|
+
instance = FinnhubRuby::EbitdaEstimatesInfo.new(
|
19
|
+
ebitda_avg: null,
|
20
|
+
ebitda_high: null,
|
21
|
+
ebitda_low: null,
|
22
|
+
number_analysts: null,
|
23
|
+
period: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -25,6 +25,10 @@
|
|
25
25
|
| **max_redemption_fee** | **Float** | Max redemption fee. | [optional] |
|
26
26
|
| **standard_min_investment** | **Float** | Minimum investment for standard accounts. | [optional] |
|
27
27
|
| **turnover** | **Float** | Turnover. | [optional] |
|
28
|
+
| **series_id** | **String** | Fund's series ID. This field can be used to group multiple share classes into 1 unique fund. | [optional] |
|
29
|
+
| **series_name** | **String** | Fund's series name. | [optional] |
|
30
|
+
| **class_id** | **String** | Class ID. | [optional] |
|
31
|
+
| **class_name** | **String** | Class name. | [optional] |
|
28
32
|
|
29
33
|
## Example
|
30
34
|
|
@@ -52,7 +56,11 @@ instance = FinnhubRuby::MutualFundProfileData.new(
|
|
52
56
|
cusip: null,
|
53
57
|
max_redemption_fee: null,
|
54
58
|
standard_min_investment: null,
|
55
|
-
turnover: null
|
59
|
+
turnover: null,
|
60
|
+
series_id: null,
|
61
|
+
series_name: null,
|
62
|
+
class_id: null,
|
63
|
+
class_name: null
|
56
64
|
)
|
57
65
|
```
|
58
66
|
|
data/docs/StockSymbol.md
CHANGED
@@ -10,7 +10,10 @@
|
|
10
10
|
| **type** | **String** | Security type. | [optional] |
|
11
11
|
| **mic** | **String** | Primary exchange's MIC. | [optional] |
|
12
12
|
| **figi** | **String** | FIGI identifier. | [optional] |
|
13
|
+
| **share_class_figi** | **String** | Global Share Class FIGI. | [optional] |
|
13
14
|
| **currency** | **String** | Price's currency. This might be different from the reporting currency of fundamental data. | [optional] |
|
15
|
+
| **symbol2** | **String** | Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE. | [optional] |
|
16
|
+
| **isin** | **String** | ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field. | [optional] |
|
14
17
|
|
15
18
|
## Example
|
16
19
|
|
@@ -24,7 +27,10 @@ instance = FinnhubRuby::StockSymbol.new(
|
|
24
27
|
type: null,
|
25
28
|
mic: null,
|
26
29
|
figi: null,
|
27
|
-
|
30
|
+
share_class_figi: null,
|
31
|
+
currency: null,
|
32
|
+
symbol2: null,
|
33
|
+
isin: null
|
28
34
|
)
|
29
35
|
```
|
30
36
|
|
data/docs/Transactions.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
7
8
|
| **name** | **String** | Insider's name. | [optional] |
|
8
9
|
| **share** | **Integer** | Number of shares held after the transaction. | [optional] |
|
9
10
|
| **change** | **Integer** | Number of share changed from the last period. A positive value suggests a <code>BUY</code> transaction. A negative value suggests a <code>SELL</code> transaction. | [optional] |
|
@@ -18,6 +19,7 @@
|
|
18
19
|
require 'finnhub_ruby'
|
19
20
|
|
20
21
|
instance = FinnhubRuby::Transactions.new(
|
22
|
+
symbol: null,
|
21
23
|
name: null,
|
22
24
|
share: null,
|
23
25
|
change: null,
|
data/docs/UsptoPatent.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# FinnhubRuby::UsptoPatent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **application_number** | **String** | Application Number. | [optional] |
|
8
|
+
| **company_filing_name** | **Array<String>** | Array of companies' name on the patent. | [optional] |
|
9
|
+
| **filing_date** | **String** | Filing date. | [optional] |
|
10
|
+
| **description** | **String** | Description. | [optional] |
|
11
|
+
| **filing_status** | **String** | Filing status. | [optional] |
|
12
|
+
| **patent_number** | **String** | Patent number. | [optional] |
|
13
|
+
| **publication_date** | **String** | Publication date. | [optional] |
|
14
|
+
| **patent_type** | **String** | Patent's type. | [optional] |
|
15
|
+
| **url** | **String** | URL of the original article. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'finnhub_ruby'
|
21
|
+
|
22
|
+
instance = FinnhubRuby::UsptoPatent.new(
|
23
|
+
application_number: null,
|
24
|
+
company_filing_name: null,
|
25
|
+
filing_date: null,
|
26
|
+
description: null,
|
27
|
+
filing_status: null,
|
28
|
+
patent_number: null,
|
29
|
+
publication_date: null,
|
30
|
+
patent_type: null,
|
31
|
+
url: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::UsptoPatentResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **data** | [**Array<UsptoPatent>**](UsptoPatent.md) | Array of patents. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::UsptoPatentResult.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# FinnhubRuby::VisaApplication
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **year** | **Integer** | Year. | [optional] |
|
8
|
+
| **quarter** | **Integer** | Quarter. | [optional] |
|
9
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
10
|
+
| **case_number** | **String** | Case number. | [optional] |
|
11
|
+
| **case_status** | **String** | Case status. | [optional] |
|
12
|
+
| **received_date** | **String** | Received date. | [optional] |
|
13
|
+
| **visa_class** | **String** | Visa class. | [optional] |
|
14
|
+
| **job_title** | **String** | Job Title. | [optional] |
|
15
|
+
| **soc_code** | **String** | SOC Code. A list of SOC code can be found <a href=\"https://www.bls.gov/oes/current/oes_stru.htm\" target=\"_blank\">here</a>. | [optional] |
|
16
|
+
| **full_time_position** | **String** | Full-time position flag. | [optional] |
|
17
|
+
| **begin_date** | **String** | Job's start date. | [optional] |
|
18
|
+
| **end_date** | **String** | Job's end date. | [optional] |
|
19
|
+
| **employer_name** | **String** | Company's name. | [optional] |
|
20
|
+
| **worksite_address** | **String** | Worksite address. | [optional] |
|
21
|
+
| **worksite_city** | **String** | Worksite city. | [optional] |
|
22
|
+
| **worksite_county** | **String** | Worksite county. | [optional] |
|
23
|
+
| **worksite_state** | **String** | Worksite state. | [optional] |
|
24
|
+
| **worksite_postal_code** | **String** | Worksite postal code. | [optional] |
|
25
|
+
| **wage_range_from** | **Float** | Wage range from. | [optional] |
|
26
|
+
| **wage_range_to** | **Float** | Wage range to. | [optional] |
|
27
|
+
| **wave_unit_of_pay** | **String** | Wage unit of pay. | [optional] |
|
28
|
+
| **wage_level** | **String** | Wage level. | [optional] |
|
29
|
+
| **h1b_dependent** | **String** | H1B dependent flag. | [optional] |
|
30
|
+
|
31
|
+
## Example
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require 'finnhub_ruby'
|
35
|
+
|
36
|
+
instance = FinnhubRuby::VisaApplication.new(
|
37
|
+
year: null,
|
38
|
+
quarter: null,
|
39
|
+
symbol: null,
|
40
|
+
case_number: null,
|
41
|
+
case_status: null,
|
42
|
+
received_date: null,
|
43
|
+
visa_class: null,
|
44
|
+
job_title: null,
|
45
|
+
soc_code: null,
|
46
|
+
full_time_position: null,
|
47
|
+
begin_date: null,
|
48
|
+
end_date: null,
|
49
|
+
employer_name: null,
|
50
|
+
worksite_address: null,
|
51
|
+
worksite_city: null,
|
52
|
+
worksite_county: null,
|
53
|
+
worksite_state: null,
|
54
|
+
worksite_postal_code: null,
|
55
|
+
wage_range_from: null,
|
56
|
+
wage_range_to: null,
|
57
|
+
wave_unit_of_pay: null,
|
58
|
+
wage_level: null,
|
59
|
+
h1b_dependent: null
|
60
|
+
)
|
61
|
+
```
|
62
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::VisaApplicationResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **data** | [**Array<VisaApplication>**](VisaApplication.md) | Array of H1b and Permanent visa applications. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::VisaApplicationResult.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|