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

regula/facesdk/webclient/gen/model/match_response.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 MatchResponse(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 = {
+        'code': 'FaceSDKResultCode',
+        'detections': '[MatchImageDetection]',
+        'results': '[MatchImageResult]',
+        'metadata': '{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',
+    }
+
+    attribute_map = {
+        'code': 'code',
+        'detections': 'detections',
+        'results': 'results',
+        'metadata': 'metadata',
+    }
+
+    def __init__(self, code=None, detections=None, results=None, metadata=None, local_vars_configuration=None):  # noqa: E501
+        """MatchResponse - 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._code = None
+        self._detections = None
+        self._results = None
+        self._metadata = None
+        self.discriminator = None
+
+        self.code = code
+        if detections is not None:
+            self.detections = detections
+        if results is not None:
+            self.results = results
+        if metadata is not None:
+            self.metadata = metadata
+
+    @property
+    def code(self):
+        """Gets the code of this MatchResponse.  # noqa: E501
+
+
+        :return: The code of this MatchResponse.  # noqa: E501
+        :rtype: FaceSDKResultCode
+        """
+        return self._code
+
+    @code.setter
+    def code(self, code):
+        """Sets the code of this MatchResponse.
+
+
+        :param code: The code of this MatchResponse.  # noqa: E501
+        :type code: FaceSDKResultCode
+        """
+        if self.local_vars_configuration.client_side_validation and code is None:  # noqa: E501
+            raise ValueError("Invalid value for `code`, must not be `None`")  # noqa: E501
+
+        self._code = code
+
+    @property
+    def detections(self):
+        """Gets the detections of this MatchResponse.  # noqa: E501
+
+        The detection results.  # noqa: E501
+
+        :return: The detections of this MatchResponse.  # noqa: E501
+        :rtype: [MatchImageDetection]
+        """
+        return self._detections
+
+    @detections.setter
+    def detections(self, detections):
+        """Sets the detections of this MatchResponse.
+
+        The detection results.  # noqa: E501
+
+        :param detections: The detections of this MatchResponse.  # noqa: E501
+        :type detections: [MatchImageDetection]
+        """
+
+        self._detections = detections
+
+    @property
+    def results(self):
+        """Gets the results of this MatchResponse.  # noqa: E501
+
+        The comparison results.  # noqa: E501
+
+        :return: The results of this MatchResponse.  # noqa: E501
+        :rtype: [MatchImageResult]
+        """
+        return self._results
+
+    @results.setter
+    def results(self, results):
+        """Sets the results of this MatchResponse.
+
+        The comparison results.  # noqa: E501
+
+        :param results: The results of this MatchResponse.  # noqa: E501
+        :type results: [MatchImageResult]
+        """
+
+        self._results = results
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this MatchResponse.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this MatchResponse.  # 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 MatchResponse.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this MatchResponse.  # noqa: E501
+        :type metadata: {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
+        """
+
+        self._metadata = metadata
+
+    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, MatchResponse):
+            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, MatchResponse):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

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

regula/facesdk/webclient/gen/model/operation_log.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 OperationLog(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 = {
+        'status_code': 'int',
+        'type': 'str',
+        'msg': 'str',
+        'metadata': '{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',
+    }
+
+    attribute_map = {
+        'status_code': 'statusCode',
+        'type': 'type',
+        'msg': 'msg',
+        'metadata': 'metadata',
+    }
+
+    def __init__(self, status_code=None, type=None, msg=None, metadata=None, local_vars_configuration=None):  # noqa: E501
+        """OperationLog - 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._status_code = None
+        self._type = None
+        self._msg = None
+        self._metadata = None
+        self.discriminator = None
+
+        if status_code is not None:
+            self.status_code = status_code
+        if type is not None:
+            self.type = type
+        if msg is not None:
+            self.msg = msg
+        if metadata is not None:
+            self.metadata = metadata
+
+    @property
+    def status_code(self):
+        """Gets the status_code of this OperationLog.  # noqa: E501
+
+        Status code.  # noqa: E501
+
+        :return: The status_code of this OperationLog.  # noqa: E501
+        :rtype: int
+        """
+        return self._status_code
+
+    @status_code.setter
+    def status_code(self, status_code):
+        """Sets the status_code of this OperationLog.
+
+        Status code.  # noqa: E501
+
+        :param status_code: The status_code of this OperationLog.  # noqa: E501
+        :type status_code: int
+        """
+
+        self._status_code = status_code
+
+    @property
+    def type(self):
+        """Gets the type of this OperationLog.  # noqa: E501
+
+        Error type.  # noqa: E501
+
+        :return: The type of this OperationLog.  # noqa: E501
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this OperationLog.
+
+        Error type.  # noqa: E501
+
+        :param type: The type of this OperationLog.  # noqa: E501
+        :type type: str
+        """
+
+        self._type = type
+
+    @property
+    def msg(self):
+        """Gets the msg of this OperationLog.  # noqa: E501
+
+        Error message.  # noqa: E501
+
+        :return: The msg of this OperationLog.  # noqa: E501
+        :rtype: str
+        """
+        return self._msg
+
+    @msg.setter
+    def msg(self, msg):
+        """Sets the msg of this OperationLog.
+
+        Error message.  # noqa: E501
+
+        :param msg: The msg of this OperationLog.  # noqa: E501
+        :type msg: str
+        """
+
+        self._msg = msg
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this OperationLog.  # noqa: E501
+
+        A free-form object containing group's extended attributes.  # noqa: E501
+
+        :return: The metadata of this OperationLog.  # 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 OperationLog.
+
+        A free-form object containing group's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this OperationLog.  # noqa: E501
+        :type metadata: {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
+        """
+
+        self._metadata = metadata
+
+    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, OperationLog):
+            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, OperationLog):
+            return True
+
+        return self.to_dict() != other.to_dict()