Source code for pyrogram.raw.types.star_ref_program

#  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 io import BytesIO

from pyrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from pyrogram.raw.core import TLObject
from pyrogram import raw
from typing import List, Optional, Any

# # # # # # # # # # # # # # # # # # # # # # # #
#               !!! WARNING !!!               #
#          This is a generated file!          #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #




class StarRefProgram(TLObject):  # type: ignore
    """Info about an `affiliate program offered by a bot <https://core.telegram.org/api/bots/referrals>`_

    Constructor of :obj:`~pyrogram.raw.base.StarRefProgram`.

    Details:
        - Layer: ``229``
        - ID: ``DD0C66F2``

    Parameters:
        bot_id (``int`` ``64-bit``):
            ID of the bot that offers the program

        commission_permille (``int`` ``32-bit``):
            An affiliate gets a commission of `starRefProgram <https://core.telegram.org/constructor/starRefProgram>`_. ``commission_permille`` ‰ `Telegram Stars <https://core.telegram.org/api/stars>`_ for every mini app transaction made by users they refer

        duration_months (``int`` ``32-bit``, *optional*):
            An affiliate gets a commission for every mini app transaction made by users they refer, for ``duration_months`` months after a referral link is imported, starting the bot for the first time

        end_date (``int`` ``32-bit``, *optional*):
            Point in time (Unix timestamp) when the affiliate program will be closed (optional, if not set the affiliate program isn't scheduled to be closed)

        daily_revenue_per_user (:obj:`StarsAmount <pyrogram.raw.base.StarsAmount>`, *optional*):
            The amount of daily revenue per user in Telegram Stars of the bot that created the affiliate program. To obtain the approximated revenue per referred user, multiply this value by ``commission_permille`` and divide by ``1000``.

    Functions:
        This object can be returned by 1 function.

        .. currentmodule:: pyrogram.raw.functions

        .. autosummary::
            :nosignatures:

            bots.UpdateStarRefProgram
    """

    __slots__: List[str] = ["bot_id", "commission_permille", "duration_months", "end_date", "daily_revenue_per_user"]

    ID = 0xdd0c66f2
    QUALNAME = "types.StarRefProgram"

    def __init__(self, *, bot_id: int, commission_permille: int, duration_months: Optional[int] = None, end_date: Optional[int] = None, daily_revenue_per_user: "raw.base.StarsAmount" = None) -> None:
        self.bot_id = bot_id  # long
        self.commission_permille = commission_permille  # int
        self.duration_months = duration_months  # flags.0?int
        self.end_date = end_date  # flags.1?int
        self.daily_revenue_per_user = daily_revenue_per_user  # flags.2?StarsAmount

    @staticmethod
    def read(b: BytesIO, *args: Any) -> "StarRefProgram":
        
        flags = Int.read(b)
        
        bot_id = Long.read(b)
        
        commission_permille = Int.read(b)
        
        duration_months = Int.read(b) if flags & (1 << 0) else None
        end_date = Int.read(b) if flags & (1 << 1) else None
        daily_revenue_per_user = TLObject.read(b) if flags & (1 << 2) else None
        
        return StarRefProgram(bot_id=bot_id, commission_permille=commission_permille, duration_months=duration_months, end_date=end_date, daily_revenue_per_user=daily_revenue_per_user)

    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
        flags |= (1 << 1) if self.end_date is not None else 0
        flags |= (1 << 2) if self.daily_revenue_per_user is not None else 0
        b.write(Int(flags))
        
        b.write(Long(self.bot_id))
        
        b.write(Int(self.commission_permille))
        
        if self.duration_months is not None:
            b.write(Int(self.duration_months))
        
        if self.end_date is not None:
            b.write(Int(self.end_date))
        
        if self.daily_revenue_per_user is not None:
            b.write(self.daily_revenue_per_user.write())
        
        return b.getvalue()