MHPY-26 Support passing includeDeleted to the records endpoint

mediahaven/resources/records.py

@@ -37,20 +37,37 @@ def count(self, query: str) -> int:
         )
 
     def get(
-        self, record_id: str, accept_format=DEFAULT_ACCEPT_FORMAT
+        self,
+        record_id: str,
+        accept_format=DEFAULT_ACCEPT_FORMAT,
+        include_deleted=False,
+        **query_params,
     ) -> MediaHavenSingleObject:
         """Get a single record.
 
         Args:
             record_id: It can either be a MediaObjectId, FragmentId or RecordId.
             accept_format: The "Accept" request header.
+            include_deleted: If true, also return the record if it has been
+                logically deleted.
+            **query_params: Further optional query parameters:
+                query_params["fields"]: Select only specific fields. Supports
+                    Exif, dotted keys and Context. If the record has record
+                    structure Data, the information for Exif is obtained from the
+                    original representation. (Can be combined with profiles).
+                query_params["profiles"]: The profiles for which the fields
+                    should be returned (Can be combined with fields).
+                query_params["source"]: The source from which the record should
+                    be fetched.
 
         Returns:
             A single record.
         """
         response = self.mh_client._get(
             self._construct_path(record_id),
             accept_format,
+            includeDeleted=str(include_deleted).lower(),
+            **query_params,
         )
         return MediaHavenSingleObjectCreator.create_object(response, accept_format)
 

tests/test_records.py

@@ -21,7 +21,24 @@ def test_get(self, object_creator_mock, records: Records):
 
         # Assert
         mh_client_mock._get.assert_called_once_with(
-            f"{records.name}/{record_id}", AcceptFormat.JSON
+            f"{records.name}/{record_id}", AcceptFormat.JSON, includeDeleted="false"
+        )
+        object_creator_mock.create_object.assert_called_once_with(
+            mh_client_mock._get(), AcceptFormat.JSON
+        )
+
+    @patch("mediahaven.resources.records.MediaHavenSingleObjectCreator")
+    def test_get_with_include_deleted(self, object_creator_mock, records: Records):
+        # Arrange
+        record_id = "1"
+        mh_client_mock = records.mh_client
+
+        # Act
+        records.get(record_id, include_deleted=True)
+
+        # Assert
+        mh_client_mock._get.assert_called_once_with(
+            f"{records.name}/{record_id}", AcceptFormat.JSON, includeDeleted="true"
         )
         object_creator_mock.create_object.assert_called_once_with(
             mh_client_mock._get(), AcceptFormat.JSON