intrinio-sdk 1.0.0 → 1.1.0

data/docs/DividendRecord.md

@@ -0,0 +1,17 @@
+# Intrinio::DividendRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ex_dividend** | **Float** | Amount of dividend in US dollars | [optional] 
+**currency** | **String** | The 3-digit currency code the dividend amount was reported in | [optional] 
+**announcement_date** | **Date** | Date dividend was announced | [optional] 
+**record_date** | **Date** | Date before which holders-of-record will receive the dividend | [optional] 
+**pay_date** | **Date** | Date the divdiend was paid | [optional] 
+**frequency** | **String** | Identifies payment frequency of announced dividend | [optional] 
+**status** | **String** | Status of the dividend | [optional] 
+**forward_yield** | **Float** | The forward dividend yield | [optional] 
+**forward_rate** | **Float** | The forward dividend rate | [optional] 
+**security** | [**SecuritySummary**](SecuritySummary.md) |  | [optional] 
+
+

data/docs/EarningsRecord.md

@@ -0,0 +1,30 @@
+# Intrinio::EarningsRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quarter** | **String** | The letter “Q” followed by the quarter number the earnings information applies to | [optional] 
+**time_of_day** | **String** | Indicates the time of the announcement | [optional] 
+**broadcast_url** | **String** | Link for Conference Call recording | [optional] 
+**transcript_url** | **String** | Link to the earnings release transcript | [optional] 
+**transcript_quarter** | **String** | The letter “Q” followed by the quarter number the earnings transcript applies to | [optional] 
+**transcript_fiscal_year** | **String** | Fiscal year in YYYY format for the earnings transcript | [optional] 
+**conference_call_date** | **Date** | Date of the conference call | [optional] 
+**conference_call_time** | **String** | Published time of the conference call | [optional] 
+**conference_call_phone_number** | **String** | Publicly available phone number for replay conference call | [optional] 
+**conference_call_passcode** | **String** | Passcode for replay conference call | [optional] 
+**last_confirmation_date** | **Date** | Date of last earnings date update by a WSH analyst | [optional] 
+**board_of_directors_meeting_date** | **Date** | Date of Board/Shareholder Meeting | [optional] 
+**board_of_directors_meeting_type** | **String** | The type of meeting - \"B\" indicates a Board of Directors meeting and \"S\" indicates a Shareholder meeting | [optional] 
+**company_website** | **String** | Website link for the company | [optional] 
+**q1_date** | **Date** | Earnings Date for 1st quarter | [optional] 
+**q2_date** | **Date** | Earnings Date for 2nd quarter | [optional] 
+**q3_date** | **Date** | Earnings Date for 3rd quarter | [optional] 
+**q4_date** | **Date** | Earnings Date for 4th quarter | [optional] 
+**type** | **String** | The nature of the next reported earnings date - \"V\" indicates a Verified date, \"T\" indicates that the date was gathered from the company, but is still considered Tentative, and \"I\" indicates that the date is forecased or Inferred | [optional] 
+**next_earnings_date** | **Date** | Next earnings date | [optional] 
+**next_earnings_quarter** | **String** | The quarter of the next earnings release | [optional] 
+**next_earnings_fiscal_year** | **Integer** | The fiscal year associated with next earnings date and next earnings quarter | [optional] 
+**security** | [**SecuritySummary**](SecuritySummary.md) |  | [optional] 
+
+

data/docs/FilingApi.md

