Skip to content

Users

Implementations for the users endpoint.

Users

Bases: HTTPAwareEndpoint

A class with implementations for the users endpoint.

Source code in ravyapi/api/endpoints/users.py 
 32
 33
 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
120
121
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
154
155
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
196
197
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
class Users(HTTPAwareEndpoint):
    """A class with implementations for the `users` endpoint."""

    __slots__: tuple[str, ...] = ()

    @with_permission_check("users")
    async def get_user(self: HTTPAwareEndpoint, user_id: int) -> GetUserResponse:
        """Get extensive user information.

        Parameters
        ----------
        user_id : int
            User ID of the user to look up.

        Raises
        ------
        TypeError
            If any parameters are of invalid types.

        Returns
        -------
        GetUserResponse
            A model response from `ravyapi.api.endpoints.users.Users.get_user`.
            Located as `ravyapi.api.models.users.GetUserResponse`.
        """
        if not isinstance(user_id, int):
            raise TypeError('Parameter "user_id" must be of type "int"')

        return GetUserResponse(
            await self._http.get(self._http.paths.users(user_id).route)
        )

    @with_permission_check("users.pronouns")
    async def get_pronouns(
        self: HTTPAwareEndpoint, user_id: int
    ) -> GetPronounsResponse:
        """Get pronouns.

        Parameters
        ----------
        user_id : int
            User ID of the user to look up.

        Raises
        ------
        TypeError
            If any parameters are of invalid types.

        Returns
        -------
        GetPronounsResponse
            A model response from `ravyapi.api.endpoints.users.Users.get_pronouns`.
            Located as `ravyapi.api.models.users.GetPronounsResponse`.
        """
        if not isinstance(user_id, int):
            raise TypeError('Parameter "user_id" must be of type "int"')

        return GetPronounsResponse(
            await self._http.get(self._http.paths.users(user_id).pronouns)
        )

    @with_permission_check("users.bans")
    async def get_bans(self: HTTPAwareEndpoint, user_id: int) -> GetBansResponse:
        """Get bans.

        Parameters
        ----------
        user_id : int
            User ID of the user to look up.

        Raises
        ------
        TypeError
            If any parameters are of invalid types.

        Returns
        -------
        GetBansResponse
            A model response from `ravyapi.api.endpoints.users.Users.get_bans`.
            Located as `ravyapi.api.models.users.GetBansResponse`.
        """
        if not isinstance(user_id, int):
            raise TypeError('Parameter "user_id" must be of type "int"')

        return GetBansResponse(
            await self._http.get(self._http.paths.users(user_id).bans)
        )

    @with_permission_check("admin.bans")
    async def add_ban(
        self: HTTPAwareEndpoint,
        user_id: int,
        *,
        provider: str,
        reason: str,
        moderator: int,
        reason_key: str | None = None,
    ) -> None:
        """Add ban.

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

        Raises
        ------
        TypeError
            If any parameters are of invalid types.
        ValueError
            If any parameters are invalid values.
        """
        if not isinstance(user_id, int):
            raise TypeError('Parameter "user_id" must be of type "int"')

        if not isinstance(provider, str):
            raise TypeError('Parameter "provider" must be of type "str"')

        if not provider:
            raise ValueError('Parameter "provider" must not be empty')

        if not isinstance(reason, str):
            raise TypeError('Parameter "reason" must be of type "str"')

        if not reason:
            raise ValueError('Parameter "reason" must not be empty')

        if not isinstance(moderator, int):
            raise TypeError('Parameter "moderator" must be of type "int"')

        if reason_key is not None and not isinstance(reason_key, str):
            raise TypeError('Parameter "reason_key" must be of type "str"')

        if reason_key is not None and not reason_key:
            raise ValueError('Parameter "reason_key" must not be empty')

        await self._http.post(
            self._http.paths.users(user_id).bans,
            json=BanEntryRequest(provider, reason, moderator, reason_key).to_json(),
        )

    @with_permission_check("users.whitelists")
    async def get_whitelists(
        self: HTTPAwareEndpoint, user_id: int
    ) -> GetWhitelistsResponse:
        """Get whitelists.

        Parameters
        ----------
        user_id : int
            User ID of the user to look up.

        Raises
        ------
        TypeError
            If any parameters are of invalid types.

        Returns
        -------
        GetWhitelistsResponse
            A model response from `ravyapi.api.endpoints.users.Users.get_whitelists`.
            Located as `ravyapi.api.models.users.GetWhitelistsResponse`.
        """
        if not isinstance(user_id, int):
            raise TypeError('Parameter "user_id" must be of type "int"')

        return GetWhitelistsResponse(
            await self._http.get(self._http.paths.users(user_id).whitelists)
        )

    @with_permission_check("users.rep")
    async def get_reputation(
        self: HTTPAwareEndpoint, user_id: int
    ) -> GetReputationResponse:
        """Get reputation.

        Parameters
        ----------
        user_id : int
            User ID of the user to look up.

        Raises
        ------
        TypeError
            If any parameters are of invalid types.

        Returns
        -------
        GetReputationResponse
            A model response from `ravyapi.api.endpoints.users.Users.get_reputation`.
            Located as `ravyapi.api.models.users.GetReputationResponse`.
        """
        if not isinstance(user_id, int):
            raise TypeError('Parameter "user_id" must be of type "int"')

        return GetReputationResponse(
            await self._http.get(self._http.paths.users(user_id).reputation)
        )

