Update allowed parameters for API.update_status
authorHarmon <Harmon758@gmail.com>
Tue, 27 Aug 2019 02:02:04 +0000 (21:02 -0500)
committerHarmon <Harmon758@gmail.com>
Tue, 27 Aug 2019 02:02:04 +0000 (21:02 -0500)
Resolves #1101

docs/api.rst
tweepy/api.py

index 27f469de67159f64720d8ad3f21dbafa3203b7b1..d97a26ae6f6c0bd1aed9029eb05cb5ab26daaad0 100644 (file)
@@ -112,15 +112,20 @@ Status methods
    or too long will be silently ignored.
 
    :param status: The text of your status update.
-   :param in_reply_to_status_id: The ID of an existing status that the update is in reply to.
-   :param in_reply_to_status_id_str: The ID of an existing status that the update is in reply to (as string).
-   :param auto_populate_reply_metadata: Whether to automatically include the @mentions in the status metadata.
-   :param lat: The location's latitude that this tweet refers to.
-   :param long: The location's longitude that this tweet refers to.
-   :param source: Source of the update. Only supported by Identi.ca. Twitter ignores this parameter.
-   :param place_id: Twitter ID of location which is listed in the Tweet if geolocation is enabled for the user.
+   :param in_reply_to_status_id: The ID of an existing status that the update is in reply to. Note: This parameter will be ignored unless the author of the Tweet this parameter references is mentioned within the status text. Therefore, you must include @username, where username is the author of the referenced Tweet, within the update.
+   :param auto_populate_reply_metadata: If set to true and used with in_reply_to_status_id, leading @mentions will be looked up from the original Tweet, and added to the new Tweet from there. This wil append @mentions into the metadata of an extended Tweet as a reply chain grows, until the limit on @mentions is reached. In cases where the original Tweet has been deleted, the reply will fail.
+   :param exclude_reply_user_ids: When used with auto_populate_reply_metadata, a comma-separated list of user ids which will be removed from the server-generated @mentions prefix on an extended Tweet. Note that the leading @mention cannot be removed as it would break the in-reply-to-status-id semantics. Attempting to remove it will be silently ignored.
+   :param attachment_url: In order for a URL to not be counted in the status body of an extended Tweet, provide a URL as a Tweet attachment. This URL must be a Tweet permalink, or Direct Message deep link. Arbitrary, non-Twitter URLs must remain in the status text. URLs passed to the attachment_url parameter not matching either a Tweet permalink or Direct Message deep link will fail at Tweet creation and cause an exception.
+   :param media_ids: A list of media_ids to associate with the Tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a Tweet.
+   :param possibly_sensitive: If you upload Tweet media that might be considered sensitive content such as nudity, or medical procedures, you must set this value to true.
+   :param lat: The latitude of the location this Tweet refers to. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there is no corresponding long parameter.
+   :param long: The longitude of the location this Tweet refers to. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there no corresponding lat parameter.
+   :param place_id: A place in the world.
    :param display_coordinates: Whether or not to put a pin on the exact coordinates a Tweet has been sent from.
-   :param media_ids: A list of media_ids to associate with the Tweet.
+   :param trim_user: When set to either true, t, or 1, the response will include a user object including only the author's ID. Omit this parameter to receive the complete user object.
+   :param enable_dmcommands: When set to true, enables shortcode commands for sending Direct Messages as part of the status text to send a Direct Message to a user. When set to false, disables this behavior and includes any leading characters in the status text that is posted
+   :param fail_dmcommands: When set to true, causes any status text that starts with shortcode commands to return an API error. When set to false, allows shortcode commands to be sent in the status text and acted on by the API.
+   :param card_uri: Associate an ads card with the Tweet using the card_uri value from any ads card response.
    :rtype: :class:`Status` object
 
 
index fa9f4226f577c928606a076ee0e9558d2ec67a0b..fc38124173ca08b4871c50f0c5e28fd48cd912a1 100644 (file)
@@ -176,7 +176,7 @@ class API(object):
 
     def update_status(self, *args, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
-            :allowed_param:'status', 'in_reply_to_status_id', 'in_reply_to_status_id_str', 'auto_populate_reply_metadata', 'lat', 'long', 'source', 'place_id', 'display_coordinates', 'media_ids'
+            :allowed_param:'status', 'in_reply_to_status_id', 'auto_populate_reply_metadata', 'exclude_reply_user_ids', 'attachment_url', 'media_ids', 'possibly_sensitive', 'lat', 'long', 'place_id', 'display_coordinates', 'trim_user', 'enable_dmcommands', 'fail_dmcommands', 'card_uri'
         """
         post_data = {}
         media_ids = kwargs.pop("media_ids", None)
@@ -188,7 +188,7 @@ class API(object):
             path='/statuses/update.json',
             method='POST',
             payload_type='status',
-            allowed_param=['status', 'in_reply_to_status_id', 'in_reply_to_status_id_str', 'auto_populate_reply_metadata', 'lat', 'long', 'source', 'place_id', 'display_coordinates'],
+            allowed_param=['status', 'in_reply_to_status_id', 'auto_populate_reply_metadata', 'exclude_reply_user_ids', 'attachment_url', 'media_ids', 'possibly_sensitive', 'lat', 'long', 'place_id', 'display_coordinates', 'trim_user', 'enable_dmcommands', 'fail_dmcommands', 'card_uri'],
             require_auth=True
         )(post_data=post_data, *args, **kwargs)