api.py 47.5 KB
Newer Older
1
# Tweepy
2 3
# Copyright 2009-2010 Joshua Roesslein
# See LICENSE for details.
4

Mark Smith's avatar
Mark Smith committed
5 6
from __future__ import print_function

7 8 9
import os
import mimetypes

Mark Smith's avatar
Mark Smith committed
10 11
import six

Josh Roesslein's avatar
Josh Roesslein committed
12 13
from tweepy.binder import bind_api
from tweepy.error import TweepError
14
from tweepy.parsers import ModelParser, Parser
15
from tweepy.utils import list_to_csv
16

Josh Roesslein's avatar
Josh Roesslein committed
17

18
class API(object):
Josh Roesslein's avatar
Josh Roesslein committed
19 20
    """Twitter API"""

21
    def __init__(self, auth_handler=None,
22
                 host='api.twitter.com', search_host='search.twitter.com',
Florent Espanet's avatar
Florent Espanet committed
23 24 25 26
                 upload_host='upload.twitter.com', cache=None, api_root='/1.1',
                 search_root='', upload_root='/1.1', retry_count=0,
                 retry_delay=0, retry_errors=None, timeout=60, parser=None,
                 compression=False, wait_on_rate_limit=False,
27 28 29 30 31 32
                 wait_on_rate_limit_notify=False, proxy=''):
        """ Api instance Constructor

        :param auth_handler:
        :param host:  url of the server of the rest api, default:'api.twitter.com'
        :param search_host: url of the search server, default:'search.twitter.com'
Florent Espanet's avatar
Florent Espanet committed
33
        :param upload_host: url of the upload server, default:'upload.twitter.com'
34 35 36
        :param cache: Cache to query if a GET method is used, default:None
        :param api_root: suffix of the api version, default:'/1.1'
        :param search_root: suffix of the search version, default:''
Florent Espanet's avatar
Florent Espanet committed
37
        :param upload_root: suffix of the upload version, default:'/1.1'
38 39 40 41 42 43 44 45 46 47 48 49
        :param retry_count: number of allowed retries, default:0
        :param retry_delay: delay in second between retries, default:0
        :param retry_errors: default:None
        :param timeout: delay before to consider the request as timed out in seconds, default:60
        :param parser: ModelParser instance to parse the responses, default:None
        :param compression: If the response is compressed, default:False
        :param wait_on_rate_limit: If the api wait when it hits the rate limit, default:False
        :param wait_on_rate_limit_notify: If the api print a notification when the rate limit is hit, default:False
        :param proxy: Url to use as proxy during the HTTP request, default:''

        :raise TypeError: If the given parser is not a ModelParser instance.
        """
Josh Roesslein's avatar
Josh Roesslein committed
50
        self.auth = auth_handler
Josh Roesslein's avatar
Josh Roesslein committed
51
        self.host = host
52
        self.search_host = search_host
Florent Espanet's avatar
Florent Espanet committed
53
        self.upload_host = upload_host
Josh Roesslein's avatar
Josh Roesslein committed
54
        self.api_root = api_root
55
        self.search_root = search_root
Florent Espanet's avatar
Florent Espanet committed
56
        self.upload_root = upload_root
Josh Roesslein's avatar
Josh Roesslein committed
57
        self.cache = cache
Mike's avatar
Mike committed
58
        self.compression = compression
59 60
        self.retry_count = retry_count
        self.retry_delay = retry_delay
61
        self.retry_errors = retry_errors
62
        self.timeout = timeout
63
        self.wait_on_rate_limit = wait_on_rate_limit
64
        self.wait_on_rate_limit_notify = wait_on_rate_limit_notify
65
        self.parser = parser or ModelParser()
Aaron Hill's avatar
Aaron Hill committed
66 67 68
        self.proxy = {}
        if proxy:
            self.proxy['https'] = proxy
Josh Roesslein's avatar
Josh Roesslein committed
69

70 71 72 73 74 75
        # Attempt to explain more clearly the parser argument requirements
        # https://github.com/tweepy/tweepy/issues/421
        #
        parser_type = Parser
        if not isinstance(self.parser, parser_type):
            raise TypeError(
Mark Smith's avatar
Mark Smith committed
76 77 78 79 80
                '"parser" argument has to be an instance of "{required}".'
                ' It is currently a {actual}.'.format(
                    required=parser_type.__name__,
                    actual=type(self.parser)
                )
81
            )
Josh Roesslein's avatar
Josh Roesslein committed
82

83 84
    @property
    def home_timeline(self):
85
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/home_timeline
86 87 88 89 90 91 92 93 94 95
            :allowed_param:'since_id', 'max_id', 'count'
        """
        return bind_api(
            api=self,
            path='/statuses/home_timeline.json',
            payload_type='status', payload_list=True,
            allowed_param=['since_id', 'max_id', 'count'],
            require_auth=True
        )

Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
96
    def statuses_lookup(self, id_, include_entities=None,
97
                        trim_user=None, map_=None, tweet_mode=None):
98
        return self._statuses_lookup(list_to_csv(id_), include_entities,
99
                                     trim_user, map_, tweet_mode)
100 101 102

    @property
    def _statuses_lookup(self):
103
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/lookup
104
            :allowed_param:'id', 'include_entities', 'trim_user', 'map', 'tweet_mode'
105 106 107 108 109
        """
        return bind_api(
            api=self,
            path='/statuses/lookup.json',
            payload_type='status', payload_list=True,
110
            allowed_param=['id', 'include_entities', 'trim_user', 'map', 'tweet_mode'],
111 112 113 114 115
            require_auth=True
        )

    @property
    def user_timeline(self):
