regula-facesdk-webclient 7.2.388.dev0__py3-none-any.whl → 8.1.433.dev0__py3-none-any.whl

regula/facesdk/webclient/gen/exceptions.py

@@ -1,13 +1,10 @@
-"""
-    Regula Face SDK Web API
-
-    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+# coding: utf-8
 
-    The version of the OpenAPI document: 7.2.0
+"""
     Generated by: https://openapi-generator.tech
 """
-
-
+from typing import Any, Optional
+from typing_extensions import Self
 
 class OpenApiException(Exception):
     """The base exception class for all OpenAPIExceptions"""
@@ -15,7 +12,7 @@ class OpenApiException(Exception):
 
 class ApiTypeError(OpenApiException, TypeError):
     def __init__(self, msg, path_to_item=None, valid_classes=None,
-                 key_type=None):
+                 key_type=None) -> None:
         """ Raises an exception for TypeErrors
 
         Args:
@@ -43,7 +40,7 @@ class ApiTypeError(OpenApiException, TypeError):
 
 
 class ApiValueError(OpenApiException, ValueError):
-    def __init__(self, msg, path_to_item=None):
+    def __init__(self, msg, path_to_item=None) -> None:
         """
         Args:
             msg (str): the exception message
@@ -61,7 +58,7 @@ class ApiValueError(OpenApiException, ValueError):
 
 
 class ApiAttributeError(OpenApiException, AttributeError):
-    def __init__(self, msg, path_to_item=None):
+    def __init__(self, msg, path_to_item=None) -> None:
         """
         Raised when an attribute reference or assignment fails.
 
@@ -80,7 +77,7 @@ class ApiAttributeError(OpenApiException, AttributeError):
 
 
 class ApiKeyError(OpenApiException, KeyError):
