regula-facesdk-webclient 6.4.198.dev0__py3-none-any.whl

regula/facesdk/webclient/gen/model/detection.py

@@ -0,0 +1,258 @@
+# coding: utf-8
+
+"""
+    Regula Face SDK Web API
+
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+
+    The version of the OpenAPI document: 6.2.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from regula.facesdk.webclient.gen.configuration import Configuration
+
+
+class Detection(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'crop': 'str',
+        'attributes': 'DetectionAttributes',
+        'landmarks': '[[int]]',
+        'quality': 'DetectionQuality',
+        'roi': 'FaceRectangular',
+        'thumbnail': 'str',
+    }
+
+    attribute_map = {
+        'crop': 'crop',
+        'attributes': 'attributes',
+        'landmarks': 'landmarks',
+        'quality': 'quality',
+        'roi': 'roi',
+        'thumbnail': 'thumbnail',
+    }
+
+    def __init__(self, crop=None, attributes=None, landmarks=None, quality=None, roi=None, thumbnail=None, local_vars_configuration=None):  # noqa: E501
+        """Detection - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._crop = None
+        self._attributes = None
+        self._landmarks = None
+        self._quality = None
+        self._roi = None
+        self._thumbnail = None
+        self.discriminator = None
+
+        if crop is not None:
+            self.crop = crop
+        if attributes is not None:
+            self.attributes = attributes
+        self.landmarks = landmarks
+        if quality is not None:
+            self.quality = quality
+        self.roi = roi
+        if thumbnail is not None:
+            self.thumbnail = thumbnail
+
+    @property
+    def crop(self):
+        """Gets the crop of this Detection.  # noqa: E501
+
+        Base64-encoded image.  # noqa: E501
+
+        :return: The crop of this Detection.  # noqa: E501
+        :rtype: str
+        """
+        return self._crop
+
+    @crop.setter
+    def crop(self, crop):
+        """Sets the crop of this Detection.
+
+        Base64-encoded image.  # noqa: E501
+
+        :param crop: The crop of this Detection.  # noqa: E501
+        :type crop: str
+        """
+
+        self._crop = crop
+
+    @property
+    def attributes(self):
+        """Gets the attributes of this Detection.  # noqa: E501
+
+
+        :return: The attributes of this Detection.  # noqa: E501
+        :rtype: DetectionAttributes
+        """
+        return self._attributes
+
+    @attributes.setter
+    def attributes(self, attributes):
+        """Sets the attributes of this Detection.
+
+
+        :param attributes: The attributes of this Detection.  # noqa: E501
+        :type attributes: DetectionAttributes
+        """
+
+        self._attributes = attributes
+
+    @property
+    def landmarks(self):
+        """Gets the landmarks of this Detection.  # noqa: E501
+
+        Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.  # noqa: E501
+
+        :return: The landmarks of this Detection.  # noqa: E501
+        :rtype: [[int]]
+        """
+        return self._landmarks
+
+    @landmarks.setter
+    def landmarks(self, landmarks):
+        """Sets the landmarks of this Detection.
+
+        Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.  # noqa: E501
+
+        :param landmarks: The landmarks of this Detection.  # noqa: E501
+        :type landmarks: [[int]]
+        """
+        if self.local_vars_configuration.client_side_validation and landmarks is None:  # noqa: E501
+            raise ValueError("Invalid value for `landmarks`, must not be `None`")  # noqa: E501
+
+        self._landmarks = landmarks
+
+    @property
+    def quality(self):
+        """Gets the quality of this Detection.  # noqa: E501
+
+
+        :return: The quality of this Detection.  # noqa: E501
+        :rtype: DetectionQuality
+        """
+        return self._quality
+
+    @quality.setter
+    def quality(self, quality):
+        """Sets the quality of this Detection.
+
+
+        :param quality: The quality of this Detection.  # noqa: E501
+        :type quality: DetectionQuality
+        """
+
+        self._quality = quality
+
+    @property
+    def roi(self):
+        """Gets the roi of this Detection.  # noqa: E501
+
+
+        :return: The roi of this Detection.  # noqa: E501
+        :rtype: FaceRectangular
+        """
+        return self._roi
+
+    @roi.setter
+    def roi(self, roi):
+        """Sets the roi of this Detection.
+
+
+        :param roi: The roi of this Detection.  # noqa: E501
+        :type roi: FaceRectangular
+        """
+        if self.local_vars_configuration.client_side_validation and roi is None:  # noqa: E501
+            raise ValueError("Invalid value for `roi`, must not be `None`")  # noqa: E501
+
+        self._roi = roi
+
+    @property
+    def thumbnail(self):
+        """Gets the thumbnail of this Detection.  # noqa: E501
+
+        See `crop` instead.  # noqa: E501
+
+        :return: The thumbnail of this Detection.  # noqa: E501
+        :rtype: str
+        """
+        return self._thumbnail
+
+    @thumbnail.setter
+    def thumbnail(self, thumbnail):
+        """Sets the thumbnail of this Detection.
+
+        See `crop` instead.  # noqa: E501
+
+        :param thumbnail: The thumbnail of this Detection.  # noqa: E501
+        :type thumbnail: str
+        """
+
+        self._thumbnail = thumbnail
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, Detection):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, Detection):
+            return True
+
+        return self.to_dict() != other.to_dict()

