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

regula/facesdk/webclient/gen/model/add_image_to_person_request.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 AddImageToPersonRequest(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',
+        'image': 'AddImageToPersonRequestImage',
+        'threshold': 'float',
+        'limit': 'int',
+    }
+
+    attribute_map = {
+        'tag': 'tag',
+        'image': 'image',
+        'threshold': 'threshold',
+        'limit': 'limit',
+    }
+
+    def __init__(self, tag=None, image=None, threshold=None, limit=None, local_vars_configuration=None):  # noqa: E501
+        """AddImageToPersonRequest - 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._image = None
+        self._threshold = None
+        self._limit = None
+        self.discriminator = None
+
+        if tag is not None:
+            self.tag = tag
+        self.image = image
+        if threshold is not None:
+            self.threshold = threshold
+        if limit is not None:
+            self.limit = limit
+
+    @property
+    def tag(self):
+        """Gets the tag of this AddImageToPersonRequest.  # noqa: E501
+
+        Session identificator.  # noqa: E501
+
+        :return: The tag of this AddImageToPersonRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._tag
+
+    @tag.setter
+    def tag(self, tag):
+        """Sets the tag of this AddImageToPersonRequest.
+
+        Session identificator.  # noqa: E501
+
+        :param tag: The tag of this AddImageToPersonRequest.  # noqa: E501
+        :type tag: str
+        """
+
+        self._tag = tag
+
+    @property
+    def image(self):
+        """Gets the image of this AddImageToPersonRequest.  # noqa: E501
+
+
+        :return: The image of this AddImageToPersonRequest.  # noqa: E501
+        :rtype: AddImageToPersonRequestImage
+        """
+        return self._image
+
+    @image.setter
+    def image(self, image):
+        """Sets the image of this AddImageToPersonRequest.
+
+
+        :param image: The image of this AddImageToPersonRequest.  # noqa: E501
+        :type image: AddImageToPersonRequestImage
+        """
+        if self.local_vars_configuration.client_side_validation and image is None:  # noqa: E501
+            raise ValueError("Invalid value for `image`, must not be `None`")  # noqa: E501
+
+        self._image = image
+
+    @property
+    def threshold(self):
+        """Gets the threshold of this AddImageToPersonRequest.  # noqa: E501
+
+        The similarity threshold.  # noqa: E501
+
+        :return: The threshold of this AddImageToPersonRequest.  # noqa: E501
+        :rtype: float
+        """
+        return self._threshold
+
+    @threshold.setter
+    def threshold(self, threshold):
+        """Sets the threshold of this AddImageToPersonRequest.
+
+        The similarity threshold.  # noqa: E501
+
+        :param threshold: The threshold of this AddImageToPersonRequest.  # noqa: E501
+        :type threshold: float
+        """
+
+        self._threshold = threshold
+
+    @property
+    def limit(self):
+        """Gets the limit of this AddImageToPersonRequest.  # noqa: E501
+
+        The maximum number of results to be returned.  # noqa: E501
+
+        :return: The limit of this AddImageToPersonRequest.  # noqa: E501
+        :rtype: int
+        """
+        return self._limit
+
+    @limit.setter
+    def limit(self, limit):
+        """Sets the limit of this AddImageToPersonRequest.
+
+        The maximum number of results to be returned.  # noqa: E501
+
+        :param limit: The limit of this AddImageToPersonRequest.  # noqa: E501
+        :type limit: int
+        """
+
+        self._limit = limit
+
+    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, AddImageToPersonRequest):
+            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, AddImageToPersonRequest):
+            return True
+
+        return self.to_dict() != other.to_dict()

