SDK-2792-python-add-support-for-retrieving-the-extraction-image-ids-field-from-the-idv-pages

Author: mehmet-yoti

yoti_python_sdk/doc_scan/session/retrieve/page_response.py

@@ -23,6 +23,7 @@ def __init__(self, data=None):
         )
         self.__media = MediaResponse(data["media"]) if "media" in data.keys() else None
         self.__frames = [FrameResponse(frame) for frame in data.get("frames", [])]
+        self.__extraction_image_ids = data.get("extraction_image_ids", [])
 
     @property
     def capture_method(self):
@@ -53,3 +54,13 @@ def frames(self):
         :rtype: list[FrameResponse]
         """
         return self.__frames
+
+    @property
+    def extraction_image_ids(self):
+        """
+        Returns the list of extraction image IDs
+
+        :return: the extraction image IDs
+        :rtype: list[str]
+        """
+        return self.__extraction_image_ids

yoti_python_sdk/tests/doc_scan/session/retrieve/test_page_response.py

@@ -8,12 +8,17 @@
 class PageResponseTest(unittest.TestCase):
     SOME_CAPTURE_METHOD = "someCaptureMethod"
     SOME_FRAMES = [{"first": "frame"}, {"second": "frame"}]
+    SOME_EXTRACTION_IMAGE_IDS = [
+        "066a9372-0a52-4fe4-a026-866f8aee6fcb",
+        "9b0c9c0a-ff30-41ed-815b-d95d63271d45",
+    ]
 
     def test_should_parse_correctly(self):
         data = {
             "capture_method": self.SOME_CAPTURE_METHOD,
             "media": {},
             "frames": self.SOME_FRAMES,
+            "extraction_image_ids": self.SOME_EXTRACTION_IMAGE_IDS,
         }
 
         result = PageResponse(data)
@@ -23,13 +28,16 @@ def test_should_parse_correctly(self):
         assert len(result.frames) == 2
         assert isinstance(result.frames[0], FrameResponse)
         assert isinstance(result.frames[1], FrameResponse)
+        assert len(result.extraction_image_ids) == 2
+        assert result.extraction_image_ids == self.SOME_EXTRACTION_IMAGE_IDS
 
     def test_should_parse_with_none(self):
         result = PageResponse(None)
 
         assert result.capture_method is None
         assert result.media is None
         assert len(result.frames) == 0
+        assert len(result.extraction_image_ids) == 0
 
 
 if __name__ == "__main__":