Errors

Exceptions raised when an error is encountered during API calls.

AccessError

Bases: Exception

A class denoting an exception raised when required permission is not satisfied.

Attributes:

Name	Type	Description
required	str	The required permission for a path route.

required property

required: str

The required permission for a path route.

__init__

__init__(required: str) -> None

Parameters:

Name	Type	Description	Default
required	str	The permission that was needed.	required

BadRequestError

Bases: HTTPError

A class denoting an exception raised when a bad request is made.

Attributes:

Name	Type	Description
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.

exc_data property

exc_data: str | dict[str, Any]

The error data returned by the Ravy API.

status property

status: int

The HTTP status code of the response.

__init__

__init__(exc_data: str | dict[str, Any]) -> None

Parameters:

Name	Type	Description	Default
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.	required

ForbiddenError

Bases: HTTPError

A class denoting an exception raised when a forbidden request is made.

Attributes:

Name	Type	Description
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.

exc_data property

exc_data: str | dict[str, Any]

The error data returned by the Ravy API.

status property

status: int

The HTTP status code of the response.

__init__

__init__(exc_data: str | dict[str, Any]) -> None

Parameters:

Name	Type	Description	Default
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.	required

HTTPError

Bases: Exception

A base class for all HTTP exceptions.

Parameters:

Name	Type	Description	Default
status	int	The HTTP status code of the response.	required
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.	required

Attributes:

Name	Type	Description
status	int	The HTTP status code of the response.
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.

exc_data property

exc_data: str | dict[str, Any]

The error data returned by the Ravy API.

status property

status: int

The HTTP status code of the response.

__init__

__init__(status: int, exc_data: str | dict[str, Any]) -> None

Parameters:

Name	Type	Description	Default
status	int	The HTTP status code of the response.	required
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.	required

NotFoundError

Bases: HTTPError

A class denoting an exception raised when a resource is not found.

Attributes:

Name	Type	Description
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.

exc_data property

exc_data: str | dict[str, Any]

The error data returned by the Ravy API.

status property

status: int

The HTTP status code of the response.

__init__

__init__(exc_data: str | dict[str, Any]) -> None

Parameters:

Name	Type	Description	Default
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.	required

TooManyRequestsError

Bases: HTTPError

A class denoting an exception raised when a request is made too frequently.

Attributes:

Name	Type	Description
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.

exc_data property

exc_data: str | dict[str, Any]

The error data returned by the Ravy API.

status property

status: int

The HTTP status code of the response.

__init__

__init__(exc_data: str | dict[str, Any]) -> None

Parameters:

Name	Type	Description	Default
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.	required

UnauthorizedError

Bases: HTTPError

A class denoting an exception raised when an unauthorized request is made.

Attributes:

Name	Type	Description
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.

exc_data property

exc_data: str | dict[str, Any]

The error data returned by the Ravy API.

status property

status: int

The HTTP status code of the response.

__init__

__init__(exc_data: str | dict[str, Any]) -> None

Parameters:

Name	Type	Description	Default
exc_data	str | dict[str, Any]	The error data returned by the Ravy API.	required