116
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/user_timeline
117
            :allowed_param:'id', 'user_id', 'screen_name', 'since_id', 'max_id', 'count', 'include_rts'
118 119 120 121 122 123 124 125 126 127 128
        """
        return bind_api(
            api=self,
            path='/statuses/user_timeline.json',
            payload_type='status', payload_list=True,
            allowed_param=['id', 'user_id', 'screen_name', 'since_id',
                           'max_id', 'count', 'include_rts']
        )

    @property
    def mentions_timeline(self):
129
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/mentions_timeline
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
            :allowed_param:'since_id', 'max_id', 'count'
        """
        return bind_api(
            api=self,
            path='/statuses/mentions_timeline.json',
            payload_type='status', payload_list=True,
            allowed_param=['since_id', 'max_id', 'count'],
            require_auth=True
        )

    @property
    def related_results(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/get/related_results/show/%3id.format
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/related_results/show/{id}.json',
            payload_type='relation', payload_list=True,
            allowed_param=['id'],
            require_auth=False
        )

    @property
    def retweets_of_me(self):
155
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/retweets_of_me
156 157 158 159 160 161 162 163 164 165 166 167
            :allowed_param:'since_id', 'max_id', 'count'
        """
        return bind_api(
            api=self,
            path='/statuses/retweets_of_me.json',
            payload_type='status', payload_list=True,
            allowed_param=['since_id', 'max_id', 'count'],
            require_auth=True
        )

    @property
    def get_status(self):
168 169
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/show/%3Aid
            :allowed_param:'id'
170 171 172 173 174 175 176 177
        """
        return bind_api(
            api=self,
            path='/statuses/show.json',
            payload_type='status',
            allowed_param=['id']
        )

178
    def update_status(self, *args, **kwargs):
179
        """ :reference: https://dev.twitter.com/rest/reference/post/statuses/update
180
            :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'
181
        """
182
        post_data = {}
183
        media_ids = kwargs.pop("media_ids", None)
184 185
        if media_ids is not None:
            post_data["media_ids"] = list_to_csv(media_ids)
Namwoo Kim's avatar
Namwoo Kim committed
186

187 188 189 190 191
        return bind_api(
            api=self,
            path='/statuses/update.json',
            method='POST',
            payload_type='status',
192
            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'],
193
            require_auth=True
194
        )(post_data=post_data, *args, **kwargs)
195

Florent Espanet's avatar
Florent Espanet committed
196 197 198 199 200
    def media_upload(self, filename, *args, **kwargs):
        """ :reference: https://dev.twitter.com/rest/reference/post/media/upload
            :allowed_param:
        """
        f = kwargs.pop('file', None)
201
        headers, post_data = API._pack_image(filename, 4883, form_field='media', f=f)
Florent Espanet's avatar
Florent Espanet committed
202 203 204 205 206 207 208 209 210 211 212 213
        kwargs.update({'headers': headers, 'post_data': post_data})

        return bind_api(
            api=self,
            path='/media/upload.json',
            method='POST',
            payload_type='media',
            allowed_param=[],
            require_auth=True,
            upload_api=True
        )(*args, **kwargs)

214
    def update_with_media(self, filename, *args, **kwargs):
215
        """ :reference: https://dev.twitter.com/rest/reference/post/statuses/update_with_media
216
            :allowed_param:'status', 'possibly_sensitive', 'in_reply_to_status_id', 'in_reply_to_status_id_str', 'auto_populate_reply_metadata', 'lat', 'long', 'place_id', 'display_coordinates'
217
        """
218 219
        f = kwargs.pop('file', None)
        headers, post_data = API._pack_image(filename, 3072, form_field='media[]', f=f)
220 221 222
        kwargs.update({'headers': headers, 'post_data': post_data})

        return bind_api(
223
            api=self,
224
            path='/statuses/update_with_media.json',
225
            method='POST',
226
            payload_type='status',
227
            allowed_param=[
228 229
                'status', 'possibly_sensitive', 'in_reply_to_status_id', 'in_reply_to_status_id_str',
                'auto_populate_reply_metadata', 'lat', 'long', 'place_id', 'display_coordinates'
230 231
            ],
            require_auth=True
Aaron Hill's avatar
Aaron Hill committed
232
        )(*args, **kwargs)
233

234 235
    @property
    def destroy_status(self):
236
        """ :reference: https://dev.twitter.com/rest/reference/post/statuses/destroy/%3Aid
237 238 239 240 241 242 243 244 245 246 247 248 249
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/statuses/destroy/{id}.json',
            method='POST',
            payload_type='status',
            allowed_param=['id'],
            require_auth=True
        )

    @property
    def retweet(self):
250
        """ :reference: https://dev.twitter.com/rest/reference/post/statuses/retweet/%3Aid
