regula.facesdk.webclient 8.5.892.dev0__tar.gz → 8.5.894rc0__tar.gz

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/PKG-INFO

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

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/api/liveness20_api.py

@@ -9,7 +9,6 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import Field, StrictStr
-from typing import Optional
 from typing_extensions import Annotated
 from uuid import UUID
 from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo
@@ -35,8 +34,8 @@ class Liveness20Api:
     @validate_call
     def delete_liveness_transaction(
         self,
-        transaction_id: Annotated[Optional[UUID], Field(description="ID of the current liveness transaction.")] = None,
-        tag: Annotated[Optional[StrictStr], Field(description="A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.")] = None,
+        transaction_id: Annotated[UUID, Field(description="ID of the current liveness transaction.")],
+        tag: Annotated[StrictStr, Field(description="A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -54,9 +53,9 @@ class Liveness20Api:
 
         This endpoint deletes a liveness transaction based on either the specified `tag` or `transactionId`. At least one of the parameters must be provided for the operation to be valid.
 
-        :param transaction_id: ID of the current liveness transaction.
+        :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str
-        :param tag: A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.
+        :param tag: A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction. (required)
         :type tag: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -106,8 +105,8 @@ class Liveness20Api:
     @validate_call
     def delete_liveness_transaction_with_http_info(
         self,
-        transaction_id: Annotated[Optional[UUID], Field(description="ID of the current liveness transaction.")] = None,
-        tag: Annotated[Optional[StrictStr], Field(description="A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.")] = None,
+        transaction_id: Annotated[UUID, Field(description="ID of the current liveness transaction.")],
+        tag: Annotated[StrictStr, Field(description="A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -125,9 +124,9 @@ class Liveness20Api:
 
         This endpoint deletes a liveness transaction based on either the specified `tag` or `transactionId`. At least one of the parameters must be provided for the operation to be valid.
 
-        :param transaction_id: ID of the current liveness transaction.
+        :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str
-        :param tag: A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.
+        :param tag: A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction. (required)
         :type tag: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -177,8 +176,8 @@ class Liveness20Api:
     @validate_call
     def delete_liveness_transaction_without_preload_content(
         self,
-        transaction_id: Annotated[Optional[UUID], Field(description="ID of the current liveness transaction.")] = None,
-        tag: Annotated[Optional[StrictStr], Field(description="A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.")] = None,
+        transaction_id: Annotated[UUID, Field(description="ID of the current liveness transaction.")],
+        tag: Annotated[StrictStr, Field(description="A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -196,9 +195,9 @@ class Liveness20Api:
 
         This endpoint deletes a liveness transaction based on either the specified `tag` or `transactionId`. At least one of the parameters must be provided for the operation to be valid.
 
-        :param transaction_id: ID of the current liveness transaction.
+        :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str
-        :param tag: A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction.
+        :param tag: A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction. (required)
         :type tag: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/detect_response.py

@@ -9,9 +9,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
-from uuid import UUID
 from regula.facesdk.webclient.gen.models.detect_result import DetectResult
 from regula.facesdk.webclient.gen.models.face_sdk_result_code import FaceSDKResultCode
 from typing import Optional, Set
@@ -23,9 +22,8 @@ class DetectResponse(BaseModel):
     DetectResponse
     """ # noqa: E501
     code: SkipValidation[FaceSDKResultCode] = Field(alias="code")
-    transaction_id: SkipValidation[str] = Field(alias="transactionId", description="Transaction identifier")
     results: SkipValidation[Optional[DetectResult]] = Field(alias="results", default=None)
-    __properties: ClassVar[List[str]] = ["code", "transactionId", "results"]
+    __properties: ClassVar[List[str]] = ["code", "results"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -84,7 +82,6 @@ class DetectResponse(BaseModel):
 
         _obj = cls.model_validate({
             "code": obj.get("code"),
-            "transactionId": obj.get("transactionId"),
             "results": DetectResult.from_dict(obj["results"]) if obj.get("results") is not None else None
         })
         return _obj

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/detection.py

@@ -25,7 +25,7 @@ class Detection(BaseModel):
     attributes: SkipValidation[Optional[DetectionAttributes]] = Field(alias="attributes", default=None)
     landmarks: SkipValidation[List[List[int]]] = Field(alias="landmarks", description="Absolute coordinates (X,Y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.")
     quality: SkipValidation[Optional[DetectionQuality]] = Field(alias="quality", default=None)
-    roi: SkipValidation[List[float]] = Field(alias="roi", description="The rectangular area of a detected face that is represented by a set of four elements [x, y, width, height]: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
+    roi: SkipValidation[List[float]] = Field(alias="roi", description="The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
     __properties: ClassVar[List[str]] = ["crop", "attributes", "landmarks", "quality", "roi"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/detection_face.py

@@ -22,7 +22,7 @@ class DetectionFace(BaseModel):
     face_index: SkipValidation[Optional[float]] = Field(alias="faceIndex", default=None, description="The detected face index number.")
     landmarks: SkipValidation[Optional[List[List[float]]]] = Field(alias="landmarks", default=None, description="Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.")
     rotation_angle: SkipValidation[Optional[float]] = Field(alias="rotationAngle", default=None, description="Angle of rotation of the face from the vertical axis, degrees.")
-    roi: SkipValidation[Optional[List[float]]] = Field(alias="roi", default=None, description="The rectangular area of a detected face that is represented by a set of four elements [x, y, width, height]: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
+    roi: SkipValidation[Optional[List[float]]] = Field(alias="roi", default=None, description="The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
     crop: SkipValidation[Optional[bytearray]] = Field(alias="crop", default=None, description="Base64-encoded aligned and cropped portrait.")
     __properties: ClassVar[List[str]] = ["faceIndex", "landmarks", "rotationAngle", "roi", "crop"]
 

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/face_sdk_result.py

@@ -9,9 +9,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List
-from uuid import UUID
 from regula.facesdk.webclient.gen.models.face_sdk_result_code import FaceSDKResultCode
 from typing import Optional, Set
 from typing_extensions import Self
@@ -22,8 +21,7 @@ class FaceSDKResult(BaseModel):
     FaceSDKResult
     """ # noqa: E501
     code: SkipValidation[FaceSDKResultCode] = Field(alias="code")
-    transaction_id: SkipValidation[str] = Field(alias="transactionId", description="Transaction identifier")
-    __properties: ClassVar[List[str]] = ["code", "transactionId"]
+    __properties: ClassVar[List[str]] = ["code"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -78,8 +76,7 @@ class FaceSDKResult(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "code": obj.get("code"),
-            "transactionId": obj.get("transactionId")
+            "code": obj.get("code")
         })
         return _obj
 

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/face_sdk_result_code.py

@@ -12,7 +12,7 @@ from typing_extensions import Self
 
 class FaceSDKResultCode(int, Enum):
     """
-    The result code.
+    The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
     """
 
     """
@@ -59,13 +59,6 @@ class FaceSDKResultCode(int, Enum):
     FACER_ABORTED_LIVENESS_TRANSACTION = 252
     FACER_GENERAL_ERROR = 253
     FACER_PASSIVE_LIVENESS_FAIL = 254
-    FACER_PRINTED_FACE_DETECTED = 255
-    FACER_BLOCKED_REQUEST = 256
-    FACER_CORRUPTED_REQUEST = 257
-    FACER_GENERAL_CHECK_FAIL_RTD = 258
-    FACER_BLINK_FAILED = 259
-    FACER_BAD_FACE_QUALITY_LIVENESS_TRANSACTION = 260
-    FACER_BAD_FRAME_SIZE = 261
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/faces_response.py

@@ -23,7 +23,7 @@ class FacesResponse(BaseModel):
     face_index: SkipValidation[Optional[float]] = Field(alias="faceIndex", default=None, description="The detected face index number.")
     landmarks: SkipValidation[Optional[List[List[float]]]] = Field(alias="landmarks", default=None, description="Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.")
     rotation_angle: SkipValidation[Optional[float]] = Field(alias="rotationAngle", default=None, description="Angle of rotation of the face from the vertical axis, degrees.")
-    roi: SkipValidation[Optional[List[float]]] = Field(alias="roi", default=None, description="The rectangular area of a detected face that is represented by a set of four elements [x, y, width, height]: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
+    roi: SkipValidation[Optional[List[float]]] = Field(alias="roi", default=None, description="The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
     crop: SkipValidation[Optional[bytearray]] = Field(alias="crop", default=None, description="Base64-encoded aligned and cropped portrait.")
     persons: SkipValidation[Optional[List[PersonWithImages]]] = Field(alias="persons", default=None, description="Detected Persons.")
     __properties: ClassVar[List[str]] = ["faceIndex", "landmarks", "rotationAngle", "roi", "crop", "persons"]

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/match_and_search_response.py

@@ -11,7 +11,6 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from uuid import UUID
 from regula.facesdk.webclient.gen.models.face_sdk_result_code import FaceSDKResultCode
 from regula.facesdk.webclient.gen.models.match_and_search_response_data_detections_item import MatchAndSearchResponseDataDetectionsItem
 from regula.facesdk.webclient.gen.models.match_image_result import MatchImageResult
@@ -24,12 +23,11 @@ class MatchAndSearchResponse(BaseModel):
     MatchAndSearchResponse
     """ # noqa: E501
     code: SkipValidation[FaceSDKResultCode] = Field(alias="code")
-    transaction_id: SkipValidation[str] = Field(alias="transactionId", description="Transaction identifier")
     results: SkipValidation[Optional[List[MatchImageResult]]] = Field(alias="results", default=None, description="The match and search results.")
     elapsed_time: SkipValidation[Optional[float]] = Field(alias="elapsedTime", default=None, description="Server processing time, ms. Does not include the time taken to receive the request or deliver the response.")
     metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     detections: SkipValidation[Optional[List[MatchAndSearchResponseDataDetectionsItem]]] = Field(alias="detections", default=None, description="The detection results.")
-    __properties: ClassVar[List[str]] = ["code", "transactionId", "results", "elapsedTime", "metadata", "detections"]
+    __properties: ClassVar[List[str]] = ["code", "results", "elapsedTime", "metadata", "detections"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -99,7 +97,6 @@ class MatchAndSearchResponse(BaseModel):
 
         _obj = cls.model_validate({
             "code": obj.get("code"),
-            "transactionId": obj.get("transactionId"),
             "results": [MatchImageResult.from_dict(_item) for _item in obj.get("results", []) if MatchImageResult.from_dict(_item) is not None],
             "elapsedTime": obj.get("elapsedTime"),
             "metadata": obj.get("metadata"),

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/match_image.py

@@ -22,7 +22,7 @@ class MatchImage(BaseModel):
     """ # noqa: E501
     index: SkipValidation[Optional[int]] = Field(alias="index", default=None, description="The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.")
     type: SkipValidation[Optional[ImageSource]] = Field(alias="type", default=None)
-    data: SkipValidation[Optional[bytearray]] = Field(alias="data", default=None, description="Base64-encoded image.")
+    data: SkipValidation[bytearray] = Field(alias="data", description="Base64-encoded image.")
     detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
     liveness_transaction_id: SkipValidation[Optional[str]] = Field(alias="livenessTransactionId", default=None, description="Identifier of the completed liveness transaction whose captured face is used as one of the comparison inputs. If this parameter is provided, it replaces one of the images in the matching request.")
     __properties: ClassVar[List[str]] = ["index", "type", "data", "detectAll", "livenessTransactionId"]

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/match_response.py

@@ -11,7 +11,6 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
-from uuid import UUID
 from regula.facesdk.webclient.gen.models.face_sdk_result_code import FaceSDKResultCode
 from regula.facesdk.webclient.gen.models.match_image_detection import MatchImageDetection
 from regula.facesdk.webclient.gen.models.match_image_result import MatchImageResult
@@ -24,11 +23,10 @@ class MatchResponse(BaseModel):
     MatchResponse
     """ # noqa: E501
     code: SkipValidation[FaceSDKResultCode] = Field(alias="code")
-    transaction_id: SkipValidation[str] = Field(alias="transactionId", description="Transaction identifier")
     detections: SkipValidation[Optional[List[MatchImageDetection]]] = Field(alias="detections", default=None, description="The detection results.")
     results: SkipValidation[Optional[List[MatchImageResult]]] = Field(alias="results", default=None, description="The comparison results.")
     metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
-    __properties: ClassVar[List[str]] = ["code", "transactionId", "detections", "results", "metadata"]
+    __properties: ClassVar[List[str]] = ["code", "detections", "results", "metadata"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -98,7 +96,6 @@ class MatchResponse(BaseModel):
 
         _obj = cls.model_validate({
             "code": obj.get("code"),
-            "transactionId": obj.get("transactionId"),
             "detections": [MatchImageDetection.from_dict(_item) for _item in obj.get("detections", []) if MatchImageDetection.from_dict(_item) is not None],
             "results": [MatchImageResult.from_dict(_item) for _item in obj.get("results", []) if MatchImageResult.from_dict(_item) is not None],
             "metadata": obj.get("metadata")

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/search_detection.py

@@ -28,7 +28,7 @@ class SearchDetection(BaseModel):
     landmarks: SkipValidation[Optional[List[List[int]]]] = Field(alias="landmarks", default=None, description="Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.")
     landmarks_type: SkipValidation[Optional[int]] = Field(alias="landmarksType", default=None, description="Internal.")
     msg: SkipValidation[Optional[str]] = Field(alias="msg", default=None, description="Internal.")
-    roi: SkipValidation[Optional[List[float]]] = Field(alias="roi", default=None, description="The rectangular area of a detected face that is represented by a set of four elements [x, y, width, height]: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
+    roi: SkipValidation[Optional[List[float]]] = Field(alias="roi", default=None, description="The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.")
     version_sdk: SkipValidation[Optional[str]] = Field(alias="versionSDK", default=None)
     __properties: ClassVar[List[str]] = ["code", "crop", "detectorType", "hash", "idx", "image", "landmarks", "landmarksType", "msg", "roi", "versionSDK"]
 

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/search_parameters_create_person.py

@@ -65,11 +65,6 @@ class SearchParametersCreatePerson(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # set to None if ttl (nullable) is None
-        # and model_fields_set contains the field
-        if self.ttl is None and "ttl" in self.model_fields_set:
-            _dict['ttl'] = None
-
         return _dict
 
     @classmethod

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula/facesdk/webclient/gen/models/transaction_info.py

@@ -12,7 +12,6 @@ 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.face_sdk_result_code import FaceSDKResultCode
 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
@@ -23,7 +22,7 @@ class TransactionInfo(BaseModel):
     """
     TransactionInfo
     """ # noqa: E501
-    code: SkipValidation[Optional[FaceSDKResultCode]] = Field(alias="code", default=None)
+    code: SkipValidation[Optional[int]] = Field(alias="code", default=None, description="Result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).")
     status: SkipValidation[Optional[int]] = Field(alias="status", default=None, description="Whether the liveness detection is confirmed `0` or not `1`.")
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator, should be unique for each session.")
     transaction_id: SkipValidation[Optional[str]] = Field(alias="transactionId", default=None, description="Transaction ID, there can be several transactions within one session.")
@@ -83,11 +82,6 @@ class TransactionInfo(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of verify_result
         if self.verify_result:
             _dict['verifyResult'] = self.verify_result.to_dict()
-        # set to None if status (nullable) is None
-        # and model_fields_set contains the field
-        if self.status is None and "status" in self.model_fields_set:
-            _dict['status'] = None
-
         return _dict
 
     @classmethod

{regula_facesdk_webclient-8.5.892.dev0 → regula_facesdk_webclient-8.5.894rc0}/regula_facesdk_webclient.egg-info/PKG-INFO

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