Skip to content

Ksoft

API models for the ksoft endpoint.

GetKSoftBanResponse

A model response from ravyapi.api.endpoints.ksoft.KSoft.get_ban.

Attributes

data : dict[str, Any] The raw data returned from the Ravy API. found: bool Whether the user was found in the database. user_id : int | None The user's ID, if found. tag : str | None The user's tag, if found. reason : str | None Reason for the ban, if found. proof : str | None Evidence for the ban, if found. moderator : int | None User ID of the responsible moderator, if found. severe : bool | None Whether the ban is severe, if found. timestamp : str | None A timestamp of the ban, if found.

Source code in ravyapi/api/models/ksoft.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
 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
class GetKSoftBanResponse:
    """A model response from `ravyapi.api.endpoints.ksoft.KSoft.get_ban`.

    Attributes
    ----------
    data : dict[str, Any]
        The raw data returned from the Ravy API.
    found: bool
        Whether the user was found in the database.
    user_id : int | None
        The user's ID, if found.
    tag : str | None
        The user's tag, if found.
    reason : str | None
        Reason for the ban, if found.
    proof : str | None
        Evidence for the ban, if found.
    moderator : int | None
        User ID of the responsible moderator, if found.
    severe : bool | None
        Whether the ban is severe, if found.
    timestamp : str | None
        A timestamp of the ban, if found.
    """

    __slots__: tuple[str, ...] = (
        "_data",
        "_found",
        "_user_id",
        "_tag",
        "_reason",
        "_proof",
        "_moderator",
        "_severe",
        "_timestamp",
    )

    def __init__(self, data: dict[str, Any]) -> None:
        self._data: dict[str, Any] = data
        self._found: bool = data["found"]
        user_id: str | None = data.get("id")
        self._user_id: int | None = int(user_id) if user_id else None
        self._tag: str | None = data.get("tag")
        self._reason: str | None = data.get("reason")
        self._proof: str | None = data.get("proof")
        moderator: str | None = data.get("moderator")
        self._moderator: int | None = int(moderator) if moderator else None
        self._severe: bool | None = data.get("severe")
        self._timestamp: str | None = data.get("timestamp")

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__module__}.{self.__class__.__qualname__}"
            f"(found={self.found!r}, user_id={self.user_id!r}, tag={self.tag!r}, "
            f"reason={self.reason!r}, proof={self.proof!r}, moderator={self.moderator!r}, "
            f"severe={self.severe!r}, timestamp={self.timestamp!r})"
        )

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

    @property
    def found(self) -> bool:
        """Whether the user was found in the database."""
        return self._found

    @property
    def user_id(self) -> int | None:
        """The user's ID, if found."""
        return self._user_id

    @property
    def tag(self) -> str | None:
        """The user's tag, if found."""
        return self._tag

    @property
    def reason(self) -> str | None:
        """Reason for the ban, if found."""
        return self._reason

    @property
    def proof(self) -> str | None:
        """Evidence for the ban, if found."""
        return self._proof

    @property
    def moderator(self) -> int | None:
        """User ID of the responsible moderator, if found."""
        return self._moderator

    @property
    def severe(self) -> bool | None:
        """Whether the ban is severe, if found."""
        return self._severe

    @property
    def timestamp(self) -> str | None:
        """A timestamp of the ban, if found."""
        return self._timestamp

data: dict[str, Any] property

The raw data returned from the Ravy API.

found: bool property

Whether the user was found in the database.

moderator: int | None property

User ID of the responsible moderator, if found.

proof: str | None property

Evidence for the ban, if found.

reason: str | None property

Reason for the ban, if found.

severe: bool | None property

Whether the ban is severe, if found.

tag: str | None property

The user's tag, if found.

timestamp: str | None property

A timestamp of the ban, if found.

user_id: int | None property

The user's ID, if found.