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

regula/facesdk/webclient/gen/model/attribute_config.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 AttributeConfig(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 = {
+        'name': 'FaceAttribute',
+    }
+
+    attribute_map = {
+        'name': 'name',
+    }
+
+    def __init__(self, name=None, local_vars_configuration=None):  # noqa: E501
+        """AttributeConfig - 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._name = None
+        self.discriminator = None
+
+        if name is not None:
+            self.name = name
+
+    @property
+    def name(self):
+        """Gets the name of this AttributeConfig.  # noqa: E501
+
+
+        :return: The name of this AttributeConfig.  # noqa: E501
+        :rtype: FaceAttribute
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """Sets the name of this AttributeConfig.
+
+
+        :param name: The name of this AttributeConfig.  # noqa: E501
+        :type name: FaceAttribute
+        """
+
+        self._name = name
+
+    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, AttributeConfig):
+            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, AttributeConfig):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,92 @@
+# 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 AttributeConfigList(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 = {
+    }
+
+    attribute_map = {
+    }
+
+    def __init__(self, local_vars_configuration=None):  # noqa: E501
+        """AttributeConfigList - 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.discriminator = None
+
+    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, AttributeConfigList):
+            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, AttributeConfigList):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,208 @@
+# 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 Crop(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 = {
+        'type': 'FaceImageQualityAlignType',
+        'pad_color': 'RGB',
+        'size': '[int]',
+        'return_original_rect': 'bool',
+    }
+
+    attribute_map = {
+        'type': 'type',
+        'pad_color': 'padColor',
+        'size': 'size',
+        'return_original_rect': 'returnOriginalRect',
+    }
+
+    def __init__(self, type=None, pad_color=None, size=None, return_original_rect=None, local_vars_configuration=None):  # noqa: E501
+        """Crop - 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._type = None
+        self._pad_color = None
+        self._size = None
+        self._return_original_rect = None
+        self.discriminator = None
+
+        if type is not None:
+            self.type = type
+        if pad_color is not None:
+            self.pad_color = pad_color
+        if size is not None:
+            self.size = size
+        if return_original_rect is not None:
+            self.return_original_rect = return_original_rect
+
+    @property
+    def type(self):
+        """Gets the type of this Crop.  # noqa: E501
+
+
+        :return: The type of this Crop.  # noqa: E501
+        :rtype: FaceImageQualityAlignType
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this Crop.
+
+
+        :param type: The type of this Crop.  # noqa: E501
+        :type type: FaceImageQualityAlignType
+        """
+
+        self._type = type
+
+    @property
+    def pad_color(self):
+        """Gets the pad_color of this Crop.  # noqa: E501
+
+
+        :return: The pad_color of this Crop.  # noqa: E501
+        :rtype: RGB
+        """
+        return self._pad_color
+
+    @pad_color.setter
+    def pad_color(self, pad_color):
+        """Sets the pad_color of this Crop.
+
+
+        :param pad_color: The pad_color of this Crop.  # noqa: E501
+        :type pad_color: RGB
+        """
+
+        self._pad_color = pad_color
+
+    @property
+    def size(self):
+        """Gets the size of this Crop.  # noqa: E501
+
+        The resize value in case `type` matches this value. If it doesn't, no resize is performed.  # noqa: E501
+
+        :return: The size of this Crop.  # noqa: E501
+        :rtype: [int]
+        """
+        return self._size
+
+    @size.setter
+    def size(self, size):
+        """Sets the size of this Crop.
+
+        The resize value in case `type` matches this value. If it doesn't, no resize is performed.  # noqa: E501
+
+        :param size: The size of this Crop.  # noqa: E501
+        :type size: [int]
+        """
+        if (self.local_vars_configuration.client_side_validation and
+                size is not None and len(size) > 2):
+            raise ValueError("Invalid value for `size`, number of items must be less than or equal to `2`")  # noqa: E501
+        if (self.local_vars_configuration.client_side_validation and
+                size is not None and len(size) < 2):
+            raise ValueError("Invalid value for `size`, number of items must be greater than or equal to `2`")  # noqa: E501
+
+        self._size = size
+
+    @property
+    def return_original_rect(self):
+        """Gets the return_original_rect of this Crop.  # noqa: E501
+
+        Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.  # noqa: E501
+
+        :return: The return_original_rect of this Crop.  # noqa: E501
+        :rtype: bool
+        """
+        return self._return_original_rect
+
+    @return_original_rect.setter
+    def return_original_rect(self, return_original_rect):
+        """Sets the return_original_rect of this Crop.
+
+        Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.  # noqa: E501
+
+        :param return_original_rect: The return_original_rect of this Crop.  # noqa: E501
+        :type return_original_rect: bool
+        """
+
+        self._return_original_rect = return_original_rect
+
+    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, Crop):
+            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, Crop):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,204 @@
+# 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 DetectRequest(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 = {
+        'tag': 'str',
+        'process_param': 'ProcessParam',
+        'image': 'str',
+        'thumbnails': 'bool',
+    }
+
+    attribute_map = {
+        'tag': 'tag',
+        'process_param': 'processParam',
+        'image': 'image',
+        'thumbnails': 'thumbnails',
+    }
+
+    def __init__(self, tag=None, process_param=None, image=None, thumbnails=False, local_vars_configuration=None):  # noqa: E501
+        """DetectRequest - 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._tag = None
+        self._process_param = None
+        self._image = None
+        self._thumbnails = None
+        self.discriminator = None
+
+        if tag is not None:
+            self.tag = tag
+        if process_param is not None:
+            self.process_param = process_param
+        if image is not None:
+            self.image = image
+        if thumbnails is not None:
+            self.thumbnails = thumbnails
+
+    @property
+    def tag(self):
+        """Gets the tag of this DetectRequest.  # noqa: E501
+
+        Session identificator, should be unique for each session.  # noqa: E501
+
+        :return: The tag of this DetectRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._tag
+
+    @tag.setter
+    def tag(self, tag):
+        """Sets the tag of this DetectRequest.
+
+        Session identificator, should be unique for each session.  # noqa: E501
+
+        :param tag: The tag of this DetectRequest.  # noqa: E501
+        :type tag: str
+        """
+
+        self._tag = tag
+
+    @property
+    def process_param(self):
+        """Gets the process_param of this DetectRequest.  # noqa: E501
+
+
+        :return: The process_param of this DetectRequest.  # noqa: E501
+        :rtype: ProcessParam
+        """
+        return self._process_param
+
+    @process_param.setter
+    def process_param(self, process_param):
+        """Sets the process_param of this DetectRequest.
+
+
+        :param process_param: The process_param of this DetectRequest.  # noqa: E501
+        :type process_param: ProcessParam
+        """
+
+        self._process_param = process_param
+
+    @property
+    def image(self):
+        """Gets the image of this DetectRequest.  # noqa: E501
+
+        Base64-encoded image.  # noqa: E501
+
+        :return: The image of this DetectRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._image
+
+    @image.setter
+    def image(self, image):
+        """Sets the image of this DetectRequest.
+
+        Base64-encoded image.  # noqa: E501
+
+        :param image: The image of this DetectRequest.  # noqa: E501
+        :type image: str
+        """
+
+        self._image = image
+
+    @property
+    def thumbnails(self):
+        """Gets the thumbnails of this DetectRequest.  # noqa: E501
+
+        Use `processParam.outputImageParams.crop` instead.  # noqa: E501
+
+        :return: The thumbnails of this DetectRequest.  # noqa: E501
+        :rtype: bool
+        """
+        return self._thumbnails
+
+    @thumbnails.setter
+    def thumbnails(self, thumbnails):
+        """Sets the thumbnails of this DetectRequest.
+
+        Use `processParam.outputImageParams.crop` instead.  # noqa: E501
+
+        :param thumbnails: The thumbnails of this DetectRequest.  # noqa: E501
+        :type thumbnails: bool
+        """
+
+        self._thumbnails = thumbnails
+
+    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, DetectRequest):
+            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, DetectRequest):
+            return True
+
+        return self.to_dict() != other.to_dict()