-    def __init__(self, msg, path_to_item=None):
+    def __init__(self, msg, path_to_item=None) -> None:
         """
         Args:
             msg (str): the exception message
@@ -98,17 +95,63 @@ class ApiKeyError(OpenApiException, KeyError):
 
 class ApiException(OpenApiException):
 
-    def __init__(self, status=None, reason=None, http_resp=None):
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
         if http_resp:
-            self.status = http_resp.status
-            self.reason = http_resp.reason
-            self.body = http_resp.data
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
             self.headers = http_resp.getheaders()
-        else:
-            self.status = status
-            self.reason = reason
-            self.body = None
-            self.headers = None
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
 
     def __str__(self):
         """Custom error messages for exception"""
@@ -118,34 +161,40 @@ class ApiException(OpenApiException):
             error_message += "HTTP response headers: {0}\n".format(
                 self.headers)
 
-        if self.body:
-            error_message += "HTTP response body: {0}\n".format(self.body)
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
 
         return error_message
 
 
-class NotFoundException(ApiException):
+class BadRequestException(ApiException):
+    pass
 
-    def __init__(self, status=None, reason=None, http_resp=None):
-        super(NotFoundException, self).__init__(status, reason, http_resp)
 
+class NotFoundException(ApiException):
+    pass
 
-class UnauthorizedException(ApiException):
 
-    def __init__(self, status=None, reason=None, http_resp=None):
-        super(UnauthorizedException, self).__init__(status, reason, http_resp)
+class UnauthorizedException(ApiException):
+    pass
 
 
 class ForbiddenException(ApiException):
-
-    def __init__(self, status=None, reason=None, http_resp=None):
-        super(ForbiddenException, self).__init__(status, reason, http_resp)
+    pass
 
 
 class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
 
-    def __init__(self, status=None, reason=None, http_resp=None):
-        super(ServiceException, self).__init__(status, reason, http_resp)
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
 
 
 def render_path(path_to_item):

regula/facesdk/webclient/gen/models/__init__.py

@@ -1,98 +1,205 @@
+# coding: utf-8
+
 # flake8: noqa
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+if __import__("typing").TYPE_CHECKING:
+    # import models into model package
+    from regula.facesdk.webclient.gen.models.add_image_to_person_request import AddImageToPersonRequest
+    from regula.facesdk.webclient.gen.models.add_image_to_person_request_data import AddImageToPersonRequestData
+    from regula.facesdk.webclient.gen.models.add_image_to_person_request_image import AddImageToPersonRequestImage
+    from regula.facesdk.webclient.gen.models.add_image_to_person_response import AddImageToPersonResponse
+    from regula.facesdk.webclient.gen.models.attribute_config import AttributeConfig
+    from regula.facesdk.webclient.gen.models.attributes_data import AttributesData
+    from regula.facesdk.webclient.gen.models.crop import Crop
+    from regula.facesdk.webclient.gen.models.detail_item import DetailItem
+    from regula.facesdk.webclient.gen.models.detect_attributes_details import DetectAttributesDetails
+    from regula.facesdk.webclient.gen.models.detect_details_meta import DetectDetailsMeta
+    from regula.facesdk.webclient.gen.models.detect_meta_data import DetectMetaData
+    from regula.facesdk.webclient.gen.models.detect_request import DetectRequest
+    from regula.facesdk.webclient.gen.models.detect_request_data import DetectRequestData
+    from regula.facesdk.webclient.gen.models.detect_response import DetectResponse
+    from regula.facesdk.webclient.gen.models.detect_response_results import DetectResponseResults
+    from regula.facesdk.webclient.gen.models.detect_result import DetectResult
+    from regula.facesdk.webclient.gen.models.detection import Detection
+    from regula.facesdk.webclient.gen.models.detection_attributes import DetectionAttributes
+    from regula.facesdk.webclient.gen.models.detection_attributes_details_inner import DetectionAttributesDetailsInner
+    from regula.facesdk.webclient.gen.models.detection_face import DetectionFace
+    from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality
+    from regula.facesdk.webclient.gen.models.device_info import DeviceInfo
+    from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute
+    from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType
+    from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups
+    from regula.facesdk.webclient.gen.models.face_image_quality_groups_strings import FaceImageQualityGroupsStrings
+    from regula.facesdk.webclient.gen.models.face_image_quality_status import FaceImageQualityStatus
+    from regula.facesdk.webclient.gen.models.face_quality_config_name import FaceQualityConfigName
+    from regula.facesdk.webclient.gen.models.face_quality_scenarios import FaceQualityScenarios
+    from regula.facesdk.webclient.gen.models.face_sdk_result import FaceSDKResult
+    from regula.facesdk.webclient.gen.models.face_sdk_result_code import FaceSDKResultCode
+    from regula.facesdk.webclient.gen.models.faces_response import FacesResponse
+    from regula.facesdk.webclient.gen.models.faces_response_data import FacesResponseData
+    from regula.facesdk.webclient.gen.models.filter_op import FilterOp
+    from regula.facesdk.webclient.gen.models.filter_search_request import FilterSearchRequest
+    from regula.facesdk.webclient.gen.models.group import Group
+    from regula.facesdk.webclient.gen.models.group_data import GroupData
+    from regula.facesdk.webclient.gen.models.group_page import GroupPage
+    from regula.facesdk.webclient.gen.models.group_page_items import GroupPageItems
+    from regula.facesdk.webclient.gen.models.group_response import GroupResponse
+    from regula.facesdk.webclient.gen.models.group_to_create import GroupToCreate
+    from regula.facesdk.webclient.gen.models.image import Image
+    from regula.facesdk.webclient.gen.models.image_fields import ImageFields
+    from regula.facesdk.webclient.gen.models.image_fields_image import ImageFieldsImage
+    from regula.facesdk.webclient.gen.models.image_page import ImagePage
+    from regula.facesdk.webclient.gen.models.image_page_items import ImagePageItems
+    from regula.facesdk.webclient.gen.models.image_source import ImageSource
+    from regula.facesdk.webclient.gen.models.liveness_type import LivenessType
+    from regula.facesdk.webclient.gen.models.match_and_search_request import MatchAndSearchRequest
+    from regula.facesdk.webclient.gen.models.match_and_search_request_images_item import MatchAndSearchRequestImagesItem
+    from regula.facesdk.webclient.gen.models.match_and_search_response import MatchAndSearchResponse
+    from regula.facesdk.webclient.gen.models.match_and_search_response_data import MatchAndSearchResponseData
+    from regula.facesdk.webclient.gen.models.match_and_search_response_data_detections_item import MatchAndSearchResponseDataDetectionsItem
+    from regula.facesdk.webclient.gen.models.match_image import MatchImage
+    from regula.facesdk.webclient.gen.models.match_image_detection import MatchImageDetection
+    from regula.facesdk.webclient.gen.models.match_image_result import MatchImageResult
+    from regula.facesdk.webclient.gen.models.match_request import MatchRequest
+    from regula.facesdk.webclient.gen.models.match_request_data import MatchRequestData
+    from regula.facesdk.webclient.gen.models.match_response import MatchResponse
+    from regula.facesdk.webclient.gen.models.match_response_data import MatchResponseData
+    from regula.facesdk.webclient.gen.models.operation_log import OperationLog
+    from regula.facesdk.webclient.gen.models.output_image_params import OutputImageParams
+    from regula.facesdk.webclient.gen.models.page import Page
+    from regula.facesdk.webclient.gen.models.person import Person
+    from regula.facesdk.webclient.gen.models.person_data import PersonData
+    from regula.facesdk.webclient.gen.models.person_fields import PersonFields
+    from regula.facesdk.webclient.gen.models.person_items import PersonItems
+    from regula.facesdk.webclient.gen.models.person_to_update_fields import PersonToUpdateFields
+    from regula.facesdk.webclient.gen.models.person_with_images import PersonWithImages
+    from regula.facesdk.webclient.gen.models.person_with_images_data import PersonWithImagesData
+    from regula.facesdk.webclient.gen.models.persons_page import PersonsPage
+    from regula.facesdk.webclient.gen.models.process_param import ProcessParam
+    from regula.facesdk.webclient.gen.models.process_param_attributes import ProcessParamAttributes
+    from regula.facesdk.webclient.gen.models.quality_config import QualityConfig
+    from regula.facesdk.webclient.gen.models.quality_detail import QualityDetail
+    from regula.facesdk.webclient.gen.models.quality_details_groups import QualityDetailsGroups
+    from regula.facesdk.webclient.gen.models.quality_request import QualityRequest
+    from regula.facesdk.webclient.gen.models.recognize_image import RecognizeImage
+    from regula.facesdk.webclient.gen.models.recognize_image_data import RecognizeImageData
+    from regula.facesdk.webclient.gen.models.resize_options import ResizeOptions
+    from regula.facesdk.webclient.gen.models.search_bad_params import SearchBadParams
+    from regula.facesdk.webclient.gen.models.search_detection import SearchDetection
+    from regula.facesdk.webclient.gen.models.search_parameters import SearchParameters
+    from regula.facesdk.webclient.gen.models.search_parameters_create_person import SearchParametersCreatePerson
+    from regula.facesdk.webclient.gen.models.search_person import SearchPerson
+    from regula.facesdk.webclient.gen.models.search_person_data import SearchPersonData
+    from regula.facesdk.webclient.gen.models.search_request import SearchRequest
+    from regula.facesdk.webclient.gen.models.search_result import SearchResult
+    from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo
+    from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels
+    from regula.facesdk.webclient.gen.models.update_group import UpdateGroup
+    
+else:
+    from lazy_imports import LazyModule, as_package, load
 
-# import all models into this package
-# if you have many models here with many references from one model to another this may
-# raise a RecursionError
-# to avoid this, import only the models that you directly need like:
-# from from regula.facesdk.webclient.gen.model.pet import Pet
-# or import this package, but before doing it, use:
-# import sys
-# sys.setrecursionlimit(n)
+    load(
+        LazyModule(
+            *as_package(__file__),
+            """# import models into model package
+from regula.facesdk.webclient.gen.models.add_image_to_person_request import AddImageToPersonRequest
+from regula.facesdk.webclient.gen.models.add_image_to_person_request_data import AddImageToPersonRequestData
+from regula.facesdk.webclient.gen.models.add_image_to_person_request_image import AddImageToPersonRequestImage
+from regula.facesdk.webclient.gen.models.add_image_to_person_response import AddImageToPersonResponse
+from regula.facesdk.webclient.gen.models.attribute_config import AttributeConfig
+from regula.facesdk.webclient.gen.models.attributes_data import AttributesData
+from regula.facesdk.webclient.gen.models.crop import Crop
+from regula.facesdk.webclient.gen.models.detail_item import DetailItem
+from regula.facesdk.webclient.gen.models.detect_attributes_details import DetectAttributesDetails
+from regula.facesdk.webclient.gen.models.detect_details_meta import DetectDetailsMeta
+from regula.facesdk.webclient.gen.models.detect_meta_data import DetectMetaData
+from regula.facesdk.webclient.gen.models.detect_request import DetectRequest
+from regula.facesdk.webclient.gen.models.detect_request_data import DetectRequestData
+from regula.facesdk.webclient.gen.models.detect_response import DetectResponse
+from regula.facesdk.webclient.gen.models.detect_response_results import DetectResponseResults
+from regula.facesdk.webclient.gen.models.detect_result import DetectResult
+from regula.facesdk.webclient.gen.models.detection import Detection
+from regula.facesdk.webclient.gen.models.detection_attributes import DetectionAttributes
+from regula.facesdk.webclient.gen.models.detection_attributes_details_inner import DetectionAttributesDetailsInner
+from regula.facesdk.webclient.gen.models.detection_face import DetectionFace
+from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality
+from regula.facesdk.webclient.gen.models.device_info import DeviceInfo
+from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute
+from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType
+from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups
+from regula.facesdk.webclient.gen.models.face_image_quality_groups_strings import FaceImageQualityGroupsStrings
+from regula.facesdk.webclient.gen.models.face_image_quality_status import FaceImageQualityStatus
+from regula.facesdk.webclient.gen.models.face_quality_config_name import FaceQualityConfigName
+from regula.facesdk.webclient.gen.models.face_quality_scenarios import FaceQualityScenarios
+from regula.facesdk.webclient.gen.models.face_sdk_result import FaceSDKResult
+from regula.facesdk.webclient.gen.models.face_sdk_result_code import FaceSDKResultCode
+from regula.facesdk.webclient.gen.models.faces_response import FacesResponse
+from regula.facesdk.webclient.gen.models.faces_response_data import FacesResponseData
+from regula.facesdk.webclient.gen.models.filter_op import FilterOp
+from regula.facesdk.webclient.gen.models.filter_search_request import FilterSearchRequest
+from regula.facesdk.webclient.gen.models.group import Group
+from regula.facesdk.webclient.gen.models.group_data import GroupData
+from regula.facesdk.webclient.gen.models.group_page import GroupPage
+from regula.facesdk.webclient.gen.models.group_page_items import GroupPageItems
+from regula.facesdk.webclient.gen.models.group_response import GroupResponse
+from regula.facesdk.webclient.gen.models.group_to_create import GroupToCreate
+from regula.facesdk.webclient.gen.models.image import Image
+from regula.facesdk.webclient.gen.models.image_fields import ImageFields
+from regula.facesdk.webclient.gen.models.image_fields_image import ImageFieldsImage
+from regula.facesdk.webclient.gen.models.image_page import ImagePage
+from regula.facesdk.webclient.gen.models.image_page_items import ImagePageItems
+from regula.facesdk.webclient.gen.models.image_source import ImageSource
+from regula.facesdk.webclient.gen.models.liveness_type import LivenessType
+from regula.facesdk.webclient.gen.models.match_and_search_request import MatchAndSearchRequest
+from regula.facesdk.webclient.gen.models.match_and_search_request_images_item import MatchAndSearchRequestImagesItem
+from regula.facesdk.webclient.gen.models.match_and_search_response import MatchAndSearchResponse
+from regula.facesdk.webclient.gen.models.match_and_search_response_data import MatchAndSearchResponseData
+from regula.facesdk.webclient.gen.models.match_and_search_response_data_detections_item import MatchAndSearchResponseDataDetectionsItem
+from regula.facesdk.webclient.gen.models.match_image import MatchImage
+from regula.facesdk.webclient.gen.models.match_image_detection import MatchImageDetection
+from regula.facesdk.webclient.gen.models.match_image_result import MatchImageResult
+from regula.facesdk.webclient.gen.models.match_request import MatchRequest
+from regula.facesdk.webclient.gen.models.match_request_data import MatchRequestData
+from regula.facesdk.webclient.gen.models.match_response import MatchResponse
+from regula.facesdk.webclient.gen.models.match_response_data import MatchResponseData
+from regula.facesdk.webclient.gen.models.operation_log import OperationLog
+from regula.facesdk.webclient.gen.models.output_image_params import OutputImageParams
+from regula.facesdk.webclient.gen.models.page import Page
+from regula.facesdk.webclient.gen.models.person import Person
+from regula.facesdk.webclient.gen.models.person_data import PersonData
+from regula.facesdk.webclient.gen.models.person_fields import PersonFields
+from regula.facesdk.webclient.gen.models.person_items import PersonItems
+from regula.facesdk.webclient.gen.models.person_to_update_fields import PersonToUpdateFields
+from regula.facesdk.webclient.gen.models.person_with_images import PersonWithImages
+from regula.facesdk.webclient.gen.models.person_with_images_data import PersonWithImagesData
+from regula.facesdk.webclient.gen.models.persons_page import PersonsPage
+from regula.facesdk.webclient.gen.models.process_param import ProcessParam
+from regula.facesdk.webclient.gen.models.process_param_attributes import ProcessParamAttributes
+from regula.facesdk.webclient.gen.models.quality_config import QualityConfig
+from regula.facesdk.webclient.gen.models.quality_detail import QualityDetail
+from regula.facesdk.webclient.gen.models.quality_details_groups import QualityDetailsGroups
+from regula.facesdk.webclient.gen.models.quality_request import QualityRequest
+from regula.facesdk.webclient.gen.models.recognize_image import RecognizeImage
+from regula.facesdk.webclient.gen.models.recognize_image_data import RecognizeImageData
+from regula.facesdk.webclient.gen.models.resize_options import ResizeOptions
+from regula.facesdk.webclient.gen.models.search_bad_params import SearchBadParams
+from regula.facesdk.webclient.gen.models.search_detection import SearchDetection
+from regula.facesdk.webclient.gen.models.search_parameters import SearchParameters
+from regula.facesdk.webclient.gen.models.search_parameters_create_person import SearchParametersCreatePerson
+from regula.facesdk.webclient.gen.models.search_person import SearchPerson
+from regula.facesdk.webclient.gen.models.search_person_data import SearchPersonData
+from regula.facesdk.webclient.gen.models.search_request import SearchRequest
+from regula.facesdk.webclient.gen.models.search_result import SearchResult
+from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo
+from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels
+from regula.facesdk.webclient.gen.models.update_group import UpdateGroup
 
