Users

Implementations for the users endpoint.

Users

Bases: HTTPAwareEndpoint

A class with implementations for the users endpoint.

add_ban async

add_ban(user_id: int, *, provider: str, reason: str, moderator: int, reason_key: str | None = None) -> None

Add ban.

Parameters:

Name	Type	Description	Default
user_id	int	User ID of the user to ban.	required
provider	str	Source for where the user was banned.	required
reason	str	Why the user was banned.	required
moderator	int	User ID of the responsible moderator, usually Discord.	required
reason_key	str | None	Machine-readable version of the reason - only present for providers ravy and dservices.	None

Raises:

Type	Description
TypeError	If any parameters are of invalid types.
ValueError	If any parameters are invalid values.

get_bans async

get_bans(user_id: int) -> GetBansResponse

Get bans.

Parameters:

Name	Type	Description	Default
user_id	int	User ID of the user to look up.	required

Raises:

Type	Description
TypeError	If any parameters are of invalid types.

Returns:

Type	Description
GetBansResponse	A model response from ravyapi.api.endpoints.users.Users.get_bans. Located as ravyapi.api.models.users.GetBansResponse.

get_pronouns async

get_pronouns(user_id: int) -> GetPronounsResponse

Get pronouns.

Parameters:

Name	Type	Description	Default
user_id	int	User ID of the user to look up.	required

Raises:

Type	Description
TypeError	If any parameters are of invalid types.

Returns:

Type	Description
GetPronounsResponse	A model response from ravyapi.api.endpoints.users.Users.get_pronouns. Located as ravyapi.api.models.users.GetPronounsResponse.

get_reputation async

get_reputation(user_id: int) -> GetReputationResponse

Get reputation.

Parameters:

Name	Type	Description	Default
user_id	int	User ID of the user to look up.	required

Raises:

Type	Description
TypeError	If any parameters are of invalid types.

Returns:

Type	Description
GetReputationResponse	A model response from ravyapi.api.endpoints.users.Users.get_reputation. Located as ravyapi.api.models.users.GetReputationResponse.

get_user async

get_user(user_id: int) -> GetUserResponse

Get extensive user information.

Parameters:

Name	Type	Description	Default
user_id	int	User ID of the user to look up.	required

Raises:

Type	Description
TypeError	If any parameters are of invalid types.

Returns:

Type	Description
GetUserResponse	A model response from ravyapi.api.endpoints.users.Users.get_user. Located as ravyapi.api.models.users.GetUserResponse.

get_whitelists async

get_whitelists(user_id: int) -> GetWhitelistsResponse

Get whitelists.

Parameters:

Name	Type	Description	Default
user_id	int	User ID of the user to look up.	required

Raises:

Type	Description
TypeError	If any parameters are of invalid types.

Returns:

Type	Description
GetWhitelistsResponse	A model response from ravyapi.api.endpoints.users.Users.get_whitelists. Located as ravyapi.api.models.users.GetWhitelistsResponse.