@@ -5,8 +5,14 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**filter_filings**](FilingApi.md#filter_filings) | **GET** /filings/filter | Filter Filings
-[**get_all_filings**](FilingApi.md#get_all_filings) | **GET** /filings | Get All Filings
-[**get_filing_by_id**](FilingApi.md#get_filing_by_id) | **GET** /filings/{id} | Get a Filing by ID
+[**filter_notes**](FilingApi.md#filter_notes) | **GET** /filings/notes/filter | Filter SEC filing notes
+[**get_all_filings**](FilingApi.md#get_all_filings) | **GET** /filings | All Filings
+[**get_all_notes**](FilingApi.md#get_all_notes) | **GET** /filings/notes | Get All SEC filing notes
+[**get_filing_by_id**](FilingApi.md#get_filing_by_id) | **GET** /filings/{id} | Lookup Filing
+[**get_note**](FilingApi.md#get_note) | **GET** /filings/notes/{identifier} | Get an SEC filing note by ID
+[**get_note_html**](FilingApi.md#get_note_html) | **GET** /filings/notes/{identifier}/html | Returns the content of an SEC filing note as originally filed
+[**get_note_text**](FilingApi.md#get_note_text) | **GET** /filings/notes/{identifier}/text | Returns the content of an SEC filing note stripped of HTML
+[**search_notes**](FilingApi.md#search_notes) | **GET** /filings/notes/search | Search Filing Notes
 
 
 # **filter_filings**
@@ -14,7 +20,7 @@ Method | HTTP request | Description
 
 Filter Filings
 
-Returns filings that match the specified filters
+Returns Filings that match the specified filters
 
 ### Example
 ```ruby
@@ -59,12 +65,65 @@ Name | Type | Description  | Notes
 
 [**ApiResponseFilings**](ApiResponseFilings.md)
 
+# **filter_notes**
+> ApiResponseFilingNotes filter_notes(opts)
+
+Filter SEC filing notes
+
+Returns SEC filing notes matching the supplied criteria
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+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 report type
+  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-15"), # Date | Limit search to filings on or before this date
+  period_ended_start_date: Date.parse("2018-07-15"), # Date | Limit search to filings with a period end date on or after this date
+  period_ended_end_date: Date.parse("2018-11-15"), # Date | Limit search to filings with a period end date on or before this date
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = filing_api.filter_notes(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->filter_notes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **company** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | [optional] 
+ **report_type** | **String**| Notes contained in filings that match the given report type | [optional] 
+ **filing_start_date** | **Date**| Limit search to filings on or after this date | [optional] 
+ **filing_end_date** | **Date**| Limit search to filings on or before this date | [optional] 
+ **period_ended_start_date** | **Date**| Limit search to filings with a period end date on or after this date | [optional] 
+ **period_ended_end_date** | **Date**| Limit search to filings with a period end date on or before this date | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseFilingNotes**](ApiResponseFilingNotes.md)
+
 # **get_all_filings**
 > ApiResponseFilings get_all_filings(opts)
 
-Get All Filings
+All Filings
 
-Returns all filings
+Returns all Filings
 
 ### Example
 ```ruby
@@ -100,12 +159,53 @@ Name | Type | Description  | Notes
 
 [**ApiResponseFilings**](ApiResponseFilings.md)
 
+# **get_all_notes**
+> ApiResponseFilingNotes get_all_notes(opts)
+
+Get All SEC filing notes
+
+Return All notes from SEC Filings, most-recent first
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+filing_api = Intrinio::FilingApi.new
+
+opts = { 
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = filing_api.get_all_notes(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_all_notes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseFilingNotes**](ApiResponseFilingNotes.md)
+
 # **get_filing_by_id**
 > Filing get_filing_by_id(id)
 
-Get a Filing by ID
+Lookup Filing
 
-Return the filing with the given ID
+Returns the Filing with the given `identifier`
 
 ### Example
 ```ruby
@@ -140,3 +240,169 @@ Name | Type | Description  | Notes
 
 [**Filing**](Filing.md)
 
+# **get_note**
+> FilingNote get_note(identifier, opts)
+
+Get an SEC filing note by ID
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+filing_api = Intrinio::FilingApi.new
+
+identifier = "xbn_3fghz" # String | The Intrinio ID of the filing note
+
+opts = { 
+  content_format: "text" # String | Returns content in html (as filed) or plain text
+}
+
+begin
+  result = filing_api.get_note(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_note: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| The Intrinio ID of the filing note | 
+ **content_format** | **String**| Returns content in html (as filed) or plain text | [optional] [default to text]
+
+### Return type
+
+[**FilingNote**](FilingNote.md)
+
+# **get_note_html**
+> String get_note_html(identifier)
+
+Returns the content of an SEC filing note as originally filed
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+filing_api = Intrinio::FilingApi.new
+
+identifier = "xbn_3fghz" # String | The Intrinio ID of the filing note
+
+
+begin
+  result = filing_api.get_note_html(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_note_html: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| The Intrinio ID of the filing note | 
+
+### Return type
+
+**String**
+
+# **get_note_text**
+> String get_note_text(identifier)
+
+Returns the content of an SEC filing note stripped of HTML
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+filing_api = Intrinio::FilingApi.new
+
+identifier = "xbn_3fghz" # String | The Intrinio ID of the filing note
+
+
+begin
+  result = filing_api.get_note_text(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_note_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| The Intrinio ID of the filing note | 
+
+### Return type
+
+**String**
+
+# **search_notes**
+> ApiResponseFilingNotesSearch search_notes(query, opts)
+
+Search Filing Notes
+
+Searches SEC filing notes using the text in `query`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+filing_api = Intrinio::FilingApi.new
+
+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 # Float | The number of results to return
+}
+
+begin
+  result = filing_api.search_notes(query, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->search_notes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**| Search for notes that contain all or parts of this text | 
+ **filing_start_date** | **Date**| Limit search to filings on or after this date | [optional] 
+ **filing_end_date** | **Date**| Limit search to filings on or before this date | [optional] 
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
+
+### Return type
+
+[**ApiResponseFilingNotesSearch**](ApiResponseFilingNotesSearch.md)
+

data/docs/FilingNote.md

@@ -0,0 +1,11 @@
+# Intrinio::FilingNote
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the note | [optional] 
+**xbrl_tag** | **String** | The XBRL Tag used for the note | [optional] 
+**content** | **String** | The plain text (after html has been removed) of the note, or text including html if the content_format parameter has been set to html | [optional] 
+**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |  | [optional] 
+
+

data/docs/FilingNoteFiling.md

@@ -0,0 +1,11 @@
+# Intrinio::FilingNoteFiling
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cik** | **String** | The Central Index Key (CIK) assigned to the company | [optional] 
+**report_type** | **String** | The type of report (10-Q, 10-K, etc) filed | [optional] 
+**period_end_date** | **Date** | The ending date of the fiscal period for the filing | [optional] 
+**filing_date** | **Date** | The date the report was filed with the SEC | [optional] 
+
+

data/docs/FilingNoteSummary.md

@@ -0,0 +1,10 @@
+# Intrinio::FilingNoteSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the note | [optional] 
+**xbrl_tag** | **String** | The XBRL tag used for the note by the filing entity | [optional] 
+**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |  | [optional] 
+
+

data/docs/FundamentalsApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_fundamental_by_id**](FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Get a Fundamental by ID
-[**get_fundamental_reported_financials**](FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Get Reported Financials for a Fundamental
-[**get_fundamental_standardized_financials**](FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Get Standardized Financials for a Fundamental
-[**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup a Fundamental
+[**get_fundamental_by_id**](FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
+[**get_fundamental_reported_financials**](FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
+[**get_fundamental_standardized_financials**](FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
+[**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
 
 
 # **get_fundamental_by_id**
 > Fundamental get_fundamental_by_id(id)
 
-Get a Fundamental by ID
+Fundamental by ID
 
-Retrieves detailed fundamental data for the given `fundamental_id`.
+Returns detailed fundamental data for the given `id`.
 
 ### Example
 ```ruby
@@ -53,7 +53,7 @@ Name | Type | Description  | Notes
 # **get_fundamental_reported_financials**
 > ApiResponseReportedFinancials get_fundamental_reported_financials(id)
 
-Get Reported Financials for a Fundamental
+Reported Financials
 
 Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
 
@@ -93,7 +93,7 @@ Name | Type | Description  | Notes
 # **get_fundamental_standardized_financials**
 > ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)
 
-Get Standardized Financials for a Fundamental
+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.
 
@@ -133,7 +133,7 @@ Name | Type | Description  | Notes
 # **lookup_fundamental**
 > Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
 
-Lookup a Fundamental
+Lookup Fundamental
 
 Returns the Fundamental for the Company with the given `identifier` and with the given parameters