RubyGems - intrinio-sdk - Versions diffs - 5.20.0 → 6.21.1 - Mend

intrinio-sdk 5.20.0 → 6.21.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (596) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d65fd6620b2a2603a627dd1d2234783100c8151974707491a29e08a989c16e73
-  data.tar.gz: b92aa2cdb20c53b73aa3e072e33ec425853eb58fe394019a9be3238c719a6649
+  metadata.gz: 695e7aa6cba57686538e48ae671eba052034176513c4b24e9b9778d5ad5b25ff
+  data.tar.gz: 3564801843fcacc8f623ead05a2b16135dc223adc6888347ff0cda2377b75c25
 SHA512:
-  metadata.gz: 14d639901a856c8add661d7f201c74abef2cbffd27592457f29d57716922ed24cdabd7f92b3a15fc364e1fb80a9b48d2a8889e20bb618e61d66938e161e66366
-  data.tar.gz: 54d2c377430eb2e9f65f8a13072589e246145338f94671fbe4d86c1d72ad66307726f6d29eade96f82d4ad30eba8ac5284c4548156e25e74f74347765125d0be
+  metadata.gz: 226a43fd31077069ad3643a98fb2fbd4e9382c71979912826c12c95df4d7f2e6b36f07ecacb2d4cddeaa3b2ae11b1ab2be3ac7b67c2d5a937b95839c9f8dfe8e
+  data.tar.gz: 24ecc9dbe1e439bb962f1c05e0ca22c6704bf6b81934ff86f96f3177058affcfb63cdab050177d158d00186045f095c936da2cdaa506e8a4e3059226e274489d

data/README.md CHANGED Viewed

@@ -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.27.5
-- Package version: 5.20.0
+- API version: 2.29.0
+- Package version: 6.21.1
 ## Installation
