Add send_star_gift method

Signed-off-by: wulan17 <wulan17@nusantararom.org>
This commit is contained in:
KurimuzonAkuma 2024-10-07 10:00:37 +03:00 committed by wulan17
parent bb96ca8597
commit d4649275e9
No known key found for this signature in database
GPG key ID: 318CD6CD3A6AC0A5
3 changed files with 107 additions and 1 deletions

View file

@ -358,6 +358,7 @@ def pyrogram_api():
send_paid_media
send_paid_reaction
send_payment_form
send_star_gift
""",
password="""
Password

View file

@ -29,6 +29,7 @@ from .send_invoice import SendInvoice
from .send_paid_media import SendPaidMedia
from .send_paid_reaction import SendPaidReaction
from .send_payment_form import SendPaymentForm
from .send_star_gift import SendStarGift
class Payments(
ApplyGiftCode,
@ -42,6 +43,7 @@ class Payments(
SendPaidReaction,
SendPaidMedia,
SendInvoice,
SendPaymentForm
SendPaymentForm,
SendStarGift
):
pass

View file

@ -0,0 +1,103 @@
# Pyrofork - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
#
# This file is part of Pyrofork.
#
# Pyrofork 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.
#
# Pyrofork 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 Pyrofork. If not, see <http://www.gnu.org/licenses/>.
from typing import Optional, Union, List
import pyrogram
from pyrogram import raw, types, enums, utils
class SendStarGift:
async def send_star_gift(
self: "pyrogram.Client",
chat_id: Union[int, str],
star_gift_id: int,
text: Optional[str] = None,
parse_mode: Optional["enums.ParseMode"] = None,
entities: Optional[List["types.MessageEntity"]] = None,
hide_my_name: Optional[bool] = None,
) -> bool:
"""Send star gift.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
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).
star_gift_id (``int``):
Unique identifier of star gift.
text (``str``, *optional*):
Text of the message to be sent.
parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
entities (List of :obj:`~pyrogram.types.MessageEntity`, *optional*):
List of special entities that appear in message text, which can be specified instead of *parse_mode*.
hide_my_name (``bool``, *optional*):
If True, your name will be hidden from visitors to the gift recipient's profile.
Returns:
``bool``: On success, True is returned.
Example:
.. code-block:: python
# Send gift
app.send_star_gift(chat_id=chat_id, star_gift_id=123)
"""
peer = await self.resolve_peer(chat_id)
if isinstance(peer, raw.types.InputPeerUser):
peer = raw.types.InputUser(user_id=peer.user_id, access_hash=peer.access_hash)
elif isinstance(peer, raw.types.InputPeerSelf):
peer = raw.types.InputUserSelf()
else:
raise ValueError("chat_id must belong to a user.")
text, entities = (await utils.parse_text_entities(self, text, parse_mode, entities)).values()
invoice = raw.types.InputInvoiceStarGift(
user_id=peer,
gift_id=star_gift_id,
hide_name=hide_my_name,
message=raw.types.TextWithEntities(text=text, entities=entities) if text else None
)
form = await self.invoke(
raw.functions.payments.GetPaymentForm(
invoice=invoice
)
)
await self.invoke(
raw.functions.payments.SendStarsForm(
form_id=form.form_id,
invoice=invoice
)
)
return True