117 lines
5.0 KiB
Python
117 lines
5.0 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2025
|
|
# 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 the classes for Telegram Stars affiliates."""
|
|
from typing import TYPE_CHECKING, Optional
|
|
|
|
from telegram._chat import Chat
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._user import User
|
|
from telegram._utils.argumentparsing import de_json_optional
|
|
from telegram._utils.types import JSONDict
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import Bot
|
|
|
|
|
|
class AffiliateInfo(TelegramObject):
|
|
"""Contains information about the affiliate that received a commission via this transaction.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`affiliate_user`, :attr:`affiliate_chat`,
|
|
:attr:`commission_per_mille`, :attr:`amount`, and :attr:`nanostar_amount` are equal.
|
|
|
|
.. versionadded:: 21.9
|
|
|
|
Args:
|
|
affiliate_user (:class:`telegram.User`, optional): The bot or the user that received an
|
|
affiliate commission if it was received by a bot or a user
|
|
affiliate_chat (:class:`telegram.Chat`, optional): The chat that received an affiliate
|
|
commission if it was received by a chat
|
|
commission_per_mille (:obj:`int`): The number of Telegram Stars received by the affiliate
|
|
for each 1000 Telegram Stars received by the bot from referred users
|
|
amount (:obj:`int`): Integer amount of Telegram Stars received by the affiliate from the
|
|
transaction, rounded to 0; can be negative for refunds
|
|
nanostar_amount (:obj:`int`, optional): The number of
|
|
:tg-const:`~telegram.constants.Nanostar.VALUE` shares of Telegram
|
|
Stars received by the affiliate; from
|
|
:tg-const:`~telegram.constants.NanostarLimit.MIN_AMOUNT` to
|
|
:tg-const:`~telegram.constants.NanostarLimit.MAX_AMOUNT`;
|
|
can be negative for refunds
|
|
|
|
Attributes:
|
|
affiliate_user (:class:`telegram.User`): Optional. The bot or the user that received an
|
|
affiliate commission if it was received by a bot or a user
|
|
affiliate_chat (:class:`telegram.Chat`): Optional. The chat that received an affiliate
|
|
commission if it was received by a chat
|
|
commission_per_mille (:obj:`int`): The number of Telegram Stars received by the affiliate
|
|
for each 1000 Telegram Stars received by the bot from referred users
|
|
amount (:obj:`int`): Integer amount of Telegram Stars received by the affiliate from the
|
|
transaction, rounded to 0; can be negative for refunds
|
|
nanostar_amount (:obj:`int`): Optional. The number of
|
|
:tg-const:`~telegram.constants.Nanostar.VALUE` shares of Telegram
|
|
Stars received by the affiliate; from
|
|
:tg-const:`~telegram.constants.NanostarLimit.MIN_AMOUNT` to
|
|
:tg-const:`~telegram.constants.NanostarLimit.MAX_AMOUNT`;
|
|
can be negative for refunds
|
|
"""
|
|
|
|
__slots__ = (
|
|
"affiliate_chat",
|
|
"affiliate_user",
|
|
"amount",
|
|
"commission_per_mille",
|
|
"nanostar_amount",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
commission_per_mille: int,
|
|
amount: int,
|
|
affiliate_user: Optional["User"] = None,
|
|
affiliate_chat: Optional["Chat"] = None,
|
|
nanostar_amount: Optional[int] = None,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
) -> None:
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
self.affiliate_user: Optional[User] = affiliate_user
|
|
self.affiliate_chat: Optional[Chat] = affiliate_chat
|
|
self.commission_per_mille: int = commission_per_mille
|
|
self.amount: int = amount
|
|
self.nanostar_amount: Optional[int] = nanostar_amount
|
|
|
|
self._id_attrs = (
|
|
self.affiliate_user,
|
|
self.affiliate_chat,
|
|
self.commission_per_mille,
|
|
self.amount,
|
|
self.nanostar_amount,
|
|
)
|
|
self._freeze()
|
|
|
|
@classmethod
|
|
def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "AffiliateInfo":
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
data = cls._parse_data(data)
|
|
|
|
data["affiliate_user"] = de_json_optional(data.get("affiliate_user"), User, bot)
|
|
data["affiliate_chat"] = de_json_optional(data.get("affiliate_chat"), Chat, bot)
|
|
|
|
return super().de_json(data=data, bot=bot)
|