intrinio-sdk 3.0.0 → 3.1.0

data/docs/FilingNote.md

@@ -1,11 +1,26 @@
-# Intrinio::FilingNote
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Intrinio ID of the note | [optional] 
-**xbrl_tag** | **String** | The XBRL Tag used for the note | [optional] 
-**content** | **String** | The plain text (after html has been removed) of the note, or text including html if the content_format parameter has been set to html | [optional] 
-**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |  | [optional] 
+
+
+[//]: # (CLASS:Intrinio::FilingNote)
+
+[//]: # (KIND:object)
+
+### Intrinio::FilingNote
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the note  
+**xbrl_tag** | String | The XBRL Tag used for the note  
+**content** | String | The plain text (after html has been removed) of the note, or text including html if the content_format parameter has been set to html  
+**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::FilingNoteFiling)
+
 
 

data/docs/FilingNoteFiling.md

@@ -1,11 +1,23 @@
-# Intrinio::FilingNoteFiling
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cik** | **String** | The Central Index Key (CIK) assigned to the company | [optional] 
-**report_type** | **String** | The type of report (10-Q, 10-K, etc) filed | [optional] 
-**period_end_date** | **Date** | The ending date of the fiscal period for the filing | [optional] 
-**filing_date** | **Date** | The date the report was filed with the SEC | [optional] 
+
+
+[//]: # (CLASS:Intrinio::FilingNoteFiling)
+
+[//]: # (KIND:object)
+
+### Intrinio::FilingNoteFiling
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**cik** | String | The Central Index Key (CIK) assigned to the company  
+**report_type** | String | The filing <a href=\"/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>  
+**period_end_date** | Date | The ending date of the fiscal period for the filing  
+**filing_date** | Date | The date the report was filed with the SEC  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/FilingNoteSummary.md

@@ -1,10 +1,25 @@
-# Intrinio::FilingNoteSummary
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Intrinio ID of the note | [optional] 
-**xbrl_tag** | **String** | The XBRL tag used for the note by the filing entity | [optional] 
-**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |  | [optional] 
+
+
+[//]: # (CLASS:Intrinio::FilingNoteSummary)
+
+[//]: # (KIND:object)
+
+### Intrinio::FilingNoteSummary
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the note  
+**xbrl_tag** | String | The XBRL tag used for the note by the filing entity  
+**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::FilingNoteFiling)
+
 
 

data/docs/FilingSummary.md

@@ -1,16 +1,28 @@
-# Intrinio::FilingSummary
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Intrinio ID of the Filing | [optional] 
-**filing_date** | **Date** | The date when the filing was submitted to the SEC by the company | [optional] 
-**accepted_date** | **DateTime** | The date and time when the filing was accepted by SEC | [optional] 
-**period_end_date** | **Date** | The ending date of the fiscal period for the filing | [optional] 
-**report_type** | **String** | The filing report type | [optional] 
-**sec_unique_id** | **String** | A unique identifier for the filing provided by the SEC | [optional] 
-**filing_url** | **String** | The URL to the filing page on the SEC site | [optional] 
-**report_url** | **String** | The URL to the actual report on the SEC site | [optional] 
-**instance_url** | **String** | The URL for the XBRL filing for the report | [optional] 
+
+
+[//]: # (CLASS:Intrinio::FilingSummary)
+
+[//]: # (KIND:object)
+
+### Intrinio::FilingSummary
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the Filing  
+**filing_date** | Date | The date when the filing was submitted to the SEC by the company  
+**accepted_date** | DateTime | The date and time when the filing was accepted by SEC  
+**period_end_date** | Date | The ending date of the fiscal period for the filing  
+**report_type** | String | The filing <a href=\"/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>  
+**sec_unique_id** | String | A unique identifier for the filing provided by the SEC  
+**filing_url** | String | The URL to the filing page on the SEC site  
+**report_url** | String | The URL to the actual report on the SEC site  
+**instance_url** | String | The URL for the XBRL filing for the report  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/ForceIndexTechnicalValue.md

@@ -1,9 +1,21 @@
-# Intrinio::ForceIndexTechnicalValue
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**date_time** | **DateTime** | The date_time of the observation | [optional] 
-**fi** | **Float** | The Force Index calculation value | [optional] 
+
+[//]: # (CLASS:Intrinio::ForceIndexTechnicalValue)
+
+[//]: # (KIND:object)
+
+### Intrinio::ForceIndexTechnicalValue
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**date_time** | DateTime | The date_time of the observation  
+**fi** | Float | The Force Index calculation value  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/ForexApi.md

@@ -9,21 +9,51 @@ Method | HTTP request | Description
 [**get_forex_prices**](ForexApi.md#get_forex_prices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices
 
 
-# **get_forex_currencies**
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ForexApi)
+
+[//]: # (METHOD:get_forex_currencies)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseForexCurrencies)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseForexCurrencies.md)
+
+[//]: # (OPERATION:get_forex_currencies_v2)
+
+[//]: # (ENDPOINT:/forex/currencies)
+
+[//]: # (DOCUMENT_LINK:ForexApi.md#get_forex_currencies)
+
+## **get_forex_currencies**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_currencies_v2)
+
+[//]: # (START_OVERVIEW)
+
 > ApiResponseForexCurrencies get_forex_currencies
 
-Forex Currencies
+#### Forex Currencies
+
 
 Returns a list of forex currencies for which prices are available.
 
+[//]: # (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
 
 forex_api = Intrinio::ForexApi.new
@@ -36,28 +66,70 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
+
+[//]: # (START_PARAMETERS)
+
 This endpoint does not need any parameter.
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**ApiResponseForexCurrencies**](ApiResponseForexCurrencies.md)
 
-# **get_forex_pairs**
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ForexApi)
+
+[//]: # (METHOD:get_forex_pairs)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseForexPairs)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseForexPairs.md)
+
+[//]: # (OPERATION:get_forex_pairs_v2)
+
+[//]: # (ENDPOINT:/forex/pairs)
+
+[//]: # (DOCUMENT_LINK:ForexApi.md#get_forex_pairs)
+
+## **get_forex_pairs**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_pairs_v2)
+
+[//]: # (START_OVERVIEW)
+
 > ApiResponseForexPairs get_forex_pairs
 
-Forex Currency Pairs
+#### Forex Currency Pairs
+
 
 Returns a list of currency pairs used to request foreign exchange (forex) market price data. The currency that is used as the reference is called quote currency and the currency that is quoted in relation is called the base currency. For example, in the pair code “EURGBP” with a price of 0.88, one Euro (base currency) can be exchanged for 0.88 British Pounds (quote currency).
 
+[//]: # (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
 
 forex_api = Intrinio::ForexApi.new
@@ -70,28 +142,70 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
+
+[//]: # (START_PARAMETERS)
+
 This endpoint does not need any parameter.
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**ApiResponseForexPairs**](ApiResponseForexPairs.md)
 
-# **get_forex_prices**
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ForexApi)
+
+[//]: # (METHOD:get_forex_prices)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseForexPrices)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseForexPrices.md)
+
+[//]: # (OPERATION:get_forex_prices_v2)
+
+[//]: # (ENDPOINT:/forex/prices/{pair}/{timeframe})
+
+[//]: # (DOCUMENT_LINK:ForexApi.md#get_forex_prices)
+
+## **get_forex_prices**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_prices_v2)
+
+[//]: # (START_OVERVIEW)
+
 > ApiResponseForexPrices get_forex_prices(pair, timeframe, opts)
 
-Forex Currency Prices
+#### Forex Currency Prices
+
 
 Provides a list of forex price quotes for a given forex currency pair and timeframe.
 
+[//]: # (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
 
 forex_api = Intrinio::ForexApi.new
@@ -118,21 +232,33 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **pair** | **String**| The Forex Currency Pair code | 
- **timeframe** | **String**| The time interval for the quotes | 
- **timezone** | **String**| Returns trading times in this timezone | [optional] [default to UTC]
- **start_date** | **Date**| Return Forex Prices on or after this date | [optional] 
- **start_time** | **String**| Return Forex Prices at or after this time (24-hour) | [optional] 
- **end_date** | **Date**| Return Forex Prices on or before this date | [optional] 
- **end_time** | **String**| Return Forex Prices at or before this time (24-hour) | [optional] 
- **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] 
+ **pair** | String| The Forex Currency Pair code |  &nbsp;
+ **timeframe** | String| The time interval for the quotes |  &nbsp;
+ **timezone** | String| Returns trading times in this timezone | [optional] [default to UTC] &nbsp;
+ **start_date** | Date| Return Forex Prices on or after this date | [optional]  &nbsp;
+ **start_time** | String| Return Forex Prices at or after this time (24-hour) | [optional]  &nbsp;
+ **end_date** | Date| Return Forex Prices on or before this date | [optional]  &nbsp;
+ **end_time** | String| Return Forex Prices at or before this time (24-hour) | [optional]  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**ApiResponseForexPrices**](ApiResponseForexPrices.md)
 
+[//]: # (END_OPERATION)
+

data/docs/ForexCurrency.md

@@ -1,10 +1,22 @@
-# Intrinio::ForexCurrency
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** | The ISO 4217 currency code | [optional] 
-**name** | **String** | The name of the currency | [optional] 
-**country** | **String** | The country in which the currency is used | [optional] 
+
+
+[//]: # (CLASS:Intrinio::ForexCurrency)
+
+[//]: # (KIND:object)
+
+### Intrinio::ForexCurrency
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**code** | String | The ISO 4217 currency code  
+**name** | String | The name of the currency  
+**country** | String | The country in which the currency is used  
+
+[//]: # (END_DEFINITION)
+