finnhub_ruby 1.1.16 → 1.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e7bac941b8f3c132c056f81150cdf4df5c9a090516deb7d9c8c3f2f0f0d7531
-  data.tar.gz: 7902eb891dfa9aa9a8a3c8ebe301f4b2703ed5175aefde9caeead3fbad2a6ea3
+  metadata.gz: 840da9e6e0893fda73e5b4ee3943a54a5a5e54d9163ff43b4a7a8925e4db121a
+  data.tar.gz: 2cc86c1ecc481e58b0df75ada3bc472c54baf83dd20e1cffb1f185feda1ca955
 SHA512:
-  metadata.gz: bee858deb0f608f67b7c59e97fed2412d4e7dac705e6b11260c03b09a952ae095442f723f796de3dece6ecbb2a25da8abca7708289c5820fa8689d3bc9d5debf
-  data.tar.gz: ea7a78b43a3c1ef3313367ac53f62d43d1e2b3ebe250fbacb8553a241c8dc2582f85e8a117fb0d9edf1a0699ef62104ebc45ed7c1386f8fd3aeeaf76cd5a55e5
+  metadata.gz: c7cc0a9a720915e41db73ec91cfec803454ddd3962ab6bde38dc60a84a1dd4fc18b4749e903ec34f1ba0f2f6e6d4353728a141defd3137649075fe558ccd32e1
+  data.tar.gz: 62ab3be671f5dca7b274a361fca6695dd3c3e7fed067f716303fc561e54f81ea17bf6a1c5f0084feaece85ac5fbb2fdc13a3d62d5c355f07faf9ccaede3f470c

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.16
+- Package version: 1.1.17
 
 ## 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.16'
