finnhub_ruby 1.1.18 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26122ba70fd4c403542a630dcae03d6f5e99d8721599fca79fa463fe15f85e8c
-  data.tar.gz: 5f9c644431ffb37e9990c273b0a6d648120c3e5baaaf97a509fc299d485fa30c
+  metadata.gz: 6f5ca0c3eb663220b1ce26a51d7f0d73811ef76ed36d7fd8b6f0bdafb1aefe06
+  data.tar.gz: cc715e395c7526aadbb094284c202a49d55b5855e4ec9f7e5ed98fa27b29de79
 SHA512:
-  metadata.gz: 292f53eb344820f120ed793b65efc38a4289d61b848a739ffde0055d95f38fdf47e52733b2b02b79ecb98ccf870c6bdf554657e627b72665adf9d5b2481bde1a
-  data.tar.gz: 1c6fcbe6c3eca11821207f16da674497fe9c731e66ddf092f394a3a3e8aeddbef59b80407679eb965dc9aecce7c65d759dd842d36bcbbb1cd8b90e8235926cf3
+  metadata.gz: 491edeacc31ce9f52f1a4085ed1809922ef2bf5c7e0aa20a204f76d43c59ebabc49430e765130f53c81ca4ae67f15fff2033490c211f392dd536e914a5eb4b4d
+  data.tar.gz: c23bb87082594740381e8b49ba33fa07997c845c8c962e2ac36cbc7c4d5bd37af9a4c89761b56d3c2c7646876ccba008747b680a6c388de9b037478bf6561053

data/.gitignore

@@ -0,0 +1,39 @@
+# Generated by: https://openapi-generator.tech
+#
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,148 @@
+# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
+# Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
+AllCops:
+  TargetRubyVersion: 2.4
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - 'actionpack/lib/action_dispatch/journey/parser.rb'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: false
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+#Style/StringLiterals:
+#  Enabled: true
+#  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: false
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+script:
+  - bundle install --path vendor/bundle
+  - bundle exec rspec
+  - gem build finnhub_ruby.gemspec
+  - gem install ./finnhub_ruby-1.1.21.gem

data/README.md

@@ -1,7 +1,7 @@
 # finnhub-ruby
 - API documentation: https://finnhub.io/docs/api
 - API version: 1.0.0
-- Package version: 1.1.18
+- Package version: 2.0.0
 
 ## Installation
 https://rubygems.org/gems/finnhub_ruby
@@ -13,7 +13,7 @@ gem install finnhub_ruby
 or in your Gemfile
 
 ```ruby
-gem 'finnhub_ruby', '~> 1.1.17'
+gem 'finnhub_ruby', '~> 2.0.0'
 ```
 
 ## Getting Started
@@ -31,7 +31,7 @@ finnhub_client = FinnhubRuby::DefaultApi.new
 puts(finnhub_client.similarity_index({symbol: 'AAPL'}))
 
 # Stock symbols
-puts(finnhub_client.stock_symbols('US'))
+puts(client.stock_symbols('US'))
 
 #Symbol search
 puts(finnhub_client.symbol_search('AAPL'))
@@ -126,7 +126,7 @@ puts(finnhub_client.forex_symbols('OANDA'))
 puts(finnhub_client.fund_ownership('AMZN', {limit: 5}))
 
 # General news
-puts(finnhub_client.market_news('forex', {min_id: 0}))
+puts(finnhub_client.general_news('forex', {min_id: 0}))
 
 # Investors ownership
 puts(finnhub_client.ownership('AAPL', {limit: 5}))

data/docs/AirlinePriceIndex.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::AirlinePriceIndex
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **String** | Date | [optional] |
+| **price_index** | **Float** | Price Index | [optional] |
+| **daily_avg_price** | **Float** | Daily average ticket price. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::AirlinePriceIndex.new(
+  date: null,
+  price_index: null,
+  daily_avg_price: null
+)
+```
+

data/docs/AirlinePriceIndexData.md

@@ -0,0 +1,24 @@
+# FinnhubRuby::AirlinePriceIndexData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<AirlinePriceIndex>**](AirlinePriceIndex.md) | Array of price index. | [optional] |
+| **airline** | **String** | Airline name | [optional] |
+| **from** | **String** | From date | [optional] |
+| **to** | **String** | To date | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::AirlinePriceIndexData.new(
+  data: null,
+  airline: null,
+  from: null,
+  to: null
+)
+```
+

data/docs/BondTickData.md

@@ -9,9 +9,12 @@
 | **total** | **Integer** | Total number of ticks for that date. | [optional] |
 | **v** | **Array<Float>** | List of volume data. | [optional] |
 | **p** | **Array<Float>** | List of price data. | [optional] |
+| **y** | **Array<Float>** | List of yield data. | [optional] |
 | **t** | **Array<Integer>** | List of timestamp in UNIX ms. | [optional] |
 | **si** | **Array<String>** | List of values showing the side (Buy/sell) of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional] |
 | **cp** | **Array<String>** | List of values showing the counterparty of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional] |
+| **rp** | **Array<String>** | List of values showing the reporting party of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional] |
+| **ats** | **Array<String>** | ATS flag. Y or empty | [optional] |
 | **c** | **Array<Array<String>>** | List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\">here</a> | [optional] |
 
 ## Example
