Exceptions

Definition of Exceptions and Errors thrown

exception matterapi.client.exceptions.ApiError(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: Exception

Base for api errors

exception matterapi.client.exceptions.ContentTooLarge(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 413 Content too large

class matterapi.client.exceptions.ExceptionBody(*, id: str, message: str, request_id: str, status_code: int, detailed_error: str = None, is_oauth: bool = None)

Bases: pydantic.main.BaseModel

Exception Body definition for errors returned by the API

detailed_error: Optional[str]

id: str

is_oauth: Optional[bool]

message: str

request_id: str

status_code: int

exception matterapi.client.exceptions.FeatureDisabled(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 501 Feature is disabled

exception matterapi.client.exceptions.InternalServerError(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 500 Internal Server Error

exception matterapi.client.exceptions.InvalidOrMissingParameters(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 400 Invalid or missing parameters in URL or request body

exception matterapi.client.exceptions.MethodNotAllowed(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 405 Method Not Allowed

exception matterapi.client.exceptions.NoAccessTokenProvided(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 401 No access token provided

exception matterapi.client.exceptions.NotEnoughPermissions(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 403 Do not have appropriate permissions

exception matterapi.client.exceptions.ResourceNotFound(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 404 Resource not found

exception matterapi.client.exceptions.TooManyRequests(message, error_details: Optional[matterapi.client.exceptions.ExceptionBody] = None)

Bases: matterapi.client.exceptions.ApiError

Raised when mattermost returns a 429 Too many requests