Source code for pyrogram.methods.payments.get_available_gifts
# 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 __future__ import annotations
import pyrogram
from pyrogram import raw, types
class GetAvailableGifts:
async def get_available_gifts(
self: pyrogram.Client,
) -> list[types.Gift]:
"""Get all available star gifts that can be sent to other users.
.. include:: /_includes/usable-by/users-bots.rst
Returns:
List of :obj:`~pyrogram.types.Gift`: On success, a list of star gifts is returned.
Example:
.. code-block:: python
await app.get_available_gifts()
"""
r = await self.invoke(raw.functions.payments.GetStarGifts(hash=0))
users = {i.id: i for i in r.users}
chats = {i.id: i for i in r.chats}
return types.List(
[
await types.Gift._parse_regular(self, gift, users=users, chats=chats)
for gift in r.gifts
]
)