Merge pull request #885 from adamtheturtle/fail

Document Fails

Author: adamtheturtle

src/vws/vws.py

@@ -202,6 +202,10 @@ def add_target(
 
         Returns:
             The target ID of the new target.
+
+        Raises:
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
         """
         image_data = image.getvalue()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
@@ -244,6 +248,8 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
             Response details of a target from Vuforia.
 
         Raises:
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
         """
@@ -266,6 +272,8 @@ def wait_for_target_processed(self, target_id: str) -> None:
             target_id: The ID of the target to wait for.
 
         Raises:
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
             TimeoutError: The target remained in the processing stage for more
                 than five minutes.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
@@ -290,6 +298,10 @@ def list_targets(self) -> List[str]:
 
         Returns:
             The IDs of all targets in the database.
+
+        Raises:
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
         """
         response = self._make_request(
             method='GET',
@@ -317,6 +329,8 @@ def get_target_summary_report(
             Details of the target.
 
         Raises:
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
         """
@@ -338,6 +352,10 @@ def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
 
         Returns:
             Details of the database.
+
+        Raises:
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
         """
         response = self._make_request(
             method='GET',
@@ -359,6 +377,8 @@ def delete_target(self, target_id: str) -> None:
             target_id: The ID of the target to delete.
 
         Raises:
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
         """