251 252 253 254 255 256 257 258 259 260 261
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/statuses/retweet/{id}.json',
            method='POST',
            payload_type='status',
            allowed_param=['id'],
            require_auth=True
        )

legokichi's avatar
legokichi committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275
    @property
    def unretweet(self):
        """ :reference: https://dev.twitter.com/rest/reference/post/statuses/unretweet/%3Aid
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/statuses/unretweet/{id}.json',
            method='POST',
            payload_type='status',
            allowed_param=['id'],
            require_auth=True
        )

276 277
    @property
    def retweets(self):
278
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/retweets/%3Aid
279 280 281 282 283 284 285 286 287 288 289 290
            :allowed_param:'id', 'count'
        """
        return bind_api(
            api=self,
            path='/statuses/retweets/{id}.json',
            payload_type='status', payload_list=True,
            allowed_param=['id', 'count'],
            require_auth=True
        )

    @property
    def retweeters(self):
291
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/retweeters/ids
292 293 294 295 296 297 298 299 300 301 302
            :allowed_param:'id', 'cursor', 'stringify_ids
        """
        return bind_api(
            api=self,
            path='/statuses/retweeters/ids.json',
            payload_type='ids',
            allowed_param=['id', 'cursor', 'stringify_ids']
        )

    @property
    def get_user(self):
303 304
        """ :reference: https://dev.twitter.com/rest/reference/get/users/show
            :allowed_param:'id', 'user_id', 'screen_name'
305 306 307 308 309 310 311 312 313 314
        """
        return bind_api(
            api=self,
            path='/users/show.json',
            payload_type='user',
            allowed_param=['id', 'user_id', 'screen_name']
        )

    @property
    def get_oembed(self):
315 316
        """ :reference: https://dev.twitter.com/rest/reference/get/statuses/oembed
            :allowed_param:'id', 'url', 'maxwidth', 'hide_media', 'omit_script', 'align', 'related', 'lang'
317 318 319 320 321 322 323 324
        """
        return bind_api(
            api=self,
            path='/statuses/oembed.json',
            payload_type='json',
            allowed_param=['id', 'url', 'maxwidth', 'hide_media', 'omit_script', 'align', 'related', 'lang']
        )

chebee7i's avatar
chebee7i committed
325
    def lookup_users(self, user_ids=None, screen_names=None, include_entities=None):
326
        """ Perform bulk look up of users from user ID or screenname """
chebee7i's avatar
chebee7i committed
327 328 329 330 331 332 333 334 335 336
        post_data = {}
        if include_entities is not None:
            include_entities = 'true' if include_entities else 'false'
            post_data['include_entities'] = include_entities
        if user_ids:
            post_data['user_id'] = list_to_csv(user_ids)
        if screen_names:
            post_data['screen_name'] = list_to_csv(screen_names)

        return self._lookup_users(post_data=post_data)
337

338 339
    @property
    def _lookup_users(self):
340
        """ :reference: https://dev.twitter.com/rest/reference/get/users/lookup
chebee7i's avatar
chebee7i committed
341
            allowed_param='user_id', 'screen_name', 'include_entities'
342 343 344 345 346
        """
        return bind_api(
            api=self,
            path='/users/lookup.json',
            payload_type='user', payload_list=True,
chebee7i's avatar
chebee7i committed
347
            method='POST',
348
            allowed_param=['user_id', 'screen_name', 'include_entities']
349
        )
350

Josh Roesslein's avatar
Josh Roesslein committed
351
    def me(self):
352
        """ Get the authenticated user """
Josh Roesslein's avatar
Josh Roesslein committed
353
        return self.get_user(screen_name=self.auth.get_username())
Josh Roesslein's avatar
Josh Roesslein committed
354

355 356
    @property
    def search_users(self):
357
        """ :reference: https://dev.twitter.com/rest/reference/get/users/search
358 359 360 361 362 363 364 365 366 367 368 369
            :allowed_param:'q', 'count', 'page'
        """
        return bind_api(
            api=self,
            path='/users/search.json',
            payload_type='user', payload_list=True,
            require_auth=True,
            allowed_param=['q', 'count', 'page']
        )

    @property
    def suggested_users(self):
370 371
        """ :reference: https://dev.twitter.com/rest/reference/get/users/suggestions/%3Aslug
            :allowed_param:'slug', 'lang'
372 373 374 375 376 377 378 379 380 381 382
        """
        return bind_api(
            api=self,
            path='/users/suggestions/{slug}.json',
            payload_type='user', payload_list=True,
            require_auth=True,
            allowed_param=['slug', 'lang']
        )

    @property
    def suggested_categories(self):
383
        """ :reference: https://dev.twitter.com/rest/reference/get/users/suggestions
384 385 386 387 388 389 390 391 392 393 394 395
            :allowed_param:'lang'
        """
        return bind_api(
            api=self,
            path='/users/suggestions.json',
            payload_type='category', payload_list=True,
            allowed_param=['lang'],
            require_auth=True
        )

    @property
    def suggested_users_tweets(self):
396
        """ :reference: https://dev.twitter.com/rest/reference/get/users/suggestions/%3Aslug/members