add_ban(user_id, *, provider, reason, moderator, reason_key=None) async

Add ban.

Parameters

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

Raises

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

Source code in ravyapi/api/endpoints/users.py 
120
121
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
@with_permission_check("admin.bans")
async def add_ban(
    self: HTTPAwareEndpoint,
    user_id: int,
    *,
    provider: str,
    reason: str,
    moderator: int,
    reason_key: str | None = None,
) -> None:
    """Add ban.

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

    Raises
    ------
    TypeError
        If any parameters are of invalid types.
    ValueError
        If any parameters are invalid values.
    """
    if not isinstance(user_id, int):
        raise TypeError('Parameter "user_id" must be of type "int"')

    if not isinstance(provider, str):
        raise TypeError('Parameter "provider" must be of type "str"')

    if not provider:
        raise ValueError('Parameter "provider" must not be empty')

    if not isinstance(reason, str):
        raise TypeError('Parameter "reason" must be of type "str"')

    if not reason:
        raise ValueError('Parameter "reason" must not be empty')

    if not isinstance(moderator, int):
        raise TypeError('Parameter "moderator" must be of type "int"')

    if reason_key is not None and not isinstance(reason_key, str):
        raise TypeError('Parameter "reason_key" must be of type "str"')

    if reason_key is not None and not reason_key:
        raise ValueError('Parameter "reason_key" must not be empty')

    await self._http.post(
        self._http.paths.users(user_id).bans,
        json=BanEntryRequest(provider, reason, moderator, reason_key).to_json(),
    )

get_bans(user_id) async

Get bans.

Parameters

user_id : int User ID of the user to look up.

Raises

TypeError If any parameters are of invalid types.

Returns

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

Source code in ravyapi/api/endpoints/users.py 
 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
@with_permission_check("users.bans")
async def get_bans(self: HTTPAwareEndpoint, user_id: int) -> GetBansResponse:
    """Get bans.

    Parameters
    ----------
    user_id : int
        User ID of the user to look up.

    Raises
    ------
    TypeError
        If any parameters are of invalid types.

    Returns
    -------
    GetBansResponse
        A model response from `ravyapi.api.endpoints.users.Users.get_bans`.
        Located as `ravyapi.api.models.users.GetBansResponse`.
    """
    if not isinstance(user_id, int):
        raise TypeError('Parameter "user_id" must be of type "int"')

    return GetBansResponse(
        await self._http.get(self._http.paths.users(user_id).bans)
    )

