regula-facesdk-webclient 8.4.835.dev0__tar.gz → 8.4.837.dev0__tar.gz

{regula_facesdk_webclient-8.4.835.dev0 → regula_facesdk_webclient-8.4.837.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.4.835.dev0
+Version: 8.4.837.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_facesdk_webclient-8.4.835.dev0 → regula_facesdk_webclient-8.4.837.dev0}/regula/facesdk/webclient/gen/__init__.py

@@ -47,6 +47,8 @@ __all__ = [
     "DetectionFace",
     "DetectionQuality",
     "DeviceInfo",
+    "EnrollResult",
+    "EnrollSearchResult",
     "FaceAttribute",
     "FaceImageQualityAlignType",
     "FaceImageQualityGroups",
@@ -116,6 +118,8 @@ __all__ = [
     "TransactionInfo",
     "TransactionLabels",
     "UpdateGroup",
+    "VerifyResult",
+    "VerifyResultMatch",
 ]
 
 if __import__("typing").TYPE_CHECKING:
@@ -161,6 +165,8 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.detection_face import DetectionFace as DetectionFace
     from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality as DetectionQuality
     from regula.facesdk.webclient.gen.models.device_info import DeviceInfo as DeviceInfo
+    from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult as EnrollResult
+    from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult as EnrollSearchResult
     from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute as FaceAttribute
     from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType as FaceImageQualityAlignType
     from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups as FaceImageQualityGroups
@@ -230,6 +236,8 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo as TransactionInfo
     from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels as TransactionLabels
     from regula.facesdk.webclient.gen.models.update_group import UpdateGroup as UpdateGroup
+    from regula.facesdk.webclient.gen.models.verify_result import VerifyResult as VerifyResult
+    from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch as VerifyResultMatch
     
 else:
     from lazy_imports import LazyModule, as_package, load
@@ -281,6 +289,8 @@ from regula.facesdk.webclient.gen.models.detection_attributes_details_inner impo
 from regula.facesdk.webclient.gen.models.detection_face import DetectionFace as DetectionFace
 from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality as DetectionQuality
 from regula.facesdk.webclient.gen.models.device_info import DeviceInfo as DeviceInfo
+from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult as EnrollResult
+from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult as EnrollSearchResult
 from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute as FaceAttribute
 from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType as FaceImageQualityAlignType
 from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups as FaceImageQualityGroups
@@ -350,6 +360,8 @@ from regula.facesdk.webclient.gen.models.search_result import SearchResult as Se
 from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo as TransactionInfo
 from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels as TransactionLabels
 from regula.facesdk.webclient.gen.models.update_group import UpdateGroup as UpdateGroup
+from regula.facesdk.webclient.gen.models.verify_result import VerifyResult as VerifyResult
+from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch as VerifyResultMatch
 
 """,
             name=__name__,

{regula_facesdk_webclient-8.4.835.dev0 → regula_facesdk_webclient-8.4.837.dev0}/regula/facesdk/webclient/gen/api/liveness20_api.py

@@ -322,7 +322,7 @@ class Liveness20Api:
     ) -> TransactionInfo:
         """liveness check
 
-        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`. 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.   When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.   The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`   By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.   To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.  You can also use liveness as part of the <a href=\"https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/\" target=\"_blank\">Enroll and Verify</a> flow. 
 
         :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str
@@ -389,7 +389,7 @@ class Liveness20Api:
     ) -> ApiResponse[TransactionInfo]:
         """liveness check
 
-        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`. 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.   When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.   The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`   By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.   To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.  You can also use liveness as part of the <a href=\"https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/\" target=\"_blank\">Enroll and Verify</a> flow. 
 
         :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str
@@ -456,7 +456,7 @@ class Liveness20Api:
     ) -> RESTResponseType:
         """liveness check
 
-        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`. 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.   When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.   The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`   By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.   To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.  You can also use liveness as part of the <a href=\"https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/\" target=\"_blank\">Enroll and Verify</a> flow. 
 
         :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str

{regula_facesdk_webclient-8.4.835.dev0 → regula_facesdk_webclient-8.4.837.dev0}/regula/facesdk/webclient/gen/models/__init__.py

@@ -29,6 +29,8 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.detection_face import DetectionFace
     from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality
     from regula.facesdk.webclient.gen.models.device_info import DeviceInfo
+    from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult
+    from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult
     from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute
     from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType
     from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups
@@ -98,6 +100,8 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo
     from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels
     from regula.facesdk.webclient.gen.models.update_group import UpdateGroup
+    from regula.facesdk.webclient.gen.models.verify_result import VerifyResult
+    from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch
     
 else:
     from lazy_imports import LazyModule, as_package, load