regula/facesdk/webclient/gen/model/add_image_to_person_request_image.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 AddImageToPersonRequestImage(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 = {
+        'content_type': 'str',
+        'content': 'str',
+        'image_url': 'str',
+        'resize_options': 'ResizeOptions',
+    }
+
+    attribute_map = {
+        'content_type': 'contentType',
+        'content': 'content',
+        'image_url': 'imageUrl',
+        'resize_options': 'resizeOptions',
+    }
+
+    def __init__(self, content_type=None, content=None, image_url=None, resize_options=None, local_vars_configuration=None):  # noqa: E501
+        """AddImageToPersonRequestImage - 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._content_type = None
+        self._content = None
+        self._image_url = None
+        self._resize_options = None
+        self.discriminator = None
+
+        if content_type is not None:
+            self.content_type = content_type
+        if content is not None:
+            self.content = content
+        if image_url is not None:
+            self.image_url = image_url
+        if resize_options is not None:
+            self.resize_options = resize_options
+
+    @property
+    def content_type(self):
+        """Gets the content_type of this AddImageToPersonRequestImage.  # noqa: E501
+
+        Original media type of the uploaded image.  # noqa: E501
+
+        :return: The content_type of this AddImageToPersonRequestImage.  # noqa: E501
+        :rtype: str
+        """
+        return self._content_type
+
+    @content_type.setter
+    def content_type(self, content_type):
+        """Sets the content_type of this AddImageToPersonRequestImage.
+
+        Original media type of the uploaded image.  # noqa: E501
+
+        :param content_type: The content_type of this AddImageToPersonRequestImage.  # noqa: E501
+        :type content_type: str
+        """
+
+        self._content_type = content_type
+
+    @property
+    def content(self):
+        """Gets the content of this AddImageToPersonRequestImage.  # noqa: E501
+
+        Base64-encoded image.  # noqa: E501
+
+        :return: The content of this AddImageToPersonRequestImage.  # noqa: E501
+        :rtype: str
+        """
+        return self._content
+
+    @content.setter
+    def content(self, content):
+        """Sets the content of this AddImageToPersonRequestImage.
+
+        Base64-encoded image.  # noqa: E501
+
+        :param content: The content of this AddImageToPersonRequestImage.  # noqa: E501
+        :type content: str
+        """
+
+        self._content = content
+
+    @property
+    def image_url(self):
+        """Gets the image_url of this AddImageToPersonRequestImage.  # noqa: E501
+
+        Image URL.  # noqa: E501
+
+        :return: The image_url of this AddImageToPersonRequestImage.  # noqa: E501
+        :rtype: str
+        """
+        return self._image_url
+
+    @image_url.setter
+    def image_url(self, image_url):
+        """Sets the image_url of this AddImageToPersonRequestImage.
+
+        Image URL.  # noqa: E501
+
+        :param image_url: The image_url of this AddImageToPersonRequestImage.  # noqa: E501
+        :type image_url: str
+        """
+
+        self._image_url = image_url
+
+    @property
+    def resize_options(self):
+        """Gets the resize_options of this AddImageToPersonRequestImage.  # noqa: E501
+
+
+        :return: The resize_options of this AddImageToPersonRequestImage.  # noqa: E501
+        :rtype: ResizeOptions
+        """
+        return self._resize_options
+
+    @resize_options.setter
+    def resize_options(self, resize_options):
+        """Sets the resize_options of this AddImageToPersonRequestImage.
+
+
+        :param resize_options: The resize_options of this AddImageToPersonRequestImage.  # noqa: E501
+        :type resize_options: ResizeOptions
+        """
+
+        self._resize_options = resize_options
+
+    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, AddImageToPersonRequestImage):
+            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, AddImageToPersonRequestImage):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,262 @@
+# 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 AddImageToPersonResponse(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 = {
+        'id': 'str',
+        'content_type': 'str',
+        'created_at': 'str',
+        'path': 'str',
+        'url': 'str',
+        'metadata': '{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',
+    }
+
+    attribute_map = {
+        'id': 'id',
+        'content_type': 'contentType',
+        'created_at': 'createdAt',
+        'path': 'path',
+        'url': 'url',
+        'metadata': 'metadata',
+    }
+
+    def __init__(self, id=None, content_type=None, created_at=None, path=None, url=None, metadata=None, local_vars_configuration=None):  # noqa: E501
+        """AddImageToPersonResponse - 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._id = None
+        self._content_type = None
+        self._created_at = None
+        self._path = None
+        self._url = None
+        self._metadata = None
+        self.discriminator = None
+
+        if id is not None:
+            self.id = id
+        if content_type is not None:
+            self.content_type = content_type
+        if created_at is not None:
+            self.created_at = created_at
+        if path is not None:
+            self.path = path
+        if url is not None:
+            self.url = url
+        if metadata is not None:
+            self.metadata = metadata
+
+    @property
+    def id(self):
+        """Gets the id of this AddImageToPersonResponse.  # noqa: E501
+
+        Response image ID. The list is sorted by decreasing ID value.  # noqa: E501
+
+        :return: The id of this AddImageToPersonResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this AddImageToPersonResponse.
+
+        Response image ID. The list is sorted by decreasing ID value.  # noqa: E501
+
+        :param id: The id of this AddImageToPersonResponse.  # noqa: E501
+        :type id: str
+        """
+
+        self._id = id
+
+    @property
+    def content_type(self):
+        """Gets the content_type of this AddImageToPersonResponse.  # noqa: E501
+
+        Original media type of the returned image.  # noqa: E501
+
+        :return: The content_type of this AddImageToPersonResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._content_type
+
+    @content_type.setter
+    def content_type(self, content_type):
+        """Sets the content_type of this AddImageToPersonResponse.
+
+        Original media type of the returned image.  # noqa: E501
+
+        :param content_type: The content_type of this AddImageToPersonResponse.  # noqa: E501
+        :type content_type: str
+        """
+
+        self._content_type = content_type
+
+    @property
+    def created_at(self):
+        """Gets the created_at of this AddImageToPersonResponse.  # noqa: E501
+
+        Returned image creation date.  # noqa: E501
+
+        :return: The created_at of this AddImageToPersonResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._created_at
+
+    @created_at.setter
+    def created_at(self, created_at):
+        """Sets the created_at of this AddImageToPersonResponse.
+
+        Returned image creation date.  # noqa: E501
+
+        :param created_at: The created_at of this AddImageToPersonResponse.  # noqa: E501
+        :type created_at: str
+        """
+
+        self._created_at = created_at
+
+    @property
+    def path(self):
+        """Gets the path of this AddImageToPersonResponse.  # noqa: E501
+
+        Returned image path.  # noqa: E501
+
+        :return: The path of this AddImageToPersonResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._path
+
+    @path.setter
+    def path(self, path):
+        """Sets the path of this AddImageToPersonResponse.
+
+        Returned image path.  # noqa: E501
+
+        :param path: The path of this AddImageToPersonResponse.  # noqa: E501
+        :type path: str
+        """
+
+        self._path = path
+
+    @property
+    def url(self):
+        """Gets the url of this AddImageToPersonResponse.  # noqa: E501
+
+        Returned image URL.  # noqa: E501
+
+        :return: The url of this AddImageToPersonResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._url
+
+    @url.setter
+    def url(self, url):
+        """Sets the url of this AddImageToPersonResponse.
+
+        Returned image URL.  # noqa: E501
+
+        :param url: The url of this AddImageToPersonResponse.  # noqa: E501
+        :type url: str
+        """
+
+        self._url = url
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this AddImageToPersonResponse.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this AddImageToPersonResponse.  # 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 AddImageToPersonResponse.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this AddImageToPersonResponse.  # 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, AddImageToPersonResponse):
+            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, AddImageToPersonResponse):
+            return True
+
+        return self.to_dict() != other.to_dict()