regula-facesdk-webclient 6.4.198.dev0__tar.gz

regula_facesdk_webclient-6.4.198.dev0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.1
+Name: regula_facesdk_webclient
+Version: 6.4.198.dev0
+Summary: Regula's FaceSDK web python client
+Home-page: https://regulaforensics.com
+Author: Regula Forensics, Inc.
+Author-email: support@regulaforensics.com
+Keywords: face recognition,facesdk,regulaforensics,regula
+Requires-Python: >=3.5
+Description-Content-Type: text/markdown
+Requires-Dist: certifi>=2024.07.04
+Requires-Dist: six>=1.10
+Requires-Dist: python-dateutil>=2.5.3
+Requires-Dist: urllib3>=2.2.2
+Requires-Dist: vistir<=0.6.1,>=0.4.0
+Requires-Dist: idna==3.7
+Requires-Dist: requests>=2.32.3
+
+# Regula Face SDK web API Python 3.5+ client
+
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/FaceSDK-web-openapi)
+[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
+[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://faceapi.regulaforensics.com/)
+
+## ⚠️ Warning: Package Name Changed
+## Package name has been changed from `regula.facesdk.webclient` to `regula_facesdk_webclient`
+
+Face recognition as easy as reading two bytes.
+
+If you have any problems with or questions about this client, please contact us
+through a [GitHub issue](https://github.com/regulaforensics/FaceSDK-web-python-client/issues).
+You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/FaceSDK-web-python-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; 
+We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+See [dev guide](./dev.md)
+
+## Install package
+`regula_facesdk_webclient` is on the Python Package Index (PyPI):
+
+```bash
+pip install regula_facesdk_webclient
+```
+
+Or using `pipenv`
+```bash
+pipenv install regula_facesdk_webclient
+```
+
+## Example
+Performing request:
+
+```python
+from regula_facesdk_webclient import *
+
+with open("face1.jpg", "rb") as f:
+    face_1_bytes = f.read()
+
+with open("face2.jpg", "rb") as f:
+    face_2_bytes = f.read()
+
+with MatchingApi(host="http://0.0.0.0:41101/api") as api:
+    images = [
+        MatchImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
+        MatchImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
+        MatchImage(index=3, data=face_2_bytes)
+    ]
+    match_request = MatchRequest(images=images)
+    match_response = api.match(match_request)
+
+    detect_request = DetectRequest(face_1_bytes)
+    detect_response = api.detect(detect_request)
+```
+
+You can find more detailed guide and run this sample in [example](./example) folder.

regula_facesdk_webclient-6.4.198.dev0/README.md

@@ -0,0 +1,55 @@
+# Regula Face SDK web API Python 3.5+ client
+
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/FaceSDK-web-openapi)
+[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
+[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://faceapi.regulaforensics.com/)
+
+## ⚠️ Warning: Package Name Changed
+## Package name has been changed from `regula.facesdk.webclient` to `regula_facesdk_webclient`
+
+Face recognition as easy as reading two bytes.
+
+If you have any problems with or questions about this client, please contact us
+through a [GitHub issue](https://github.com/regulaforensics/FaceSDK-web-python-client/issues).
+You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/FaceSDK-web-python-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; 
+We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+See [dev guide](./dev.md)
+
+## Install package
+`regula_facesdk_webclient` is on the Python Package Index (PyPI):
+
+```bash
+pip install regula_facesdk_webclient
+```
+
+Or using `pipenv`
+```bash
+pipenv install regula_facesdk_webclient
+```
+
+## Example
+Performing request:
+
+```python
+from regula_facesdk_webclient import *
+
+with open("face1.jpg", "rb") as f:
+    face_1_bytes = f.read()
+
+with open("face2.jpg", "rb") as f:
+    face_2_bytes = f.read()
+
+with MatchingApi(host="http://0.0.0.0:41101/api") as api:
+    images = [
+        MatchImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
+        MatchImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
+        MatchImage(index=3, data=face_2_bytes)
+    ]
+    match_request = MatchRequest(images=images)
+    match_response = api.match(match_request)
+
+    detect_request = DetectRequest(face_1_bytes)
+    detect_response = api.detect(detect_request)
+```
+
+You can find more detailed guide and run this sample in [example](./example) folder.

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/__init__.py

@@ -0,0 +1,15 @@
+# compatibility import
+from regula.facesdk.webclient.ext import MatchImage, MatchRequest
+from regula.facesdk.webclient.gen.model.face_sdk_result import FaceSDKResult
+from regula.facesdk.webclient.gen.model.face_sdk_result_code import FaceSDKResultCode
+from regula.facesdk.webclient.gen.model.match_image_detection import MatchImageDetection
+from regula.facesdk.webclient.gen.model.match_image_result import MatchImageResult
+from regula.facesdk.webclient.gen.model.match_response import MatchResponse
+
+FaceRecognitionResult = FaceSDKResult
+FaceRecognitionResultCode = FaceSDKResultCode
+CompareImage = MatchImage
+CompareImageDetection = MatchImageDetection
+CompareImageResult = MatchImageResult
+CompareRequest = MatchRequest
+CompareResponse = MatchResponse

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/__init__.py

@@ -0,0 +1,5 @@
+from regula.facesdk.webclient.ext.api import MatchApi, FaceSdk
+from regula.facesdk.webclient.ext.common import Base64String
+from regula.facesdk.webclient.ext.models import MatchRequest
+from regula.facesdk.webclient.ext.models import MatchImage
+from regula.facesdk.webclient.ext.models import DetectRequest

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/api/__init__.py

@@ -0,0 +1,3 @@
+from regula.facesdk.webclient.ext.api.match_api import MatchApi
+from regula.facesdk.webclient.ext.api.person_api import PersonApi
+from regula.facesdk.webclient.ext.api.sdk import FaceSdk

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/api/group_api.py

@@ -0,0 +1,36 @@
+from regula.facesdk.webclient.gen import ApiClient
+from regula.facesdk.webclient.gen.api.group_api import GroupApi as GenGroupApi
+from regula.facesdk.webclient.gen.model.group import Group
+from regula.facesdk.webclient.gen.model.group_page import GroupPage
+from regula.facesdk.webclient.gen.model.group_to_create import GroupToCreate
+from regula.facesdk.webclient.gen.model.persons_page import PersonsPage
+from regula.facesdk.webclient.gen.model.update_group import UpdateGroup
+
+
+class GroupApi(GenGroupApi):
+    def __init__(self, api_client: ApiClient):
+        super().__init__(api_client)
+
+    def create_group(self, group_name: str, metadata=None, **kwargs) -> Group:
+        if metadata is None:
+            metadata = {}
+        group_to_create = GroupToCreate(name=group_name, metadata=metadata)
+        return super().create_group(group_to_create, **kwargs)
+
+    def delete_group(self, group_id: str, **kwargs) -> None:
+        return super().delete_group(group_id, **kwargs)
+
+    def get_all_groups(self, **kwargs) -> GroupPage:
+        return super().get_all_groups(**kwargs)
+
+    def get_all_persons_by_group_id(self, group_id: str, **kwargs) -> PersonsPage:
+        return super().get_all_persons_by_group_id(group_id, **kwargs)
+
+    def get_group(self, group_id: str, **kwargs) -> Group:
+        return super().get_group(group_id, **kwargs)
+
+    def update_group(self, group_id: str, group_to_create: GroupToCreate, **kwargs) -> None:
+        return super().update_group(group_id, group_to_create, **kwargs)
+
+    def update_persons_in_group(self, group_id: str, update_group: UpdateGroup, **kwargs) -> None:
+        return super().update_persons_in_group(group_id, update_group, **kwargs)

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/api/match_api.py

@@ -0,0 +1,46 @@
+from typing import List
+
+from regula.facesdk.webclient.gen import Configuration, ApiClient
+from regula.facesdk.webclient.gen.apis import MatchApi as GenMatchApi
+from regula.facesdk.webclient.ext.models import MatchRequest, DetectRequest
+from regula.facesdk.webclient.gen.model.detect_response import DetectResponse
+from regula.facesdk.webclient.gen.model.match_and_search_request import MatchAndSearchRequest
+from regula.facesdk.webclient.gen.model.match_and_search_request_all_of_images import MatchAndSearchRequestAllOfImages
+from regula.facesdk.webclient.gen.model.match_and_search_response import MatchAndSearchResponse
+from regula.facesdk.webclient.gen.model.match_response import MatchResponse
+
+
+class MatchApi(GenMatchApi):
+    def __init__(self, host=None, debug=False, verify_ssl=False, api_client=None):
+        if api_client:
+            super().__init__(api_client)
+        else:
+            configuration = Configuration(host=host)
+            configuration.debug = debug
+            configuration.verify_ssl = verify_ssl
+
+            super().__init__(ApiClient(configuration=configuration))
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.api_client.close()
+
+    def match_and_search(self, images: List[MatchAndSearchRequestAllOfImages], group_ids: List[int],
+                         limit: int = 100, threshold: float = 1.0) -> MatchAndSearchResponse:
+        body = MatchAndSearchRequest(
+            images=images,
+            group_ids=group_ids
+        )
+        return super().match_and_search(body)
+
+    def match(self, match_request: MatchRequest, **kwargs) -> MatchResponse:
+        return super().match(match_request, **kwargs)
+
+    # deprecated use match
+    def compare(self, compare_request: MatchRequest, **kwargs) -> MatchResponse:
+        return super().match(compare_request, **kwargs)
+
+    def detect(self, detect_request: DetectRequest, **kwargs) -> DetectResponse:
+        return super().detect(detect_request, **kwargs)

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/api/person_api.py

@@ -0,0 +1,46 @@
+import base64
+
+from regula.facesdk.webclient.gen import ApiClient
+from regula.facesdk.webclient.gen.api.person_api import PersonApi as GenPersonApi
+from regula.facesdk.webclient.gen.model.image import Image
+from regula.facesdk.webclient.gen.model.image_fields import ImageFields
+from regula.facesdk.webclient.gen.model.image_fields_image import ImageFieldsImage
+from regula.facesdk.webclient.gen.model.image_page import ImagePage
+from regula.facesdk.webclient.gen.model.person import Person
+from regula.facesdk.webclient.gen.model.person_fields import PersonFields
+
+
+class PersonApi(GenPersonApi):
+    def __init__(self, api_client: ApiClient):
+        super().__init__(api_client)
+
+    def add_image_to_person(self, person_id: str, content: bytes, content_type: str = None, **kwargs) -> Image:
+        base_image = base64.b64encode(content).decode("UTF-8")
+        image = ImageFields(image=ImageFieldsImage(content_type, base_image))
+        return super().add_image_to_person(person_id, image, **kwargs)
+
+    def create_person(self, person_fields: PersonFields, **kwargs) -> Person:
+        if person_fields.metadata is None:
+            person_fields.metadata = {}
+        return super().create_person(person_fields, **kwargs)
+
+    def delete_image_of_person(self, image_id: str, person_id: str, **kwargs) -> None:
+        return super().delete_image_of_person(image_id, person_id, **kwargs)
+
+    def delete_person(self, person_id: str, **kwargs) -> None:
+        return super().delete_person(person_id, **kwargs)
+
+    def get_all_groups_by_person_id(self, person_id: str, **kwargs):
+        return super().get_all_groups_by_person_id(person_id)
+
+    def get_all_images_by_person_id(self, person_id: str, **kwargs) -> ImagePage:
+        return super().get_all_images_by_person_id(person_id, **kwargs)
+
+    def get_image_of_person(self, image_id: str, person_id: str, **kwargs):
+        return super().get_image_of_person(image_id, person_id, **kwargs)
+
+    def get_person(self, person_id: str, **kwargs) -> Person:
+        return super().get_person(person_id, **kwargs)
+
+    def update_person(self, person_id: str, person_fields: PersonFields, **kwargs) -> None:
+        return super().update_person(person_id, person_fields, **kwargs)

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/api/sdk.py

@@ -0,0 +1,28 @@
+from regula.facesdk.webclient.ext.api import MatchApi
+from regula.facesdk.webclient.ext.api import PersonApi
+from regula.facesdk.webclient.ext.api.group_api import GroupApi
+from regula.facesdk.webclient.ext.api.search_api import SearchApi
+from regula.facesdk.webclient.gen import ApiClient, Configuration
+
+
+class FaceSdk:
+    def __init__(self, host=None, debug=None, verify_ssl=False, api_client=None):
+        if api_client:
+            self.__api_client = api_client
+        else:
+            configuration = Configuration(host=host)
+            configuration.debug = debug
+            configuration.verify_ssl = verify_ssl
+
+            self.__api_client = ApiClient(configuration=configuration)
+
+        self.match_api = MatchApi(api_client=self.__api_client)
+        self.person_api = PersonApi(api_client=self.__api_client)
+        self.group_api = GroupApi(api_client=self.__api_client)
+        self.search_api = SearchApi(api_client=self.__api_client)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.__api_client.close()

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/api/search_api.py

@@ -0,0 +1,17 @@
+import base64
+
+from regula.facesdk.webclient.gen import ApiClient
+from regula.facesdk.webclient.gen.api.search_api import SearchApi as GenSearchApi
+from regula.facesdk.webclient.gen.model.search_request import SearchRequest
+from regula.facesdk.webclient.gen.model.search_result import SearchResult
+
+
+class SearchApi(GenSearchApi):
+    def __init__(self, api_client: ApiClient):
+        super().__init__(api_client)
+
+    def search(self, search_request: SearchRequest, **kwargs) -> SearchResult:
+        image = search_request.image
+        if image is not None:
+            search_request.image.content = base64.b64encode(image.content).decode("utf-8") if image.content else None
+        return super().search(search_request, **kwargs)

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/common.py

@@ -0,0 +1,7 @@
+import base64
+
+Base64String = str
+
+
+def bytes_to_base64(payload: bytes):
+    return base64.b64encode(payload).decode("utf-8")

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/models/__init__.py

@@ -0,0 +1,6 @@
+from regula.facesdk.webclient.ext.models.match_request import MatchRequest
+from regula.facesdk.webclient.ext.models.match_image import MatchImage
+from regula.facesdk.webclient.ext.models.detect_request import DetectRequest
+
+CompareRequest = MatchRequest
+CompareImage = MatchImage

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/models/detect_request.py

@@ -0,0 +1,32 @@
+from typing import Union
+
+from regula.facesdk.webclient.ext.common import Base64String, bytes_to_base64
+from regula.facesdk.webclient.gen import ApiValueError
+from regula.facesdk.webclient.gen.model.process_param import ProcessParam
+from regula.facesdk.webclient.gen.models import DetectRequest as GetDetectRequest
+
+
+class DetectRequest(GetDetectRequest):
+    def __init__(
+            self,
+            image: Union[Base64String, bytes],
+            process_param: ProcessParam = None,
+            only_central_face=False,
+            thumbnails=False,
+            local_vars_configuration=None,
+            tag=None,
+
+    ):
+        if not image:
+            raise ApiValueError(f"image: expected <not empty> - obtained <{image}>", "image")
+
+        if isinstance(image, bytes):
+            image = bytes_to_base64(image)
+
+        super().__init__(
+            image=image,
+            thumbnails=thumbnails,
+            local_vars_configuration=local_vars_configuration,
+            tag=tag,
+            process_param=process_param
+        )

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/models/match_image.py

@@ -0,0 +1,19 @@
+from typing import Union
+
+from regula.facesdk.webclient.ext.common import Base64String, bytes_to_base64
+from regula.facesdk.webclient.gen import ApiValueError
+from regula.facesdk.webclient.gen.model.image_source import ImageSource
+from regula.facesdk.webclient.gen.models import MatchImage as GenMatchImage
+
+
+class MatchImage(GenMatchImage):
+    def __init__(self, index=None, type=None, data: Union[Base64String, bytes] = None, local_vars_configuration=None):
+        if not data:
+            raise ApiValueError(f"compare image {index} data: expected <not empty>")
+
+        if not type:
+            type = ImageSource.LIVE
+        if isinstance(data, bytes):
+            data = bytes_to_base64(data)
+
+        super().__init__(index, type, data, local_vars_configuration)

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/ext/models/match_request.py

@@ -0,0 +1,34 @@
+from typing import List, Union
+
+from regula.facesdk.webclient.ext.common import Base64String
+from regula.facesdk.webclient.ext.models.match_image import MatchImage
+from regula.facesdk.webclient.gen import ApiValueError
+from regula.facesdk.webclient.gen.models import MatchRequest as GenMatchRequest
+
+
+class MatchRequest(GenMatchRequest):
+    def __init__(
+            self,
+            images: List[Union[MatchImage, Base64String, bytes]],
+            thumbnails=False,
+            local_vars_configuration=None,
+            output_image_params=None,
+            tag=None
+    ):
+        if not images:
+            raise ApiValueError(f"compare request images: expected size <more than 1>")
+
+        input_images = []
+        for index, item in enumerate(images):
+            if isinstance(item, MatchImage):
+                input_images.append(item)
+            else:
+                input_images.append(MatchImage(index, None, item, local_vars_configuration))
+
+        super().__init__(
+            images=input_images,
+            local_vars_configuration=local_vars_configuration,
+            output_image_params=output_image_params,
+            thumbnails=thumbnails,
+            tag=tag
+        )

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/gen/__init__.py

@@ -0,0 +1,27 @@
+# flake8: noqa
+
+"""
+    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
+"""
+
+
+__version__ = "1.0.0"
+
+# import ApiClient
+from regula.facesdk.webclient.gen.api_client import ApiClient
+
+# import Configuration
+from regula.facesdk.webclient.gen.configuration import Configuration
+
+# import exceptions
+from regula.facesdk.webclient.gen.exceptions import OpenApiException
+from regula.facesdk.webclient.gen.exceptions import ApiAttributeError
+from regula.facesdk.webclient.gen.exceptions import ApiTypeError
+from regula.facesdk.webclient.gen.exceptions import ApiValueError
+from regula.facesdk.webclient.gen.exceptions import ApiKeyError
+from regula.facesdk.webclient.gen.exceptions import ApiException

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/gen/api/__init__.py

@@ -0,0 +1,3 @@
+# do not import all apis into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all apis from one package, import them with
+# from regula.facesdk.webclient.gen.apis import GroupApi

regula_facesdk_webclient-6.4.198.dev0/regula/facesdk/webclient/gen/api/diagnostics_api.py

@@ -0,0 +1,162 @@
+# 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
+"""
+
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from regula.facesdk.webclient.gen.api_client import ApiClient
+from regula.facesdk.webclient.gen.exceptions import (  # noqa: F401
+    ApiTypeError,
+    ApiValueError
+)
+
+
+class DiagnosticsApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def readiness(self, **kwargs):  # noqa: E501
+        """Checking the license status  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.readiness(async_req=True)
+        >>> result = thread.get()
+
+        :param x_request_id: Request header label.
+        :type x_request_id: str
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: {str: (bool, date, datetime, dict, float, int, list, str, none_type)}
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.readiness_with_http_info(**kwargs)  # noqa: E501
+
+    def readiness_with_http_info(self, **kwargs):  # noqa: E501
+        """Checking the license status  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.readiness_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param x_request_id: Request header label.
+        :type x_request_id: str
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :type _return_http_data_only: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'x_request_id',
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method readiness" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+        if 'x_request_id' in local_var_params:
+            header_params['X-RequestID'] = local_var_params['x_request_id']  # noqa: E501
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/api/readiness', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='{str: (bool, date, datetime, dict, float, int, list, str, none_type)}',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats,
+            _request_auth=local_var_params.get('_request_auth'))