Objects
User
- class amari.objects.User(guild_id: int, data: dict, position: int | None = None, *, leaderboard: Leaderboard | None = None)[source]
An Amari user.
- guild_id
The user’s guild ID.
- Type:
int
- user_id
The user’s ID.
- Type:
int
- name
The user’s Discord username. This may not be up to date.
- Type:
str
- exp
The user’s experience points.
- Type:
int
- level
The user’s level.
- Type:
Optional[int]
- weeklyexp
The user’s weekly experience points.
- Type:
Optional[int]
- position
The user’s position in the leaderboard.
- Type:
Optional[int]
- leaderboard
The leaderboard object the user is in, if a leaderboard endpoint was fetched.
- Type:
Optional[Leaderboard]
Users
- class amari.objects.Users(guild_id: int, data: dict)[source]
An object which holds multiple users.
- guild_id
The guild ID.
- Type:
int
- total_members
The amount of users in the list.
- Type:
int
- queried_members
The amount of users requested.
- Type:
int
Leaderboard
- class amari.objects.Leaderboard(guild_id: int, data: dict)[source]
An Amari leaderboard.
- guild_id
The guild ID.
- Type:
int
- user_count
The number of users in the leaderboard.
- Type:
int
- total_count
The total number of users on Amari’s API in this leaderboard.
- Type:
Optional[int]
- add_user(user: User, /) Leaderboard[source]
Add a user to the leaderboard.
- Parameters:
user (User) – The user to add.
- Returns:
The leaderboard the user was added to, for fluent class chaining.
- Return type:
Rewards
- class amari.objects.Rewards(guild_id: int, data: dict)[source]
A collection of Amari reward roles.
- guild_id
The guild ID.
- Type:
int
- reward_count
The number of reward roles.
- Type:
int
- roles
The guild’s reward roles.
- Type:
Dict[int, RewardRole]
- get_role(role_id: int, /) RewardRole | None[source]
Get a reward role from the rewards.
- Parameters:
role_id (int) – The role’s ID.
- Returns:
The role, if found in the rewards.
- Return type:
Optional[RewardRole]