@@ -85,6 +85,11 @@ Class | Method | HTTP request | Description
 *Intrinio::DataTagApi* | [**get_all_data_tags**](docs/DataTagApi.md#get_all_data_tags) | **GET** /data_tags | All Data Tags
 *Intrinio::DataTagApi* | [**get_data_tag_by_id**](docs/DataTagApi.md#get_data_tag_by_id) | **GET** /data_tags/{identifier} | Lookup Data Tag
 *Intrinio::DataTagApi* | [**search_data_tags**](docs/DataTagApi.md#search_data_tags) | **GET** /data_tags/search | Search Data Tags
+*Intrinio::ESGApi* | [**get_esg_companies**](docs/ESGApi.md#get_esg_companies) | **GET** /esg/companies | ESG Companies
+*Intrinio::ESGApi* | [**get_esg_company_comprehensive_ratings**](docs/ESGApi.md#get_esg_company_comprehensive_ratings) | **GET** /esg/{identifier}/comprehensive | ESG Company Comprehensive Ratings History
+*Intrinio::ESGApi* | [**get_esg_company_ratings**](docs/ESGApi.md#get_esg_company_ratings) | **GET** /esg/{identifier} | ESG Company Ratings History
+*Intrinio::ESGApi* | [**get_esg_latest**](docs/ESGApi.md#get_esg_latest) | **GET** /esg | ESG Latest
+*Intrinio::ESGApi* | [**get_esg_latest_comprehensive**](docs/ESGApi.md#get_esg_latest_comprehensive) | **GET** /esg/comprehensive | ESG Latest Comprehensive
 *Intrinio::ETFsApi* | [**get_all_etfs**](docs/ETFsApi.md#get_all_etfs) | **GET** /etfs | All ETFs
 *Intrinio::ETFsApi* | [**get_etf**](docs/ETFsApi.md#get_etf) | **GET** /etfs/{identifier} | Lookup ETF
 *Intrinio::ETFsApi* | [**get_etf_analytics**](docs/ETFsApi.md#get_etf_analytics) | **GET** /etfs/{identifier}/analytics | ETF Analytics
@@ -105,6 +110,7 @@ Class | Method | HTTP request | Description
 *Intrinio::ForexApi* | [**get_forex_currencies**](docs/ForexApi.md#get_forex_currencies) | **GET** /forex/currencies | Forex Currencies
 *Intrinio::ForexApi* | [**get_forex_pairs**](docs/ForexApi.md#get_forex_pairs) | **GET** /forex/pairs | Forex Currency Pairs
 *Intrinio::ForexApi* | [**get_forex_prices**](docs/ForexApi.md#get_forex_prices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices
+*Intrinio::FundamentalsApi* | [**filter_fundamental**](docs/FundamentalsApi.md#filter_fundamental) | **GET** /fundamentals | Filter Fundamental
 *Intrinio::FundamentalsApi* | [**get_fundamental_by_id**](docs/FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
 *Intrinio::FundamentalsApi* | [**get_fundamental_reported_financials**](docs/FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
 *Intrinio::FundamentalsApi* | [**get_fundamental_standardized_financials**](docs/FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
@@ -146,6 +152,7 @@ Class | Method | HTTP request | Description
 *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_eod**](docs/OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
 *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_snapshots**](docs/OptionsApi.md#get_options_snapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
 *Intrinio::OptionsApi* | [**get_options_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 *Intrinio::OptionsApi* | [**get_unusual_activity**](docs/OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
 *Intrinio::OptionsApi* | [**get_unusual_activity_intraday**](docs/OptionsApi.md#get_unusual_activity_intraday) | **GET** /options/unusual_activity/{symbol}/intraday | Options Unusual Activity Intraday
@@ -198,6 +205,7 @@ Class | Method | HTTP request | Description
 *Intrinio::SecurityApi* | [**get_security_price_technicals_vwap**](docs/SecurityApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
 *Intrinio::SecurityApi* | [**get_security_price_technicals_wr**](docs/SecurityApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
 *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_snapshots**](docs/SecurityApi.md#get_security_snapshots) | **GET** /securities/snapshots | Realtime Stock Prices Snapshot
 *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 for Security
@@ -273,6 +281,11 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseCompanySharesOutstanding](docs/ApiResponseCompanySharesOutstanding.md)
  - [Intrinio::ApiResponseDataTags](docs/ApiResponseDataTags.md)
  - [Intrinio::ApiResponseDataTagsSearch](docs/ApiResponseDataTagsSearch.md)
+ - [Intrinio::ApiResponseESGCompanies](docs/ApiResponseESGCompanies.md)
+ - [Intrinio::ApiResponseESGCompanyComprehensiveRatingHistory](docs/ApiResponseESGCompanyComprehensiveRatingHistory.md)
+ - [Intrinio::ApiResponseESGCompanyRatingHistory](docs/ApiResponseESGCompanyRatingHistory.md)
+ - [Intrinio::ApiResponseESGLatest](docs/ApiResponseESGLatest.md)
+ - [Intrinio::ApiResponseESGLatestComprehensive](docs/ApiResponseESGLatestComprehensive.md)
  - [Intrinio::ApiResponseETFHoldings](docs/ApiResponseETFHoldings.md)
  - [Intrinio::ApiResponseETFs](docs/ApiResponseETFs.md)
  - [Intrinio::ApiResponseEconomicIndexHistoricalData](docs/ApiResponseEconomicIndexHistoricalData.md)
@@ -397,6 +410,11 @@ Class | Method | HTTP request | Description
  - [Intrinio::DetrendedPriceOscillatorTechnicalValue](docs/DetrendedPriceOscillatorTechnicalValue.md)
  - [Intrinio::DividendRecord](docs/DividendRecord.md)
  - [Intrinio::DonchianChannelTechnicalValue](docs/DonchianChannelTechnicalValue.md)
+ - [Intrinio::ESGCompanySummary](docs/ESGCompanySummary.md)
+ - [Intrinio::ESGComprehensiveRating](docs/ESGComprehensiveRating.md)
+ - [Intrinio::ESGComprehensiveRatingWithCompany](docs/ESGComprehensiveRatingWithCompany.md)
+ - [Intrinio::ESGRating](docs/ESGRating.md)
+ - [Intrinio::ESGRatingWithCompany](docs/ESGRatingWithCompany.md)
  - [Intrinio::ETF](docs/ETF.md)
  - [Intrinio::ETFAnalytics](docs/ETFAnalytics.md)
  - [Intrinio::ETFHolding](docs/ETFHolding.md)
@@ -446,6 +464,8 @@ Class | Method | HTTP request | Description
  - [Intrinio::OptionPriceEod](docs/OptionPriceEod.md)
  - [Intrinio::OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [Intrinio::OptionRealtime](docs/OptionRealtime.md)
+ - [Intrinio::OptionSnapshotGroup](docs/OptionSnapshotGroup.md)
+ - [Intrinio::OptionSnapshotsResult](docs/OptionSnapshotsResult.md)
  - [Intrinio::OptionStatsRealtime](docs/OptionStatsRealtime.md)
  - [Intrinio::OptionUnusualTrade](docs/OptionUnusualTrade.md)
  - [Intrinio::Owner](docs/Owner.md)
@@ -462,6 +482,8 @@ Class | Method | HTTP request | Description
  - [Intrinio::SecurityScreenGroup](docs/SecurityScreenGroup.md)
  - [Intrinio::SecurityScreenResult](docs/SecurityScreenResult.md)
  - [Intrinio::SecurityScreenResultData](docs/SecurityScreenResultData.md)
+ - [Intrinio::SecuritySnapshotGroup](docs/SecuritySnapshotGroup.md)
+ - [Intrinio::SecuritySnapshotsResult](docs/SecuritySnapshotsResult.md)
  - [Intrinio::SecuritySummary](docs/SecuritySummary.md)
  - [Intrinio::SimpleMovingAverageTechnicalValue](docs/SimpleMovingAverageTechnicalValue.md)
  - [Intrinio::StandardizedFinancial](docs/StandardizedFinancial.md)

data/docs/ApiResponseESGCompanies.md ADDED Viewed

@@ -0,0 +1,24 @@
+[//]: # (CLASS:Intrinio::ApiResponseESGCompanies)
+[//]: # (KIND:object)
+### Intrinio::ApiResponseESGCompanies
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**companies** | [**Array&lt;ESGCompanySummary&gt;**](ESGCompanySummary.md) |  &nbsp;
+**next_page** | String | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGCompanySummary)

data/docs/ApiResponseESGCompanyComprehensiveRatingHistory.md ADDED Viewed

@@ -0,0 +1,28 @@
+[//]: # (CLASS:Intrinio::ApiResponseESGCompanyComprehensiveRatingHistory)
+[//]: # (KIND:object)
+### Intrinio::ApiResponseESGCompanyComprehensiveRatingHistory
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**ratings** | [**Array&lt;ESGComprehensiveRating&gt;**](ESGComprehensiveRating.md) |  &nbsp;
+**company** | [**ESGCompanySummary**](ESGCompanySummary.md) |  &nbsp;
+**next_page** | String | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGComprehensiveRating)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGCompanySummary)

data/docs/ApiResponseESGCompanyRatingHistory.md ADDED Viewed

@@ -0,0 +1,28 @@
+[//]: # (CLASS:Intrinio::ApiResponseESGCompanyRatingHistory)
+[//]: # (KIND:object)
+### Intrinio::ApiResponseESGCompanyRatingHistory
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**ratings** | [**Array&lt;ESGRating&gt;**](ESGRating.md) |  &nbsp;
+**company** | [**ESGCompanySummary**](ESGCompanySummary.md) |  &nbsp;
+**next_page** | String | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGRating)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGCompanySummary)

data/docs/ApiResponseESGLatest.md ADDED Viewed

@@ -0,0 +1,24 @@
+[//]: # (CLASS:Intrinio::ApiResponseESGLatest)
+[//]: # (KIND:object)
+### Intrinio::ApiResponseESGLatest
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**ratings** | [**Array&lt;ESGRatingWithCompany&gt;**](ESGRatingWithCompany.md) |  &nbsp;
+**next_page** | String | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGRatingWithCompany)

data/docs/ApiResponseESGLatestComprehensive.md ADDED Viewed

@@ -0,0 +1,24 @@
+[//]: # (CLASS:Intrinio::ApiResponseESGLatestComprehensive)
+[//]: # (KIND:object)
+### Intrinio::ApiResponseESGLatestComprehensive
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**ratings** | [**Array&lt;ESGComprehensiveRatingWithCompany&gt;**](ESGComprehensiveRatingWithCompany.md) |  &nbsp;
+**next_page** | String | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGComprehensiveRatingWithCompany)

data/docs/CompanyApi.md CHANGED Viewed

@@ -154,7 +154,7 @@ Name | Type | Description  | Notes
 #### All News
-Returns all News for all Companies
+Returns the latest news article links, headlines and summaries for all US traded companies allowing you to keep a pulse on companies and their business operations.
 [//]: # (END_OVERVIEW)
@@ -236,7 +236,7 @@ Name | Type | Description  | Notes
 #### Lookup Company
-Returns the Company with the given `identifier`
+Returns company reference and metadata such as tickers, CIK, and a unique company identifier, as well as company metadata such as business description, employee count, and company URL.
 [//]: # (END_OVERVIEW)
@@ -392,7 +392,7 @@ Name | Type | Description  | Notes
 #### Data Point (Number) for Company
-Returns a numeric value for the given `tag` for the Company with the given `identifier`
+Returns latest value for calculations, metrics, and financial data points for a company.
 [//]: # (END_OVERVIEW)
@@ -471,7 +471,7 @@ Name | Type | Description  | Notes
 #### Data Point (Text) for Company
-Returns a text value for the given `tag` for the Company with the given `identifier`
+Returns latest value for metadata items for a company.
 [//]: # (END_OVERVIEW)
@@ -642,7 +642,7 @@ Name | Type | Description  | Notes
 #### All Fundamentals by Company
-Returns all Fundamentals for the Company with the given `identifier`. Returns Fundamentals matching parameters when supplied.
+Returns a list of fundamentals with unique fundamental IDs associated with a particular company. Useful to obtain all historical and/or latest fundamental IDs for a given company to then use to loop through and pull all fundamental data available.
 [//]: # (END_OVERVIEW)
@@ -838,7 +838,7 @@ Name | Type | Description  | Notes
 #### IPOs
-Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \"going public\" is initiated by an IPO, at which point the company's stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.
+Returns a list of historical, current, and upcoming initial public offerings (IPOs) across the major US Exchanges. Includes relevant information such as the IPO status, the offer amount, the total share count and target share price.
 [//]: # (END_OVERVIEW)
@@ -886,7 +886,7 @@ pp result
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **ticker** | String| Return IPOs with the given ticker (typically the IPO for the company) | [optional]  &nbsp;
- **status** | 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 | [optional]  &nbsp;
+ **status** | String| Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occurred and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand | [optional]  &nbsp;
  **start_date** | Date| Return IPOs on or after the given date | [optional]  &nbsp;
  **end_date** | Date| Return IPOs on or before the given date | [optional]  &nbsp;
  **offer_amount_greater_than** | Integer| Return IPOs with an offer dollar amount greater than the given amount | [optional]  &nbsp;
@@ -932,7 +932,7 @@ Name | Type | Description  | Notes
 #### All News by Company
-Returns news for the Company with the given `identifier`
+Returns the latest and historical news article links, headlines and summaries for a specified US traded company.
 [//]: # (END_OVERVIEW)
@@ -1016,7 +1016,7 @@ Name | Type | Description  | Notes
 #### All Securities by Company
-Returns Securities for the Company with the given `identifier`
+Returns a list of underlying securities with associated reference data tied to a given company identifier.
 [//]: # (END_OVERVIEW)
@@ -1434,7 +1434,7 @@ Name | Type | Description  | Notes
 #### Search Companies
-Searches for Companies matching the text `query`
+Search the companies database and return a list of companies matching the text query parameter passed through. Query parameter searches across the company ticker and name.
 [//]: # (END_OVERVIEW)
@@ -1518,7 +1518,7 @@ Name | Type | Description  | Notes
 #### Shares Outstanding by Company
-Returns shares outstanding for the Company with the given `identifier`
+Returns the shares outstanding reported on the front cover of the SEC 10-K and 10-Q filings.
 [//]: # (END_OVERVIEW)