intrinio-sdk 3.0.0 → 3.1.0

data/docs/DataTag.md

@@ -1,18 +1,30 @@
-# Intrinio::DataTag
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Intrinio ID for the Data Tag | [optional] 
-**name** | **String** | The readable name of the Data Tag | [optional] 
-**tag** | **String** | The code-name of the Data Tag | [optional] 
-**statement_code** | **String** | The code of the financial statement to which this Data Tag belongs | [optional] 
-**statement_type** | **String** | The format of the financial statment to which this Data Tag belongs | [optional] 
-**parent** | **String** | The parent Data Tag forming the statement relationship with the factor | [optional] 
-**sequence** | **Float** | The order in which the Data Tag appears in its logical group (such as a financial statement) | [optional] 
-**factor** | **String** | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag | [optional] 
-**balance** | **String** | Whether the Data Tag represents a credit or debit | [optional] 
-**type** | **String** | The nature of the Data Tag, operating or nonoperating | [optional] 
-**unit** | **String** | The unit of the Data Tag | [optional] 
+
+
+[//]: # (CLASS:Intrinio::DataTag)
+
+[//]: # (KIND:object)
+
+### Intrinio::DataTag
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID for the Data Tag  
+**name** | String | The readable name of the Data Tag  
+**tag** | String | The code-name of the Data Tag  
+**statement_code** | String | The code of the financial statement to which this Data Tag belongs  
+**statement_type** | String | The format of the financial statment to which this Data Tag belongs  
+**parent** | String | The parent Data Tag forming the statement relationship with the factor  
+**sequence** | Float | The order in which the Data Tag appears in its logical group (such as a financial statement)  
+**factor** | String | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag  
+**balance** | String | Whether the Data Tag represents a credit or debit  
+**type** | String | The nature of the Data Tag, operating or nonoperating  
+**unit** | String | The unit of the Data Tag  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/DataTagApi.md

@@ -9,21 +9,51 @@ Method | HTTP request | Description
 [**search_data_tags**](DataTagApi.md#search_data_tags) | **GET** /data_tags/search | Search Data Tags
 
 
-# **get_all_data_tags**
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::DataTagApi)
+
+[//]: # (METHOD:get_all_data_tags)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseDataTags)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseDataTags.md)
+
+[//]: # (OPERATION:get_all_data_tags_v2)
+
+[//]: # (ENDPOINT:/data_tags)
+
+[//]: # (DOCUMENT_LINK:DataTagApi.md#get_all_data_tags)
+
+## **get_all_data_tags**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_data_tags_v2)
+
+[//]: # (START_OVERVIEW)
+
 > ApiResponseDataTags get_all_data_tags(opts)
 
-All Data Tags
+#### All Data Tags
+
 
 Returns all Data Tags. Returns Data Tags matching parameters when specified.
 
+[//]: # (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
 
 dataTag_api = Intrinio::DataTagApi.new
@@ -46,37 +76,79 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **tag** | **String**| Tag | [optional] 
- **type** | **String**| Type | [optional] 
- **parent** | **String**| ID of tag parent | [optional] 
- **statement_code** | **String**| Statement Code | [optional] 
- **fs_template** | **String**| Template | [optional] [default to industrial]
- **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] 
+ **tag** | String| Tag | [optional]   
+ **type** | String| Type | [optional]   
+ **parent** | String| ID of tag parent | [optional]   
+ **statement_code** | String| Statement Code | [optional]   
+ **fs_template** | String| Template | [optional] [default to industrial]  
+ **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]   
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**ApiResponseDataTags**](ApiResponseDataTags.md)
 
-# **get_data_tag_by_id**
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::DataTagApi)
+
+[//]: # (METHOD:get_data_tag_by_id)
+
+[//]: # (RETURN_TYPE:Intrinio::DataTag)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:DataTag.md)
+
+[//]: # (OPERATION:get_data_tag_by_id_v2)
+
+[//]: # (ENDPOINT:/data_tags/{identifier})
+
+[//]: # (DOCUMENT_LINK:DataTagApi.md#get_data_tag_by_id)
+
+## **get_data_tag_by_id**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_data_tag_by_id_v2)
+
+[//]: # (START_OVERVIEW)
+
 > DataTag get_data_tag_by_id(identifier)
 
-Lookup Data Tag
+#### Lookup Data Tag
+
 
 Returns the Data Tag with the given `identifier`
 
+[//]: # (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
 
 dataTag_api = Intrinio::DataTagApi.new
@@ -92,31 +164,73 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | **String**| The Intrinio ID or the code-name of the Data Tag | 
+ **identifier** | String| The Intrinio ID or the code-name of the Data Tag |  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**DataTag**](DataTag.md)
 
-# **search_data_tags**
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::DataTagApi)
+
+[//]: # (METHOD:search_data_tags)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseDataTagsSearch)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseDataTagsSearch.md)
+
+[//]: # (OPERATION:search_data_tags_v2)
+
+[//]: # (ENDPOINT:/data_tags/search)
+
+[//]: # (DOCUMENT_LINK:DataTagApi.md#search_data_tags)
+
+## **search_data_tags**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_data_tags_v2)
+
+[//]: # (START_OVERVIEW)
+
 > ApiResponseDataTagsSearch search_data_tags(query, opts)
 
-Search Data Tags
+#### Search Data Tags
+
 
 Searches for Data Tags matching the text `query`
 
+[//]: # (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
 
 dataTag_api = Intrinio::DataTagApi.new
@@ -135,14 +249,26 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
 ### Parameters
 
+[//]: # (START_PARAMETERS)
+
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **query** | **String**|  | 
- **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
+ **query** | String|  |  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
 
 ### Return type
 
 [**ApiResponseDataTagsSearch**](ApiResponseDataTagsSearch.md)
 
+[//]: # (END_OPERATION)
+

data/docs/DataTagSummary.md

@@ -1,15 +1,27 @@
-# Intrinio::DataTagSummary
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Intrinio ID for the Data Tag | [optional] 
-**name** | **String** | The readable name of the Data Tag | [optional] 
-**tag** | **String** | The code-name of the Data Tag | [optional] 
-**parent** | **String** | The parent Data Tag forming the statement relationship with the factor | [optional] 
-**sequence** | **Float** | The order in which the Data Tag appears in its logical group (such as a financial statement) | [optional] 
-**factor** | **String** | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag | [optional] 
-**balance** | **String** | Whether the Data Tag represents a credit or debit | [optional] 
-**unit** | **String** | The unit of the Data Tag | [optional] 
+
+
+[//]: # (CLASS:Intrinio::DataTagSummary)
+
+[//]: # (KIND:object)
+
+### Intrinio::DataTagSummary
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID for the Data Tag  
+**name** | String | The readable name of the Data Tag  
+**tag** | String | The code-name of the Data Tag  
+**parent** | String | The parent Data Tag forming the statement relationship with the factor  
+**sequence** | Float | The order in which the Data Tag appears in its logical group (such as a financial statement)  
+**factor** | String | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag  
+**balance** | String | Whether the Data Tag represents a credit or debit  
+**unit** | String | The unit of the Data Tag  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/DetrendedPriceOscillatorTechnicalValue.md

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

data/docs/DividendRecord.md

@@ -1,17 +1,32 @@
-# Intrinio::DividendRecord
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ex_dividend** | **Float** | Amount of dividend in US dollars | [optional] 
-**currency** | **String** | The 3-digit currency code the dividend amount was reported in | [optional] 
-**announcement_date** | **Date** | Date dividend was announced | [optional] 
-**record_date** | **Date** | Date before which holders-of-record will receive the dividend | [optional] 
-**pay_date** | **Date** | Date the divdiend was paid | [optional] 
-**frequency** | **String** | Identifies payment frequency of announced dividend | [optional] 
-**status** | **String** | Status of the dividend | [optional] 
-**forward_yield** | **Float** | The forward dividend yield | [optional] 
-**forward_rate** | **Float** | The forward dividend rate | [optional] 
-**security** | [**SecuritySummary**](SecuritySummary.md) |  | [optional] 
+
+
+[//]: # (CLASS:Intrinio::DividendRecord)
+
+[//]: # (KIND:object)
+
+### Intrinio::DividendRecord
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**ex_dividend** | Float | Amount of dividend in US dollars  
+**currency** | String | The 3-digit currency code the dividend amount was reported in  
+**announcement_date** | Date | Date dividend was announced  
+**record_date** | Date | Date before which holders-of-record will receive the dividend  
+**pay_date** | Date | Date the divdiend was paid  
+**frequency** | String | Identifies payment frequency of announced dividend  
+**status** | String | Status of the dividend  
+**forward_yield** | Float | The forward dividend yield  
+**forward_rate** | Float | The forward dividend rate  
+**security** | [**SecuritySummary**](SecuritySummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::SecuritySummary)
+
 
 

data/docs/DonchianChannelTechnicalValue.md

@@ -1,10 +1,22 @@
-# Intrinio::DonchianChannelTechnicalValue
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**date_time** | **DateTime** | The date_time of the observation | [optional] 
-**lower_bound** | **Float** | The lower bound value of the Donchian Channel calculation | [optional] 
-**upper_bound** | **Float** | The upper bound value of the Donchian Channel calculation | [optional] 
+
+
+[//]: # (CLASS:Intrinio::DonchianChannelTechnicalValue)
+
+[//]: # (KIND:object)
+
+### Intrinio::DonchianChannelTechnicalValue
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**date_time** | DateTime | The date_time of the observation  
+**lower_bound** | Float | The lower bound value of the Donchian Channel calculation  
+**upper_bound** | Float | The upper bound value of the Donchian Channel calculation  
+
+[//]: # (END_DEFINITION)
+
 
 

data/docs/EarningsRecord.md

@@ -1,30 +1,45 @@
-# Intrinio::EarningsRecord
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quarter** | **String** | The letter “Q” followed by the quarter number the earnings information applies to | [optional] 
-**time_of_day** | **String** | Indicates the time of the announcement | [optional] 
-**broadcast_url** | **String** | Link for Conference Call recording | [optional] 
-**transcript_url** | **String** | Link to the earnings release transcript | [optional] 
-**transcript_quarter** | **String** | The letter “Q” followed by the quarter number the earnings transcript applies to | [optional] 
-**transcript_fiscal_year** | **String** | Fiscal year in YYYY format for the earnings transcript | [optional] 
-**conference_call_date** | **Date** | Date of the conference call | [optional] 
-**conference_call_time** | **String** | Published time of the conference call | [optional] 
-**conference_call_phone_number** | **String** | Publicly available phone number for replay conference call | [optional] 
-**conference_call_passcode** | **String** | Passcode for replay conference call | [optional] 
-**last_confirmation_date** | **Date** | Date of last earnings date update by a WSH analyst | [optional] 
-**board_of_directors_meeting_date** | **Date** | Date of Board/Shareholder Meeting | [optional] 
-**board_of_directors_meeting_type** | **String** | The type of meeting - \"B\" indicates a Board of Directors meeting and \"S\" indicates a Shareholder meeting | [optional] 
-**company_website** | **String** | Website link for the company | [optional] 
-**q1_date** | **Date** | Earnings Date for 1st quarter | [optional] 
-**q2_date** | **Date** | Earnings Date for 2nd quarter | [optional] 
-**q3_date** | **Date** | Earnings Date for 3rd quarter | [optional] 
-**q4_date** | **Date** | Earnings Date for 4th quarter | [optional] 
-**type** | **String** | The nature of the next reported earnings date - \"V\" indicates a Verified date, \"T\" indicates that the date was gathered from the company, but is still considered Tentative, and \"I\" indicates that the date is forecased or Inferred | [optional] 
-**next_earnings_date** | **Date** | Next earnings date | [optional] 
-**next_earnings_quarter** | **String** | The quarter of the next earnings release | [optional] 
-**next_earnings_fiscal_year** | **Integer** | The fiscal year associated with next earnings date and next earnings quarter | [optional] 
-**security** | [**SecuritySummary**](SecuritySummary.md) |  | [optional] 
+
+
+[//]: # (CLASS:Intrinio::EarningsRecord)
+
+[//]: # (KIND:object)
+
+### Intrinio::EarningsRecord
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**quarter** | String | The letter “Q” followed by the quarter number the earnings information applies to  
+**time_of_day** | String | Indicates the time of the announcement  
+**broadcast_url** | String | Link for Conference Call recording  
+**transcript_url** | String | Link to the earnings release transcript  
+**transcript_quarter** | String | The letter “Q” followed by the quarter number the earnings transcript applies to  
+**transcript_fiscal_year** | String | Fiscal year in YYYY format for the earnings transcript  
+**conference_call_date** | Date | Date of the conference call  
+**conference_call_time** | String | Published time of the conference call  
+**conference_call_phone_number** | String | Publicly available phone number for replay conference call  
+**conference_call_passcode** | String | Passcode for replay conference call  
+**last_confirmation_date** | Date | Date of last earnings date update by a WSH analyst  
+**board_of_directors_meeting_date** | Date | Date of Board/Shareholder Meeting  
+**board_of_directors_meeting_type** | String | The type of meeting - \"B\" indicates a Board of Directors meeting and \"S\" indicates a Shareholder meeting  
+**company_website** | String | Website link for the company  
+**q1_date** | Date | Earnings Date for 1st quarter  
+**q2_date** | Date | Earnings Date for 2nd quarter  
+**q3_date** | Date | Earnings Date for 3rd quarter  
+**q4_date** | Date | Earnings Date for 4th quarter  
+**type** | String | The nature of the next reported earnings date - \"V\" indicates a Verified date, \"T\" indicates that the date was gathered from the company, but is still considered Tentative, and \"I\" indicates that the date is forecased or Inferred  
+**next_earnings_date** | Date | Next earnings date  
+**next_earnings_quarter** | String | The quarter of the next earnings release  
+**next_earnings_fiscal_year** | Integer | The fiscal year associated with next earnings date and next earnings quarter  
+**security** | [**SecuritySummary**](SecuritySummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::SecuritySummary)
+