Skip to content

Commit

Permalink
Add notes about endpoint removals in Client / AsyncClient documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Harmon758 committed Aug 26, 2023
1 parent 935ea8c commit f32d12d
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/asyncclient.rst
Expand Up @@ -527,3 +527,8 @@ Batch compliance
.. automethod:: AsyncClient.get_compliance_job

.. automethod:: AsyncClient.create_compliance_job


.. rubric:: Footnotes

.. [#changelog] https://developer.twitter.com/en/updates/changelog
5 changes: 5 additions & 0 deletions docs/client.rst
Expand Up @@ -531,3 +531,8 @@ Batch compliance
.. automethod:: Client.get_compliance_job

.. automethod:: Client.create_compliance_job


.. rubric:: Footnotes

.. [#changelog] https://developer.twitter.com/en/updates/changelog
20 changes: 20 additions & 0 deletions tweepy/asynchronous/client.py
Expand Up @@ -1835,6 +1835,11 @@ async def get_users_followers(self, id, *, user_auth=False, **params):
Returns a list of users who are followers of the specified user ID.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
Parameters
----------
id : int | str
Expand Down Expand Up @@ -1883,6 +1888,11 @@ async def get_users_following(self, id, *, user_auth=False, **params):
Returns a list of users the specified user ID is following.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
Parameters
----------
id : int | str
Expand Down Expand Up @@ -2822,6 +2832,11 @@ async def get_list_followers(self, id, *, user_auth=False, **params):
Returns a list of users who are followers of the specified List.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
Parameters
----------
id : list[str] | str
Expand Down Expand Up @@ -2869,6 +2884,11 @@ async def get_followed_lists(self, id, *, user_auth=False, **params):
Returns all Lists a specified user follows.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
Parameters
----------
id : list[str] | str
Expand Down
20 changes: 20 additions & 0 deletions tweepy/client.py
Expand Up @@ -1973,6 +1973,11 @@ def get_users_followers(self, id, *, user_auth=False, **params):
Returns a list of users who are followers of the specified user ID.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
Parameters
----------
id : int | str
Expand Down Expand Up @@ -2021,6 +2026,11 @@ def get_users_following(self, id, *, user_auth=False, **params):
Returns a list of users the specified user ID is following.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
Parameters
----------
id : int | str
Expand Down Expand Up @@ -3028,6 +3038,11 @@ def get_list_followers(self, id, *, user_auth=False, **params):
Returns a list of users who are followers of the specified List.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
.. versionadded:: 4.4
Parameters
Expand Down Expand Up @@ -3077,6 +3092,11 @@ def get_followed_lists(self, id, *, user_auth=False, **params):
Returns all Lists a specified user follows.
.. note::
The Twitter API endpoint that this method uses has been removed
from the Basic and Pro tiers [#changelog]_.
.. versionadded:: 4.4
Parameters
Expand Down

0 comments on commit f32d12d

Please sign in to comment.