mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 20:14:51 +00:00
91 lines
3.2 KiB
Python
91 lines
3.2 KiB
Python
# Pyrofork - Telegram MTProto API Client Library for Python
|
|
# 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/>.
|
|
|
|
import pyrogram
|
|
from pyrogram import raw
|
|
from pyrogram import types
|
|
from typing import Union
|
|
|
|
|
|
class GetStarsTransactions:
|
|
async def get_stars_transactions(
|
|
self: "pyrogram.Client",
|
|
chat_id: Union[int, str] = "me",
|
|
limit: int = 0,
|
|
offset: str = "",
|
|
is_inbound: bool = None,
|
|
is_outbound: bool = None,
|
|
is_ascending: bool = None
|
|
) -> "types.StarsStatus":
|
|
"""Get stars transactions.
|
|
|
|
.. include:: /_includes/usable-by/users-bots.rst
|
|
|
|
Parameters:
|
|
chat_id (``int`` | ``str``, *optional*):
|
|
Unique identifier (int) or username (str) of the target user.
|
|
You can also use chat public link in form of *t.me/<username>* (str).
|
|
default to self.
|
|
only for bots.
|
|
|
|
limit (``int``, *optional*):
|
|
Limits the number of transactions to be retrieved.
|
|
|
|
offset (``str``, *optional*):
|
|
Offset the list of transactions to be retrieved.
|
|
|
|
is_inbound (``bool``, *optional*):
|
|
True, if only inbound transactions should be retrieved.
|
|
|
|
is_outbound (``bool``, *optional*):
|
|
True, if only outbound transactions should be retrieved.
|
|
|
|
is_ascending (``bool``, *optional*):
|
|
True, if transactions should be returned in ascending order.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# get all transactions
|
|
app.get_stars_transactions()
|
|
|
|
# get all inbound transactions
|
|
app.get_stars_transactions(is_inbound=True)
|
|
|
|
# get all outbound transactions
|
|
app.get_stars_transactions(is_outbound=True)
|
|
|
|
# get all transactions in ascending order
|
|
app.get_stars_transactions(is_ascending=True)
|
|
|
|
Returns:
|
|
:obj:`~pyrogram.types.StarsStatus`: On success, a :obj:`~pyrogram.types.StarsStatus` object is returned.
|
|
"""
|
|
peer = await self.resolve_peer(chat_id)
|
|
|
|
r = await self.invoke(
|
|
raw.functions.payments.GetStarsTransactions(
|
|
peer=peer,
|
|
limit=limit,
|
|
offset=offset,
|
|
inbound=is_inbound,
|
|
outbound=is_outbound,
|
|
ascending=is_ascending
|
|
)
|
|
)
|
|
return types.StarsStatus._parse(self, r)
|