intrinio-sdk 5.9.1 → 5.13.1

data/docs/RealtimeStockPrice.md

@@ -20,7 +20,7 @@ Name | Type | Description
 **ask_price** | Float | The price of the top ask order.  
 **ask_size** | Float | The size of the top ask order.  
 **open_price** | Float | The price at the open of the trading day.  
-**close_price** | Float | The price at the close of the trading day.  
+**close_price** | Float | The price at the close of the trading day. (IEX only)  
 **high_price** | Float | The high price for the trading day.  
 **low_price** | Float | The low price for the trading day.  
 **exchange_volume** | Float | The number of shares exchanged during the trading day on the exchange.  

data/docs/SecurityApi.md

@@ -48,7 +48,7 @@ Method | HTTP request | Description
 [**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
 [**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
 [**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
-[**get_security_zacks_analyst_ratings**](SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings
+[**get_security_zacks_analyst_ratings**](SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security
 [**get_security_zacks_analyst_ratings_snapshot**](SecurityApi.md#get_security_zacks_analyst_ratings_snapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot
 [**get_security_zacks_eps_surprises**](SecurityApi.md#get_security_zacks_eps_surprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security
 [**get_security_zacks_sales_surprises**](SecurityApi.md#get_security_zacks_sales_surprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security
@@ -4051,7 +4051,7 @@ Name | Type | Description  | Notes
 
 > ApiResponseSecurityZacksAnalystRatings get_security_zacks_analyst_ratings(identifier, opts)
 
-#### Zacks Analyst Ratings
+#### Zacks Analyst Ratings for Security
 
 
 Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given `identifier`. Zack’s storied research team aggregates and validates the ratings from professional analysts.

data/docs/StockPriceSummary.md

@@ -25,6 +25,13 @@ Name | Type | Description
 **adj_low** | Float | The lowest price over the span of the period, adjusted for splits and dividends  
 **adj_close** | Float | The price at the end of the period, adjusted for splits and dividends  
 **adj_volume** | Float | The number of shares exchanged during the period, adjusted for splits and dividends  
+**factor** | Float | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.  
+**split_ratio** | Float | The ratio of the stock split, if a stock split occurred.  
+**dividend** | Float | The dividend amount, if a dividend was paid.  
+**change** | Float | The difference in price from the last price for this frequency  
+**percent_change** | Float | The percent difference in price from the last price for this frequency  
+**fifty_two_week_high** | Float | The 52 week high price (daily only)  
+**fifty_two_week_low** | Float | The 52 week low price (daily only)  
 
 [//]: # (END_DEFINITION)
 

data/docs/TheaEntityAnswer.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::TheaEntityAnswer)
+
+[//]: # (KIND:object)
+
+### Intrinio::TheaEntityAnswer
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**answer** | String | The summarized answer returned from Thea  
+**content** | String | The underlying content the answer was sourced from  
+**source_documents** | [**Array<TheaSourceDocument>**](TheaSourceDocument.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::TheaSourceDocument)
+
+
+

data/docs/TheaSourceDocument.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::TheaSourceDocument)
+
+[//]: # (KIND:object)
+
+### Intrinio::TheaSourceDocument
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The unique id for the Thea source document  
+**tags** | [**Array<TheaSourceDocumentTags>**](TheaSourceDocumentTags.md) | Entity identifying tags associated with the source document  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::TheaSourceDocumentTags)
+
+
+

data/docs/TheaSourceDocumentTags.md

@@ -0,0 +1,21 @@
+
+
+[//]: # (CLASS:Intrinio::TheaSourceDocumentTags)
+
+[//]: # (KIND:object)
+
+### Intrinio::TheaSourceDocumentTags
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**key** | String | Defintes whether the tag is a key or a value  
+**value** | String | The value of the tag  
+
+[//]: # (END_DEFINITION)
+
+
+

data/intrinio-sdk.gemspec

@@ -5,7 +5,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.19.0
+OpenAPI spec version: 2.23.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.19.0
+OpenAPI spec version: 2.23.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -21,12 +21,15 @@ require 'intrinio-sdk/models/accumulation_distribution_index_technical_value'
 require 'intrinio-sdk/models/api_response_bulk_download_links'
 require 'intrinio-sdk/models/api_response_companies'
 require 'intrinio-sdk/models/api_response_companies_search'
+require 'intrinio-sdk/models/api_response_company_answers'
 require 'intrinio-sdk/models/api_response_company_filings'
 require 'intrinio-sdk/models/api_response_company_fundamentals'
 require 'intrinio-sdk/models/api_response_company_historical_data'
 require 'intrinio-sdk/models/api_response_company_insider_transaction_filings'
 require 'intrinio-sdk/models/api_response_company_news'
+require 'intrinio-sdk/models/api_response_company_recognize'
 require 'intrinio-sdk/models/api_response_company_securities'
+require 'intrinio-sdk/models/api_response_company_shares_outstanding'
 require 'intrinio-sdk/models/api_response_data_tags'
 require 'intrinio-sdk/models/api_response_data_tags_search'
 require 'intrinio-sdk/models/api_response_etf_holdings'
@@ -53,7 +56,10 @@ require 'intrinio-sdk/models/api_response_options_chain'
 require 'intrinio-sdk/models/api_response_options_chain_realtime'
 require 'intrinio-sdk/models/api_response_options_expirations'
 require 'intrinio-sdk/models/api_response_options_price_realtime'
+require 'intrinio-sdk/models/api_response_options_prices_batch_realtime'
+require 'intrinio-sdk/models/api_response_options_realtime'
 require 'intrinio-sdk/models/api_response_options_stats_realtime'
+require 'intrinio-sdk/models/api_response_options_tickers'
 require 'intrinio-sdk/models/api_response_owner_insider_transaction_filings'
 require 'intrinio-sdk/models/api_response_owner_institutional_holdings'
 require 'intrinio-sdk/models/api_response_owners'
@@ -138,6 +144,7 @@ require 'intrinio-sdk/models/company_filing'
 require 'intrinio-sdk/models/company_initial_public_offering'
 require 'intrinio-sdk/models/company_news'
 require 'intrinio-sdk/models/company_news_summary'
+require 'intrinio-sdk/models/company_shares_outstanding'
 require 'intrinio-sdk/models/company_summary'
 require 'intrinio-sdk/models/data_tag'
 require 'intrinio-sdk/models/data_tag_summary'
@@ -184,8 +191,10 @@ require 'intrinio-sdk/models/on_balance_volume_technical_value'
 require 'intrinio-sdk/models/option'
 require 'intrinio-sdk/models/option_chain'
 require 'intrinio-sdk/models/option_chain_realtime'
+require 'intrinio-sdk/models/option_contracts_list'
 require 'intrinio-sdk/models/option_factors_realtime'
 require 'intrinio-sdk/models/option_price'
+require 'intrinio-sdk/models/option_price_batch_realtime'
 require 'intrinio-sdk/models/option_price_realtime'
 require 'intrinio-sdk/models/option_realtime'
 require 'intrinio-sdk/models/option_stats_realtime'
@@ -216,6 +225,9 @@ require 'intrinio-sdk/models/stock_price_adjustment_summary'
 require 'intrinio-sdk/models/stock_price_interval'
 require 'intrinio-sdk/models/stock_price_summary'
 require 'intrinio-sdk/models/technical_indicator'
+require 'intrinio-sdk/models/thea_entity_answer'
+require 'intrinio-sdk/models/thea_source_document'
+require 'intrinio-sdk/models/thea_source_document_tags'
 require 'intrinio-sdk/models/triple_exponential_average_technical_value'
 require 'intrinio-sdk/models/true_strength_index_technical_value'
 require 'intrinio-sdk/models/ultimate_oscillator_technical_value'

data/lib/intrinio-sdk/api/bulk_downloads_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.19.0
+OpenAPI spec version: 2.23.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/company_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.19.0
+OpenAPI spec version: 2.23.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -57,8 +57,8 @@ module Intrinio
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: CompanyApi.get_all_companies ..."
       end
-      if @api_client.config.client_side_validation && opts[:'template'] && !['industrial', 'financial'].include?(opts[:'template'])
-        fail ArgumentError, 'invalid value for "template", must be one of industrial, financial'
+      if @api_client.config.client_side_validation && opts[:'template'] && !['indu', 'fin'].include?(opts[:'template'])
+        fail ArgumentError, 'invalid value for "template", must be one of indu, fin'
       end
       if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
         fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CompanyApi.get_all_companies, must be smaller than or equal to 10000.'
@@ -214,6 +214,66 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Company Answers
+    # Returns answers for a question about the Company with the given `identifier`
+    # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @param query The query to ask the Thea API
+    # @param [Hash] opts the optional parameters
+    # @return [ApiResponseCompanyAnswers]
+    def get_company_answers(identifier, query, opts = {})
+      data, _status_code, _headers = get_company_answers_with_http_info(identifier, query, opts)
+      return data
+    end
+
+    # Company Answers
+    # Returns answers for a question about the Company with the given `identifier`
+    # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @param query The query to ask the Thea API
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiResponseCompanyAnswers, Fixnum, Hash)>] ApiResponseCompanyAnswers data, response status code and response headers
+    def get_company_answers_with_http_info(identifier, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CompanyApi.get_company_answers ..."
+      end
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling CompanyApi.get_company_answers"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling CompanyApi.get_company_answers"
+      end
+      # resource path
+      local_var_path = "/companies/{identifier}/answers".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseCompanyAnswers')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompanyApi#get_company_answers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Data Point (Number) for Company
     # Returns a numeric value for the given `tag` for the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
@@ -863,10 +923,6 @@ module Intrinio
     # Returns the latest insider transaction filing for a company.
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
-    # @option opts [Date] :start_date Return Company&#39;s insider transaction filings on or after this date
-    # @option opts [Date] :end_date Return Company&#39;s insider transaction filings on or before this date
-    # @option opts [String] :ownership_type The type of ownership to return transaction filings for. &#39;D&#39; is for direct transactions. &#39;I&#39; is for indirect transactions. Omit for both types.
-    # @option opts [Integer] :page_size The number of results to return (default to 100)
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [InsiderTransactionFiling]
     def latest_insider_transaction_filing_by_company(identifier, opts = {})
@@ -878,10 +934,6 @@ module Intrinio
     # Returns the latest insider transaction filing for a company.
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
-    # @option opts [Date] :start_date Return Company&#39;s insider transaction filings on or after this date
-    # @option opts [Date] :end_date Return Company&#39;s insider transaction filings on or before this date
-    # @option opts [String] :ownership_type The type of ownership to return transaction filings for. &#39;D&#39; is for direct transactions. &#39;I&#39; is for indirect transactions. Omit for both types.
-    # @option opts [Integer] :page_size The number of results to return
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [Array<(InsiderTransactionFiling, Fixnum, Hash)>] InsiderTransactionFiling data, response status code and response headers
     def latest_insider_transaction_filing_by_company_with_http_info(identifier, opts = {})
@@ -892,19 +944,11 @@ module Intrinio
       if @api_client.config.client_side_validation && identifier.nil?
         fail ArgumentError, "Missing the required parameter 'identifier' when calling CompanyApi.latest_insider_transaction_filing_by_company"
       end
-      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
-        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CompanyApi.latest_insider_transaction_filing_by_company, must be smaller than or equal to 10000.'
-      end
-
       # resource path
       local_var_path = "/companies/{identifier}/insider_transaction_filings/latest".sub('{' + 'identifier' + '}', identifier.to_s)
 
       # query parameters
       query_params = {}
-      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
-      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
-      query_params[:'ownership_type'] = opts[:'ownership_type'] if !opts[:'ownership_type'].nil?
-      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
 
       # header parameters
@@ -1010,6 +1054,60 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Recognize Company
+    # Returns a list of companies recognized by the Thea API in the given `text` query string parameter.
+    # @param text The text sent to the Thea API to analyze
+    # @param [Hash] opts the optional parameters
+    # @return [ApiResponseCompanyRecognize]
+    def recognize_company(text, opts = {})
+      data, _status_code, _headers = recognize_company_with_http_info(text, opts)
+      return data
+    end
+
+    # Recognize Company
+    # Returns a list of companies recognized by the Thea API in the given &#x60;text&#x60; query string parameter.
+    # @param text The text sent to the Thea API to analyze
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiResponseCompanyRecognize, Fixnum, Hash)>] ApiResponseCompanyRecognize data, response status code and response headers
+    def recognize_company_with_http_info(text, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CompanyApi.recognize_company ..."
+      end
+      # verify the required parameter 'text' is set
+      if @api_client.config.client_side_validation && text.nil?
+        fail ArgumentError, "Missing the required parameter 'text' when calling CompanyApi.recognize_company"
+      end
+      # resource path
+      local_var_path = "/companies/recognize"
+
+      # query parameters
+      query_params = {}
+      query_params[:'text'] = text
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseCompanyRecognize')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompanyApi#recognize_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search Companies
     # Searches for Companies matching the text `query`
     # @param query Search parameters
@@ -1073,5 +1171,58 @@ module Intrinio
       end
       return data, status_code, headers
     end
+
+    # Shares Outstanding by Company
+    # Returns shares outstanding for the Company with the given `identifier`
+    # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @param [Hash] opts the optional parameters
+    # @return [ApiResponseCompanySharesOutstanding]
+    def shares_outstanding_by_company(identifier, opts = {})
+      data, _status_code, _headers = shares_outstanding_by_company_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Shares Outstanding by Company
+    # Returns shares outstanding for the Company with the given &#x60;identifier&#x60;
+    # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiResponseCompanySharesOutstanding, Fixnum, Hash)>] ApiResponseCompanySharesOutstanding data, response status code and response headers
+    def shares_outstanding_by_company_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CompanyApi.shares_outstanding_by_company ..."
+      end
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling CompanyApi.shares_outstanding_by_company"
+      end
+      # resource path
+      local_var_path = "/companies/{identifier}/shares_outstanding".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseCompanySharesOutstanding')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompanyApi#shares_outstanding_by_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end