Document Client

docs/api.rst

@@ -4,9 +4,9 @@
 
 .. include:: parameters.rst
 
-*************************************
-:class:`tweepy.API` --- API Reference
-*************************************
+**************************************************
+:class:`tweepy.API` --- Twitter API v1.1 Reference
+**************************************************
 
 .. autoclass:: API
 

docs/client.rst

@@ -0,0 +1,192 @@
+.. _client_reference:
+
+.. currentmodule:: tweepy
+
+***************************************************
+:class:`tweepy.Client` --- Twitter API v2 Reference
+***************************************************
+
+.. autoclass:: Client
+
+Tweets
+======
+
+Hide replies
+------------
+
+.. automethod:: Client.hide_reply
+
+.. automethod:: Client.unhide_reply
+
+Search Tweets
+-------------
+
+.. automethod:: Client.search_all_tweets
+
+.. automethod:: Client.search_recent_tweets
+
+Timelines
+---------
+
+.. automethod:: Client.get_users_mentions
+
+.. automethod:: Client.get_users_tweets
+
+Tweet lookup
+------------
+
+.. automethod:: Client.get_tweet
+
+.. automethod:: Client.get_tweets
+
+Users
+=====
+
+Follows
+-------
+
+.. automethod:: Client.unfollow
+
+.. automethod:: Client.get_users_followers
+
+.. automethod:: Client.get_users_following
+
+.. automethod:: Client.follow
+
+User lookup
+-----------
+
+.. automethod:: Client.get_user
+
+.. automethod:: Client.get_users
+
+Expansions and Fields Parameters
+================================
+
+.. _expansions_parameter:
+
+``expansions``
+--------------
+For methods that return Tweets, `Expansions`_ enable you to request additional
+data objects that relate to the originally returned Tweets. Submit a list of
+desired expansions in a comma-separated list without spaces. The ID that
+represents the expanded data object will be included directly in the Tweet data
+object, but the expanded object metadata will be returned within the
+``includes`` response object, and will also include the ID so that you can
+match this data object to the original Tweet object.
+
+The following data objects can be expanded using this parameter:
+
+* The Tweet author's user object
+* The user object of the Tweet’s author that the
+  original Tweet is responding to
+* Any mentioned users’ object
+* Any referenced Tweets’ author’s user object
+* Attached media’s object
+* Attached poll’s object
+* Attached place’s object
+* Any referenced Tweets’ object
+
+For methods that return users, `Expansions`_ enable you to request additional
+data objects that relate to the originally returned users. The ID that
+represents the expanded data object will be included directly in the user data
+object, but the expanded object metadata will be returned within the
+``includes`` response object, and will also include the ID so that you can
+match this data object to the original Tweet object. At this time, the only
+expansion available to endpoints that primarily return user objects is
+``expansions=pinned_tweet_id``. You will find the expanded Tweet data object
+living in the ``includes`` response object.
+
+.. _media_fields_parameter:
+
+``media_fields``
+----------------
+This `fields`_ parameter enables you to select which specific `media fields`_
+will deliver in each returned Tweet. Specify the desired fields in a
+comma-separated list without spaces between commas and fields. The Tweet will
+only return media fields if the Tweet contains media and if you've also
+included the ``expansions=attachments.media_keys`` query parameter in your
+request. While the media ID will be located in the Tweet object, you will find
+this ID and all additional media fields in the ``includes`` data object.
+
+.. _place_fields_parameter:
+
+``place_fields``
+----------------
+This `fields`_ parameter enables you to select which specific `place fields`_
+will deliver in each returned Tweet. Specify the desired fields in a
+comma-separated list without spaces between commas and fields. The Tweet will
+only return place fields if the Tweet contains a place and if you've also
+included the ``expansions=geo.place_id`` query parameter in your request. While
+the place ID will be located in the Tweet object, you will find this ID and all
+additional place fields in the ``includes`` data object.
+
+.. _poll_fields_parameter:
+
+``poll_fields``
+---------------
+
+This `fields`_ parameter enables you to select which specific `poll fields`_
+will deliver in each returned Tweet. Specify the desired fields in a
+comma-separated list without spaces between commas and fields. The Tweet will
+only return poll fields if the Tweet contains a poll and if you've also
+included the ``expansions=attachments.poll_ids`` query parameter in your
+request. While the poll ID will be located in the Tweet object, you will find
+this ID and all additional poll fields in the ``includes`` data object.
+
+.. _tweet_fields_parameter:
+
+``tweet_fields``
+----------------
+
+For methods that return Tweets, this `fields`_ parameter enables you to select
+which specific `Tweet fields`_ will deliver in each returned Tweet object.
+Specify the desired fields in a comma-separated list without spaces between
+commas and fields. You can also pass the ``expansions=referenced_tweets.id``
+expansion to return the specified fields for both the original Tweet and any
+included referenced Tweets. The requested Tweet fields will display in both the
+original Tweet data object, as well as in the referenced Tweet expanded data
+object that will be located in the ``includes`` data object.
+
+For methods that return users, this `fields`_ parameter enables you to select
+which specific `Tweet fields`_ will deliver in each returned pinned Tweet.
+Specify the desired fields in a comma-separated list without spaces between
+commas and fields. The Tweet fields will only return if the user has a pinned
+Tweet and if you've also included the ``expansions=pinned_tweet_id`` query
+parameter in your request. While the referenced Tweet ID will be located in the
+original Tweet object, you will find this ID and all additional Tweet fields in
+the ``includes`` data object.
+
+.. _user_fields_parameter:
+
+``user_fields``
+---------------
+
+For methods that return Tweets, this `fields`_ parameter enables you to select
+which specific `user fields`_ will deliver in each returned Tweet. Specify the
+desired fields in a comma-separated list without spaces between commas and
+fields. While the user ID will be located in the original Tweet object, you
+will find this ID and all additional user fields in the ``includes`` data
+object.
+
+You must also pass one of the user expansions to return the desired user
+fields:
+
+* ``expansions=author_id``
+* ``expansions=entities.mentions.username``
+* ``expansions=in_reply_to_user_id``
+* ``expansions=referenced_tweets.id.author_id``
+
+For methods that return users, this `fields`_ parameter enables you to select
+which specific `user fields`_ will deliver with each returned users objects.
+Specify the desired fields in a comma-separated list without spaces between
+commas and fields. These specified user fields will display directly in the
+user data objects.
+
+.. _Expansions: https://developer.twitter.com/en/docs/twitter-api/expansions
+.. _fields: https://developer.twitter.com/en/docs/twitter-api/fields
+.. _media fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/media
+.. _place fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/place
+.. _poll fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/poll
+.. _Tweet fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet
+.. _user fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user

docs/index.rst

@@ -17,6 +17,7 @@ Contents:
    code_snippet.rst
    cursor_tutorial.rst
    api.rst
+   client.rst
    stream.rst
    exceptions.rst
    extended_tweets.rst