diff --git a/docs/api.rst b/docs/api.rst index 40b890c3f..4e631e63d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -13,249 +13,249 @@ .. table:: :align: center - +------------------------------------------+-------------------------------------+ - | Twitter API v1.1 Endpoint | :class:`API` Method | - +==========================================+=====================================+ - | .. centered:: :ref:`Premium Search APIs` | - +------------------------------------------+-------------------------------------+ - | `GET search/30day/:label`_ | :meth:`API.search_30_day` | - +------------------------------------------+-------------------------------------+ - | `GET search/fullarchive/:label`_ | :meth:`API.search_full_archive` | - +------------------------------------------+-------------------------------------+ - | .. centered:: :ref:`Tweets` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get Tweet timelines|_ | - +------------------------------------------+-------------------------------------+ - | `GET statuses/home_timeline`_ | :meth:`API.home_timeline` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/mentions_timeline`_ | :meth:`API.mentions_timeline` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/user_timeline`_ | :meth:`API.user_timeline` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Post, retrieve, and engage with Tweets|_ | - +------------------------------------------+-------------------------------------+ - | `GET favorites/list`_ | :meth:`API.favorites` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/lookup`_ | :meth:`API.lookup_statuses` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/oembed`_ | :meth:`API.get_oembed` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/retweeters/ids`_ | :meth:`API.retweeters` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/retweets/:id`_ | :meth:`API.retweets` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/retweets_of_me`_ | :meth:`API.retweets_of_me` | - +------------------------------------------+-------------------------------------+ - | `GET statuses/show/:id`_ | :meth:`API.get_status` | - +------------------------------------------+-------------------------------------+ - | `POST favorites/create`_ | :meth:`API.create_favorite` | - +------------------------------------------+-------------------------------------+ - | `POST favorites/destroy`_ | :meth:`API.destroy_favorite` | - +------------------------------------------+-------------------------------------+ - | `POST statuses/destroy/:id`_ | :meth:`API.destroy_status` | - +------------------------------------------+-------------------------------------+ - | `POST statuses/retweet/:id`_ | :meth:`API.retweet` | - +------------------------------------------+-------------------------------------+ - | `POST statuses/unretweet/:id`_ | :meth:`API.unretweet` | - +------------------------------------------+-------------------------------------+ - | `POST statuses/update`_ | :meth:`API.update_status` | - +------------------------------------------+-------------------------------------+ - | `POST statuses/update_with_media`_ | :meth:`API.update_with_media` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Search Tweets|_ | - +------------------------------------------+-------------------------------------+ - | `GET search/tweets`_ | :meth:`API.search` | - +------------------------------------------+-------------------------------------+ - | .. centered:: :ref:`Accounts and users` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Create and manage lists|_ | - +------------------------------------------+-------------------------------------+ - | `GET lists/list`_ | :meth:`API.get_lists` | - +------------------------------------------+-------------------------------------+ - | `GET lists/members`_ | :meth:`API.get_list_members` | - +------------------------------------------+-------------------------------------+ - | `GET lists/members/show`_ | :meth:`API.get_list_member` | - +------------------------------------------+-------------------------------------+ - | `GET lists/memberships`_ | :meth:`API.get_list_memberships` | - +------------------------------------------+-------------------------------------+ - | `GET lists/ownerships`_ | :meth:`API.get_list_ownerships` | - +------------------------------------------+-------------------------------------+ - | `GET lists/show`_ | :meth:`API.get_list` | - +------------------------------------------+-------------------------------------+ - | `GET lists/statuses`_ | :meth:`API.list_timeline` | - +------------------------------------------+-------------------------------------+ - | `GET lists/subscribers`_ | :meth:`API.get_list_subscribers` | - +------------------------------------------+-------------------------------------+ - | `GET lists/subscribers/show`_ | :meth:`API.get_list_subscriber` | - +------------------------------------------+-------------------------------------+ - | `GET lists/subscriptions`_ | :meth:`API.get_list_subscriptions` | - +------------------------------------------+-------------------------------------+ - | `POST lists/create`_ | :meth:`API.create_list` | - +------------------------------------------+-------------------------------------+ - | `POST lists/destroy`_ | :meth:`API.destroy_list` | - +------------------------------------------+-------------------------------------+ - | `POST lists/members/create`_ | :meth:`API.add_list_member` | - +------------------------------------------+-------------------------------------+ - | `POST lists/members/create_all`_ | :meth:`API.add_list_members` | - +------------------------------------------+-------------------------------------+ - | `POST lists/members/destroy`_ | :meth:`API.remove_list_member` | - +------------------------------------------+-------------------------------------+ - | `POST lists/members/destroy_all`_ | :meth:`API.remove_list_members` | - +------------------------------------------+-------------------------------------+ - | `POST lists/subscribers/create`_ | :meth:`API.subscribe_list` | - +------------------------------------------+-------------------------------------+ - | `POST lists/subscribers/destroy`_ | :meth:`API.unsubscribe_list` | - +------------------------------------------+-------------------------------------+ - | `POST lists/update`_ | :meth:`API.update_list` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Follow, search, and get users|_ | - +------------------------------------------+-------------------------------------+ - | `GET followers/ids`_ | :meth:`API.followers_ids` | - +------------------------------------------+-------------------------------------+ - | `GET followers/list`_ | :meth:`API.followers` | - +------------------------------------------+-------------------------------------+ - | `GET friends/ids`_ | :meth:`API.friends_ids` | - +------------------------------------------+-------------------------------------+ - | `GET friends/list`_ | :meth:`API.friends` | - +------------------------------------------+-------------------------------------+ - | `GET friendships/incoming`_ | :meth:`API.friendships_incoming` | - +------------------------------------------+-------------------------------------+ - | `GET friendships/lookup`_ | :meth:`API.lookup_friendships` | - +------------------------------------------+-------------------------------------+ - | `GET friendships/no_retweets/ids`_ | :meth:`API.no_retweets_friendships` | - +------------------------------------------+-------------------------------------+ - | `GET friendships/outgoing`_ | :meth:`API.friendships_outgoing` | - +------------------------------------------+-------------------------------------+ - | `GET friendships/show`_ | :meth:`API.get_friendship` | - +------------------------------------------+-------------------------------------+ - | `GET users/lookup`_ | :meth:`API.lookup_users` | - +------------------------------------------+-------------------------------------+ - | `GET users/search`_ | :meth:`API.search_users` | - +------------------------------------------+-------------------------------------+ - | `GET users/show`_ | :meth:`API.get_user` | - +------------------------------------------+-------------------------------------+ - | `POST friendships/create`_ | :meth:`API.create_friendship` | - +------------------------------------------+-------------------------------------+ - | `POST friendships/destroy`_ | :meth:`API.destroy_friendship` | - +------------------------------------------+-------------------------------------+ - | `POST friendships/update`_ | :meth:`API.update_friendship` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Manage account settings and profile|_ | - +------------------------------------------+-------------------------------------+ - | `GET account/settings`_ | :meth:`API.get_settings` | - +------------------------------------------+-------------------------------------+ - | `GET account/verify_credentials`_ | :meth:`API.verify_credentials` | - +------------------------------------------+-------------------------------------+ - | `GET saved_searches/list`_ | :meth:`API.get_saved_searches` | - +------------------------------------------+-------------------------------------+ - | `GET saved_searches/show/:id`_ | :meth:`API.get_saved_search` | - +------------------------------------------+-------------------------------------+ - | `GET users/profile_banner`_ | :meth:`API.get_profile_banner` | - +------------------------------------------+-------------------------------------+ - | `POST account/remove_profile_banner`_ | :meth:`API.remove_profile_banner` | - +------------------------------------------+-------------------------------------+ - | `POST account/settings`_ | :meth:`API.set_settings` | - +------------------------------------------+-------------------------------------+ - | `POST account/update_profile`_ | :meth:`API.update_profile` | - +------------------------------------------+-------------------------------------+ - | `POST account/update_profile_banner`_ | :meth:`API.update_profile_banner` | - +------------------------------------------+-------------------------------------+ - | `POST account/update_profile_image`_ | :meth:`API.update_profile_image` | - +------------------------------------------+-------------------------------------+ - | `POST saved_searches/create`_ | :meth:`API.create_saved_search` | - +------------------------------------------+-------------------------------------+ - | `POST saved_searches/destroy/:id`_ | :meth:`API.destroy_saved_search` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Mute, block, and report users|_ | - +------------------------------------------+-------------------------------------+ - | `GET blocks/ids`_ | :meth:`API.blocks_ids` | - +------------------------------------------+-------------------------------------+ - | `GET blocks/list`_ | :meth:`API.blocks` | - +------------------------------------------+-------------------------------------+ - | `GET mutes/users/ids`_ | :meth:`API.mutes_ids` | - +------------------------------------------+-------------------------------------+ - | `GET mutes/users/list`_ | :meth:`API.mutes` | - +------------------------------------------+-------------------------------------+ - | `POST blocks/create`_ | :meth:`API.create_block` | - +------------------------------------------+-------------------------------------+ - | `POST blocks/destroy`_ | :meth:`API.destroy_block` | - +------------------------------------------+-------------------------------------+ - | `POST mutes/users/create`_ | :meth:`API.create_mute` | - +------------------------------------------+-------------------------------------+ - | `POST mutes/users/destroy`_ | :meth:`API.destroy_mute` | - +------------------------------------------+-------------------------------------+ - | `POST users/report_spam`_ | :meth:`API.report_spam` | - +------------------------------------------+-------------------------------------+ - | .. centered:: :ref:`Direct Messages` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Sending and receiving events|_ | - +------------------------------------------+-------------------------------------+ - | `DELETE direct_messages/events/destroy`_ | :meth:`API.delete_direct_message` | - +------------------------------------------+-------------------------------------+ - | `GET direct_messages/events/list`_ | :meth:`API.get_direct_messages` | - +------------------------------------------+-------------------------------------+ - | `GET direct_messages/events/show`_ | :meth:`API.get_direct_message` | - +------------------------------------------+-------------------------------------+ - | `POST direct_messages/events/new`_ | :meth:`API.send_direct_message` | - +------------------------------------------+-------------------------------------+ - | .. centered:: :ref:`Media` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Upload media|_ | - +------------------------------------------+-------------------------------------+ - | `GET media/upload`_ | :meth:`API.get_media_upload_status` | - +------------------------------------------+-------------------------------------+ - | `POST media/metadata/create`_ | :meth:`API.create_media_metadata` | - +------------------------------------------+-------------------------------------+ - | | :meth:`API.media_upload` | - +------------------------------------------+-------------------------------------+ - | `POST media/upload`_ | :meth:`API.simple_upload` | - +------------------------------------------+-------------------------------------+ - | | :meth:`API.chunked_upload` | - +------------------------------------------+-------------------------------------+ - | `POST media/upload (APPEND)`_ | :meth:`API.chunked_upload_append` | - +------------------------------------------+-------------------------------------+ - | `POST media/upload (FINALIZE)`_ | :meth:`API.chunked_upload_finalize` | - +------------------------------------------+-------------------------------------+ - | `POST media/upload (INIT)`_ | :meth:`API.chunked_upload_init` | - +------------------------------------------+-------------------------------------+ - | .. centered:: :ref:`Trends` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get locations with trending topics|_ | - +------------------------------------------+-------------------------------------+ - | `GET trends/available`_ | :meth:`API.trends_available` | - +------------------------------------------+-------------------------------------+ - | `GET trends/closest`_ | :meth:`API.trends_closest` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get trends near a location|_ | - +------------------------------------------+-------------------------------------+ - | `GET trends/place`_ | :meth:`API.trends_place` | - +------------------------------------------+-------------------------------------+ - | .. centered:: :ref:`Geo` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get information about a place|_ | - +------------------------------------------+-------------------------------------+ - | `GET geo/id/:place_id`_ | :meth:`API.geo_id` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get places near a location|_ | - +------------------------------------------+-------------------------------------+ - | `GET geo/reverse_geocode`_ | :meth:`API.reverse_geocode` | - +------------------------------------------+-------------------------------------+ - | `GET geo/search`_ | :meth:`API.search_geo` | - +------------------------------------------+-------------------------------------+ - | .. centered:: :ref:`Developer utilities` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get Twitter configuration details|_ | - +------------------------------------------+-------------------------------------+ - | `GET help/configuration`_ | :meth:`API.configuration` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get Twitter supported languages|_ | - +------------------------------------------+-------------------------------------+ - | `GET help/languages`_ | :meth:`API.supported_languages` | - +------------------------------------------+-------------------------------------+ - | .. centered:: |Get app rate limit status|_ | - +------------------------------------------+-------------------------------------+ - | `GET application/rate_limit_status`_ | :meth:`API.rate_limit_status` | - +------------------------------------------+-------------------------------------+ + +------------------------------------------+--------------------------------------+ + | Twitter API v1.1 Endpoint | :class:`API` Method | + +==========================================+======================================+ + | .. centered:: :ref:`Premium Search APIs` | + +------------------------------------------+--------------------------------------+ + | `GET search/30day/:label`_ | :meth:`API.search_30_day` | + +------------------------------------------+--------------------------------------+ + | `GET search/fullarchive/:label`_ | :meth:`API.search_full_archive` | + +------------------------------------------+--------------------------------------+ + | .. centered:: :ref:`Tweets` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get Tweet timelines|_ | + +------------------------------------------+--------------------------------------+ + | `GET statuses/home_timeline`_ | :meth:`API.home_timeline` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/mentions_timeline`_ | :meth:`API.mentions_timeline` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/user_timeline`_ | :meth:`API.user_timeline` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Post, retrieve, and engage with Tweets|_ | + +------------------------------------------+--------------------------------------+ + | `GET favorites/list`_ | :meth:`API.favorites` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/lookup`_ | :meth:`API.lookup_statuses` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/oembed`_ | :meth:`API.get_oembed` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/retweeters/ids`_ | :meth:`API.retweeters` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/retweets/:id`_ | :meth:`API.retweets` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/retweets_of_me`_ | :meth:`API.retweets_of_me` | + +------------------------------------------+--------------------------------------+ + | `GET statuses/show/:id`_ | :meth:`API.get_status` | + +------------------------------------------+--------------------------------------+ + | `POST favorites/create`_ | :meth:`API.create_favorite` | + +------------------------------------------+--------------------------------------+ + | `POST favorites/destroy`_ | :meth:`API.destroy_favorite` | + +------------------------------------------+--------------------------------------+ + | `POST statuses/destroy/:id`_ | :meth:`API.destroy_status` | + +------------------------------------------+--------------------------------------+ + | `POST statuses/retweet/:id`_ | :meth:`API.retweet` | + +------------------------------------------+--------------------------------------+ + | `POST statuses/unretweet/:id`_ | :meth:`API.unretweet` | + +------------------------------------------+--------------------------------------+ + | `POST statuses/update`_ | :meth:`API.update_status` | + +------------------------------------------+--------------------------------------+ + | `POST statuses/update_with_media`_ | :meth:`API.update_status_with_media` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Search Tweets|_ | + +------------------------------------------+--------------------------------------+ + | `GET search/tweets`_ | :meth:`API.search` | + +------------------------------------------+--------------------------------------+ + | .. centered:: :ref:`Accounts and users` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Create and manage lists|_ | + +------------------------------------------+--------------------------------------+ + | `GET lists/list`_ | :meth:`API.get_lists` | + +------------------------------------------+--------------------------------------+ + | `GET lists/members`_ | :meth:`API.get_list_members` | + +------------------------------------------+--------------------------------------+ + | `GET lists/members/show`_ | :meth:`API.get_list_member` | + +------------------------------------------+--------------------------------------+ + | `GET lists/memberships`_ | :meth:`API.get_list_memberships` | + +------------------------------------------+--------------------------------------+ + | `GET lists/ownerships`_ | :meth:`API.get_list_ownerships` | + +------------------------------------------+--------------------------------------+ + | `GET lists/show`_ | :meth:`API.get_list` | + +------------------------------------------+--------------------------------------+ + | `GET lists/statuses`_ | :meth:`API.list_timeline` | + +------------------------------------------+--------------------------------------+ + | `GET lists/subscribers`_ | :meth:`API.get_list_subscribers` | + +------------------------------------------+--------------------------------------+ + | `GET lists/subscribers/show`_ | :meth:`API.get_list_subscriber` | + +------------------------------------------+--------------------------------------+ + | `GET lists/subscriptions`_ | :meth:`API.get_list_subscriptions` | + +------------------------------------------+--------------------------------------+ + | `POST lists/create`_ | :meth:`API.create_list` | + +------------------------------------------+--------------------------------------+ + | `POST lists/destroy`_ | :meth:`API.destroy_list` | + +------------------------------------------+--------------------------------------+ + | `POST lists/members/create`_ | :meth:`API.add_list_member` | + +------------------------------------------+--------------------------------------+ + | `POST lists/members/create_all`_ | :meth:`API.add_list_members` | + +------------------------------------------+--------------------------------------+ + | `POST lists/members/destroy`_ | :meth:`API.remove_list_member` | + +------------------------------------------+--------------------------------------+ + | `POST lists/members/destroy_all`_ | :meth:`API.remove_list_members` | + +------------------------------------------+--------------------------------------+ + | `POST lists/subscribers/create`_ | :meth:`API.subscribe_list` | + +------------------------------------------+--------------------------------------+ + | `POST lists/subscribers/destroy`_ | :meth:`API.unsubscribe_list` | + +------------------------------------------+--------------------------------------+ + | `POST lists/update`_ | :meth:`API.update_list` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Follow, search, and get users|_ | + +------------------------------------------+--------------------------------------+ + | `GET followers/ids`_ | :meth:`API.followers_ids` | + +------------------------------------------+--------------------------------------+ + | `GET followers/list`_ | :meth:`API.followers` | + +------------------------------------------+--------------------------------------+ + | `GET friends/ids`_ | :meth:`API.friends_ids` | + +------------------------------------------+--------------------------------------+ + | `GET friends/list`_ | :meth:`API.friends` | + +------------------------------------------+--------------------------------------+ + | `GET friendships/incoming`_ | :meth:`API.friendships_incoming` | + +------------------------------------------+--------------------------------------+ + | `GET friendships/lookup`_ | :meth:`API.lookup_friendships` | + +------------------------------------------+--------------------------------------+ + | `GET friendships/no_retweets/ids`_ | :meth:`API.no_retweets_friendships` | + +------------------------------------------+--------------------------------------+ + | `GET friendships/outgoing`_ | :meth:`API.friendships_outgoing` | + +------------------------------------------+--------------------------------------+ + | `GET friendships/show`_ | :meth:`API.get_friendship` | + +------------------------------------------+--------------------------------------+ + | `GET users/lookup`_ | :meth:`API.lookup_users` | + +------------------------------------------+--------------------------------------+ + | `GET users/search`_ | :meth:`API.search_users` | + +------------------------------------------+--------------------------------------+ + | `GET users/show`_ | :meth:`API.get_user` | + +------------------------------------------+--------------------------------------+ + | `POST friendships/create`_ | :meth:`API.create_friendship` | + +------------------------------------------+--------------------------------------+ + | `POST friendships/destroy`_ | :meth:`API.destroy_friendship` | + +------------------------------------------+--------------------------------------+ + | `POST friendships/update`_ | :meth:`API.update_friendship` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Manage account settings and profile|_ | + +------------------------------------------+--------------------------------------+ + | `GET account/settings`_ | :meth:`API.get_settings` | + +------------------------------------------+--------------------------------------+ + | `GET account/verify_credentials`_ | :meth:`API.verify_credentials` | + +------------------------------------------+--------------------------------------+ + | `GET saved_searches/list`_ | :meth:`API.get_saved_searches` | + +------------------------------------------+--------------------------------------+ + | `GET saved_searches/show/:id`_ | :meth:`API.get_saved_search` | + +------------------------------------------+--------------------------------------+ + | `GET users/profile_banner`_ | :meth:`API.get_profile_banner` | + +------------------------------------------+--------------------------------------+ + | `POST account/remove_profile_banner`_ | :meth:`API.remove_profile_banner` | + +------------------------------------------+--------------------------------------+ + | `POST account/settings`_ | :meth:`API.set_settings` | + +------------------------------------------+--------------------------------------+ + | `POST account/update_profile`_ | :meth:`API.update_profile` | + +------------------------------------------+--------------------------------------+ + | `POST account/update_profile_banner`_ | :meth:`API.update_profile_banner` | + +------------------------------------------+--------------------------------------+ + | `POST account/update_profile_image`_ | :meth:`API.update_profile_image` | + +------------------------------------------+--------------------------------------+ + | `POST saved_searches/create`_ | :meth:`API.create_saved_search` | + +------------------------------------------+--------------------------------------+ + | `POST saved_searches/destroy/:id`_ | :meth:`API.destroy_saved_search` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Mute, block, and report users|_ | + +------------------------------------------+--------------------------------------+ + | `GET blocks/ids`_ | :meth:`API.blocks_ids` | + +------------------------------------------+--------------------------------------+ + | `GET blocks/list`_ | :meth:`API.blocks` | + +------------------------------------------+--------------------------------------+ + | `GET mutes/users/ids`_ | :meth:`API.mutes_ids` | + +------------------------------------------+--------------------------------------+ + | `GET mutes/users/list`_ | :meth:`API.mutes` | + +------------------------------------------+--------------------------------------+ + | `POST blocks/create`_ | :meth:`API.create_block` | + +------------------------------------------+--------------------------------------+ + | `POST blocks/destroy`_ | :meth:`API.destroy_block` | + +------------------------------------------+--------------------------------------+ + | `POST mutes/users/create`_ | :meth:`API.create_mute` | + +------------------------------------------+--------------------------------------+ + | `POST mutes/users/destroy`_ | :meth:`API.destroy_mute` | + +------------------------------------------+--------------------------------------+ + | `POST users/report_spam`_ | :meth:`API.report_spam` | + +------------------------------------------+--------------------------------------+ + | .. centered:: :ref:`Direct Messages` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Sending and receiving events|_ | + +------------------------------------------+--------------------------------------+ + | `DELETE direct_messages/events/destroy`_ | :meth:`API.delete_direct_message` | + +------------------------------------------+--------------------------------------+ + | `GET direct_messages/events/list`_ | :meth:`API.get_direct_messages` | + +------------------------------------------+--------------------------------------+ + | `GET direct_messages/events/show`_ | :meth:`API.get_direct_message` | + +------------------------------------------+--------------------------------------+ + | `POST direct_messages/events/new`_ | :meth:`API.send_direct_message` | + +------------------------------------------+--------------------------------------+ + | .. centered:: :ref:`Media` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Upload media|_ | + +------------------------------------------+--------------------------------------+ + | `GET media/upload`_ | :meth:`API.get_media_upload_status` | + +------------------------------------------+--------------------------------------+ + | `POST media/metadata/create`_ | :meth:`API.create_media_metadata` | + +------------------------------------------+--------------------------------------+ + | | :meth:`API.media_upload` | + +------------------------------------------+--------------------------------------+ + | `POST media/upload`_ | :meth:`API.simple_upload` | + +------------------------------------------+--------------------------------------+ + | | :meth:`API.chunked_upload` | + +------------------------------------------+--------------------------------------+ + | `POST media/upload (APPEND)`_ | :meth:`API.chunked_upload_append` | + +------------------------------------------+--------------------------------------+ + | `POST media/upload (FINALIZE)`_ | :meth:`API.chunked_upload_finalize` | + +------------------------------------------+--------------------------------------+ + | `POST media/upload (INIT)`_ | :meth:`API.chunked_upload_init` | + +------------------------------------------+--------------------------------------+ + | .. centered:: :ref:`Trends` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get locations with trending topics|_ | + +------------------------------------------+--------------------------------------+ + | `GET trends/available`_ | :meth:`API.trends_available` | + +------------------------------------------+--------------------------------------+ + | `GET trends/closest`_ | :meth:`API.trends_closest` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get trends near a location|_ | + +------------------------------------------+--------------------------------------+ + | `GET trends/place`_ | :meth:`API.trends_place` | + +------------------------------------------+--------------------------------------+ + | .. centered:: :ref:`Geo` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get information about a place|_ | + +------------------------------------------+--------------------------------------+ + | `GET geo/id/:place_id`_ | :meth:`API.geo_id` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get places near a location|_ | + +------------------------------------------+--------------------------------------+ + | `GET geo/reverse_geocode`_ | :meth:`API.reverse_geocode` | + +------------------------------------------+--------------------------------------+ + | `GET geo/search`_ | :meth:`API.search_geo` | + +------------------------------------------+--------------------------------------+ + | .. centered:: :ref:`Developer utilities` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get Twitter configuration details|_ | + +------------------------------------------+--------------------------------------+ + | `GET help/configuration`_ | :meth:`API.configuration` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get Twitter supported languages|_ | + +------------------------------------------+--------------------------------------+ + | `GET help/languages`_ | :meth:`API.supported_languages` | + +------------------------------------------+--------------------------------------+ + | .. centered:: |Get app rate limit status|_ | + +------------------------------------------+--------------------------------------+ + | `GET application/rate_limit_status`_ | :meth:`API.rate_limit_status` | + +------------------------------------------+--------------------------------------+ .. _GET search/30day/:label: https://developer.twitter.com/en/docs/twitter-api/premium/search-api/api-reference/premium-search .. _GET search/fullarchive/:label: https://developer.twitter.com/en/docs/twitter-api/premium/search-api/api-reference/premium-search @@ -416,7 +416,7 @@ Post, retrieve, and engage with Tweets .. automethod:: API.update_status -.. automethod:: API.update_with_media +.. automethod:: API.update_status_with_media Search Tweets ------------- diff --git a/tests/test_api.py b/tests/test_api.py index 066a2e62c..2a2039c3b 100644 --- a/tests/test_api.py +++ b/tests/test_api.py @@ -97,7 +97,7 @@ def testupdateanddestroystatuswithoutkwarg(self): @tape.use_cassette('testupdatestatuswithmedia.yaml', serializer='yaml') def testupdatestatuswithmedia(self): - update = self.api.update_with_media(tweet_text, 'examples/banner.png') + update = self.api.update_status_with_media(tweet_text, 'examples/banner.png') self.assertIn(tweet_text + ' https://t.co', update.text) @tape.use_cassette('testmediauploadpng.yaml', serializer='yaml') diff --git a/tweepy/api.py b/tweepy/api.py index 43ea11043..0f04d84b1 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -1129,8 +1129,9 @@ def update_status(self, status, **kwargs): ) @payload('status') - def update_with_media(self, status, filename, *, file=None, **kwargs): - """update_with_media( \ + def update_status_with_media(self, status, filename, *, file=None, + **kwargs): + """update_status_with_media( \ status, filename, *, file, possibly_sensitive, \ in_reply_to_status_id, lat, long, place_id, display_coordinates \ )