RubyGems - intrinio-sdk - Versions diffs - 5.21.0 → 6.21.0 - Mend

intrinio-sdk 5.21.0 → 6.21.0

Files changed (583) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9e5dbaa75321df06ce193ce07b05b44281d0cab4c8a37710680015986e6492
-  data.tar.gz: 0beb24c0de3d394c7b93707b59bfc2fcf37e2486cf36d178f7baf33e315554c1
+  metadata.gz: 66323a623c8c4c2ffcee30cfcd92f06a6210b77e8e933e945660058ca01613b9
+  data.tar.gz: 18053424cd1f63f36765fc9e201975ba3d1a590744a939572d5627ca10401f14
 SHA512:
-  metadata.gz: ef14e3433a4bdd5bb7a9e5d46c8194f86510dba18a3422c201a44efca20c40b93500d9d9a4ae11ea42ff90bb81e4943fd3f0dedc4e26953f05b4fd87b8372109
-  data.tar.gz: cf9f08a7849db3bd80f9e4a0fb8e16fc7bfe2ac6732d1e369660226670b31ffd5ae832963c20daaeaddef0e0b35057b72ef282f65335bc55b3347ffa17721a49
+  metadata.gz: e765983570282aef07a1191b931bb3cbdacfed9241d11beca76ed15f6c61991f505afa30d870dc52a077f658b1a2dd2f4926cf0689d85048136d1a83bb19a88b
+  data.tar.gz: ea3b8e4956cb12ee614a2af4332200022edfbee5f36d5fcfde24e188040db38a7c0a8727fa2e4fdd87ecec20ae78950fe9eea29673418517ef98c76e4b7e6a00

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    intrinio-sdk (5.21.0)
+    intrinio-sdk (6.21.0)
       json (~> 2.1, >= 2.1.0)
       retriable (~> 3.1, >= 3.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -54,7 +54,7 @@ GEM
       hashdiff
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 DEPENDENCIES
   autotest (~> 4.4, >= 4.4.6)
@@ -69,4 +69,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 BUNDLED WITH
-   2.1.4
+   2.3.19

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.28.0
-- Package version: 5.21.0
+- API version: 2.28.4
+- Package version: 6.21.0
 ## Installation
@@ -86,8 +86,10 @@ Class | Method | HTTP request | Description
 *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
@@ -151,6 +153,7 @@ Class | Method | HTTP request | Description
 *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_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
+*Intrinio::OptionsApi* | [**get_security_snapshots**](docs/OptionsApi.md#get_security_snapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
 *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
 *Intrinio::OptionsApi* | [**get_unusual_activity_universal**](docs/OptionsApi.md#get_unusual_activity_universal) | **GET** /options/unusual_activity | Options Unusual Activity Universal
@@ -202,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
@@ -278,8 +282,10 @@ Class | Method | HTTP request | Description
  - [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)
@@ -405,6 +411,8 @@ Class | Method | HTTP request | Description
  - [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)
@@ -456,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)
@@ -472,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/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/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/ESGApi.md CHANGED Viewed

@@ -5,8 +5,10 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_esg_companies**](ESGApi.md#get_esg_companies) | **GET** /esg/companies | ESG Companies
+[**get_esg_company_comprehensive_ratings**](ESGApi.md#get_esg_company_comprehensive_ratings) | **GET** /esg/{identifier}/comprehensive | ESG Company Comprehensive Ratings History
 [**get_esg_company_ratings**](ESGApi.md#get_esg_company_ratings) | **GET** /esg/{identifier} | ESG Company Ratings History
 [**get_esg_latest**](ESGApi.md#get_esg_latest) | **GET** /esg | ESG Latest
+[**get_esg_latest_comprehensive**](ESGApi.md#get_esg_latest_comprehensive) | **GET** /esg/comprehensive | ESG Latest Comprehensive
@@ -60,7 +62,9 @@ end
 eSG_api = Intrinio::ESGApi.new
 opts = {
-  country: "USA",
+  country: "Canada",
+  industry: "Retail",
+  ticker: "SHOP",
   page_size: 100,
   next_page: nil
 }
@@ -81,6 +85,8 @@ pp result
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **country** | String|  | [optional]  &nbsp;
+ **industry** | String|  | [optional]  &nbsp;
+ **ticker** | String|  | [optional]  &nbsp;
  **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
  **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
@@ -93,6 +99,89 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ESGApi)
+[//]: # (METHOD:get_esg_company_comprehensive_ratings)
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseESGCompanyComprehensiveRatingHistory)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ApiResponseESGCompanyComprehensiveRatingHistory.md)
+[//]: # (OPERATION:get_esg_company_comprehensive_ratings_v2)
+[//]: # (ENDPOINT:/esg/{identifier}/comprehensive)
+[//]: # (DOCUMENT_LINK:ESGApi.md#get_esg_company_comprehensive_ratings)
+## **get_esg_company_comprehensive_ratings**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_esg_company_comprehensive_ratings_v2)
+[//]: # (START_OVERVIEW)
+> ApiResponseESGCompanyComprehensiveRatingHistory get_esg_company_comprehensive_ratings(identifier, opts)
+#### ESG Company Comprehensive Ratings History
+[//]: # (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
+eSG_api = Intrinio::ESGApi.new
+identifier = "AAPL"
+opts = {
+  page_size: 100,
+  next_page: nil
+}
+result = eSG_api.get_esg_company_comprehensive_ratings(identifier, opts)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| ISIN, Intrinio ID, or Ticker |  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ApiResponseESGCompanyComprehensiveRatingHistory**](ApiResponseESGCompanyComprehensiveRatingHistory.md)
+[//]: # (END_OPERATION)
 [//]: # (START_OPERATION)
 [//]: # (CLASS:Intrinio::ESGApi)
@@ -227,7 +316,6 @@ eSG_api = Intrinio::ESGApi.new
 opts = {
   country: "USA",
-  country2: "USA",
   page_size: 100,
   next_page: nil
 }
@@ -248,7 +336,6 @@ pp result
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **country** | String|  | [optional]  &nbsp;
- **country2** | String|  | [optional]  &nbsp;
  **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
  **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
@@ -260,3 +347,86 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ESGApi)
+[//]: # (METHOD:get_esg_latest_comprehensive)
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseESGLatestComprehensive)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ApiResponseESGLatestComprehensive.md)
+[//]: # (OPERATION:get_esg_latest_comprehensive_v2)
+[//]: # (ENDPOINT:/esg/comprehensive)
+[//]: # (DOCUMENT_LINK:ESGApi.md#get_esg_latest_comprehensive)
+## **get_esg_latest_comprehensive**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_esg_latest_comprehensive_v2)
+[//]: # (START_OVERVIEW)
+> ApiResponseESGLatestComprehensive get_esg_latest_comprehensive(opts)
+#### ESG Latest Comprehensive
+[//]: # (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
+eSG_api = Intrinio::ESGApi.new
+opts = {
+  country: "USA",
+  page_size: 100,
+  next_page: nil
+}
+result = eSG_api.get_esg_latest_comprehensive(opts)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **country** | String|  | [optional]  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ApiResponseESGLatestComprehensive**](ApiResponseESGLatestComprehensive.md)
+[//]: # (END_OPERATION)

data/docs/ESGCompanySummary.md CHANGED Viewed

@@ -12,12 +12,12 @@
 Name | Type | Description
 ------------ | ------------- | -------------
-**id** | String |  &nbsp;
-**name** | String |  &nbsp;
-**ticker** | String |  &nbsp;
-**isin** | String |  &nbsp;
-**primary_industry** | String |  &nbsp;
-**country** | String |  &nbsp;
+**id** | String | The Intrinio ID of the company. &nbsp;
+**name** | String | The company’s common name. &nbsp;
+**ticker** | String | The stock market ticker symbol associated with the company’s common stock security. &nbsp;
+**isin** | String | The company&#39;s common securities identification 12-digit alphanumeric code. &nbsp;
+**primary_industry** | String | The primary industry associated with the company based on their main revenue generating operations. &nbsp;
+**country** | String | The country in which the company&#39;s headquarters or primary place of business is located. &nbsp;
 [//]: # (END_DEFINITION)

data/docs/ESGComprehensiveRating.md ADDED Viewed

@@ -0,0 +1,58 @@
+[//]: # (CLASS:Intrinio::ESGComprehensiveRating)
+[//]: # (KIND:object)
+### Intrinio::ESGComprehensiveRating
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**date** | Date | Indicates the date on which the ESG Rating was calculated. &nbsp;
+**country_average_rating** | Float | The average ESG rating of all companies in a particular country in which the company is a peer of. &nbsp;
+**industry_average_rating** | Float | The average ESG rating of all companies in a particular industry in which the company is a peer of. &nbsp;
+**overall_rating** | Float | The company&#39;s overall aggregated ESG rating, taking into account its ESG scoring from the Community, Employee, Enviroment, and Governance categories. &nbsp;
+**community_rating** | Float | The Community Category reflects a companys citizenship, charitable giving, and volunteerism. This category covers the company&#39;s human rights record and treatment of its supply chain. It also covers the environmental and social impacts of the companys products and services, and the development of sustainable products, processes and technologies. &nbsp;
+**employee_rating** | Float | The Employees category includes disclosure of policies, programs, and performance in diversity, labor relations and labor rights. The evaluation focuses on the quality of policies and programs, compliance with national laws and regulations, and proactive management initiatives. The category includes evaluation of inclusive diversity policies, fair treatment of all employees, robust diversity (EEO-1) programs and training. &nbsp;
+**environment_rating** | Float | The Environment category data covers a company&#39;s interactions with the environment at large, including use of natural resources. The category evaluates corporate environmental performance, compliance with environmental regulations, and mitigation of environmental footprint. It also includes leadership in addressing climate change through appropriate policies and strategies. &nbsp;
+**governance_rating** | Float | Corporate governance refers to leadership structure and the values that determine corporate direction, ethics and performance. The Governance category covers disclosure of policies and procedures, board independence and diversity, executive compensation, attention to stakeholder concerns, and evaluation of a company&#39;s culture of ethical leadership and compliance. &nbsp;
+**human_rights_and_supply_chain_rating** | Float | The Human Rights and Supply Chain subcategory measures a company&#39;s commitment to respecting fundamental human rights conventions. This subcategory covers a company&#39;s transparency in overseas sourcing disclosure and monitoring. The subcategory also covers the relationship with and respect for the human rights of indigenous peoples near its proposed or current operations. &nbsp;
+**community_dev_and_philanthropy_rating** | Float | The Community Development and Philanthropy subcategory covers the relationship between a company and the communities within which it is embedded. It reflects a company&#39;s community citizenship through charitable giving, donations of goods, and volunteerism of staff time. It also includes protecting public health (e.g., avoidance of industrial accidents) and managing the social impacts of its operations. &nbsp;
+**product_rating** | Float | The Product subcategory covers the responsibility of a company for the development, design, and management of its products and services. This subcategory reflects a company&#39;s capacity to reduce environmental costs, create new market opportunities, and produce or market goods and services that enhance the health and quality of life for consumers. &nbsp;
+**compensation_and_benefits_rating** | Float | The Compensation and Benefits subcategory covers a company&#39;s capacity to increase its workforce loyalty and productivity. It includes benefits that engage employees and improve worker development. This subcategory also focuses on long-term employment growth and stability by promotion practices, lay-off practices, and relations with retired employees. &nbsp;
+**diversity_and_labor_rights_rating** | Float | The Diversity and Labor Rights subcategory covers workplace policies and practices covering fair and non-discriminatory treatment of employees. It covers a company&#39;s labor-management relations and participation by employees. Fundamental labor rights include freedom of association and protection of the right to organize. &nbsp;
+**training_health_and_safety_rating** | Float | The Training, Safety and Health subcategory measures a company&#39;s effectiveness in providing a healthy and safe workplace. It includes programs to support the health, well-being and productivity of all employees. This subcategory includes workplace policies and programs that boost employee morale, workplace productivity and worker development. &nbsp;
+**energy_climate_change_rating** | Float | The Energy and Climate Change subcategory measures a company&#39;s effectiveness in addressing climate change through appropriate policies and strategies. The subcategory includes energy use, emissions to air of CO2 and other Greenhouse Gas Emissions (GHG) and other alternative environmental technologies. &nbsp;
+**environment_policy_and_reporting_rating** | Float | The Environmental Policy and Reporting subcategory includes a company&#39;s policies and intention to reduce the environmental impact of a company. The data includes the company&#39;s environmental reporting performance, adherence to environmental reporting standards and compliance with investor, regulatory and stakeholders&#39; requests for transparency. Compliance data consists of breaches of regulatory limits and accidental releases. &nbsp;
+**resource_management_rating** | Float | The Resource Management subcategory covers how efficiently resources are used in manufacturing and delivering products and services. It includes a company&#39;s capacity to reduce the use of materials, energy or water, and to find more efficient solutions by improving its supply chain management. This subcategory includes environmental performance relative to production size. &nbsp;
+**board_rating** | Float | The Board subcategory covers a company&#39;s effectiveness in following best practices in corporate governance principles related to board membership. It includes how the company provides competitive and proportionate management compensation and its ability to incent executives and board members to achieve both financial and extra-financial targets. &nbsp;
+**leadership_ethics_rating** | Float | The Leadership Ethics subcategory measures how a company manages its relationships with its various stakeholders, including investors, customers, communities, and regulators. It measures a company&#39;s commitment and effectiveness toward the vision of integrating social and environmental aspects into the overall core strategy. It also measures whether sustainability principles are integrated from the top down into the day-to-day operations of the company. &nbsp;
+**transparency_reporting_rating** | Float | The Transparency and Reporting subcategory rates factors including are corporate policies and practices aligned with sustainability goals. It also covers whether the company is a signatory of Global Compact and other leading global entities. It evaluates the assurance (3rd party audit) of the accuracy, completeness, and reliability of its Sustainability or Corporate Social Responsibility reports. &nbsp;
+**country_percentile_rank** | Float | The percentile rank of the company&#39;s ESG rating in comparison to it&#39;s country peers. &nbsp;
+**industry_percentile_rank** | Float | The percentile rank of the company&#39;s ESG rating in comparison to it&#39;s industry peers. &nbsp;
+**overall_percentile_rank** | Float | The percentile rank of the company&#39;s overall ESG rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**community_percentile_rank** | Float | The percentile rank of the company&#39;s Community rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**employee_percentile_rank** | Float | The percentile rank of the company&#39;s Employee rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**environment_percentile_rank** | Float | The percentile rank of the company&#39;s Environment rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**governance_percentile_rank** | Float | The percentile rank of the company&#39;s Governance rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**human_rights_and_supply_chain_percentile_rank** | Float | The percentile rank of the company&#39;s Human Rights and Supply Chain rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**community_dev_and_philanthropy_percentile_rank** | Float | The percentile rank of the company&#39;s Community, Dev, and Philanthropy rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**product_percentile_rank** | Float | The percentile rank of the company&#39;s Product rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**compensation_and_benefits_percentile_rank** | Float | The percentile rank of the company&#39;s Compensation and Benefits rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**diversity_and_labor_rights_percentile_rank** | Float | The percentile rank of the company&#39;s Diversity and Labor Rights rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**training_health_and_safety_percentile_rank** | Float | The percentile rank of the company&#39;s Training, Health, and Safety rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**energy_climate_change_percentile_rank** | Float | The percentile rank of the company&#39;s Energy Climate Change rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**environment_policy_and_reporting_percentile_rank** | Float | The percentile rank of the company&#39;s Environment Policy and Reporting rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**resource_management_percentile_rank** | Float | The percentile rank of the company&#39;s Resource Management rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**board_percentile_rank** | Float | The percentile rank of the company&#39;s Board rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**leadership_ethics_percentile_rank** | Float | The percentile rank of the company&#39;s Leadership Ethics rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**transparency_reporting_percentile_rank** | Float | The percentile rank of the company&#39;s Transaperency Reporting rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+[//]: # (END_DEFINITION)

data/docs/ESGComprehensiveRatingWithCompany.md ADDED Viewed

@@ -0,0 +1,62 @@
+[//]: # (CLASS:Intrinio::ESGComprehensiveRatingWithCompany)
+[//]: # (KIND:object)
+### Intrinio::ESGComprehensiveRatingWithCompany
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**date** | Date | Indicates the date on which the ESG Rating was calculated. &nbsp;
+**country_average_rating** | Float | The average ESG rating of all companies in a particular country in which the company is a peer of. &nbsp;
+**industry_average_rating** | Float | The average ESG rating of all companies in a particular industry in which the company is a peer of. &nbsp;
+**overall_rating** | Float | The company&#39;s overall aggregated ESG rating, taking into account its ESG scoring from the Community, Employee, Enviroment, and Governance categories. &nbsp;
+**community_rating** | Float | The Community Category reflects a companys citizenship, charitable giving, and volunteerism. This category covers the company&#39;s human rights record and treatment of its supply chain. It also covers the environmental and social impacts of the companys products and services, and the development of sustainable products, processes and technologies. &nbsp;
+**employee_rating** | Float | The Employees category includes disclosure of policies, programs, and performance in diversity, labor relations and labor rights. The evaluation focuses on the quality of policies and programs, compliance with national laws and regulations, and proactive management initiatives. The category includes evaluation of inclusive diversity policies, fair treatment of all employees, robust diversity (EEO-1) programs and training. &nbsp;
+**environment_rating** | Float | The Environment category data covers a company&#39;s interactions with the environment at large, including use of natural resources. The category evaluates corporate environmental performance, compliance with environmental regulations, and mitigation of environmental footprint. It also includes leadership in addressing climate change through appropriate policies and strategies. &nbsp;
+**governance_rating** | Float | Corporate governance refers to leadership structure and the values that determine corporate direction, ethics and performance. The Governance category covers disclosure of policies and procedures, board independence and diversity, executive compensation, attention to stakeholder concerns, and evaluation of a company&#39;s culture of ethical leadership and compliance. &nbsp;
+**human_rights_and_supply_chain_rating** | Float | The Human Rights and Supply Chain subcategory measures a company&#39;s commitment to respecting fundamental human rights conventions. This subcategory covers a company&#39;s transparency in overseas sourcing disclosure and monitoring. The subcategory also covers the relationship with and respect for the human rights of indigenous peoples near its proposed or current operations. &nbsp;
+**community_dev_and_philanthropy_rating** | Float | The Community Development and Philanthropy subcategory covers the relationship between a company and the communities within which it is embedded. It reflects a company&#39;s community citizenship through charitable giving, donations of goods, and volunteerism of staff time. It also includes protecting public health (e.g., avoidance of industrial accidents) and managing the social impacts of its operations. &nbsp;
+**product_rating** | Float | The Product subcategory covers the responsibility of a company for the development, design, and management of its products and services. This subcategory reflects a company&#39;s capacity to reduce environmental costs, create new market opportunities, and produce or market goods and services that enhance the health and quality of life for consumers. &nbsp;
+**compensation_and_benefits_rating** | Float | The Compensation and Benefits subcategory covers a company&#39;s capacity to increase its workforce loyalty and productivity. It includes benefits that engage employees and improve worker development. This subcategory also focuses on long-term employment growth and stability by promotion practices, lay-off practices, and relations with retired employees. &nbsp;
+**diversity_and_labor_rights_rating** | Float | The Diversity and Labor Rights subcategory covers workplace policies and practices covering fair and non-discriminatory treatment of employees. It covers a company&#39;s labor-management relations and participation by employees. Fundamental labor rights include freedom of association and protection of the right to organize. &nbsp;
+**training_health_and_safety_rating** | Float | The Training, Safety and Health subcategory measures a company&#39;s effectiveness in providing a healthy and safe workplace. It includes programs to support the health, well-being and productivity of all employees. This subcategory includes workplace policies and programs that boost employee morale, workplace productivity and worker development. &nbsp;
+**energy_climate_change_rating** | Float | The Energy and Climate Change subcategory measures a company&#39;s effectiveness in addressing climate change through appropriate policies and strategies. The subcategory includes energy use, emissions to air of CO2 and other Greenhouse Gas Emissions (GHG) and other alternative environmental technologies. &nbsp;
+**environment_policy_and_reporting_rating** | Float | The Environmental Policy and Reporting subcategory includes a company&#39;s policies and intention to reduce the environmental impact of a company. The data includes the company&#39;s environmental reporting performance, adherence to environmental reporting standards and compliance with investor, regulatory and stakeholders&#39; requests for transparency. Compliance data consists of breaches of regulatory limits and accidental releases. &nbsp;
+**resource_management_rating** | Float | The Resource Management subcategory covers how efficiently resources are used in manufacturing and delivering products and services. It includes a company&#39;s capacity to reduce the use of materials, energy or water, and to find more efficient solutions by improving its supply chain management. This subcategory includes environmental performance relative to production size. &nbsp;
+**board_rating** | Float | The Board subcategory covers a company&#39;s effectiveness in following best practices in corporate governance principles related to board membership. It includes how the company provides competitive and proportionate management compensation and its ability to incent executives and board members to achieve both financial and extra-financial targets. &nbsp;
+**leadership_ethics_rating** | Float | The Leadership Ethics subcategory measures how a company manages its relationships with its various stakeholders, including investors, customers, communities, and regulators. It measures a company&#39;s commitment and effectiveness toward the vision of integrating social and environmental aspects into the overall core strategy. It also measures whether sustainability principles are integrated from the top down into the day-to-day operations of the company. &nbsp;
+**transparency_reporting_rating** | Float | The Transparency and Reporting subcategory rates factors including are corporate policies and practices aligned with sustainability goals. It also covers whether the company is a signatory of Global Compact and other leading global entities. It evaluates the assurance (3rd party audit) of the accuracy, completeness, and reliability of its Sustainability or Corporate Social Responsibility reports. &nbsp;
+**country_percentile_rank** | Float | The percentile rank of the company&#39;s ESG rating in comparison to it&#39;s country peers. &nbsp;
+**industry_percentile_rank** | Float | The percentile rank of the company&#39;s ESG rating in comparison to it&#39;s industry peers. &nbsp;
+**overall_percentile_rank** | Float | The percentile rank of the company&#39;s overall ESG rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**community_percentile_rank** | Float | The percentile rank of the company&#39;s Community rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**employee_percentile_rank** | Float | The percentile rank of the company&#39;s Employee rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**environment_percentile_rank** | Float | The percentile rank of the company&#39;s Environment rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**governance_percentile_rank** | Float | The percentile rank of the company&#39;s Governance rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**human_rights_and_supply_chain_percentile_rank** | Float | The percentile rank of the company&#39;s Human Rights and Supply Chain rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**community_dev_and_philanthropy_percentile_rank** | Float | The percentile rank of the company&#39;s Community, Dev, and Philanthropy rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**product_percentile_rank** | Float | The percentile rank of the company&#39;s Product rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**compensation_and_benefits_percentile_rank** | Float | The percentile rank of the company&#39;s Compensation and Benefits rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**diversity_and_labor_rights_percentile_rank** | Float | The percentile rank of the company&#39;s Diversity and Labor Rights rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**training_health_and_safety_percentile_rank** | Float | The percentile rank of the company&#39;s Training, Health, and Safety rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**energy_climate_change_percentile_rank** | Float | The percentile rank of the company&#39;s Energy Climate Change rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**environment_policy_and_reporting_percentile_rank** | Float | The percentile rank of the company&#39;s Environment Policy and Reporting rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**resource_management_percentile_rank** | Float | The percentile rank of the company&#39;s Resource Management rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**board_percentile_rank** | Float | The percentile rank of the company&#39;s Board rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**leadership_ethics_percentile_rank** | Float | The percentile rank of the company&#39;s Leadership Ethics rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**transparency_reporting_percentile_rank** | Float | The percentile rank of the company&#39;s Transaperency Reporting rating in comparison to all companies within the CSRHub ESG universe. &nbsp;
+**company** | [**ESGCompanySummary**](ESGCompanySummary.md) |  &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ESGCompanySummary)

data/docs/ESGRating.md CHANGED Viewed

@@ -12,11 +12,11 @@
 Name | Type | Description
 ------------ | ------------- | -------------
-**date** | Date |  &nbsp;
-**community_rating** | Float |  &nbsp;
-**employee_rating** | Float |  &nbsp;
-**environment_rating** | Float |  &nbsp;
-**governance_rating** | Float |  &nbsp;
+**date** | Date | Indicates the date on which the ESG Rating was calculated. &nbsp;
+**community_rating** | Float | The Community Category reflects a company&#39;s citizenship, charitable giving, and volunteerism. This category covers the company&#39;s human rights record and treatment of its supply chain. It also covers the environmental and social impacts of the company&#39;s products and services, and the development of sustainable products, processes and technologies. &nbsp;
+**employee_rating** | Float | The Employees category includes disclosure of policies, programs, and performance in diversity, labor relations and labor rights. The evaluation focuses on the quality of policies and programs, compliance with national laws and regulations, and proactive management initiatives. The category includes evaluation of inclusive diversity policies, fair treatment of all employees, robust diversity (EEO-1) programs and training. &nbsp;
+**environment_rating** | Float | The Environment category data covers a company&#39;s interactions with the environment at large, including use of natural resources. The category evaluates corporate environmental performance, compliance with environmental regulations, and mitigation of environmental footprint. It also includes leadership in addressing climate change through appropriate policies and strategies. &nbsp;
+**governance_rating** | Float | Corporate governance refers to leadership structure and the values that determine corporate direction, ethics and performance. The Governance category covers disclosure of policies and procedures, board independence and diversity, executive compensation, attention to stakeholder concerns, and evaluation of a companys culture of ethical leadership and compliance. &nbsp;
 [//]: # (END_DEFINITION)

data/docs/ESGRatingWithCompany.md CHANGED Viewed

@@ -12,11 +12,11 @@
 Name | Type | Description
 ------------ | ------------- | -------------
-**date** | Date |  &nbsp;
-**community_rating** | Float |  &nbsp;
-**employee_rating** | Float |  &nbsp;
-**environment_rating** | Float |  &nbsp;
-**governance_rating** | Float |  &nbsp;
+**date** | Date | Indicates the date on which the ESG Rating was calculated. &nbsp;
+**community_rating** | Float | The Community Category reflects a company&#39;s citizenship, charitable giving, and volunteerism. This category covers the company’s human rights record and treatment of its supply chain. It also covers the environmental and social impacts of the companys products and services, and the development of sustainable products, processes and technologies. &nbsp;
+**employee_rating** | Float | The Employees category includes disclosure of policies, programs, and performance in diversity, labor relations and labor rights. The evaluation focuses on the quality of policies and programs, compliance with national laws and regulations, and proactive management initiatives. The category includes evaluation of inclusive diversity policies, fair treatment of all employees, robust diversity (EEO-1) programs and training. &nbsp;
+**environment_rating** | Float | The Environment category data covers a company’s interactions with the environment at large, including use of natural resources. The category evaluates corporate environmental performance, compliance with environmental regulations, and mitigation of environmental footprint. It also includes leadership in addressing climate change through appropriate policies and strategies. &nbsp;
+**governance_rating** | Float | Corporate governance refers to leadership structure and the values that determine corporate direction, ethics and performance. The Governance category covers disclosure of policies and procedures, board independence and diversity, executive compensation, attention to stakeholder concerns, and evaluation of a company’s culture of ethical leadership and compliance. &nbsp;
 **company** | [**ESGCompanySummary**](ESGCompanySummary.md) |  &nbsp;
 [//]: # (END_DEFINITION)

data/docs/OptionSnapshotGroup.md ADDED Viewed

@@ -0,0 +1,21 @@
+[//]: # (CLASS:Intrinio::OptionSnapshotGroup)
+[//]: # (KIND:object)
+### Intrinio::OptionSnapshotGroup
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**time** | DateTime | The UTC timestamp of this snapshot group. &nbsp;
+**files** | Array&lt;Object&gt; | List of all the snapshot parts of this group. &nbsp;
+[//]: # (END_DEFINITION)

data/docs/OptionSnapshotsResult.md ADDED Viewed

@@ -0,0 +1,23 @@
+[//]: # (CLASS:Intrinio::OptionSnapshotsResult)
+[//]: # (KIND:object)
+### Intrinio::OptionSnapshotsResult
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**snapshots** | [**Array&lt;OptionSnapshotGroup&gt;**](OptionSnapshotGroup.md) | List of all the snapshot groups comprising the queried result. &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::OptionSnapshotGroup)