Client

__init__(http_client=aiosonic.HTTPClient())

Initializes the API client.

Parameters:

Name	Type	Description	Default
http_client	aiosonic.HTTPClient	The http client to use	aiosonic.HTTPClient()

get_agent_by_uuid(uuid, language=None) async

Gets an agent by the UUID.

Parameters:

Name	Type	Description	Default
uuid	str	the agent's uuid	required
language	typing.Optional[str]	the language	None

Returns:

Type	Description
agents.Agent	agents.Agent: the agent

get_agents(language=None, is_playable_character=None) async

Gets the agents.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None
is_playable_character	typing.Optional[bool]	if the agent can be used	None

Returns:

Type	Description
list[agents.Agent]	list[agents.Agent]: a list of the agents

get_buddies(language=None) async

Gets the buddies.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[buddies.Buddy]	list[buddies.Buddy]: a list of the buddies

get_buddy_by_uuid(uuid, language=None) async

Gets a buddy by the uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the buddy's uuid	required
language	typing.Optional[str]	the language	None

Returns:

Type	Description
buddies.Buddy	buddies.Buddy: the buddy

get_bundle_by_uuid(uuid, language=None) async

Gets a bundle by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the bundle's uuid	required
language	typing.Optional[str]	the language	None

Returns:

Type	Description
bundles.Bundle	bundles.Bundle: the bundle

get_bundles(language=None) async

Gets the bundles.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[bundles.Bundle]	list[bundles.Bundle]: a list of the bundles

get_ceremonies(language=None) async

Gets the ceremonies.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[ceremonies.Ceremony]	list[ceremonies.Ceremony]: a list of the ceremonies

get_ceremony_by_uuid(uuid, language=None) async

Gets a ceremony by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the ceremony's uuid	required
language	typing.Optional[str]	the language	None

Returns:

Type	Description
ceremonies.Ceremony	ceremonies.Ceremony: the ceremony

get_competitive_season_by_uuid(uuid, language=None) async

Gets a competitive season by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the competitive season's uuid	required
language	str	the language	None

Returns:

Type	Description
seasons.CompetitiveSeason	seasons.CompetitiveSeason: the season

get_competitive_seasons(language=None) async

Gets the competitive seasons.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[seasons.CompetitiveSeason]	list[seasons.CompetitiveSeason]: a list of the competitive seasons

get_competitive_tier_by_uuid(uuid, language=None) async

Gets a competitive tier by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the competitive tier's uuid	required
language	typing.Optional[str]	the language	None

Returns:

Type	Description
competitive_tiers.CompetitiveTier	competitive_tiers.CompetitiveTier: the competitive tier

get_competitive_tiers(language=None) async

Gets the competitive tiers.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[competitive_tiers.CompetitiveTier]	list[competitive_tiers.CompetitiveTier]: a list of the competitive tiers

get_content_tier_by_uuid(uuid, language=None) async

Gets a content tier by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the content tier's uuid	required
language	typing.Optional[str]	the language	None

Returns:

Type	Description
content_tiers.ContentTier	content_tiers.ContentTier: the content tier

get_content_tiers(language=None) async

Gets the content tiers.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[content_tiers.ContentTier]	list[content_tiers.ContentTier]: a list of the content tiers

get_contract_by_uuid(uuid, language=None) async

Gets a contract by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the contract's uuid	required
language	typing.Optional[str]	the language	None

Returns:

Type	Description
contracts.Contract	contracts.Contract: the contract

get_contracts(language=None) async

Gets the contracts.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[contracts.Contract]	list[contracts.Contract]: a list of the contracts

get_currencies(language=None) async

Gets the currencies.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[currencies.Currency]	list[currencies.Currency]: a list of the currencies

get_currency_by_uuid(uuid, language=None) async

Gets a currency by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the currency's uuid	required
language	str	the language	None

Returns:

Type	Description
currencies.Currency	currencies.Curreny: the currency

get_event_by_uuid(uuid, language=None) async

Gets a event by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the event's uuid	required
language	str	the language	None

Returns:

Type	Description
events.Event	events.Event: the event

get_events(language=None) async

Gets the events.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[events.Event]	list[events.Event]: a list of the events

get_gamemode_by_uuid(uuid, language=None) async

Gets a gamemode by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the gamemode's uuid	required
language	str	the language	None

Returns:

Type	Description
gamemodes.Gamemode	gamemodes.Gamemode: the gamemode

get_gamemode_equippable_by_uuid(uuid, language=None) async

Gets a gamemode equippable by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the gamemode equippable's uuid	required
language	str	the language	None

Returns:

Type	Description
gamemodes.GamemodeEquippable	gamemodes.GamemodeEquippable: the gamemode equippable

get_gamemode_equippables(language=None) async

