DOC: Mark endpoints which now require additional entitlements

docs/source/market-info.rst

@@ -68,6 +68,11 @@ Examples
 Earnings Today
 --------------
 
+.. warning:: Beginning December 1, 2020, use of this endpoint will require 
+             additional entitlements. Full details can be found in the 
+             IEX Cloud Help Center. See `here <https://intercom.help/iexcloud/en/articles/4529082-iex-cloud-s-2020-data-upgrade>`_
+             for additional information.
+
 .. warning:: ``get_todays_earnings`` has been deprecated and renamed
             ``get_earnings_today``.
 

docs/source/stocks.rst

@@ -41,47 +41,13 @@ single request.
 See :ref:`Additional Methods<stocks.additional_methods>` for more a list of
 methods available.
 
-.. _stocks.endpoint_list:
-
-List of Endpoints
-~~~~~~~~~~~~~~~~~
-
-All endpoints not available as methods of the ``Stock`` object are noted below.
-
-Endpoints which are supported by top-level functions are noted.
-
-- :ref:`Advanced Stats<stocks.advanced_stats>`
-- :ref:`Balance Sheet<stocks.balance_sheet>`
-- :ref:`Book<stocks.book>`
-- :ref:`Cash Flow<stocks.cash_flow>`
-- :ref:`Charts<stocks.charts>`
-- :ref:`Company<stocks.company>`
-- :ref:`Delayed Quote<stocks.delayed_quote>`
-- :ref:`Dividends (Basic)<stocks.dividends>`
-- :ref:`Earnings<stocks.earnings>`
-- :ref:`Estimates<stocks.estimates>`
-- :ref:`Financials<stocks.financials>`
-- :ref:`Fund Ownership<stocks.fund_ownership>`
-- :ref:`Historical Prices<stocks.historical>` - ``get_historical_data`` and ``get_historical_intraday``
-- :ref:`Income Statement<stocks.income_statement>`
-- :ref:`Insider Roster<stocks.insider_roster>`
-- :ref:`Insider Summary<stocks.insider_summary>`
-- :ref:`Insider Transactions<stocks.insider_transactions>`
-- :ref:`Institutional Ownership<stocks.institutional_ownership>`
-- :ref:`Key Stats<stocks.key_stats>`
-- :ref:`Largest Trades<stocks.largest_trades>`
-- :ref:`Logo<stocks.logo>`
-- :ref:`OHLC<stocks.ohlc>`
-- :ref:`Open/Close<stocks.open_close>`
-- :ref:`Peers Groups<stocks.peers>`
-- :ref:`Previous Day Prices<stocks.previous_day_prices>`
-- :ref:`Price<stocks.price-only>`
-- :ref:`Price Target<stocks.price_target>`
-- :ref:`Quote<stocks.quote>`
-- :ref:`Relevant Stocks<stocks.relevant_stocks>`
-- :ref:`Splits (Basic)<stocks.splits>`
-- :ref:`Time Series<stocks.time_series>`
-- :ref:`Volume by Venue<stocks.volume_by_venue>`
+.. _stocks.contents:
+
+Endpoints
+---------
+
+.. contents::
+    :depth: 2
 
 
 .. _stocks.stock_object:
@@ -174,13 +140,23 @@ Dividends (Basic)
 Earnings
 --------
 
+.. warning:: Beginning December 1, 2020, use of this endpoint will require 
+             additional entitlements. Full details can be found in the 
+             IEX Cloud Help Center. See `here <https://intercom.help/iexcloud/en/articles/4529082-iex-cloud-s-2020-data-upgrade>`_
+             for additional information.
+
 .. automethod:: iexfinance.stocks.base.Stock.get_earnings
 
 .. _stocks.estimates:
 
 Estimates
 ---------
 
+.. warning:: Beginning December 1, 2020, use of this endpoint will require 
+             additional entitlements. Full details can be found in the 
+             IEX Cloud Help Center. See `here <https://intercom.help/iexcloud/en/articles/4529082-iex-cloud-s-2020-data-upgrade>`_
+             for additional information.
+
 .. automethod:: iexfinance.stocks.base.Stock.get_estimates
 
 .. _stocks.financials:
@@ -396,6 +372,11 @@ Price Only
 Price Target
 ------------
 
+.. warning:: Beginning December 1, 2020, use of this endpoint will require 
+             additional entitlements. Full details can be found in the 
+             IEX Cloud Help Center. See `here <https://intercom.help/iexcloud/en/articles/4529082-iex-cloud-s-2020-data-upgrade>`_
+             for additional information.
+
 .. automethod:: iexfinance.stocks.base.Stock.get_price_target
 
 .. _stocks.quote:

docs/source/whatsnew/v0.5.0.txt

@@ -22,31 +22,24 @@ Enhancements
 - Improves message weighting for historical data when calls are under
   1-year range
 - Adds support for historical data for the previous 15 years
-  (extended from 5 years) (GH94_)
+  (extended from 5 years) (:issue:`94`)
 - Adds ``flake8-bugbear`` for additional code quality checks
 - Repairs date handling to accept multiple formats, including ``str``,
   ``int``, ``date``, ``datetime``, and ``pandas.Timestamp`` and use a rolling 15-year default start date for historical data (specifically ``get_historical_data``)
-- Adds endpoint for us trading days/holidays (thanks Bouldersky)
+- Adds endpoint for us trading days/holidays (thanks :user:`Bouldersky`)
 - Adds official support for Python 3.8
-- Adds endpoint for advanced stats
-- Adds ``last`` and ``period`` parameters to ``Stock.get_estimates`` :issue:`213`
+- Adds endpoint for advanced stats (thanks :user:`SaymV`)
+- Adds ``last`` and ``period`` parameters to ``Stock.get_estimates`` (:issue:`213`)
 - Adds endpoints for international symbol reference data (thanks :user:`anthonyvd`)
 - Adds endpoint for Sectors reference data (thanks :user:`YairMZ`)
 
-.. _GH94: https://github.com/addisonlynch/iexfinance/issues/94
-.. _GH213: https://github.com/addisonlynch/iexfinance/issues/213
-
 
 Bug Fixes
 ~~~~~~~~~
 
 - Modifies ``Stock.get_historical_prices`` and ``Stock.get_chart``
-  (GH165_) to return all fields, including ``changePercent``
-- Repairs ``stocks.get_historical_data`` bug which errored on symbols without historical data (GH223_)
-
-  .. _GH165: https://github.com/addisonlynch/iexfinance/issues/165
-  .. _GH223: https://github.com/addisonlynch/iexfinance/issues/223
-
+  (:issue:`165`) to return all fields, including ``changePercent``
+- Repairs ``stocks.get_historical_data`` bug which errored on symbols without historical data (:issue:`223`)
 
 Backward Incompatible Changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -61,3 +54,6 @@ Backward Incompatible Changes
 - All endpoints in ``iexdata`` are now JSON-only (pandas output formatting no
   is longer supported)
 - ``iexfinance.stocks.get_market_in_focus`` has been immediately deprecated.
+- Certain endpoints (such as ``Stock.get_price_target``) now require additional entitlements.
+  See the IEX Cloud Help Center for more information. All endpoints which require additional
+  entitlements are noted in the ``iexfinance`` documentation.