@@ -128,6 +132,8 @@ from regula.facesdk.webclient.gen.models.detection_attributes_details_inner impo
 from regula.facesdk.webclient.gen.models.detection_face import DetectionFace
 from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality
 from regula.facesdk.webclient.gen.models.device_info import DeviceInfo
+from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult
+from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult
 from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute
 from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType
 from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups
@@ -197,6 +203,8 @@ from regula.facesdk.webclient.gen.models.search_result import SearchResult
 from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo
 from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels
 from regula.facesdk.webclient.gen.models.update_group import UpdateGroup
+from regula.facesdk.webclient.gen.models.verify_result import VerifyResult
+from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch
 
 """,
             name=__name__,

regula_facesdk_webclient-8.4.837.dev0/regula/facesdk/webclient/gen/models/enroll_result.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult
+from regula.facesdk.webclient.gen.models.person import Person
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class EnrollResult(BaseModel):
+    """
+    Result of the enrollment requested at session start via the `enroll` parameter. Returned only when enrollment was requested and the Enroll and Verify feature is enabled. Populated after the liveness check completes successfully.
+    """ # noqa: E501
+    enrolled: SkipValidation[Optional[bool]] = Field(alias="enrolled", default=None, description="Whether a new Person was created during enrollment. `true` when a new Person was created; `false` when a matching Person was found during the pre-enrollment search and no new Person was created.")
+    person: SkipValidation[Optional[Person]] = Field(alias="person", default=None, description="The Person created during enrollment. Present only when `enrolled` is `true`.")
+    search: SkipValidation[Optional[EnrollSearchResult]] = Field(alias="search", default=None)
+    __properties: ClassVar[List[str]] = ["enrolled", "person", "search"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EnrollResult from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of person
+        if self.person:
+            _dict['person'] = self.person.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of search
+        if self.search:
+            _dict['search'] = self.search.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EnrollResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "enrolled": obj.get("enrolled"),
+            "person": Person.from_dict(obj["person"]) if obj.get("person") is not None else None,
+            "search": EnrollSearchResult.from_dict(obj["search"]) if obj.get("search") is not None else None
+        })
+        return _obj
+
+

regula_facesdk_webclient-8.4.837.dev0/regula/facesdk/webclient/gen/models/enroll_search_result.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.facesdk.webclient.gen.models.search_person import SearchPerson
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class EnrollSearchResult(BaseModel):
+    """
+    Result of the 1:N search performed before enrollment when `enroll.search` is provided at session start. Present only when at least one matching Person is found. In this case, no new Person is created.
+    """ # noqa: E501
+    persons: SkipValidation[Optional[List[SearchPerson]]] = Field(alias="persons", default=None, description="Persons found during the pre-enrollment search.")
+    __properties: ClassVar[List[str]] = ["persons"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EnrollSearchResult from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in persons (list)
+        _items = []
+        if self.persons:
+            for _item_persons in self.persons:
+                if _item_persons:
+                    _items.append(_item_persons.to_dict())
+            _dict['persons'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EnrollSearchResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "persons": [SearchPerson.from_dict(_item) for _item in obj.get("persons", []) if SearchPerson.from_dict(_item) is not None]
+        })
+        return _obj
+
+

{regula_facesdk_webclient-8.4.835.dev0 → regula_facesdk_webclient-8.4.837.dev0}/regula/facesdk/webclient/gen/models/transaction_info.py

@@ -11,7 +11,9 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult
 from regula.facesdk.webclient.gen.models.liveness_type import LivenessType
+from regula.facesdk.webclient.gen.models.verify_result import VerifyResult
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic import SkipValidation, Field
@@ -27,9 +29,11 @@ class TransactionInfo(BaseModel):
     video: SkipValidation[Optional[str]] = Field(alias="video", default=None, description="Link to the session video, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)")
     age: SkipValidation[Optional[List[Dict[str, object]]]] = Field(alias="age", default=None, description="Approximate age with an accuracy of +/-3 years.")
     portrait: SkipValidation[Optional[str]] = Field(alias="portrait", default=None, description="Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing the Person's extended attributes.")
     type: SkipValidation[Optional[LivenessType]] = Field(alias="type", default=None)
-    __properties: ClassVar[List[str]] = ["code", "status", "tag", "transactionId", "video", "age", "portrait", "metadata", "type"]
+    enroll_result: SkipValidation[Optional[EnrollResult]] = Field(alias="enrollResult", default=None)
+    verify_result: SkipValidation[Optional[VerifyResult]] = Field(alias="verifyResult", default=None)
+    __properties: ClassVar[List[str]] = ["code", "status", "tag", "transactionId", "video", "age", "portrait", "metadata", "type", "enrollResult", "verifyResult"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -72,6 +76,12 @@ class TransactionInfo(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of enroll_result
+        if self.enroll_result:
+            _dict['enrollResult'] = self.enroll_result.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of verify_result
+        if self.verify_result:
+            _dict['verifyResult'] = self.verify_result.to_dict()
         return _dict
 
     @classmethod
@@ -92,7 +102,9 @@ class TransactionInfo(BaseModel):
             "age": obj.get("age"),
             "portrait": obj.get("portrait"),
             "metadata": obj.get("metadata"),
-            "type": obj.get("type")
+            "type": obj.get("type"),
+            "enrollResult": EnrollResult.from_dict(obj["enrollResult"]) if obj.get("enrollResult") is not None else None,
+            "verifyResult": VerifyResult.from_dict(obj["verifyResult"]) if obj.get("verifyResult") is not None else None
         })
         return _obj
 

regula_facesdk_webclient-8.4.837.dev0/regula/facesdk/webclient/gen/models/verify_result.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.facesdk.webclient.gen.models.person import Person
+from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class VerifyResult(BaseModel):
+    """
+    Result of the verification requested at session start via the `verify` parameter. Returned only when verification was requested and the Enroll and Verify feature is enabled.
+    """ # noqa: E501
+    verified: SkipValidation[Optional[bool]] = Field(alias="verified", default=None, description="Whether the Person was successfully verified. `true` when the liveness check succeeds and the liveness portrait matches the enrolled Person according to the specified threshold; `false` when the liveness check fails or the faces do not match.")
+    person: SkipValidation[Optional[Person]] = Field(alias="person", default=None, description="The Person the liveness portrait was verified against.")
+    match: SkipValidation[Optional[VerifyResultMatch]] = Field(alias="match", default=None)
+    __properties: ClassVar[List[str]] = ["verified", "person", "match"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VerifyResult from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of person
+        if self.person:
+            _dict['person'] = self.person.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of match
+        if self.match:
+            _dict['match'] = self.match.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VerifyResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "verified": obj.get("verified"),
+            "person": Person.from_dict(obj["person"]) if obj.get("person") is not None else None,
+            "match": VerifyResultMatch.from_dict(obj["match"]) if obj.get("match") is not None else None
+        })
+        return _obj
+
+

regula_facesdk_webclient-8.4.837.dev0/regula/facesdk/webclient/gen/models/verify_result_match.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class VerifyResultMatch(BaseModel):
+    """
+    Face comparison details. Present when the liveness check succeeds.
+    """ # noqa: E501
+    verified: SkipValidation[Optional[bool]] = Field(alias="verified", default=None, description="Whether the faces matched according to the specified similarity threshold. `true` when the face similarity meets the threshold; `false` when it does not.")
+    similarity: SkipValidation[Optional[float]] = Field(alias="similarity", default=None, description="Face similarity score in the range from `0` to `1`.")
+    __properties: ClassVar[List[str]] = ["verified", "similarity"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VerifyResultMatch from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VerifyResultMatch from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "verified": obj.get("verified"),
+            "similarity": obj.get("similarity")
+        })
+        return _obj
+
+

{regula_facesdk_webclient-8.4.835.dev0 → regula_facesdk_webclient-8.4.837.dev0}/regula_facesdk_webclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.4.835.dev0
+Version: 8.4.837.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_facesdk_webclient-8.4.835.dev0 → regula_facesdk_webclient-8.4.837.dev0}/regula_facesdk_webclient.egg-info/SOURCES.txt

@@ -52,6 +52,8 @@ regula/facesdk/webclient/gen/models/detection_attributes_details_inner.py
 regula/facesdk/webclient/gen/models/detection_face.py
 regula/facesdk/webclient/gen/models/detection_quality.py
 regula/facesdk/webclient/gen/models/device_info.py
+regula/facesdk/webclient/gen/models/enroll_result.py
+regula/facesdk/webclient/gen/models/enroll_search_result.py
 regula/facesdk/webclient/gen/models/face_attribute.py
 regula/facesdk/webclient/gen/models/face_image_quality_align_type.py
 regula/facesdk/webclient/gen/models/face_image_quality_groups.py
@@ -121,6 +123,8 @@ regula/facesdk/webclient/gen/models/search_result.py
 regula/facesdk/webclient/gen/models/transaction_info.py
 regula/facesdk/webclient/gen/models/transaction_labels.py
 regula/facesdk/webclient/gen/models/update_group.py
+regula/facesdk/webclient/gen/models/verify_result.py
+regula/facesdk/webclient/gen/models/verify_result_match.py
 regula_facesdk_webclient.egg-info/PKG-INFO
 regula_facesdk_webclient.egg-info/SOURCES.txt
 regula_facesdk_webclient.egg-info/dependency_links.txt