intrinio-sdk 5.4.0 → 5.6.4

data/docs/FilingApi.md

@@ -62,28 +62,24 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
-
-company = "AAPL" # String | Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)
-
-opts = { 
-  report_type: nil, # String | Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>.
-  start_date: Date.parse("2015-01-01"), # Date | Filed on or after the given date
-  end_date: nil, # Date | Filed before or after the given date
-  industry_category: nil, # String | Return companies in the given industry category
-  industry_group: nil, # String | Return companies in the given industry group
-  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
+company = "AAPL"
+
+opts = {
+  report_type: "10-Q",
+  start_date: Date.parse("2015-01-01"),
+  end_date: nil,
+  industry_category: nil,
+  industry_group: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = filing_api.get_all_filings(company, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_all_filings: #{e}"
-end
+result = filing_api.get_all_filings(company, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -160,27 +156,24 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
 
-opts = { 
-  company: "AAPL", # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-  report_type: "10-Q", # String | Notes contained in filings that match the given <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>
-  filing_start_date: nil, # Date | Limit search to filings on or after this date
-  filing_end_date: nil, # Date | Limit search to filings on or before this date
-  period_ended_start_date: nil, # Date | Limit search to filings with a period end date on or after this date
-  period_ended_end_date: nil, # Date | Limit search to filings with a period end date on or before this 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
+opts = {
+  company: "AAPL",
+  report_type: "10-Q",
+  filing_start_date: nil,
+  filing_end_date: nil,
+  period_ended_start_date: nil,
+  period_ended_end_date: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = filing_api.get_all_notes(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_all_notes: #{e}"
-end
+result = filing_api.get_all_notes(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -257,19 +250,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
+id = "fil_7Kn2P6"
 
-id = "fil_7Kn2P6" # String | The Intrinio ID of the Filing
-
-
-begin
-  result = filing_api.get_filing_by_id(id)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_filing_by_id: #{e}"
-end
+result = filing_api.get_filing_by_id(id)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -339,28 +327,24 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
-
-identifier = "fil_B73xBG" # String | A Filing identifier
-
-opts = { 
-  statement_code: nil, # String | Filters fundamentals by statement code
-  type: nil, # String | Filters fundamentals by type
-  fiscal_year: nil, # Integer | Filters fundamentals by fiscal year
-  fiscal_period: nil, # String | Filters fundamentals by fiscal period
-  start_date: nil, # Date | Returns fundamentals on or after the given date
-  end_date: nil, # Date | Returns fundamentals on or before the given date
-  next_page: nil # String | Gets the next page of data from a previous API call
+identifier = "fil_B73xBG"
+
+opts = {
+  statement_code: nil,
+  type: nil,
+  fiscal_year: nil,
+  fiscal_period: nil,
+  start_date: nil,
+  end_date: nil,
+  next_page: nil
 }
 
-begin
-  result = filing_api.get_filing_fundamentals(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_filing_fundamentals: #{e}"
-end
+result = filing_api.get_filing_fundamentals(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -436,19 +420,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
+identifier = "fil_B73xBG"
 
-identifier = "fil_B73xBG" # String | A Filing identifier
-
-
-begin
-  result = filing_api.get_filing_html(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_filing_html: #{e}"
-end
+result = filing_api.get_filing_html(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -517,19 +496,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
+identifier = "fil_B73xBG"
 
-identifier = "fil_B73xBG" # String | A Filing identifier
-
-
-begin
-  result = filing_api.get_filing_text(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_filing_text: #{e}"
-end
+result = filing_api.get_filing_text(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -598,22 +572,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
+identifier = "xbn_ydK3QL"
 
-identifier = "xbn_ydK3QL" # String | The Intrinio ID of the filing note
-
-opts = { 
-  content_format: "text" # String | Returns content in html (as filed) or plain text
+opts = {
+  content_format: "text"
 }
 
-begin
-  result = filing_api.get_note(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_note: #{e}"
-end
+result = filing_api.get_note(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -683,19 +653,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
+identifier = "xbn_ydK3QL"
 
-identifier = "xbn_ydK3QL" # String | The Intrinio ID of the filing note
-
-
-begin
-  result = filing_api.get_note_html(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_note_html: #{e}"
-end
+result = filing_api.get_note_html(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -764,19 +729,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
+identifier = "xbn_ydK3QL"
 
-identifier = "xbn_ydK3QL" # String | The Intrinio ID of the filing note
-
-
-begin
-  result = filing_api.get_note_text(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->get_note_text: #{e}"
-end
+result = filing_api.get_note_text(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -846,24 +806,20 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 filing_api = Intrinio::FilingApi.new
+query = "inflation"
 
-query = "inflation" # String | Search for notes that contain all or parts of this text
-
-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 # Integer | The number of results to return
+opts = {
+  filing_start_date: Date.parse("2018-07-15"),
+  filing_end_date: Date.parse("2018-11-30"),
+  page_size: 100
 }
 
-begin
-  result = filing_api.search_notes(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FilingApi->search_notes: #{e}"
-end
+result = filing_api.search_notes(query, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

data/docs/ForexApi.md

@@ -55,16 +55,12 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 forex_api = Intrinio::ForexApi.new
-
-begin
-  result = forex_api.get_forex_currencies
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ForexApi->get_forex_currencies: #{e}"
-end
+result = forex_api.get_forex_currencies
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -131,16 +127,12 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 forex_api = Intrinio::ForexApi.new
-
-begin
-  result = forex_api.get_forex_pairs
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ForexApi->get_forex_pairs: #{e}"
-end
+result = forex_api.get_forex_pairs
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -207,30 +199,25 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 forex_api = Intrinio::ForexApi.new
-
-pair = "EURUSD" # String | The Forex Currency Pair code
-
-timeframe = "D1" # String | The time interval for the quotes
-
-opts = { 
-  timezone: "UTC", # String | Returns trading times in this timezone
-  start_date: nil, # Date | Return Forex Prices on or after this date
-  start_time: nil, # String | Return Forex Prices at or after this time (24-hour)
-  end_date: nil, # Date | Return Forex Prices on or before this date
-  end_time: nil, # String | Return Forex Prices at or before this time (24-hour)
-  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
+pair = "EURUSD"
+timeframe = "D1"
+
+opts = {
+  timezone: "UTC",
+  start_date: Date.parse("2018-01-01"),
+  start_time: nil,
+  end_date: Date.parse("2019-01-01"),
+  end_time: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = forex_api.get_forex_prices(pair, timeframe, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ForexApi->get_forex_prices: #{e}"
-end
+result = forex_api.get_forex_prices(pair, timeframe, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -248,9 +235,9 @@ Name | Type | Description  | Notes
  **timeframe** | String| The time interval for the quotes |   
  **timezone** | String| Returns trading times in this timezone | [optional] [default to UTC]  
  **start_date** | Date| Return Forex Prices on or after this date | [optional]   
- **start_time** | String| Return Forex Prices at or after this time (24-hour) | [optional]   
+ **start_time** | String| Return Forex Prices at or after this time (24-hour in 'hh:mm' format, UTC timezone) | [optional]   
  **end_date** | Date| Return Forex Prices on or before this date | [optional]   
- **end_time** | String| Return Forex Prices at or before this time (24-hour) | [optional]   
+ **end_time** | String| Return Forex Prices at or before this time (24-hour in 'hh:mm' format, UTC timezone) | [optional]   
  **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]   
 

data/docs/FundamentalsApi.md

@@ -56,19 +56,14 @@ 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
+id = "fun_ge9LlE"
 
-id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental
-
-
-begin
-  result = fundamentals_api.get_fundamental_by_id(id)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FundamentalsApi->get_fundamental_by_id: #{e}"
-end
+result = fundamentals_api.get_fundamental_by_id(id)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -138,19 +133,14 @@ 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
+id = "AAPL-income_statement-2018-Q1"
 
-id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
-
-
-begin
-  result = fundamentals_api.get_fundamental_reported_financials(id)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FundamentalsApi->get_fundamental_reported_financials: #{e}"
-end
+result = fundamentals_api.get_fundamental_reported_financials(id)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -220,19 +210,14 @@ 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
+id = "AAPL-income_statement-2018-Q1"
 
-id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
-
-
-begin
-  result = fundamentals_api.get_fundamental_standardized_financials(id)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FundamentalsApi->get_fundamental_standardized_financials: #{e}"
-end
+result = fundamentals_api.get_fundamental_standardized_financials(id)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -302,25 +287,17 @@ 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
+identifier = "AAPL"
+statement_code = "income_statement"
+fiscal_year = 2017
+fiscal_period = "FY"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-statement_code = "income_statement" # String | The statement code
-
-fiscal_year = 2017 # Integer | The fiscal year
-
-fiscal_period = "FY" # String | The fiscal period
-
-
-begin
-  result = fundamentals_api.lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling FundamentalsApi->lookup_fundamental: #{e}"
-end
+result = fundamentals_api.lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)