aiogram/aiogram/methods/set_passport_data_errors.py
Alex Root Junior fea1b7b0a3
Reworked request builder (#1142)
* Reworked request builder

* Added more default values

* Update tests

* Fixed timestamp

* Fixed Py3.8 support

* Describe changes
2023-03-11 20:46:36 +02:00

23 lines
1.1 KiB
Python

from __future__ import annotations
from typing import TYPE_CHECKING, List
from ..types import PassportElementError
from .base import TelegramMethod
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
__api_method__ = "setPassportDataErrors"
user_id: int
"""User identifier"""
errors: List[PassportElementError]
"""A JSON-serialized array describing the errors"""