intrinio-sdk 2.3.0 → 3.0.0

data/docs/DataPointApi.md

@@ -8,17 +8,7 @@ Method | HTTP request | Description
 [**get_data_point_text**](DataPointApi.md#get_data_point_text) | **GET** /data_point/{identifier}/{tag}/text | Data Point (Text)
 
 
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/data_point/{identifier}/{tag}/number)
-
-[//]: # (DOC_LINK:DataPointApi.md#get_data_point_number)
-
 # **get_data_point_number**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_data_point_number_v2)
-
 > Float get_data_point_number(identifier, tag)
 
 Data Point (Number)
@@ -26,9 +16,6 @@ Data Point (Number)
 Returns a numeric value for the given `tag` and the entity with the given `identifier`
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -53,8 +40,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -66,19 +51,7 @@ Name | Type | Description  | Notes
 
 **Float**
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/data_point/{identifier}/{tag}/text)
-
-[//]: # (DOC_LINK:DataPointApi.md#get_data_point_text)
-
 # **get_data_point_text**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_data_point_text_v2)
-
 > String get_data_point_text(identifier, tag)
 
 Data Point (Text)
@@ -86,9 +59,6 @@ Data Point (Text)
 Returns a text value for the given `tag` for the Security with the given `identifier`
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -113,8 +83,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -126,5 +94,3 @@ Name | Type | Description  | Notes
 
 **String**
 
-[//]: # (END_OPERATION)
-

data/docs/DataTag.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **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] 

data/docs/DataTagApi.md

@@ -9,17 +9,7 @@ Method | HTTP request | Description
 [**search_data_tags**](DataTagApi.md#search_data_tags) | **GET** /data_tags/search | Search Data Tags
 
 
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/data_tags)
-
-[//]: # (DOC_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)
-
 > ApiResponseDataTags get_all_data_tags(opts)
 
 All Data Tags
@@ -27,9 +17,6 @@ All Data Tags
 Returns all Data Tags. Returns Data Tags matching parameters when specified.
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -59,8 +46,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -77,19 +62,7 @@ Name | Type | Description  | Notes
 
 [**ApiResponseDataTags**](ApiResponseDataTags.md)
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/data_tags/{identifier})
-
-[//]: # (DOC_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)
-
 > DataTag get_data_tag_by_id(identifier)
 
 Lookup Data Tag
@@ -97,9 +70,6 @@ Lookup Data Tag
 Returns the Data Tag with the given `identifier`
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -122,8 +92,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -134,19 +102,7 @@ Name | Type | Description  | Notes
 
 [**DataTag**](DataTag.md)
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/data_tags/search)
-
-[//]: # (DOC_LINK:DataTagApi.md#search_data_tags)
-
 # **search_data_tags**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_data_tags_v2)
-
 > ApiResponseDataTagsSearch search_data_tags(query, opts)
 
 Search Data Tags
@@ -154,9 +110,6 @@ Search Data Tags
 Searches for Data Tags matching the text `query`
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -182,8 +135,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -195,5 +146,3 @@ Name | Type | Description  | Notes
 
 [**ApiResponseDataTagsSearch**](ApiResponseDataTagsSearch.md)
 
-[//]: # (END_OPERATION)
-

data/docs/DataTagSummary.md

@@ -6,6 +6,10 @@ 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] 
 
 

data/docs/FilingApi.md

@@ -13,17 +13,7 @@ Method | HTTP request | Description
 [**search_notes**](FilingApi.md#search_notes) | **GET** /filings/notes/search | Search Filing Notes
 
 
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/filings)
-
-[//]: # (DOC_LINK:FilingApi.md#get_all_filings)
-
 # **get_all_filings**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_filings_v2)
-
 > ApiResponseFilings get_all_filings(company, opts)
 
 All Filings
@@ -31,9 +21,6 @@ All Filings
 Returns all Filings. Returns Filings matching parameters when supplied.
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -48,7 +35,7 @@ filing_api = Intrinio::FilingApi.new
 company = "AAPL" # String | Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)
 
 opts = { 
-  report_type: nil, # String | Filter by report type
+  report_type: nil, # String | Filter by report type. Separate values with commas to return multiple report types.
   start_date: Date.parse("2015-01-01"), # Date | Filed on or after the given date
   end_date: nil, # Date | Filed before or after the given date
   page_size: 100, # Integer | The number of results to return
@@ -63,14 +50,12 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **company** | **String**| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) | 
- **report_type** | **String**| Filter by report type | [optional] 
+ **report_type** | **String**| Filter by report type. Separate values with commas to return multiple report types. | [optional] 
  **start_date** | **Date**| Filed on or after the given date | [optional] 
  **end_date** | **Date**| Filed before or after the given date | [optional] 
  **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
@@ -80,19 +65,7 @@ Name | Type | Description  | Notes
 
 [**ApiResponseFilings**](ApiResponseFilings.md)
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/filings/notes)
-
-[//]: # (DOC_LINK:FilingApi.md#get_all_notes)
-
 # **get_all_notes**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_notes_v2)
-
 > ApiResponseFilingNotes get_all_notes(opts)
 
 All Filing Notes
@@ -100,9 +73,6 @@ All Filing Notes
 Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied.
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -133,8 +103,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -152,19 +120,7 @@ Name | Type | Description  | Notes
 
 [**ApiResponseFilingNotes**](ApiResponseFilingNotes.md)
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/filings/{id})
-
-[//]: # (DOC_LINK:FilingApi.md#get_filing_by_id)
-
 # **get_filing_by_id**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_filing_by_id_v2)
-
 > Filing get_filing_by_id(id)
 
 Lookup Filing
@@ -172,9 +128,6 @@ Lookup Filing
 Returns the Filing with the given `identifier`
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -197,8 +150,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -209,27 +160,12 @@ Name | Type | Description  | Notes
 
 [**Filing**](Filing.md)
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/filings/notes/{identifier})
-
-[//]: # (DOC_LINK:FilingApi.md#get_note)
-
 # **get_note**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_note_v2)
-
 > FilingNote get_note(identifier, opts)
 
 Filing Note by ID
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -255,8 +191,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -268,27 +202,12 @@ Name | Type | Description  | Notes
 
 [**FilingNote**](FilingNote.md)
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/filings/notes/{identifier}/html)
-
-[//]: # (DOC_LINK:FilingApi.md#get_note_html)
-
 # **get_note_html**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_note_html_v2)
-
 > String get_note_html(identifier)
 
 Filing Note HTML
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -311,8 +230,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -323,27 +240,12 @@ Name | Type | Description  | Notes
 
 **String**
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/filings/notes/{identifier}/text)
-
-[//]: # (DOC_LINK:FilingApi.md#get_note_text)
-
 # **get_note_text**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_note_text_v2)
-
 > String get_note_text(identifier)
 
 Filing Note Text
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -366,8 +268,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -378,19 +278,7 @@ Name | Type | Description  | Notes
 
 **String**
 
-[//]: # (END_OPERATION)
-
-
-[//]: # (START_OPERTATION)
-
-[//]: # (ENDPOINT:/filings/notes/search)
-
-[//]: # (DOC_LINK:FilingApi.md#search_notes)
-
 # **search_notes**
-
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_notes_v2)
-
 > ApiResponseFilingNotesSearch search_notes(query, opts)
 
 Search Filing Notes
@@ -398,9 +286,6 @@ Search Filing Notes
 Searches for Filing Notes using the `query`
 
 ### Example
-
-[//]: # (START_CODE_EXAMPLE)
-
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -429,8 +314,6 @@ rescue Intrinio::ApiError => e
 end
 ```
 
-[//]: # (END_CODE_EXAMPLE)
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -445,5 +328,3 @@ Name | Type | Description  | Notes
 
 [**ApiResponseFilingNotesSearch**](ApiResponseFilingNotesSearch.md)
 
-[//]: # (END_OPERATION)
-