get_pronouns(user_id) async

Get pronouns.

Parameters

user_id : int User ID of the user to look up.

Raises

TypeError If any parameters are of invalid types.

Returns

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

Source code in ravyapi/api/endpoints/users.py 
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
@with_permission_check("users.pronouns")
async def get_pronouns(
    self: HTTPAwareEndpoint, user_id: int
) -> GetPronounsResponse:
    """Get pronouns.

    Parameters
    ----------
    user_id : int
        User ID of the user to look up.

    Raises
    ------
    TypeError
        If any parameters are of invalid types.

    Returns
    -------
    GetPronounsResponse
        A model response from `ravyapi.api.endpoints.users.Users.get_pronouns`.
        Located as `ravyapi.api.models.users.GetPronounsResponse`.
    """
    if not isinstance(user_id, int):
        raise TypeError('Parameter "user_id" must be of type "int"')

    return GetPronounsResponse(
        await self._http.get(self._http.paths.users(user_id).pronouns)
    )

get_reputation(user_id) async

Get reputation.

Parameters

user_id : int User ID of the user to look up.

Raises

TypeError If any parameters are of invalid types.

Returns

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

Source code in ravyapi/api/endpoints/users.py 
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
@with_permission_check("users.rep")
async def get_reputation(
    self: HTTPAwareEndpoint, user_id: int
) -> GetReputationResponse:
    """Get reputation.

    Parameters
    ----------
    user_id : int
        User ID of the user to look up.

    Raises
    ------
    TypeError
        If any parameters are of invalid types.

    Returns
    -------
    GetReputationResponse
        A model response from `ravyapi.api.endpoints.users.Users.get_reputation`.
        Located as `ravyapi.api.models.users.GetReputationResponse`.
    """
    if not isinstance(user_id, int):
        raise TypeError('Parameter "user_id" must be of type "int"')

    return GetReputationResponse(
        await self._http.get(self._http.paths.users(user_id).reputation)
    )

get_user(user_id) async

Get extensive user information.

Parameters

user_id : int User ID of the user to look up.

Raises

TypeError If any parameters are of invalid types.

Returns

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

Source code in ravyapi/api/endpoints/users.py 
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
@with_permission_check("users")
async def get_user(self: HTTPAwareEndpoint, user_id: int) -> GetUserResponse:
    """Get extensive user information.

    Parameters
    ----------
    user_id : int
        User ID of the user to look up.

    Raises
    ------
    TypeError
        If any parameters are of invalid types.

    Returns
    -------
    GetUserResponse
        A model response from `ravyapi.api.endpoints.users.Users.get_user`.
        Located as `ravyapi.api.models.users.GetUserResponse`.
    """
    if not isinstance(user_id, int):
        raise TypeError('Parameter "user_id" must be of type "int"')

    return GetUserResponse(
        await self._http.get(self._http.paths.users(user_id).route)
    )

get_whitelists(user_id) async

Get whitelists.

Parameters

user_id : int User ID of the user to look up.

Raises

TypeError If any parameters are of invalid types.

Returns

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

Source code in ravyapi/api/endpoints/users.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
@with_permission_check("users.whitelists")
async def get_whitelists(
    self: HTTPAwareEndpoint, user_id: int
) -> GetWhitelistsResponse:
    """Get whitelists.

    Parameters
    ----------
    user_id : int
        User ID of the user to look up.

    Raises
    ------
    TypeError
        If any parameters are of invalid types.

    Returns
    -------
    GetWhitelistsResponse
        A model response from `ravyapi.api.endpoints.users.Users.get_whitelists`.
        Located as `ravyapi.api.models.users.GetWhitelistsResponse`.
    """
    if not isinstance(user_id, int):
        raise TypeError('Parameter "user_id" must be of type "int"')

    return GetWhitelistsResponse(
        await self._http.get(self._http.paths.users(user_id).whitelists)
    )