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

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

@@ -0,0 +1,178 @@
+# coding: utf-8
+
+"""
+    Regula Face SDK Web API
+
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+
+    The version of the OpenAPI document: 6.2.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from regula.facesdk.webclient.gen.configuration import Configuration
+
+
+class MatchAndSearchRequestAllOf(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',
+        'images': '[MatchAndSearchRequestAllOfImages]',
+        'group_ids': '[str]',
+    }
+
+    attribute_map = {
+        'tag': 'tag',
+        'images': 'images',
+        'group_ids': 'groupIds',
+    }
+
+    def __init__(self, tag=None, images=None, group_ids=None, local_vars_configuration=None):  # noqa: E501
+        """MatchAndSearchRequestAllOf - 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._images = None
+        self._group_ids = None
+        self.discriminator = None
+
+        if tag is not None:
+            self.tag = tag
+        if images is not None:
+            self.images = images
+        if group_ids is not None:
+            self.group_ids = group_ids
+
+    @property
+    def tag(self):
+        """Gets the tag of this MatchAndSearchRequestAllOf.  # noqa: E501
+
+        Session identificator, should be unique for each session.  # noqa: E501
+
+        :return: The tag of this MatchAndSearchRequestAllOf.  # noqa: E501
+        :rtype: str
+        """
+        return self._tag
+
+    @tag.setter
+    def tag(self, tag):
+        """Sets the tag of this MatchAndSearchRequestAllOf.
+
+        Session identificator, should be unique for each session.  # noqa: E501
+
+        :param tag: The tag of this MatchAndSearchRequestAllOf.  # noqa: E501
+        :type tag: str
+        """
+
+        self._tag = tag
+
+    @property
+    def images(self):
+        """Gets the images of this MatchAndSearchRequestAllOf.  # noqa: E501
+
+        Person's images.  # noqa: E501
+
+        :return: The images of this MatchAndSearchRequestAllOf.  # noqa: E501
+        :rtype: [MatchAndSearchRequestAllOfImages]
+        """
+        return self._images
+
+    @images.setter
+    def images(self, images):
+        """Sets the images of this MatchAndSearchRequestAllOf.
+
+        Person's images.  # noqa: E501
+
+        :param images: The images of this MatchAndSearchRequestAllOf.  # noqa: E501
+        :type images: [MatchAndSearchRequestAllOfImages]
+        """
+
+        self._images = images
+
+    @property
+    def group_ids(self):
+        """Gets the group_ids of this MatchAndSearchRequestAllOf.  # noqa: E501
+
+        IDs of the groups in which the search is performed.  # noqa: E501
+
+        :return: The group_ids of this MatchAndSearchRequestAllOf.  # noqa: E501
+        :rtype: [str]
+        """
+        return self._group_ids
+
+    @group_ids.setter
+    def group_ids(self, group_ids):
+        """Sets the group_ids of this MatchAndSearchRequestAllOf.
+
+        IDs of the groups in which the search is performed.  # noqa: E501
+
+        :param group_ids: The group_ids of this MatchAndSearchRequestAllOf.  # noqa: E501
+        :type group_ids: [str]
+        """
+
+        self._group_ids = group_ids
+
+    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, MatchAndSearchRequestAllOf):
+            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, MatchAndSearchRequestAllOf):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,148 @@
+# 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 MatchAndSearchRequestAllOfImages(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': 'str',
+        'type': 'ImageSource',
+    }
+
+    attribute_map = {
+        'content': 'content',
+        'type': 'type',
+    }
+
+    def __init__(self, content=None, type=None, local_vars_configuration=None):  # noqa: E501
+        """MatchAndSearchRequestAllOfImages - 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 = None
+        self._type = None
+        self.discriminator = None
+
+        if content is not None:
+            self.content = content
+        if type is not None:
+            self.type = type
+
+    @property
+    def content(self):
+        """Gets the content of this MatchAndSearchRequestAllOfImages.  # noqa: E501
+
+        Base64-encoded image.  # noqa: E501
+
+        :return: The content of this MatchAndSearchRequestAllOfImages.  # noqa: E501
+        :rtype: str
+        """
+        return self._content
+
+    @content.setter
+    def content(self, content):
+        """Sets the content of this MatchAndSearchRequestAllOfImages.
+
+        Base64-encoded image.  # noqa: E501
+
+        :param content: The content of this MatchAndSearchRequestAllOfImages.  # noqa: E501
+        :type content: str
+        """
+
+        self._content = content
+
+    @property
+    def type(self):
+        """Gets the type of this MatchAndSearchRequestAllOfImages.  # noqa: E501
+
+
+        :return: The type of this MatchAndSearchRequestAllOfImages.  # noqa: E501
+        :rtype: ImageSource
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this MatchAndSearchRequestAllOfImages.
+
+
+        :param type: The type of this MatchAndSearchRequestAllOfImages.  # noqa: E501
+        :type type: ImageSource
+        """
+
+        self._type = type
+
+    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, MatchAndSearchRequestAllOfImages):
+            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, MatchAndSearchRequestAllOfImages):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,233 @@
+# 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 MatchAndSearchResponse(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': '[MatchImageResult]',
+        'elapsed_time': 'float',
+        'metadata': '{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',
+        'detections': '[MatchAndSearchResponseAllOfDetections]',
+    }
+
+    attribute_map = {
+        'code': 'code',
+        'results': 'results',
+        'elapsed_time': 'elapsedTime',
+        'metadata': 'metadata',
+        'detections': 'detections',
+    }
+
+    def __init__(self, code=None, results=None, elapsed_time=None, metadata=None, detections=None, local_vars_configuration=None):  # noqa: E501
+        """MatchAndSearchResponse - 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._elapsed_time = None
+        self._metadata = None
+        self._detections = None
+        self.discriminator = None
+
+        self.code = code
+        if results is not None:
+            self.results = results
+        if elapsed_time is not None:
+            self.elapsed_time = elapsed_time
+        if metadata is not None:
+            self.metadata = metadata
+        if detections is not None:
+            self.detections = detections
+
+    @property
+    def code(self):
+        """Gets the code of this MatchAndSearchResponse.  # noqa: E501
+
+
+        :return: The code of this MatchAndSearchResponse.  # noqa: E501
+        :rtype: FaceSDKResultCode
+        """
+        return self._code
+
+    @code.setter
+    def code(self, code):
+        """Sets the code of this MatchAndSearchResponse.
+
+
+        :param code: The code of this MatchAndSearchResponse.  # 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 MatchAndSearchResponse.  # noqa: E501
+
+        The match and search results.  # noqa: E501
+
+        :return: The results of this MatchAndSearchResponse.  # noqa: E501
+        :rtype: [MatchImageResult]
+        """
+        return self._results
+
+    @results.setter
+    def results(self, results):
+        """Sets the results of this MatchAndSearchResponse.
+
+        The match and search results.  # noqa: E501
+
+        :param results: The results of this MatchAndSearchResponse.  # noqa: E501
+        :type results: [MatchImageResult]
+        """
+
+        self._results = results
+
+    @property
+    def elapsed_time(self):
+        """Gets the elapsed_time of this MatchAndSearchResponse.  # noqa: E501
+
+        Time the processing has taken, ms.  # noqa: E501
+
+        :return: The elapsed_time of this MatchAndSearchResponse.  # noqa: E501
+        :rtype: float
+        """
+        return self._elapsed_time
+
+    @elapsed_time.setter
+    def elapsed_time(self, elapsed_time):
+        """Sets the elapsed_time of this MatchAndSearchResponse.
+
+        Time the processing has taken, ms.  # noqa: E501
+
+        :param elapsed_time: The elapsed_time of this MatchAndSearchResponse.  # noqa: E501
+        :type elapsed_time: float
+        """
+
+        self._elapsed_time = elapsed_time
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this MatchAndSearchResponse.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this MatchAndSearchResponse.  # 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 MatchAndSearchResponse.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this MatchAndSearchResponse.  # noqa: E501
+        :type metadata: {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
+        """
+
+        self._metadata = metadata
+
+    @property
+    def detections(self):
+        """Gets the detections of this MatchAndSearchResponse.  # noqa: E501
+
+        The detection results.  # noqa: E501
+
+        :return: The detections of this MatchAndSearchResponse.  # noqa: E501
+        :rtype: [MatchAndSearchResponseAllOfDetections]
+        """
+        return self._detections
+
+    @detections.setter
+    def detections(self, detections):
+        """Sets the detections of this MatchAndSearchResponse.
+
+        The detection results.  # noqa: E501
+
+        :param detections: The detections of this MatchAndSearchResponse.  # noqa: E501
+        :type detections: [MatchAndSearchResponseAllOfDetections]
+        """
+
+        self._detections = detections
+
+    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, MatchAndSearchResponse):
+            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, MatchAndSearchResponse):
+            return True
+
+        return self.to_dict() != other.to_dict()