intrinio-sdk 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fe9f04fb97097c77560ac7e5d730daf57b776e9
-  data.tar.gz: 2f67e35c2179498d21fe25767a01cc31884d2dcd
+  metadata.gz: 41c95ba978995dd98f7160495279d62971e0c7e9
+  data.tar.gz: d8ff69e3367daf7289b5d8d3c7b47003086c24ae
 SHA512:
-  metadata.gz: 5964f730deef047cbb4476afc06c213c6aa43e51de11f391986770979320ec2a052910c56e6ba64cffb4f71ba39162da7ee6959e2caac266294d290c18f46cfc
-  data.tar.gz: 115530971e191d5ae016ea8fff0651ac1e1f3709bbfb57aab537a675fe1a261aab3993401071523d8ae8420b69e23b15bd06c1e1c04ec3043a5ec35ae70de432
+  metadata.gz: 3a3761c67ff6a576673753fa27a676e34b5e137b5eeb1ca7fe4a4501d8b87b34c36adc1b27cf7a85eb6c8debc245c1c699505fb0d8b7b54dc68330e93e7f3ebd
+  data.tar.gz: 0af7b0bb3dcc7dec561caa10d0fc380dee3c3856dad78abbfc5eb0c796173541d0d92a6a716ea9e766105d705481c19b04992985bc647ee811d6a5286a14377c

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.11.0
-- Package version: 5.4.0
+- API version: 2.13.0
+- Package version: 5.5.0
 
 
 ## Installation
