Add reverse as allowed parameter for API.lists_all
authorHarmon <Harmon758@gmail.com>
Wed, 4 Sep 2019 06:23:12 +0000 (01:23 -0500)
committerHarmon <Harmon758@gmail.com>
Wed, 4 Sep 2019 06:23:12 +0000 (01:23 -0500)
docs/api.rst
tweepy/api.py

index fd775482352ae8bc1493995118c4395a46a39d68..0e209e032b83f14f0061b97b5480f1e6a65ebf7a 100644 (file)
@@ -811,7 +811,7 @@ List Methods
    :rtype: :class:`List` object
 
 
-.. method:: API.lists_all([screen_name], [user_id])
+.. method:: API.lists_all([screen_name], [user_id], [reverse])
 
    Returns all lists the authenticating or specified user subscribes to,
    including their own. The user is specified using the ``user_id`` or
@@ -821,10 +821,15 @@ List Methods
    A maximum of 100 results will be returned by this call. Subscribed lists are
    returned first, followed by owned lists. This means that if a user
    subscribes to 90 lists and owns 20 lists, this method returns 90
-   subscriptions and 10 owned lists.
+   subscriptions and 10 owned lists. The ``reverse`` method returns owned lists
+   first, so with ``reverse=true``, 20 owned lists and 80 subscriptions would
+   be returned.
 
    :param screen_name: |screen_name|
    :param user_id: |user_id|
+   :param reverse: A boolean indicating if you would like owned lists to be
+                   returned first. See description above for information on how
+                   this parameter works.
    :rtype: list of :class:`List` objects
 
 
index 116523f39e3a4215089b77c2048a963f52184692..46ee22b2237c26e9e16b4b0b15579733a50f9fed 100644 (file)
@@ -1000,13 +1000,13 @@ class API(object):
     @property
     def lists_all(self):
         """ :reference: https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
-            :allowed_param: 'screen_name', 'user_id'
+            :allowed_param: 'screen_name', 'user_id', 'reverse'
         """
         return bind_api(
             api=self,
             path='/lists/list.json',
             payload_type='list', payload_list=True,
-            allowed_param=['screen_name', 'user_id'],
+            allowed_param=['screen_name', 'user_id', 'reverse'],
             require_auth=True
         )