finnhub_ruby 1.1.18 → 2.0.0

data/docs/SearchBody.md

@@ -0,0 +1,60 @@
+# FinnhubRuby::SearchBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | Search query |  |
+| **isins** | **String** | List of isin to search, comma separated (Max: 50). | [optional] |
+| **cusips** | **String** | List of cusip to search, comma separated (Max: 50). | [optional] |
+| **ciks** | **String** | List of SEC Center Index Key to search, comma separated (Max: 50). | [optional] |
+| **sedar_ids** | **String** | List of SEDAR issuer number to search, comma separated (Max: 50). | [optional] |
+| **ch_ids** | **String** | List of Companies House number to search, comma separated (Max: 50). | [optional] |
+| **symbols** | **String** | List of symbols to search, comma separated (Max: 50). | [optional] |
+| **sedols** | **String** | List of sedols to search, comma separated (Max: 50). | [optional] |
+| **sources** | **String** | List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **forms** | **String** | List of forms to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **gics** | **String** | List of gics to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **naics** | **String** | List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **exhibits** | **String** | List of exhibits to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **exchanges** | **String** | List of exchanges to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **countries** | **String** | List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **acts** | **String** | List of SEC's exchanges act to search, comma separated. Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **caps** | **String** | List of market capitalization to search, comma separated. Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **from_date** | **String** | Search from date in format: YYYY-MM-DD, default from the last 2 years | [optional] |
+| **to_date** | **String** | Search to date in format: YYYY-MM-DD, default to today | [optional] |
+| **page** | **String** | Use for pagination, default to page 1 | [optional] |
+| **sort** | **String** | Sort result by, default: sortMostRecent. Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **highlighted** | **Boolean** | Enable highlight in returned filings. If enabled, only return 10 results each time | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SearchBody.new(
+  query: null,
+  isins: null,
+  cusips: null,
+  ciks: null,
+  sedar_ids: null,
+  ch_ids: null,
+  symbols: null,
+  sedols: null,
+  sources: null,
+  forms: null,
+  gics: null,
+  naics: null,
+  exhibits: null,
+  exchanges: null,
+  countries: null,
+  acts: null,
+  caps: null,
+  from_date: null,
+  to_date: null,
+  page: null,
+  sort: null,
+  highlighted: null
+)
+```
+

data/docs/SearchFilter.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::SearchFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Filter id, use with respective field in search query body. | [optional] |
+| **name** | **String** | Display name. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SearchFilter.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/SearchResponse.md

@@ -0,0 +1,24 @@
+# FinnhubRuby::SearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | Total filing matched your search criteria. | [optional] |
+| **took** | **Integer** | Time took to execute your search query on our server, value in ms. | [optional] |
+| **page** | **Integer** | Current search page | [optional] |
+| **filings** | [**Array<FilingResponse>**](FilingResponse.md) | Filing match your search criteria. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SearchResponse.new(
+  count: null,
+  took: null,
+  page: null,
+  filings: null
+)
+```
+

data/docs/SentimentContent.md

@@ -0,0 +1,30 @@
+# FinnhubRuby::SentimentContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mention** | **Integer** | Number of mentions | [optional] |
+| **positive_mention** | **Integer** | Number of positive mentions | [optional] |
+| **negative_mention** | **Integer** | Number of negative mentions | [optional] |
+| **positive_score** | **Float** | Positive score. Range 0-1 | [optional] |
+| **negative_score** | **Float** | Negative score. Range 0-1 | [optional] |
+| **score** | **Float** | Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative | [optional] |
+| **at_time** | **String** | Period. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SentimentContent.new(
+  mention: null,
+  positive_mention: null,
+  negative_mention: null,
+  positive_score: null,
+  negative_score: null,
+  score: null,
+  at_time: null
+)
+```
+

data/docs/SocialSentiment.md

@@ -5,8 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Company symbol. | [optional] |
-| **reddit** | [**Array<RedditSentimentContent>**](RedditSentimentContent.md) | Reddit sentiment. | [optional] |
-| **twitter** | [**Array<TwitterSentimentContent>**](TwitterSentimentContent.md) | Twitter sentiment. | [optional] |
+| **data** | [**Array<SentimentContent>**](SentimentContent.md) | Sentiment data. | [optional] |
 
 ## Example
 
@@ -15,8 +14,7 @@ require 'finnhub_ruby'
 
 instance = FinnhubRuby::SocialSentiment.new(
   symbol: null,
-  reddit: null,
-  twitter: null
+  data: null
 )
 ```
 

data/finnhub_ruby.gemspec

@@ -3,7 +3,7 @@
 =begin
 #Finnhub API
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#Ruby client for Finnhub API
 
 The version of the OpenAPI document: 1.0.0
 
@@ -19,20 +19,20 @@ Gem::Specification.new do |s|
   s.name        = "finnhub_ruby"
   s.version     = FinnhubRuby::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["OpenAPI-Generator"]
-  s.email       = [""]
-  s.homepage    = "https://openapi-generator.tech"
+  s.authors     = ["Finnhub"]
+  s.email       = ["support@finnhub.io"]
+  s.homepage    = "https://github.com/Finnhub-Stock-API/finnhub-ruby"
   s.summary     = "Finnhub API Ruby Gem"
-  s.description = "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)"
-  s.license     = "Unlicense"
+  s.description = "Ruby client for Finnhub API. Finnhub API provides real-time stock price, crypto, and forex data."
+  s.license     = "Apache-2.0"
   s.required_ruby_version = ">= 2.4"
 
-  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.3'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
 
-  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
-  s.test_files    = `find spec/*`.split("\n")
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.executables   = []
   s.require_paths = ["lib"]
 end

data/lib/finnhub_ruby/version.rb

@@ -1,15 +1,3 @@
-=begin
-#Finnhub API
-
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-The version of the OpenAPI document: 1.0.0
-
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
-
-=end
-
 module FinnhubRuby
-  VERSION = '1.1.18'
-end
+  VERSION = "2.0.0"
+end