Source code for pyrogram.methods.stories.get_story_albums

#  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


class GetStoryAlbums:
    async def get_story_albums(
        self: pyrogram.Client,
        chat_id: int | str,
    ) -> list[types.StoryAlbum]:
        """Get all story albums (highlights) from a chat or channel.

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

        Parameters:
            chat_id (``int`` | ``str``):
                Unique identifier (int) or username (str) of the target chat.

        Returns:
            List of :obj:`~pyrogram.types.StoryAlbum`: On success, a list of story albums is returned.

        Example:
            .. code-block:: python

                albums = await app.get_story_albums(chat_id)
                for album in albums:
                    print(album)
        """
        peer = await self.resolve_peer(chat_id)
        r = await self.invoke(
            raw.functions.stories.GetAlbums(
                peer=peer,
                hash=0,
            )
        )

        chat = await self.get_chat(chat_id) if hasattr(self, "get_chat") else None

        return types.List(
            [types.StoryAlbum._parse(self, album, chat=chat) for album in getattr(r, "albums", [])]
        )