Merge pull request tweepy#2009 from qin-yu/qy/dm-event-doc

Harmon758 · web-flow · commit 85f5f3d53f19 · 2022-11-14T20:10:57.000-06:00
Add fields documentation for Direct Message events
diff --git a/docs/expansions_and_fields.rst b/docs/expansions_and_fields.rst
@@ -8,12 +8,13 @@ Expansions and Fields
 ``expansions``
 --------------
 `Expansions`_ enable you to request additional data objects that relate to the
-originally returned List, Space, Tweets, or users. 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 List, Space, Tweet, or
-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 Space, Tweet, or user object.
+originally returned List, Space, Tweets, Users, or Direct Message conversation
+events. Submit a list of desired expansions in a comma-separated list without
+spaces. The ID(s) that represent(s) the expanded data object(s) will be
+included directly in the List, Space, Tweet, user, or event 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 Space, Tweet, User or Direct Message conversation event object.
 
 At this time, the only expansion available to endpoints that primarily return
 List objects is ``expansions=owner_id``. You will find the expanded user data
@@ -40,6 +41,14 @@ using this parameter:
 * Attached place’s object
 * Any referenced Tweets’ object
 
+For methods that returns Direct Message conversation events, the following data
+objects can be expanded using this parameter:
+
+* The user object for the message sender.
+* Attached media's object.
+* Any referenced Tweet's object.
+* The user object for who is joining or leaving group conversations.
+
 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.
