Urls

Implementations for the urls endpoint.

URLs ¶

Bases: HTTPAwareEndpoint

A class with implementations for the urls endpoint.

edit_website(url: str, *, is_fraudulent: bool, message: str, encode: bool = True) -> None

Edit website information.

Parameters:

Name	Type	Description	Default
`url`	`str`	The url-encoded url to set data for.	required
`is_fraudulent`	`bool`	Whether the website is fraudulent.	required
`message`	`str`	An informational message about the website.	required
`encode`	`bool`	Whether to url-encode the parameter `url`.	`True`

Raises:

Type	Description
`TypeError`	If any parameters are of invalid types.
`ValueError`	If any parameters are invalid values.

get_website(url: str, *, author: int | None = None, phisherman_user: int | None = None) -> GetWebsiteResponse

Get website information.

Parameters:

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

Raises:

Type	Description
`TypeError`	If any parameters are of invalid types.
`ValueError`	If any parameters are invalid values.

Returns:

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