intrinio-sdk 5.9.0 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb1a59b7bc5d4e4fc4dfd7f1755dcd81a777c2a3a4b4296e4ede4193d982b677
-  data.tar.gz: d1f3aa8ea3bceca9f94b8c4498807831a350ffbfa42245f67fff2bd5a7ab7855
+  metadata.gz: 61e78d656c3cada31a88763d640b310ea129a015d4f300add34e7fbad1380250
+  data.tar.gz: ea73099b39cdc4deda4940907a73319f88e45d9c34f4af792b41effa0fd3320d
 SHA512:
-  metadata.gz: b634dff267e97c75c94dda12db0e914d4ef5c8ca5e4e99ff78f2989d56aab637b4219beaa47e48ed72a2fc1a2de05ff1ee347e3eeff3c3d5a8ab6095a33229da
-  data.tar.gz: 881ed8ffe286abc99438395c4649cbc5f09576fbd127de9cf068c123ea8a72e9d96a40f3f1621a65aa9cab6ceb5fb91addb5e09a3140de1080db2ad32eab69e1
+  metadata.gz: 0d2b20ca936cc466f82c009ba2b0c05bcb9804969a140e50f13f35824d697a13bf5d558464d4e1da8b9d8418b4bf3b38bcdcb99c368fd686c97fcf96886c5b01
+  data.tar.gz: 52f246e4a465d56ba75219362c2b705315ef226e93b3c9fe22f348a37a7bb842dba1c670758e5c9f760361a291cd230c57558cd53ff9025538816d5605ee6345

data/README.md

@@ -8,8 +8,8 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.19.0
-- Package version: 5.9.0
+- API version: 2.23.0
+- Package version: 5.13.0
 
 
 ## Installation
