From e2fb467b52659e87de592ff80b03edb9324c0189 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 14 Nov 2022 22:12:27 -0600 Subject: [PATCH] Update documentation for dm_event_fields parameter This documentation was previously inaccurate when the Twitter API v2 Direct Messages endpoints were launched but has now recently been updated. --- tweepy/asynchronous/client.py | 5 +++-- tweepy/client.py | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/tweepy/asynchronous/client.py b/tweepy/asynchronous/client.py index e0bdf3c..19749e9 100644 --- a/tweepy/asynchronous/client.py +++ b/tweepy/asynchronous/client.py @@ -2602,8 +2602,9 @@ class AsyncClient(AsyncBaseClient): The ``participant_id`` of the user that the authenicating user is having a 1-1 conversation with. dm_event_fields : list[str] | str | None - Extra fields to include in the event payload. ``id``, ``text``, and - ``event_type`` are returned by default. + Extra fields to include in the event payload. ``id`` and + ``event_type`` are returned by default. The ``text`` value isn't + included for ``ParticipantsJoin`` and ``ParticipantsLeave`` events. event_types : str The type of Direct Message event to returm. If not included, all types are returned. diff --git a/tweepy/client.py b/tweepy/client.py index 2afda8e..47efd33 100644 --- a/tweepy/client.py +++ b/tweepy/client.py @@ -2812,8 +2812,9 @@ class Client(BaseClient): The ``participant_id`` of the user that the authenicating user is having a 1-1 conversation with. dm_event_fields : list[str] | str | None - Extra fields to include in the event payload. ``id``, ``text``, and - ``event_type`` are returned by default. + Extra fields to include in the event payload. ``id`` and + ``event_type`` are returned by default. The ``text`` value isn't + included for ``ParticipantsJoin`` and ``ParticipantsLeave`` events. event_types : str The type of Direct Message event to returm. If not included, all types are returned. -- 2.25.1