intrinio-sdk 3.1.0 → 3.2.0

data/docs/DataPointApi.md

@@ -29,7 +29,7 @@ Method | HTTP request | Description
 
 ## **get_data_point_number**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_data_point_number_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_data_point_number_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -49,6 +49,7 @@ Returns a numeric value for the given `tag` and the entity with the given `ident
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -64,7 +65,7 @@ tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://d
 
 begin
   result = dataPoint_api.get_data_point_number(identifier, tag)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling DataPointApi->get_data_point_number: #{e}"
 end
@@ -114,7 +115,7 @@ Name | Type | Description  | Notes
 
 ## **get_data_point_text**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_data_point_text_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_data_point_text_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -134,6 +135,7 @@ Returns a text value for the given `tag` for the Security with the given `identi
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -149,7 +151,7 @@ tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.in
 
 begin
   result = dataPoint_api.get_data_point_text(identifier, tag)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling DataPointApi->get_data_point_text: #{e}"
 end

data/docs/DataTagApi.md

@@ -30,7 +30,7 @@ Method | HTTP request | Description
 
 ## **get_all_data_tags**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_data_tags_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_data_tags_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -50,6 +50,7 @@ Returns all Data Tags. Returns Data Tags matching parameters when specified.
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -70,7 +71,7 @@ opts = {
 
 begin
   result = dataTag_api.get_all_data_tags(opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling DataTagApi->get_all_data_tags: #{e}"
 end
@@ -125,7 +126,7 @@ Name | Type | Description  | Notes
 
 ## **get_data_tag_by_id**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_data_tag_by_id_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_data_tag_by_id_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -145,6 +146,7 @@ Returns the Data Tag with the given `identifier`
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -158,7 +160,7 @@ identifier = "marketcap" # String | The Intrinio ID or the code-name of the Data
 
 begin
   result = dataTag_api.get_data_tag_by_id(identifier)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling DataTagApi->get_data_tag_by_id: #{e}"
 end
@@ -207,7 +209,7 @@ Name | Type | Description  | Notes
 
 ## **search_data_tags**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_data_tags_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_data_tags_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -227,6 +229,7 @@ Searches for Data Tags matching the text `query`
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -243,7 +246,7 @@ opts = {
 
 begin
   result = dataTag_api.search_data_tags(query, opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling DataTagApi->search_data_tags: #{e}"
 end

data/docs/FilingApi.md

@@ -35,7 +35,7 @@ Method | HTTP request | Description
 
 ## **get_all_filings**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_filings_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_filings_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -55,6 +55,7 @@ Returns all Filings. Returns Filings matching parameters when supplied.
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -75,7 +76,7 @@ opts = {
 
 begin
   result = filing_api.get_all_filings(company, opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->get_all_filings: #{e}"
 end
@@ -129,7 +130,7 @@ Name | Type | Description  | Notes
 
 ## **get_all_notes**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_notes_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_notes_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -149,6 +150,7 @@ Return all Notes from all Filings, most-recent first. Returns notes matching par
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -170,7 +172,7 @@ opts = {
 
 begin
   result = filing_api.get_all_notes(opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->get_all_notes: #{e}"
 end
@@ -226,7 +228,7 @@ Name | Type | Description  | Notes
 
 ## **get_filing_by_id**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_filing_by_id_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_filing_by_id_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -246,6 +248,7 @@ Returns the Filing with the given `identifier`
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -259,7 +262,7 @@ id = "fil_7Kn2P6" # String | The Intrinio ID of the Filing
 
 begin
   result = filing_api.get_filing_by_id(id)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->get_filing_by_id: #{e}"
 end
@@ -308,7 +311,7 @@ Name | Type | Description  | Notes
 
 ## **get_filing_fundamentals**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_filing_fundamentals_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_filing_fundamentals_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -328,6 +331,7 @@ Returns all Fundamentals for the SEC Filing with the given `identifier`. Returns
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -350,7 +354,7 @@ opts = {
 
 begin
   result = filing_api.get_filing_fundamentals(identifier, opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->get_filing_fundamentals: #{e}"
 end
@@ -406,7 +410,7 @@ Name | Type | Description  | Notes
 
 ## **get_note**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_note_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_note_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -425,6 +429,7 @@ Name | Type | Description  | Notes
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -441,7 +446,7 @@ opts = {
 
 begin
   result = filing_api.get_note(identifier, opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->get_note: #{e}"
 end
@@ -491,7 +496,7 @@ Name | Type | Description  | Notes
 
 ## **get_note_html**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_note_html_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_note_html_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -510,6 +515,7 @@ Name | Type | Description  | Notes
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -523,7 +529,7 @@ identifier = "xbn_3fghz" # String | The Intrinio ID of the filing note
 
 begin
   result = filing_api.get_note_html(identifier)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->get_note_html: #{e}"
 end
@@ -572,7 +578,7 @@ Name | Type | Description  | Notes
 
 ## **get_note_text**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_note_text_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_note_text_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -591,6 +597,7 @@ Name | Type | Description  | Notes
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -604,7 +611,7 @@ identifier = "xbn_3fghz" # String | The Intrinio ID of the filing note
 
 begin
   result = filing_api.get_note_text(identifier)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->get_note_text: #{e}"
 end
@@ -653,7 +660,7 @@ Name | Type | Description  | Notes
 
 ## **search_notes**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_notes_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_notes_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -673,6 +680,7 @@ Searches for Filing Notes using the `query`
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -692,7 +700,7 @@ opts = {
 
 begin
   result = filing_api.search_notes(query, opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FilingApi->search_notes: #{e}"
 end

data/docs/ForexApi.md

@@ -30,7 +30,7 @@ Method | HTTP request | Description
 
 ## **get_forex_currencies**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_currencies_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_forex_currencies_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -50,6 +50,7 @@ Returns a list of forex currencies for which prices are available.
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -60,7 +61,7 @@ forex_api = Intrinio::ForexApi.new
 
 begin
   result = forex_api.get_forex_currencies
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling ForexApi->get_forex_currencies: #{e}"
 end
@@ -106,7 +107,7 @@ This endpoint does not need any parameter.
 
 ## **get_forex_pairs**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_pairs_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_forex_pairs_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -126,6 +127,7 @@ Returns a list of currency pairs used to request foreign exchange (forex) market
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -136,7 +138,7 @@ forex_api = Intrinio::ForexApi.new
 
 begin
   result = forex_api.get_forex_pairs
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling ForexApi->get_forex_pairs: #{e}"
 end
@@ -182,7 +184,7 @@ This endpoint does not need any parameter.
 
 ## **get_forex_prices**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_prices_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_forex_prices_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -202,6 +204,7 @@ Provides a list of forex price quotes for a given forex currency pair and timefr
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -226,7 +229,7 @@ opts = {
 
 begin
   result = forex_api.get_forex_prices(pair, timeframe, opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling ForexApi->get_forex_prices: #{e}"
 end

data/docs/FundamentalsApi.md

@@ -31,7 +31,7 @@ Method | HTTP request | Description
 
 ## **get_fundamental_by_id**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_by_id_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_fundamental_by_id_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -51,6 +51,7 @@ Returns detailed fundamental data for the given `id`.
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -64,7 +65,7 @@ id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental
 
 begin
   result = fundamentals_api.get_fundamental_by_id(id)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FundamentalsApi->get_fundamental_by_id: #{e}"
 end
@@ -113,7 +114,7 @@ Name | Type | Description  | Notes
 
 ## **get_fundamental_reported_financials**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_reported_financials_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_fundamental_reported_financials_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -133,6 +134,7 @@ Returns the As-Reported Financials directly from the financial statements of the
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -146,7 +148,7 @@ id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (
 
 begin
   result = fundamentals_api.get_fundamental_reported_financials(id)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FundamentalsApi->get_fundamental_reported_financials: #{e}"
 end
@@ -195,7 +197,7 @@ Name | Type | Description  | Notes
 
 ## **get_fundamental_standardized_financials**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_standardized_financials_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_fundamental_standardized_financials_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -204,7 +206,7 @@ Name | Type | Description  | Notes
 #### 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. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
+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.
 
 [//]: # (END_OVERVIEW)
 
@@ -215,6 +217,7 @@ Returns professional-grade historical financial data. This data is standardized,
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -228,7 +231,7 @@ id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (
 
 begin
   result = fundamentals_api.get_fundamental_standardized_financials(id)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FundamentalsApi->get_fundamental_standardized_financials: #{e}"
 end
@@ -277,7 +280,7 @@ Name | Type | Description  | Notes
 
 ## **lookup_fundamental**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/lookup_fundamental_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/lookup_fundamental_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -297,6 +300,7 @@ Returns the Fundamental for the Company with the given `identifier` and with the
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -316,7 +320,7 @@ fiscal_period = "FY" # String | The fiscal period
 
 begin
   result = fundamentals_api.lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling FundamentalsApi->lookup_fundamental: #{e}"
 end

data/docs/HistoricalDataApi.md

@@ -28,7 +28,7 @@ Method | HTTP request | Description
 
 ## **get_historical_data**
 
-[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_historical_data_v2)
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_historical_data_v2)
 
 [//]: # (START_OVERVIEW)
 
@@ -48,6 +48,7 @@ Returns historical values for the given `tag` and the entity represented by the
 ```ruby
 # Load the gem
 require 'intrinio-sdk'
+require 'pp'
 
 # Setup authorization
 Intrinio.configure do |config|
@@ -72,7 +73,7 @@ opts = {
 
 begin
   result = historicalData_api.get_historical_data(identifier, tag, opts)
-  p result
+  pp result
 rescue Intrinio::ApiError => e
   puts "Exception when calling HistoricalDataApi->get_historical_data: #{e}"
 end