Source code for pyrogram.methods.stickers.replace_sticker_in_set

#  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 __future__ import annotations


import pyrogram
from pyrogram import raw, types, utils
from pyrogram.file_id import FileType


class ReplaceStickerInSet:
    async def replace_sticker_in_set(
        self: pyrogram.Client,
        user_id: int | str,
        old_sticker: str,
        sticker: types.InputSticker,
    ) -> types.StickerSet:
        """Replace an existing sticker in a sticker set with a new one.

        .. include:: /_includes/usable-by/users-bots.rst

        Parameters:
            user_id (``int`` | ``str``):
                Unique identifier (int) or username (str) of the sticker set owner.

            old_sticker (``str``):
                File identifier of the replaced sticker.

            sticker (:obj:`~pyrogram.types.InputSticker`):
                The new sticker.

        Returns:
            :obj:`~pyrogram.types.StickerSet`: The updated sticker set is returned.
        """
        r = await self.invoke(
            raw.functions.stickers.ReplaceSticker(
                sticker=utils.get_input_media_from_file_id(
                    file_id=old_sticker, expected_file_type=FileType.STICKER
                ).id,
                new_sticker=await sticker.write(self, user_id),
            )
        )

        return await types.StickerSet._parse(self, r)