2022-11-30 23:39:08 +00:00
|
|
|
# favourites.py - favourites and also bookmarks
|
|
|
|
|
2023-06-19 21:35:03 +00:00
|
|
|
from mastodon.versions import _DICT_VERSION_STATUS
|
|
|
|
from mastodon.utility import api_version
|
2022-11-30 23:39:08 +00:00
|
|
|
|
2023-06-19 21:35:03 +00:00
|
|
|
from mastodon.internals import Mastodon as Internals
|
|
|
|
from mastodon.types import Status, IdType, PaginatableList
|
2022-11-30 23:39:08 +00:00
|
|
|
|
2023-06-19 21:35:03 +00:00
|
|
|
from typing import Optional, Union
|
2023-01-02 13:39:16 +00:00
|
|
|
|
2022-11-30 23:39:08 +00:00
|
|
|
class Mastodon(Internals):
|
|
|
|
###
|
|
|
|
# Reading data: Favourites
|
|
|
|
###
|
|
|
|
@api_version("1.0.0", "2.6.0", _DICT_VERSION_STATUS)
|
2023-06-19 21:35:03 +00:00
|
|
|
def favourites(self, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None,
|
|
|
|
since_id: Optional[IdType] = None, limit: Optional[int] = None) -> PaginatableList[Status]:
|
2022-11-30 23:39:08 +00:00
|
|
|
"""
|
|
|
|
Fetch the logged-in user's favourited statuses.
|
|
|
|
|
2023-04-16 19:12:06 +00:00
|
|
|
This endpoint uses internal ids for pagination, passing status ids to
|
2023-06-19 21:35:03 +00:00
|
|
|
`max_id`, `min_id`, or `since_id` will not work.
|
2023-04-16 19:12:06 +00:00
|
|
|
|
2022-11-30 23:39:08 +00:00
|
|
|
Returns a list of :ref:`status dicts <status dicts>`.
|
|
|
|
"""
|
|
|
|
if max_id is not None:
|
2023-06-19 21:35:03 +00:00
|
|
|
max_id = self.__unpack_id(max_id)
|
2022-11-30 23:39:08 +00:00
|
|
|
|
|
|
|
if min_id is not None:
|
2023-06-19 21:35:03 +00:00
|
|
|
min_id = self.__unpack_id(min_id)
|
2022-11-30 23:39:08 +00:00
|
|
|
|
|
|
|
if since_id is not None:
|
2023-06-19 21:35:03 +00:00
|
|
|
since_id = self.__unpack_id(since_id)
|
2022-11-30 23:39:08 +00:00
|
|
|
|
|
|
|
params = self.__generate_params(locals())
|
|
|
|
return self.__api_request('GET', '/api/v1/favourites', params)
|
|
|
|
|
|
|
|
###
|
|
|
|
# Reading data: Bookmarks
|
|
|
|
###
|
|
|
|
@api_version("3.1.0", "3.1.0", _DICT_VERSION_STATUS)
|
2023-06-19 21:35:03 +00:00
|
|
|
def bookmarks(self, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None,
|
|
|
|
since_id: Optional[IdType] = None, limit: Optional[int] = None) -> PaginatableList[Status]:
|
2022-11-30 23:39:08 +00:00
|
|
|
"""
|
|
|
|
Get a list of statuses bookmarked by the logged-in user.
|
|
|
|
|
2023-04-16 19:12:06 +00:00
|
|
|
This endpoint uses internal ids for pagination, passing status ids to
|
2023-06-19 21:35:03 +00:00
|
|
|
`max_id`, `min_id`, or `since_id` will not work.
|
2022-11-30 23:39:08 +00:00
|
|
|
"""
|
|
|
|
if max_id is not None:
|
2023-06-19 21:35:03 +00:00
|
|
|
max_id = self.__unpack_id(max_id)
|
2022-11-30 23:39:08 +00:00
|
|
|
|
|
|
|
if min_id is not None:
|
2023-06-19 21:35:03 +00:00
|
|
|
min_id = self.__unpack_id(min_id)
|
2022-11-30 23:39:08 +00:00
|
|
|
|
|
|
|
if since_id is not None:
|
2023-06-19 21:35:03 +00:00
|
|
|
since_id = self.__unpack_id(since_id)
|
2022-11-30 23:39:08 +00:00
|
|
|
|
|
|
|
params = self.__generate_params(locals())
|
|
|
|
return self.__api_request('GET', '/api/v1/bookmarks', params)
|