|
| 1 | +# Pyrogram - Telegram MTProto API Client Library for Python |
| 2 | +# Copyright (C) 2017-present Dan <https://github.com/delivrance> |
| 3 | +# |
| 4 | +# This file is part of Pyrogram. |
| 5 | +# |
| 6 | +# Pyrogram is free software: you can redistribute it and/or modify |
| 7 | +# it under the terms of the GNU Lesser General Public License as published |
| 8 | +# by the Free Software Foundation, either version 3 of the License, or |
| 9 | +# (at your option) any later version. |
| 10 | +# |
| 11 | +# Pyrogram is distributed in the hope that it will be useful, |
| 12 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | +# GNU Lesser General Public License for more details. |
| 15 | +# |
| 16 | +# You should have received a copy of the GNU Lesser General Public License |
| 17 | +# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>. |
| 18 | + |
| 19 | + |
| 20 | +from typing import Optional, Union |
| 21 | + |
| 22 | +import pyrogram |
| 23 | +from pyrogram import raw, types |
| 24 | + |
| 25 | + |
| 26 | +class PlaceGiftAuctionBid: |
| 27 | + async def place_gift_auction_bid( |
| 28 | + self: "pyrogram.Client", |
| 29 | + gift_id: int, |
| 30 | + star_count: int, |
| 31 | + user_id: Optional[Union[int, str]] = None, |
| 32 | + text: Optional["types.FormattedText"] = None, |
| 33 | + is_private: Optional[bool] = False, |
| 34 | + ) -> bool: |
| 35 | + """Places a bid on an auction gift. |
| 36 | +
|
| 37 | + .. include:: /_includes/usable-by/users.rst |
| 38 | +
|
| 39 | + Parameters: |
| 40 | + gift_id (``int``): |
| 41 | + Identifier of the gift to place the bid on. |
| 42 | +
|
| 43 | + star_count (``int``): |
| 44 | + The number of Telegram Stars to place in the bid. |
| 45 | +
|
| 46 | + user_id (``int`` | ``str``, *optional*): |
| 47 | + Unique identifier (int) or username (str) of the target chat you want to transfer the star gift to. |
| 48 | + For your personal cloud (Saved Messages) you can simply use "me" or "self". |
| 49 | + For a contact that exists in your Telegram address book you can use his phone number (str). |
| 50 | +
|
| 51 | + text (:obj:`~pyrogram.types.FormattedText`, *optional*): |
| 52 | + Text to show along with the gift. |
| 53 | + Must be empty if the receiver enabled paid messages. |
| 54 | +
|
| 55 | + is_private (``bool``, *optional*): |
| 56 | + Pass True to show gift text and sender only to the gift receiver, otherwise, everyone will be able to see them. |
| 57 | +
|
| 58 | + Returns: |
| 59 | + ``bool``: On success, True is returned. |
| 60 | +
|
| 61 | + Example: |
| 62 | + .. code-block:: python |
| 63 | +
|
| 64 | + # Place a bid of 100 stars on a gift auction for yourself |
| 65 | + await app.place_gift_auction_bid( |
| 66 | + gift_id=12345, |
| 67 | + star_count=100 |
| 68 | + ) |
| 69 | +
|
| 70 | + # Place a bid of 250 stars on a gift auction for another user with a message |
| 71 | + await app.place_gift_auction_bid( |
| 72 | + gift_id=12345, |
| 73 | + star_count=250, |
| 74 | + user_id="@KurimuzonAkuma", |
| 75 | + text=types.FormattedText( |
| 76 | + text="Here's a gift for you!" |
| 77 | + ) |
| 78 | + ) |
| 79 | + """ |
| 80 | + invoice = raw.types.InputInvoiceStarGiftAuctionBid( |
| 81 | + gift_id=gift_id, |
| 82 | + bid_amount=star_count, |
| 83 | + hide_name=is_private, |
| 84 | + update_bid=False, |
| 85 | + peer=await self.resolve_peer(user_id or "me"), |
| 86 | + message=await text.write() if text else None |
| 87 | + ) |
| 88 | + |
| 89 | + form = await self.invoke( |
| 90 | + raw.functions.payments.GetPaymentForm( |
| 91 | + invoice=invoice |
| 92 | + ) |
| 93 | + ) |
| 94 | + |
| 95 | + if star_count < 0: |
| 96 | + raise ValueError("Invalid amount of Telegram Stars specified.") |
| 97 | + |
| 98 | + if form.invoice.prices[0].amount > star_count: |
| 99 | + raise ValueError("Have not enough Telegram Stars.") |
| 100 | + |
| 101 | + r = await self.invoke( |
| 102 | + raw.functions.payments.SendStarsForm( |
| 103 | + form_id=form.form_id, |
| 104 | + invoice=invoice |
| 105 | + ) |
| 106 | + ) |
| 107 | + |
| 108 | + return isinstance(r, raw.types.payments.PaymentResult) |
0 commit comments