aiogram.api.methods.unban_chat_member

aiogram/api/methods/unban_chat_member.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Dict, Union

from .base import Request, TelegramMethod

if TYPE_CHECKING:  # pragma: no cover
    from ..client.bot import Bot


class UnbanChatMember(TelegramMethod[bool]):
    """
    Use this method to unban a previously kicked user in a supergroup or channel. The user will
    not return to the group or channel automatically, but will be able to join via link, etc. The
    bot must be an administrator for this to work. Returns True on success.

    Source: https://core.telegram.org/bots/api#unbanchatmember
    """

    __returning__ = bool

    chat_id: Union[int, str]
    """Unique identifier for the target group or username of the target supergroup or channel (in
    the format @username)"""
    user_id: int
    """Unique identifier of the target user"""

    def build_request(self, bot: Bot) -> Request:
        data: Dict[str, Any] = self.dict()

        return Request(method="unbanChatMember", data=data)