.. include:: strings.rst
Statuses
========

.. module:: statuses

.. function:: update(server_url, *args, **kwargs)

  Updates the authenticating user's current status.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/statuses.html#post--api-statuses-update.json

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`status_dict`

.. function:: show(server_url, status_id, *args, **kwargs)

  Returns a specified status.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/statuses.html#get--api-statuses-show-(int-status_id).json

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`status_dict`

.. function:: destroy(server_url, status_id, *args, **kwargs)

  Deletes the status specified by the required ID parameter.
  The authenticating user must be the author of the specified status.
  Returns the destroyed status if successful.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/statuses.html#post--api-statuses-destroy-(int-status_id).json

  :param str server_url: |server_url|
  :param int status_id: ID of the status to delete
  :rtype: dict
  :return: :ref:`status_dict`

.. function:: repeat(server_url, status_id, *args, **kwargs)

  Repeats a status. Returns the original status with repeat details
  embedded.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/statuses.html#post--api-statuses-retweet-(int-status_id).json

  :param str server_url: |server_url|
  :param int status_id: ID of the status to repeat
  :rtype: dict
  :return: :ref:`status_dict`

.. function:: conversation(server_url, conversation_id, *args, **kwargs)

  Returns statuses that have been posted in the conversation

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/statuses.html#get--api-statuses-conversation-(int-conversation_id).json

  :param str server_url: |server_url|
  :param int conversation_id: ID of the conversation to show
  :rtype: list
  :return: a list of :ref:`status dicts <status_dict>`

.. function:: favorite(server_url, status_id, *args, **kwargs)

  Favorites the status specified in the ID parameter as the authenticating
  user. Returns the liked status when successful.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/favorites.html

  :param str server_url: |server_url|
  :param int status_id: ID of the status to favorite
  :rtype: dict
  :return: :ref:`status_dict`


.. function:: unfavorite(server_url, status_id, *args, **kwargs)

   Unfavorites the status specified in the ID parameter as the authenticating
   user. Returns the unliked status when successful.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/favorites.html#post--api-favorites-destroy-(int-status_id).json

  :param str server_url: |server_url|
  :param int status_id: ID of the status to unfavorite
  :rtype: dict
  :return: :ref:`status_dict`

.. function:: favorites(server_url, *args, **kwargs)

  Returns recent notices favorited by the authenticating or specified user.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/favorites.html#get--api-favorites.json

  :param str server_url: |server_url|
  :rtype: list
  :return: a list of :ref:`status dicts <status_dict>`