397 398 399 400 401 402 403 404 405 406 407 408
            :allowed_param:'slug'
        """
        return bind_api(
            api=self,
            path='/users/suggestions/{slug}/members.json',
            payload_type='status', payload_list=True,
            allowed_param=['slug'],
            require_auth=True
        )

    @property
    def direct_messages(self):
409
        """ :reference: https://dev.twitter.com/rest/reference/get/direct_messages
410
            :allowed_param:'since_id', 'max_id', 'count', 'full_text'
411 412 413 414 415
        """
        return bind_api(
            api=self,
            path='/direct_messages.json',
            payload_type='direct_message', payload_list=True,
416
            allowed_param=['since_id', 'max_id', 'count', 'full_text'],
417 418 419 420 421
            require_auth=True
        )

    @property
    def get_direct_message(self):
422
        """ :reference: https://dev.twitter.com/rest/reference/get/direct_messages/show
423
            :allowed_param:'id', 'full_text'
424 425 426 427 428
        """
        return bind_api(
            api=self,
            path='/direct_messages/show/{id}.json',
            payload_type='direct_message',
429
            allowed_param=['id', 'full_text'],
430 431 432 433 434
            require_auth=True
        )

    @property
    def sent_direct_messages(self):
435
        """ :reference: https://dev.twitter.com/rest/reference/get/direct_messages/sent
436
            :allowed_param:'since_id', 'max_id', 'count', 'page', 'full_text'
437 438 439 440 441
        """
        return bind_api(
            api=self,
            path='/direct_messages/sent.json',
            payload_type='direct_message', payload_list=True,
442
            allowed_param=['since_id', 'max_id', 'count', 'page', 'full_text'],
443 444 445 446 447
            require_auth=True
        )

    @property
    def send_direct_message(self):
448
        """ :reference: https://dev.twitter.com/rest/reference/post/direct_messages/new
449 450 451 452 453 454 455 456 457 458 459 460 461
            :allowed_param:'user', 'screen_name', 'user_id', 'text'
        """
        return bind_api(
            api=self,
            path='/direct_messages/new.json',
            method='POST',
            payload_type='direct_message',
            allowed_param=['user', 'screen_name', 'user_id', 'text'],
            require_auth=True
        )

    @property
    def destroy_direct_message(self):
462
        """ :reference: https://dev.twitter.com/rest/reference/post/direct_messages/destroy
463 464 465 466 467
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/direct_messages/destroy.json',
468
            method='POST',
469 470 471 472 473 474 475
            payload_type='direct_message',
            allowed_param=['id'],
            require_auth=True
        )

    @property
    def create_friendship(self):
476
        """ :reference: https://dev.twitter.com/rest/reference/post/friendships/create
477 478 479 480 481 482 483 484 485 486 487 488 489
            :allowed_param:'id', 'user_id', 'screen_name', 'follow'
        """
        return bind_api(
            api=self,
            path='/friendships/create.json',
            method='POST',
            payload_type='user',
            allowed_param=['id', 'user_id', 'screen_name', 'follow'],
            require_auth=True
        )

    @property
    def destroy_friendship(self):
490
        """ :reference: https://dev.twitter.com/rest/reference/post/friendships/destroy
491 492 493 494 495
            :allowed_param:'id', 'user_id', 'screen_name'
        """
        return bind_api(
            api=self,
            path='/friendships/destroy.json',
496
            method='POST',
497 498 499 500 501 502 503
            payload_type='user',
            allowed_param=['id', 'user_id', 'screen_name'],
            require_auth=True
        )

    @property
    def show_friendship(self):
504
        """ :reference: https://dev.twitter.com/rest/reference/get/friendships/show
505
            :allowed_param:'source_id', 'source_screen_name', 'target_id', 'target_screen_name'
506 507 508 509 510 511 512 513 514
        """
        return bind_api(
            api=self,
            path='/friendships/show.json',
            payload_type='friendship',
            allowed_param=['source_id', 'source_screen_name',
                           'target_id', 'target_screen_name']
        )

515
    def lookup_friendships(self, user_ids=None, screen_names=None):
516
        """ Perform bulk look up of friendships from user ID or screenname """
Santosh Kumar's avatar
Santosh Kumar committed
517
        return self._lookup_friendships(list_to_csv(user_ids), list_to_csv(screen_names))
518

519 520
    @property
    def _lookup_friendships(self):
521
        """ :reference: https://dev.twitter.com/rest/reference/get/friendships/lookup
522 523 524 525 526 527 528 529 530 531 532 533
            :allowed_param:'user_id', 'screen_name'
        """
        return bind_api(
            api=self,
            path='/friendships/lookup.json',
            payload_type='relationship', payload_list=True,
            allowed_param=['user_id', 'screen_name'],
            require_auth=True
        )

    @property
    def friends_ids(self):
534 535
        """ :reference: https://dev.twitter.com/rest/reference/get/friends/ids
            :allowed_param:'id', 'user_id', 'screen_name', 'cursor'
536 537 538 539 540 541 542 543 544 545
        """
        return bind_api(
            api=self,
            path='/friends/ids.json',
            payload_type='ids',
            allowed_param=['id', 'user_id', 'screen_name', 'cursor']
        )

    @property
    def friends(self):
