Skip to content

Users

API models for the users endpoint.

GetBansResponse

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

Attributes

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.

Source code in ravyapi/api/models/users.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
class GetBansResponse:
    """A model response from `ravyapi.api.endpoints.users.Users.get_bans`.

    Attributes
    ----------
    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.
    """

    __slots__: tuple[str, ...] = ("_data", "_trust", "_bans")

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._trust = Trust(data["trust"])
        self._bans = [BanEntryResponse(ban) for ban in data["bans"]]

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(trust={self.trust!r}, bans={self.bans!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def trust(self) -> Trust:
        """The user's `ravyapi.api.models.generic.trust.Trust` trust model."""
        return self._trust

    @property
    def bans(self) -> list[BanEntryResponse]:
        """A list of the user's `ravyapi.api.models.generic.ban_entry.BanEntryResponse` ban models."""
        return self._bans

bans property

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

data property

The raw data returned from the Ravy API.

trust property

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

GetPronounsResponse

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

Attributes

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

Source code in ravyapi/api/models/users.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
class GetPronounsResponse:
    """A model response from `ravyapi.api.endpoints.users.Users.get_pronouns`.

    Attributes
    ----------
    data : dict[str, Any]
        The raw data returned from the Ravy API.
    pronouns : str
        The user's pronouns.
    """

    __slots__: tuple[str, ...] = ("_data", "_pronouns")

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._pronouns: str = data["pronouns"]

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(pronouns={self.pronouns!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def pronouns(self) -> str:
        """The user's pronouns."""
        return self._pronouns

data property

The raw data returned from the Ravy API.

pronouns property

The user's pronouns.

GetReputationResponse

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

Attributes

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.

Source code in ravyapi/api/models/users.py 
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
class GetReputationResponse:
    """A model response from `ravyapi.api.endpoints.users.Users.get_reputation`.

    Attributes
    ----------
    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.
    """

    __slots__: tuple[str, ...] = ("_data", "_rep", "_trust")

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._rep = [ReputationEntry(rep) for rep in data["rep"]]
        self._trust = Trust(data["trust"])

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(rep={self.rep!r}, trust={self.trust!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def rep(self) -> list[ReputationEntry]:
        """A list of the user's `ravyapi.api.models.users.ReputationEntry` reputation models."""
        return self._rep

    @property
    def trust(self) -> Trust:
        """The user's `ravyapi.api.models.generic.trust.Trust` trust model."""
        return self._trust

data property

The raw data returned from the Ravy API.

rep property

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

trust property

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

GetUserResponse

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

Attributes

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.

Source code in ravyapi/api/models/users.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class GetUserResponse:
    """A model response from `ravyapi.api.endpoints.users.Users.get_user`.

    Attributes
    ----------
    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.
    """

    __slots__: tuple[str, ...] = (
        "_data",
        "_pronouns",
        "_trust",
        "_whitelists",
        "_bans",
        "_rep",
        "_sentinel",
    )

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._pronouns: str = data["pronouns"]
        self._trust: Trust = Trust(data["trust"])
        self._whitelists: list[WhitelistEntry] = [
            WhitelistEntry(whitelist) for whitelist in data["whitelists"]
        ]
        self._bans: list[BanEntryResponse] = [
            BanEntryResponse(ban) for ban in data["bans"]
        ]
        self._rep: list[ReputationEntry] = [ReputationEntry(rep) for rep in data["rep"]]
        self._sentinel: SentinelEntry = SentinelEntry(data["sentinel"])

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(pronouns={self.pronouns!r}, trust={self.trust!r}, "
            f"whitelists={self.whitelists!r}, bans={self.bans!r}, "
            f"rep={self.rep!r}, sentinel={self.sentinel!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def pronouns(self) -> str:
        """The user's pronouns."""
        return self._pronouns

    @property
    def trust(self) -> Trust:
        """The user's `ravyapi.api.models.generic.trust.Trust` trust model."""
        return self._trust

    @property
    def whitelists(self) -> list[WhitelistEntry]:
        """A list of the user's `ravyapi.api.models.users.WhitelistEntry` whitelist models."""
        return self._whitelists

    @property
    def bans(self) -> list[BanEntryResponse]:
        """A list of the user's `ravyapi.api.models.generic.ban_entry.BanEntryResponse` ban models."""
        return self._bans

    @property
    def rep(self) -> list[ReputationEntry]:
        """A list of the user's `ravyapi.api.models.users.ReputationEntry` reputation models."""
        return self._rep

    @property
    def sentinel(self) -> SentinelEntry:
        """The user's `ravyapi.api.models.users.SentinelEntry` sentinel model."""
        return self._sentinel

bans property

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

data property

The raw data returned from the Ravy API.

pronouns property

The user's pronouns.

rep property

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

sentinel property

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

trust property

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

whitelists property

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

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.

Source code in ravyapi/api/models/users.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
class GetWhitelistsResponse:
    """A model response from `ravyapi.api.endpoints.users.Users.get_whitelists`.

    Attributes
    ----------
    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.
    """

    __slots__: tuple[str, ...] = ("_data", "_whitelists", "_trust")

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._whitelists = [
            WhitelistEntry(whitelist) for whitelist in data["whitelists"]
        ]
        self._trust = Trust(data["trust"])

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(whitelists={self.whitelists!r}, trust={self.trust!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def whitelists(self) -> list[WhitelistEntry]:
        """A list of the user's `ravyapi.api.models.users.WhitelistEntry` whitelist models."""
        return self._whitelists

    @property
    def trust(self) -> Trust:
        """The user's `ravyapi.api.models.generic.trust.Trust` trust model."""
        return self._trust

data property

The raw data returned from the Ravy API.

trust property

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

whitelists property

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

ReputationEntry

A model for a user's reputation entry.

Attributes

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.

Source code in ravyapi/api/models/users.py 
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
class ReputationEntry:
    """A model for a user's reputation entry.

    Attributes
    ----------
    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.
    """

    __slots__: tuple[str, ...] = (
        "_data",
        "_provider",
        "_score",
        "_upvotes",
        "_downvotes",
    )

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._provider: str = data["provider"]
        self._score: float = data["score"]
        self._upvotes: int | None = data.get("upvotes")
        self._downvotes: int | None = data.get("downvotes")

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(provider={self.provider!r}, score={self.score!r}, "
            f"upvotes={self.upvotes!r}, downvotes={self.downvotes!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def provider(self) -> str:
        """Source for the reputation data."""
        return self._provider

    @property
    def score(self) -> float:
        """Normalized value (0-1) for reputation of the user, 0.5 is default."""
        return self._score

    @property
    def upvotes(self) -> int | None:
        """Amount of upvotes this user has received, optional."""
        return self._upvotes

    @property
    def downvotes(self) -> int | None:
        """Amount of downvotes this user has received, optional."""
        return self._downvotes

data property

The raw data returned from the Ravy API.

downvotes property

Amount of downvotes this user has received, optional.

provider property

Source for the reputation data.

score property

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

upvotes property

Amount of upvotes this user has received, optional.

SentinelEntry

A model for a user's sentinel entry.

Attributes

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.

Source code in ravyapi/api/models/users.py 
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
class SentinelEntry:
    """A model for a user's sentinel entry.

    Attributes
    ----------
    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.
    """

    __slots__: tuple[str, ...] = ("_data", "_verified", "_internal_id")

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._verified: bool = data["verified"]
        self._internal_id: str = str(data["id"])

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(verified={self.verified!r}, internal_id={self.internal_id!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def verified(self) -> bool:
        """Whether this user has linked their account to sentinel."""
        return self._verified

    @property
    def internal_id(self) -> str:
        """Internal ID for debug purposes."""
        return self._internal_id

data property

The raw data returned from the Ravy API.

internal_id property

Internal ID for debug purposes.

verified property

Whether this user has linked their account to sentinel.

WhitelistEntry

A model for a user's whitelist entry.

Attributes

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.

Source code in ravyapi/api/models/users.py 
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
class WhitelistEntry:
    """A model for a user's whitelist entry.

    Attributes
    ----------
    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.
    """

    __slots__: tuple[str, ...] = ("_data", "_provider", "_reason")

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._provider: str = data["provider"]
        self._reason: str = data["reason"]

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(provider={self.provider!r}, reason={self.reason!r})"
        )

    @property
    def data(self) -> dict[str, Any]:
        """The raw data returned from the Ravy API."""
        return self._data

    @property
    def provider(self) -> str:
        """Source for where the user is whitelisted."""
        return self._provider

    @property
    def reason(self) -> str:
        """Why the user is whitelisted, usually STAFF."""
        return self._reason

data property

The raw data returned from the Ravy API.

provider property

Source for where the user is whitelisted.

reason property

Why the user is whitelisted, usually STAFF.