-from regula.facesdk.webclient.gen.model.add_image_to_person_request import AddImageToPersonRequest
-from regula.facesdk.webclient.gen.model.add_image_to_person_request_image import AddImageToPersonRequestImage
-from regula.facesdk.webclient.gen.model.add_image_to_person_response import AddImageToPersonResponse
-from regula.facesdk.webclient.gen.model.attribute_config import AttributeConfig
-from regula.facesdk.webclient.gen.model.attribute_config_list import AttributeConfigList
-from regula.facesdk.webclient.gen.model.crop import Crop
-from regula.facesdk.webclient.gen.model.detect_attributes_details import DetectAttributesDetails
-from regula.facesdk.webclient.gen.model.detect_details_meta import DetectDetailsMeta
-from regula.facesdk.webclient.gen.model.detect_request import DetectRequest
-from regula.facesdk.webclient.gen.model.detect_response import DetectResponse
-from regula.facesdk.webclient.gen.model.detect_response_all_of import DetectResponseAllOf
-from regula.facesdk.webclient.gen.model.detect_result import DetectResult
-from regula.facesdk.webclient.gen.model.detection import Detection
-from regula.facesdk.webclient.gen.model.detection_attributes import DetectionAttributes
-from regula.facesdk.webclient.gen.model.detection_face import DetectionFace
-from regula.facesdk.webclient.gen.model.detection_quality import DetectionQuality
-from regula.facesdk.webclient.gen.model.device_info import DeviceInfo
-from regula.facesdk.webclient.gen.model.face_attribute import FaceAttribute
-from regula.facesdk.webclient.gen.model.face_image_quality_align_type import FaceImageQualityAlignType
-from regula.facesdk.webclient.gen.model.face_image_quality_groups import FaceImageQualityGroups
-from regula.facesdk.webclient.gen.model.face_image_quality_groups_strings import FaceImageQualityGroupsStrings
-from regula.facesdk.webclient.gen.model.face_image_quality_status import FaceImageQualityStatus
-from regula.facesdk.webclient.gen.model.face_quality_config_name import FaceQualityConfigName
-from regula.facesdk.webclient.gen.model.face_quality_scenarios import FaceQualityScenarios
-from regula.facesdk.webclient.gen.model.face_rectangular import FaceRectangular
-from regula.facesdk.webclient.gen.model.face_sdk_result import FaceSDKResult
-from regula.facesdk.webclient.gen.model.face_sdk_result_code import FaceSDKResultCode
-from regula.facesdk.webclient.gen.model.faces_response import FacesResponse
-from regula.facesdk.webclient.gen.model.faces_response_all_of import FacesResponseAllOf
-from regula.facesdk.webclient.gen.model.filter_op import FilterOp
-from regula.facesdk.webclient.gen.model.filter_search_request import FilterSearchRequest
-from regula.facesdk.webclient.gen.model.group import Group
-from regula.facesdk.webclient.gen.model.group_all_of import GroupAllOf
-from regula.facesdk.webclient.gen.model.group_page import GroupPage
-from regula.facesdk.webclient.gen.model.group_page_all_of import GroupPageAllOf
-from regula.facesdk.webclient.gen.model.group_response import GroupResponse
-from regula.facesdk.webclient.gen.model.group_to_create import GroupToCreate
-from regula.facesdk.webclient.gen.model.image import Image
-from regula.facesdk.webclient.gen.model.image_fields import ImageFields
-from regula.facesdk.webclient.gen.model.image_page import ImagePage
-from regula.facesdk.webclient.gen.model.image_page_all_of import ImagePageAllOf
-from regula.facesdk.webclient.gen.model.image_source import ImageSource
-from regula.facesdk.webclient.gen.model.liveness_type import LivenessType
-from regula.facesdk.webclient.gen.model.match_and_search_request import MatchAndSearchRequest
-from regula.facesdk.webclient.gen.model.match_and_search_request_images import MatchAndSearchRequestImages
-from regula.facesdk.webclient.gen.model.match_and_search_response import MatchAndSearchResponse
-from regula.facesdk.webclient.gen.model.match_and_search_response_all_of import MatchAndSearchResponseAllOf
-from regula.facesdk.webclient.gen.model.match_and_search_response_all_of_detections import MatchAndSearchResponseAllOfDetections
-from regula.facesdk.webclient.gen.model.match_image import MatchImage
-from regula.facesdk.webclient.gen.model.match_image_detection import MatchImageDetection
-from regula.facesdk.webclient.gen.model.match_image_result import MatchImageResult
-from regula.facesdk.webclient.gen.model.match_request import MatchRequest
-from regula.facesdk.webclient.gen.model.match_response import MatchResponse
-from regula.facesdk.webclient.gen.model.match_response_all_of import MatchResponseAllOf
-from regula.facesdk.webclient.gen.model.operation_log import OperationLog
-from regula.facesdk.webclient.gen.model.output_image_params import OutputImageParams
-from regula.facesdk.webclient.gen.model.page import Page
-from regula.facesdk.webclient.gen.model.person import Person
-from regula.facesdk.webclient.gen.model.person_all_of import PersonAllOf
-from regula.facesdk.webclient.gen.model.person_fields import PersonFields
-from regula.facesdk.webclient.gen.model.person_to_update_fields import PersonToUpdateFields
-from regula.facesdk.webclient.gen.model.person_with_images import PersonWithImages
-from regula.facesdk.webclient.gen.model.person_with_images_all_of import PersonWithImagesAllOf
-from regula.facesdk.webclient.gen.model.persons_page import PersonsPage
-from regula.facesdk.webclient.gen.model.persons_page_all_of import PersonsPageAllOf
-from regula.facesdk.webclient.gen.model.process_param import ProcessParam
-from regula.facesdk.webclient.gen.model.process_param_attributes import ProcessParamAttributes
-from regula.facesdk.webclient.gen.model.quality_config import QualityConfig
-from regula.facesdk.webclient.gen.model.quality_config_list import QualityConfigList
-from regula.facesdk.webclient.gen.model.quality_detail import QualityDetail
-from regula.facesdk.webclient.gen.model.quality_details_groups import QualityDetailsGroups
-from regula.facesdk.webclient.gen.model.quality_request import QualityRequest
-from regula.facesdk.webclient.gen.model.rgb import RGB
-from regula.facesdk.webclient.gen.model.recognize_image import RecognizeImage
-from regula.facesdk.webclient.gen.model.recognize_image_all_of import RecognizeImageAllOf
-from regula.facesdk.webclient.gen.model.resize_options import ResizeOptions
-from regula.facesdk.webclient.gen.model.search_bad_params import SearchBadParams
-from regula.facesdk.webclient.gen.model.search_detection import SearchDetection
-from regula.facesdk.webclient.gen.model.search_parameters import SearchParameters
-from regula.facesdk.webclient.gen.model.search_parameters_create_person import SearchParametersCreatePerson
-from regula.facesdk.webclient.gen.model.search_person import SearchPerson
-from regula.facesdk.webclient.gen.model.search_person_all_of import SearchPersonAllOf
-from regula.facesdk.webclient.gen.model.search_request import SearchRequest
-from regula.facesdk.webclient.gen.model.search_request_all_of import SearchRequestAllOf
-from regula.facesdk.webclient.gen.model.search_result import SearchResult
-from regula.facesdk.webclient.gen.model.transaction_info import TransactionInfo
-from regula.facesdk.webclient.gen.model.update_group import UpdateGroup
+""",
+            name=__name__,
+            doc=__doc__,
+        )
+    )

regula/facesdk/webclient/gen/models/add_image_to_person_request.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.facesdk.webclient.gen.models.add_image_to_person_request_image import AddImageToPersonRequestImage
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class AddImageToPersonRequest(BaseModel):
+    """
+    Image in the request data, includes image and contentType.
+    """ # noqa: E501
+    tenant: SkipValidation[Optional[str]] = Field(alias="tenant", default=None, description="A label used to group transactions by customers, applications, or other criteria.")
+    env: SkipValidation[Optional[str]] = Field(alias="env", default=None, description="A label used to differentiate transactions by development stages.")
+    tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator.")
+    image: SkipValidation[AddImageToPersonRequestImage] = Field(alias="image")
+    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
+    limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
+    __properties: ClassVar[List[str]] = ["tenant", "env", "tag", "image", "threshold", "limit"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AddImageToPersonRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of image
+        if self.image:
+            _dict['image'] = self.image.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AddImageToPersonRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenant": obj.get("tenant"),
+            "env": obj.get("env"),
+            "tag": obj.get("tag"),
+            "image": AddImageToPersonRequestImage.from_dict(obj["image"]) if obj.get("image") is not None else None,
+            "threshold": obj.get("threshold"),
+            "limit": obj.get("limit")
+        })
+        return _obj
+
+