546
        """ :reference: https://dev.twitter.com/rest/reference/get/friends/list
547
            :allowed_param:'id', 'user_id', 'screen_name', 'cursor', 'skip_status', 'include_user_entities'
548 549 550 551 552
        """
        return bind_api(
            api=self,
            path='/friends/list.json',
            payload_type='user', payload_list=True,
553
            allowed_param=['id', 'user_id', 'screen_name', 'cursor', 'skip_status', 'include_user_entities']
554 555 556 557
        )

    @property
    def friendships_incoming(self):
558 559
        """ :reference: https://dev.twitter.com/rest/reference/get/friendships/incoming
            :allowed_param:'cursor'
560 561 562 563 564 565 566 567 568 569
        """
        return bind_api(
            api=self,
            path='/friendships/incoming.json',
            payload_type='ids',
            allowed_param=['cursor']
        )

    @property
    def friendships_outgoing(self):
570 571
        """ :reference: https://dev.twitter.com/rest/reference/get/friendships/outgoing
            :allowed_param:'cursor'
572 573 574 575 576 577 578 579 580 581
        """
        return bind_api(
            api=self,
            path='/friendships/outgoing.json',
            payload_type='ids',
            allowed_param=['cursor']
        )

    @property
    def followers_ids(self):
582 583
        """ :reference: https://dev.twitter.com/rest/reference/get/followers/ids
            :allowed_param:'id', 'user_id', 'screen_name', 'cursor', 'count'
584 585 586 587 588 589 590 591 592 593
        """
        return bind_api(
            api=self,
            path='/followers/ids.json',
            payload_type='ids',
            allowed_param=['id', 'user_id', 'screen_name', 'cursor', 'count']
        )

    @property
    def followers(self):
594
        """ :reference: https://dev.twitter.com/rest/reference/get/followers/list
595 596 597 598 599 600 601 602 603 604
            :allowed_param:'id', 'user_id', 'screen_name', 'cursor', 'count', 'skip_status', 'include_user_entities'
        """
        return bind_api(
            api=self,
            path='/followers/list.json',
            payload_type='user', payload_list=True,
            allowed_param=['id', 'user_id', 'screen_name', 'cursor', 'count',
                           'skip_status', 'include_user_entities']
        )

Namwoo Kim's avatar
Namwoo Kim committed
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
    @property
    def get_settings(self):
        """ :reference: https://dev.twitter.com/rest/reference/get/account/settings
        """
        return bind_api(
            api=self,
            path='/account/settings.json',
            payload_type='json',
            use_cache=False
        )

    @property
    def set_settings(self):
        """ :reference: https://dev.twitter.com/rest/reference/post/account/settings
            :allowed_param:'sleep_time_enabled', 'start_sleep_time',
            'end_sleep_time', 'time_zone', 'trend_location_woeid',
            'allow_contributor_request', 'lang'
        """
        return bind_api(
            api=self,
            path='/account/settings.json',
            method='POST',
            payload_type='json',
            allowed_param=['sleep_time_enabled', 'start_sleep_time',
                           'end_sleep_time', 'time_zone',
                           'trend_location_woeid', 'allow_contributor_request',
                           'lang'],
            use_cache=False
        )

635
    def verify_credentials(self, **kargs):
636
        """ :reference: https://dev.twitter.com/rest/reference/get/account/verify_credentials
Jacob Ferrero's avatar
Jacob Ferrero committed
637
            :allowed_param:'include_entities', 'skip_status', 'include_email'
638
        """
Josh Roesslein's avatar
Josh Roesslein committed
639 640
        try:
            return bind_api(
641 642 643 644
                api=self,
                path='/account/verify_credentials.json',
                payload_type='user',
                require_auth=True,
Jacob Ferrero's avatar
Jacob Ferrero committed
645
                allowed_param=['include_entities', 'skip_status', 'include_email'],
Aaron Hill's avatar
Aaron Hill committed
646
            )(**kargs)
647
        except TweepError as e:
648 649 650
            if e.response and e.response.status == 401:
                return False
            raise
Josh Roesslein's avatar
Josh Roesslein committed
651

652 653
    @property
    def rate_limit_status(self):
654
        """ :reference: https://dev.twitter.com/rest/reference/get/application/rate_limit_status
655 656 657 658 659 660 661 662 663 664 665 666
            :allowed_param:'resources'
        """
        return bind_api(
            api=self,
            path='/application/rate_limit_status.json',
            payload_type='json',
            allowed_param=['resources'],
            use_cache=False
        )

    @property
    def set_delivery_device(self):
667
        """ :reference: https://dev.twitter.com/rest/reference/post/account/update_delivery_device
668 669 670 671 672 673 674 675 676 677 678 679
            :allowed_param:'device'
        """
        return bind_api(
            api=self,
            path='/account/update_delivery_device.json',
            method='POST',
            allowed_param=['device'],
            payload_type='user',
            require_auth=True
        )

    def update_profile_image(self, filename, file_=None):
680 681 682
        """ :reference: https://dev.twitter.com/rest/reference/post/account/update_profile_image
            :allowed_param:'include_entities', 'skip_status'
        """
683 684 685 686 687 688
        headers, post_data = API._pack_image(filename, 700, f=file_)
        return bind_api(
            api=self,
            path='/account/update_profile_image.json',
            method='POST',
            payload_type='user',
689
            allowed_param=['include_entities', 'skip_status'],
690
            require_auth=True
Josh Roesslein's avatar
Josh Roesslein committed
691 692
        )(self, post_data=post_data, headers=headers)

