regula.facesdk.webclient 6.1.0__tar.gz → 6.4.140.dev0__tar.gz

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/PKG-INFO

@@ -1,17 +1,20 @@
 Metadata-Version: 2.1
 Name: regula.facesdk.webclient
-Version: 6.1.0
+Version: 6.4.140.dev0
 Summary: Regula's FaceSDK web python client
-Home-page: https://mobile.regulaforensics.com
+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>=2023.7.22
+Requires-Dist: certifi>=2024.07.04
 Requires-Dist: six>=1.10
 Requires-Dist: python-dateutil>=2.5.3
-Requires-Dist: urllib3>=1.15.1
+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
 

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/ext/__init__.py

@@ -1,4 +1,4 @@
-from regula.facesdk.webclient.ext.api import MatchingApi, FaceSdk
+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

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/ext/api/__init__.py

@@ -1,3 +1,3 @@
-from regula.facesdk.webclient.ext.api.matching_api import MatchingApi
+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.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/ext/api/group_api.py

@@ -20,11 +20,11 @@ class GroupApi(GenGroupApi):
     def delete_group(self, group_id: str, **kwargs) -> None:
         return super().delete_group(group_id, **kwargs)
 
-    def get_all_groups(self, page: int, size: int, **kwargs) -> GroupPage:
-        return super().get_all_groups(page, size, **kwargs)
+    def get_all_groups(self, **kwargs) -> GroupPage:
+        return super().get_all_groups(**kwargs)
 
-    def get_all_persons_by_group_id(self, page: int, size: int, group_id: str, **kwargs) -> PersonsPage:
-        return super().get_all_persons_by_group_id(page, size, group_id, **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)

regula.facesdk.webclient-6.1.0/regula/facesdk/webclient/ext/api/matching_api.py → regula_facesdk_webclient-6.4.140.dev0/regula/facesdk/webclient/ext/api/match_api.py

@@ -1,7 +1,7 @@
 from typing import List
 
 from regula.facesdk.webclient.gen import Configuration, ApiClient
-from regula.facesdk.webclient.gen.apis import MatchingApi as GenMatchingApi
+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
@@ -10,7 +10,7 @@ from regula.facesdk.webclient.gen.model.match_and_search_response import MatchAn
 from regula.facesdk.webclient.gen.model.match_response import MatchResponse
 
 
-class MatchingApi(GenMatchingApi):
+class MatchApi(GenMatchApi):
     def __init__(self, host=None, debug=False, verify_ssl=False, api_client=None):
         if api_client:
             super().__init__(api_client)

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/ext/api/person_api.py

@@ -30,11 +30,11 @@ class PersonApi(GenPersonApi):
     def delete_person(self, person_id: str, **kwargs) -> None:
         return super().delete_person(person_id, **kwargs)
 
-    def get_all_groups_by_person_id(self, page: int, size: int, person_id: str, **kwargs):
-        return super().get_all_groups_by_person_id(page, size, person_id)
+    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, page: int, size: int, person_id: str, **kwargs) -> ImagePage:
-        return super().get_all_images_by_person_id(page, size, person_id, **kwargs)
+    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)

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/ext/api/sdk.py

@@ -1,4 +1,4 @@
-from regula.facesdk.webclient.ext.api import MatchingApi
+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
@@ -16,7 +16,7 @@ class FaceSdk:
 
             self.__api_client = ApiClient(configuration=configuration)
 
-        self.matching_api = MatchingApi(api_client=self.__api_client)
+        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)

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/ext/models/detect_request.py

@@ -2,14 +2,20 @@ 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],
-            only_central_face=False, thumbnails=False,
-            local_vars_configuration=None, tag=None
+            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")
@@ -18,6 +24,9 @@ class DetectRequest(GetDetectRequest):
             image = bytes_to_base64(image)
 
         super().__init__(
-            image=image, thumbnails=thumbnails,
-            local_vars_configuration=local_vars_configuration, tag=tag
+            image=image,
+            thumbnails=thumbnails,
+            local_vars_configuration=local_vars_configuration,
+            tag=tag,
+            process_param=process_param
         )

