Source code for hydrogram.raw.functions.bots.update_star_ref_program
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram 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.
#
# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from io import BytesIO
from hydrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from hydrogram.raw.core import TLObject
from hydrogram import raw
from typing import List, Optional, Any
# # # # # # # # # # # # # # # # # # # # # # # #
# !!! WARNING !!! #
# This is a generated file! #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #
[docs]
class UpdateStarRefProgram(TLObject): # type: ignore
"""Create, edit or delete the affiliate program of a bot we own
Details:
- Layer: ``223``
- ID: ``778B5AB3``
Parameters:
bot (:obj:`InputUser <hydrogram.raw.base.InputUser>`):
The bot
commission_permille (``int`` ``32-bit``):
The permille commission rate: it indicates the share of Telegram Stars received by affiliates for every transaction made by users they referred inside of the bot. The minimum and maximum values for this parameter are contained in the starref_min_commission_permille and starref_max_commission_permille client configuration parameters. Can be 0 to terminate the affiliate program. Both the duration and the commission may only be raised after creation of the program: to lower them, the program must first be terminated and a new one created.
duration_months (``int`` ``32-bit``, *optional*):
Indicates the duration of the affiliate program; if not set, there is no expiration date.
Returns:
:obj:`StarRefProgram <hydrogram.raw.base.StarRefProgram>`
"""
__slots__: List[str] = ["bot", "commission_permille", "duration_months"]
ID = 0x778b5ab3
QUALNAME = "functions.bots.UpdateStarRefProgram"
def __init__(self, *, bot: "raw.base.InputUser", commission_permille: int, duration_months: Optional[int] = None) -> None:
self.bot = bot # InputUser
self.commission_permille = commission_permille # int
self.duration_months = duration_months # flags.0?int
@staticmethod
def read(b: BytesIO, *args: Any) -> "UpdateStarRefProgram":
flags = Int.read(b)
bot = TLObject.read(b)
commission_permille = Int.read(b)
duration_months = Int.read(b) if flags & (1 << 0) else None
return UpdateStarRefProgram(bot=bot, commission_permille=commission_permille, duration_months=duration_months)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 0) if self.duration_months is not None else 0
b.write(Int(flags))
b.write(self.bot.write())
b.write(Int(self.commission_permille))
if self.duration_months is not None:
b.write(Int(self.duration_months))
return b.getvalue()