intrinio-sdk 2.2.0 → 2.3.0

data/docs/CryptoPrice.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**time** | **String** | The date and time of the beginning of the timeframe (in UTC). The open prices would be at this time, while close prices would be at this time plus the timeframe. | [optional] 
+**time** | **DateTime** | The date and time of the beginning of the timeframe (in UTC). The open prices would be at this time, while close prices would be at this time plus the timeframe. | [optional] 
 **open** | **Float** | The opening price of the timeframe. | [optional] 
 **high** | **Float** | The high price of the timeframe. | [optional] 
 **low** | **Float** | The low price of the timeframe. | [optional] 

data/docs/DataPointApi.md

@@ -8,14 +8,27 @@ 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)
 
-$$v2_data_point_number_description$$
+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'
@@ -27,9 +40,9 @@ end
 
 dataPoint_api = Intrinio::DataPointApi.new
 
-identifier = "$$v2_data_point_identifier_default$$" # String | $$v2_data_point_identifier_description$$
+identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
 
-tag = "$$v2_data_point_item_number_default$$" # String | $$v2_data_point_item_description$$
+tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
 
 
 begin
@@ -40,25 +53,42 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | **String**| $$v2_data_point_identifier_description$$ | 
- **tag** | **String**| $$v2_data_point_item_description$$ | 
+ **identifier** | **String**| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | 
 
 ### Return type
 
 **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)
 
-$$v2_data_point_text_description$$
+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'
@@ -70,9 +100,9 @@ end
 
 dataPoint_api = Intrinio::DataPointApi.new
 
-identifier = "$$v2_data_point_identifier_default$$" # String | $$v2_data_point_identifier_description$$
+identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
 
-tag = "$$v2_data_point_item_text_default$$" # String | $$v2_data_point_item_description$$
+tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
 
 
 begin
@@ -83,14 +113,18 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | **String**| $$v2_data_point_identifier_description$$ | 
- **tag** | **String**| $$v2_data_point_item_description$$ | 
+ **identifier** | **String**| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | 
 
 ### Return type
 
 **String**
 
+[//]: # (END_OPERATION)
+

data/docs/DataTagApi.md

@@ -9,7 +9,17 @@ 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
@@ -17,6 +27,9 @@ 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'
@@ -34,7 +47,7 @@ opts = {
   parent: nil, # String | ID of tag parent
   statement_code: "income_statement", # String | Statement Code
   fs_template: "industrial", # String | Template
-  page_size: 100, # Float | The number of results to return
+  page_size: 100, # Integer | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -46,6 +59,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -55,14 +70,26 @@ Name | Type | Description  | Notes
  **parent** | **String**| ID of tag parent | [optional] 
  **statement_code** | **String**| Statement Code | [optional] 
  **fs_template** | **String**| Template | [optional] [default to industrial]
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
+ **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] 
 
 ### Return type
 
 [**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
@@ -70,6 +97,9 @@ Lookup Data Tag
 Returns the Data Tag with the given `identifier`
 
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -92,6 +122,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -102,7 +134,19 @@ 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
@@ -110,6 +154,9 @@ Search Data Tags
 Searches for Data Tags matching the text `query`
 
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -124,7 +171,7 @@ dataTag_api = Intrinio::DataTagApi.new
 query = "revenue" # String | 
 
 opts = { 
-  page_size: 100 # Float | The number of results to return
+  page_size: 100 # Integer | The number of results to return
 }
 
 begin
@@ -135,14 +182,18 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | **String**|  | 
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
 [**ApiResponseDataTagsSearch**](ApiResponseDataTagsSearch.md)
 
+[//]: # (END_OPERATION)
+

data/docs/FilingApi.md

@@ -13,7 +13,17 @@ 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
@@ -21,6 +31,9 @@ All Filings
 Returns all Filings. Returns Filings matching parameters when supplied.
 
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -37,8 +50,8 @@ company = "AAPL" # String | Filings for the given `company` identifier (ticker,
 opts = { 
   report_type: nil, # String | Filter by report type
   start_date: Date.parse("2015-01-01"), # Date | Filed on or after the given date
-  end_date: Date.parse("2019-01-01"), # Date | Filed before or after the given date
-  page_size: 100, # Float | The number of results to return
+  end_date: nil, # Date | Filed before or after the given date
+  page_size: 100, # Integer | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -50,6 +63,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -58,14 +73,26 @@ Name | Type | Description  | Notes
  **report_type** | **String**| Filter by report type | [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** | **Float**| The number of results to return | [optional] [default to 100]
+ **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] 
 
 ### Return type
 
 [**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
@@ -73,6 +100,9 @@ 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'
@@ -91,7 +121,7 @@ opts = {
   filing_end_date: Date.parse("2018-11-15"), # Date | Limit search to filings on or before this date
   period_ended_start_date: Date.parse("2018-07-15"), # Date | Limit search to filings with a period end date on or after this date
   period_ended_end_date: Date.parse("2018-11-15"), # Date | Limit search to filings with a period end date on or before this date
-  page_size: 100, # Float | The number of results to return
+  page_size: 100, # Integer | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -103,6 +133,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -113,14 +145,26 @@ Name | Type | Description  | Notes
  **filing_end_date** | **Date**| Limit search to filings on or before this date | [optional] 
  **period_ended_start_date** | **Date**| Limit search to filings with a period end date on or after this date | [optional] 
  **period_ended_end_date** | **Date**| Limit search to filings with a period end date on or before this date | [optional] 
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
+ **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] 
 
 ### Return type
 
 [**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
@@ -128,6 +172,9 @@ Lookup Filing
 Returns the Filing with the given `identifier`
 
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -150,6 +197,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -160,12 +209,27 @@ 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'
@@ -191,6 +255,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -202,12 +268,27 @@ 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'
@@ -230,6 +311,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -240,12 +323,27 @@ 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'
@@ -268,6 +366,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -278,7 +378,19 @@ 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
@@ -286,6 +398,9 @@ Search Filing Notes
 Searches for Filing Notes using the `query`
 
 ### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
@@ -302,8 +417,8 @@ query = "inflation" # String | Search for notes that contain all or parts of thi
 opts = { 
   filing_start_date: Date.parse("2018-07-15"), # Date | Limit search to filings on or after this date
   filing_end_date: Date.parse("2018-11-30"), # Date | Limit search to filings on or before this date
-  page_size: 100, # Float | The number of results to return
-  page_size2: 100 # Float | The number of results to return
+  page_size: 100, # Integer | The number of results to return
+  page_size2: 100 # Integer | The number of results to return
 }
 
 begin
@@ -314,6 +429,8 @@ rescue Intrinio::ApiError => e
 end
 ```
 
+[//]: # (END_CODE_EXAMPLE)
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -321,10 +438,12 @@ Name | Type | Description  | Notes
  **query** | **String**| Search for notes that contain all or parts of this text | 
  **filing_start_date** | **Date**| Limit search to filings on or after this date | [optional] 
  **filing_end_date** | **Date**| Limit search to filings on or before this date | [optional] 
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
- **page_size2** | **Float**| The number of results to return | [optional] [default to 100]
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
+ **page_size2** | **Integer**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
 [**ApiResponseFilingNotesSearch**](ApiResponseFilingNotesSearch.md)
 
+[//]: # (END_OPERATION)
+