+gem 'finnhub_ruby', '~> 1.1.17'
 ```
 
 ## Getting Started

data/docs/Company.md

@@ -7,7 +7,7 @@
 | **name** | **String** | Executive name | [optional] |
 | **age** | **Integer** | Age | [optional] |
 | **title** | **String** | Title | [optional] |
-| **since** | **String** | Year appointed | [optional] |
+| **since** | **String** | Year first appointed as executive/director of the company | [optional] |
 | **sex** | **String** | Sex | [optional] |
 | **compensation** | **Integer** | Total compensation | [optional] |
 | **currency** | **String** | Compensation currency | [optional] |

data/docs/DefaultApi.md

@@ -64,6 +64,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
 | [**quote**](DefaultApi.md#quote) | **GET** /quote | Quote |
 | [**recommendation_trends**](DefaultApi.md#recommendation_trends) | **GET** /stock/recommendation | Recommendation Trends |
 | [**revenue_breakdown**](DefaultApi.md#revenue_breakdown) | **GET** /stock/revenue-breakdown | Revenue Breakdown |
+| [**sector_metric**](DefaultApi.md#sector_metric) | **GET** /sector/metrics | Sector Metrics |
 | [**similarity_index**](DefaultApi.md#similarity_index) | **GET** /stock/similarity-index | Similarity Index |
 | [**social_sentiment**](DefaultApi.md#social_sentiment) | **GET** /stock/social-sentiment | Social Sentiment |
 | [**stock_basic_dividends**](DefaultApi.md#stock_basic_dividends) | **GET** /stock/dividend2 | Dividends 2 (Basic) |
@@ -3329,7 +3330,7 @@ end
 
 International Filings
 
-List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
+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.
 
 ### Examples
 
@@ -4136,7 +4137,7 @@ end
 
 Major Press Releases
 
-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>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>
 
 ### Examples
 
@@ -4495,6 +4496,77 @@ end
 - **Accept**: application/json
 
 
+## sector_metric
+
+> <SectorMetric> sector_metric(region)
+
+Sector Metrics
+
+Get ratios for different sectors and regions/indices.
+
+### Examples
+
+```ruby
+require 'time'
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+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>.
+
+begin
+  # Sector Metrics
+  result = api_instance.sector_metric(region)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->sector_metric: #{e}"
+end
+```
+
+#### Using the sector_metric_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SectorMetric>, Integer, Hash)> sector_metric_with_http_info(region)
+
+```ruby
+begin
+  # Sector Metrics
+  data, status_code, headers = api_instance.sector_metric_with_http_info(region)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SectorMetric>
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->sector_metric_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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;. |  |
+
+### Return type
+
+[**SectorMetric**](SectorMetric.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## similarity_index
 
 > <SimilarityIndex> similarity_index(opts)

data/docs/KeyCustomersSuppliers.md

@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Symbol | [optional] |
 | **name** | **String** | Name | [optional] |
+| **country** | **String** | Country | [optional] |
+| **industry** | **String** | Industry | [optional] |
 | **customer** | **Boolean** | Whether the company is a customer. | [optional] |
 | **supplier** | **Boolean** | Whether the company is a supplier | [optional] |
 | **one_month_correlation** | **Float** | 1-month price correlation | [optional] |
@@ -23,6 +25,8 @@ require 'finnhub_ruby'
 instance = FinnhubRuby::KeyCustomersSuppliers.new(
   symbol: null,
   name: null,
+  country: null,
+  industry: null,
   customer: null,
   supplier: null,
   one_month_correlation: null,

data/docs/MutualFundProfileData.md

@@ -29,6 +29,8 @@
 | **series_name** | **String** | Fund's series name. | [optional] |
 | **class_id** | **String** | Class ID. | [optional] |
 | **class_name** | **String** | Class name. | [optional] |
+| **sfdr_classification** | **String** | SFDR classification for EU funds. Under the new classifications, a fund'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] |
+| **currency** | **String** | Fund's currency | [optional] |
 
 ## Example
 
@@ -60,7 +62,9 @@ instance = FinnhubRuby::MutualFundProfileData.new(
   series_id: null,
   series_name: null,
   class_id: null,
-  class_name: null
+  class_name: null,
+  sfdr_classification: null,
+  currency: null
 )
 ```
 

data/docs/SectorMetric.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::SectorMetric
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **region** | **String** | Region. | [optional] |
+| **data** | [**Array<SectorMetricData>**](SectorMetricData.md) | Metrics for each sector. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SectorMetric.new(
+  region: null,
+  data: null
+)
+```
+

data/docs/SectorMetricData.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::SectorMetricData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sector** | **String** | Sector | [optional] |
+| **metrics** | **Object** | Metrics data in key-value format. <code>a</code> and <code>m</code> fields are for average and median respectively. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SectorMetricData.new(
+  sector: null,
+  metrics: null
+)
+```
+

data/lib/finnhub_ruby/api/default_api.rb

@@ -2966,7 +2966,7 @@ module FinnhubRuby
     end
 
     # International Filings
-    # List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
+    # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :symbol Symbol. Leave empty to list latest filings.
     # @option opts [String] :country Filter by country using country's 2-letter code.
@@ -2977,7 +2977,7 @@ module FinnhubRuby
     end
 
     # International Filings
-    # List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
+    # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :symbol Symbol. Leave empty to list latest filings.
     # @option opts [String] :country Filter by country using country's 2-letter code.
@@ -3690,7 +3690,7 @@ module FinnhubRuby
     end
 
     # Major Press Releases
-    # 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>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>
     # @param symbol [String] Company symbol.
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :from From time: 2020-01-01.
@@ -3702,7 +3702,7 @@ module FinnhubRuby
     end
 
     # Major Press Releases
-    # 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.
+    # &lt;p&gt;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.&lt;/p&gt;&lt;p&gt;Full-text press releases data is available for Enterprise clients. &lt;a href&#x3D;\&quot;mailto:support@finnhub.io\&quot;&gt;Contact Us&lt;/a&gt; to learn more.&lt;/p&gt;
     # @param symbol [String] Company symbol.
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :from From time: 2020-01-01.
@@ -4014,6 +4014,70 @@ module FinnhubRuby
       return data, status_code, headers
     end
 
+    # Sector Metrics
+    # Get ratios for different sectors and regions/indices.
+    # @param 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;.
+    # @param [Hash] opts the optional parameters
+    # @return [SectorMetric]
+    def sector_metric(region, opts = {})
+      data, _status_code, _headers = sector_metric_with_http_info(region, opts)
+      data
+    end
+
+    # Sector Metrics
+    # Get ratios for different sectors and regions/indices.
+    # @param 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;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SectorMetric, Integer, Hash)>] SectorMetric data, response status code and response headers
+    def sector_metric_with_http_info(region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.sector_metric ...'
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling DefaultApi.sector_metric"
+      end
+      # resource path
+      local_var_path = '/sector/metrics'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'region'] = region
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SectorMetric'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.sector_metric",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#sector_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Similarity Index
     # <p>Calculate the textual difference between a company's 10-K / 10-Q reports and the same type of report in the previous year using Cosine Similarity. For example, this endpoint compares 2019's 10-K with 2018's 10-K. Companies breaking from its routines in disclosure of financial condition and risk analysis section can signal a significant change in the company's stock price in the upcoming 4 quarters.</p>
     # @param [Hash] opts the optional parameters

data/lib/finnhub_ruby/models/company.rb

@@ -24,7 +24,7 @@ module FinnhubRuby
     # Title
     attr_accessor :title
 
-    # Year appointed
+    # Year first appointed as executive/director of the company
     attr_accessor :since
 
     # Sex

data/lib/finnhub_ruby/models/key_customers_suppliers.rb

@@ -21,6 +21,12 @@ module FinnhubRuby
     # Name
     attr_accessor :name
 
+    # Country
+    attr_accessor :country
+
+    # Industry
+    attr_accessor :industry
+
     # Whether the company is a customer.
     attr_accessor :customer
 
@@ -50,6 +56,8 @@ module FinnhubRuby
       {
         :'symbol' => :'symbol',
         :'name' => :'name',
+        :'country' => :'country',
+        :'industry' => :'industry',
         :'customer' => :'customer',
         :'supplier' => :'supplier',
         :'one_month_correlation' => :'oneMonthCorrelation',
@@ -71,6 +79,8 @@ module FinnhubRuby
       {
         :'symbol' => :'String',
         :'name' => :'String',
+        :'country' => :'String',
+        :'industry' => :'String',
         :'customer' => :'Boolean',
         :'supplier' => :'Boolean',
         :'one_month_correlation' => :'Float',
@@ -111,6 +121,14 @@ module FinnhubRuby
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'industry')
+        self.industry = attributes[:'industry']
+      end
+
       if attributes.key?(:'customer')
         self.customer = attributes[:'customer']
       end
@@ -164,6 +182,8 @@ module FinnhubRuby
       self.class == o.class &&
           symbol == o.symbol &&
           name == o.name &&
+          country == o.country &&
+          industry == o.industry &&
           customer == o.customer &&
           supplier == o.supplier &&
           one_month_correlation == o.one_month_correlation &&
@@ -183,7 +203,7 @@ module FinnhubRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, name, customer, supplier, one_month_correlation, one_year_correlation, six_month_correlation, three_month_correlation, two_week_correlation, two_year_correlation].hash
+      [symbol, name, country, industry, customer, supplier, one_month_correlation, one_year_correlation, six_month_correlation, three_month_correlation, two_week_correlation, two_year_correlation].hash
     end
 
     # Builds the object from hash

data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb

@@ -90,6 +90,12 @@ module FinnhubRuby
     # Class name.
     attr_accessor :class_name
 
+    # SFDR classification for EU funds. Under the new classifications, a fund'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.”
+    attr_accessor :sfdr_classification
+
+    # Fund's currency
+    attr_accessor :currency
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -117,7 +123,9 @@ module FinnhubRuby
         :'series_id' => :'seriesId',
         :'series_name' => :'seriesName',
         :'class_id' => :'classId',
-        :'class_name' => :'className'
+        :'class_name' => :'className',
+        :'sfdr_classification' => :'sfdrClassification',
+        :'currency' => :'currency'
       }
     end
 
@@ -153,7 +161,9 @@ module FinnhubRuby
         :'series_id' => :'String',
         :'series_name' => :'String',
         :'class_id' => :'String',
-        :'class_name' => :'String'
+        :'class_name' => :'String',
+        :'sfdr_classification' => :'String',
+        :'currency' => :'String'
       }
     end
 
@@ -277,6 +287,14 @@ module FinnhubRuby
       if attributes.key?(:'class_name')
         self.class_name = attributes[:'class_name']
       end
+
+      if attributes.key?(:'sfdr_classification')
+        self.sfdr_classification = attributes[:'sfdr_classification']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -321,7 +339,9 @@ module FinnhubRuby
           series_id == o.series_id &&
           series_name == o.series_name &&
           class_id == o.class_id &&
-          class_name == o.class_name
+          class_name == o.class_name &&
+          sfdr_classification == o.sfdr_classification &&
+          currency == o.currency
     end
 
     # @see the `==` method
@@ -333,7 +353,7 @@ module FinnhubRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, category, investment_segment, total_nav, expense_ratio, benchmark, inception_date, description, fund_family, manager, status, beta, deferred_load, fee12b1, front_load, ira_min_investment, isin, cusip, max_redemption_fee, standard_min_investment, turnover, series_id, series_name, class_id, class_name].hash
+      [name, category, investment_segment, total_nav, expense_ratio, benchmark, inception_date, description, fund_family, manager, status, beta, deferred_load, fee12b1, front_load, ira_min_investment, isin, cusip, max_redemption_fee, standard_min_investment, turnover, series_id, series_name, class_id, class_name, sfdr_classification, currency].hash
     end
 
     # Builds the object from hash

data/lib/finnhub_ruby/models/sector_metric.rb

@@ -0,0 +1,231 @@
+=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
+
+require 'date'
+require 'time'
+
+module FinnhubRuby
+  class SectorMetric
+    # Region.
+    attr_accessor :region
+
+    # Metrics for each sector.
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'region' => :'region',
+        :'data' => :'data'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'region' => :'String',
+        :'data' => :'Array<SectorMetricData>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::SectorMetric` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FinnhubRuby::SectorMetric`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          region == o.region &&
+          data == o.data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [region, data].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = FinnhubRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/finnhub_ruby/models/sector_metric_data.rb

@@ -0,0 +1,229 @@
+=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
+
+require 'date'
+require 'time'
+
+module FinnhubRuby
+  class SectorMetricData
+    # Sector
+    attr_accessor :sector
+
+    # Metrics data in key-value format. <code>a</code> and <code>m</code> fields are for average and median respectively.
+    attr_accessor :metrics
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sector' => :'sector',
+        :'metrics' => :'metrics'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'sector' => :'String',
+        :'metrics' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::SectorMetricData` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FinnhubRuby::SectorMetricData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'sector')
+        self.sector = attributes[:'sector']
+      end
+
+      if attributes.key?(:'metrics')
+        self.metrics = attributes[:'metrics']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          sector == o.sector &&
+          metrics == o.metrics
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [sector, metrics].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = FinnhubRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/finnhub_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.1
 =end
 
 module FinnhubRuby
-  VERSION = '1.1.16'
+  VERSION = '1.1.17'
 end

data/lib/finnhub_ruby.rb

@@ -114,6 +114,8 @@ require 'finnhub_ruby/models/revenue_breakdown'
 require 'finnhub_ruby/models/revenue_estimates'
 require 'finnhub_ruby/models/revenue_estimates_info'
 require 'finnhub_ruby/models/sec_sentiment_analysis'
+require 'finnhub_ruby/models/sector_metric'
+require 'finnhub_ruby/models/sector_metric_data'
 require 'finnhub_ruby/models/sentiment'
 require 'finnhub_ruby/models/similarity_index'
 require 'finnhub_ruby/models/similarity_index_info'

data/spec/models/sector_metric_data_spec.rb

@@ -0,0 +1,40 @@
+=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
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FinnhubRuby::SectorMetricData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe FinnhubRuby::SectorMetricData do
+  let(:instance) { FinnhubRuby::SectorMetricData.new }
+
+  describe 'test an instance of SectorMetricData' do
+    it 'should create an instance of SectorMetricData' do
+      expect(instance).to be_instance_of(FinnhubRuby::SectorMetricData)
+    end
+  end
+  describe 'test attribute "sector"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "metrics"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/sector_metric_spec.rb

@@ -0,0 +1,40 @@
+=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
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FinnhubRuby::SectorMetric
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe FinnhubRuby::SectorMetric do
+  let(:instance) { FinnhubRuby::SectorMetric.new }
+
+  describe 'test an instance of SectorMetric' do
+    it 'should create an instance of SectorMetric' do
+      expect(instance).to be_instance_of(FinnhubRuby::SectorMetric)
+    end
+  end
+  describe 'test attribute "region"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finnhub_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.16
+  version: 1.1.17
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -161,6 +161,8 @@ files:
 - docs/RevenueEstimates.md
 - docs/RevenueEstimatesInfo.md
 - docs/SECSentimentAnalysis.md
+- docs/SectorMetric.md
+- docs/SectorMetricData.md
 - docs/Sentiment.md
 - docs/SimilarityIndex.md
 - docs/SimilarityIndexInfo.md
@@ -193,6 +195,7 @@ files:
 - finnhub_ruby-1.1.13.gem
 - finnhub_ruby-1.1.14.gem
 - finnhub_ruby-1.1.15.gem
+- finnhub_ruby-1.1.16.gem
 - finnhub_ruby-1.1.7.gem
 - finnhub_ruby-1.1.8.gem
 - finnhub_ruby-1.1.9.gem
@@ -316,6 +319,8 @@ files:
 - lib/finnhub_ruby/models/revenue_estimates.rb
 - lib/finnhub_ruby/models/revenue_estimates_info.rb
 - lib/finnhub_ruby/models/sec_sentiment_analysis.rb
+- lib/finnhub_ruby/models/sector_metric.rb
+- lib/finnhub_ruby/models/sector_metric_data.rb
 - lib/finnhub_ruby/models/sentiment.rb
 - lib/finnhub_ruby/models/similarity_index.rb
 - lib/finnhub_ruby/models/similarity_index_info.rb
@@ -447,6 +452,8 @@ files:
 - spec/models/revenue_estimates_info_spec.rb
 - spec/models/revenue_estimates_spec.rb
 - spec/models/sec_sentiment_analysis_spec.rb
+- spec/models/sector_metric_data_spec.rb
+- spec/models/sector_metric_spec.rb
 - spec/models/sentiment_spec.rb
 - spec/models/similarity_index_info_spec.rb
 - spec/models/similarity_index_spec.rb
@@ -546,6 +553,7 @@ test_files:
 - spec/models/company_earnings_quality_score_data_spec.rb
 - spec/models/earnings_estimates_info_spec.rb
 - spec/models/forex_symbol_spec.rb
+- spec/models/sector_metric_spec.rb
 - spec/models/key_customers_suppliers_spec.rb
 - spec/models/symbol_lookup_info_spec.rb
 - spec/models/lobbying_data_spec.rb
@@ -601,6 +609,7 @@ test_files:
 - spec/models/quote_spec.rb
 - spec/models/filing_sentiment_spec.rb
 - spec/models/upgrade_downgrade_spec.rb
+- spec/models/sector_metric_data_spec.rb
 - spec/models/covid_info_spec.rb
 - spec/models/technical_analysis_spec.rb
 - spec/models/mutual_fund_country_exposure_spec.rb