mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-22 23:27:49 +01:00
93 lines
3.7 KiB
Python
93 lines
3.7 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2018
|
|
# 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 ShippingQuery."""
|
|
|
|
from telegram import TelegramObject, User, ShippingAddress
|
|
|
|
|
|
class ShippingQuery(TelegramObject):
|
|
"""This object contains information about an incoming shipping query.
|
|
|
|
Note:
|
|
* In Python `from` is a reserved word, use `from_user` instead.
|
|
|
|
Attributes:
|
|
id (:obj:`str`): Unique query identifier.
|
|
from_user (:class:`telegram.User`): User who sent the query.
|
|
invoice_payload (:obj:`str`): Bot specified invoice payload.
|
|
shipping_address (:class:`telegram.ShippingAddress`): User specified shipping address.
|
|
bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods.
|
|
|
|
Args:
|
|
id (:obj:`str`): Unique query identifier.
|
|
from_user (:class:`telegram.User`): User who sent the query.
|
|
invoice_payload (:obj:`str`): Bot specified invoice payload.
|
|
shipping_address (:class:`telegram.ShippingAddress`): User specified shipping address.
|
|
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self, id, from_user, invoice_payload, shipping_address, bot=None, **kwargs):
|
|
self.id = id
|
|
self.from_user = from_user
|
|
self.invoice_payload = invoice_payload
|
|
self.shipping_address = shipping_address
|
|
|
|
self.bot = bot
|
|
|
|
self._id_attrs = (self.id,)
|
|
|
|
@classmethod
|
|
def de_json(cls, data, bot):
|
|
if not data:
|
|
return None
|
|
|
|
data = super(ShippingQuery, cls).de_json(data, bot)
|
|
|
|
data['from_user'] = User.de_json(data.pop('from'), bot)
|
|
data['shipping_address'] = ShippingAddress.de_json(data.get('shipping_address'), bot)
|
|
|
|
return cls(**data)
|
|
|
|
def to_dict(self):
|
|
data = super(ShippingQuery, self).to_dict()
|
|
|
|
data['from'] = data.pop('from_user', None)
|
|
|
|
return data
|
|
|
|
def answer(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.answer_shipping_query(update.shipping_query.id, *args, **kwargs)
|
|
|
|
Args:
|
|
ok (:obj:`bool`): Specify True if delivery to the specified address is possible and
|
|
False if there are any problems (for example, if delivery to the specified address
|
|
is not possible).
|
|
shipping_options (List[:class:`telegram.ShippingOption`], optional): Required if ok is
|
|
True. A JSON-serialized array of available shipping options.
|
|
error_message (:obj:`str`, optional): Required if ok is False. Error message in human
|
|
readable form that explains why it is impossible to complete the order (e.g.
|
|
"Sorry, delivery to your desired address is unavailable'). Telegram will display
|
|
this message to the user.
|
|
|
|
"""
|
|
return self.bot.answer_shipping_query(self.id, *args, **kwargs)
|