SDK-2758-python-add-support-for-requesting-and-retrieving-share-code-resources-tasks

Author: mehmet-yoti

yoti_python_sdk/doc_scan/constants.py

@@ -13,6 +13,7 @@
 SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION = (
     "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION"
 )
+VERIFY_SHARE_CODE_TASK = "VERIFY_SHARE_CODE_TASK"
 
 CAMERA = "CAMERA"
 CAMERA_AND_UPLOAD = "CAMERA_AND_UPLOAD"

yoti_python_sdk/doc_scan/session/retrieve/resource_container.py

@@ -14,6 +14,9 @@
 from yoti_python_sdk.doc_scan.session.retrieve.static_liveness_resource_response import (
     StaticLivenessResourceResponse,
 )
+from yoti_python_sdk.doc_scan.session.retrieve.share_code_resource_response import (
+    ShareCodeResourceResponse,
+)
 
 
 class ResourceContainer(object):
@@ -45,6 +48,11 @@ def __init__(self, data=None):
             for liveness in data.get("liveness_capture", [])
         ]
 
+        self.__share_codes = [
+            ShareCodeResourceResponse(share_code)
+            for share_code in data.get("share_codes", [])
+        ]
+
     @staticmethod
     def __parse_liveness_capture(liveness_capture):
         """
@@ -122,3 +130,13 @@ def static_liveness_resources(self):
             for liveness in self.__liveness_capture
             if isinstance(liveness, StaticLivenessResourceResponse)
         ]
+
+    @property
+    def share_codes(self):
+        """
+        Return a list of share code resources
+
+        :return: list of share codes
+        :rtype: list[ShareCodeResourceResponse]
+        """
+        return self.__share_codes

yoti_python_sdk/doc_scan/session/retrieve/resource_response.py

@@ -4,6 +4,7 @@
     TextExtractionTaskResponse,
     SupplementaryDocumentTextExtractionTaskResponse,
 )
+from .verify_share_code_task_response import VerifyShareCodeTaskResponse
 
 
 class ResourceResponse(object):
@@ -35,6 +36,7 @@ def __parse_task(task):
         types = {
             constants.ID_DOCUMENT_TEXT_DATA_EXTRACTION: TextExtractionTaskResponse,
             constants.SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION: SupplementaryDocumentTextExtractionTaskResponse,
+            constants.VERIFY_SHARE_CODE_TASK: VerifyShareCodeTaskResponse,
         }
         clazz = types.get(
             task.get("type", None), TaskResponse  # Default fallback for task type

yoti_python_sdk/doc_scan/session/retrieve/share_code_media_response.py

@@ -0,0 +1,26 @@
+from yoti_python_sdk.doc_scan.session.retrieve.media_response import MediaResponse
+
+
+class ShareCodeMediaResponse(object):
+    """
+    Wraps a MediaResponse inside a share code resource field
+    """
+
+    def __init__(self, data=None):
+        if data is None:
+            data = dict()
+
+        if "media" in data and data["media"] is not None:
+            self.__media = MediaResponse(data["media"])
+        else:
+            self.__media = None
+
+    @property
+    def media(self):
+        """
+        The media object
+
+        :return: the media
+        :rtype: MediaResponse or None
+        """
+        return self.__media

yoti_python_sdk/doc_scan/session/retrieve/share_code_resource_response.py

@@ -0,0 +1,137 @@
+from yoti_python_sdk.doc_scan.session.retrieve.resource_response import (
+    ResourceResponse,
+)
+from yoti_python_sdk.doc_scan.session.retrieve.share_code_media_response import (
+    ShareCodeMediaResponse,
+)
+from yoti_python_sdk.doc_scan.session.retrieve.verify_share_code_task_response import (
+    VerifyShareCodeTaskResponse,
+)
+
+
+class ShareCodeResourceResponse(ResourceResponse):
+    """
+    Represents a share code resource for a given session
+    """
+
+    def __init__(self, data=None):
+        if data is None:
+            data = dict()
+
+        ResourceResponse.__init__(self, data)
+
+        source = data.get("source", None)
+        if isinstance(source, str):
+            self.__source = source
+        elif isinstance(source, dict):
+            self.__source = source.get("type", str(source))
+        else:
+            self.__source = None
+
+        self.__created_at = data.get("created_at", None)
+        self.__last_updated = data.get("last_updated", None)
+
+        self.__lookup_profile = (
+            ShareCodeMediaResponse(data["lookup_profile"])
+            if "lookup_profile" in data and data["lookup_profile"] is not None
+            else None
+        )
+        self.__returned_profile = (
+            ShareCodeMediaResponse(data["returned_profile"])
+            if "returned_profile" in data and data["returned_profile"] is not None
+            else None
+        )
+        self.__id_photo = (
+            ShareCodeMediaResponse(data["id_photo"])
+            if "id_photo" in data and data["id_photo"] is not None
+            else None
+        )
+        self.__file = (
+            ShareCodeMediaResponse(data["file"])
+            if "file" in data and data["file"] is not None
+            else None
+        )
+
+    @property
+    def source(self):
+        """
+        The source of the share code
+
+        :return: the source
+        :rtype: str or None
+        """
+        return self.__source
+
+    @property
+    def created_at(self):
+        """
+        The date the share code was created
+
+        :return: the created at date
+        :rtype: str or None
+        """
+        return self.__created_at
+
+    @property
+    def last_updated(self):
+        """
+        The date the share code was last updated
+
+        :return: the last updated date
+        :rtype: str or None
+        """
+        return self.__last_updated
+
+    @property
+    def lookup_profile(self):
+        """
+        The lookup profile media
+
+        :return: the lookup profile
+        :rtype: ShareCodeMediaResponse or None
+        """
+        return self.__lookup_profile
+
+    @property
+    def returned_profile(self):
+        """
+        The returned profile media
+
+        :return: the returned profile
+        :rtype: ShareCodeMediaResponse or None
+        """
+        return self.__returned_profile
+
+    @property
+    def id_photo(self):
+        """
+        The ID photo media
+
+        :return: the ID photo
+        :rtype: ShareCodeMediaResponse or None
+        """
+        return self.__id_photo
+
+    @property
+    def file(self):
+        """
+        The file media
+
+        :return: the file
+        :rtype: ShareCodeMediaResponse or None
+        """
+        return self.__file
+
+    @property
+    def verify_share_code_tasks(self):
+        """
+        Returns a list of verify share code tasks
+
+        :return: list of verify share code tasks
+        :rtype: list[VerifyShareCodeTaskResponse]
+        """
+        return [
+            task
+            for task in self.tasks
+            if isinstance(task, VerifyShareCodeTaskResponse)
+        ]

yoti_python_sdk/doc_scan/session/retrieve/verify_share_code_task_response.py

@@ -0,0 +1,9 @@
+from yoti_python_sdk.doc_scan.session.retrieve.task_response import TaskResponse
+
+
+class VerifyShareCodeTaskResponse(TaskResponse):
+    """
+    Represents a Verify Share Code task response
+    """
+
+    pass

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

@@ -9,6 +9,9 @@
 from yoti_python_sdk.doc_scan.session.retrieve.resource_container import (
     ResourceContainer,
 )
+from yoti_python_sdk.doc_scan.session.retrieve.share_code_resource_response import (
+    ShareCodeResourceResponse,
+)
 
 
 class ResourceContainerTest(unittest.TestCase):
@@ -62,6 +65,32 @@ def test_should_filter_static_liveness_resources(self):
         assert len(result.liveness_capture) == 2
         assert len(result.static_liveness_resources) == 1
 
+    def test_should_parse_share_codes(self):
+        data = {
+            "share_codes": [
+                {"id": "share-code-1", "source": "END_USER", "tasks": []},
+                {"id": "share-code-2", "source": "END_USER", "tasks": []},
+            ]
+        }
+
+        result = ResourceContainer(data)
+
+        assert len(result.share_codes) == 2
+        assert isinstance(result.share_codes[0], ShareCodeResourceResponse)
+        assert isinstance(result.share_codes[1], ShareCodeResourceResponse)
+
+    def test_should_parse_with_empty_share_codes(self):
+        data = {"share_codes": []}
+
+        result = ResourceContainer(data)
+
+        assert len(result.share_codes) == 0
+
+    def test_should_parse_with_missing_share_codes(self):
+        result = ResourceContainer({})
+
+        assert len(result.share_codes) == 0
+
 
 if __name__ == "__main__":
     unittest.main()

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

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+import unittest
+
+from yoti_python_sdk.doc_scan.session.retrieve.share_code_media_response import (
+    ShareCodeMediaResponse,
+)
+
+
+class ShareCodeMediaResponseTest(unittest.TestCase):
+    def test_should_parse_media(self):
+        data = {
+            "media": {
+                "id": "some-media-id",
+                "type": "JSON",
+                "created": "2026-02-05T11:33:46Z",
+                "last_updated": "2026-02-05T11:33:50Z",
+            }
+        }
+
+        result = ShareCodeMediaResponse(data)
+
+        assert result.media is not None
+        assert result.media.id == "some-media-id"
+        assert result.media.type == "JSON"
+        assert result.media.created is not None
+        assert result.media.last_updated is not None
+
+    def test_should_return_none_media_when_key_missing(self):
+        result = ShareCodeMediaResponse({})
+
+        assert result.media is None
+
+    def test_should_return_none_media_when_value_is_null(self):
+        data = {"media": None}
+
+        result = ShareCodeMediaResponse(data)
+
+        assert result.media is None
+
+    def test_should_parse_empty_media_object(self):
+        data = {"media": {}}
+
+        result = ShareCodeMediaResponse(data)
+
+        assert result.media is not None
+        assert result.media.id is None
+        assert result.media.type is None
+
+    def test_should_parse_when_none(self):
+        result = ShareCodeMediaResponse(None)
+
+        assert result.media is None
+
+
+if __name__ == "__main__":
+    unittest.main()