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

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

@@ -0,0 +1,206 @@
+# 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 MatchAndSearchResponseAllOf(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 = {
+        'results': '[MatchImageResult]',
+        'elapsed_time': 'float',
+        'metadata': '{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',
+        'detections': '[MatchAndSearchResponseAllOfDetections]',
+    }
+
+    attribute_map = {
+        'results': 'results',
+        'elapsed_time': 'elapsedTime',
+        'metadata': 'metadata',
+        'detections': 'detections',
+    }
+
+    def __init__(self, results=None, elapsed_time=None, metadata=None, detections=None, local_vars_configuration=None):  # noqa: E501
+        """MatchAndSearchResponseAllOf - 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._results = None
+        self._elapsed_time = None
+        self._metadata = None
+        self._detections = None
+        self.discriminator = None
+
+        if results is not None:
+            self.results = results
+        if elapsed_time is not None:
+            self.elapsed_time = elapsed_time
+        if metadata is not None:
+            self.metadata = metadata
+        if detections is not None:
+            self.detections = detections
+
+    @property
+    def results(self):
+        """Gets the results of this MatchAndSearchResponseAllOf.  # noqa: E501
+
+        The match and search results.  # noqa: E501
+
+        :return: The results of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :rtype: [MatchImageResult]
+        """
+        return self._results
+
+    @results.setter
+    def results(self, results):
+        """Sets the results of this MatchAndSearchResponseAllOf.
+
+        The match and search results.  # noqa: E501
+
+        :param results: The results of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :type results: [MatchImageResult]
+        """
+
+        self._results = results
+
+    @property
+    def elapsed_time(self):
+        """Gets the elapsed_time of this MatchAndSearchResponseAllOf.  # noqa: E501
+
+        Time the processing has taken, ms.  # noqa: E501
+
+        :return: The elapsed_time of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :rtype: float
+        """
+        return self._elapsed_time
+
+    @elapsed_time.setter
+    def elapsed_time(self, elapsed_time):
+        """Sets the elapsed_time of this MatchAndSearchResponseAllOf.
+
+        Time the processing has taken, ms.  # noqa: E501
+
+        :param elapsed_time: The elapsed_time of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :type elapsed_time: float
+        """
+
+        self._elapsed_time = elapsed_time
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this MatchAndSearchResponseAllOf.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :rtype: {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """Sets the metadata of this MatchAndSearchResponseAllOf.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :type metadata: {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
+        """
+
+        self._metadata = metadata
+
+    @property
+    def detections(self):
+        """Gets the detections of this MatchAndSearchResponseAllOf.  # noqa: E501
+
+        The detection results.  # noqa: E501
+
+        :return: The detections of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :rtype: [MatchAndSearchResponseAllOfDetections]
+        """
+        return self._detections
+
+    @detections.setter
+    def detections(self, detections):
+        """Sets the detections of this MatchAndSearchResponseAllOf.
+
+        The detection results.  # noqa: E501
+
+        :param detections: The detections of this MatchAndSearchResponseAllOf.  # noqa: E501
+        :type detections: [MatchAndSearchResponseAllOfDetections]
+        """
+
+        self._detections = detections
+
+    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, MatchAndSearchResponseAllOf):
+            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, MatchAndSearchResponseAllOf):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,176 @@
+# 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 MatchAndSearchResponseAllOfDetections(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 = {
+        'faces': '[FacesResponse]',
+        'image_index': 'int',
+        'status': 'FaceSDKResultCode',
+    }
+
+    attribute_map = {
+        'faces': 'faces',
+        'image_index': 'imageIndex',
+        'status': 'status',
+    }
+
+    def __init__(self, faces=None, image_index=None, status=None, local_vars_configuration=None):  # noqa: E501
+        """MatchAndSearchResponseAllOfDetections - 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._faces = None
+        self._image_index = None
+        self._status = None
+        self.discriminator = None
+
+        if faces is not None:
+            self.faces = faces
+        if image_index is not None:
+            self.image_index = image_index
+        if status is not None:
+            self.status = status
+
+    @property
+    def faces(self):
+        """Gets the faces of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+
+        Detected faces.  # noqa: E501
+
+        :return: The faces of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+        :rtype: [FacesResponse]
+        """
+        return self._faces
+
+    @faces.setter
+    def faces(self, faces):
+        """Sets the faces of this MatchAndSearchResponseAllOfDetections.
+
+        Detected faces.  # noqa: E501
+
+        :param faces: The faces of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+        :type faces: [FacesResponse]
+        """
+
+        self._faces = faces
+
+    @property
+    def image_index(self):
+        """Gets the image_index of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+
+        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.  # noqa: E501
+
+        :return: The image_index of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+        :rtype: int
+        """
+        return self._image_index
+
+    @image_index.setter
+    def image_index(self, image_index):
+        """Sets the image_index of this MatchAndSearchResponseAllOfDetections.
+
+        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.  # noqa: E501
+
+        :param image_index: The image_index of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+        :type image_index: int
+        """
+
+        self._image_index = image_index
+
+    @property
+    def status(self):
+        """Gets the status of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+
+
+        :return: The status of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+        :rtype: FaceSDKResultCode
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """Sets the status of this MatchAndSearchResponseAllOfDetections.
+
+
+        :param status: The status of this MatchAndSearchResponseAllOfDetections.  # noqa: E501
+        :type status: FaceSDKResultCode
+        """
+
+        self._status = status
+
+    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, MatchAndSearchResponseAllOfDetections):
+            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, MatchAndSearchResponseAllOfDetections):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,205 @@
+# 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 MatchImage(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 = {
+        'index': 'int',
+        'type': 'ImageSource',
+        'data': 'str',
+        'detect_all': 'bool',
+    }
+
+    attribute_map = {
+        'index': 'index',
+        'type': 'type',
+        'data': 'data',
+        'detect_all': 'detectAll',
+    }
+
+    def __init__(self, index=None, type=None, data=None, detect_all=False, local_vars_configuration=None):  # noqa: E501
+        """MatchImage - 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._index = None
+        self._type = None
+        self._data = None
+        self._detect_all = None
+        self.discriminator = None
+
+        if index is not None:
+            self.index = index
+        if type is not None:
+            self.type = type
+        self.data = data
+        if detect_all is not None:
+            self.detect_all = detect_all
+
+    @property
+    def index(self):
+        """Gets the index of this MatchImage.  # noqa: E501
+
+        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.  # noqa: E501
+
+        :return: The index of this MatchImage.  # noqa: E501
+        :rtype: int
+        """
+        return self._index
+
+    @index.setter
+    def index(self, index):
+        """Sets the index of this MatchImage.
+
+        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.  # noqa: E501
+
+        :param index: The index of this MatchImage.  # noqa: E501
+        :type index: int
+        """
+
+        self._index = index
+
+    @property
+    def type(self):
+        """Gets the type of this MatchImage.  # noqa: E501
+
+
+        :return: The type of this MatchImage.  # noqa: E501
+        :rtype: ImageSource
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this MatchImage.
+
+
+        :param type: The type of this MatchImage.  # noqa: E501
+        :type type: ImageSource
+        """
+
+        self._type = type
+
+    @property
+    def data(self):
+        """Gets the data of this MatchImage.  # noqa: E501
+
+        Base64-encoded image.  # noqa: E501
+
+        :return: The data of this MatchImage.  # noqa: E501
+        :rtype: str
+        """
+        return self._data
+
+    @data.setter
+    def data(self, data):
+        """Sets the data of this MatchImage.
+
+        Base64-encoded image.  # noqa: E501
+
+        :param data: The data of this MatchImage.  # noqa: E501
+        :type data: str
+        """
+        if self.local_vars_configuration.client_side_validation and data is None:  # noqa: E501
+            raise ValueError("Invalid value for `data`, must not be `None`")  # noqa: E501
+
+        self._data = data
+
+    @property
+    def detect_all(self):
+        """Gets the detect_all of this MatchImage.  # noqa: E501
+
+        Whether to detect all faces in the image. If set to `false`, only the most central face is detected.  # noqa: E501
+
+        :return: The detect_all of this MatchImage.  # noqa: E501
+        :rtype: bool
+        """
+        return self._detect_all
+
+    @detect_all.setter
+    def detect_all(self, detect_all):
+        """Sets the detect_all of this MatchImage.
+
+        Whether to detect all faces in the image. If set to `false`, only the most central face is detected.  # noqa: E501
+
+        :param detect_all: The detect_all of this MatchImage.  # noqa: E501
+        :type detect_all: bool
+        """
+
+        self._detect_all = detect_all
+
+    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, MatchImage):
+            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, MatchImage):
+            return True
+
+        return self.to_dict() != other.to_dict()