intrinio-sdk 3.0.0 → 3.1.0

data/docs/ForexPair.md

@@ -1,10 +1,22 @@
-# Intrinio::ForexPair
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** | The common code of the currency pair | [optional] 
-**base_currency** | **String** | The ISO 4217 currency code of the base currency | [optional] 
-**quote_currency** | **String** | The ISO 4217 currency code of the quote currency | [optional] 
+
+
+[//]: # (CLASS:Intrinio::ForexPair)
+
+[//]: # (KIND:object)
+
+### Intrinio::ForexPair
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**code** | String | The common code of the currency pair  
+**base_currency** | String | The ISO 4217 currency code of the base currency  
+**quote_currency** | String | The ISO 4217 currency code of the quote currency  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/ForexPrice.md

@@ -1,17 +1,29 @@
-# Intrinio::ForexPrice
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**occurred_at** | **String** | The timestamp of the beginning of the timeframe. The open prices would be at this time, while close prices would be at this time plus the timeframe. | [optional] 
-**open_bid** | **Float** | Open bid | [optional] 
-**high_bid** | **Float** | High bid | [optional] 
-**low_bid** | **Float** | Low bid | [optional] 
-**close_bid** | **Float** | Close bid | [optional] 
-**open_ask** | **Float** | Open ask | [optional] 
-**high_ask** | **Float** | High ask | [optional] 
-**low_ask** | **Float** | Low ask | [optional] 
-**close_ask** | **Float** | Close ask | [optional] 
-**total_ticks** | **Integer** | Total ticks | [optional] 
+
+
+[//]: # (CLASS:Intrinio::ForexPrice)
+
+[//]: # (KIND:object)
+
+### Intrinio::ForexPrice
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**occurred_at** | String | The timestamp of the beginning of the timeframe. The open prices would be at this time, while close prices would be at this time plus the timeframe.  
+**open_bid** | Float | Open bid  
+**high_bid** | Float | High bid  
+**low_bid** | Float | Low bid  
+**close_bid** | Float | Close bid  
+**open_ask** | Float | Open ask  
+**high_ask** | Float | High ask  
+**low_ask** | Float | Low ask  
+**close_ask** | Float | Close ask  
+**total_ticks** | Integer | Total ticks  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/Fundamental.md

@@ -1,16 +1,31 @@
-# Intrinio::Fundamental
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Intrinio ID of the Fundamental | [optional] 
-**statement_code** | **String** | The code of the financial statement that the Fundamental represents | [optional] 
-**fiscal_year** | **Float** | The fiscal year | [optional] 
-**fiscal_period** | **String** | The fiscal period | [optional] 
-**type** | **String** | The type of Fundamental | [optional] 
-**start_date** | **Date** | The period start date | [optional] 
-**end_date** | **Date** | The period start date | [optional] 
-**filing_date** | **DateTime** | The date and time when the Fundamental was filed with the SEC | [optional] 
-**company** | [**CompanySummary**](CompanySummary.md) | The Company that the Fundamental was belongs to | [optional] 
+
+
+[//]: # (CLASS:Intrinio::Fundamental)
+
+[//]: # (KIND:object)
+
+### Intrinio::Fundamental
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the Fundamental  
+**statement_code** | String | The code of the financial statement that the Fundamental represents  
+**fiscal_year** | Float | The fiscal year  
+**fiscal_period** | String | The fiscal period  
+**type** | String | The type of Fundamental  
+**start_date** | Date | The period start date  
+**end_date** | Date | The period start date  
+**filing_date** | DateTime | The date and time when the Fundamental was filed with the SEC  
+**company** | [**CompanySummary**](CompanySummary.md) | The Company that the Fundamental was belongs to  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
 
 

data/docs/FundamentalSummary.md

@@ -1,15 +1,27 @@
-# Intrinio::FundamentalSummary
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Intrinio ID of the Fundamental | [optional] 
-**statement_code** | **String** | The code of the financial statement that the Fundamental represents | [optional] 
-**fiscal_year** | **Float** | The fiscal year | [optional] 
-**fiscal_period** | **String** | The fiscal period | [optional] 
-**type** | **String** | The type of Fundamental | [optional] 
-**start_date** | **Date** | The period start date | [optional] 
-**end_date** | **Date** | The period start date | [optional] 
-**filing_date** | **DateTime** | The date and time when the Fundamental was filed with the SEC | [optional] 
+
+
+[//]: # (CLASS:Intrinio::FundamentalSummary)
+
+[//]: # (KIND:object)
+
+### Intrinio::FundamentalSummary
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the Fundamental  
+**statement_code** | String | The code of the financial statement that the Fundamental represents  
+**fiscal_year** | Float | The fiscal year  
+**fiscal_period** | String | The fiscal period  
+**type** | String | The type of Fundamental  
+**start_date** | Date | The period start date  
+**end_date** | Date | The period start date  
+**filing_date** | DateTime | The date and time when the Fundamental was filed with the SEC  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/FundamentalsApi.md

@@ -10,21 +10,51 @@ Method | HTTP request | Description
 [**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
 
 
-# **get_fundamental_by_id**
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FundamentalsApi)
+
+[//]: # (METHOD:get_fundamental_by_id)
+
+[//]: # (RETURN_TYPE:Intrinio::Fundamental)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:Fundamental.md)
+
+[//]: # (OPERATION:get_fundamental_by_id_v2)
+
+[//]: # (ENDPOINT:/fundamentals/{id})
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#get_fundamental_by_id)
+
+## **get_fundamental_by_id**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_by_id_v2)
+
+[//]: # (START_OVERVIEW)
+
 > Fundamental get_fundamental_by_id(id)
 
-Fundamental by ID
+#### Fundamental by ID
+
 
 Returns detailed fundamental data for the given `id`.
 
+[//]: # (END_OVERVIEW)
+
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
 
 # Setup authorization
 Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR_API_KEY'
 end
 
 fundamentals_api = Intrinio::FundamentalsApi.new
@@ -40,31 +70,73 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The Intrinio ID for the Fundamental | 
+ **id** | String| The Intrinio ID for the Fundamental |   
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**Fundamental**](Fundamental.md)
 
-# **get_fundamental_reported_financials**
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FundamentalsApi)
+
+[//]: # (METHOD:get_fundamental_reported_financials)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseReportedFinancials)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseReportedFinancials.md)
+
+[//]: # (OPERATION:get_fundamental_reported_financials_v2)
+
+[//]: # (ENDPOINT:/fundamentals/{id}/reported_financials)
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#get_fundamental_reported_financials)
+
+## **get_fundamental_reported_financials**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_reported_financials_v2)
+
+[//]: # (START_OVERVIEW)
+
 > ApiResponseReportedFinancials get_fundamental_reported_financials(id)
 
-Reported Financials
+#### Reported Financials
+
 
 Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
 
+[//]: # (END_OVERVIEW)
+
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
 
 # Setup authorization
 Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR_API_KEY'
 end
 
 fundamentals_api = Intrinio::FundamentalsApi.new
@@ -80,31 +152,73 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | 
+ **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**ApiResponseReportedFinancials**](ApiResponseReportedFinancials.md)
 
-# **get_fundamental_standardized_financials**
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FundamentalsApi)
+
+[//]: # (METHOD:get_fundamental_standardized_financials)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseStandardizedFinancials)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseStandardizedFinancials.md)
+
+[//]: # (OPERATION:get_fundamental_standardized_financials_v2)
+
+[//]: # (ENDPOINT:/fundamentals/{id}/standardized_financials)
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#get_fundamental_standardized_financials)
+
+## **get_fundamental_standardized_financials**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_standardized_financials_v2)
+
+[//]: # (START_OVERVIEW)
+
 > ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)
 
-Standardized Financials
+#### Standardized Financials
+
 
 Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
 
+[//]: # (END_OVERVIEW)
+
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
 
 # Setup authorization
 Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR_API_KEY'
 end
 
 fundamentals_api = Intrinio::FundamentalsApi.new
@@ -120,31 +234,73 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | 
+ **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**ApiResponseStandardizedFinancials**](ApiResponseStandardizedFinancials.md)
 
-# **lookup_fundamental**
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FundamentalsApi)
+
+[//]: # (METHOD:lookup_fundamental)
+
+[//]: # (RETURN_TYPE:Intrinio::Fundamental)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:Fundamental.md)
+
+[//]: # (OPERATION:lookup_fundamental_v2)
+
+[//]: # (ENDPOINT:/fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period})
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#lookup_fundamental)
+
+## **lookup_fundamental**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/lookup_fundamental_v2)
+
+[//]: # (START_OVERVIEW)
+
 > Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
 
-Lookup Fundamental
+#### Lookup Fundamental
+
 
 Returns the Fundamental for the Company with the given `identifier` and with the given parameters
 
+[//]: # (END_OVERVIEW)
+
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
 
 # Setup authorization
 Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR_API_KEY'
 end
 
 fundamentals_api = Intrinio::FundamentalsApi.new
@@ -166,16 +322,28 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
- **statement_code** | **String**| The statement code | 
- **fiscal_year** | **Integer**| The fiscal year | 
- **fiscal_period** | **String**| The fiscal period | 
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  &nbsp;
+ **statement_code** | String| The statement code |  &nbsp;
+ **fiscal_year** | Integer| The fiscal year |  &nbsp;
+ **fiscal_period** | String| The fiscal period |  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**Fundamental**](Fundamental.md)
 
+[//]: # (END_OPERATION)
+