regula/facesdk/webclient/gen/model/detection_attributes.py

@@ -0,0 +1,148 @@
+# coding: utf-8
+
+"""
+    Regula Face SDK Web API
+
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+
+    The version of the OpenAPI document: 6.2.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from regula.facesdk.webclient.gen.configuration import Configuration
+
+
+class DetectionAttributes(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'details': '[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]',
+        'elapsed_time': 'float',
+    }
+
+    attribute_map = {
+        'details': 'details',
+        'elapsed_time': 'elapsedTime',
+    }
+
+    def __init__(self, details=None, elapsed_time=None, local_vars_configuration=None):  # noqa: E501
+        """DetectionAttributes - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._details = None
+        self._elapsed_time = None
+        self.discriminator = None
+
+        if details is not None:
+            self.details = details
+        if elapsed_time is not None:
+            self.elapsed_time = elapsed_time
+
+    @property
+    def details(self):
+        """Gets the details of this DetectionAttributes.  # noqa: E501
+
+
+        :return: The details of this DetectionAttributes.  # noqa: E501
+        :rtype: [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]
+        """
+        return self._details
+
+    @details.setter
+    def details(self, details):
+        """Sets the details of this DetectionAttributes.
+
+
+        :param details: The details of this DetectionAttributes.  # noqa: E501
+        :type details: [{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]
+        """
+
+        self._details = details
+
+    @property
+    def elapsed_time(self):
+        """Gets the elapsed_time of this DetectionAttributes.  # noqa: E501
+
+        The elapsed time for attribute detection.  # noqa: E501
+
+        :return: The elapsed_time of this DetectionAttributes.  # noqa: E501
+        :rtype: float
+        """
+        return self._elapsed_time
+
+    @elapsed_time.setter
+    def elapsed_time(self, elapsed_time):
+        """Sets the elapsed_time of this DetectionAttributes.
+
+        The elapsed time for attribute detection.  # noqa: E501
+
+        :param elapsed_time: The elapsed_time of this DetectionAttributes.  # noqa: E501
+        :type elapsed_time: float
+        """
+
+        self._elapsed_time = elapsed_time
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, DetectionAttributes):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, DetectionAttributes):
+            return True
+
+        return self.to_dict() != other.to_dict()

regula/facesdk/webclient/gen/model/detection_face.py