693
    def update_profile_background_image(self, filename, **kargs):
694 695 696
        """ :reference: https://dev.twitter.com/rest/reference/post/account/update_profile_background_image
            :allowed_param:'tile', 'include_entities', 'skip_status', 'use'
        """
697 698
        f = kargs.pop('file', None)
        headers, post_data = API._pack_image(filename, 800, f=f)
Josh Roesslein's avatar
Josh Roesslein committed
699
        bind_api(
Jordi Riera's avatar
Jordi Riera committed
700
            api=self,
701 702 703
            path='/account/update_profile_background_image.json',
            method='POST',
            payload_type='user',
Arudmin's avatar
Arudmin committed
704
            allowed_param=['tile', 'include_entities', 'skip_status', 'use'],
705
            require_auth=True
Mark Smith's avatar
Mark Smith committed
706
        )(post_data=post_data, headers=headers)
Josh Roesslein's avatar
Josh Roesslein committed
707

708
    def update_profile_banner(self, filename, **kargs):
709 710 711
        """ :reference: https://dev.twitter.com/rest/reference/post/account/update_profile_banner
            :allowed_param:'width', 'height', 'offset_left', 'offset_right'
        """
712 713
        f = kargs.pop('file', None)
        headers, post_data = API._pack_image(filename, 700, form_field="banner", f=f)
714
        bind_api(
Jordi Riera's avatar
Jordi Riera committed
715
            api=self,
716 717 718 719
            path='/account/update_profile_banner.json',
            method='POST',
            allowed_param=['width', 'height', 'offset_left', 'offset_right'],
            require_auth=True
Mark Smith's avatar
Mark Smith committed
720
        )(post_data=post_data, headers=headers)
721

722 723
    @property
    def update_profile(self):
724
        """ :reference: https://dev.twitter.com/rest/reference/post/account/update_profile
725
            :allowed_param:'name', 'url', 'location', 'description', 'profile_link_color'
726 727 728 729 730 731
        """
        return bind_api(
            api=self,
            path='/account/update_profile.json',
            method='POST',
            payload_type='user',
732
            allowed_param=['name', 'url', 'location', 'description', 'profile_link_color'],
733 734 735 736 737
            require_auth=True
        )

    @property
    def favorites(self):
738 739
        """ :reference: https://dev.twitter.com/rest/reference/get/favorites/list
            :allowed_param:'screen_name', 'user_id', 'max_id', 'count', 'since_id', 'max_id'
740 741 742 743 744 745 746 747 748 749
        """
        return bind_api(
            api=self,
            path='/favorites/list.json',
            payload_type='status', payload_list=True,
            allowed_param=['screen_name', 'user_id', 'max_id', 'count', 'since_id', 'max_id']
        )

    @property
    def create_favorite(self):
750
        """ :reference:https://dev.twitter.com/rest/reference/post/favorites/create
751 752 753 754 755 756 757 758 759 760 761 762 763
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/favorites/create.json',
            method='POST',
            payload_type='status',
            allowed_param=['id'],
            require_auth=True
        )

    @property
    def destroy_favorite(self):
764
        """ :reference: https://dev.twitter.com/rest/reference/post/favorites/destroy
765 766 767 768 769 770 771 772 773 774 775 776 777
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/favorites/destroy.json',
            method='POST',
            payload_type='status',
            allowed_param=['id'],
            require_auth=True
        )

    @property
    def create_block(self):
778
        """ :reference: https://dev.twitter.com/rest/reference/post/blocks/create
779 780 781 782 783 784 785 786 787 788 789 790 791
            :allowed_param:'id', 'user_id', 'screen_name'
        """
        return bind_api(
            api=self,
            path='/blocks/create.json',
            method='POST',
            payload_type='user',
            allowed_param=['id', 'user_id', 'screen_name'],
            require_auth=True
        )

    @property
    def destroy_block(self):
792
        """ :reference: https://dev.twitter.com/rest/reference/post/blocks/destroy
793 794 795 796 797
            :allowed_param:'id', 'user_id', 'screen_name'
        """
        return bind_api(
            api=self,
            path='/blocks/destroy.json',
798
            method='POST',
799 800 801 802 803 804 805
            payload_type='user',
            allowed_param=['id', 'user_id', 'screen_name'],
            require_auth=True
        )

    @property
    def blocks(self):
806
        """ :reference: https://dev.twitter.com/rest/reference/get/blocks/list
807 808 809 810 811 812 813 814 815 816 817 818
            :allowed_param:'cursor'
        """
        return bind_api(
            api=self,
            path='/blocks/list.json',
            payload_type='user', payload_list=True,
            allowed_param=['cursor'],
            require_auth=True
        )

    @property
    def blocks_ids(self):
819
        """ :reference: https://dev.twitter.com/rest/reference/get/blocks/ids """
820 821 822 823 824 825 826 827 828
        return bind_api(
            api=self,
            path='/blocks/ids.json',
            payload_type='json',
            require_auth=True
        )

    @property
    def report_spam(self):
