intrinio-sdk 1.0.0 → 1.1.0

data/docs/StockExchangeApi.md

@@ -5,11 +5,12 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**filter_stock_exchanges**](StockExchangeApi.md#filter_stock_exchanges) | **GET** /stock_exchanges/filter | Filter Stock Exchanges
-[**get_all_stock_exchanges**](StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | Get All Stock Exchanges
-[**get_stock_exchange_by_id**](StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Get Stock Exchange by ID
-[**get_stock_exchange_price_adjustments**](StockExchangeApi.md#get_stock_exchange_price_adjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Get Stock Price Adjustments by Exchange
-[**get_stock_exchange_prices**](StockExchangeApi.md#get_stock_exchange_prices) | **GET** /stock_exchanges/{identifier}/prices | Get Stock Prices by Exchange
-[**get_stock_exchange_securities**](StockExchangeApi.md#get_stock_exchange_securities) | **GET** /stock_exchanges/{identifier}/securities | Get Securities by Exchange
+[**get_all_stock_exchanges**](StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | All Stock Exchanges
+[**get_stock_exchange_by_id**](StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
+[**get_stock_exchange_price_adjustments**](StockExchangeApi.md#get_stock_exchange_price_adjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Stock Price Adjustments by Exchange
+[**get_stock_exchange_prices**](StockExchangeApi.md#get_stock_exchange_prices) | **GET** /stock_exchanges/{identifier}/prices | Stock Prices by Exchange
+[**get_stock_exchange_realtime_prices**](StockExchangeApi.md#get_stock_exchange_realtime_prices) | **GET** /stock_exchanges/{identifier}/prices/realtime | Realtime Stock Prices by Exchange
+[**get_stock_exchange_securities**](StockExchangeApi.md#get_stock_exchange_securities) | **GET** /stock_exchanges/{identifier}/securities | Securities by Exchange
 
 
 # **filter_stock_exchanges**
@@ -17,7 +18,7 @@ Method | HTTP request | Description
 
 Filter Stock Exchanges
 
-Return Stock Exchanges matching the given filters
+Returns Stock Exchanges matching the given filters
 
 ### Example
 ```ruby
@@ -60,9 +61,9 @@ Name | Type | Description  | Notes
 # **get_all_stock_exchanges**
 > ApiResponseStockExchanges get_all_stock_exchanges
 
-Get All Stock Exchanges
+All Stock Exchanges
 
-Return All Stock Exchanges
+Returns all Stock Exchanges
 
 ### Example
 ```ruby
@@ -94,7 +95,9 @@ This endpoint does not need any parameter.
 # **get_stock_exchange_by_id**
 > StockExchange get_stock_exchange_by_id(identifier)
 
-Get Stock Exchange by ID
+Lookup Stock Exchange
+
+Returns the Stock Exchange with the given `identifier`
 
 ### Example
 ```ruby
@@ -132,9 +135,9 @@ Name | Type | Description  | Notes
 # **get_stock_exchange_price_adjustments**
 > ApiResponseStockExchangeStockPriceAdjustments get_stock_exchange_price_adjustments(identifier, opts)
 
-Get Stock Price Adjustments by Exchange
+Stock Price Adjustments by Exchange
 
-Return stock price adjustments for the Stock Exchange with the given `identifier`
+Returns stock price adjustments for the Stock Exchange with the given `identifier`
 
 ### Example
 ```ruby
@@ -178,9 +181,9 @@ Name | Type | Description  | Notes
 # **get_stock_exchange_prices**
 > ApiResponseStockExchangeStockPrices get_stock_exchange_prices(identifier, opts)
 
-Get Stock Prices by Exchange
+Stock Prices by Exchange
 
-Return daily Stock Prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available)
+Returns end-of-day stock prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available)
 
 ### Example
 ```ruby
@@ -221,12 +224,58 @@ Name | Type | Description  | Notes
 
 [**ApiResponseStockExchangeStockPrices**](ApiResponseStockExchangeStockPrices.md)
 
+# **get_stock_exchange_realtime_prices**
+> ApiResponseStockExchangeRealtimeStockPrices get_stock_exchange_realtime_prices(identifier, opts)
+
+Realtime Stock Prices by Exchange
+
+Returns realtime stock prices for the Stock Exchange with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+stockExchange_api = Intrinio::StockExchangeApi.new
+
+identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID)
+
+opts = { 
+  source: nil, # String | Return realtime prices from the specified data source
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = stockExchange_api.get_stock_exchange_realtime_prices(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling StockExchangeApi->get_stock_exchange_realtime_prices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) | 
+ **source** | **String**| Return realtime prices from the specified data source | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseStockExchangeRealtimeStockPrices**](ApiResponseStockExchangeRealtimeStockPrices.md)
+
 # **get_stock_exchange_securities**
 > ApiResponseStockExchangeSecurities get_stock_exchange_securities(identifier, opts)
 
-Get Securities by Exchange
+Securities by Exchange
 
-Return Securities traded on the Stock Exchange with `identifier`
+Returns Securities traded on the Stock Exchange with `identifier`
 
 ### Example
 ```ruby

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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -26,6 +26,8 @@ require 'intrinio-sdk/models/api_response_company_securities'
 require 'intrinio-sdk/models/api_response_data_tags'
 require 'intrinio-sdk/models/api_response_economic_index_historical_data'
 require 'intrinio-sdk/models/api_response_economic_indices'
+require 'intrinio-sdk/models/api_response_filing_notes'
+require 'intrinio-sdk/models/api_response_filing_notes_search'
 require 'intrinio-sdk/models/api_response_filings'
 require 'intrinio-sdk/models/api_response_historical_data'
 require 'intrinio-sdk/models/api_response_news'
@@ -37,6 +39,7 @@ require 'intrinio-sdk/models/api_response_security_historical_data'
 require 'intrinio-sdk/models/api_response_security_stock_price_adjustments'
 require 'intrinio-sdk/models/api_response_security_stock_prices'
 require 'intrinio-sdk/models/api_response_standardized_financials'
+require 'intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices'
 require 'intrinio-sdk/models/api_response_stock_exchange_securities'
 require 'intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments'
 require 'intrinio-sdk/models/api_response_stock_exchange_stock_prices'
@@ -50,13 +53,20 @@ require 'intrinio-sdk/models/company_news_summary'
 require 'intrinio-sdk/models/company_summary'
 require 'intrinio-sdk/models/data_tag'
 require 'intrinio-sdk/models/data_tag_summary'
+require 'intrinio-sdk/models/dividend_record'
+require 'intrinio-sdk/models/earnings_record'
 require 'intrinio-sdk/models/economic_index'
 require 'intrinio-sdk/models/economic_index_summary'
 require 'intrinio-sdk/models/filing'
+require 'intrinio-sdk/models/filing_note'
+require 'intrinio-sdk/models/filing_note_filing'
+require 'intrinio-sdk/models/filing_note_summary'
 require 'intrinio-sdk/models/filing_summary'
 require 'intrinio-sdk/models/fundamental'
 require 'intrinio-sdk/models/fundamental_summary'
 require 'intrinio-sdk/models/historical_data'
+require 'intrinio-sdk/models/realtime_stock_price'
+require 'intrinio-sdk/models/realtime_stock_price_security'
 require 'intrinio-sdk/models/reported_financial'
 require 'intrinio-sdk/models/reported_tag'
 require 'intrinio-sdk/models/sic_index'

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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -91,7 +91,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Filter Fundamentals for a Company
+    # Filter Fundamentals by Company
     # Returns Fundamentals for the Company with the given `identifier` and matching the specified filters
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -110,7 +110,7 @@ module Intrinio
       return data
     end
 
-    # Filter Fundamentals for a Company
+    # Filter Fundamentals by Company
     # Returns Fundamentals for the Company with the given `identifier` and matching the specified filters
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -177,8 +177,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get All Companies
-    # 
+    # All Companies
+    # Returns all Companies
     # @param [Hash] opts the optional parameters
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [ApiResponseCompanies]
@@ -187,8 +187,8 @@ module Intrinio
       return data
     end
 
-    # Get All Companies
-    # 
+    # All Companies
+    # Returns all Companies
     # @param [Hash] opts the optional parameters
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [Array<(ApiResponseCompanies, Fixnum, Hash)>] ApiResponseCompanies data, response status code and response headers
@@ -227,8 +227,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get All Company News
-    # Returns all news for all companies
+    # All News
+    # Returns all News for all Companies
     # @param [Hash] opts the optional parameters
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [ApiResponseNews]
@@ -237,8 +237,8 @@ module Intrinio
       return data
     end
 
-    # Get All Company News
-    # Returns all news for all companies
+    # All News
+    # Returns all News for all Companies
     # @param [Hash] opts the optional parameters
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [Array<(ApiResponseNews, Fixnum, Hash)>] ApiResponseNews data, response status code and response headers
@@ -277,8 +277,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get a Company by ID
-    # 
+    # Lookup Company
+    # Returns the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @return [Company]
@@ -287,8 +287,8 @@ module Intrinio
       return data
     end
 
-    # Get a Company by ID
-    # 
+    # Lookup Company
+    # Returns 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<(Company, Fixnum, Hash)>] Company data, response status code and response headers
@@ -330,7 +330,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Company Data Point (Number)
+    # 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)
     # @param tag An Intrinio data tag
@@ -341,7 +341,7 @@ module Intrinio
       return data
     end
 
-    # Get Company Data Point (Number)
+    # Data Point (Number) for Company
     # Returns a numeric value for the given &#x60;tag&#x60; for the Company with the given &#x60;identifier&#x60;
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param tag An Intrinio data tag
@@ -389,7 +389,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Company Data Point (Text)
+    # Data Point (Text) for Company
     # Returns a text value for the given `tag` for the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param tag An Intrinio data tag
@@ -400,7 +400,7 @@ module Intrinio
       return data
     end
 
-    # Get Company Data Point (Text)
+    # Data Point (Text) for Company
     # Returns a text value for the given &#x60;tag&#x60; for the Company with the given &#x60;identifier&#x60;
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param tag An Intrinio data tag
@@ -448,7 +448,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Filings for a Company
+    # All Filings by Company
     # Returns a complete list of SEC filings for the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -459,7 +459,7 @@ module Intrinio
       return data
     end
 
-    # Get Filings for a Company
+    # All Filings by Company
     # Returns a complete list of SEC filings 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
@@ -504,7 +504,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get All Fundamentals for a Company
+    # All Fundamentals by Company
     # Returns all Fundamentals for the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -515,7 +515,7 @@ module Intrinio
       return data
     end
 
-    # Get All Fundamentals for a Company
+    # All Fundamentals by Company
     # Returns all Fundamentals 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
@@ -560,11 +560,12 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Company Historical Data
+    # Historical Data for Company
     # Returns historical values for the given `tag` and the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-    # @param tag Item
+    # @param tag An Intrinio data-tag
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :frequency Return historical data in the given frequency (default to daily)
     # @option opts [String] :type Filter by type, when applicable
     # @option opts [Date] :start_date Get historical data on or after this date
     # @option opts [Date] :end_date Get historical data on or before this date
@@ -576,11 +577,12 @@ module Intrinio
       return data
     end
 
-    # Get Company Historical Data
+    # Historical Data for Company
     # Returns historical values for the given &#x60;tag&#x60; and the Company with the given &#x60;identifier&#x60;
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-    # @param tag Item
+    # @param tag An Intrinio data-tag
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :frequency Return historical data in the given frequency
     # @option opts [String] :type Filter by type, when applicable
     # @option opts [Date] :start_date Get historical data on or after this date
     # @option opts [Date] :end_date Get historical data on or before this date
@@ -599,6 +601,9 @@ module Intrinio
       if @api_client.config.client_side_validation && tag.nil?
         fail ArgumentError, "Missing the required parameter 'tag' when calling CompanyApi.get_company_historical_data"
       end
+      if @api_client.config.client_side_validation && opts[:'frequency'] && !['daily', 'weekly', 'monthly', 'quarterly', 'yearly'].include?(opts[:'frequency'])
+        fail ArgumentError, 'invalid value for "frequency", must be one of daily, weekly, monthly, quarterly, yearly'
+      end
       if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
         fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
       end
@@ -607,6 +612,7 @@ module Intrinio
 
       # query parameters
       query_params = {}
+      query_params[:'frequency'] = opts[:'frequency'] if !opts[:'frequency'].nil?
       query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
       query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
       query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
@@ -637,7 +643,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get News for a Company
+    # All News by Company
     # Returns news for the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -648,7 +654,7 @@ module Intrinio
       return data
     end
 
-    # Get News for a Company
+    # All News by Company
     # Returns news 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
@@ -693,8 +699,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get Securities by Company
-    # Return Securities for the Company with `identifier`
+    # All Securities by Company
+    # Returns Securities for the Company with the given `identifier`
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -704,8 +710,8 @@ module Intrinio
       return data
     end
 
-    # Get Securities by Company
-    # Return Securities for the Company with &#x60;identifier&#x60;
+    # All Securities by Company
+    # Returns Securities 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
     # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -749,7 +755,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Lookup a Fundamental for a Company
+    # Lookup Fundamental by Company
     # Returns the Fundamental for the Company with the given `identifier` and with the given parameters
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param statement_code The statement code
@@ -762,7 +768,7 @@ module Intrinio
       return data
     end
 
-    # Lookup a Fundamental for a Company
+    # Lookup Fundamental by Company
     # Returns the Fundamental for the Company with the given &#x60;identifier&#x60; and with the given parameters
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param statement_code The statement code

data/lib/intrinio-sdk/api/data_point_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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -20,7 +20,7 @@ module Intrinio
       @api_client = api_client
     end
 
-    # Get a Data Point (Number)
+    # Data Point (Number)
     # Returns a numeric value for the given `tag` and the entity with the given `identifier`
     # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
     # @param tag An Intrinio data tag ID or code-name
@@ -31,7 +31,7 @@ module Intrinio
       return data
     end
 
-    # Get a Data Point (Number)
+    # Data Point (Number)
     # Returns a numeric value for the given `tag` and the entity with the given `identifier`
     # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
     # @param tag An Intrinio data tag ID or code-name
@@ -79,7 +79,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get a Data Point (Text)
+    # Data Point (Text)
     # Returns a text value for the given `tag` and the entity with the given `identifier`
     # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
     # @param tag An Intrinio data tag ID or code-name
@@ -90,7 +90,7 @@ module Intrinio
       return data
     end
 
-    # Get a Data Point (Text)
+    # Data Point (Text)
     # Returns a text value for the given `tag` and the entity with the given `identifier`
     # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
     # @param tag An Intrinio data tag ID or code-name