intrinio-sdk 1.0.0

data/docs/CompanyFiling.md

@@ -0,0 +1,17 @@
+# Intrinio::CompanyFiling
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the Filing | [optional] 
+**filing_date** | **Date** | The date when the filing was submitted to the SEC by the company | [optional] 
+**accepted_date** | **DateTime** | The date and time when the filing was accepted by SEC | [optional] 
+**period_end_date** | **Date** | The ending date of the fiscal period for the filing | [optional] 
+**report_type** | **String** | The filing report type | [optional] 
+**sec_unique_id** | **String** | A unique identifier for the filing provided by the SEC | [optional] 
+**filing_url** | **String** | The URL to the filing page on the SEC site | [optional] 
+**report_url** | **String** | The URL to the actual report on the SEC site | [optional] 
+**instance_url** | **String** | The URL for the XBRL filing for the report | [optional] 
+**company** | [**CompanySummary**](CompanySummary.md) |  | [optional] 
+
+

data/docs/CompanyNews.md

@@ -0,0 +1,13 @@
+# Intrinio::CompanyNews
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the news article | [optional] 
+**title** | **String** | The title of the news article | [optional] 
+**publication_date** | **DateTime** | The publication date of the news article | [optional] 
+**url** | **String** | The url of the news article | [optional] 
+**summary** | **String** | A summary of the news article | [optional] 
+**company** | [**CompanySummary**](CompanySummary.md) | The Company that the Fundamental was belongs to | [optional] 
+
+

data/docs/CompanyNewsSummary.md

@@ -0,0 +1,12 @@
+# Intrinio::CompanyNewsSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the news article | [optional] 
+**title** | **String** | The title of the news article | [optional] 
+**publication_date** | **String** | The publication date of the news article | [optional] 
+**url** | **String** | The url of the news article | [optional] 
+**summary** | **String** | A summary of the news article | [optional] 
+
+

data/docs/CompanySummary.md

@@ -0,0 +1,12 @@
+# Intrinio::CompanySummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the company | [optional] 
+**ticker** | **String** | The stock market ticker symbol associated with the company's common stock securities | [optional] 
+**name** | **String** | The company's common name | [optional] 
+**lei** | **String** | The Legal Entity Identifier (LEI) assigned to the company | [optional] 
+**cik** | **String** | The Central Index Key (CIK) assigned to the company | [optional] 
+
+

data/docs/DataPointApi.md

