aiogram/aiogram/methods/set_passport_data_errors.py
Alex Root Junior e4046095d7
Dev 3.x i18n & improvements (#696)
* Added base code and make code improvements
* Auto-exclude coverage for `if TYPE_CHECKING:`
* Fixed current coverage
* Cover I18n module
* Update pipeline
* Fixed annotations
* Added docs
* Move exceptions
* Added tests for KeyboardBuilder and initial docs
* Remove help generator (removed from sources tree, requires rewrite)
* Added patch-notes #698, #699, #700, #701, #702, #703
2021-09-22 00:52:38 +03:00

30 lines
1.3 KiB
Python

from __future__ import annotations
from typing import TYPE_CHECKING, Any, Dict, List
from ..types import PassportElementError
from .base import Request, TelegramMethod
if TYPE_CHECKING:
from ..client.bot import Bot
class SetPassportDataErrors(TelegramMethod[bool]):
"""
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns :code:`True` on success.
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
Source: https://core.telegram.org/bots/api#setpassportdataerrors
"""
__returning__ = bool
user_id: int
"""User identifier"""
errors: List[PassportElementError]
"""A JSON-serialized array describing the errors"""
def build_request(self, bot: Bot) -> Request:
data: Dict[str, Any] = self.dict()
return Request(method="setPassportDataErrors", data=data)