intrinio-sdk 5.6.1 → 5.6.3

data/docs/DataPointApi.md

@@ -54,21 +54,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 dataPoint_api = Intrinio::DataPointApi.new
+identifier = "AAPL"
+tag = "marketcap"
 
-identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
-
-tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-
-
-begin
-  result = dataPoint_api.get_data_point_number(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataPointApi->get_data_point_number: #{e}"
-end
+result = dataPoint_api.get_data_point_number(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -139,21 +133,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 dataPoint_api = Intrinio::DataPointApi.new
+identifier = "AAPL"
+tag = "ceo"
 
-identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
-
-tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-
-
-begin
-  result = dataPoint_api.get_data_point_text(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataPointApi->get_data_point_text: #{e}"
-end
+result = dataPoint_api.get_data_point_text(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

data/docs/DataTagApi.md

@@ -55,26 +55,23 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 dataTag_api = Intrinio::DataTagApi.new
 
-opts = { 
-  tag: nil, # String | Tag
-  type: nil, # String | Type
-  parent: nil, # String | ID of tag parent
-  statement_code: "income_statement", # String | Statement Code
-  fs_template: "industrial", # String | Template
-  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 = {
+  tag: nil,
+  type: nil,
+  parent: nil,
+  statement_code: "income_statement",
+  fs_template: "industrial",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = dataTag_api.get_all_data_tags(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->get_all_data_tags: #{e}"
-end
+result = dataTag_api.get_all_data_tags(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -150,19 +147,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 dataTag_api = Intrinio::DataTagApi.new
+identifier = "marketcap"
 
-identifier = "marketcap" # String | The Intrinio ID or the code-name of the Data Tag
-
-
-begin
-  result = dataTag_api.get_data_tag_by_id(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->get_data_tag_by_id: #{e}"
-end
+result = dataTag_api.get_data_tag_by_id(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -232,22 +224,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 dataTag_api = Intrinio::DataTagApi.new
+query = "revenue"
 
-query = "revenue" # String | 
-
-opts = { 
-  page_size: 100 # Integer | The number of results to return
+opts = {
+  page_size: 100
 }
 
-begin
-  result = dataTag_api.search_data_tags(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->search_data_tags: #{e}"
-end
+result = dataTag_api.search_data_tags(query, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

data/docs/ETFsApi.md

@@ -58,22 +58,19 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 eTFs_api = Intrinio::ETFsApi.new
 
-opts = { 
-  exchange: "XNAS", # String | 
-  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 = {
+  exchange: "XNAS",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = eTFs_api.get_all_etfs(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ETFsApi->get_all_etfs: #{e}"
-end
+result = eTFs_api.get_all_etfs(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -145,19 +142,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
 
-identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
-
-
-begin
-  result = eTFs_api.get_etf(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ETFsApi->get_etf: #{e}"
-end
+result = eTFs_api.get_etf(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -227,19 +219,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
 
-identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
-
-
-begin
-  result = eTFs_api.get_etf_analytics(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ETFsApi->get_etf_analytics: #{e}"
-end
+result = eTFs_api.get_etf_analytics(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -309,23 +296,19 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
 
-identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
-
-opts = { 
-  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 = {
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = eTFs_api.get_etf_holdings(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ETFsApi->get_etf_holdings: #{e}"
-end
+result = eTFs_api.get_etf_holdings(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -397,19 +380,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
 
-identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
-
-
-begin
-  result = eTFs_api.get_etf_stats(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ETFsApi->get_etf_stats: #{e}"
-end
+result = eTFs_api.get_etf_stats(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -479,19 +457,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 eTFs_api = Intrinio::ETFsApi.new
+query = "iShares"
 
-query = "iShares" # String | 
-
-
-begin
-  result = eTFs_api.search_etfs(query)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling ETFsApi->search_etfs: #{e}"
-end
+result = eTFs_api.search_etfs(query)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

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)