intrinio-sdk 6.41.0 → 6.43.0

data/docs/SecurityApi.md

@@ -5,6 +5,8 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_all_securities**](SecurityApi.md#get_all_securities) | **GET** /securities | All Securities
+[**get_securities_latest_dividend_records**](SecurityApi.md#get_securities_latest_dividend_records) | **GET** /securities/dividends/latest | Latest Dividend Records for All Securities
+[**get_securities_latest_earnings_records**](SecurityApi.md#get_securities_latest_earnings_records) | **GET** /securities/earnings/latest | Latest Earnings Records for All Securities
 [**get_securities_short_interest**](SecurityApi.md#get_securities_short_interest) | **GET** /securities/short_interest | Latest Short Interest
 [**get_security_by_id**](SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Lookup Security
 [**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security
@@ -186,6 +188,182 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::SecurityApi)
+
+[//]: # (METHOD:get_securities_latest_dividend_records)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecuritiesDividendLatest)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritiesDividendLatest.md)
+
+[//]: # (OPERATION:get_securities_latest_dividend_records_v2)
+
+[//]: # (ENDPOINT:/securities/dividends/latest)
+
+[//]: # (DOCUMENT_LINK:SecurityApi.md#get_securities_latest_dividend_records)
+
+## **get_securities_latest_dividend_records**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_securities_latest_dividend_records_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseSecuritiesDividendLatest get_securities_latest_dividend_records(opts)
+
+#### Latest Dividend Records for All Securities
+
+
+Returns the latest available dividend information for all securities. Returns one dividend record per security, limited to records from the last 90 days, sorted by date_loaded in descending order.
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+
+security_api = Intrinio::SecurityApi.new
+
+opts = {
+  page_size: 100,
+  next_page: nil,
+  date: Date.parse("2013-10-20"),
+  identifiers: "AAPL,MSFT",
+  next_page2: nil
+}
+
+result = security_api.get_securities_latest_dividend_records(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+ **date** | Date| Return dividend records on or before this date. Format YYYY-MM-DD | [optional]   
+ **identifiers** | String| A comma-delimited list of security identifiers (tickers, CUSIPs, ISINs, etc.) | [optional]   
+ **next_page2** | String| Gets the next page of data from a previous API call | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseSecuritiesDividendLatest**](ApiResponseSecuritiesDividendLatest.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::SecurityApi)
+
+[//]: # (METHOD:get_securities_latest_earnings_records)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecuritiesEarningsLatest)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritiesEarningsLatest.md)
+
+[//]: # (OPERATION:get_securities_latest_earnings_records_v2)
+
+[//]: # (ENDPOINT:/securities/earnings/latest)
+
+[//]: # (DOCUMENT_LINK:SecurityApi.md#get_securities_latest_earnings_records)
+
+## **get_securities_latest_earnings_records**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_securities_latest_earnings_records_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseSecuritiesEarningsLatest get_securities_latest_earnings_records(opts)
+
+#### Latest Earnings Records for All Securities
+
+
+Returns the latest available earnings information for all securities. Returns one earnings record per security, limited to records from the last 90 days, sorted by date_loaded in descending order.
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+
+security_api = Intrinio::SecurityApi.new
+
+opts = {
+  page_size: 100,
+  next_page: nil,
+  date: Date.parse("2013-10-20"),
+  identifiers: "AAPL,MSFT",
+  next_page2: nil
+}
+
+result = security_api.get_securities_latest_earnings_records(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+ **date** | Date| Return earnings records on or before this date. Format YYYY-MM-DD | [optional]   
+ **identifiers** | String| A comma-delimited list of security identifiers (tickers, CUSIPs, ISINs, etc.) | [optional]   
+ **next_page2** | String| Gets the next page of data from a previous API call | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseSecuritiesEarningsLatest**](ApiResponseSecuritiesEarningsLatest.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::SecurityApi)
@@ -315,7 +493,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 result = security_api.get_security_by_id(identifier)
 pp result
@@ -372,7 +550,7 @@ Name | Type | Description  | Notes
 #### Data Point (Number) for Security
 
 
-Returns a numeric value for the given `tag` for the Security with the given `identifier`
+$$v2_security_data_point_number_description$$
 
 [//]: # (END_OVERVIEW)
 
@@ -392,8 +570,8 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
-tag = "close_price"
+identifier = "$$v2_security_data_point_identifier_default$$"
+tag = "$$v2_security_data_point_item_number_default$$"
 
 result = security_api.get_security_data_point_number(identifier, tag)
 pp result
@@ -410,8 +588,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   
- **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
+ **identifier** | String| $$v2_security_data_point_identifier_description$$ |   
+ **tag** | String| $$v2_security_data_point_item_description$$ |   
 
 [//]: # (END_PARAMETERS)
 
@@ -451,7 +629,7 @@ Name | Type | Description  | Notes
 #### Data Point (Text) for Security
 
 
-Returns a text value for the given `tag` for the Security with the given `identifier`
+$$v2_security_data_point_text_description$$
 
 [//]: # (END_OVERVIEW)
 
@@ -471,8 +649,8 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
-tag = "figi"
+identifier = "$$v2_security_data_point_identifier_default$$"
+tag = "$$v2_security_data_point_item_text_default$$"
 
 result = security_api.get_security_data_point_text(identifier, tag)
 pp result
@@ -489,7 +667,7 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   
+ **identifier** | String| $$v2_security_data_point_identifier_description$$ |   
  **tag** | String| An Intrinio data tag ID or code-name |   
 
 [//]: # (END_PARAMETERS)
@@ -530,7 +708,7 @@ Name | Type | Description  | Notes
 #### Historical Data for Security
 
 
-Returns historical values for the given `tag` and the Security with the given `identifier`
+$$v2_security_historical_data_description$$
 
 [//]: # (END_OVERVIEW)
 
@@ -550,8 +728,8 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
-tag = "adj_close_price"
+identifier = "$$v2_security_historical_data_identifier_default$$"
+tag = "$$v2_security_historical_data_item_default$$"
 
 opts = {
   frequency: "daily",
@@ -578,8 +756,8 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   
- **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
+ **identifier** | String| $$v2_security_historical_data_identifier_description$$ |   
+ **tag** | String| $$v2_security_data_point_item_description$$ |   
  **frequency** | String| Return historical data in the given frequency | [optional] [default to daily]  
  **type** | String| Filter by type, when applicable | [optional]   
  **start_date** | Date| Get historical data on or after this date | [optional]   
@@ -800,7 +978,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   next_page: nil
@@ -1128,7 +1306,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 interval_size = "5m"
 
 opts = {
@@ -1230,7 +1408,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 result = security_api.get_security_latest_dividend_record(identifier)
 pp result
@@ -1307,7 +1485,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 result = security_api.get_security_latest_earnings_record(identifier)
 pp result
@@ -1384,7 +1562,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: "2018-01-01",
@@ -1472,7 +1650,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 22,
@@ -1562,7 +1740,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 14,
@@ -1652,7 +1830,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   short_period: 5,
@@ -1744,7 +1922,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 14,
@@ -1834,7 +2012,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 20,
@@ -1928,7 +2106,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 20,
@@ -2020,7 +2198,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 20,
@@ -2110,7 +2288,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 20,
@@ -2202,7 +2380,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 20,
@@ -2294,7 +2472,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 20,
@@ -2384,7 +2562,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: "2018-01-01",
@@ -2472,7 +2650,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   low_period: 9,
@@ -2566,7 +2744,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 10,
@@ -2656,7 +2834,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   roc1: 10,
@@ -2762,7 +2940,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   fast_period: 12,
@@ -2858,7 +3036,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 14,
@@ -2948,7 +3126,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   ema_period: 9,
@@ -3040,7 +3218,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: "2018-01-01",
@@ -3128,7 +3306,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: "2018-01-01",
@@ -3216,7 +3394,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 10,
@@ -3306,7 +3484,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 14,
@@ -3398,7 +3576,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 20,
@@ -3490,7 +3668,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 14,
@@ -3582,7 +3760,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 15,
@@ -3672,7 +3850,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   low_period: 13,
@@ -3766,7 +3944,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   short_period: 7,
@@ -3866,7 +4044,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 14,
@@ -3956,7 +4134,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: "2018-01-01",
@@ -4044,7 +4222,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: "2018-01-01",
@@ -4132,7 +4310,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   period: 14,
@@ -4222,7 +4400,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   active_only: false,
@@ -4308,7 +4486,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   source: ["iex,delayed_sip"]
@@ -4469,7 +4647,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   next_page: nil
@@ -4631,7 +4809,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: Date.parse("2018-01-01"),
@@ -4719,7 +4897,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: Date.parse("2018-01-01"),
@@ -4807,7 +4985,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: Date.parse("2018-01-01"),
@@ -4895,7 +5073,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: Date.parse("2018-01-01"),
@@ -5183,7 +5361,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   start_date: nil,
@@ -5297,7 +5475,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   date: nil
@@ -5379,7 +5557,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   page_size: 100,
@@ -5463,7 +5641,7 @@ Intrinio.configure do |config|
 end
 
 security_api = Intrinio::SecurityApi.new
-identifier = "AAPL"
+identifier = "$$v2_ticker_default$$"
 
 opts = {
   page_size: 100,