pyrofork/pyrogram/methods/payments/transfer_star_gift.py
KurimuzonAkuma 8e7e5fb9ff pyrofork: update StarGift type to new layer
Signed-off-by: Yasir Aris <git@yasir.id>
2025-01-04 16:28:41 +07:00

65 lines
2.2 KiB
Python

# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram 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 General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import Union
import pyrogram
from pyrogram import raw
class TransferStarGift:
async def transfer_star_gift(
self: "pyrogram.Client",
chat_id: Union[int, str],
message_id: int,
) -> bool:
"""Transfer star gift to another user.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat you want to transfer the star gift to.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
message_id (``int``):
Unique message identifier of star gift.
Returns:
``bool``: On success, True is returned.
Example:
.. code-block:: python
# Show gift
app.transfer_star_gift(chat_id=123, message_id=123)
"""
peer = await self.resolve_peer(chat_id)
if not isinstance(peer, (raw.types.InputPeerUser, raw.types.InputPeerSelf)):
raise ValueError("chat_id must belong to a user.")
await self.invoke(
raw.functions.payments.TransferStarGift(
msg_id=message_id,
keep_original_details=keep_details
)
)
return True # TODO: