Users

API models for the users endpoint.

GetBansResponse

A model response from ravyapi.api.endpoints.users.Users.get_bans.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
trust	Trust	The user's ravyapi.api.models.generic.trust.Trust trust model.
bans	list[BanEntryResponse]	A list of the user's ravyapi.api.models.generic.ban_entry.BanEntryResponse ban models.

bans property

bans: list[BanEntryResponse]

A list of the user's ravyapi.api.models.generic.ban_entry.BanEntryResponse ban models.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

trust property

trust: Trust

The user's ravyapi.api.models.generic.trust.Trust trust model.

GetPronounsResponse

A model response from ravyapi.api.endpoints.users.Users.get_pronouns.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
pronouns	str	The user's pronouns.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

pronouns property

pronouns: str

The user's pronouns.

GetReputationResponse

A model response from ravyapi.api.endpoints.users.Users.get_reputation.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
rep	list[ReputationEntry]	A list of the user's ravyapi.api.models.users.ReputationEntry reputation models.
trust	Trust	The user's ravyapi.api.models.generic.trust.Trust trust model.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

rep property

rep: list[ReputationEntry]

A list of the user's ravyapi.api.models.users.ReputationEntry reputation models.

trust property

trust: Trust

The user's ravyapi.api.models.generic.trust.Trust trust model.

GetUserResponse

A model response from ravyapi.api.endpoints.users.Users.get_user.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
pronouns	str	The user's pronouns.
trust	Trust	The user's ravyapi.api.models.generic.trust.Trust trust model.
whitelists	list[WhitelistEntry]	A list of the user's ravyapi.api.models.users.WhitelistEntry whitelist models.
bans	list[BanEntryResponse]	A list of the user's ravyapi.api.models.generic.ban_entry.BanEntryResponse ban models.
rep	list[ReputationEntry]	A list of the user's ravyapi.api.models.users.ReputationEntry reputation models.
sentinel	SentinelEntry	The user's ravyapi.api.models.users.SentinelEntry sentinel model.

bans property

bans: list[BanEntryResponse]

A list of the user's ravyapi.api.models.generic.ban_entry.BanEntryResponse ban models.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

pronouns property

pronouns: str

The user's pronouns.

rep property

rep: list[ReputationEntry]

A list of the user's ravyapi.api.models.users.ReputationEntry reputation models.

sentinel property

sentinel: SentinelEntry

The user's ravyapi.api.models.users.SentinelEntry sentinel model.

trust property

trust: Trust

The user's ravyapi.api.models.generic.trust.Trust trust model.

whitelists property

whitelists: list[WhitelistEntry]

A list of the user's ravyapi.api.models.users.WhitelistEntry whitelist models.

GetWhitelistsResponse

A model response from ravyapi.api.endpoints.users.Users.get_whitelists.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
whitelists	list[WhitelistEntry]	A list of the user's ravyapi.api.models.users.WhitelistEntry whitelist models.
trust	Trust	The user's ravyapi.api.models.generic.trust.Trust trust model.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

trust property

trust: Trust

The user's ravyapi.api.models.generic.trust.Trust trust model.

whitelists property

whitelists: list[WhitelistEntry]

A list of the user's ravyapi.api.models.users.WhitelistEntry whitelist models.

ReputationEntry

A model for a user's reputation entry.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
provider	str	Source for the reputation data.
score	float	Normalized value (0-1) for reputation of the user, 0.5 is default.
upvotes	int | None	Amount of upvotes this user has received, optional.
downvotes	int | None	Amount of downvotes this user has received, optional.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

downvotes property

downvotes: int | None

Amount of downvotes this user has received, optional.

provider property

provider: str

Source for the reputation data.

score property

score: float

Normalized value (0-1) for reputation of the user, 0.5 is default.

upvotes property

upvotes: int | None

Amount of upvotes this user has received, optional.

SentinelEntry

A model for a user's sentinel entry.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
verified	bool	Whether this user has linked their account to sentinel.
internal_id	str	Internal ID for debug purposes.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

internal_id property

internal_id: str

Internal ID for debug purposes.

verified property

verified: bool

Whether this user has linked their account to sentinel.

WhitelistEntry

A model for a user's whitelist entry.

Attributes:

Name	Type	Description
data	dict[str, Any]	The raw data returned from the Ravy API.
provider	str	Source for where the user is whitelisted.
reason	str	Why the user is whitelisted, usually STAFF.

data property

data: dict[str, Any]

The raw data returned from the Ravy API.

provider property

provider: str

Source for where the user is whitelisted.

reason property

reason: str

Why the user is whitelisted, usually STAFF.