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

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

@@ -0,0 +1,290 @@
+# 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 Image(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',
+        'updated_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',
+        'updated_at': 'updatedAt',
+        'path': 'path',
+        'url': 'url',
+        'metadata': 'metadata',
+    }
+
+    def __init__(self, id=None, content_type=None, created_at=None, updated_at=None, path=None, url=None, metadata=None, local_vars_configuration=None):  # noqa: E501
+        """Image - 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._updated_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 updated_at is not None:
+            self.updated_at = updated_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 Image.  # noqa: E501
+
+        Response image ID. The list is sorted by decreasing ID value.  # noqa: E501
+
+        :return: The id of this Image.  # noqa: E501
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this Image.
+
+        Response image ID. The list is sorted by decreasing ID value.  # noqa: E501
+
+        :param id: The id of this Image.  # noqa: E501
+        :type id: str
+        """
+
+        self._id = id
+
+    @property
+    def content_type(self):
+        """Gets the content_type of this Image.  # noqa: E501
+
+        Original media type of the returned image.  # noqa: E501
+
+        :return: The content_type of this Image.  # noqa: E501
+        :rtype: str
+        """
+        return self._content_type
+
+    @content_type.setter
+    def content_type(self, content_type):
+        """Sets the content_type of this Image.
+
+        Original media type of the returned image.  # noqa: E501
+
+        :param content_type: The content_type of this Image.  # noqa: E501
+        :type content_type: str
+        """
+
+        self._content_type = content_type
+
+    @property
+    def created_at(self):
+        """Gets the created_at of this Image.  # noqa: E501
+
+        Returned image creation date.  # noqa: E501
+
+        :return: The created_at of this Image.  # noqa: E501
+        :rtype: str
+        """
+        return self._created_at
+
+    @created_at.setter
+    def created_at(self, created_at):
+        """Sets the created_at of this Image.
+
+        Returned image creation date.  # noqa: E501
+
+        :param created_at: The created_at of this Image.  # noqa: E501
+        :type created_at: str
+        """
+
+        self._created_at = created_at
+
+    @property
+    def updated_at(self):
+        """Gets the updated_at of this Image.  # noqa: E501
+
+        Returned image update date.  # noqa: E501
+
+        :return: The updated_at of this Image.  # noqa: E501
+        :rtype: str
+        """
+        return self._updated_at
+
+    @updated_at.setter
+    def updated_at(self, updated_at):
+        """Sets the updated_at of this Image.
+
+        Returned image update date.  # noqa: E501
+
+        :param updated_at: The updated_at of this Image.  # noqa: E501
+        :type updated_at: str
+        """
+
+        self._updated_at = updated_at
+
+    @property
+    def path(self):
+        """Gets the path of this Image.  # noqa: E501
+
+        Returned image path.  # noqa: E501
+
+        :return: The path of this Image.  # noqa: E501
+        :rtype: str
+        """
+        return self._path
+
+    @path.setter
+    def path(self, path):
+        """Sets the path of this Image.
+
+        Returned image path.  # noqa: E501
+
+        :param path: The path of this Image.  # noqa: E501
+        :type path: str
+        """
+
+        self._path = path
+
+    @property
+    def url(self):
+        """Gets the url of this Image.  # noqa: E501
+
+        Returned image URL.  # noqa: E501
+
+        :return: The url of this Image.  # noqa: E501
+        :rtype: str
+        """
+        return self._url
+
+    @url.setter
+    def url(self, url):
+        """Sets the url of this Image.
+
+        Returned image URL.  # noqa: E501
+
+        :param url: The url of this Image.  # noqa: E501
+        :type url: str
+        """
+
+        self._url = url
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this Image.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this Image.  # 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 Image.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this Image.  # 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, Image):
+            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, Image):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,258 @@
+# 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 ImageFields(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',
+        'output_image_params': 'OutputImageParams',
+        'detect_all': 'bool',
+        'threshold': 'float',
+        'limit': 'int',
+    }
+
+    attribute_map = {
+        'tag': 'tag',
+        'image': 'image',
+        'output_image_params': 'outputImageParams',
+        'detect_all': 'detectAll',
+        'threshold': 'threshold',
+        'limit': 'limit',
+    }
+
+    def __init__(self, tag=None, image=None, output_image_params=None, detect_all=False, threshold=None, limit=None, local_vars_configuration=None):  # noqa: E501
+        """ImageFields - 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._output_image_params = None
+        self._detect_all = None
+        self._threshold = None
+        self._limit = None
+        self.discriminator = None
+
+        if tag is not None:
+            self.tag = tag
+        if image is not None:
+            self.image = image
+        if output_image_params is not None:
+            self.output_image_params = output_image_params
+        if detect_all is not None:
+            self.detect_all = detect_all
+        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 ImageFields.  # noqa: E501
+
+        Session identificator, should be unique for each session.  # noqa: E501
+
+        :return: The tag of this ImageFields.  # noqa: E501
+        :rtype: str
+        """
+        return self._tag
+
+    @tag.setter
+    def tag(self, tag):
+        """Sets the tag of this ImageFields.
+
+        Session identificator, should be unique for each session.  # noqa: E501
+
+        :param tag: The tag of this ImageFields.  # noqa: E501
+        :type tag: str
+        """
+
+        self._tag = tag
+
+    @property
+    def image(self):
+        """Gets the image of this ImageFields.  # noqa: E501
+
+
+        :return: The image of this ImageFields.  # noqa: E501
+        :rtype: AddImageToPersonRequestImage
+        """
+        return self._image
+
+    @image.setter
+    def image(self, image):
+        """Sets the image of this ImageFields.
+
+
+        :param image: The image of this ImageFields.  # noqa: E501
+        :type image: AddImageToPersonRequestImage
+        """
+
+        self._image = image
+
+    @property
+    def output_image_params(self):
+        """Gets the output_image_params of this ImageFields.  # noqa: E501
+
+
+        :return: The output_image_params of this ImageFields.  # noqa: E501
+        :rtype: OutputImageParams
+        """
+        return self._output_image_params
+
+    @output_image_params.setter
+    def output_image_params(self, output_image_params):
+        """Sets the output_image_params of this ImageFields.
+
+
+        :param output_image_params: The output_image_params of this ImageFields.  # noqa: E501
+        :type output_image_params: OutputImageParams
+        """
+
+        self._output_image_params = output_image_params
+
+    @property
+    def detect_all(self):
+        """Gets the detect_all of this ImageFields.  # noqa: E501
+
+        Whether to detect all faces in the image. If set to `false`, only the most central face is detected.  # noqa: E501
+
+        :return: The detect_all of this ImageFields.  # noqa: E501
+        :rtype: bool
+        """
+        return self._detect_all
+
+    @detect_all.setter
+    def detect_all(self, detect_all):
+        """Sets the detect_all of this ImageFields.
+
+        Whether to detect all faces in the image. If set to `false`, only the most central face is detected.  # noqa: E501
+
+        :param detect_all: The detect_all of this ImageFields.  # noqa: E501
+        :type detect_all: bool
+        """
+
+        self._detect_all = detect_all
+
+    @property
+    def threshold(self):
+        """Gets the threshold of this ImageFields.  # noqa: E501
+
+        The similarity threshold.  # noqa: E501
+
+        :return: The threshold of this ImageFields.  # noqa: E501
+        :rtype: float
+        """
+        return self._threshold
+
+    @threshold.setter
+    def threshold(self, threshold):
+        """Sets the threshold of this ImageFields.
+
+        The similarity threshold.  # noqa: E501
+
+        :param threshold: The threshold of this ImageFields.  # noqa: E501
+        :type threshold: float
+        """
+
+        self._threshold = threshold
+
+    @property
+    def limit(self):
+        """Gets the limit of this ImageFields.  # noqa: E501
+
+        The maximum number of results to be returned.  # noqa: E501
+
+        :return: The limit of this ImageFields.  # noqa: E501
+        :rtype: int
+        """
+        return self._limit
+
+    @limit.setter
+    def limit(self, limit):
+        """Sets the limit of this ImageFields.
+
+        The maximum number of results to be returned.  # noqa: E501
+
+        :param limit: The limit of this ImageFields.  # 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, ImageFields):
+            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, ImageFields):
+            return True
+
+        return self.to_dict() != other.to_dict()