intrinio-sdk 5.19.0 → 6.21.0

data/lib/intrinio-sdk/api/fundamentals_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.27.2
+OpenAPI spec version: 2.28.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -20,8 +20,94 @@ module Intrinio
       @api_client = api_client
     end
 
+    # Filter Fundamental
+    # Returns fundamentals that meet the set of filters specified in parameters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :filed_after Only include fundamentals that were filed on or after this date.
+    # @option opts [Date] :filed_before Only include fundamentals that were filed on or before this date.
+    # @option opts [BOOLEAN] :reported_only Only as-reported fundamentals
+    # @option opts [Integer] :fiscal_year Only for the given fiscal year
+    # @option opts [String] :statement_code Only of the given statement code
+    # @option opts [String] :type Only of the given type
+    # @option opts [String] :fiscal_period The fiscal period
+    # @option opts [Date] :start_date Only include fundamentals where covered period is on or after this date.
+    # @option opts [Date] :end_date Only include fundamentals where covered period is on or before this date.
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [Fundamental]
+    def filter_fundamental(opts = {})
+      data, _status_code, _headers = filter_fundamental_with_http_info(opts)
+      return data
+    end
+
+    # Filter Fundamental
+    # Returns fundamentals that meet the set of filters specified in parameters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :filed_after Only include fundamentals that were filed on or after this date.
+    # @option opts [Date] :filed_before Only include fundamentals that were filed on or before this date.
+    # @option opts [BOOLEAN] :reported_only Only as-reported fundamentals
+    # @option opts [Integer] :fiscal_year Only for the given fiscal year
+    # @option opts [String] :statement_code Only of the given statement code
+    # @option opts [String] :type Only of the given type
+    # @option opts [String] :fiscal_period The fiscal period
+    # @option opts [Date] :start_date Only include fundamentals where covered period is on or after this date.
+    # @option opts [Date] :end_date Only include fundamentals where covered period is on or before this date.
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [Array<(Fundamental, Fixnum, Hash)>] Fundamental data, response status code and response headers
+    def filter_fundamental_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FundamentalsApi.filter_fundamental ..."
+      end
+      if @api_client.config.client_side_validation && opts[:'statement_code'] && !['income_statement', 'balance_sheet_statement', 'cash_flow_statement', 'calculations'].include?(opts[:'statement_code'])
+        fail ArgumentError, 'invalid value for "statement_code", must be one of income_statement, balance_sheet_statement, cash_flow_statement, calculations'
+      end
+      if @api_client.config.client_side_validation && opts[:'type'] && !['QTR', 'YTD', 'FY', 'TTM'].include?(opts[:'type'])
+        fail ArgumentError, 'invalid value for "type", must be one of QTR, YTD, FY, TTM'
+      end
+      if @api_client.config.client_side_validation && opts[:'fiscal_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'fiscal_period'])
+        fail ArgumentError, 'invalid value for "fiscal_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
+      end
+      # resource path
+      local_var_path = "/fundamentals"
+
+      # query parameters
+      query_params = {}
+      query_params[:'filed_after'] = opts[:'filed_after'] if !opts[:'filed_after'].nil?
+      query_params[:'filed_before'] = opts[:'filed_before'] if !opts[:'filed_before'].nil?
+      query_params[:'reported_only'] = opts[:'reported_only'] if !opts[:'reported_only'].nil?
+      query_params[:'fiscal_year'] = opts[:'fiscal_year'] if !opts[:'fiscal_year'].nil?
+      query_params[:'statement_code'] = opts[:'statement_code'] if !opts[:'statement_code'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'fiscal_period'] = opts[:'fiscal_period'] if !opts[:'fiscal_period'].nil?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Fundamental')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundamentalsApi#filter_fundamental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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.
     # @param id The Intrinio ID for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Fundamental]
@@ -31,7 +117,7 @@ module Intrinio
     end
 
     # Fundamental by ID
-    # Returns detailed fundamental data for the given &#x60;id&#x60;.
+    # Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.
     # @param id The Intrinio ID for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Array<(Fundamental, Fixnum, Hash)>] Fundamental data, response status code and response headers
@@ -74,7 +160,7 @@ module Intrinio
     end
 
     # 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.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [ApiResponseReportedFinancials]
@@ -84,7 +170,7 @@ module Intrinio
     end
 
     # 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.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiResponseReportedFinancials, Fixnum, Hash)>] ApiResponseReportedFinancials data, response status code and response headers
@@ -127,7 +213,7 @@ module Intrinio
     end
 
     # 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.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [ApiResponseStandardizedFinancials]
@@ -137,7 +223,7 @@ module Intrinio
     end
 
     # 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&#39; 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.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiResponseStandardizedFinancials, Fixnum, Hash)>] ApiResponseStandardizedFinancials data, response status code and response headers
@@ -239,7 +325,7 @@ module Intrinio
     end
 
     # 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.
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param statement_code The statement code
     # @param fiscal_year The fiscal year
@@ -252,7 +338,7 @@ module Intrinio
     end
 
     # Lookup Fundamental
-    # Returns the Fundamental for the Company with the given &#x60;identifier&#x60; 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.
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param statement_code The statement code
     # @param fiscal_year The fiscal year

data/lib/intrinio-sdk/api/historical_data_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.27.2
+OpenAPI spec version: 2.28.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/index_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.27.2
+OpenAPI spec version: 2.28.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -21,7 +21,7 @@ module Intrinio
     end
 
     # All Economic Indices
-    # 
+    # Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return (default to 100)
     # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -32,7 +32,7 @@ module Intrinio
     end
 
     # All Economic Indices
-    # 
+    # Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return
     # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -192,7 +192,7 @@ module Intrinio
     end
 
     # Lookup Economic Index
-    # 
+    # Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @return [EconomicIndex]
@@ -202,7 +202,7 @@ module Intrinio
     end
 
     # Lookup Economic Index
-    # 
+    # Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @return [Array<(EconomicIndex, Fixnum, Hash)>] EconomicIndex data, response status code and response headers
@@ -245,7 +245,7 @@ module Intrinio
     end
 
     # Data Point (Number) for an Economic Index
-    # Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
+    # Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -256,7 +256,7 @@ module Intrinio
     end
 
     # Data Point (Number) for an Economic Index
-    # Returns a numeric value for the given &#x60;tag&#x60; for the Economic Index with the given &#x60;identifier&#x60;
+    # Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -363,7 +363,7 @@ module Intrinio
     end
 
     # Historical Data for an Economic Index
-    # Returns historical values for the given `tag` and the Economic Index with the given `identifier`
+    # Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -380,7 +380,7 @@ module Intrinio
     end
 
     # Historical Data for an Economic Index
-    # Returns historical values for the given &#x60;tag&#x60; and the Economic Index with the given &#x60;identifier&#x60;
+    # Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -957,7 +957,7 @@ module Intrinio
     end
 
     # Search Economic Indices
-    # Searches for indices using the text in `query`
+    # Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.
     # @param query Search query
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -968,7 +968,7 @@ module Intrinio
     end
 
     # Search Economic Indices
-    # Searches for indices using the text in &#x60;query&#x60;
+    # Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.
     # @param query Search query
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return

data/lib/intrinio-sdk/api/insider_transaction_filings_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.27.2
+OpenAPI spec version: 2.28.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/municipality_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.27.2
+OpenAPI spec version: 2.28.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset