Skip to content

Urls

Implementations for the urls endpoint.

URLs

Bases: HTTPAwareEndpoint

A class with implementations for the urls endpoint.

Source code in ravyapi/api/endpoints/urls.py 
 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
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
class URLs(HTTPAwareEndpoint):
    """A class with implementations for the `urls` endpoint."""

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

    @with_permission_check("urls.cached")
    async def get_website(
        self: HTTPAwareEndpoint,
        url: str,
        *,
        author: int | None = None,
        phisherman_user: int | None = None,
    ) -> GetWebsiteResponse:
        """Get website information.

        Parameters
        ----------
        url : str
            The url-encoded url to look up.
        author : int | None
            Optional, the user that posted the message containing this URL (for auto banning, requires admin.users).
        phisherman_user : int | None
            Optional, required if `ravyapi.client.Client.set_phisherman_token` is called, Discord user ID of the token owner.

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

        Returns
        -------
        GetWebsiteResponse
            A model response from `ravyapi.api.endpoints.urls.URLs.get_website`.
            Located as `ravyapi.api.models.urls.GetWebsiteResponse`.
        """
        if not isinstance(url, str):
            raise TypeError('Parameter "url" must be of type "str"')

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

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

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

        if self._http.phisherman_token is None and phisherman_user:
            raise ValueError("Phisherman token required if phisherman user is set.")

        if self._http.phisherman_token is not None and not phisherman_user:
            raise ValueError("Phisherman user required if phisherman token is set.")

        params: dict[str, Any] = {"url": url}

        if author is not None:
            params["author"] = author

        if self._http.phisherman_token is not None:
            params["phisherman_token"] = self._http.phisherman_token

        if phisherman_user is not None:
            params["phisherman_user"] = phisherman_user

        return GetWebsiteResponse(
            await self._http.get(self._http.paths.urls.route, params=params)
        )

    @with_permission_check("admin.urls")
    async def edit_website(
        self: HTTPAwareEndpoint,
        url: str,
        *,
        is_fraudulent: bool,
        message: str,
        encode: bool = True,
    ) -> None:
        """Edit website information.

        Parameters
        ----------
        url : str
            The url-encoded url to set data for.
        is_fraudulent : bool
            Whether the website is fraudulent.
        message : str
            An informational message about the website.
        encode : bool
            Whether to url-encode the parameter `url`.

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

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

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

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

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

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

        if encode:
            message = urllib.parse.quote_plus(message)

        await self._http.post(
            f"{self._http.paths.urls.route}/{url}",
            json=EditWebsiteRequest(is_fraudulent, message).to_json(),
        )

edit_website(url, *, is_fraudulent, message, encode=True) async

Edit website information.

Parameters

url : str The url-encoded url to set data for. is_fraudulent : bool Whether the website is fraudulent. message : str An informational message about the website. encode : bool Whether to url-encode the parameter url.

Raises

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

Source code in ravyapi/api/endpoints/urls.py 
 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
@with_permission_check("admin.urls")
async def edit_website(
    self: HTTPAwareEndpoint,
    url: str,
    *,
    is_fraudulent: bool,
    message: str,
    encode: bool = True,
) -> None:
    """Edit website information.

    Parameters
    ----------
    url : str
        The url-encoded url to set data for.
    is_fraudulent : bool
        Whether the website is fraudulent.
    message : str
        An informational message about the website.
    encode : bool
        Whether to url-encode the parameter `url`.

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

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

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

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

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

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

    if encode:
        message = urllib.parse.quote_plus(message)

    await self._http.post(
        f"{self._http.paths.urls.route}/{url}",
        json=EditWebsiteRequest(is_fraudulent, message).to_json(),
    )

get_website(url, *, author=None, phisherman_user=None) async

Get website information.

Parameters

url : str The url-encoded url to look up. author : int | None Optional, the user that posted the message containing this URL (for auto banning, requires admin.users). phisherman_user : int | None Optional, required if ravyapi.client.Client.set_phisherman_token is called, Discord user ID of the token owner.

Raises

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

Returns

GetWebsiteResponse A model response from ravyapi.api.endpoints.urls.URLs.get_website. Located as ravyapi.api.models.urls.GetWebsiteResponse.

Source code in ravyapi/api/endpoints/urls.py 
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
@with_permission_check("urls.cached")
async def get_website(
    self: HTTPAwareEndpoint,
    url: str,
    *,
    author: int | None = None,
    phisherman_user: int | None = None,
) -> GetWebsiteResponse:
    """Get website information.

    Parameters
    ----------
    url : str
        The url-encoded url to look up.
    author : int | None
        Optional, the user that posted the message containing this URL (for auto banning, requires admin.users).
    phisherman_user : int | None
        Optional, required if `ravyapi.client.Client.set_phisherman_token` is called, Discord user ID of the token owner.

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

    Returns
    -------
    GetWebsiteResponse
        A model response from `ravyapi.api.endpoints.urls.URLs.get_website`.
        Located as `ravyapi.api.models.urls.GetWebsiteResponse`.
    """
    if not isinstance(url, str):
        raise TypeError('Parameter "url" must be of type "str"')

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

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

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

    if self._http.phisherman_token is None and phisherman_user:
        raise ValueError("Phisherman token required if phisherman user is set.")

    if self._http.phisherman_token is not None and not phisherman_user:
        raise ValueError("Phisherman user required if phisherman token is set.")

    params: dict[str, Any] = {"url": url}

    if author is not None:
        params["author"] = author

    if self._http.phisherman_token is not None:
        params["phisherman_token"] = self._http.phisherman_token

    if phisherman_user is not None:
        params["phisherman_user"] = phisherman_user

    return GetWebsiteResponse(
        await self._http.get(self._http.paths.urls.route, params=params)
    )