Skip to content

Client

Module containing the client interfacing for interactions.

Client

The client interface for interacting with the Ravy API.

Attributes

closed : bool Whether or not the client is closed. avatars : Avatars The avatars endpoint. guilds : Guilds The guilds endpoint. ksoft : KSoft The ksoft endpoint. users : Users The users endpoint. urls : URLs The urls endpoint. tokens : Tokens The tokens endpoint.

Source code in ravyapi/client.py 
 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
125
126
127
128
129
130
131
132
133
134
135
136
class Client:
    """The client interface for interacting with the Ravy API.

    Attributes
    ----------
    closed : bool
        Whether or not the client is closed.
    avatars : Avatars
        The `avatars` endpoint.
    guilds : Guilds
        The `guilds` endpoint.
    ksoft : KSoft
        The `ksoft` endpoint.
    users : Users
        The `users` endpoint.
    urls : URLs
        The `urls` endpoint.
    tokens : Tokens
        The `tokens` endpoint.
    """

    __slots__: tuple[str, ...] = (
        "_token",
        "_http",
        "_closed",
        "_avatars",
        "_guilds",
        "_ksoft",
        "_users",
        "_urls",
        "_tokens",
    )

    def __init__(self, token: str) -> None:
        """
        Parameters
        ----------
        token : str
            The token used to authenticate with the API.
        """
        self._token: str = token
        self._http: HTTPClient = HTTPClient(self._token)
        self._closed: bool = False
        self._avatars: Avatars = Avatars(self._http)
        self._guilds: Guilds = Guilds(self._http)
        self._ksoft: KSoft = KSoft(self._http)
        self._users: Users = Users(self._http)
        self._urls: URLs = URLs(self._http)
        self._tokens: Tokens = Tokens(self._http)

    async def close(self) -> None:
        """Closes the client, shutting down the underlying HTTP client."""
        await self._http.close()
        self._closed = True

        _LOGGER.info("Client is successfully closed")

    def set_phisherman_token(self, token: str) -> Client:
        """Sets the phisherman token for the client.

        Parameters
        ----------
        token : str
            The phisherman token to set.

        Returns
        -------
        Client
            The client with the phisherman token set.
        """
        self._http.set_phisherman_token(token)
        return self

    @property
    def closed(self) -> bool:
        """Whether or not the client is closed."""
        return self._closed

    @property
    def avatars(self) -> Avatars:
        """The `avatars` endpoint."""
        return self._avatars

    @property
    def guilds(self) -> Guilds:
        """The `guilds` endpoint."""
        return self._guilds

    @property
    def ksoft(self) -> KSoft:
        """The `ksoft` endpoint."""
        return self._ksoft

    @property
    def users(self) -> Users:
        """The `users` endpoint."""
        return self._users

    @property
    def urls(self) -> URLs:
        """The `urls` endpoint."""
        return self._urls

    @property
    def tokens(self) -> Tokens:
        """The `tokens` endpoint."""
        return self._tokens

avatars: Avatars property

The avatars endpoint.

closed: bool property

Whether or not the client is closed.

guilds: Guilds property

The guilds endpoint.

ksoft: KSoft property

The ksoft endpoint.

tokens: Tokens property

The tokens endpoint.

urls: URLs property

The urls endpoint.

users: Users property

The users endpoint.

__init__(token)

Parameters

token : str The token used to authenticate with the API.

Source code in ravyapi/client.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def __init__(self, token: str) -> None:
    """
    Parameters
    ----------
    token : str
        The token used to authenticate with the API.
    """
    self._token: str = token
    self._http: HTTPClient = HTTPClient(self._token)
    self._closed: bool = False
    self._avatars: Avatars = Avatars(self._http)
    self._guilds: Guilds = Guilds(self._http)
    self._ksoft: KSoft = KSoft(self._http)
    self._users: Users = Users(self._http)
    self._urls: URLs = URLs(self._http)
    self._tokens: Tokens = Tokens(self._http)

close() async

Closes the client, shutting down the underlying HTTP client.

Source code in ravyapi/client.py 
80
81
82
83
84
85
async def close(self) -> None:
    """Closes the client, shutting down the underlying HTTP client."""
    await self._http.close()
    self._closed = True

    _LOGGER.info("Client is successfully closed")

set_phisherman_token(token)

Sets the phisherman token for the client.

Parameters

token : str The phisherman token to set.

Returns

Client The client with the phisherman token set.

Source code in ravyapi/client.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def set_phisherman_token(self, token: str) -> Client:
    """Sets the phisherman token for the client.

    Parameters
    ----------
    token : str
        The phisherman token to set.

    Returns
    -------
    Client
        The client with the phisherman token set.
    """
    self._http.set_phisherman_token(token)
    return self