regula_facesdk_webclient-6.4.140.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.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/gen/api/__init__.py

@@ -1,3 +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 DiagnosticsApi
+# from regula.facesdk.webclient.gen.apis import GroupApi

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/gen/api/diagnostics_api.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-    Regula FaceSDK Web API
+    Regula Face SDK 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
+    <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.1.0
+    The version of the OpenAPI document: 6.2.0
     Generated by: https://openapi-generator.tech
 """
 
@@ -102,7 +102,7 @@ class DiagnosticsApi(object):
         local_var_params = locals()
 
         all_params = [
-            'x_request_id'
+            'x_request_id',
         ]
         all_params.extend(
             [

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/gen/api/group_api.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-    Regula FaceSDK Web API
+    Regula Face SDK 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
+    <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.1.0
+    The version of the OpenAPI document: 6.2.0
     Generated by: https://openapi-generator.tech
 """
 
@@ -106,8 +106,8 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_to_create'
-            'x_request_id'
+            'group_to_create',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -246,8 +246,8 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'x_request_id'
+            'group_id',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -386,9 +386,9 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'page'
-            'size'
-            'x_request_id'
+            'page',
+            'size',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -529,10 +529,10 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'page'
-            'size'
-            'x_request_id'
+            'group_id',
+            'page',
+            'size',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -671,8 +671,8 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'x_request_id'
+            'group_id',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -811,9 +811,9 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'group_to_create'
-            'x_request_id'
+            'group_id',
+            'group_to_create',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -962,9 +962,9 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'update_group'
-            'x_request_id'
+            'group_id',
+            'update_group',
+            'x_request_id',
         ]
         all_params.extend(
             [

regula_facesdk_webclient-6.4.140.dev0/regula/facesdk/webclient/gen/api/healthcheck_api.py

@@ -0,0 +1,283 @@
+# 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 HealthcheckApi(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 healthz(self, **kwargs):  # noqa: E501
+        """Server healthcheck  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.healthz(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: DeviceInfo
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.healthz_with_http_info(**kwargs)  # noqa: E501
+
+    def healthz_with_http_info(self, **kwargs):  # noqa: E501
+        """Server healthcheck  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.healthz_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(DeviceInfo, 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 healthz" % 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/healthz', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='DeviceInfo',  # 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'))
+
+    def readyz(self, **kwargs):  # noqa: E501
+        """License healthcheck  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.readyz(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: None
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.readyz_with_http_info(**kwargs)  # noqa: E501
+
+    def readyz_with_http_info(self, **kwargs):  # noqa: E501
+        """License healthcheck  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.readyz_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: None
+        """
+
+        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 readyz" % 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
+        # Authentication setting
+        auth_settings = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/api/readyz', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # 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'))

{regula.facesdk.webclient-6.1.0 → regula_facesdk_webclient-6.4.140.dev0}/regula/facesdk/webclient/gen/api/liveness_2_0_api.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-    Regula FaceSDK Web API
+    Regula Face SDK 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
+    <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.1.0
+    The version of the OpenAPI document: 6.2.0
     Generated by: https://openapi-generator.tech
 """
 
@@ -37,8 +37,9 @@ class Liveness20Api(object):
         self.api_client = api_client
 
     def get_liveness_transaction_info(self, transaction_id, **kwargs):  # noqa: E501
-        """Liveness assessment  # noqa: E501
+        """liveness check  # noqa: E501
 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -66,8 +67,9 @@ class Liveness20Api(object):
         return self.get_liveness_transaction_info_with_http_info(transaction_id, **kwargs)  # noqa: E501
 
     def get_liveness_transaction_info_with_http_info(self, transaction_id, **kwargs):  # noqa: E501
-        """Liveness assessment  # noqa: E501
+        """liveness check  # noqa: E501
 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -102,7 +104,7 @@ class Liveness20Api(object):
         local_var_params = locals()
 
         all_params = [
-            'transaction_id'
+            'transaction_id',
         ]
         all_params.extend(
             [