Gets the gamemodes equippables.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[gamemodes.GamemodeEquippable]	list[gamemodes.Gamemode]: a list of the gamemodee eqippables

get_gamemodes(language=None) async

Gets the gamemodes.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[gamemodes.Gamemode]	list[gamemodes.Gamemode]: a list of the gamemodes

get_gear(language=None) async

Gets the gear.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[gear.Gear]	list[gear.gear]: a list of the gear

get_gear_by_uuid(uuid, language=None) async

Gets a gear by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the gear's uuid	required
language	str	the language	None

Returns:

Type	Description
gear.Gear	gear.gear: the gear

get_level_borders(language=None) async

Gets the level borders.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[level_borders.LevelBorder]	list[level_borders.LevelBorder]: a list of the level borders

get_level_borders_by_uuid(uuid, language=None) async

Gets a level border by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the level border's uuid	required
language	str	the language	None

Returns:

Type	Description
level_borders.LevelBorder	level_borders.LevelBorder: the level border

get_map_by_uuid(uuid, language=None) async

Gets a map by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the map's uuid	required
language	str	the language	None

Returns:

Type	Description
maps.Map	maps.Map: the map

get_maps(language=None) async

Gets the maps.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[maps.Map]	list[maps.Map]: a list of the maps

get_player_card_by_uuid(uuid, language=None) async

Gets a player card by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the player card's uuid	required
language	str	the language	None

Returns:

Type	Description
player_cards.PlayerCard	player_cards.PlayerCard: the player card

get_player_cards(language=None) async

Gets the player cards.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[player_cards.PlayerCard]	list[player_cards.PlayerCard]: a list of the player cards

get_player_title_by_uuid(uuid, language=None) async

Gets a player title by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the player title's uuid	required
language	str	the language	None

Returns:

Type	Description
player_titles.PlayerTitle	player_titles.Playertitle: the player title

get_player_titles(language=None) async

Gets the player titles.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[player_titles.PlayerTitle]	list[player_titles.Playertitle]: a list of the player titles

get_season_by_uuid(uuid, language=None) async

Gets a season by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the season's uuid	required
language	str	the language	None

Returns:

Type	Description
seasons.Season	seasons.Season: the season

get_seasons(language=None) async

Gets the seasons.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[seasons.Season]	list[seasons.Season]: a list of the seasons

get_spray_by_uuid(uuid, language=None) async

Gets a spray by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the spray's uuid	required
language	str	the language	None

Returns:

Type	Description
sprays.Spray	sprays.Spray: the spray

get_spray_level_by_uuid(uuid, language=None) async

Gets a spray level by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the spray level's uuid	required
language	str	the language	None

Returns:

Type	Description
sprays.Spray	sprays.SprayLevel: the spray level

get_spray_levels(language=None) async

Gets the spray levels.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[sprays.SprayLevel]	list[sprays.SprayLevel]: a list of the spray levels

get_sprays(language=None) async

Gets the sprays.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[sprays.Spray]	list[sprays.Spray]: a list of the sprays

get_themes(language=None) async

Gets the themes.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[themes.Theme]	list[themes.Theme]: a list of the themes

get_themes_by_uuid(uuid, language=None) async

Gets a theme by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the theme's uuid	required
language	str	the language	None

Returns:

Type	Description
themes.Theme	themes.Theme: the theme

get_version() async

Gets the version.

Returns:

Type	Description
version.Version	version.Version: the version

get_weapon_skin_by_uuid(uuid, language=None) async

Gets a weapon skin by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the weapon skin's uuid	required
language	str	the language	None

Returns:

Type	Description
weapons.WeaponSkin	weapons.WeaponSkin: the weapon skin

get_weapon_skin_chroma_by_uuid(uuid, language=None) async

Gets a weapon skin by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the weapon skin's uuid	required
language	str	the language	None

Returns:

Type	Description
weapons.WeaponSkinChroma	weapons.WeaponSkinChroma: the weapon skin

get_weapon_skin_chromas(language=None) async

Gets weapon skin chromas.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[weapons.WeaponSkinChroma]	list[weapons.WeaponSkinChroma]: a list of the weapon skin chromas

get_weapon_skins(language=None) async

Gets weapon skins.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[weapons.WeaponSkin]	list[weapons.WeaponSkin]: a list of the weapon skins

get_weapons(language=None) async

Gets weapons.

Parameters:

Name	Type	Description	Default
language	typing.Optional[str]	the language	None

Returns:

Type	Description
list[weapons.Weapon]	list[weapons.Weapon]: a list of the weapons

get_weapons_by_uuid(uuid, language=None) async

Gets a weapon by its uuid.

Parameters:

Name	Type	Description	Default
uuid	str	the weapon's uuid	required
language	str	the language	None

Returns:

Type	Description
weapons.Weapon	weapons.Weapon: the weapon