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

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

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    Regula FaceSDK Web API
+
+    Regula FaceSDK Web API # 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: 5.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 DetectRequestAttributes(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 = {
+        'config': 'QualityConfigList',
+    }
+
+    attribute_map = {
+        'config': 'config',
+    }
+
+    def __init__(self, config=None, local_vars_configuration=None):  # noqa: E501
+        """DetectRequestAttributes - 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._config = None
+        self.discriminator = None
+
+        if config is not None:
+            self.config = config
+
+    @property
+    def config(self):
+        """Gets the config of this DetectRequestAttributes.  # noqa: E501
+
+
+        :return: The config of this DetectRequestAttributes.  # noqa: E501
+        :rtype: QualityConfigList
+        """
+        return self._config
+
+    @config.setter
+    def config(self, config):
+        """Sets the config of this DetectRequestAttributes.
+
+
+        :param config: The config of this DetectRequestAttributes.  # noqa: E501
+        :type config: QualityConfigList
+        """
+
+        self._config = config
+
+    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, DetectRequestAttributes):
+            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, DetectRequestAttributes):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,147 @@
+# 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 DetectResponse(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',
+        'results': 'DetectResult',
+    }
+
+    attribute_map = {
+        'code': 'code',
+        'results': 'results',
+    }
+
+    def __init__(self, code=None, results=None, local_vars_configuration=None):  # noqa: E501
+        """DetectResponse - 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._results = None
+        self.discriminator = None
+
+        self.code = code
+        if results is not None:
+            self.results = results
+
+    @property
+    def code(self):
+        """Gets the code of this DetectResponse.  # noqa: E501
+
+
+        :return: The code of this DetectResponse.  # noqa: E501
+        :rtype: FaceSDKResultCode
+        """
+        return self._code
+
+    @code.setter
+    def code(self, code):
+        """Sets the code of this DetectResponse.
+
+
+        :param code: The code of this DetectResponse.  # 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 results(self):
+        """Gets the results of this DetectResponse.  # noqa: E501
+
+
+        :return: The results of this DetectResponse.  # noqa: E501
+        :rtype: DetectResult
+        """
+        return self._results
+
+    @results.setter
+    def results(self, results):
+        """Sets the results of this DetectResponse.
+
+
+        :param results: The results of this DetectResponse.  # noqa: E501
+        :type results: DetectResult
+        """
+
+        self._results = results
+
+    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, DetectResponse):
+            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, DetectResponse):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,120 @@
+# 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 DetectResponseAllOf(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': 'DetectResult',
+    }
+
+    attribute_map = {
+        'results': 'results',
+    }
+
+    def __init__(self, results=None, local_vars_configuration=None):  # noqa: E501
+        """DetectResponseAllOf - 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.discriminator = None
+
+        if results is not None:
+            self.results = results
+
+    @property
+    def results(self):
+        """Gets the results of this DetectResponseAllOf.  # noqa: E501
+
+
+        :return: The results of this DetectResponseAllOf.  # noqa: E501
+        :rtype: DetectResult
+        """
+        return self._results
+
+    @results.setter
+    def results(self, results):
+        """Sets the results of this DetectResponseAllOf.
+
+
+        :param results: The results of this DetectResponseAllOf.  # noqa: E501
+        :type results: DetectResult
+        """
+
+        self._results = results
+
+    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, DetectResponseAllOf):
+            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, DetectResponseAllOf):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,231 @@
+# 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 DetectResult(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': '[Detection]',
+        'detector_type': 'int',
+        'landmarks_type': 'int',
+        'scenario': 'FaceQualityScenarios',
+        'timer': 'float',
+    }
+
+    attribute_map = {
+        'detections': 'detections',
+        'detector_type': 'detectorType',
+        'landmarks_type': 'landmarksType',
+        'scenario': 'scenario',
+        'timer': 'timer',
+    }
+
+    def __init__(self, detections=None, detector_type=None, landmarks_type=None, scenario=None, timer=None, local_vars_configuration=None):  # noqa: E501
+        """DetectResult - 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._detector_type = None
+        self._landmarks_type = None
+        self._scenario = None
+        self._timer = None
+        self.discriminator = None
+
+        self.detections = detections
+        if detector_type is not None:
+            self.detector_type = detector_type
+        if landmarks_type is not None:
+            self.landmarks_type = landmarks_type
+        if scenario is not None:
+            self.scenario = scenario
+        if timer is not None:
+            self.timer = timer
+
+    @property
+    def detections(self):
+        """Gets the detections of this DetectResult.  # noqa: E501
+
+
+        :return: The detections of this DetectResult.  # noqa: E501
+        :rtype: [Detection]
+        """
+        return self._detections
+
+    @detections.setter
+    def detections(self, detections):
+        """Sets the detections of this DetectResult.
+
+
+        :param detections: The detections of this DetectResult.  # noqa: E501
+        :type detections: [Detection]
+        """
+        if self.local_vars_configuration.client_side_validation and detections is None:  # noqa: E501
+            raise ValueError("Invalid value for `detections`, must not be `None`")  # noqa: E501
+
+        self._detections = detections
+
+    @property
+    def detector_type(self):
+        """Gets the detector_type of this DetectResult.  # noqa: E501
+
+        Internal.  # noqa: E501
+
+        :return: The detector_type of this DetectResult.  # noqa: E501
+        :rtype: int
+        """
+        return self._detector_type
+
+    @detector_type.setter
+    def detector_type(self, detector_type):
+        """Sets the detector_type of this DetectResult.
+
+        Internal.  # noqa: E501
+
+        :param detector_type: The detector_type of this DetectResult.  # noqa: E501
+        :type detector_type: int
+        """
+
+        self._detector_type = detector_type
+
+    @property
+    def landmarks_type(self):
+        """Gets the landmarks_type of this DetectResult.  # noqa: E501
+
+        Internal.  # noqa: E501
+
+        :return: The landmarks_type of this DetectResult.  # noqa: E501
+        :rtype: int
+        """
+        return self._landmarks_type
+
+    @landmarks_type.setter
+    def landmarks_type(self, landmarks_type):
+        """Sets the landmarks_type of this DetectResult.
+
+        Internal.  # noqa: E501
+
+        :param landmarks_type: The landmarks_type of this DetectResult.  # noqa: E501
+        :type landmarks_type: int
+        """
+
+        self._landmarks_type = landmarks_type
+
+    @property
+    def scenario(self):
+        """Gets the scenario of this DetectResult.  # noqa: E501
+
+
+        :return: The scenario of this DetectResult.  # noqa: E501
+        :rtype: FaceQualityScenarios
+        """
+        return self._scenario
+
+    @scenario.setter
+    def scenario(self, scenario):
+        """Sets the scenario of this DetectResult.
+
+
+        :param scenario: The scenario of this DetectResult.  # noqa: E501
+        :type scenario: FaceQualityScenarios
+        """
+
+        self._scenario = scenario
+
+    @property
+    def timer(self):
+        """Gets the timer of this DetectResult.  # noqa: E501
+
+        The total time taken for the detection.  # noqa: E501
+
+        :return: The timer of this DetectResult.  # noqa: E501
+        :rtype: float
+        """
+        return self._timer
+
+    @timer.setter
+    def timer(self, timer):
+        """Sets the timer of this DetectResult.
+
+        The total time taken for the detection.  # noqa: E501
+
+        :param timer: The timer of this DetectResult.  # noqa: E501
+        :type timer: float
+        """
+
+        self._timer = timer
+
+    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, DetectResult):
+            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, DetectResult):
+            return True
+
+        return self.to_dict() != other.to_dict()