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

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

@@ -0,0 +1,146 @@
+# 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 OutputImageParams(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 = {
+        'background_color': 'RGB',
+        'crop': 'Crop',
+    }
+
+    attribute_map = {
+        'background_color': 'backgroundColor',
+        'crop': 'crop',
+    }
+
+    def __init__(self, background_color=None, crop=None, local_vars_configuration=None):  # noqa: E501
+        """OutputImageParams - 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._background_color = None
+        self._crop = None
+        self.discriminator = None
+
+        if background_color is not None:
+            self.background_color = background_color
+        if crop is not None:
+            self.crop = crop
+
+    @property
+    def background_color(self):
+        """Gets the background_color of this OutputImageParams.  # noqa: E501
+
+
+        :return: The background_color of this OutputImageParams.  # noqa: E501
+        :rtype: RGB
+        """
+        return self._background_color
+
+    @background_color.setter
+    def background_color(self, background_color):
+        """Sets the background_color of this OutputImageParams.
+
+
+        :param background_color: The background_color of this OutputImageParams.  # noqa: E501
+        :type background_color: RGB
+        """
+
+        self._background_color = background_color
+
+    @property
+    def crop(self):
+        """Gets the crop of this OutputImageParams.  # noqa: E501
+
+
+        :return: The crop of this OutputImageParams.  # noqa: E501
+        :rtype: Crop
+        """
+        return self._crop
+
+    @crop.setter
+    def crop(self, crop):
+        """Sets the crop of this OutputImageParams.
+
+
+        :param crop: The crop of this OutputImageParams.  # noqa: E501
+        :type crop: Crop
+        """
+
+        self._crop = crop
+
+    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, OutputImageParams):
+            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, OutputImageParams):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,150 @@
+# 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 Page(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 = {
+        'page': 'int',
+        'total_pages': 'int',
+    }
+
+    attribute_map = {
+        'page': 'page',
+        'total_pages': 'totalPages',
+    }
+
+    def __init__(self, page=None, total_pages=None, local_vars_configuration=None):  # noqa: E501
+        """Page - 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._page = None
+        self._total_pages = None
+        self.discriminator = None
+
+        if page is not None:
+            self.page = page
+        if total_pages is not None:
+            self.total_pages = total_pages
+
+    @property
+    def page(self):
+        """Gets the page of this Page.  # noqa: E501
+
+        Current page number.  # noqa: E501
+
+        :return: The page of this Page.  # noqa: E501
+        :rtype: int
+        """
+        return self._page
+
+    @page.setter
+    def page(self, page):
+        """Sets the page of this Page.
+
+        Current page number.  # noqa: E501
+
+        :param page: The page of this Page.  # noqa: E501
+        :type page: int
+        """
+
+        self._page = page
+
+    @property
+    def total_pages(self):
+        """Gets the total_pages of this Page.  # noqa: E501
+
+        Total number of pages.  # noqa: E501
+
+        :return: The total_pages of this Page.  # noqa: E501
+        :rtype: int
+        """
+        return self._total_pages
+
+    @total_pages.setter
+    def total_pages(self, total_pages):
+        """Sets the total_pages of this Page.
+
+        Total number of pages.  # noqa: E501
+
+        :param total_pages: The total_pages of this Page.  # noqa: E501
+        :type total_pages: int
+        """
+
+        self._total_pages = total_pages
+
+    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, Page):
+            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, Page):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,318 @@
+# 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 Person(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',
+        'id': 'str',
+        'created_at': 'str',
+        'updated_at': 'str',
+    }
+
+    attribute_map = {
+        'name': 'name',
+        'external_id': 'externalId',
+        'metadata': 'metadata',
+        'groups': 'groups',
+        'ttl': 'ttl',
+        'id': 'id',
+        'created_at': 'createdAt',
+        'updated_at': 'updatedAt',
+    }
+
+    def __init__(self, name=None, external_id=None, metadata=None, groups=None, ttl=None, id=None, created_at=None, updated_at=None, local_vars_configuration=None):  # noqa: E501
+        """Person - 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._id = None
+        self._created_at = None
+        self._updated_at = 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
+        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
+
+    @property
+    def name(self):
+        """Gets the name of this Person.  # noqa: E501
+
+        Person's name.  # noqa: E501
+
+        :return: The name of this Person.  # noqa: E501
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """Sets the name of this Person.
+
+        Person's name.  # noqa: E501
+
+        :param name: The name of this Person.  # 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 Person.  # 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 Person.  # noqa: E501
+        :rtype: str
+        """
+        return self._external_id
+
+    @external_id.setter
+    def external_id(self, external_id):
+        """Sets the external_id of this Person.
+
+        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 Person.  # noqa: E501
+        :type external_id: str
+        """
+
+        self._external_id = external_id
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this Person.  # noqa: E501
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :return: The metadata of this Person.  # 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 Person.
+
+        A free-form object containing person's extended attributes.  # noqa: E501
+
+        :param metadata: The metadata of this Person.  # 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 Person.  # noqa: E501
+
+        List of groups this person belongs to.  # noqa: E501
+
+        :return: The groups of this Person.  # noqa: E501
+        :rtype: [str]
+        """
+        return self._groups
+
+    @groups.setter
+    def groups(self, groups):
+        """Sets the groups of this Person.
+
+        List of groups this person belongs to.  # noqa: E501
+
+        :param groups: The groups of this Person.  # noqa: E501
+        :type groups: [str]
+        """
+
+        self._groups = groups
+
+    @property
+    def ttl(self):
+        """Gets the ttl of this Person.  # noqa: E501
+
+        The lifespan of the Person's records, seconds. Optional.  # noqa: E501
+
+        :return: The ttl of this Person.  # noqa: E501
+        :rtype: int, none_type
+        """
+        return self._ttl
+
+    @ttl.setter
+    def ttl(self, ttl):
+        """Sets the ttl of this Person.
+
+        The lifespan of the Person's records, seconds. Optional.  # noqa: E501
+
+        :param ttl: The ttl of this Person.  # noqa: E501
+        :type ttl: int, none_type
+        """
+
+        self._ttl = ttl
+
+    @property
+    def id(self):
+        """Gets the id of this Person.  # noqa: E501
+
+        Person ID. The list of persons is sorted by decreasing ID value.  # noqa: E501
+
+        :return: The id of this Person.  # noqa: E501
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this Person.
+
+        Person ID. The list of persons is sorted by decreasing ID value.  # noqa: E501
+
+        :param id: The id of this Person.  # noqa: E501
+        :type id: str
+        """
+
+        self._id = id
+
+    @property
+    def created_at(self):
+        """Gets the created_at of this Person.  # noqa: E501
+
+        Person creation date.  # noqa: E501
+
+        :return: The created_at of this Person.  # noqa: E501
+        :rtype: str
+        """
+        return self._created_at
+
+    @created_at.setter
+    def created_at(self, created_at):
+        """Sets the created_at of this Person.
+
+        Person creation date.  # noqa: E501
+
+        :param created_at: The created_at of this Person.  # noqa: E501
+        :type created_at: str
+        """
+
+        self._created_at = created_at
+
+    @property
+    def updated_at(self):
+        """Gets the updated_at of this Person.  # noqa: E501
+
+        Person update date.  # noqa: E501
+
+        :return: The updated_at of this Person.  # noqa: E501
+        :rtype: str
+        """
+        return self._updated_at
+
+    @updated_at.setter
+    def updated_at(self, updated_at):
+        """Sets the updated_at of this Person.
+
+        Person update date.  # noqa: E501
+
+        :param updated_at: The updated_at of this Person.  # noqa: E501
+        :type updated_at: str
+        """
+
+        self._updated_at = updated_at
+
+    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, Person):
+            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, Person):
+            return True
+
+        return self.to_dict() != other.to_dict()