Skip to content

Ban entry

Generic models for ban entries.

BanEntryRequest

A generic model for ban entry requests.

Parameters

provider: str Source for where the user or guild is banned. reason: str Why the user or guild is 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.

Attributes

provider: str Source for where the user or guild is banned. reason: str Why the user or guild is 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.

Source code in ravyapi/api/models/generic/ban_entry.py 
 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
class BanEntryRequest:
    """A generic model for ban entry requests.

    Parameters
    ----------
    provider: str
        Source for where the user or guild is banned.
    reason: str
        Why the user or guild is 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.

    Attributes
    ----------
    provider: str
        Source for where the user or guild is banned.
    reason: str
        Why the user or guild is 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.
    """

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

    def __init__(
        self, provider: str, reason: str, moderator: int, reason_key: str | None = None
    ) -> None:
        """
        Parameters
        ----------
        provider: str
            Source for where the user or guild is banned.
        reason: str
            Why the user or guild is 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.
        """
        self._provider: str = provider
        self._reason: str = reason
        self._moderator: int = moderator
        self._reason_key: str | None = reason_key

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

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

    @property
    def reason(self) -> str:
        """Why the user or guild is banned."""
        return self._reason

    @property
    def moderator(self) -> int:
        """User ID of the responsible moderator, usually Discord."""
        return self._moderator

    @property
    def reason_key(self) -> str | None:
        """Machine-readable version of the reason - only present for providers ravy and dservices."""
        return self._reason_key

    def to_json(self) -> dict[str, Any]:
        """Returns a JSON representation of the model.

        Returns
        -------
        dict[str, Any]
            A JSON representation of the model.
        """
        data = {
            "provider": self.provider,
            "reason": self.reason,
            "moderator": str(self.moderator),
        }

        if self.reason_key is not None:
            data["reason_key"] = self.reason_key

        return data

moderator: int property

User ID of the responsible moderator, usually Discord.

provider: str property

Source for where the user or guild is banned.

reason: str property

Why the user or guild is banned.

reason_key: str | None property

Machine-readable version of the reason - only present for providers ravy and dservices.

__init__(provider, reason, moderator, reason_key=None)

Parameters

provider: str Source for where the user or guild is banned. reason: str Why the user or guild is 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.

Source code in ravyapi/api/models/generic/ban_entry.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def __init__(
    self, provider: str, reason: str, moderator: int, reason_key: str | None = None
) -> None:
    """
    Parameters
    ----------
    provider: str
        Source for where the user or guild is banned.
    reason: str
        Why the user or guild is 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.
    """
    self._provider: str = provider
    self._reason: str = reason
    self._moderator: int = moderator
    self._reason_key: str | None = reason_key

to_json()

Returns a JSON representation of the model.

Returns

dict[str, Any] A JSON representation of the model.

Source code in ravyapi/api/models/generic/ban_entry.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
def to_json(self) -> dict[str, Any]:
    """Returns a JSON representation of the model.

    Returns
    -------
    dict[str, Any]
        A JSON representation of the model.
    """
    data = {
        "provider": self.provider,
        "reason": self.reason,
        "moderator": str(self.moderator),
    }

    if self.reason_key is not None:
        data["reason_key"] = self.reason_key

    return data

BanEntryResponse

A generic model for ban entry responses.

Attributes

data: dict[str, Any] The raw data returned from the Ravy API. provider: str Source for where the user or guild was banned. reason: str Why the user or guild was banned. reason_key: str | None Machine-readable version of the reason - only present for providers ravy and dservices. moderator: int User ID of the responsible moderator, usually Discord.

Source code in ravyapi/api/models/generic/ban_entry.py 
23
24
25
26
27
28
29
30
31
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
class BanEntryResponse:
    """A generic model for ban entry responses.

    Attributes
    ----------
    data: dict[str, Any]
        The raw data returned from the Ravy API.
    provider: str
        Source for where the user or guild was banned.
    reason: str
        Why the user or guild was banned.
    reason_key: str | None
        Machine-readable version of the reason - only present for providers ravy and dservices.
    moderator: int
        User ID of the responsible moderator, usually Discord.
    """

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

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._provider: str = data["provider"]
        self._reason: str = data["reason"]
        self._reason_key: str | None = data.get("reason_key")
        self._moderator: int = int(data["moderator"])

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(provider={self.provider!r}, reason={self.reason!r}, "
            f"reason_key={self.reason_key!r}, moderator={self.moderator!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 or guild was banned."""
        return self._provider

    @property
    def reason(self) -> str:
        """Why the user or guild was banned."""
        return self._reason

    @property
    def reason_key(self) -> str | None:
        """Machine-readable version of the reason - only present for providers ravy and dservices."""
        return self._reason_key

    @property
    def moderator(self) -> int:
        """User ID of the responsible moderator, usually Discord."""
        return self._moderator

data: dict[str, Any] property

The raw data returned from the Ravy API.

moderator: int property

User ID of the responsible moderator, usually Discord.

provider: str property

Source for where the user or guild was banned.

reason: str property

Why the user or guild was banned.

reason_key: str | None property

Machine-readable version of the reason - only present for providers ravy and dservices.