diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index f3b7ba9..db66849 100755 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -2,12 +2,11 @@ regula/__init__.py regula/facesdk/__init__.py regula/facesdk/webclient/gen/__init__.py regula/facesdk/webclient/gen/api/__init__.py -regula/facesdk/webclient/gen/api/diagnostics_api.py -regula/facesdk/webclient/gen/api/group_api.py -regula/facesdk/webclient/gen/api/liveness_2_0_api.py -regula/facesdk/webclient/gen/api/matching_api.py -regula/facesdk/webclient/gen/api/person_api.py -regula/facesdk/webclient/gen/api/search_api.py +regula/facesdk/webclient/gen/api/diagnostic_api.py +regula/facesdk/webclient/gen/api/face_comparison_api.py +regula/facesdk/webclient/gen/api/face_detection_api.py +regula/facesdk/webclient/gen/api/face_identification_api.py +regula/facesdk/webclient/gen/api/liveness_assessment_api.py regula/facesdk/webclient/gen/api_client.py regula/facesdk/webclient/gen/apis/__init__.py regula/facesdk/webclient/gen/configuration.py diff --git a/regula/facesdk/webclient/gen/api/__init__.py b/regula/facesdk/webclient/gen/api/__init__.py index d384f76..1397f6d 100644 --- a/regula/facesdk/webclient/gen/api/__init__.py +++ b/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 DiagnosticApi diff --git a/regula/facesdk/webclient/gen/api/diagnostic_api.py b/regula/facesdk/webclient/gen/api/diagnostic_api.py new file mode 100644 index 0000000..759a32b --- /dev/null +++ b/regula/facesdk/webclient/gen/api/diagnostic_api.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Regula Face SDK Web API + + Regula Face SDK is a cross-platform biometric verification solution for a digital identity verification process. 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: * Face Detection * Face Match (1:1) * Face Search (1:N) * Liveness Assessment Here is the OpenAPI specification on GitHub. ### 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 +""" + + +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 DiagnosticApi(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')) diff --git a/regula/facesdk/webclient/gen/api/face_comparison_api.py b/regula/facesdk/webclient/gen/api/face_comparison_api.py new file mode 100644 index 0000000..df8a9aa --- /dev/null +++ b/regula/facesdk/webclient/gen/api/face_comparison_api.py @@ -0,0 +1,321 @@ +# coding: utf-8 + +""" + Regula Face SDK Web API + + Regula Face SDK is a cross-platform biometric verification solution for a digital identity verification process. 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: * Face Detection * Face Match (1:1) * Face Search (1:N) * Liveness Assessment Here is the OpenAPI specification on GitHub. ### 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 +""" + + +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 FaceComparisonApi(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 match(self, match_request, **kwargs): # noqa: E501 + """compare faces (1:1) # noqa: E501 + + To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter.

