intrinio-sdk 5.6.1 → 5.9.0

data/docs/BulkDownloadsApi.md

@@ -53,16 +53,12 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 bulkDownloads_api = Intrinio::BulkDownloadsApi.new
-
-begin
-  result = bulkDownloads_api.get_bulk_download_links
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling BulkDownloadsApi->get_bulk_download_links: #{e}"
-end
+result = bulkDownloads_api.get_bulk_download_links
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

data/docs/CompanyApi.md

@@ -15,6 +15,8 @@ Method | HTTP request | Description
 [**get_company_ipos**](CompanyApi.md#get_company_ipos) | **GET** /companies/ipos | IPOs
 [**get_company_news**](CompanyApi.md#get_company_news) | **GET** /companies/{identifier}/news | All News by Company
 [**get_company_securities**](CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | All Securities by Company
+[**insider_transaction_filings_by_company**](CompanyApi.md#insider_transaction_filings_by_company) | **GET** /companies/{identifier}/insider_transaction_filings | Insider Transaction Filings by Company
+[**latest_insider_transaction_filing_by_company**](CompanyApi.md#latest_insider_transaction_filing_by_company) | **GET** /companies/{identifier}/insider_transaction_filings/latest | Latest Insider Transaction Filing by Company
 [**lookup_company_fundamental**](CompanyApi.md#lookup_company_fundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental by Company
 [**search_companies**](CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
 
@@ -65,29 +67,26 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
 
-opts = { 
-  latest_filing_date: nil, # Date | Return companies whose latest 10-Q or 10-K was filed on or after this date
-  sic: nil, # String | Return companies with the given Standard Industrial Classification code
-  template: nil, # String | Return companies with the given financial statement template
-  sector: nil, # String | Return companies in the given industry sector
-  industry_category: nil, # String | Return companies in the given industry category
-  industry_group: nil, # String | Return companies in the given industry group
-  has_fundamentals: true, # BOOLEAN | Return only companies that have fundamentals when true
-  has_stock_prices: true, # BOOLEAN | Return only companies that have stock prices when true
-  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 = {
+  latest_filing_date: nil,
+  sic: nil,
+  template: nil,
+  sector: nil,
+  industry_category: nil,
+  industry_group: nil,
+  has_fundamentals: true,
+  has_stock_prices: true,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_all_companies(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_all_companies: #{e}"
-end
+result = company_api.get_all_companies(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -166,21 +165,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
 
-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 = company_api.get_all_company_news(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_all_company_news: #{e}"
-end
+result = company_api.get_all_company_news(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -251,19 +247,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-
-begin
-  result = company_api.get_company(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company: #{e}"
-end
+result = company_api.get_company(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -333,21 +324,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+tag = "marketcap"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, 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 = company_api.get_company_data_point_number(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_data_point_number: #{e}"
-end
+result = company_api.get_company_data_point_number(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -418,21 +403,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+tag = "ceo"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, 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 = company_api.get_company_data_point_text(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_data_point_text: #{e}"
-end
+result = company_api.get_company_data_point_text(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -503,26 +482,22 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
-
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-opts = { 
-  report_type: nil, # String | Filter by <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>. Separate values with commas to return multiple report types.
-  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
-  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
+identifier = "AAPL"
+
+opts = {
+  report_type: nil,
+  start_date: Date.parse("2015-01-01"),
+  end_date: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_filings(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_filings: #{e}"
-end
+result = company_api.get_company_filings(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -597,31 +572,27 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
-
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-opts = { 
-  filed_after: nil, # Date | Filed on or after this date
-  filed_before: nil, # Date | Filed on or before this date
-  reported_only: false, # BOOLEAN | Only as-reported fundamentals
-  fiscal_year: nil, # Integer | Only for the given fiscal year
-  statement_code: nil, # String | Only of the given statement code
-  type: nil, # String | Only of the given type
-  start_date: nil, # Date | Only on or after the given date
-  end_date: nil, # Date | Only on or before the given 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
+identifier = "AAPL"
+
+opts = {
+  filed_after: nil,
+  filed_before: nil,
+  reported_only: false,
+  fiscal_year: nil,
+  statement_code: nil,
+  type: nil,
+  start_date: nil,
+  end_date: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_fundamentals(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_fundamentals: #{e}"
-end
+result = company_api.get_company_fundamentals(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -701,30 +672,25 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
-
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-
-opts = { 
-  frequency: "daily", # String | Return historical data in the given frequency
-  type: nil, # String | Return historical data for given fiscal period type
-  start_date: Date.parse("2018-01-01"), # Date | Return historical data on or after this date
-  end_date: nil, # Date | Return historical data on or before this date
-  sort_order: "desc", # String | Sort by date `asc` or `desc`
-  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
+identifier = "AAPL"
+tag = "marketcap"
+
+opts = {
+  frequency: "daily",
+  type: nil,
+  start_date: Date.parse("2018-01-01"),
+  end_date: nil,
+  sort_order: "desc",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_historical_data(identifier, tag, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_historical_data: #{e}"
-end
+result = company_api.get_company_historical_data(identifier, tag, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -802,27 +768,24 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
 
-opts = { 
-  ticker: nil, # String | Return IPOs with the given ticker (typically the IPO for the company)
-  status: nil, # String | Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
-  start_date: nil, # Date | Return IPOs on or after the given date
-  end_date: nil, # Date | Return IPOs on or before the given date
-  offer_amount_greater_than: nil, # Integer | Return IPOs with an offer dollar amount greater than the given amount
-  offer_amount_less_than: nil, # Integer | Return IPOs with an offer dollar amount less than the given amount
-  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 = {
+  ticker: "UBER",
+  status: nil,
+  start_date: nil,
+  end_date: nil,
+  offer_amount_greater_than: nil,
+  offer_amount_less_than: nil,
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_ipos(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_ipos: #{e}"
-end
+result = company_api.get_company_ipos(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -899,23 +862,19 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, 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 = company_api.get_company_news(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_news: #{e}"
-end
+result = company_api.get_company_news(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -987,22 +946,194 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+
+opts = {
+  next_page: nil
+}
+
+result = company_api.get_company_securities(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
 
-opts = { 
-  next_page: nil # String | Gets the next page of data from a previous API call
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseCompanySecurities**](ApiResponseCompanySecurities.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:insider_transaction_filings_by_company)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseInsiderTransactionFilings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseInsiderTransactionFilings.md)
+
+[//]: # (OPERATION:insider_transaction_filings_by_company_v2)
+
+[//]: # (ENDPOINT:/companies/{identifier}/insider_transaction_filings)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#insider_transaction_filings_by_company)
+
+## **insider_transaction_filings_by_company**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/insider_transaction_filings_by_company_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseInsiderTransactionFilings insider_transaction_filings_by_company(identifier, opts)
+
+#### Insider Transaction Filings by Company
+
+
+Returns a list of all insider transaction filings in a company. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.
+
+[//]: # (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
+
+company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+
+opts = {
+  start_date: Date.parse("2018-01-01"),
+  end_date: Date.parse("2019-01-01"),
+  ownership_type: "D",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = company_api.get_company_securities(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->get_company_securities: #{e}"
+result = company_api.insider_transaction_filings_by_company(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  &nbsp;
+ **start_date** | Date| Return Company&#39;s insider transaction filings on or after this date | [optional]  &nbsp;
+ **end_date** | Date| Return Company&#39;s insider transaction filings on or before this date | [optional]  &nbsp;
+ **ownership_type** | String| The type of ownership to return transaction filings for. &#39;D&#39; is for direct transactions. &#39;I&#39; is for indirect transactions. Omit for both types. | [optional]  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseInsiderTransactionFilings**](ApiResponseInsiderTransactionFilings.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:latest_insider_transaction_filing_by_company)
+
+[//]: # (RETURN_TYPE:Intrinio::InsiderTransactionFiling)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:InsiderTransactionFiling.md)
+
+[//]: # (OPERATION:latest_insider_transaction_filing_by_company_v2)
+
+[//]: # (ENDPOINT:/companies/{identifier}/insider_transaction_filings/latest)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#latest_insider_transaction_filing_by_company)
+
+## **latest_insider_transaction_filing_by_company**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/latest_insider_transaction_filing_by_company_v2)
+
+[//]: # (START_OVERVIEW)
+
+> InsiderTransactionFiling latest_insider_transaction_filing_by_company(identifier, opts)
+
+#### Latest Insider Transaction Filing by Company
+
+
+Returns the latest insider transaction filing for a company.
+
+[//]: # (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
+
+company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+
+opts = {
+  start_date: Date.parse("2018-01-01"),
+  end_date: Date.parse("2019-01-01"),
+  ownership_type: "D",
+  page_size: 100,
+  next_page: nil
+}
+
+result = company_api.latest_insider_transaction_filing_by_company(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1017,13 +1148,17 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  &nbsp;
+ **start_date** | Date| Return Company&#39;s insider transaction filings on or after this date | [optional]  &nbsp;
+ **end_date** | Date| Return Company&#39;s insider transaction filings on or before this date | [optional]  &nbsp;
+ **ownership_type** | String| The type of ownership to return transaction filings for. &#39;D&#39; is for direct transactions. &#39;I&#39; is for indirect transactions. Omit for both types. | [optional]  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
  **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
 
 [//]: # (END_PARAMETERS)
 
 ### Return type
 
-[**ApiResponseCompanySecurities**](ApiResponseCompanySecurities.md)
+[**InsiderTransactionFiling**](InsiderTransactionFiling.md)
 
 [//]: # (END_OPERATION)
 
@@ -1073,25 +1208,17 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+statement_code = "income_statement"
+fiscal_period = "FY"
+fiscal_year = 2017
 
-identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-
-statement_code = "income_statement" # String | The statement code
-
-fiscal_period = "FY" # String | The fiscal period
-
-fiscal_year = 2017 # Integer | The fiscal year
-
-
-begin
-  result = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->lookup_company_fundamental: #{e}"
-end
+result = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1164,22 +1291,19 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 company_api = Intrinio::CompanyApi.new
+query = "Apple"
 
-query = "Apple" # String | Search parameters
-
-opts = { 
-  page_size: 100 # Integer | The number of results to return
+opts = {
+  active: true,
+  page_size: 100
 }
 
-begin
-  result = company_api.search_companies(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling CompanyApi->search_companies: #{e}"
-end
+result = company_api.search_companies(query, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1194,6 +1318,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | String| Search parameters |  &nbsp;
+ **active** | BOOLEAN| When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. | [optional]  &nbsp;
  **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
 
 [//]: # (END_PARAMETERS)