Source code for pyrogram.raw.types.stars_subscription
# 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! #
# # # # # # # # # # # # # # # # # # # # # # # #
[docs]
class StarsSubscription(TLObject): # type: ignore
"""Represents a `Telegram Star subscription ยป <https://core.telegram.org/api/invites#paid-invite-links>`_.
Constructor of :obj:`~pyrogram.raw.base.StarsSubscription`.
Details:
- Layer: ``229``
- ID: ``2E6EAB1A``
Parameters:
id (``str``):
Subscription ID.
peer (:obj:`Peer <pyrogram.raw.base.Peer>`):
Identifier of the associated private chat.
until_date (``int`` ``32-bit``):
Expiration date of the current subscription period.
pricing (:obj:`StarsSubscriptionPricing <pyrogram.raw.base.StarsSubscriptionPricing>`):
Pricing of the subscription in Telegram Stars.
canceled (``bool``, *optional*):
Whether this subscription was cancelled.
can_refulfill (``bool``, *optional*):
Whether we left the associated private channel, but we can still rejoin it using `payments.fulfillStarsSubscription <https://core.telegram.org/method/payments.fulfillStarsSubscription>`_ because the current subscription period hasn't expired yet.
missing_balance (``bool``, *optional*):
Whether this subscription has expired because there are not enough stars on the user's balance to extend it.
bot_canceled (``bool``, *optional*):
Set if this `bot subscription <https://core.telegram.org/api/subscriptions#bot-subscriptions>`_ was cancelled by the bot
chat_invite_hash (``str``, *optional*):
Invitation link, used to renew the subscription after cancellation or expiration.
title (``str``, *optional*):
For bot subscriptions, the title of the subscription invoice
photo (:obj:`WebDocument <pyrogram.raw.base.WebDocument>`, *optional*):
For bot subscriptions, the photo from the subscription invoice
invoice_slug (``str``, *optional*):
For bot subscriptions, the `identifier <https://core.telegram.org/api/links#invoice-links>`_ of the subscription invoice
"""
__slots__: List[str] = ["id", "peer", "until_date", "pricing", "canceled", "can_refulfill", "missing_balance", "bot_canceled", "chat_invite_hash", "title", "photo", "invoice_slug"]
ID = 0x2e6eab1a
QUALNAME = "types.StarsSubscription"
def __init__(self, *, id: str, peer: "raw.base.Peer", until_date: int, pricing: "raw.base.StarsSubscriptionPricing", canceled: Optional[bool] = None, can_refulfill: Optional[bool] = None, missing_balance: Optional[bool] = None, bot_canceled: Optional[bool] = None, chat_invite_hash: Optional[str] = None, title: Optional[str] = None, photo: "raw.base.WebDocument" = None, invoice_slug: Optional[str] = None) -> None:
self.id = id # string
self.peer = peer # Peer
self.until_date = until_date # int
self.pricing = pricing # StarsSubscriptionPricing
self.canceled = canceled # flags.0?true
self.can_refulfill = can_refulfill # flags.1?true
self.missing_balance = missing_balance # flags.2?true
self.bot_canceled = bot_canceled # flags.7?true
self.chat_invite_hash = chat_invite_hash # flags.3?string
self.title = title # flags.4?string
self.photo = photo # flags.5?WebDocument
self.invoice_slug = invoice_slug # flags.6?string
@staticmethod
def read(b: BytesIO, *args: Any) -> "StarsSubscription":
flags = Int.read(b)
canceled = True if flags & (1 << 0) else False
can_refulfill = True if flags & (1 << 1) else False
missing_balance = True if flags & (1 << 2) else False
bot_canceled = True if flags & (1 << 7) else False
id = String.read(b)
peer = TLObject.read(b)
until_date = Int.read(b)
pricing = TLObject.read(b)
chat_invite_hash = String.read(b) if flags & (1 << 3) else None
title = String.read(b) if flags & (1 << 4) else None
photo = TLObject.read(b) if flags & (1 << 5) else None
invoice_slug = String.read(b) if flags & (1 << 6) else None
return StarsSubscription(id=id, peer=peer, until_date=until_date, pricing=pricing, canceled=canceled, can_refulfill=can_refulfill, missing_balance=missing_balance, bot_canceled=bot_canceled, chat_invite_hash=chat_invite_hash, title=title, photo=photo, invoice_slug=invoice_slug)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 0) if self.canceled else 0
flags |= (1 << 1) if self.can_refulfill else 0
flags |= (1 << 2) if self.missing_balance else 0
flags |= (1 << 7) if self.bot_canceled else 0
flags |= (1 << 3) if self.chat_invite_hash is not None else 0
flags |= (1 << 4) if self.title is not None else 0
flags |= (1 << 5) if self.photo is not None else 0
flags |= (1 << 6) if self.invoice_slug is not None else 0
b.write(Int(flags))
b.write(String(self.id))
b.write(self.peer.write())
b.write(Int(self.until_date))
b.write(self.pricing.write())
if self.chat_invite_hash is not None:
b.write(String(self.chat_invite_hash))
if self.title is not None:
b.write(String(self.title))
if self.photo is not None:
b.write(self.photo.write())
if self.invoice_slug is not None:
b.write(String(self.invoice_slug))
return b.getvalue()