# relationships.py - endpoints for user and domain blocks and mutes as well as follow requests
from mastodon.versions import _DICT_VERSION_ACCOUNT, _DICT_VERSION_RELATIONSHIP
from mastodon.utility import api_version
from mastodon.internals import Mastodon as Internals
from mastodon.types import Account, Relationship, PaginatableList, IdType
from typing import Optional, Union
class Mastodon(Internals):
###
# Reading data: Mutes and Blocks
###
[docs]
@api_version("1.1.0", "2.6.0", _DICT_VERSION_ACCOUNT)
def mutes(self, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None, since_id:
Optional[IdType] = None, limit: Optional[int] = None) -> PaginatableList[Account]:
"""
Fetch a list of users muted by the logged-in user.
"""
if max_id is not None:
max_id = self.__unpack_id(max_id)
if min_id is not None:
min_id = self.__unpack_id(min_id)
if since_id is not None:
since_id = self.__unpack_id(since_id)
params = self.__generate_params(locals())
return self.__api_request('GET', '/api/v1/mutes', params)
[docs]
@api_version("1.0.0", "2.6.0", _DICT_VERSION_ACCOUNT)
def blocks(self, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None, since_id:
Optional[IdType] = None, limit: Optional[int] = None) -> PaginatableList[Account]:
"""
Fetch a list of users blocked by the logged-in user.
"""
if max_id is not None:
max_id = self.__unpack_id(max_id)
if min_id is not None:
min_id = self.__unpack_id(min_id)
if since_id is not None:
since_id = self.__unpack_id(since_id)
params = self.__generate_params(locals())
return self.__api_request('GET', '/api/v1/blocks', params)
###
# Reading data: Follow requests
###
[docs]
@api_version("1.0.0", "2.6.0", _DICT_VERSION_ACCOUNT)
def follow_requests(self, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None, since_id:
Optional[IdType] = None, limit: Optional[int] = None) -> PaginatableList[Account]:
"""
Fetch the logged-in user's incoming follow requests.
"""
if max_id is not None:
max_id = self.__unpack_id(max_id)
if min_id is not None:
min_id = self.__unpack_id(min_id)
if since_id is not None:
since_id = self.__unpack_id(since_id)
params = self.__generate_params(locals())
return self.__api_request('GET', '/api/v1/follow_requests', params)
###
# Reading data: Domain blocks
###
[docs]
@api_version("1.4.0", "2.6.0", "1.4.0")
def domain_blocks(self, max_id: Optional[IdType] = None, min_id: Optional[IdType] = None, since_id:
Optional[IdType] = None, limit: Optional[int] = None) -> PaginatableList[str]:
"""
Fetch the logged-in user's blocked domains.
Returns a list of blocked domain URLs (as strings, without protocol specifier).
"""
if max_id is not None:
max_id = self.__unpack_id(max_id)
if min_id is not None:
min_id = self.__unpack_id(min_id)
if since_id is not None:
since_id = self.__unpack_id(since_id)
params = self.__generate_params(locals())
return self.__api_request('GET', '/api/v1/domain_blocks', params)
###
# Writing data: Follow requests
###
[docs]
@api_version("1.0.0", "3.0.0", _DICT_VERSION_RELATIONSHIP)
def follow_request_authorize(self, id: Union[Account, IdType]) -> Relationship:
"""
Accept an incoming follow request from the given Account and returns the updated Relationship.
"""
id = self.__unpack_id(id)
return self.__api_request('POST', f'/api/v1/follow_requests/{id}/authorize')
[docs]
@api_version("1.0.0", "3.0.0", _DICT_VERSION_RELATIONSHIP)
def follow_request_reject(self, id: Union[Account, IdType]) -> Relationship:
"""
Reject an incoming follow request from the given Account and returns the updated Relationship.
"""
id = self.__unpack_id(id)
return self.__api_request('POST', f'/api/v1/follow_requests/{id}/reject')
###
# Writing data: Domain blocks
###
[docs]
@api_version("1.4.0", "1.4.0", "1.4.0")
def domain_block(self, domain: str):
"""
Add a block for all statuses originating from the specified domain for the logged-in user.
"""
params = self.__generate_params(locals())
self.__api_request('POST', '/api/v1/domain_blocks', params)
[docs]
@api_version("1.4.0", "1.4.0", "1.4.0")
def domain_unblock(self, domain: str):
"""
Remove a domain block for the logged-in user.
"""
params = self.__generate_params(locals())
self.__api_request('DELETE', '/api/v1/domain_blocks', params)