from dataclasses import dataclass, field
from typing import Any, Dict, List, Type
# ======================================== Result ========================================
[docs]
@dataclass
class Result:
"""HTTP request result wrapper.
Attributes
----------
status_code : int
The HTTP status code of the response.
message : str
The HTTP status message.
data : dict
The response data.
"""
status_code: int
message: str = "None"
data: dict = field(default_factory=dict)
# ======================================== Card Data ========================================
[docs]
@dataclass
class CardData:
"""Player card data.
Attributes
----------
small : str
Small card image URL.
large : str
Large card image URL.
wide : str
Wide card image URL.
id : str
Card ID.
"""
small: str
large: str
wide: str
id: str
# ======================================== Account ========================================
[docs]
@dataclass
class AccountV1:
"""Account V1 information.
Attributes
----------
puuid : str
The player's unique identifier.
region : str
The player's region.
account_level : int
The player's account level.
name : str
The player's game name.
tag : str
The player's tag.
card : CardData
The player's card data with image URLs.
last_update : str
Last update timestamp.
last_update_raw : int
Last update timestamp (raw).
"""
puuid: str
region: str
account_level: int
name: str
tag: str
card: CardData
last_update: str
last_update_raw: int
[docs]
@dataclass
class AccountV2:
"""Account V2 information.
Attributes
----------
puuid : str
The player's unique identifier.
region : str
The player's region.
account_level : int
The player's account level.
name : str
The player's game name.
tag : str
The player's tag.
card : str
The player's card ID.
title : str
The player's title.
platforms : List[str]
Available platforms.
updated_at : str
Update timestamp.
"""
puuid: str
region: str
account_level: int
name: str
tag: str
card: str
title: str
platforms: List[str]
updated_at: str
# ======================================== Content ========================================
[docs]
@dataclass
class ContentCharacter:
"""Content character structure.
Attributes
----------
name : str
Character name.
id : str
Character ID.
assetName : str
Asset name.
localizedNames : Dict[str, str]
Character names in different locales.
isPlayableCharacter : bool
Whether character is playable.
"""
name: str
id: str
assetName: str = ""
localizedNames: Dict[str, str] = field(default_factory=dict)
isPlayableCharacter: bool = False
[docs]
@dataclass
class ContentMap:
"""Content map structure.
Attributes
----------
name : str
Map name.
id : str
Map ID.
assetName : str
Asset name.
assetPath : str
Asset path.
localizedNames : Dict[str, str]
Map names in different locales.
"""
name: str
id: str
assetName: str = ""
assetPath: str = ""
localizedNames: Dict[str, str] = field(default_factory=dict)
[docs]
@dataclass
class ContentItem:
"""Generic content item structure.
Attributes
----------
name : str
Item name.
id : str
Item ID.
assetName : str
Asset name.
assetPath : str
Asset path.
localizedNames : Dict[str, str]
Item names in different locales.
"""
name: str
id: str
assetName: str = ""
assetPath: str = ""
localizedNames: Dict[str, str] = field(default_factory=dict)
[docs]
@dataclass
class ContentPlayerTitle:
"""Content player title structure.
Attributes
----------
name : str
Title name.
id : str
Title ID.
assetName : str
Asset name.
titleText : str
Display text for the title.
"""
name: str
id: str
assetName: str = ""
titleText: str = ""
[docs]
@dataclass
class ContentAct:
"""Content act structure.
Attributes
----------
name : str
Act name.
id : str
Act ID.
localizedNames : Dict[str, str]
Act names in different locales.
isActive : bool
Whether the act is currently active.
"""
name: str
id: str
localizedNames: Dict[str, str] = field(default_factory=dict)
isActive: bool = False
[docs]
@dataclass
class Content:
"""In-game content data.
Attributes
----------
version : str
Content version.
characters : List[ContentCharacter]
Available characters.
maps : List[ContentMap]
Available maps.
chromas : List[ContentItem]
Available chromas.
skins : List[ContentItem]
Available skins.
skin_levels : List[ContentItem]
Available skin levels.
equips : List[ContentItem]
Available equips.
game_modes : List[ContentItem]
Available game modes.
sprays : List[ContentItem]
Available sprays.
spray_levels : List[ContentItem]
Available spray levels.
charms : List[ContentItem]
Available charms.
charm_levels : List[ContentItem]
Available charm levels.
player_cards : List[ContentItem]
Available player cards.
player_titles : List[ContentPlayerTitle]
Available player titles.
acts : List[ContentAct]
Available acts.
ceremonies : List[ContentItem]
Available ceremonies.
"""
version: str
characters: List[ContentCharacter] = field(default_factory=list)
maps: List[ContentMap] = field(default_factory=list)
chromas: List[ContentItem] = field(default_factory=list)
skins: List[ContentItem] = field(default_factory=list)
skinLevels: List[ContentItem] = field(default_factory=list)
equips: List[ContentItem] = field(default_factory=list)
gameModes: List[ContentItem] = field(default_factory=list)
sprays: List[ContentItem] = field(default_factory=list)
sprayLevels: List[ContentItem] = field(default_factory=list)
charms: List[ContentItem] = field(default_factory=list)
charmLevels: List[ContentItem] = field(default_factory=list)
playerCards: List[ContentItem] = field(default_factory=list)
playerTitles: List[ContentPlayerTitle] = field(default_factory=list)
acts: List[ContentAct] = field(default_factory=list)
ceremonies: List[ContentItem] = field(default_factory=list)
# ======================================== Version ========================================
@dataclass
class Version:
"""Version response"""
region: str
branch: str
build_date: str
build_ver: str
last_checked: str
version: int
version_for_api: str
# ======================================== Endpoint Mapping ========================================
def _get_endpoint_model_map() -> dict[str, Type[Any]]:
"""Get the mapping of API endpoints to their response model classes.
Returns
-------
dict[str, Type[Any]]
Dictionary mapping endpoint paths to model classes for automatic deserialization.
"""
# Import here to avoid circular imports
from .enums import Endpoint
return {
# Account endpoints
Endpoint.ACCOUNT_BY_NAME_V1.value: AccountV1,
Endpoint.ACCOUNT_BY_NAME_V2.value: AccountV2,
# Content endpoints
Endpoint.CONTENT_V1.value: Content,
# Version endpoints
Endpoint.VERSION_V1.value: Version,
}
# Cached endpoint model map
_ENDPOINT_MODEL_MAP: dict[str, Type[Any]] | None = None
def get_endpoint_model_map() -> dict[str, Type[Any]]:
"""Get the cached endpoint model map, creating it if necessary.
Returns
-------
dict[str, Type[Any]]
Dictionary mapping endpoint paths to model classes.
"""
global _ENDPOINT_MODEL_MAP
if _ENDPOINT_MODEL_MAP is None:
_ENDPOINT_MODEL_MAP = _get_endpoint_model_map()
return _ENDPOINT_MODEL_MAP