@@ -25,9 +28,12 @@ instance = FinnhubRuby::BondTickData.new(
   total: null,
   v: null,
   p: null,
+  y: null,
   t: null,
   si: null,
   cp: null,
+  rp: null,
+  ats: null,
   c: null
 )
 ```

data/docs/BondYieldCurve.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::BondYieldCurve
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<BondYieldCurveInfo>**](BondYieldCurveInfo.md) | Array of data. | [optional] |
+| **code** | **String** | Bond's code | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::BondYieldCurve.new(
+  data: null,
+  code: null
+)
+```
+

data/docs/BondYieldCurveInfo.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::BondYieldCurveInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **d** | **String** | Date of the reading | [optional] |
+| **v** | **Float** | Value | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::BondYieldCurveInfo.new(
+  d: null,
+  v: null
+)
+```
+

data/docs/CompanyESG2.md

@@ -0,0 +1,28 @@
+# FinnhubRuby::CompanyESG2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_esg_score** | **Float** | Total ESG Score | [optional] |
+| **environment_score** | **Float** | Environment Score | [optional] |
+| **governance_score** | **Float** | Governance Score | [optional] |
+| **social_score** | **Float** | Social Score | [optional] |
+| **data** | **Object** |  | [optional] |
+| **period** | **String** | Period | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::CompanyESG2.new(
+  total_esg_score: null,
+  environment_score: null,
+  governance_score: null,
+  social_score: null,
+  data: null,
+  period: null
+)
+```
+

data/docs/CompanyProfile.md

@@ -4,10 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **_alias** | **Array<String>** | Company name alias. | [optional] |
 | **address** | **String** | Address of company's headquarter. | [optional] |
 | **city** | **String** | City of company's headquarter. | [optional] |
 | **country** | **String** | Country of company's headquarter. | [optional] |
-| **currency** | **String** | Currency used in company filings. | [optional] |
+| **currency** | **String** | Currency used in company filings and financials. | [optional] |
+| **estimate_currency** | **String** | Currency used in Estimates data. | [optional] |
+| **market_cap_currency** | **String** | Currency used in market capitalization. | [optional] |
 | **cusip** | **String** | CUSIP number. | [optional] |
 | **sedol** | **String** | Sedol number. | [optional] |
 | **description** | **String** | Company business summary. | [optional] |
@@ -17,6 +20,8 @@
 | **gsector** | **String** | Sector. | [optional] |
 | **gsubind** | **String** | Sub-industry. | [optional] |
 | **isin** | **String** | ISIN number. | [optional] |
+| **lei** | **String** | LEI number. | [optional] |
+| **ir_url** | **String** | Investor relations website. | [optional] |
 | **naics_national_industry** | **String** | NAICS national industry. | [optional] |
 | **naics** | **String** | NAICS industry. | [optional] |
 | **naics_sector** | **String** | NAICS sector. | [optional] |
@@ -39,10 +44,13 @@
 require 'finnhub_ruby'
 
 instance = FinnhubRuby::CompanyProfile.new(
+  _alias: null,
   address: null,
   city: null,
   country: null,
   currency: null,
+  estimate_currency: null,
+  market_cap_currency: null,
   cusip: null,
   sedol: null,
   description: null,
@@ -52,6 +60,8 @@ instance = FinnhubRuby::CompanyProfile.new(
   gsector: null,
   gsubind: null,
   isin: null,
+  lei: null,
+  ir_url: null,
   naics_national_industry: null,
   naics: null,
   naics_sector: null,

data/docs/CongressionalTrading.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::CongressionalTrading
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company. | [optional] |
+| **data** | [**Array<CongressionalTransaction>**](CongressionalTransaction.md) | Array of stock trades. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::CongressionalTrading.new(
+  symbol: null,
+  data: null
+)
+```
+

data/docs/CongressionalTransaction.md

@@ -0,0 +1,36 @@
+# FinnhubRuby::CongressionalTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_from** | **Float** | Transaction amount from. | [optional] |
+| **amount_to** | **Float** | Transaction amount to. | [optional] |
+| **asset_name** | **String** | Asset name. | [optional] |
+| **filing_date** | **String** | Filing date. | [optional] |
+| **name** | **String** | Name of the representative. | [optional] |
+| **owner_type** | **String** | Owner Type. | [optional] |
+| **position** | **String** | Position. | [optional] |
+| **symbol** | **String** | Symbol. | [optional] |
+| **transaction_date** | **String** | Transaction date. | [optional] |
+| **transaction_type** | **String** | Transaction type <code>Sale</code> or <code>Purchase</code>. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::CongressionalTransaction.new(
+  amount_from: null,
+  amount_to: null,
+  asset_name: null,
+  filing_date: null,
+  name: null,
+  owner_type: null,
+  position: null,
+  symbol: null,
+  transaction_date: null,
+  transaction_type: null
+)
+```
+

data/docs/CountryMetadata.md

@@ -12,6 +12,10 @@
 | **currency_code** | **String** | Currency code | [optional] |
 | **region** | **String** | Region | [optional] |
 | **sub_region** | **String** | Sub-Region | [optional] |
+| **rating** | **String** | Moody's credit risk rating. | [optional] |
+| **default_spread** | **Float** | Default spread | [optional] |
+| **country_risk_premium** | **Float** | Country risk premium | [optional] |
+| **equity_risk_premium** | **Float** | Equity risk premium | [optional] |
 
 ## Example
 
@@ -26,7 +30,11 @@ instance = FinnhubRuby::CountryMetadata.new(
   currency: null,
   currency_code: null,
   region: null,
-  sub_region: null
+  sub_region: null,
+  rating: null,
+  default_spread: null,
+  country_risk_premium: null,
+  equity_risk_premium: null
 )
 ```