The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1` # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.match(match_request, async_req=True) + >>> result = thread.get() + + :param match_request: (required) + :type match_request: MatchRequest + :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: MatchResponse + """ + kwargs['_return_http_data_only'] = True + return self.match_with_http_info(match_request, **kwargs) # noqa: E501 + + def match_with_http_info(self, match_request, **kwargs): # noqa: E501 + """compare faces (1:1) # noqa: E501 + + To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter.

The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1` # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.match_with_http_info(match_request, async_req=True) + >>> result = thread.get() + + :param match_request: (required) + :type match_request: MatchRequest + :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(MatchResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'match_request' + '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 match" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'match_request' is set + if self.api_client.client_side_validation and ('match_request' not in local_var_params or # noqa: E501 + local_var_params['match_request'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `match_request` when calling `match`") # noqa: E501 + + 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 + if 'match_request' in local_var_params: + body_params = local_var_params['match_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/match', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MatchResponse', # 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 match_and_search(self, match_and_search_request, **kwargs): # noqa: E501 + """match and search (1:1 + 1:N) # noqa: E501 + + To compare several images from a document and look up a person in the database in one request, use POST `/api/match_and_search`. In this case, the calculation of the descriptor will be performed only once, as opposed to using two requests for the same operation. If only one person is identified, matching is not performed and only search is carried out. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.match_and_search(match_and_search_request, async_req=True) + >>> result = thread.get() + + :param match_and_search_request: (required) + :type match_and_search_request: MatchAndSearchRequest + :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: MatchAndSearchResponse + """ + kwargs['_return_http_data_only'] = True + return self.match_and_search_with_http_info(match_and_search_request, **kwargs) # noqa: E501 + + def match_and_search_with_http_info(self, match_and_search_request, **kwargs): # noqa: E501 + """match and search (1:1 + 1:N) # noqa: E501 + + To compare several images from a document and look up a person in the database in one request, use POST `/api/match_and_search`. In this case, the calculation of the descriptor will be performed only once, as opposed to using two requests for the same operation. If only one person is identified, matching is not performed and only search is carried out. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.match_and_search_with_http_info(match_and_search_request, async_req=True) + >>> result = thread.get() + + :param match_and_search_request: (required) + :type match_and_search_request: MatchAndSearchRequest + :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(MatchAndSearchResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'match_and_search_request' + '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 match_and_search" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'match_and_search_request' is set + if self.api_client.client_side_validation and ('match_and_search_request' not in local_var_params or # noqa: E501 + local_var_params['match_and_search_request'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `match_and_search_request` when calling `match_and_search`") # noqa: E501 + + 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 + if 'match_and_search_request' in local_var_params: + body_params = local_var_params['match_and_search_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/match_and_search', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MatchAndSearchResponse', # 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')) diff --git a/regula/facesdk/webclient/gen/api/face_detection_api.py b/regula/facesdk/webclient/gen/api/face_detection_api.py new file mode 100644 index 0000000..6b10a6e --- /dev/null +++ b/regula/facesdk/webclient/gen/api/face_detection_api.py @@ -0,0 +1,179 @@ +# coding: utf-8 + +""" + Regula Face SDK Web API + + Regula Face SDK is a cross-platform biometric verification solution for a digital identity verification process. 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: * Face Detection * Face Match (1:1) * Face Search (1:N) * Liveness Assessment Here is the OpenAPI specification on GitHub. ### 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 +""" + + +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 FaceDetectionApi(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 detect(self, detect_request, **kwargs): # noqa: E501 + """detect faces # noqa: E501 + + Detect face, evaluate attributes, assess the portrait quality # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.detect(detect_request, async_req=True) + >>> result = thread.get() + + :param detect_request: (required) + :type detect_request: DetectRequest + :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: DetectResponse + """ + kwargs['_return_http_data_only'] = True + return self.detect_with_http_info(detect_request, **kwargs) # noqa: E501 + + def detect_with_http_info(self, detect_request, **kwargs): # noqa: E501 + """detect faces # noqa: E501 + + Detect face, evaluate attributes, assess the portrait quality # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.detect_with_http_info(detect_request, async_req=True) + >>> result = thread.get() + + :param detect_request: (required) + :type detect_request: DetectRequest + :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(DetectResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'detect_request' + '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 detect" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'detect_request' is set + if self.api_client.client_side_validation and ('detect_request' not in local_var_params or # noqa: E501 + local_var_params['detect_request'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `detect_request` when calling `detect`") # noqa: E501 + + 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 + if 'detect_request' in local_var_params: + body_params = local_var_params['detect_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/detect', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='DetectResponse', # 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')) diff --git a/regula/facesdk/webclient/gen/api/face_identification_api.py b/regula/facesdk/webclient/gen/api/face_identification_api.py new file mode 100644 index 0000000..e577de7 --- /dev/null +++ b/regula/facesdk/webclient/gen/api/face_identification_api.py @@ -0,0 +1,2488 @@ +# coding: utf-8 + +""" + Regula Face SDK Web API + + Regula Face SDK is a cross-platform biometric verification solution for a digital identity verification process. 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: * Face Detection * Face Match (1:1) * Face Search (1:N) * Liveness Assessment Here is the OpenAPI specification on GitHub. ### 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 +""" + + +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 FaceIdentificationApi(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 add_image_to_person(self, person_id, add_image_to_person_request, **kwargs): # noqa: E501 + """Add person image # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_image_to_person(person_id, add_image_to_person_request, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param add_image_to_person_request: Image to add. (required) + :type add_image_to_person_request: AddImageToPersonRequest + :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: AddImageToPersonResponse + """ + kwargs['_return_http_data_only'] = True + return self.add_image_to_person_with_http_info(person_id, add_image_to_person_request, **kwargs) # noqa: E501 + + def add_image_to_person_with_http_info(self, person_id, add_image_to_person_request, **kwargs): # noqa: E501 + """Add person image # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.add_image_to_person_with_http_info(person_id, add_image_to_person_request, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param add_image_to_person_request: Image to add. (required) + :type add_image_to_person_request: AddImageToPersonRequest + :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(AddImageToPersonResponse, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'person_id' + 'add_image_to_person_request' + '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 add_image_to_person" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `add_image_to_person`") # noqa: E501 + # verify the required parameter 'add_image_to_person_request' is set + if self.api_client.client_side_validation and ('add_image_to_person_request' not in local_var_params or # noqa: E501 + local_var_params['add_image_to_person_request'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `add_image_to_person_request` when calling `add_image_to_person`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + 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 + if 'add_image_to_person_request' in local_var_params: + body_params = local_var_params['add_image_to_person_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/persons/{personId}/images', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AddImageToPersonResponse', # 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 create_group(self, group_to_create, **kwargs): # noqa: E501 + """Create group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_group(group_to_create, async_req=True) + >>> result = thread.get() + + :param group_to_create: Request body for the group to create. (required) + :type group_to_create: GroupToCreate + :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: Group + """ + kwargs['_return_http_data_only'] = True + return self.create_group_with_http_info(group_to_create, **kwargs) # noqa: E501 + + def create_group_with_http_info(self, group_to_create, **kwargs): # noqa: E501 + """Create group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_group_with_http_info(group_to_create, async_req=True) + >>> result = thread.get() + + :param group_to_create: Request body for the group to create. (required) + :type group_to_create: GroupToCreate + :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(Group, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'group_to_create' + '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 create_group" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'group_to_create' is set + if self.api_client.client_side_validation and ('group_to_create' not in local_var_params or # noqa: E501 + local_var_params['group_to_create'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `group_to_create` when calling `create_group`") # noqa: E501 + + 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 + if 'group_to_create' in local_var_params: + body_params = local_var_params['group_to_create'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/groups', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Group', # 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 create_person(self, person_fields, **kwargs): # noqa: E501 + """Create person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_person(person_fields, async_req=True) + >>> result = thread.get() + + :param person_fields: (required) + :type person_fields: PersonFields + :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: Person + """ + kwargs['_return_http_data_only'] = True + return self.create_person_with_http_info(person_fields, **kwargs) # noqa: E501 + + def create_person_with_http_info(self, person_fields, **kwargs): # noqa: E501 + """Create person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_person_with_http_info(person_fields, async_req=True) + >>> result = thread.get() + + :param person_fields: (required) + :type person_fields: PersonFields + :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(Person, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'person_fields' + '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 create_person" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'person_fields' is set + if self.api_client.client_side_validation and ('person_fields' not in local_var_params or # noqa: E501 + local_var_params['person_fields'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_fields` when calling `create_person`") # noqa: E501 + + 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 + if 'person_fields' in local_var_params: + body_params = local_var_params['person_fields'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/persons', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Person', # 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 delete_group(self, group_id, **kwargs): # noqa: E501 + """Delete group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_group(group_id, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :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.delete_group_with_http_info(group_id, **kwargs) # noqa: E501 + + def delete_group_with_http_info(self, group_id, **kwargs): # noqa: E501 + """Delete group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_group_with_http_info(group_id, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :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 = [ + 'group_id' + '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 delete_group" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'group_id' is set + if self.api_client.client_side_validation and ('group_id' not in local_var_params or # noqa: E501 + local_var_params['group_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `group_id` when calling `delete_group`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'group_id' in local_var_params: + path_params['groupId'] = local_var_params['group_id'] # noqa: E501 + + 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/groups/{groupId}', 'DELETE', + 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')) + + def delete_image_of_person(self, image_id, person_id, **kwargs): # noqa: E501 + """Delete image of person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_image_of_person(image_id, person_id, async_req=True) + >>> result = thread.get() + + :param image_id: Image ID. (required) + :type image_id: str + :param person_id: Person ID. (required) + :type person_id: str + :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.delete_image_of_person_with_http_info(image_id, person_id, **kwargs) # noqa: E501 + + def delete_image_of_person_with_http_info(self, image_id, person_id, **kwargs): # noqa: E501 + """Delete image of person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_image_of_person_with_http_info(image_id, person_id, async_req=True) + >>> result = thread.get() + + :param image_id: Image ID. (required) + :type image_id: str + :param person_id: Person ID. (required) + :type person_id: str + :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 = [ + 'image_id' + 'person_id' + '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 delete_image_of_person" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'image_id' is set + if self.api_client.client_side_validation and ('image_id' not in local_var_params or # noqa: E501 + local_var_params['image_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `image_id` when calling `delete_image_of_person`") # noqa: E501 + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `delete_image_of_person`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'image_id' in local_var_params: + path_params['imageId'] = local_var_params['image_id'] # noqa: E501 + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + 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/persons/{personId}/images/{imageId}', 'DELETE', + 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')) + + def delete_person(self, person_id, **kwargs): # noqa: E501 + """Delete person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_person(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :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.delete_person_with_http_info(person_id, **kwargs) # noqa: E501 + + def delete_person_with_http_info(self, person_id, **kwargs): # noqa: E501 + """Delete person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_person_with_http_info(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :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 = [ + 'person_id' + '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 delete_person" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `delete_person`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + 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/persons/{personId}', 'DELETE', + 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')) + + def get_all_groups(self, **kwargs): # noqa: E501 + """Get groups # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_groups(async_req=True) + >>> result = thread.get() + + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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: GroupPage + """ + kwargs['_return_http_data_only'] = True + return self.get_all_groups_with_http_info(**kwargs) # noqa: E501 + + def get_all_groups_with_http_info(self, **kwargs): # noqa: E501 + """Get groups # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_groups_with_http_info(async_req=True) + >>> result = thread.get() + + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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(GroupPage, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'page' + 'size' + '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 get_all_groups" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 + query_params.append(('size', local_var_params['size'])) # noqa: E501 + + 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/groups', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='GroupPage', # 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 get_all_groups_by_person_id(self, person_id, **kwargs): # noqa: E501 + """Get person groups # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_groups_by_person_id(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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: GroupPage + """ + kwargs['_return_http_data_only'] = True + return self.get_all_groups_by_person_id_with_http_info(person_id, **kwargs) # noqa: E501 + + def get_all_groups_by_person_id_with_http_info(self, person_id, **kwargs): # noqa: E501 + """Get person groups # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_groups_by_person_id_with_http_info(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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(GroupPage, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'person_id' + 'page' + 'size' + '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 get_all_groups_by_person_id" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `get_all_groups_by_person_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + query_params = [] + if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 + query_params.append(('size', local_var_params['size'])) # noqa: E501 + + 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/persons/{personId}/groups', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='GroupPage', # 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 get_all_images_by_person_id(self, person_id, **kwargs): # noqa: E501 + """Get person images # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_images_by_person_id(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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: ImagePage + """ + kwargs['_return_http_data_only'] = True + return self.get_all_images_by_person_id_with_http_info(person_id, **kwargs) # noqa: E501 + + def get_all_images_by_person_id_with_http_info(self, person_id, **kwargs): # noqa: E501 + """Get person images # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_images_by_person_id_with_http_info(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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(ImagePage, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'person_id' + 'page' + 'size' + '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 get_all_images_by_person_id" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `get_all_images_by_person_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + query_params = [] + if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 + query_params.append(('size', local_var_params['size'])) # noqa: E501 + + 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/persons/{personId}/images', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ImagePage', # 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 get_all_persons_by_group_id(self, group_id, **kwargs): # noqa: E501 + """Get group persons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_persons_by_group_id(group_id, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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: PersonsPage + """ + kwargs['_return_http_data_only'] = True + return self.get_all_persons_by_group_id_with_http_info(group_id, **kwargs) # noqa: E501 + + def get_all_persons_by_group_id_with_http_info(self, group_id, **kwargs): # noqa: E501 + """Get group persons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_persons_by_group_id_with_http_info(group_id, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :param page: The page number to get a list of persons or groups. + :type page: int + :param size: The page size with a list of persons or groups, items. + :type size: int + :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(PersonsPage, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'group_id' + 'page' + 'size' + '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 get_all_persons_by_group_id" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'group_id' is set + if self.api_client.client_side_validation and ('group_id' not in local_var_params or # noqa: E501 + local_var_params['group_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `group_id` when calling `get_all_persons_by_group_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'group_id' in local_var_params: + path_params['groupId'] = local_var_params['group_id'] # noqa: E501 + + query_params = [] + if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 + query_params.append(('size', local_var_params['size'])) # noqa: E501 + + 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/groups/{groupId}/persons', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='PersonsPage', # 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 get_group(self, group_id, **kwargs): # noqa: E501 + """Get group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_group(group_id, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :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: Group + """ + kwargs['_return_http_data_only'] = True + return self.get_group_with_http_info(group_id, **kwargs) # noqa: E501 + + def get_group_with_http_info(self, group_id, **kwargs): # noqa: E501 + """Get group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_group_with_http_info(group_id, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :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(Group, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'group_id' + '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 get_group" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'group_id' is set + if self.api_client.client_side_validation and ('group_id' not in local_var_params or # noqa: E501 + local_var_params['group_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `group_id` when calling `get_group`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'group_id' in local_var_params: + path_params['groupId'] = local_var_params['group_id'] # noqa: E501 + + 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/groups/{groupId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Group', # 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 get_image_of_person(self, image_id, person_id, **kwargs): # noqa: E501 + """Get person image by id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_image_of_person(image_id, person_id, async_req=True) + >>> result = thread.get() + + :param image_id: Image ID. (required) + :type image_id: str + :param person_id: Person ID. (required) + :type person_id: str + :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: file_type + """ + kwargs['_return_http_data_only'] = True + return self.get_image_of_person_with_http_info(image_id, person_id, **kwargs) # noqa: E501 + + def get_image_of_person_with_http_info(self, image_id, person_id, **kwargs): # noqa: E501 + """Get person image by id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_image_of_person_with_http_info(image_id, person_id, async_req=True) + >>> result = thread.get() + + :param image_id: Image ID. (required) + :type image_id: str + :param person_id: Person ID. (required) + :type person_id: str + :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(file_type, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'image_id' + 'person_id' + '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 get_image_of_person" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'image_id' is set + if self.api_client.client_side_validation and ('image_id' not in local_var_params or # noqa: E501 + local_var_params['image_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `image_id` when calling `get_image_of_person`") # noqa: E501 + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `get_image_of_person`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'image_id' in local_var_params: + path_params['imageId'] = local_var_params['image_id'] # noqa: E501 + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + 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''image/*']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/persons/{personId}/images/{imageId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='file_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')) + + def get_person(self, person_id, **kwargs): # noqa: E501 + """Get person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_person(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :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: Person + """ + kwargs['_return_http_data_only'] = True + return self.get_person_with_http_info(person_id, **kwargs) # noqa: E501 + + def get_person_with_http_info(self, person_id, **kwargs): # noqa: E501 + """Get person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_person_with_http_info(person_id, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :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(Person, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'person_id' + '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 get_person" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `get_person`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + 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/persons/{personId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Person', # 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 search(self, search_request, **kwargs): # noqa: E501 + """Find person by image in groups # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search(search_request, async_req=True) + >>> result = thread.get() + + :param search_request: (required) + :type search_request: SearchRequest + :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: SearchResult + """ + kwargs['_return_http_data_only'] = True + return self.search_with_http_info(search_request, **kwargs) # noqa: E501 + + def search_with_http_info(self, search_request, **kwargs): # noqa: E501 + """Find person by image in groups # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_with_http_info(search_request, async_req=True) + >>> result = thread.get() + + :param search_request: (required) + :type search_request: SearchRequest + :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(SearchResult, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'search_request' + '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 search" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'search_request' is set + if self.api_client.client_side_validation and ('search_request' not in local_var_params or # noqa: E501 + local_var_params['search_request'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `search_request` when calling `search`") # noqa: E501 + + 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 + if 'search_request' in local_var_params: + body_params = local_var_params['search_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/search', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='SearchResult', # 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 update_group(self, group_id, group_to_create, **kwargs): # noqa: E501 + """Update group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_group(group_id, group_to_create, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :param group_to_create: Request body for the group to update. (required) + :type group_to_create: GroupToCreate + :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.update_group_with_http_info(group_id, group_to_create, **kwargs) # noqa: E501 + + def update_group_with_http_info(self, group_id, group_to_create, **kwargs): # noqa: E501 + """Update group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_group_with_http_info(group_id, group_to_create, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :param group_to_create: Request body for the group to update. (required) + :type group_to_create: GroupToCreate + :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 = [ + 'group_id' + 'group_to_create' + '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 update_group" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'group_id' is set + if self.api_client.client_side_validation and ('group_id' not in local_var_params or # noqa: E501 + local_var_params['group_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `group_id` when calling `update_group`") # noqa: E501 + # verify the required parameter 'group_to_create' is set + if self.api_client.client_side_validation and ('group_to_create' not in local_var_params or # noqa: E501 + local_var_params['group_to_create'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `group_to_create` when calling `update_group`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'group_id' in local_var_params: + path_params['groupId'] = local_var_params['group_id'] # noqa: E501 + + 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 + if 'group_to_create' in local_var_params: + body_params = local_var_params['group_to_create'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/groups/{groupId}', 'PUT', + 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')) + + def update_person(self, person_id, person_to_update_fields, **kwargs): # noqa: E501 + """Update person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_person(person_id, person_to_update_fields, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param person_to_update_fields: Request body for the Person to update. (required) + :type person_to_update_fields: PersonToUpdateFields + :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.update_person_with_http_info(person_id, person_to_update_fields, **kwargs) # noqa: E501 + + def update_person_with_http_info(self, person_id, person_to_update_fields, **kwargs): # noqa: E501 + """Update person # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_person_with_http_info(person_id, person_to_update_fields, async_req=True) + >>> result = thread.get() + + :param person_id: Person ID. (required) + :type person_id: str + :param person_to_update_fields: Request body for the Person to update. (required) + :type person_to_update_fields: PersonToUpdateFields + :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 = [ + 'person_id' + 'person_to_update_fields' + '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 update_person" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'person_id' is set + if self.api_client.client_side_validation and ('person_id' not in local_var_params or # noqa: E501 + local_var_params['person_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_id` when calling `update_person`") # noqa: E501 + # verify the required parameter 'person_to_update_fields' is set + if self.api_client.client_side_validation and ('person_to_update_fields' not in local_var_params or # noqa: E501 + local_var_params['person_to_update_fields'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `person_to_update_fields` when calling `update_person`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'person_id' in local_var_params: + path_params['personId'] = local_var_params['person_id'] # noqa: E501 + + 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 + if 'person_to_update_fields' in local_var_params: + body_params = local_var_params['person_to_update_fields'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/persons/{personId}', 'PUT', + 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')) + + def update_persons_in_group(self, group_id, update_group, **kwargs): # noqa: E501 + """Add/remove persons to group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_persons_in_group(group_id, update_group, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :param update_group: Request body for person IDs to add or remove. (required) + :type update_group: UpdateGroup + :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.update_persons_in_group_with_http_info(group_id, update_group, **kwargs) # noqa: E501 + + def update_persons_in_group_with_http_info(self, group_id, update_group, **kwargs): # noqa: E501 + """Add/remove persons to group # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_persons_in_group_with_http_info(group_id, update_group, async_req=True) + >>> result = thread.get() + + :param group_id: Group ID. (required) + :type group_id: str + :param update_group: Request body for person IDs to add or remove. (required) + :type update_group: UpdateGroup + :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 = [ + 'group_id' + 'update_group' + '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 update_persons_in_group" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'group_id' is set + if self.api_client.client_side_validation and ('group_id' not in local_var_params or # noqa: E501 + local_var_params['group_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `group_id` when calling `update_persons_in_group`") # noqa: E501 + # verify the required parameter 'update_group' is set + if self.api_client.client_side_validation and ('update_group' not in local_var_params or # noqa: E501 + local_var_params['update_group'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `update_group` when calling `update_persons_in_group`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'group_id' in local_var_params: + path_params['groupId'] = local_var_params['group_id'] # noqa: E501 + + 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 + if 'update_group' in local_var_params: + body_params = local_var_params['update_group'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/api/groups/{groupId}/persons', 'PUT', + 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')) diff --git a/regula/facesdk/webclient/gen/api/liveness_assessment_api.py b/regula/facesdk/webclient/gen/api/liveness_assessment_api.py new file mode 100644 index 0000000..311017f --- /dev/null +++ b/regula/facesdk/webclient/gen/api/liveness_assessment_api.py @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + Regula Face SDK Web API + + Regula Face SDK is a cross-platform biometric verification solution for a digital identity verification process. 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: * Face Detection * Face Match (1:1) * Face Search (1:N) * Liveness Assessment Here is the OpenAPI specification on GitHub. ### 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 +""" + + +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 LivenessAssessmentApi(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 get_liveness_transaction_info(self, transaction_id, **kwargs): # noqa: E501 + """Liveness assessment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_liveness_transaction_info(transaction_id, async_req=True) + >>> result = thread.get() + + :param transaction_id: ID of the current liveness transaction. (required) + :type transaction_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: TransactionInfo + """ + kwargs['_return_http_data_only'] = True + 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 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_liveness_transaction_info_with_http_info(transaction_id, async_req=True) + >>> result = thread.get() + + :param transaction_id: ID of the current liveness transaction. (required) + :type transaction_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(TransactionInfo, status_code(int), headers(HTTPHeaderDict)) + """ + + local_var_params = locals() + + all_params = [ + 'transaction_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 get_liveness_transaction_info" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'transaction_id' is set + if self.api_client.client_side_validation and ('transaction_id' not in local_var_params or # noqa: E501 + local_var_params['transaction_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `transaction_id` when calling `get_liveness_transaction_info`") # noqa: E501 + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'transaction_id' in local_var_params and local_var_params['transaction_id'] is not None: # noqa: E501 + query_params.append(('transactionId', local_var_params['transaction_id'])) # noqa: E501 + + header_params = {} + + 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/v2/liveness', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='TransactionInfo', # 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')) diff --git a/regula/facesdk/webclient/gen/apis/__init__.py b/regula/facesdk/webclient/gen/apis/__init__.py index 6e7a3cd..009ebd2 100644 --- a/regula/facesdk/webclient/gen/apis/__init__.py +++ b/regula/facesdk/webclient/gen/apis/__init__.py @@ -6,7 +6,7 @@ # raise a `RecursionError`. # In order to avoid this, import only the API that you directly need like: # -# from .api.diagnostics_api import DiagnosticsApi +# from .api.diagnostic_api import DiagnosticApi # # or import this package, but before doing it, use: # @@ -14,9 +14,8 @@ # sys.setrecursionlimit(n) # Import APIs into API package: -from regula.facesdk.webclient.gen.api.diagnostics_api import DiagnosticsApi -from regula.facesdk.webclient.gen.api.group_api import GroupApi -from regula.facesdk.webclient.gen.api.liveness_2_0_api import Liveness20Api -from regula.facesdk.webclient.gen.api.matching_api import MatchingApi -from regula.facesdk.webclient.gen.api.person_api import PersonApi -from regula.facesdk.webclient.gen.api.search_api import SearchApi +from regula.facesdk.webclient.gen.api.diagnostic_api import DiagnosticApi +from regula.facesdk.webclient.gen.api.face_comparison_api import FaceComparisonApi +from regula.facesdk.webclient.gen.api.face_detection_api import FaceDetectionApi +from regula.facesdk.webclient.gen.api.face_identification_api import FaceIdentificationApi +from regula.facesdk.webclient.gen.api.liveness_assessment_api import LivenessAssessmentApi