829
        """ :reference: https://dev.twitter.com/rest/reference/post/users/report_spam
830 831 832 833 834 835 836 837 838 839 840 841 842
            :allowed_param:'user_id', 'screen_name'
        """
        return bind_api(
            api=self,
            path='/users/report_spam.json',
            method='POST',
            payload_type='user',
            allowed_param=['user_id', 'screen_name'],
            require_auth=True
        )

    @property
    def saved_searches(self):
843
        """ :reference: https://dev.twitter.com/rest/reference/get/saved_searches/show/%3Aid """
844 845 846 847 848 849 850 851 852
        return bind_api(
            api=self,
            path='/saved_searches/list.json',
            payload_type='saved_search', payload_list=True,
            require_auth=True
        )

    @property
    def get_saved_search(self):
853
        """ :reference: https://dev.twitter.com/rest/reference/get/saved_searches/show/%3Aid
854 855 856 857 858 859 860 861 862 863 864 865
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/saved_searches/show/{id}.json',
            payload_type='saved_search',
            allowed_param=['id'],
            require_auth=True
        )

    @property
    def create_saved_search(self):
866
        """ :reference: https://dev.twitter.com/rest/reference/post/saved_searches/create
867 868 869 870 871 872 873 874 875 876 877 878 879
            :allowed_param:'query'
        """
        return bind_api(
            api=self,
            path='/saved_searches/create.json',
            method='POST',
            payload_type='saved_search',
            allowed_param=['query'],
            require_auth=True
        )

    @property
    def destroy_saved_search(self):
880
        """ :reference: https://dev.twitter.com/rest/reference/post/saved_searches/destroy/%3Aid
881 882 883 884 885 886 887 888 889 890 891 892 893
            :allowed_param:'id'
        """
        return bind_api(
            api=self,
            path='/saved_searches/destroy/{id}.json',
            method='POST',
            payload_type='saved_search',
            allowed_param=['id'],
            require_auth=True
        )

    @property
    def create_list(self):
894
        """ :reference: https://dev.twitter.com/rest/reference/post/lists/create
895 896 897 898 899 900 901 902 903 904 905 906 907
            :allowed_param:'name', 'mode', 'description'
        """
        return bind_api(
            api=self,
            path='/lists/create.json',
            method='POST',
            payload_type='list',
            allowed_param=['name', 'mode', 'description'],
            require_auth=True
        )

    @property
    def destroy_list(self):
908
        """ :reference: https://dev.twitter.com/rest/reference/post/lists/destroy
909 910 911 912 913 914 915 916 917 918 919 920 921
            :allowed_param:'owner_screen_name', 'owner_id', 'list_id', 'slug'
        """
        return bind_api(
            api=self,
            path='/lists/destroy.json',
            method='POST',
            payload_type='list',
            allowed_param=['owner_screen_name', 'owner_id', 'list_id', 'slug'],
            require_auth=True
        )

    @property
    def update_list(self):
922
        """ :reference: https://dev.twitter.com/rest/reference/post/lists/update
923 924 925 926 927 928 929 930 931 932 933 934 935
            :allowed_param: list_id', 'slug', 'name', 'mode', 'description', 'owner_screen_name', 'owner_id'
        """
        return bind_api(
            api=self,
            path='/lists/update.json',
            method='POST',
            payload_type='list',
            allowed_param=['list_id', 'slug', 'name', 'mode', 'description', 'owner_screen_name', 'owner_id'],
            require_auth=True
        )

    @property
    def lists_all(self):
936
        """ :reference: https://dev.twitter.com/rest/reference/get/lists/list
937 938 939 940 941 942 943 944 945 946 947 948
            :allowed_param:'screen_name', 'user_id'
        """
        return bind_api(
            api=self,
            path='/lists/list.json',
            payload_type='list', payload_list=True,
            allowed_param=['screen_name', 'user_id'],
            require_auth=True
        )

    @property
    def lists_memberships(self):
949
        """ :reference: https://dev.twitter.com/rest/reference/get/lists/memberships
950 951 952 953 954 955 956 957 958 959 960 961
            :allowed_param:'screen_name', 'user_id', 'filter_to_owned_lists', 'cursor'
        """
        return bind_api(
            api=self,
            path='/lists/memberships.json',
            payload_type='list', payload_list=True,
            allowed_param=['screen_name', 'user_id', 'filter_to_owned_lists', 'cursor'],
            require_auth=True
        )

    @property
    def lists_subscriptions(self):
962
        """ :reference: https://dev.twitter.com/rest/reference/get/lists/subscriptions
963 964 965 966 967 968 969 970 971 972 973 974 975
            :allowed_param:'screen_name', 'user_id', 'cursor'
        """
        return bind_api(
            api=self,
            path='/lists/subscriptions.json',
            payload_type='list', payload_list=True,
            allowed_param=['screen_name', 'user_id', 'cursor'],
            require_auth=True
        )

    @property
    def list_timeline(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/get/lists/statuses
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
976 977
            :allowed_param:'owner_screen_name', 'slug', 'owner_id', 'list_id',
             'since_id', 'max_id', 'count', 'include_rts
978 979 980 981 982
        """
        return bind_api(
            api=self,
            path='/lists/statuses.json',
            payload_type='status', payload_list=True,
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
983 984 985
            allowed_param=['owner_screen_name', 'slug', 'owner_id',
                           'list_id', 'since_id', 'max_id', 'count',
                           'include_rts']
986 987 988 989
        )

    @property
    def get_list(self):