@@ -76,7 +76,9 @@ Class | Method | HTTP request | Description
 *Intrinio::CompanyApi* | [**insider_transaction_filings_by_company**](docs/CompanyApi.md#insider_transaction_filings_by_company) | **GET** /companies/{identifier}/insider_transaction_filings | Insider Transaction Filings by Company
 *Intrinio::CompanyApi* | [**latest_insider_transaction_filing_by_company**](docs/CompanyApi.md#latest_insider_transaction_filing_by_company) | **GET** /companies/{identifier}/insider_transaction_filings/latest | Latest Insider Transaction Filing by Company
 *Intrinio::CompanyApi* | [**lookup_company_fundamental**](docs/CompanyApi.md#lookup_company_fundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental by Company
+*Intrinio::CompanyApi* | [**recognize_company**](docs/CompanyApi.md#recognize_company) | **GET** /companies/recognize | Recognize Company
 *Intrinio::CompanyApi* | [**search_companies**](docs/CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
+*Intrinio::CompanyApi* | [**shares_outstanding_by_company**](docs/CompanyApi.md#shares_outstanding_by_company) | **GET** /companies/{identifier}/shares_outstanding | Shares Outstanding by Company
 *Intrinio::DataPointApi* | [**get_data_point_number**](docs/DataPointApi.md#get_data_point_number) | **GET** /data_point/{identifier}/{tag}/number | Data Point (Number)
 *Intrinio::DataPointApi* | [**get_data_point_text**](docs/DataPointApi.md#get_data_point_text) | **GET** /data_point/{identifier}/{tag}/text | Data Point (Text)
 *Intrinio::DataTagApi* | [**get_all_data_tags**](docs/DataTagApi.md#get_all_data_tags) | **GET** /data_tags | All Data Tags
@@ -128,11 +130,15 @@ Class | Method | HTTP request | Description
 *Intrinio::MunicipalityApi* | [**get_all_municipalities**](docs/MunicipalityApi.md#get_all_municipalities) | **GET** /municipalities | All Municipalities
 *Intrinio::MunicipalityApi* | [**get_municipality_by_id**](docs/MunicipalityApi.md#get_municipality_by_id) | **GET** /municipalities/{id} | Municipality by ID
 *Intrinio::MunicipalityApi* | [**get_municipality_financials**](docs/MunicipalityApi.md#get_municipality_financials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
+*Intrinio::OptionsApi* | [**get_all_options_tickers**](docs/OptionsApi.md#get_all_options_tickers) | **GET** /options/tickers | Options Tickers
+*Intrinio::OptionsApi* | [**get_option_expirations_realtime**](docs/OptionsApi.md#get_option_expirations_realtime) | **GET** /options/expirations/{symbol}/realtime | Option Expirations Realtime
 *Intrinio::OptionsApi* | [**get_options**](docs/OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
+*Intrinio::OptionsApi* | [**get_options_by_symbol_realtime**](docs/OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
 *Intrinio::OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
 *Intrinio::OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 *Intrinio::OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 *Intrinio::OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
+*Intrinio::OptionsApi* | [**get_options_prices_batch_realtime**](docs/OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
 *Intrinio::OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 *Intrinio::OptionsApi* | [**get_options_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 *Intrinio::OwnersApi* | [**get_all_owners**](docs/OwnersApi.md#get_all_owners) | **GET** /owners | All Owners
@@ -184,7 +190,7 @@ Class | Method | HTTP request | Description
 *Intrinio::SecurityApi* | [**get_security_realtime_price**](docs/SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
 *Intrinio::SecurityApi* | [**get_security_stock_price_adjustments**](docs/SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
 *Intrinio::SecurityApi* | [**get_security_stock_prices**](docs/SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
-*Intrinio::SecurityApi* | [**get_security_zacks_analyst_ratings**](docs/SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings
+*Intrinio::SecurityApi* | [**get_security_zacks_analyst_ratings**](docs/SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security
 *Intrinio::SecurityApi* | [**get_security_zacks_analyst_ratings_snapshot**](docs/SecurityApi.md#get_security_zacks_analyst_ratings_snapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot
 *Intrinio::SecurityApi* | [**get_security_zacks_eps_surprises**](docs/SecurityApi.md#get_security_zacks_eps_surprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security
 *Intrinio::SecurityApi* | [**get_security_zacks_sales_surprises**](docs/SecurityApi.md#get_security_zacks_sales_surprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security
@@ -251,7 +257,9 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseCompanyHistoricalData](docs/ApiResponseCompanyHistoricalData.md)
  - [Intrinio::ApiResponseCompanyInsiderTransactionFilings](docs/ApiResponseCompanyInsiderTransactionFilings.md)
  - [Intrinio::ApiResponseCompanyNews](docs/ApiResponseCompanyNews.md)
+ - [Intrinio::ApiResponseCompanyRecognize](docs/ApiResponseCompanyRecognize.md)
  - [Intrinio::ApiResponseCompanySecurities](docs/ApiResponseCompanySecurities.md)
+ - [Intrinio::ApiResponseCompanySharesOutstanding](docs/ApiResponseCompanySharesOutstanding.md)
  - [Intrinio::ApiResponseDataTags](docs/ApiResponseDataTags.md)
  - [Intrinio::ApiResponseDataTagsSearch](docs/ApiResponseDataTagsSearch.md)
  - [Intrinio::ApiResponseETFHoldings](docs/ApiResponseETFHoldings.md)
@@ -278,7 +286,10 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
  - [Intrinio::ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
  - [Intrinio::ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
+ - [Intrinio::ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
+ - [Intrinio::ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
  - [Intrinio::ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
+ - [Intrinio::ApiResponseOptionsTickers](docs/ApiResponseOptionsTickers.md)
  - [Intrinio::ApiResponseOwnerInsiderTransactionFilings](docs/ApiResponseOwnerInsiderTransactionFilings.md)
  - [Intrinio::ApiResponseOwnerInstitutionalHoldings](docs/ApiResponseOwnerInstitutionalHoldings.md)
  - [Intrinio::ApiResponseOwners](docs/ApiResponseOwners.md)
@@ -363,6 +374,7 @@ Class | Method | HTTP request | Description
  - [Intrinio::CompanyInitialPublicOffering](docs/CompanyInitialPublicOffering.md)
  - [Intrinio::CompanyNews](docs/CompanyNews.md)
  - [Intrinio::CompanyNewsSummary](docs/CompanyNewsSummary.md)
+ - [Intrinio::CompanySharesOutstanding](docs/CompanySharesOutstanding.md)
  - [Intrinio::CompanySummary](docs/CompanySummary.md)
  - [Intrinio::DataTag](docs/DataTag.md)
  - [Intrinio::DataTagSummary](docs/DataTagSummary.md)
@@ -409,8 +421,10 @@ Class | Method | HTTP request | Description
  - [Intrinio::Option](docs/Option.md)
  - [Intrinio::OptionChain](docs/OptionChain.md)
  - [Intrinio::OptionChainRealtime](docs/OptionChainRealtime.md)
+ - [Intrinio::OptionContractsList](docs/OptionContractsList.md)
  - [Intrinio::OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
  - [Intrinio::OptionPrice](docs/OptionPrice.md)
+ - [Intrinio::OptionPriceBatchRealtime](docs/OptionPriceBatchRealtime.md)
  - [Intrinio::OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [Intrinio::OptionRealtime](docs/OptionRealtime.md)
  - [Intrinio::OptionStatsRealtime](docs/OptionStatsRealtime.md)

data/docs/ApiResponseCompanyRecognize.md

@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseCompanyRecognize)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseCompanyRecognize
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**companies** | [**Array<CompanySummary>**](CompanySummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
+
+

data/docs/ApiResponseCompanySharesOutstanding.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseCompanySharesOutstanding)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseCompanySharesOutstanding
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**shares_outstanding** | [**Array<CompanySharesOutstanding>**](CompanySharesOutstanding.md) |   
+**company** | [**CompanySummary**](CompanySummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySharesOutstanding)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
+
+

data/docs/ApiResponseETFHoldings.md

@@ -12,13 +12,16 @@
 
 Name | Type | Description
 ------------ | ------------- | -------------
-**holdings** | Object |   
+**holdings** | [**Array<ETFHolding>**](ETFHolding.md) |   
 **etf** | [**ETFSummary**](ETFSummary.md) |   
 **next_page** | String | The token required to request the next page of the data. If null, no further results are available.  
 
 [//]: # (END_DEFINITION)
 
 
+[//]: # (CONTAINED_CLASS:Intrinio::ETFHolding)
+
+
 [//]: # (CONTAINED_CLASS:Intrinio::ETFSummary)
 
 

data/docs/ApiResponseETFs.md

@@ -12,10 +12,13 @@
 
 Name | Type | Description
 ------------ | ------------- | -------------
-**etfs** | Object |   
+**etfs** | [**Array<ETFSummary>**](ETFSummary.md) |   
 **next_page** | String | The token required to request the next page of the data. If null, no further results are available.  
 
 [//]: # (END_DEFINITION)
 
 
+[//]: # (CONTAINED_CLASS:Intrinio::ETFSummary)
+
+
 

data/docs/ApiResponseOptionsPricesBatchRealtime.md

@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseOptionsPricesBatchRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseOptionsPricesBatchRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**contracts** | [**Array<OptionPriceBatchRealtime>**](OptionPriceBatchRealtime.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionPriceBatchRealtime)
+
+
+

data/docs/ApiResponseOptionsRealtime.md

@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseOptionsRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseOptionsRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**options** | [**Array<OptionRealtime>**](OptionRealtime.md) | A list of options contracts with the given symbol  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionRealtime)
+
+
+

data/docs/ApiResponseOptionsTickers.md

@@ -0,0 +1,20 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseOptionsTickers)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseOptionsTickers
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**tickers** | Array<String> |   
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/CompanyApi.md

@@ -18,7 +18,9 @@ Method | HTTP request | Description
 [**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
+[**recognize_company**](CompanyApi.md#recognize_company) | **GET** /companies/recognize | Recognize Company
 [**search_companies**](CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
+[**shares_outstanding_by_company**](CompanyApi.md#shares_outstanding_by_company) | **GET** /companies/{identifier}/shares_outstanding | Shares Outstanding by Company
 
 
 
@@ -1125,10 +1127,6 @@ 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
 }
 
@@ -1148,10 +1146,6 @@ pp result
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
- **start_date** | Date| Return Company's insider transaction filings on or after this date | [optional]   
- **end_date** | Date| Return Company's insider transaction filings on or before this date | [optional]   
- **ownership_type** | String| The type of ownership to return transaction filings for. 'D' is for direct transactions. 'I' is for indirect transactions. Omit for both types. | [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]   
 
 [//]: # (END_PARAMETERS)
@@ -1246,6 +1240,83 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:recognize_company)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseCompanyRecognize)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyRecognize.md)
+
+[//]: # (OPERATION:recognize_company_v2)
+
+[//]: # (ENDPOINT:/companies/recognize)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#recognize_company)
+
+## **recognize_company**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/recognize_company_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseCompanyRecognize recognize_company(text)
+
+#### Recognize Company
+
+
+Returns a list of companies recognized by the Thea API in the given `text` query string parameter.
+
+[//]: # (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
+text = "Apple"
+
+result = company_api.recognize_company(text)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **text** | String| The text sent to the Thea API to analyze |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseCompanyRecognize**](ApiResponseCompanyRecognize.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::CompanyApi)
@@ -1329,3 +1400,80 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:shares_outstanding_by_company)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseCompanySharesOutstanding)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseCompanySharesOutstanding.md)
+
+[//]: # (OPERATION:shares_outstanding_by_company_v2)
+
+[//]: # (ENDPOINT:/companies/{identifier}/shares_outstanding)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#shares_outstanding_by_company)
+
+## **shares_outstanding_by_company**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/shares_outstanding_by_company_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseCompanySharesOutstanding shares_outstanding_by_company(identifier)
+
+#### Shares Outstanding by Company
+
+
+Returns shares outstanding for the Company with the given `identifier`
+
+[//]: # (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"
+
+result = company_api.shares_outstanding_by_company(identifier)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseCompanySharesOutstanding**](ApiResponseCompanySharesOutstanding.md)
+
+[//]: # (END_OPERATION)
+