2017-05-19 19:41:06 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2024-02-19 20:06:25 +01:00
|
|
|
# Copyright (C) 2015-2024
|
2017-05-19 19:41:06 +02:00
|
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU Lesser Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
|
|
"""This module contains an object that represents a Telegram PreCheckoutQuery."""
|
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
from typing import TYPE_CHECKING, Optional
|
2020-10-31 16:33:34 +01:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram._payment.orderinfo import OrderInfo
|
|
|
|
from telegram._telegramobject import TelegramObject
|
|
|
|
from telegram._user import User
|
2021-10-10 15:10:21 +02:00
|
|
|
from telegram._utils.defaultvalue import DEFAULT_NONE
|
|
|
|
from telegram._utils.types import JSONDict, ODVInput
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from telegram import Bot
|
2017-05-19 19:41:06 +02:00
|
|
|
|
|
|
|
|
|
|
|
class PreCheckoutQuery(TelegramObject):
|
2017-09-01 08:43:08 +02:00
|
|
|
"""This object contains information about an incoming pre-checkout query.
|
2017-05-19 19:41:06 +02:00
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
|
|
considered equal, if their :attr:`id` is equal.
|
|
|
|
|
2017-05-19 19:41:06 +02:00
|
|
|
Note:
|
2023-02-05 18:09:55 +01:00
|
|
|
In Python :keyword:`from` is a reserved word. Use :paramref:`from_user` instead.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
Args:
|
|
|
|
id (:obj:`str`): Unique query identifier.
|
|
|
|
from_user (:class:`telegram.User`): User who sent the query.
|
2024-06-03 19:39:31 +02:00
|
|
|
currency (:obj:`str`): Three-letter ISO 4217 currency code, or ``XTR`` for payments in
|
|
|
|
|tg_stars|.
|
2024-07-12 16:33:42 +02:00
|
|
|
total_amount (:obj:`int`): Total price in the smallest units of the currency (integer,
|
|
|
|
**not** float/double). For example, for a price of ``US$ 1.45`` pass ``amount = 145``.
|
2022-02-09 17:30:16 +01:00
|
|
|
See the ``exp`` parameter in
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
`currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_,
|
|
|
|
it shows the number of digits past the decimal point for each currency
|
|
|
|
(2 for the majority of currencies).
|
2024-07-07 13:08:52 +02:00
|
|
|
invoice_payload (:obj:`str`): Bot-specified invoice payload.
|
2017-07-23 22:33:08 +02:00
|
|
|
shipping_option_id (:obj:`str`, optional): Identifier of the shipping option chosen by the
|
|
|
|
user.
|
|
|
|
order_info (:class:`telegram.OrderInfo`, optional): Order info provided by the user.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
Attributes:
|
|
|
|
id (:obj:`str`): Unique query identifier.
|
|
|
|
from_user (:class:`telegram.User`): User who sent the query.
|
2024-06-03 19:39:31 +02:00
|
|
|
currency (:obj:`str`): Three-letter ISO 4217 currency code, or ``XTR`` for payments in
|
|
|
|
|tg_stars|.
|
2024-07-12 16:33:42 +02:00
|
|
|
total_amount (:obj:`int`): Total price in the smallest units of the currency (integer,
|
|
|
|
**not** float/double). For example, for a price of ``US$ 1.45`` pass ``amount = 145``.
|
2023-01-01 16:24:00 +01:00
|
|
|
See the ``exp`` parameter in
|
|
|
|
`currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_,
|
|
|
|
it shows the number of digits past the decimal point for each currency
|
|
|
|
(2 for the majority of currencies).
|
2024-07-07 13:08:52 +02:00
|
|
|
invoice_payload (:obj:`str`): Bot-specified invoice payload.
|
2020-12-30 15:59:50 +01:00
|
|
|
shipping_option_id (:obj:`str`): Optional. Identifier of the shipping option chosen by the
|
|
|
|
user.
|
|
|
|
order_info (:class:`telegram.OrderInfo`): Optional. Order info provided by the user.
|
2022-10-07 11:51:53 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
|
2017-05-19 19:41:06 +02:00
|
|
|
"""
|
|
|
|
|
2021-05-29 16:18:16 +02:00
|
|
|
__slots__ = (
|
|
|
|
"currency",
|
2024-02-05 19:24:00 +01:00
|
|
|
"from_user",
|
|
|
|
"id",
|
|
|
|
"invoice_payload",
|
2021-05-29 16:18:16 +02:00
|
|
|
"order_info",
|
2024-02-05 19:24:00 +01:00
|
|
|
"shipping_option_id",
|
2021-05-29 16:18:16 +02:00
|
|
|
"total_amount",
|
|
|
|
)
|
|
|
|
|
2017-05-19 19:41:06 +02:00
|
|
|
def __init__(
|
2020-11-05 18:12:01 +01:00
|
|
|
self,
|
2022-10-07 11:51:53 +02:00
|
|
|
id: str, # pylint: disable=redefined-builtin
|
2020-10-06 19:28:40 +02:00
|
|
|
from_user: User,
|
|
|
|
currency: str,
|
|
|
|
total_amount: int,
|
|
|
|
invoice_payload: str,
|
2023-05-18 07:57:59 +02:00
|
|
|
shipping_option_id: Optional[str] = None,
|
|
|
|
order_info: Optional[OrderInfo] = None,
|
2022-10-07 11:51:53 +02:00
|
|
|
*,
|
2023-05-18 07:57:59 +02:00
|
|
|
api_kwargs: Optional[JSONDict] = None,
|
2020-10-06 19:28:40 +02:00
|
|
|
):
|
2022-10-07 11:51:53 +02:00
|
|
|
super().__init__(api_kwargs=api_kwargs)
|
2023-09-09 23:12:30 +02:00
|
|
|
self.id: str = id
|
2023-02-02 18:55:07 +01:00
|
|
|
self.from_user: User = from_user
|
|
|
|
self.currency: str = currency
|
|
|
|
self.total_amount: int = total_amount
|
|
|
|
self.invoice_payload: str = invoice_payload
|
|
|
|
self.shipping_option_id: Optional[str] = shipping_option_id
|
|
|
|
self.order_info: Optional[OrderInfo] = order_info
|
2017-05-19 19:41:06 +02:00
|
|
|
|
|
|
|
self._id_attrs = (self.id,)
|
|
|
|
|
2022-12-15 15:00:36 +01:00
|
|
|
self._freeze()
|
|
|
|
|
2017-07-23 21:14:38 +02:00
|
|
|
@classmethod
|
2024-07-01 19:59:54 +02:00
|
|
|
def de_json(
|
|
|
|
cls, data: Optional[JSONDict], bot: Optional["Bot"] = None
|
|
|
|
) -> Optional["PreCheckoutQuery"]:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
|
|
data = cls._parse_data(data)
|
2020-10-06 19:28:40 +02:00
|
|
|
|
2017-05-19 19:41:06 +02:00
|
|
|
if not data:
|
|
|
|
return None
|
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
data["from_user"] = User.de_json(data.pop("from", None), bot)
|
2017-05-19 19:41:06 +02:00
|
|
|
data["order_info"] = OrderInfo.de_json(data.get("order_info"), bot)
|
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
return super().de_json(data=data, bot=bot)
|
2017-05-19 19:41:06 +02:00
|
|
|
|
2023-09-09 23:12:30 +02:00
|
|
|
async def answer(
|
2020-12-30 13:41:07 +01:00
|
|
|
self,
|
|
|
|
ok: bool,
|
2023-05-18 07:57:59 +02:00
|
|
|
error_message: Optional[str] = None,
|
2022-05-18 17:18:44 +02:00
|
|
|
*,
|
2022-04-24 12:38:09 +02:00
|
|
|
read_timeout: ODVInput[float] = DEFAULT_NONE,
|
|
|
|
write_timeout: ODVInput[float] = DEFAULT_NONE,
|
|
|
|
connect_timeout: ODVInput[float] = DEFAULT_NONE,
|
|
|
|
pool_timeout: ODVInput[float] = DEFAULT_NONE,
|
2023-05-18 07:57:59 +02:00
|
|
|
api_kwargs: Optional[JSONDict] = None,
|
2020-12-30 13:41:07 +01:00
|
|
|
) -> bool:
|
2017-09-01 08:43:08 +02:00
|
|
|
"""Shortcut for::
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2022-04-24 12:38:09 +02:00
|
|
|
await bot.answer_pre_checkout_query(update.pre_checkout_query.id, *args, **kwargs)
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.answer_pre_checkout_query`.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2017-09-01 08:43:08 +02:00
|
|
|
"""
|
2022-04-24 12:38:09 +02:00
|
|
|
return await self.get_bot().answer_pre_checkout_query(
|
2020-12-30 13:41:07 +01:00
|
|
|
pre_checkout_query_id=self.id,
|
|
|
|
ok=ok,
|
|
|
|
error_message=error_message,
|
2022-04-24 12:38:09 +02:00
|
|
|
read_timeout=read_timeout,
|
|
|
|
write_timeout=write_timeout,
|
|
|
|
connect_timeout=connect_timeout,
|
|
|
|
pool_timeout=pool_timeout,
|
2020-12-30 13:41:07 +01:00
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|