990 991
        """ :reference: https://dev.twitter.com/rest/reference/get/lists/show
            :allowed_param:'owner_screen_name', 'owner_id', 'slug', 'list_id'
992 993 994 995 996 997 998 999 1000 1001 1002
        """
        return bind_api(
            api=self,
            path='/lists/show.json',
            payload_type='list',
            allowed_param=['owner_screen_name', 'owner_id', 'slug', 'list_id']
        )

    @property
    def add_list_member(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/post/lists/members/create
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1003 1004
            :allowed_param:'screen_name', 'user_id', 'owner_screen_name',
             'owner_id', 'slug', 'list_id'
1005 1006 1007 1008 1009 1010
        """
        return bind_api(
            api=self,
            path='/lists/members/create.json',
            method='POST',
            payload_type='list',
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1011 1012
            allowed_param=['screen_name', 'user_id', 'owner_screen_name',
                           'owner_id', 'slug', 'list_id'],
1013 1014 1015 1016 1017 1018
            require_auth=True
        )

    @property
    def remove_list_member(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1019 1020
            :allowed_param:'screen_name', 'user_id', 'owner_screen_name',
             'owner_id', 'slug', 'list_id'
1021 1022 1023 1024 1025 1026
        """
        return bind_api(
            api=self,
            path='/lists/members/destroy.json',
            method='POST',
            payload_type='list',
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1027 1028
            allowed_param=['screen_name', 'user_id', 'owner_screen_name',
                           'owner_id', 'slug', 'list_id'],
1029 1030
            require_auth=True
        )
1031

kk6's avatar
kk6 committed
1032
    def add_list_members(self, screen_name=None, user_id=None, slug=None,
1033
                         list_id=None, owner_id=None, owner_screen_name=None):
1034
        """ Perform bulk add of list members from user ID or screenname """
kk6's avatar
kk6 committed
1035 1036
        return self._add_list_members(list_to_csv(screen_name),
                                      list_to_csv(user_id),
1037 1038 1039
                                      slug, list_id, owner_id,
                                      owner_screen_name)

1040 1041 1042
    @property
    def _add_list_members(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/post/lists/members/create_all
1043
            :allowed_param:'screen_name', 'user_id', 'slug', 'list_id',
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1044
            'owner_id', 'owner_screen_name'
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1045

1046 1047 1048 1049 1050 1051
        """
        return bind_api(
            api=self,
            path='/lists/members/create_all.json',
            method='POST',
            payload_type='list',
1052
            allowed_param=['screen_name', 'user_id', 'slug', 'list_id',
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1053
                           'owner_id', 'owner_screen_name'],
1054 1055 1056
            require_auth=True
        )

kk6's avatar
kk6 committed
1057
    def remove_list_members(self, screen_name=None, user_id=None, slug=None,
1058 1059
                            list_id=None, owner_id=None, owner_screen_name=None):
        """ Perform bulk remove of list members from user ID or screenname """
kk6's avatar
kk6 committed
1060
        return self._remove_list_members(list_to_csv(screen_name),
1061 1062 1063 1064 1065 1066 1067
                                         list_to_csv(user_id),
                                         slug, list_id, owner_id,
                                         owner_screen_name)

    @property
    def _remove_list_members(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy_all
1068
            :allowed_param:'screen_name', 'user_id', 'slug', 'list_id',
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1069
            'owner_id', 'owner_screen_name'
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1070

1071 1072 1073 1074 1075 1076
        """
        return bind_api(
            api=self,
            path='/lists/members/destroy_all.json',
            method='POST',
            payload_type='list',
1077
            allowed_param=['screen_name', 'user_id', 'slug', 'list_id',
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1078
                           'owner_id', 'owner_screen_name'],
1079 1080
            require_auth=True
        )
1081

1082 1083 1084
    @property
    def list_members(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/get/lists/members
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1085 1086
            :allowed_param:'owner_screen_name', 'slug', 'list_id',
             'owner_id', 'cursor
1087 1088 1089 1090 1091
        """
        return bind_api(
            api=self,
            path='/lists/members.json',
            payload_type='user', payload_list=True,
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1092 1093
            allowed_param=['owner_screen_name', 'slug', 'list_id',
                           'owner_id', 'cursor']
1094 1095 1096 1097 1098
        )

    @property
    def show_list_member(self):
        """ :reference: https://dev.twitter.com/docs/api/1.1/get/lists/members/show
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1099 1100
            :allowed_param:'list_id', 'slug', 'user_id', 'screen_name',
             'owner_screen_name', 'owner_id
1101 1102 1103 1104 1105
        """
        return bind_api(
            api=self,
            path='/lists/members/show.json',
            payload_type='user',
Omer Murat Yildirim's avatar
Omer Murat Yildirim committed
1106 1107
            allowed_param=['list_id', 'slug', 'user_id', 'screen_name',
                           'owner_screen_name', 'owner_id']
1108 1109 1110 1111 1112
        )

    @property
    def subscribe_list(self):