FundamentalsApi.md in intrinio-sdk-5.21.0

- old
+ new

@@ -2,10 +2,11 @@
 
 All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**filter_fundamental**](FundamentalsApi.md#filter_fundamental) | **GET** /fundamentals | Filter Fundamental
 [**get_fundamental_by_id**](FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
 [**get_fundamental_reported_financials**](FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
 [**get_fundamental_standardized_financials**](FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
 [**get_fundamental_standardized_financials_dimensions**](FundamentalsApi.md#get_fundamental_standardized_financials_dimensions) | **GET** /fundamentals/{id}/standardized_financials/dimensions/{tag} | Standardized Financials Dimensions
 [**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
@@ -14,10 +15,108 @@
 
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::FundamentalsApi)
 
+[//]: # (METHOD:filter_fundamental)
+
+[//]: # (RETURN_TYPE:Intrinio::Fundamental)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:Fundamental.md)
+
+[//]: # (OPERATION:filter_fundamental_v2)
+
+[//]: # (ENDPOINT:/fundamentals)
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#filter_fundamental)
+
+## **filter_fundamental**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/filter_fundamental_v2)
+
+[//]: # (START_OVERVIEW)
+
+> Fundamental filter_fundamental(opts)
+
+#### Filter Fundamental
+
+
+Returns fundamentals that meet the set of filters specified in parameters.
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+
+fundamentals_api = Intrinio::FundamentalsApi.new
+
+opts = {
+  filed_after: Date.parse("2022-01-01"),
+  filed_before: Date.parse("2022-12-01"),
+  reported_only: false,
+  fiscal_year: 2017,
+  statement_code: nil,
+  type: "false",
+  fiscal_period: "FY",
+  start_date: Date.parse("2022-01-01"),
+  end_date: Date.parse("2022-12-01"),
+  next_page: nil
+}
+
+result = fundamentals_api.filter_fundamental(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filed_after** | Date| Only include fundamentals that were filed on or after this date. | [optional]  &nbsp;
+ **filed_before** | Date| Only include fundamentals that were filed on or before this date. | [optional]  &nbsp;
+ **reported_only** | BOOLEAN| Only as-reported fundamentals | [optional]  &nbsp;
+ **fiscal_year** | Integer| Only for the given fiscal year | [optional]  &nbsp;
+ **statement_code** | String| Only of the given statement code | [optional]  &nbsp;
+ **type** | String| Only of the given type | [optional]  &nbsp;
+ **fiscal_period** | String| The fiscal period | [optional]  &nbsp;
+ **start_date** | Date| Only include fundamentals where covered period is on or after this date. | [optional]  &nbsp;
+ **end_date** | Date| Only include fundamentals where covered period is on or before this date. | [optional]  &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**Fundamental**](Fundamental.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FundamentalsApi)
+
 [//]: # (METHOD:get_fundamental_by_id)
 
 [//]: # (RETURN_TYPE:Intrinio::Fundamental)
 
 [//]: # (RETURN_TYPE_KIND:object)
@@ -39,11 +138,11 @@
 > Fundamental get_fundamental_by_id(id)
 
 #### Fundamental by ID
 
 
-Returns detailed fundamental data for the given `id`.
+Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.
 
 [//]: # (END_OVERVIEW)
 
 ### Example
 
@@ -116,11 +215,11 @@
 > ApiResponseReportedFinancials get_fundamental_reported_financials(id)
 
 #### Reported Financials
 
 
-Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
+Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
 
 [//]: # (END_OVERVIEW)
 
 ### Example
 
@@ -193,11 +292,11 @@
 > ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)
 
 #### Standardized Financials
 
 
-Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies' fundamentals.
+Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
 
 [//]: # (END_OVERVIEW)
 
 ### Example
 
@@ -349,10 +448,10 @@
 > Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
 
 #### Lookup Fundamental
 
 
-Returns the Fundamental for the Company with the given `identifier` and with the given parameters
+Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.
 
 [//]: # (END_OVERVIEW)
 
 ### Example
 