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

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

@@ -0,0 +1,206 @@
+# 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 PersonAllOf(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',
+        'created_at': 'str',
+        'updated_at': 'str',
+        'groups': '[str]',
+    }
+
+    attribute_map = {
+        'id': 'id',
+        'created_at': 'createdAt',
+        'updated_at': 'updatedAt',
+        'groups': 'groups',
+    }
+
+    def __init__(self, id=None, created_at=None, updated_at=None, groups=None, local_vars_configuration=None):  # noqa: E501
+        """PersonAllOf - 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._created_at = None
+        self._updated_at = None
+        self._groups = None
+        self.discriminator = None
+
+        if id is not None:
+            self.id = id
+        if created_at is not None:
+            self.created_at = created_at
+        if updated_at is not None:
+            self.updated_at = updated_at
+        if groups is not None:
+            self.groups = groups
+
+    @property
+    def id(self):
+        """Gets the id of this PersonAllOf.  # noqa: E501
+
+        Person ID. The list of persons is sorted by decreasing ID value.  # noqa: E501
+
+        :return: The id of this PersonAllOf.  # noqa: E501
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this PersonAllOf.
+
+        Person ID. The list of persons is sorted by decreasing ID value.  # noqa: E501
+
+        :param id: The id of this PersonAllOf.  # noqa: E501
+        :type id: str
+        """
+
+        self._id = id
+
+    @property
+    def created_at(self):
+        """Gets the created_at of this PersonAllOf.  # noqa: E501
+
+        Person creation date.  # noqa: E501
+
+        :return: The created_at of this PersonAllOf.  # noqa: E501
+        :rtype: str
+        """
+        return self._created_at
+
+    @created_at.setter
+    def created_at(self, created_at):
+        """Sets the created_at of this PersonAllOf.
+
+        Person creation date.  # noqa: E501
+
+        :param created_at: The created_at of this PersonAllOf.  # noqa: E501
+        :type created_at: str
+        """
+
+        self._created_at = created_at
+
+    @property
+    def updated_at(self):
+        """Gets the updated_at of this PersonAllOf.  # noqa: E501
+
+        Person update date.  # noqa: E501
+
+        :return: The updated_at of this PersonAllOf.  # noqa: E501
+        :rtype: str
+        """
+        return self._updated_at
+
+    @updated_at.setter
+    def updated_at(self, updated_at):
+        """Sets the updated_at of this PersonAllOf.
+
+        Person update date.  # noqa: E501
+
+        :param updated_at: The updated_at of this PersonAllOf.  # noqa: E501
+        :type updated_at: str
+        """
+
+        self._updated_at = updated_at
+
+    @property
+    def groups(self):
+        """Gets the groups of this PersonAllOf.  # noqa: E501
+
+        List of groups this person belongs to.  # noqa: E501
+
+        :return: The groups of this PersonAllOf.  # noqa: E501
+        :rtype: [str]
+        """
+        return self._groups
+
+    @groups.setter
+    def groups(self, groups):
+        """Sets the groups of this PersonAllOf.
+
+        List of groups this person belongs to.  # noqa: E501
+
+        :param groups: The groups of this PersonAllOf.  # noqa: E501
+        :type groups: [str]
+        """
+
+        self._groups = groups
+
+    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, PersonAllOf):
+            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, PersonAllOf):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,178 @@
+# coding: utf-8
+
+"""
+    Regula FaceSDK Web API
+
+    [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### 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.1.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from regula.facesdk.webclient.gen.configuration import Configuration
+
+
+class PersonCreatedResponse(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': 'int',
+        'persons': '[SearchPerson]',
+        'metadata': '{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',
+    }
+
+    attribute_map = {
+        'code': 'code',
+        'persons': 'persons',
+        'metadata': 'metadata',
+    }
+
+    def __init__(self, code=None, persons=None, metadata=None, local_vars_configuration=None):  # noqa: E501
+        """PersonCreatedResponse - 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._persons = None
+        self._metadata = None
+        self.discriminator = None
+
+        if code is not None:
+            self.code = code
+        if persons is not None:
+            self.persons = persons
+        if metadata is not None:
+            self.metadata = metadata
+
+    @property
+    def code(self):
+        """Gets the code of this PersonCreatedResponse.  # noqa: E501
+
+        Result code.  # noqa: E501
+
+        :return: The code of this PersonCreatedResponse.  # noqa: E501
+        :rtype: int
+        """
+        return self._code
+
+    @code.setter
+    def code(self, code):
+        """Sets the code of this PersonCreatedResponse.
+
+        Result code.  # noqa: E501
+
+        :param code: The code of this PersonCreatedResponse.  # noqa: E501
+        :type code: int
+        """
+
+        self._code = code
+
+    @property
+    def persons(self):
+        """Gets the persons of this PersonCreatedResponse.  # noqa: E501
+
+        Array of Person images.  # noqa: E501
+
+        :return: The persons of this PersonCreatedResponse.  # noqa: E501
+        :rtype: [SearchPerson]
+        """
+        return self._persons
+
+    @persons.setter
+    def persons(self, persons):
+        """Sets the persons of this PersonCreatedResponse.
+
+        Array of Person images.  # noqa: E501
+
+        :param persons: The persons of this PersonCreatedResponse.  # noqa: E501
+        :type persons: [SearchPerson]
+        """
+
+        self._persons = persons
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this PersonCreatedResponse.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this PersonCreatedResponse.  # 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 PersonCreatedResponse.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this PersonCreatedResponse.  # 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, PersonCreatedResponse):
+            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, PersonCreatedResponse):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,234 @@
+# 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 PersonFields(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': 'str',
+        'external_id': 'str',
+        'metadata': '{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',
+        'groups': '[str]',
+        'ttl': 'int, none_type',
+    }
+
+    attribute_map = {
+        'name': 'name',
+        'external_id': 'externalId',
+        'metadata': 'metadata',
+        'groups': 'groups',
+        'ttl': 'ttl',
+    }
+
+    def __init__(self, name=None, external_id=None, metadata=None, groups=None, ttl=None, local_vars_configuration=None):  # noqa: E501
+        """PersonFields - 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._external_id = None
+        self._metadata = None
+        self._groups = None
+        self._ttl = None
+        self.discriminator = None
+
+        self.name = name
+        if external_id is not None:
+            self.external_id = external_id
+        if metadata is not None:
+            self.metadata = metadata
+        if groups is not None:
+            self.groups = groups
+        self.ttl = ttl
+
+    @property
+    def name(self):
+        """Gets the name of this PersonFields.  # noqa: E501
+
+        Person's name.  # noqa: E501
+
+        :return: The name of this PersonFields.  # noqa: E501
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """Sets the name of this PersonFields.
+
+        Person's name.  # noqa: E501
+
+        :param name: The name of this PersonFields.  # noqa: E501
+        :type name: str
+        """
+        if self.local_vars_configuration.client_side_validation and name is None:  # noqa: E501
+            raise ValueError("Invalid value for `name`, must not be `None`")  # noqa: E501
+
+        self._name = name
+
+    @property
+    def external_id(self):
+        """Gets the external_id of this PersonFields.  # noqa: E501
+
+        Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.  # noqa: E501
+
+        :return: The external_id of this PersonFields.  # noqa: E501
+        :rtype: str
+        """
+        return self._external_id
+
+    @external_id.setter
+    def external_id(self, external_id):
+        """Sets the external_id of this PersonFields.
+
+        Person's ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.  # noqa: E501
+
+        :param external_id: The external_id of this PersonFields.  # noqa: E501
+        :type external_id: str
+        """
+
+        self._external_id = external_id
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this PersonFields.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this PersonFields.  # 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 PersonFields.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this PersonFields.  # noqa: E501
+        :type metadata: {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
+        """
+
+        self._metadata = metadata
+
+    @property
+    def groups(self):
+        """Gets the groups of this PersonFields.  # noqa: E501
+
+        Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.  # noqa: E501
+
+        :return: The groups of this PersonFields.  # noqa: E501
+        :rtype: [str]
+        """
+        return self._groups
+
+    @groups.setter
+    def groups(self, groups):
+        """Sets the groups of this PersonFields.
+
+        Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.  # noqa: E501
+
+        :param groups: The groups of this PersonFields.  # noqa: E501
+        :type groups: [str]
+        """
+
+        self._groups = groups
+
+    @property
+    def ttl(self):
+        """Gets the ttl of this PersonFields.  # noqa: E501
+
+        The lifespan of the Person's records, seconds. Optional.  # noqa: E501
+
+        :return: The ttl of this PersonFields.  # noqa: E501
+        :rtype: int, none_type
+        """
+        return self._ttl
+
+    @ttl.setter
+    def ttl(self, ttl):
+        """Sets the ttl of this PersonFields.
+
+        The lifespan of the Person's records, seconds. Optional.  # noqa: E501
+
+        :param ttl: The ttl of this PersonFields.  # noqa: E501
+        :type ttl: int, none_type
+        """
+
+        self._ttl = ttl
+
+    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, PersonFields):
+            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, PersonFields):
+            return True
+
+        return self.to_dict() != other.to_dict()