@@ -0,0 +1,96 @@
+# Intrinio::DataPointApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_data_point_number**](DataPointApi.md#get_data_point_number) | **GET** /data_point/{identifier}/{tag}/number | Get a Data Point (Number)
+[**get_data_point_text**](DataPointApi.md#get_data_point_text) | **GET** /data_point/{identifier}/{tag}/text | Get a Data Point (Text)
+
+
+# **get_data_point_number**
+> Float get_data_point_number(identifier, tag)
+
+Get a Data Point (Number)
+
+Returns a numeric value for the given `tag` and the entity with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+dataPoint_api = Intrinio::DataPointApi.new
+
+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-name
+
+
+begin
+  result = dataPoint_api.get_data_point_number(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling DataPointApi->get_data_point_number: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**Float**
+
+# **get_data_point_text**
+> String get_data_point_text(identifier, tag)
+
+Get a Data Point (Text)
+
+Returns a text value for the given `tag` and the entity with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+dataPoint_api = Intrinio::DataPointApi.new
+
+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-name
+
+
+begin
+  result = dataPoint_api.get_data_point_text(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling DataPointApi->get_data_point_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**String**
+

data/docs/DataTag.md

@@ -0,0 +1,17 @@
+# Intrinio::DataTag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the Data Tag | [optional] 
+**name** | **String** | The readable name of the Data Tag | [optional] 
+**tag** | **String** | The code-name of the Data Tag | [optional] 
+**statement_code** | **String** | The code of the financial statement to which this Data Tag belongs | [optional] 
+**statement_type** | **String** | The format of the financial statment to which this Data Tag belongs | [optional] 
+**parent** | **String** | The parent Data Tag forming the statement relationship with the factor | [optional] 
+**factor** | **String** | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag | [optional] 
+**balance** | **String** | Whether the Data Tag represents a credit or debit | [optional] 
+**type** | **String** | The nature of the Data Tag, operating or nonoperating | [optional] 
+**unit** | **String** | The unit of the Data Tag | [optional] 
+
+

data/docs/DataTagApi.md

@@ -0,0 +1,184 @@
+# Intrinio::DataTagApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**filter_data_tags**](DataTagApi.md#filter_data_tags) | **GET** /data_tags/filter | Filter Data Tags
+[**get_all_data_tags**](DataTagApi.md#get_all_data_tags) | **GET** /data_tags | Get All Data Tags
+[**get_data_tag_by_id**](DataTagApi.md#get_data_tag_by_id) | **GET** /data_tags/{identifier} | Get a Data Tag by ID
+[**search_data_tags**](DataTagApi.md#search_data_tags) | **GET** /data_tags/search | Search Data Tags
+
+
+# **filter_data_tags**
+> ApiResponseDataTags filter_data_tags(opts)
+
+Filter Data Tags
+
+Returns Data Tags that match the given filters
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+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
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = dataTag_api.filter_data_tags(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling DataTagApi->filter_data_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag** | **String**| Tag | [optional] 
+ **type** | **String**| Type | [optional] 
+ **parent** | **String**| ID of tag parent | [optional] 
+ **statement_code** | **String**| Statement Code | [optional] 
+ **fs_template** | **String**| Template | [optional] [default to industrial]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseDataTags**](ApiResponseDataTags.md)
+
+# **get_all_data_tags**
+> ApiResponseDataTags get_all_data_tags(opts)
+
+Get All Data Tags
+
+Returns All Data Tags
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+dataTag_api = Intrinio::DataTagApi.new
+
+opts = { 
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = dataTag_api.get_all_data_tags(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling DataTagApi->get_all_data_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseDataTags**](ApiResponseDataTags.md)
+
+# **get_data_tag_by_id**
+> DataTag get_data_tag_by_id(identifier)
+
+Get a Data Tag by ID
+
+Returns a Data Tag with the specified `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+dataTag_api = Intrinio::DataTagApi.new
+
+identifier = "marketcap" # String | The Intrinio ID or the code-name of the Data Tag
+
+
+begin
+  result = dataTag_api.get_data_tag_by_id(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling DataTagApi->get_data_tag_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| The Intrinio ID or the code-name of the Data Tag | 
+
+### Return type
+
+[**DataTag**](DataTag.md)
+
+# **search_data_tags**
+> ApiResponseDataTags search_data_tags(query)
+
+Search Data Tags
+
+Searches for Data Tags matching the text `query`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+dataTag_api = Intrinio::DataTagApi.new
+
+query = "revenue" # String | 
+
+
+begin
+  result = dataTag_api.search_data_tags(query)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling DataTagApi->search_data_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**|  | 
+
+### Return type
+
+[**ApiResponseDataTags**](ApiResponseDataTags.md)
+

data/docs/DataTagSummary.md

@@ -0,0 +1,11 @@
+# Intrinio::DataTagSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the Data Tag | [optional] 
+**name** | **String** | The readable name of the Data Tag | [optional] 
+**tag** | **String** | The code-name of the Data Tag | [optional] 
+**unit** | **String** | The unit of the Data Tag | [optional] 
+
+

data/docs/EconomicIndex.md

@@ -0,0 +1,19 @@
+# Intrinio::EconomicIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the Index | [optional] 
+**symbol** | **String** | The symbol used to identify the Index | [optional] 
+**name** | **String** | The name of the Index | [optional] 
+**continent** | **String** | The continent of the country of focus for the Index | [optional] 
+**country** | **String** | The country of focus for the Index | [optional] 
+**update_frequency** | **String** | How often the Index is updated | [optional] 
+**last_updated** | **DateTime** | When the Index was updated last | [optional] 
+**description** | **String** | A paragraph describing the index and its scope | [optional] 
+**observation_start** | **Date** | The earliest date for which data is available | [optional] 
+**observation_end** | **Date** | The latest date for which data is available | [optional] 
+**seasonal_adjustment** | **String** | Whether the data is adjusted to account for seasonality | [optional] 
+**units** | **String** | The units of the data | [optional] 
+
+

data/docs/EconomicIndexSummary.md

@@ -0,0 +1,18 @@
+# Intrinio::EconomicIndexSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the Index | [optional] 
+**symbol** | **String** | The symbol used to identify the Index | [optional] 
+**name** | **String** | The name of the Index | [optional] 
+**continent** | **String** | The continent of the country of focus for the Index | [optional] 
+**country** | **String** | The country of focus for the Index | [optional] 
+**update_frequency** | **String** | How often the Index is updated | [optional] 
+**last_updated** | **DateTime** | When the Index was updated last | [optional] 
+**observation_start** | **Date** | The earliest date for which data is available | [optional] 
+**observation_end** | **Date** | The latest date for which data is available | [optional] 
+**seasonal_adjustment** | **String** | Whether the data is adjusted to account for seasonality | [optional] 
+**units** | **String** | The units of the data | [optional] 
+
+

data/docs/Filing.md

@@ -0,0 +1,17 @@
+# Intrinio::Filing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the Filing | [optional] 
+**filing_date** | **Date** | The date when the filing was submitted to the SEC by the company | [optional] 
+**accepted_date** | **DateTime** | The date and time when the filing was accepted by SEC | [optional] 
+**period_end_date** | **Date** | The ending date of the fiscal period for the filing | [optional] 
+**report_type** | **String** | The filing report type | [optional] 
+**sec_unique_id** | **String** | A unique identifier for the filing provided by the SEC | [optional] 
+**filing_url** | **String** | The URL to the filing page on the SEC site | [optional] 
+**report_url** | **String** | The URL to the actual report on the SEC site | [optional] 
+**instance_url** | **String** | The URL for the XBRL filing for the report | [optional] 
+**company** | [**CompanySummary**](CompanySummary.md) |  | [optional] 
+
+

data/docs/FilingApi.md

@@ -0,0 +1,142 @@
+# Intrinio::FilingApi
+
+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_filings**
+> ApiResponseFilings filter_filings(company, opts)
+
+Filter Filings
+
+Returns filings that match the specified filters
+
+### 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
+
+company = "AAPL" # String | Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)
+
+opts = { 
+  report_type: nil, # String | Filter by report type
+  start_date: Date.parse("2015-01-01"), # Date | Filed on or after the given date
+  end_date: Date.parse("2019-01-01"), # Date | Filed before or after the given date
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = filing_api.filter_filings(company, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->filter_filings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **company** | **String**| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) | 
+ **report_type** | **String**| Filter by report type | [optional] 
+ **start_date** | **Date**| Filed on or after the given date | [optional] 
+ **end_date** | **Date**| Filed before or after the given date | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseFilings**](ApiResponseFilings.md)
+
+# **get_all_filings**
+> ApiResponseFilings get_all_filings(opts)
+
+Get All Filings
+
+Returns all filings
+
+### 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_filings(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_all_filings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseFilings**](ApiResponseFilings.md)
+
+# **get_filing_by_id**
+> Filing get_filing_by_id(id)
+
+Get a Filing by ID
+
+Return the filing with the given 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
+
+id = "fil_7Kn2P6" # String | The Intrinio ID of the Filing
+
+
+begin
+  result = filing_api.get_filing_by_id(id)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FilingApi->get_filing_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The Intrinio ID of the Filing | 
+
+### Return type
+
+[**Filing**](Filing.md)
+