finnhub_ruby 1.1.17 → 1.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 840da9e6e0893fda73e5b4ee3943a54a5a5e54d9163ff43b4a7a8925e4db121a
-  data.tar.gz: 2cc86c1ecc481e58b0df75ada3bc472c54baf83dd20e1cffb1f185feda1ca955
+  metadata.gz: 6286c442a46c71f6e4889a2fd3e6a01135f30737e0924438777eaf5d752a2326
+  data.tar.gz: 883025c7f6403f0648aa357184963292075405a7d294f19754f5f8f786dfbcbb
 SHA512:
-  metadata.gz: c7cc0a9a720915e41db73ec91cfec803454ddd3962ab6bde38dc60a84a1dd4fc18b4749e903ec34f1ba0f2f6e6d4353728a141defd3137649075fe558ccd32e1
-  data.tar.gz: 62ab3be671f5dca7b274a361fca6695dd3c3e7fed067f716303fc561e54f81ea17bf6a1c5f0084feaece85ac5fbb2fdc13a3d62d5c355f07faf9ccaede3f470c
+  metadata.gz: 76fc7fbc3af3031842ac6c706ab1ca41f08289743b5e0d899221a64a8504e7c1665ea4a80bf5c60f476881189036849a7d9e7efc27747e704177c359dbea959a
+  data.tar.gz: cfa14a11c9080cf6911673f4ccdf60d68d681875fcec38ac2e4f8b5a06d3232162a8ac56d66cd76536c51df441f748b91d97e8b216960e511d3d80f17a6a6429

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.17
+- Package version: 1.1.19
 
 ## 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', '~> 1.1.19'
 ```
 
 ## Getting Started

data/docs/BondTickData.md

@@ -0,0 +1,40 @@
+# FinnhubRuby::BondTickData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **skip** | **Integer** | Number of ticks skipped. | [optional] |
+| **count** | **Integer** | Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned. | [optional] |
+| **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
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::BondTickData.new(
+  skip: null,
+  count: null,
+  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/CompanyProfile.md

@@ -7,7 +7,9 @@
 | **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] |
@@ -43,6 +45,8 @@ instance = FinnhubRuby::CompanyProfile.new(
   city: null,
   country: null,
   currency: null,
+  estimate_currency: null,
+  market_cap_currency: null,
   cusip: null,
   sedol: null,
   description: 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
+)
+```
+