TournamentResource (client.tournament)

Endpoints: • tournament.getLastTournament • tournamentTeam.getById • tournamentTeam.getByTournamentId

.get_by_id()

Get tournament by ID.

Signature

await client.tournament.get_by_id(tournament_id: 'str') -> 'Tournament'

Parameters

Name	Type	Default
tournament_id	str	Required

Return Models

Tournament

Field	Type	Required
_id	string	Optional
__v	integer	Optional
name	string	Optional
description	string	Optional
isActive	boolean	Optional
status	string	Optional
startAt	string	Optional
teamSize	number	Optional
teamCount	integer	Optional
roundsCount	integer	Optional
type	string	Optional
maxRarity	string	Optional
skillKey	string	Optional
autoQualify1stRound	array[string]	Optional
registered	TournamentRegistered	Optional
activeRound	integer	Optional
rounds	object	Optional
winnerTournamentTeam	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

TournamentMatch

Field	Type	Required
_id	string	Optional
__v	integer	Optional
matchIndex	integer	Optional
predecessors	TournamentMatchPredecessors	Optional
attacker	string	Optional
defender	string	Optional
isQualificationRound	boolean	Optional
battle	string	Optional
wonBy	string	Optional
possibleAttackerTeamIds	array[string]	Optional
possibleDefenderTeamIds	array[string]	Optional

TournamentMatchPredecessors

Field	Type	Required
_id	string	Optional
__v	integer	Optional
attacker	integer	Optional
defender	integer	Optional

TournamentRegistered

Field	Type	Required
_id	string	Optional
__v	integer	Optional
countries	array[string]	Optional
mus	array[string]	Optional
users	array[string]	Optional

TournamentRound

Field	Type	Required
_id	string	Optional
__v	integer	Optional
roundNumber	integer	Optional
cases	number	Optional
skillValue	number	Optional
isQualificationRound	boolean	Optional
matches	array[TournamentMatch]	Optional

---

.get_last_tournament()

Get the latest tournament details.

Signature

await client.tournament.get_last_tournament() -> 'Tournament'

Return Models

Tournament

Field	Type	Required
_id	string	Optional
__v	integer	Optional
name	string	Optional
description	string	Optional
isActive	boolean	Optional
status	string	Optional
startAt	string	Optional
teamSize	number	Optional
teamCount	integer	Optional
roundsCount	integer	Optional
type	string	Optional
maxRarity	string	Optional
skillKey	string	Optional
autoQualify1stRound	array[string]	Optional
registered	TournamentRegistered	Optional
activeRound	integer	Optional
rounds	object	Optional
winnerTournamentTeam	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

TournamentMatch

Field	Type	Required
_id	string	Optional
__v	integer	Optional
matchIndex	integer	Optional
predecessors	TournamentMatchPredecessors	Optional
attacker	string	Optional
defender	string	Optional
isQualificationRound	boolean	Optional
battle	string	Optional
wonBy	string	Optional
possibleAttackerTeamIds	array[string]	Optional
possibleDefenderTeamIds	array[string]	Optional

TournamentMatchPredecessors

Field	Type	Required
_id	string	Optional
__v	integer	Optional
attacker	integer	Optional
defender	integer	Optional

TournamentRegistered

Field	Type	Required
_id	string	Optional
__v	integer	Optional
countries	array[string]	Optional
mus	array[string]	Optional
users	array[string]	Optional

TournamentRound

Field	Type	Required
_id	string	Optional
__v	integer	Optional
roundNumber	integer	Optional
cases	number	Optional
skillValue	number	Optional
isQualificationRound	boolean	Optional
matches	array[TournamentMatch]	Optional

---

.get_team_by_id()

Get a tournament team by its ID.

Signature

await client.tournament.get_team_by_id(tournament_team_id: 'str') -> 'TournamentTeam'

Parameters

Name	Type	Default
tournament_team_id	str	Required

Return Models

TournamentTeam

Field	Type	Required
_id	string	Optional
__v	integer	Optional
tournament	string	Optional
number	integer	Optional
countries	array[string]	Optional
mus	array[string]	Optional
users	array[string]	Optional
participants	array[string]	Optional
colorScheme	string	Optional
estimatedUsers	integer	Optional
status	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

---

.get_teams_by_tournament()

Get all teams for a specific tournament.

Signature

await client.tournament.get_teams_by_tournament(tournament_id: 'str') -> 'list[TournamentTeam]'

Parameters

Name	Type	Default
tournament_id	str	Required

Return Models

TournamentTeam

Field	Type	Required
_id	string	Optional
__v	integer	Optional
tournament	string	Optional
number	integer	Optional
countries	array[string]	Optional
mus	array[string]	Optional
users	array[string]	Optional
participants	array[string]	Optional
colorScheme	string	Optional
estimatedUsers	integer	Optional
status	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

await client.tournament.invalidate_cache() -> 'None'

---