@@ -208,6 +208,10 @@ Class | Method | HTTP request | Description
 *Intrinio::ZacksApi* | [**get_zacks_eps_estimates**](docs/ZacksApi.md#get_zacks_eps_estimates) | **GET** /zacks/eps_estimates | Zacks EPS Estimates
 *Intrinio::ZacksApi* | [**get_zacks_eps_growth_rates**](docs/ZacksApi.md#get_zacks_eps_growth_rates) | **GET** /zacks/eps_growth_rates | Zacks EPS Growth Rates
 *Intrinio::ZacksApi* | [**get_zacks_eps_surprises**](docs/ZacksApi.md#get_zacks_eps_surprises) | **GET** /zacks/eps_surprises | Zacks EPS Surprises
+*Intrinio::ZacksApi* | [**get_zacks_etf_holdings**](docs/ZacksApi.md#get_zacks_etf_holdings) | **GET** /zacks/etf_holdings | Zacks ETF Holdings
+*Intrinio::ZacksApi* | [**get_zacks_institutional_holding_companies**](docs/ZacksApi.md#get_zacks_institutional_holding_companies) | **GET** /zacks/institutional_holdings/companies | Zacks Institutional Holding Companies
+*Intrinio::ZacksApi* | [**get_zacks_institutional_holding_owners**](docs/ZacksApi.md#get_zacks_institutional_holding_owners) | **GET** /zacks/institutional_holdings/owners | Zacks Institutional Holding Owners
+*Intrinio::ZacksApi* | [**get_zacks_institutional_holdings**](docs/ZacksApi.md#get_zacks_institutional_holdings) | **GET** /zacks/institutional_holdings | Zacks Institutional Holdings
 *Intrinio::ZacksApi* | [**get_zacks_long_term_growth_rates**](docs/ZacksApi.md#get_zacks_long_term_growth_rates) | **GET** /zacks/long_term_growth_rates | Zacks Long Term Growth Rates
 *Intrinio::ZacksApi* | [**get_zacks_sales_surprises**](docs/ZacksApi.md#get_zacks_sales_surprises) | **GET** /zacks/sales_surprises | Zacks Sales Surprises
 *Intrinio::ZacksApi* | [**get_zacks_target_price_consensuses**](docs/ZacksApi.md#get_zacks_target_price_consensuses) | **GET** /zacks/target_price_consensuses | Zacks Target Price Consensuses
@@ -303,6 +307,10 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseZacksEPSEstimates](docs/ApiResponseZacksEPSEstimates.md)
  - [Intrinio::ApiResponseZacksEPSGrowthRates](docs/ApiResponseZacksEPSGrowthRates.md)
  - [Intrinio::ApiResponseZacksEPSSurprises](docs/ApiResponseZacksEPSSurprises.md)
+ - [Intrinio::ApiResponseZacksETFHoldings](docs/ApiResponseZacksETFHoldings.md)
+ - [Intrinio::ApiResponseZacksInstitutionalHoldingCompanies](docs/ApiResponseZacksInstitutionalHoldingCompanies.md)
+ - [Intrinio::ApiResponseZacksInstitutionalHoldingOwners](docs/ApiResponseZacksInstitutionalHoldingOwners.md)
+ - [Intrinio::ApiResponseZacksInstitutionalHoldings](docs/ApiResponseZacksInstitutionalHoldings.md)
  - [Intrinio::ApiResponseZacksLongTermGrowthRates](docs/ApiResponseZacksLongTermGrowthRates.md)
  - [Intrinio::ApiResponseZacksSalesSurprises](docs/ApiResponseZacksSalesSurprises.md)
  - [Intrinio::ApiResponseZacksTargetPriceConsensuses](docs/ApiResponseZacksTargetPriceConsensuses.md)
@@ -395,6 +403,13 @@ Class | Method | HTTP request | Description
  - [Intrinio::ZacksEPSGrowthRate](docs/ZacksEPSGrowthRate.md)
  - [Intrinio::ZacksEPSSurprise](docs/ZacksEPSSurprise.md)
  - [Intrinio::ZacksEPSSurpriseSummary](docs/ZacksEPSSurpriseSummary.md)
+ - [Intrinio::ZacksETFHolding](docs/ZacksETFHolding.md)
+ - [Intrinio::ZacksInstitutionalHolding](docs/ZacksInstitutionalHolding.md)
+ - [Intrinio::ZacksInstitutionalHoldingCompanyDetail](docs/ZacksInstitutionalHoldingCompanyDetail.md)
+ - [Intrinio::ZacksInstitutionalHoldingCompanySummary](docs/ZacksInstitutionalHoldingCompanySummary.md)
+ - [Intrinio::ZacksInstitutionalHoldingHistoricalSummary](docs/ZacksInstitutionalHoldingHistoricalSummary.md)
+ - [Intrinio::ZacksInstitutionalHoldingOwnerDetail](docs/ZacksInstitutionalHoldingOwnerDetail.md)
+ - [Intrinio::ZacksInstitutionalHoldingOwnerSummary](docs/ZacksInstitutionalHoldingOwnerSummary.md)
  - [Intrinio::ZacksLongTermGrowthRate](docs/ZacksLongTermGrowthRate.md)
  - [Intrinio::ZacksSalesSurprise](docs/ZacksSalesSurprise.md)
  - [Intrinio::ZacksSalesSurpriseSummary](docs/ZacksSalesSurpriseSummary.md)

data/docs/ApiResponseZacksETFHoldings.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseZacksETFHoldings)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseZacksETFHoldings
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**holdings** | [**Array<ZacksETFHolding>**](ZacksETFHolding.md) | Zacks ETF holding data  
+**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::ZacksETFHolding)
+
+
+

data/docs/ApiResponseZacksInstitutionalHoldingCompanies.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseZacksInstitutionalHoldingCompanies)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseZacksInstitutionalHoldingCompanies
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**companies** | [**Array<ZacksInstitutionalHoldingCompanyDetail>**](ZacksInstitutionalHoldingCompanyDetail.md) | Zacks institutional holding company data  
+**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::ZacksInstitutionalHoldingCompanyDetail)
+
+
+

data/docs/ApiResponseZacksInstitutionalHoldingOwners.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseZacksInstitutionalHoldingOwners)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseZacksInstitutionalHoldingOwners
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**owners** | [**Array<ZacksInstitutionalHoldingOwnerDetail>**](ZacksInstitutionalHoldingOwnerDetail.md) | Zacks institutional holding owners data  
+**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::ZacksInstitutionalHoldingOwnerDetail)
+
+
+

data/docs/ApiResponseZacksInstitutionalHoldings.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseZacksInstitutionalHoldings)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseZacksInstitutionalHoldings
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**holdings** | [**Array<ZacksInstitutionalHolding>**](ZacksInstitutionalHolding.md) | Zacks institutional holding data  
+**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::ZacksInstitutionalHolding)
+
+
+

data/docs/ZacksApi.md

@@ -8,6 +8,10 @@ Method | HTTP request | Description
 [**get_zacks_eps_estimates**](ZacksApi.md#get_zacks_eps_estimates) | **GET** /zacks/eps_estimates | Zacks EPS Estimates
 [**get_zacks_eps_growth_rates**](ZacksApi.md#get_zacks_eps_growth_rates) | **GET** /zacks/eps_growth_rates | Zacks EPS Growth Rates
 [**get_zacks_eps_surprises**](ZacksApi.md#get_zacks_eps_surprises) | **GET** /zacks/eps_surprises | Zacks EPS Surprises
+[**get_zacks_etf_holdings**](ZacksApi.md#get_zacks_etf_holdings) | **GET** /zacks/etf_holdings | Zacks ETF Holdings
+[**get_zacks_institutional_holding_companies**](ZacksApi.md#get_zacks_institutional_holding_companies) | **GET** /zacks/institutional_holdings/companies | Zacks Institutional Holding Companies
+[**get_zacks_institutional_holding_owners**](ZacksApi.md#get_zacks_institutional_holding_owners) | **GET** /zacks/institutional_holdings/owners | Zacks Institutional Holding Owners
+[**get_zacks_institutional_holdings**](ZacksApi.md#get_zacks_institutional_holdings) | **GET** /zacks/institutional_holdings | Zacks Institutional Holdings
 [**get_zacks_long_term_growth_rates**](ZacksApi.md#get_zacks_long_term_growth_rates) | **GET** /zacks/long_term_growth_rates | Zacks Long Term Growth Rates
 [**get_zacks_sales_surprises**](ZacksApi.md#get_zacks_sales_surprises) | **GET** /zacks/sales_surprises | Zacks Sales Surprises
 [**get_zacks_target_price_consensuses**](ZacksApi.md#get_zacks_target_price_consensuses) | **GET** /zacks/target_price_consensuses | Zacks Target Price Consensuses
@@ -436,6 +440,362 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ZacksApi)
+
+[//]: # (METHOD:get_zacks_etf_holdings)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseZacksETFHoldings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseZacksETFHoldings.md)
+
+[//]: # (OPERATION:get_zacks_etf_holdings_v2)
+
+[//]: # (ENDPOINT:/zacks/etf_holdings)
+
+[//]: # (DOCUMENT_LINK:ZacksApi.md#get_zacks_etf_holdings)
+
+## **get_zacks_etf_holdings**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_zacks_etf_holdings_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseZacksETFHoldings get_zacks_etf_holdings(opts)
+
+#### Zacks ETF Holdings
+
+
+Returns Zacks ETF holdings data
+
+[//]: # (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'
+end
+
+zacks_api = Intrinio::ZacksApi.new
+
+opts = { 
+  etf_ticker: nil, # String | Return holdings of the ETF with the given ticker
+  holding_symbol: nil, # String | Return holdings where the instrument being held has the given trading symbol
+  weight_greater: nil, # Float | Return on the holdings with a weight greater than
+  weight_less: nil, # Float | Return on the holdings with a weight less than
+  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
+}
+
+begin
+  result = zacks_api.get_zacks_etf_holdings(opts)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ZacksApi->get_zacks_etf_holdings: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **etf_ticker** | String| Return holdings of the ETF with the given ticker | [optional]   
+ **holding_symbol** | String| Return holdings where the instrument being held has the given trading symbol | [optional]   
+ **weight_greater** | Float| Return on the holdings with a weight greater than | [optional]   
+ **weight_less** | Float| Return on the holdings with a weight less than | [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)
+
+### Return type
+
+[**ApiResponseZacksETFHoldings**](ApiResponseZacksETFHoldings.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ZacksApi)
+
+[//]: # (METHOD:get_zacks_institutional_holding_companies)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseZacksInstitutionalHoldingCompanies)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseZacksInstitutionalHoldingCompanies.md)
+
+[//]: # (OPERATION:get_zacks_institutional_holding_companies_v2)
+
+[//]: # (ENDPOINT:/zacks/institutional_holdings/companies)
+
+[//]: # (DOCUMENT_LINK:ZacksApi.md#get_zacks_institutional_holding_companies)
+
+## **get_zacks_institutional_holding_companies**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_zacks_institutional_holding_companies_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseZacksInstitutionalHoldingCompanies get_zacks_institutional_holding_companies(opts)
+
+#### Zacks Institutional Holding Companies
+
+
+Returns Zacks institutional holding companies data
+
+[//]: # (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'
+end
+
+zacks_api = Intrinio::ZacksApi.new
+
+opts = { 
+  ticker: nil, # String | Return companies with the given ticker
+  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
+}
+
+begin
+  result = zacks_api.get_zacks_institutional_holding_companies(opts)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ZacksApi->get_zacks_institutional_holding_companies: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ticker** | String| Return companies with the given ticker | [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)
+
+### Return type
+
+[**ApiResponseZacksInstitutionalHoldingCompanies**](ApiResponseZacksInstitutionalHoldingCompanies.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ZacksApi)
+
+[//]: # (METHOD:get_zacks_institutional_holding_owners)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseZacksInstitutionalHoldingOwners)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseZacksInstitutionalHoldingOwners.md)
+
+[//]: # (OPERATION:get_zacks_institutional_holding_owners_v2)
+
+[//]: # (ENDPOINT:/zacks/institutional_holdings/owners)
+
+[//]: # (DOCUMENT_LINK:ZacksApi.md#get_zacks_institutional_holding_owners)
+
+## **get_zacks_institutional_holding_owners**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_zacks_institutional_holding_owners_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseZacksInstitutionalHoldingOwners get_zacks_institutional_holding_owners(opts)
+
+#### Zacks Institutional Holding Owners
+
+
+Returns Zacks institutional holding owners data
+
+[//]: # (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'
+end
+
+zacks_api = Intrinio::ZacksApi.new
+
+opts = { 
+  cik: nil, # String | Return owners with the given Central Index Key (CIK)
+  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
+}
+
+begin
+  result = zacks_api.get_zacks_institutional_holding_owners(opts)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ZacksApi->get_zacks_institutional_holding_owners: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cik** | String| Return owners with the given Central Index Key (CIK) | [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)
+
+### Return type
+
+[**ApiResponseZacksInstitutionalHoldingOwners**](ApiResponseZacksInstitutionalHoldingOwners.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ZacksApi)
+
+[//]: # (METHOD:get_zacks_institutional_holdings)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseZacksInstitutionalHoldings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseZacksInstitutionalHoldings.md)
+
+[//]: # (OPERATION:get_zacks_institutional_holdings_v2)
+
+[//]: # (ENDPOINT:/zacks/institutional_holdings)
+
+[//]: # (DOCUMENT_LINK:ZacksApi.md#get_zacks_institutional_holdings)
+
+## **get_zacks_institutional_holdings**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_zacks_institutional_holdings_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseZacksInstitutionalHoldings get_zacks_institutional_holdings(opts)
+
+#### Zacks Institutional Holdings
+
+
+Returns Zacks institutional holdings data
+
+[//]: # (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'
+end
+
+zacks_api = Intrinio::ZacksApi.new
+
+opts = { 
+  ticker: nil, # String | Return holdings where the company being held has the given ticker
+  owner_cik: nil, # String | Return holdings where the owner/holder has the given Central Index Key (CIK)
+  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
+}
+
+begin
+  result = zacks_api.get_zacks_institutional_holdings(opts)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ZacksApi->get_zacks_institutional_holdings: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ticker** | String| Return holdings where the company being held has the given ticker | [optional]   
+ **owner_cik** | String| Return holdings where the owner/holder has the given Central Index Key (CIK) | [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)
+
+### Return type
+
+[**ApiResponseZacksInstitutionalHoldings**](ApiResponseZacksInstitutionalHoldings.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::ZacksApi)