intrinio-sdk 1.1.1 → 2.0.0

data/docs/DataTagApi.md

@@ -4,18 +4,17 @@ All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**filter_data_tags**](DataTagApi.md#filter_data_tags) | **GET** /data_tags/filter | Filter Data Tags
 [**get_all_data_tags**](DataTagApi.md#get_all_data_tags) | **GET** /data_tags | All Data Tags
 [**get_data_tag_by_id**](DataTagApi.md#get_data_tag_by_id) | **GET** /data_tags/{identifier} | Lookup Data Tag
 [**search_data_tags**](DataTagApi.md#search_data_tags) | **GET** /data_tags/search | Search Data Tags
 
 
-# **filter_data_tags**
-> ApiResponseDataTags filter_data_tags(opts)
+# **get_all_data_tags**
+> ApiResponseDataTags get_all_data_tags(opts)
 
-Filter Data Tags
+All Data Tags
 
-Returns Data Tags that match the given filters
+Returns all Data Tags. Returns Data Tags matching parameters when specified.
 
 ### Example
 ```ruby
@@ -35,14 +34,15 @@ 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
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
 begin
-  result = dataTag_api.filter_data_tags(opts)
+  result = dataTag_api.get_all_data_tags(opts)
   p result
 rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->filter_data_tags: #{e}"
+  puts "Exception when calling DataTagApi->get_all_data_tags: #{e}"
 end
 ```
 
@@ -55,47 +55,7 @@ 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]
- **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
-
-### Return type
-
-[**ApiResponseDataTags**](ApiResponseDataTags.md)
-
-# **get_all_data_tags**
-> ApiResponseDataTags get_all_data_tags(opts)
-
-All Data Tags
-
-Returns All Data Tags
-
-### Example
-```ruby
-# Load the gem
-require 'intrinio-sdk'
-
-# Setup authorization
-Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
-end
-
-dataTag_api = Intrinio::DataTagApi.new
-
-opts = { 
-  next_page: nil # String | Gets the next page of data from a previous API call
-}
-
-begin
-  result = dataTag_api.get_all_data_tags(opts)
-  p result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->get_all_data_tags: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
+ **page_size** | **Float**| 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
@@ -143,7 +103,7 @@ Name | Type | Description  | Notes
 [**DataTag**](DataTag.md)
 
 # **search_data_tags**
-> ApiResponseDataTags search_data_tags(query)
+> ApiResponseDataTagsSearch search_data_tags(query, opts)
 
 Search Data Tags
 
@@ -163,9 +123,12 @@ dataTag_api = Intrinio::DataTagApi.new
 
 query = "revenue" # String | 
 
+opts = { 
+  page_size: 100 # Float | The number of results to return
+}
 
 begin
-  result = dataTag_api.search_data_tags(query)
+  result = dataTag_api.search_data_tags(query, opts)
   p result
 rescue Intrinio::ApiError => e
   puts "Exception when calling DataTagApi->search_data_tags: #{e}"
@@ -177,8 +140,9 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | **String**|  | 
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
-[**ApiResponseDataTags**](ApiResponseDataTags.md)
+[**ApiResponseDataTagsSearch**](ApiResponseDataTagsSearch.md)
 

data/docs/FilingApi.md

@@ -4,8 +4,6 @@ All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**filter_filings**](FilingApi.md#filter_filings) | **GET** /filings/filter | Filter Filings
-[**filter_notes**](FilingApi.md#filter_notes) | **GET** /filings/notes/filter | Filter Filing Notes
 [**get_all_filings**](FilingApi.md#get_all_filings) | **GET** /filings | All Filings
 [**get_all_notes**](FilingApi.md#get_all_notes) | **GET** /filings/notes | All Filing Notes
 [**get_filing_by_id**](FilingApi.md#get_filing_by_id) | **GET** /filings/{id} | Lookup Filing
@@ -15,12 +13,12 @@ Method | HTTP request | Description
 [**search_notes**](FilingApi.md#search_notes) | **GET** /filings/notes/search | Search Filing Notes
 
 
-# **filter_filings**
-> ApiResponseFilings filter_filings(company, opts)
+# **get_all_filings**
+> ApiResponseFilings get_all_filings(company, opts)
 
-Filter Filings
+All Filings
 
-Returns Filings that match the specified filters
+Returns all Filings. Returns Filings matching parameters when supplied.
 
 ### Example
 ```ruby
@@ -40,14 +38,15 @@ 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
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
 begin
-  result = filing_api.filter_filings(company, opts)
+  result = filing_api.get_all_filings(company, opts)
   p result
 rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->filter_filings: #{e}"
+  puts "Exception when calling FilingApi->get_all_filings: #{e}"
 end
 ```
 
@@ -59,18 +58,19 @@ 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]
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
 
 ### Return type
 
 [**ApiResponseFilings**](ApiResponseFilings.md)
 
-# **filter_notes**
-> ApiResponseFilingNotes filter_notes(opts)
+# **get_all_notes**
+> ApiResponseFilingNotes get_all_notes(opts)
 
-Filter Filing Notes
+All Filing Notes
 
-Returns Filing Notes that match the specified filters
+Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied.
 
 ### Example
 ```ruby
@@ -91,14 +91,15 @@ 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
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
 begin
-  result = filing_api.filter_notes(opts)
+  result = filing_api.get_all_notes(opts)
   p result
 rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->filter_notes: #{e}"
+  puts "Exception when calling FilingApi->get_all_notes: #{e}"
 end
 ```
 
@@ -112,88 +113,7 @@ 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] 
- **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
-
-### Return type
-
-[**ApiResponseFilingNotes**](ApiResponseFilingNotes.md)
-
-# **get_all_filings**
-> ApiResponseFilings get_all_filings(opts)
-
-All Filings
-
-Returns all Filings
-
-### Example
-```ruby
-# Load the gem
-require 'intrinio-sdk'
-
-# Setup authorization
-Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
-end
-
-filing_api = Intrinio::FilingApi.new
-
-opts = { 
-  next_page: nil # String | Gets the next page of data from a previous API call
-}
-
-begin
-  result = filing_api.get_all_filings(opts)
-  p result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_all_filings: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
-
-### Return type
-
-[**ApiResponseFilings**](ApiResponseFilings.md)
-
-# **get_all_notes**
-> ApiResponseFilingNotes get_all_notes(opts)
-
-All Filing Notes
-
-Return all Notes from all Filings, most-recent first
-
-### Example
-```ruby
-# Load the gem
-require 'intrinio-sdk'
-
-# Setup authorization
-Intrinio.configure do |config|
-  config.api_key['api_key'] = 'YOUR API KEY'
-end
-
-filing_api = Intrinio::FilingApi.new
-
-opts = { 
-  next_page: nil # String | Gets the next page of data from a previous API call
-}
-
-begin
-  result = filing_api.get_all_notes(opts)
-  p result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_all_notes: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
+ **page_size** | **Float**| 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
@@ -382,7 +302,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_size: 100, # Float | The number of results to return
+  page_size2: 100 # Float | The number of results to return
 }
 
 begin
@@ -401,6 +322,7 @@ Name | Type | Description  | Notes
  **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]
 
 ### Return type
 

data/docs/FundamentalSummary.md

@@ -10,6 +10,6 @@ Name | Type | Description | Notes
 **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** | **Date** | The date and time when the Fundamental was filed with the SEC | [optional] 
+**filing_date** | **DateTime** | The date and time when the Fundamental was filed with the SEC | [optional] 
 
 

data/docs/HistoricalDataApi.md

@@ -35,6 +35,7 @@ opts = {
   start_date: Date.parse("2015-01-01"), # Date | Get historical data on or after this date
   end_date: Date.parse("2019-01-01"), # Date | Get historical date on or before this date
   sort_order: "desc", # String | Sort by date `asc` or `desc`
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -56,6 +57,7 @@ Name | Type | Description  | Notes
  **start_date** | **Date**| Get historical data on or after this date | [optional] 
  **end_date** | **Date**| Get historical date on or before this date | [optional] 
  **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **page_size** | **Float**| 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

data/docs/IndexApi.md

@@ -42,6 +42,7 @@ end
 index_api = Intrinio::IndexApi.new
 
 opts = { 
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -57,6 +58,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **page_size** | **Float**| 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
@@ -81,6 +83,7 @@ end
 index_api = Intrinio::IndexApi.new
 
 opts = { 
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -96,6 +99,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **page_size** | **Float**| 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
@@ -120,6 +124,7 @@ end
 index_api = Intrinio::IndexApi.new
 
 opts = { 
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -135,6 +140,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **page_size** | **Float**| 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
@@ -293,6 +299,7 @@ opts = {
   start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
   end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
   sort_order: "desc", # String | Sort by date `asc` or `desc`
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -314,6 +321,7 @@ Name | Type | Description  | Notes
  **start_date** | **Date**| Get historical data on or after this date | [optional] 
  **end_date** | **Date**| Get historical data on or before this date | [optional] 
  **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **page_size** | **Float**| 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
@@ -472,6 +480,7 @@ opts = {
   start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
   end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
   sort_order: "desc", # String | Sort by date `asc` or `desc`
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -493,6 +502,7 @@ Name | Type | Description  | Notes
  **start_date** | **Date**| Get historical data on or after this date | [optional] 
  **end_date** | **Date**| Get historical data on or before this date | [optional] 
  **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **page_size** | **Float**| 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
@@ -651,6 +661,7 @@ opts = {
   start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
   end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
   sort_order: "desc", # String | Sort by date `asc` or `desc`
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
@@ -672,6 +683,7 @@ Name | Type | Description  | Notes
  **start_date** | **Date**| Get historical data on or after this date | [optional] 
  **end_date** | **Date**| Get historical data on or before this date | [optional] 
  **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **page_size** | **Float**| 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
@@ -679,7 +691,7 @@ Name | Type | Description  | Notes
 [**ApiResponseStockMarketIndexHistoricalData**](ApiResponseStockMarketIndexHistoricalData.md)
 
 # **search_economic_indices**
-> ApiResponseEconomicIndices search_economic_indices(query)
+> ApiResponseEconomicIndicesSearch search_economic_indices(query, opts)
 
 Search Economic Indices
 
@@ -699,9 +711,12 @@ index_api = Intrinio::IndexApi.new
 
 query = "GDP" # String | Search query
 
+opts = { 
+  page_size: 100 # Float | The number of results to return
+}
 
 begin
-  result = index_api.search_economic_indices(query)
+  result = index_api.search_economic_indices(query, opts)
   p result
 rescue Intrinio::ApiError => e
   puts "Exception when calling IndexApi->search_economic_indices: #{e}"
@@ -713,13 +728,14 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | **String**| Search query | 
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
-[**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md)
+[**ApiResponseEconomicIndicesSearch**](ApiResponseEconomicIndicesSearch.md)
 
 # **search_sic_indices**
-> ApiResponseSICIndices search_sic_indices(query)
+> ApiResponseSICIndicesSearch search_sic_indices(query, opts)
 
 Search SIC Indices
 
@@ -739,9 +755,12 @@ index_api = Intrinio::IndexApi.new
 
 query = "agriculture" # String | Search query
 
+opts = { 
+  page_size: 100 # Float | The number of results to return
+}
 
 begin
-  result = index_api.search_sic_indices(query)
+  result = index_api.search_sic_indices(query, opts)
   p result
 rescue Intrinio::ApiError => e
   puts "Exception when calling IndexApi->search_sic_indices: #{e}"
@@ -753,13 +772,14 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | **String**| Search query | 
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
-[**ApiResponseSICIndices**](ApiResponseSICIndices.md)
+[**ApiResponseSICIndicesSearch**](ApiResponseSICIndicesSearch.md)
 
 # **search_stock_markets_indices**
-> ApiResponseStockMarketIndices search_stock_markets_indices(query)
+> ApiResponseStockMarketIndicesSearch search_stock_markets_indices(query, opts)
 
 Search Stock Market Indices
 
@@ -779,9 +799,12 @@ index_api = Intrinio::IndexApi.new
 
 query = "dow" # String | Search query
 
+opts = { 
+  page_size: 100 # Float | The number of results to return
+}
 
 begin
-  result = index_api.search_stock_markets_indices(query)
+  result = index_api.search_stock_markets_indices(query, opts)
   p result
 rescue Intrinio::ApiError => e
   puts "Exception when calling IndexApi->search_stock_markets_indices: #{e}"
@@ -793,8 +816,9 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | **String**| Search query | 
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
-[**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md)
+[**ApiResponseStockMarketIndicesSearch**](ApiResponseStockMarketIndicesSearch.md)