Update exceptions documentation (#1499)

Author: iMicknl

pyoverkiz/client.py

@@ -53,6 +53,7 @@
     NexityBadCredentialsException,
     NexityServiceException,
     NoRegisteredEventListenerException,
+    NoSuchResourceException,
     NotAuthenticatedException,
     NotSuchTokenException,
     OverkizException,
@@ -1023,6 +1024,10 @@ async def check_response(response: ClientResponse) -> None:
             if message == "No registered event listener":
                 raise NoRegisteredEventListenerException(message)
 
+            # {'errorCode': 'INVALID_API_CALL', 'error': 'No such resource'}
+            if message == "No such resource":
+                raise NoSuchResourceException(message)
+
             # {"errorCode": "RESOURCE_ACCESS_DENIED",  "error": "too many concurrent requests"}
             if message == "too many concurrent requests":
                 raise TooManyConcurrentRequestsException(message)
@@ -1054,7 +1059,7 @@ async def check_response(response: ClientResponse) -> None:
             if "Access denied to gateway" in message:
                 raise AccessDeniedToGatewayException(message)
 
-        # General Overkiz exception
+        # Undefined Overkiz exception
         raise OverkizException(result)
 
     async def _refresh_token_if_expired(self) -> None:

pyoverkiz/exceptions.py

@@ -1,109 +1,113 @@
 class BaseOverkizException(Exception):
-    pass
+    """Base exception for Overkiz errors."""
 
 
 class OverkizException(BaseOverkizException):
-    pass
+    """Raised when an undefined error occurs while communicating with the Overkiz API."""
 
 
 class BadCredentialsException(BaseOverkizException):
-    pass
+    """Raised when invalid credentials are provided."""
 
 
 class InvalidCommandException(BaseOverkizException):
-    pass
+    """Raised when an invalid command is provided."""
+
+
+class NoSuchResourceException(BaseOverkizException):
+    """Raised when an invalid API call is made."""
 
 
 class NotAuthenticatedException(BaseOverkizException):
-    pass
+    """Raised when the user is not authenticated."""
 
 
 class TooManyExecutionsException(BaseOverkizException):
-    pass
+    """Raised when too many executions are requested."""
 
 
 class ExecutionQueueFullException(BaseOverkizException):
-    pass
+    """Raised when the execution queue is full."""
 
 
 class TooManyRequestsException(BaseOverkizException):
-    pass
+    """Raised when too many requests are made."""
 
 
 class TooManyConcurrentRequestsException(BaseOverkizException):
-    pass
+    """Raised when too many concurrent requests are made."""
 
 
 class ServiceUnavailableException(BaseOverkizException):
-    pass
+    """Raised when the service is unavailable."""
 
 
 class MaintenanceException(ServiceUnavailableException):
-    pass
+    """Raised when the service is under maintenance."""
 
 
 class MissingAuthorizationTokenException(BaseOverkizException):
-    pass
+    """Raised when the authorization token is missing."""
 
 
 class InvalidEventListenerIdException(BaseOverkizException):
-    pass
+    """Raised when an invalid event listener ID is provided."""
 
 
 class NoRegisteredEventListenerException(BaseOverkizException):
-    pass
+    """Raised when no event listener is registered."""
 
 
 class SessionAndBearerInSameRequestException(BaseOverkizException):
-    pass
+    """Raised when both session and bearer are provided in the same request."""
 
 
 class TooManyAttemptsBannedException(BaseOverkizException):
-    pass
+    """Raised when too many attempts are made and the user is (temporarily) banned."""
 
 
 class InvalidTokenException(BaseOverkizException):
-    pass
+    """Raised when an invalid token is provided."""
 
 
 class NotSuchTokenException(BaseOverkizException):
-    pass
+    """Raised when an invalid token is provided."""
 
 
 class UnknownUserException(BaseOverkizException):
-    pass
+    """Raised when an unknown user is provided."""
 
 
 class UnknownObjectException(BaseOverkizException):
-    pass
+    """Raised when an unknown object is provided."""
 
 
 class AccessDeniedToGatewayException(BaseOverkizException):
-    pass
+    """Raised when access is denied to the gateway. This often happens when the user is not the owner of the gateway."""
 
 
 # Nexity
 class NexityBadCredentialsException(BadCredentialsException):
-    pass
+    """Raised when invalid credentials are provided to Nexity authentication API."""
 
 
 class NexityServiceException(BaseOverkizException):
-    pass
+    """Raised when an error occurs while communicating with the Nexity API."""
 
 
 # CozyTouch
 class CozyTouchBadCredentialsException(BadCredentialsException):
-    pass
+    """Raised when invalid credentials are provided to CozyTouch authentication API."""
 
 
 class CozyTouchServiceException(BaseOverkizException):
-    pass
+    """Raised when an error occurs while communicating with the CozyTouch API."""
 
 
 # Somfy
 class SomfyBadCredentialsException(BadCredentialsException):
-    pass
+    """Raised when invalid credentials are provided to Somfy authentication API."""
 
 
 class SomfyServiceException(BaseOverkizException):
-    pass
+    """Raised when an error occurs while communicating with the Somfy API."""