@@ -0,0 +1,260 @@
+# coding: utf-8
+
+"""
+    Regula Face SDK Web API
+
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+
+    The version of the OpenAPI document: 6.2.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from regula.facesdk.webclient.gen.configuration import Configuration
+
+
+class DetectionFace(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'face_index': 'float',
+        'landmarks': '[[float]]',
+        'rotation_angle': 'float',
+        'roi': 'FaceRectangular',
+        'thumbnail': 'str',
+        'crop': 'str',
+    }
+
+    attribute_map = {
+        'face_index': 'faceIndex',
+        'landmarks': 'landmarks',
+        'rotation_angle': 'rotationAngle',
+        'roi': 'roi',
+        'thumbnail': 'thumbnail',
+        'crop': 'crop',
+    }
+
+    def __init__(self, face_index=None, landmarks=None, rotation_angle=None, roi=None, thumbnail=None, crop=None, local_vars_configuration=None):  # noqa: E501
+        """DetectionFace - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._face_index = None
+        self._landmarks = None
+        self._rotation_angle = None
+        self._roi = None
+        self._thumbnail = None
+        self._crop = None
+        self.discriminator = None
+
+        if face_index is not None:
+            self.face_index = face_index
+        if landmarks is not None:
+            self.landmarks = landmarks
+        if rotation_angle is not None:
+            self.rotation_angle = rotation_angle
+        if roi is not None:
+            self.roi = roi
+        if thumbnail is not None:
+            self.thumbnail = thumbnail
+        if crop is not None:
+            self.crop = crop
+
+    @property
+    def face_index(self):
+        """Gets the face_index of this DetectionFace.  # noqa: E501
+
+        The detected face index number.  # noqa: E501
+
+        :return: The face_index of this DetectionFace.  # noqa: E501
+        :rtype: float
+        """
+        return self._face_index
+
+    @face_index.setter
+    def face_index(self, face_index):
+        """Sets the face_index of this DetectionFace.
+
+        The detected face index number.  # noqa: E501
+
+        :param face_index: The face_index of this DetectionFace.  # noqa: E501
+        :type face_index: float
+        """
+
+        self._face_index = face_index
+
+    @property
+    def landmarks(self):
+        """Gets the landmarks of this DetectionFace.  # noqa: E501
+
+        Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.  # noqa: E501
+
+        :return: The landmarks of this DetectionFace.  # noqa: E501
+        :rtype: [[float]]
+        """
+        return self._landmarks
+
+    @landmarks.setter
+    def landmarks(self, landmarks):
+        """Sets the landmarks of this DetectionFace.
+
+        Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.  # noqa: E501
+
+        :param landmarks: The landmarks of this DetectionFace.  # noqa: E501
+        :type landmarks: [[float]]
+        """
+
+        self._landmarks = landmarks
+
+    @property
+    def rotation_angle(self):
+        """Gets the rotation_angle of this DetectionFace.  # noqa: E501
+
+        Angle of rotation of the face from the vertical axis, degrees.  # noqa: E501
+
+        :return: The rotation_angle of this DetectionFace.  # noqa: E501
+        :rtype: float
+        """
+        return self._rotation_angle
+
+    @rotation_angle.setter
+    def rotation_angle(self, rotation_angle):
+        """Sets the rotation_angle of this DetectionFace.
+
+        Angle of rotation of the face from the vertical axis, degrees.  # noqa: E501
+
+        :param rotation_angle: The rotation_angle of this DetectionFace.  # noqa: E501
+        :type rotation_angle: float
+        """
+
+        self._rotation_angle = rotation_angle
+
+    @property
+    def roi(self):
+        """Gets the roi of this DetectionFace.  # noqa: E501
+
+
+        :return: The roi of this DetectionFace.  # noqa: E501
+        :rtype: FaceRectangular
+        """
+        return self._roi
+
+    @roi.setter
+    def roi(self, roi):
+        """Sets the roi of this DetectionFace.
+
+
+        :param roi: The roi of this DetectionFace.  # noqa: E501
+        :type roi: FaceRectangular
+        """
+
+        self._roi = roi
+
+    @property
+    def thumbnail(self):
+        """Gets the thumbnail of this DetectionFace.  # noqa: E501
+
+        See `crop` instead.  # noqa: E501
+
+        :return: The thumbnail of this DetectionFace.  # noqa: E501
+        :rtype: str
+        """
+        return self._thumbnail
+
+    @thumbnail.setter
+    def thumbnail(self, thumbnail):
+        """Sets the thumbnail of this DetectionFace.
+
+        See `crop` instead.  # noqa: E501
+
+        :param thumbnail: The thumbnail of this DetectionFace.  # noqa: E501
+        :type thumbnail: str
+        """
+
+        self._thumbnail = thumbnail
+
+    @property
+    def crop(self):
+        """Gets the crop of this DetectionFace.  # noqa: E501
+
+        Base64-encoded aligned and cropped portrait.  # noqa: E501
+
+        :return: The crop of this DetectionFace.  # noqa: E501
+        :rtype: str
+        """
+        return self._crop
+
+    @crop.setter
+    def crop(self, crop):
+        """Sets the crop of this DetectionFace.
+
+        Base64-encoded aligned and cropped portrait.  # noqa: E501
+
+        :param crop: The crop of this DetectionFace.  # noqa: E501
+        :type crop: str
+        """
+
+        self._crop = crop
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, DetectionFace):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, DetectionFace):
+            return True
+
+        return self.to_dict() != other.to_dict()