mirror of
https://github.com/PaiGramTeam/SIMNet.git
synced 2024-11-29 00:42:46 +00:00
14b107b5a1
Moves all subdirectories from 'simnet/client' to 'simnet/client/components' and adds the `__all__` variable to all affected files. This change is intended to improve code organization and make it easier to manage exported symbols from these modules.
49 lines
1.8 KiB
Python
49 lines
1.8 KiB
Python
from functools import partial
|
|
from typing import Optional, List
|
|
from simnet.client.components.wish.base import BaseWishClient
|
|
from simnet.models.starrail.wish import StarRailWish
|
|
from simnet.utils.enum_ import Game
|
|
from simnet.utils.paginator import WishPaginator
|
|
|
|
__all__ = ("StarRailWishClient",)
|
|
|
|
|
|
class StarRailWishClient(BaseWishClient):
|
|
"""The StarRailWishClient class for making requests towards the Wish API."""
|
|
|
|
async def wish_history(
|
|
self,
|
|
banner_type: int,
|
|
limit: Optional[int] = None,
|
|
lang: Optional[str] = None,
|
|
authkey: Optional[str] = None,
|
|
end_id: int = 0,
|
|
) -> List[StarRailWish]:
|
|
"""
|
|
Get the wish history for a list of banner types.
|
|
|
|
Args:
|
|
banner_type (int, optional): The banner types to get the wish history for.
|
|
limit (Optional[int] , optional): The maximum number of wishes to retrieve.
|
|
If not provided, all available wishes will be returned.
|
|
lang (Optional[str], optional): The language code to use for the request.
|
|
If not provided, the class default will be used.
|
|
authkey (Optional[str], optional): The authorization key for making the request.
|
|
end_id (int, optional): The ending ID of the last wish to retrieve.
|
|
|
|
Returns:
|
|
List[StarRailWish]: A list of StarRailWish objects representing the retrieved wishes.
|
|
"""
|
|
paginator = WishPaginator(
|
|
end_id,
|
|
partial(
|
|
self.get_wish_page,
|
|
banner_type=banner_type,
|
|
game=Game.STARRAIL,
|
|
authkey=authkey,
|
|
),
|
|
)
|
|
items = await paginator.get(limit)
|
|
wish = [StarRailWish(**i) for i in items]
|
|
return wish
|