regula-documentreader-webclient 8.3.480.dev0__py3-none-any.whl → 8.4.587.dev0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of regula-documentreader-webclient might be problematic. Click here for more details.
- regula/documentreader/webclient/ext/api/document_reader_api.py +18 -4
- regula/documentreader/webclient/gen/__init__.py +755 -239
- regula/documentreader/webclient/gen/api/__init__.py +20 -1
- regula/documentreader/webclient/gen/api/resources_api.py +270 -0
- regula/documentreader/webclient/gen/api/transaction_api.py +33 -15
- regula/documentreader/webclient/gen/api_client.py +8 -1
- regula/documentreader/webclient/gen/models/__init__.py +251 -2
- regula/documentreader/webclient/gen/models/area_array.py +6 -3
- regula/documentreader/webclient/gen/models/area_container.py +6 -3
- regula/documentreader/webclient/gen/models/auth_params.py +19 -16
- regula/documentreader/webclient/gen/models/authenticity_check_list.py +5 -2
- regula/documentreader/webclient/gen/models/authenticity_check_list_item.py +4 -1
- regula/documentreader/webclient/gen/models/authenticity_check_result.py +7 -4
- regula/documentreader/webclient/gen/models/authenticity_check_result_item.py +7 -4
- regula/documentreader/webclient/gen/models/authenticity_result.py +4 -1
- regula/documentreader/webclient/gen/models/barcode_position_item.py +86 -0
- regula/documentreader/webclient/gen/models/barcode_position_result.py +93 -0
- regula/documentreader/webclient/gen/models/bc_pdf417_info.py +9 -6
- regula/documentreader/webclient/gen/models/bc_roidetect.py +7 -4
- regula/documentreader/webclient/gen/models/binary_data.py +67 -64
- regula/documentreader/webclient/gen/models/byte_array_item.py +4 -1
- regula/documentreader/webclient/gen/models/byte_array_result.py +4 -1
- regula/documentreader/webclient/gen/models/candidates_list_item.py +4 -1
- regula/documentreader/webclient/gen/models/certificate_data.py +5 -2
- regula/documentreader/webclient/gen/models/check_diagnose.py +2 -0
- regula/documentreader/webclient/gen/models/chosen_document_type.py +15 -12
- regula/documentreader/webclient/gen/models/chosen_document_type_result.py +5 -2
- regula/documentreader/webclient/gen/models/container_list.py +5 -2
- regula/documentreader/webclient/gen/models/container_list_list_inner.py +34 -20
- regula/documentreader/webclient/gen/models/cross_source_value_comparison.py +6 -3
- regula/documentreader/webclient/gen/models/data_module.py +8 -5
- regula/documentreader/webclient/gen/models/database_document.py +111 -0
- regula/documentreader/webclient/gen/models/database_document_list.py +90 -0
- regula/documentreader/webclient/gen/models/details_optical.py +12 -9
- regula/documentreader/webclient/gen/models/details_rfid.py +10 -7
- regula/documentreader/webclient/gen/models/device_info.py +13 -10
- regula/documentreader/webclient/gen/models/device_info_documents_database.py +7 -4
- regula/documentreader/webclient/gen/models/doc_bar_code_info.py +4 -1
- regula/documentreader/webclient/gen/models/doc_bar_code_info_fields_list.py +5 -2
- regula/documentreader/webclient/gen/models/doc_bar_code_info_item.py +4 -1
- regula/documentreader/webclient/gen/models/doc_graphics_info_item.py +4 -1
- regula/documentreader/webclient/gen/models/doc_visual_extended_field.py +16 -13
- regula/documentreader/webclient/gen/models/doc_visual_extended_field_item.py +4 -1
- regula/documentreader/webclient/gen/models/doc_visual_extended_info.py +5 -2
- regula/documentreader/webclient/gen/models/doc_visual_extended_info_item.py +4 -1
- regula/documentreader/webclient/gen/models/document_binary_info_result.py +4 -1
- regula/documentreader/webclient/gen/models/document_image.py +5 -2
- regula/documentreader/webclient/gen/models/document_image_result.py +4 -1
- regula/documentreader/webclient/gen/models/document_position.py +18 -15
- regula/documentreader/webclient/gen/models/document_position_item.py +4 -1
- regula/documentreader/webclient/gen/models/document_position_result.py +4 -1
- regula/documentreader/webclient/gen/models/document_types_candidates.py +5 -2
- regula/documentreader/webclient/gen/models/document_types_candidates_list.py +5 -2
- regula/documentreader/webclient/gen/models/document_types_candidates_result.py +4 -1
- regula/documentreader/webclient/gen/models/documents_database.py +7 -4
- regula/documentreader/webclient/gen/models/encrypted_rcl_item.py +4 -1
- regula/documentreader/webclient/gen/models/encrypted_rcl_result.py +4 -1
- regula/documentreader/webclient/gen/models/error_coordinates.py +7 -4
- regula/documentreader/webclient/gen/models/face_api.py +13 -10
- regula/documentreader/webclient/gen/models/face_api_search.py +7 -4
- regula/documentreader/webclient/gen/models/face_detection.py +8 -5
- regula/documentreader/webclient/gen/models/face_detection_item.py +4 -1
- regula/documentreader/webclient/gen/models/face_detection_result.py +4 -1
- regula/documentreader/webclient/gen/models/face_item.py +11 -8
- regula/documentreader/webclient/gen/models/fdsid_list.py +15 -12
- regula/documentreader/webclient/gen/models/fiber_item.py +12 -9
- regula/documentreader/webclient/gen/models/fiber_result.py +12 -9
- regula/documentreader/webclient/gen/models/field_item.py +9 -6
- regula/documentreader/webclient/gen/models/file_image.py +5 -2
- regula/documentreader/webclient/gen/models/get_transactions_by_tag_response.py +8 -4
- regula/documentreader/webclient/gen/models/glares_check_params.py +84 -0
- regula/documentreader/webclient/gen/models/graph_data.py +10 -7
- regula/documentreader/webclient/gen/models/graphic_field.py +7 -4
- regula/documentreader/webclient/gen/models/graphic_fields_list.py +5 -2
- regula/documentreader/webclient/gen/models/graphics_result.py +4 -1
- regula/documentreader/webclient/gen/models/healthcheck.py +12 -9
- regula/documentreader/webclient/gen/models/healthcheck_documents_database.py +7 -4
- regula/documentreader/webclient/gen/models/ident_item.py +10 -7
- regula/documentreader/webclient/gen/models/ident_result.py +10 -7
- regula/documentreader/webclient/gen/models/image_data.py +5 -2
- regula/documentreader/webclient/gen/models/image_qa.py +20 -11
- regula/documentreader/webclient/gen/models/image_quality_check.py +10 -7
- regula/documentreader/webclient/gen/models/image_quality_check_list.py +6 -3
- regula/documentreader/webclient/gen/models/image_quality_check_list_item.py +4 -1
- regula/documentreader/webclient/gen/models/image_quality_result.py +4 -1
- regula/documentreader/webclient/gen/models/image_transaction_data.py +4 -1
- regula/documentreader/webclient/gen/models/images.py +7 -4
- regula/documentreader/webclient/gen/models/images_available_source.py +5 -2
- regula/documentreader/webclient/gen/models/images_field.py +7 -4
- regula/documentreader/webclient/gen/models/images_field_value.py +12 -9
- regula/documentreader/webclient/gen/models/images_item.py +4 -1
- regula/documentreader/webclient/gen/models/images_result.py +4 -1
- regula/documentreader/webclient/gen/models/in_data.py +5 -2
- regula/documentreader/webclient/gen/models/in_data_transaction_images_field_value.py +7 -4
- regula/documentreader/webclient/gen/models/in_data_video.py +5 -2
- regula/documentreader/webclient/gen/models/lexical_analysis_result.py +4 -1
- regula/documentreader/webclient/gen/models/license_item.py +4 -1
- regula/documentreader/webclient/gen/models/license_result.py +4 -1
- regula/documentreader/webclient/gen/models/list_transactions_by_tag_response.py +5 -2
- regula/documentreader/webclient/gen/models/list_verified_fields.py +6 -3
- regula/documentreader/webclient/gen/models/list_verified_fields_item.py +4 -1
- regula/documentreader/webclient/gen/models/liveness_params.py +10 -7
- regula/documentreader/webclient/gen/models/mrz_detector_result.py +4 -1
- regula/documentreader/webclient/gen/models/mrz_position_item.py +4 -1
- regula/documentreader/webclient/gen/models/mrz_position_result.py +4 -1
- regula/documentreader/webclient/gen/models/mrz_rows_item.py +6 -3
- regula/documentreader/webclient/gen/models/mrz_test_quality.py +13 -10
- regula/documentreader/webclient/gen/models/mrz_test_quality_item.py +4 -1
- regula/documentreader/webclient/gen/models/mrz_test_quality_result.py +4 -1
- regula/documentreader/webclient/gen/models/ocr_security_text_item.py +14 -11
- regula/documentreader/webclient/gen/models/ocr_security_text_result.py +14 -11
- regula/documentreader/webclient/gen/models/one_candidate.py +15 -12
- regula/documentreader/webclient/gen/models/one_candidate_item.py +5 -2
- regula/documentreader/webclient/gen/models/original_symbol.py +6 -3
- regula/documentreader/webclient/gen/models/out_data.py +5 -2
- regula/documentreader/webclient/gen/models/out_data_transaction_images_field_value.py +8 -5
- regula/documentreader/webclient/gen/models/p_array_field.py +13 -10
- regula/documentreader/webclient/gen/models/parsed_data.py +4 -1
- regula/documentreader/webclient/gen/models/per_document_config.py +5 -2
- regula/documentreader/webclient/gen/models/photo_ident_item.py +12 -9
- regula/documentreader/webclient/gen/models/photo_ident_result.py +12 -9
- regula/documentreader/webclient/gen/models/point.py +5 -2
- regula/documentreader/webclient/gen/models/point_array.py +4 -1
- regula/documentreader/webclient/gen/models/points_container.py +5 -2
- regula/documentreader/webclient/gen/models/process_params.py +72 -67
- regula/documentreader/webclient/gen/models/process_params_rfid.py +4 -1
- regula/documentreader/webclient/gen/models/process_request.py +15 -12
- regula/documentreader/webclient/gen/models/process_request_image.py +6 -3
- regula/documentreader/webclient/gen/models/process_response.py +13 -10
- regula/documentreader/webclient/gen/models/process_system_info.py +5 -2
- regula/documentreader/webclient/gen/models/raw_image_container_item.py +4 -1
- regula/documentreader/webclient/gen/models/raw_image_container_list.py +5 -2
- regula/documentreader/webclient/gen/models/rectangle_coordinates.py +7 -4
- regula/documentreader/webclient/gen/models/result_item.py +14 -11
- regula/documentreader/webclient/gen/models/result_mrz_detector.py +7 -4
- regula/documentreader/webclient/gen/models/result_mrz_detector_item.py +4 -1
- regula/documentreader/webclient/gen/models/rfid_access_control_info.py +8 -5
- regula/documentreader/webclient/gen/models/rfid_access_key.py +7 -4
- regula/documentreader/webclient/gen/models/rfid_application.py +10 -7
- regula/documentreader/webclient/gen/models/rfid_application_type.py +1 -2
- regula/documentreader/webclient/gen/models/rfid_attribute_data.py +5 -2
- regula/documentreader/webclient/gen/models/rfid_attribute_name.py +5 -2
- regula/documentreader/webclient/gen/models/rfid_card_properties_ext.py +17 -14
- regula/documentreader/webclient/gen/models/rfid_certificate_ex.py +16 -13
- regula/documentreader/webclient/gen/models/rfid_data_file.py +15 -12
- regula/documentreader/webclient/gen/models/rfid_dg1.py +19 -17
- regula/documentreader/webclient/gen/models/rfid_distinguished_name.py +6 -3
- regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field.py +19 -16
- regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field_item.py +7 -4
- regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_info.py +5 -2
- regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_info_item.py +4 -1
- regula/documentreader/webclient/gen/models/rfid_graphics_info_result.py +4 -1
- regula/documentreader/webclient/gen/models/rfid_origin.py +7 -4
- regula/documentreader/webclient/gen/models/rfid_pki_extension.py +5 -2
- regula/documentreader/webclient/gen/models/rfid_raw_data.py +5 -2
- regula/documentreader/webclient/gen/models/rfid_security_object.py +8 -5
- regula/documentreader/webclient/gen/models/rfid_session_data.py +20 -17
- regula/documentreader/webclient/gen/models/rfid_signer_info_ex.py +15 -12
- regula/documentreader/webclient/gen/models/rfid_terminal.py +6 -3
- regula/documentreader/webclient/gen/models/rfid_text_data_result.py +4 -1
- regula/documentreader/webclient/gen/models/rfid_validity.py +5 -2
- regula/documentreader/webclient/gen/models/security_feature_item.py +9 -6
- regula/documentreader/webclient/gen/models/security_feature_result.py +9 -6
- regula/documentreader/webclient/gen/models/security_feature_type.py +2 -0
- regula/documentreader/webclient/gen/models/security_object_certificates.py +4 -1
- regula/documentreader/webclient/gen/models/source.py +2 -0
- regula/documentreader/webclient/gen/models/source_validity.py +5 -2
- regula/documentreader/webclient/gen/models/status.py +10 -7
- regula/documentreader/webclient/gen/models/status_item.py +4 -1
- regula/documentreader/webclient/gen/models/status_result.py +4 -1
- regula/documentreader/webclient/gen/models/string_item.py +20 -17
- regula/documentreader/webclient/gen/models/string_recognition_result.py +8 -5
- regula/documentreader/webclient/gen/models/symbol.py +4 -1
- regula/documentreader/webclient/gen/models/symbol_candidate.py +7 -4
- regula/documentreader/webclient/gen/models/symbol_estimation_item.py +20 -17
- regula/documentreader/webclient/gen/models/symbol_recognition_result.py +8 -5
- regula/documentreader/webclient/gen/models/t_doc_binary_info.py +5 -2
- regula/documentreader/webclient/gen/models/t_doc_binary_info_item.py +4 -1
- regula/documentreader/webclient/gen/models/t_original_rfid_graphics_info.py +4 -1
- regula/documentreader/webclient/gen/models/t_original_rfid_graphics_info_item.py +4 -1
- regula/documentreader/webclient/gen/models/text.py +9 -6
- regula/documentreader/webclient/gen/models/text_available_source.py +6 -3
- regula/documentreader/webclient/gen/models/text_data_result.py +4 -1
- regula/documentreader/webclient/gen/models/text_field.py +14 -11
- regula/documentreader/webclient/gen/models/text_field_value.py +13 -10
- regula/documentreader/webclient/gen/models/text_item.py +4 -1
- regula/documentreader/webclient/gen/models/text_result.py +4 -1
- regula/documentreader/webclient/gen/models/transaction_image.py +4 -1
- regula/documentreader/webclient/gen/models/transaction_info.py +11 -8
- regula/documentreader/webclient/gen/models/transaction_process_get_response.py +8 -4
- regula/documentreader/webclient/gen/models/transaction_process_request.py +14 -11
- regula/documentreader/webclient/gen/models/transaction_process_result.py +8 -4
- regula/documentreader/webclient/gen/models/trf_ft_bytes.py +7 -4
- regula/documentreader/webclient/gen/models/trf_ft_string.py +7 -4
- regula/documentreader/webclient/gen/models/verified_field_map.py +10 -7
- regula/documentreader/webclient/gen/models/visual_extended_field_item.py +15 -12
- {regula_documentreader_webclient-8.3.480.dev0.dist-info → regula_documentreader_webclient-8.4.587.dev0.dist-info}/METADATA +2 -1
- {regula_documentreader_webclient-8.3.480.dev0.dist-info → regula_documentreader_webclient-8.4.587.dev0.dist-info}/RECORD +200 -194
- {regula_documentreader_webclient-8.3.480.dev0.dist-info → regula_documentreader_webclient-8.4.587.dev0.dist-info}/WHEEL +0 -0
- {regula_documentreader_webclient-8.3.480.dev0.dist-info → regula_documentreader_webclient-8.4.587.dev0.dist-info}/top_level.txt +0 -0
|
@@ -15,6 +15,7 @@ from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
|
15
15
|
from regula.documentreader.webclient.gen.models.result import Result
|
|
16
16
|
from typing import Optional, Set
|
|
17
17
|
from typing_extensions import Self
|
|
18
|
+
from pydantic import SkipValidation, Field
|
|
18
19
|
|
|
19
20
|
from typing import TYPE_CHECKING
|
|
20
21
|
if TYPE_CHECKING:
|
|
@@ -47,7 +48,7 @@ if TYPE_CHECKING:
|
|
|
47
48
|
from regula.documentreader.webclient.gen.models.license_result import LicenseResult
|
|
48
49
|
from regula.documentreader.webclient.gen.models.graphics_result import GraphicsResult
|
|
49
50
|
from regula.documentreader.webclient.gen.models.mrz_position_result import MRZPositionResult
|
|
50
|
-
from regula.documentreader.webclient.gen.models.
|
|
51
|
+
from regula.documentreader.webclient.gen.models.barcode_position_result import BarcodePositionResult
|
|
51
52
|
from regula.documentreader.webclient.gen.models.mrz_test_quality_result import MRZTestQualityResult
|
|
52
53
|
from regula.documentreader.webclient.gen.models.document_types_candidates_result import DocumentTypesCandidatesResult
|
|
53
54
|
from regula.documentreader.webclient.gen.models.document_position_result import DocumentPositionResult
|
|
@@ -59,17 +60,19 @@ class ResultItem(BaseModel):
|
|
|
59
60
|
"""
|
|
60
61
|
Common fields for all result objects
|
|
61
62
|
""" # noqa: E501
|
|
62
|
-
buf_length: Optional[
|
|
63
|
-
light: Optional[
|
|
64
|
-
list_idx: Optional[
|
|
65
|
-
page_idx: Optional[
|
|
66
|
-
result_type: Result
|
|
63
|
+
buf_length: SkipValidation[Optional[int]] = Field(alias="buf_length", default=None)
|
|
64
|
+
light: SkipValidation[Optional[int]] = Field(alias="light", default=None)
|
|
65
|
+
list_idx: SkipValidation[Optional[int]] = Field(alias="list_idx", default=None)
|
|
66
|
+
page_idx: SkipValidation[Optional[int]] = Field(alias="page_idx", default=None)
|
|
67
|
+
result_type: SkipValidation[Result] = Field(alias="result_type")
|
|
67
68
|
__properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type"]
|
|
68
69
|
|
|
69
70
|
model_config = ConfigDict(
|
|
70
71
|
populate_by_name=True,
|
|
71
72
|
validate_assignment=True,
|
|
72
73
|
protected_namespaces=(),
|
|
74
|
+
arbitrary_types_allowed=True,
|
|
75
|
+
use_enum_values=True
|
|
73
76
|
)
|
|
74
77
|
|
|
75
78
|
|
|
@@ -78,7 +81,7 @@ class ResultItem(BaseModel):
|
|
|
78
81
|
|
|
79
82
|
# discriminator mappings
|
|
80
83
|
__discriminator_value_class_map: ClassVar[Dict[str, str]] = {
|
|
81
|
-
'1': 'DocumentImageResult','101': 'DocumentBinaryInfoResult','102': 'RFIDTextDataResult','103': 'GraphicsResult','104': 'DocumentBinaryInfoResult','105': 'RFIDGraphicsInfoResult','109': 'ByteArrayResult','15': 'LexicalAnalysisResult','16': 'DocumentImageResult','17': 'TextDataResult','18': 'TextDataResult','19': 'GraphicsResult','20': 'AuthenticityResult','26': 'TextDataResult','3': 'TextDataResult','30': 'ImageQualityResult','32': 'GraphicsResult','33': 'StatusResult','34': 'AuthenticityResult','35': 'GraphicsResult','36': 'TextResult','37': 'ImagesResult','38': 'GraphicsResult','39': 'AuthenticityResult','49': 'EncryptedRCLResult','5': 'DocBarCodeInfo','50': 'LicenseResult','6': 'GraphicsResult','61': 'MRZPositionResult','62': '
|
|
84
|
+
'1': 'DocumentImageResult','101': 'DocumentBinaryInfoResult','102': 'RFIDTextDataResult','103': 'GraphicsResult','104': 'DocumentBinaryInfoResult','105': 'RFIDGraphicsInfoResult','109': 'ByteArrayResult','15': 'LexicalAnalysisResult','16': 'DocumentImageResult','17': 'TextDataResult','18': 'TextDataResult','19': 'GraphicsResult','20': 'AuthenticityResult','26': 'TextDataResult','3': 'TextDataResult','30': 'ImageQualityResult','32': 'GraphicsResult','33': 'StatusResult','34': 'AuthenticityResult','35': 'GraphicsResult','36': 'TextResult','37': 'ImagesResult','38': 'GraphicsResult','39': 'AuthenticityResult','49': 'EncryptedRCLResult','5': 'DocBarCodeInfo','50': 'LicenseResult','6': 'GraphicsResult','61': 'MRZPositionResult','62': 'BarcodePositionResult','7': 'MRZTestQualityResult','8': 'DocumentTypesCandidatesResult','85': 'DocumentPositionResult','87': 'MRZDetectorResult','9': 'ChosenDocumentTypeResult','97': 'FaceDetectionResult'
|
|
82
85
|
}
|
|
83
86
|
|
|
84
87
|
@classmethod
|
|
@@ -100,7 +103,7 @@ class ResultItem(BaseModel):
|
|
|
100
103
|
return json.dumps(self.to_dict())
|
|
101
104
|
|
|
102
105
|
@classmethod
|
|
103
|
-
def from_json(cls, json_str: str) -> Optional[Union[DocumentImageResult, DocumentBinaryInfoResult, RFIDTextDataResult, GraphicsResult, DocumentBinaryInfoResult, RFIDGraphicsInfoResult, ByteArrayResult, LexicalAnalysisResult, DocumentImageResult, TextDataResult, TextDataResult, GraphicsResult, AuthenticityResult, TextDataResult, TextDataResult, ImageQualityResult, GraphicsResult, StatusResult, AuthenticityResult, GraphicsResult, TextResult, ImagesResult, GraphicsResult, AuthenticityResult, EncryptedRCLResult, DocBarCodeInfo, LicenseResult, GraphicsResult, MRZPositionResult,
|
|
106
|
+
def from_json(cls, json_str: str) -> Optional[Union[DocumentImageResult, DocumentBinaryInfoResult, RFIDTextDataResult, GraphicsResult, DocumentBinaryInfoResult, RFIDGraphicsInfoResult, ByteArrayResult, LexicalAnalysisResult, DocumentImageResult, TextDataResult, TextDataResult, GraphicsResult, AuthenticityResult, TextDataResult, TextDataResult, ImageQualityResult, GraphicsResult, StatusResult, AuthenticityResult, GraphicsResult, TextResult, ImagesResult, GraphicsResult, AuthenticityResult, EncryptedRCLResult, DocBarCodeInfo, LicenseResult, GraphicsResult, MRZPositionResult, BarcodePositionResult, MRZTestQualityResult, DocumentTypesCandidatesResult, DocumentPositionResult, MRZDetectorResult, ChosenDocumentTypeResult, FaceDetectionResult]]:
|
|
104
107
|
"""Create an instance of ResultItem from a JSON string"""
|
|
105
108
|
return cls.from_dict(json.loads(json_str))
|
|
106
109
|
|
|
@@ -125,7 +128,7 @@ class ResultItem(BaseModel):
|
|
|
125
128
|
return _dict
|
|
126
129
|
|
|
127
130
|
@classmethod
|
|
128
|
-
def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[DocumentImageResult, DocumentBinaryInfoResult, RFIDTextDataResult, GraphicsResult, DocumentBinaryInfoResult, RFIDGraphicsInfoResult, ByteArrayResult, LexicalAnalysisResult, DocumentImageResult, TextDataResult, TextDataResult, GraphicsResult, AuthenticityResult, TextDataResult, TextDataResult, ImageQualityResult, GraphicsResult, StatusResult, AuthenticityResult, GraphicsResult, TextResult, ImagesResult, GraphicsResult, AuthenticityResult, EncryptedRCLResult, DocBarCodeInfo, LicenseResult, GraphicsResult, MRZPositionResult,
|
|
131
|
+
def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[DocumentImageResult, DocumentBinaryInfoResult, RFIDTextDataResult, GraphicsResult, DocumentBinaryInfoResult, RFIDGraphicsInfoResult, ByteArrayResult, LexicalAnalysisResult, DocumentImageResult, TextDataResult, TextDataResult, GraphicsResult, AuthenticityResult, TextDataResult, TextDataResult, ImageQualityResult, GraphicsResult, StatusResult, AuthenticityResult, GraphicsResult, TextResult, ImagesResult, GraphicsResult, AuthenticityResult, EncryptedRCLResult, DocBarCodeInfo, LicenseResult, GraphicsResult, MRZPositionResult, BarcodePositionResult, MRZTestQualityResult, DocumentTypesCandidatesResult, DocumentPositionResult, MRZDetectorResult, ChosenDocumentTypeResult, FaceDetectionResult]]:
|
|
129
132
|
"""Create an instance of ResultItem from a dict"""
|
|
130
133
|
# look up the object type based on discriminator mapping
|
|
131
134
|
object_type = cls.get_discriminator_value(obj)
|
|
@@ -187,8 +190,8 @@ class ResultItem(BaseModel):
|
|
|
187
190
|
return import_module("regula.documentreader.webclient.gen.models.graphics_result").GraphicsResult.from_dict(obj)
|
|
188
191
|
if object_type == 'MRZPositionResult':
|
|
189
192
|
return import_module("regula.documentreader.webclient.gen.models.mrz_position_result").MRZPositionResult.from_dict(obj)
|
|
190
|
-
if object_type == '
|
|
191
|
-
return import_module("regula.documentreader.webclient.gen.models.
|
|
193
|
+
if object_type == 'BarcodePositionResult':
|
|
194
|
+
return import_module("regula.documentreader.webclient.gen.models.barcode_position_result").BarcodePositionResult.from_dict(obj)
|
|
192
195
|
if object_type == 'MRZTestQualityResult':
|
|
193
196
|
return import_module("regula.documentreader.webclient.gen.models.mrz_test_quality_result").MRZTestQualityResult.from_dict(obj)
|
|
194
197
|
if object_type == 'DocumentTypesCandidatesResult':
|
|
@@ -14,21 +14,24 @@ from typing import Any, ClassVar, Dict, List, Union
|
|
|
14
14
|
from regula.documentreader.webclient.gen.models.mrz_rows_item import MRZRowsItem
|
|
15
15
|
from typing import Optional, Set
|
|
16
16
|
from typing_extensions import Self
|
|
17
|
+
from pydantic import SkipValidation, Field
|
|
17
18
|
|
|
18
19
|
class ResultMRZDetector(BaseModel):
|
|
19
20
|
"""
|
|
20
21
|
ResultMRZDetector
|
|
21
22
|
""" # noqa: E501
|
|
22
|
-
mrz_format:
|
|
23
|
-
mrz_rows: List[MRZRowsItem] = Field(alias="MRZRows")
|
|
24
|
-
mrz_rows_num:
|
|
25
|
-
bounding_quadrangle: List[
|
|
23
|
+
mrz_format: SkipValidation[int] = Field(alias="MRZFormat")
|
|
24
|
+
mrz_rows: SkipValidation[List[MRZRowsItem]] = Field(alias="MRZRows")
|
|
25
|
+
mrz_rows_num: SkipValidation[int] = Field(alias="MRZRowsNum")
|
|
26
|
+
bounding_quadrangle: SkipValidation[List[float]] = Field(alias="boundingQuadrangle")
|
|
26
27
|
__properties: ClassVar[List[str]] = ["MRZFormat", "MRZRows", "MRZRowsNum", "boundingQuadrangle"]
|
|
27
28
|
|
|
28
29
|
model_config = ConfigDict(
|
|
29
30
|
populate_by_name=True,
|
|
30
31
|
validate_assignment=True,
|
|
31
32
|
protected_namespaces=(),
|
|
33
|
+
arbitrary_types_allowed=True,
|
|
34
|
+
use_enum_values=True
|
|
32
35
|
)
|
|
33
36
|
|
|
34
37
|
|
|
@@ -14,18 +14,21 @@ from typing import Any, ClassVar, Dict, List
|
|
|
14
14
|
from regula.documentreader.webclient.gen.models.result_mrz_detector import ResultMRZDetector
|
|
15
15
|
from typing import Optional, Set
|
|
16
16
|
from typing_extensions import Self
|
|
17
|
+
from pydantic import SkipValidation, Field
|
|
17
18
|
|
|
18
19
|
class ResultMRZDetectorItem(BaseModel):
|
|
19
20
|
"""
|
|
20
21
|
ResultMRZDetectorItem
|
|
21
22
|
""" # noqa: E501
|
|
22
|
-
result_mrz_detector: ResultMRZDetector = Field(alias="ResultMRZDetector")
|
|
23
|
+
result_mrz_detector: SkipValidation[ResultMRZDetector] = Field(alias="ResultMRZDetector")
|
|
23
24
|
__properties: ClassVar[List[str]] = ["ResultMRZDetector"]
|
|
24
25
|
|
|
25
26
|
model_config = ConfigDict(
|
|
26
27
|
populate_by_name=True,
|
|
27
28
|
validate_assignment=True,
|
|
28
29
|
protected_namespaces=(),
|
|
30
|
+
arbitrary_types_allowed=True,
|
|
31
|
+
use_enum_values=True
|
|
29
32
|
)
|
|
30
33
|
|
|
31
34
|
|
|
@@ -15,22 +15,25 @@ from regula.documentreader.webclient.gen.models.rfid_access_control_procedure_ty
|
|
|
15
15
|
from regula.documentreader.webclient.gen.models.rfid_error_codes import RFIDErrorCodes
|
|
16
16
|
from typing import Optional, Set
|
|
17
17
|
from typing_extensions import Self
|
|
18
|
+
from pydantic import SkipValidation, Field
|
|
18
19
|
|
|
19
20
|
class RfidAccessControlInfo(BaseModel):
|
|
20
21
|
"""
|
|
21
22
|
Structure is used to describe the results of a single authentication procedure or a procedure of secure data access within the context of the communication session with electronic document
|
|
22
23
|
""" # noqa: E501
|
|
23
|
-
type: RfidAccessControlProcedureType = Field(alias="Type")
|
|
24
|
-
status: RFIDErrorCodes = Field(alias="Status")
|
|
25
|
-
active_option_idx: Optional[
|
|
26
|
-
notifications: List[
|
|
27
|
-
access_control_options: Optional[List[
|
|
24
|
+
type: SkipValidation[RfidAccessControlProcedureType] = Field(alias="Type")
|
|
25
|
+
status: SkipValidation[RFIDErrorCodes] = Field(alias="Status")
|
|
26
|
+
active_option_idx: SkipValidation[Optional[float]] = Field(alias="ActiveOptionIdx", default=None, description="Index of the active variant of the procedure")
|
|
27
|
+
notifications: SkipValidation[List[int]] = Field(alias="Notifications", description="List of remarks arisen during the procedure. Can be ParsingErrorCodes or ParsingNotificationCodes enum.")
|
|
28
|
+
access_control_options: SkipValidation[Optional[List[object]]] = Field(alias="AccessControlOptions", default=None, description="List of structures with are used to describe the variants of the authentication or secure data access procedure performance within the context of the communication session with electronic document")
|
|
28
29
|
__properties: ClassVar[List[str]] = ["Type", "Status", "ActiveOptionIdx", "Notifications", "AccessControlOptions"]
|
|
29
30
|
|
|
30
31
|
model_config = ConfigDict(
|
|
31
32
|
populate_by_name=True,
|
|
32
33
|
validate_assignment=True,
|
|
33
34
|
protected_namespaces=(),
|
|
35
|
+
arbitrary_types_allowed=True,
|
|
36
|
+
use_enum_values=True
|
|
34
37
|
)
|
|
35
38
|
|
|
36
39
|
|
|
@@ -15,21 +15,24 @@ from regula.documentreader.webclient.gen.models.rfid_access_control_procedure_ty
|
|
|
15
15
|
from regula.documentreader.webclient.gen.models.rfid_password_type import RfidPasswordType
|
|
16
16
|
from typing import Optional, Set
|
|
17
17
|
from typing_extensions import Self
|
|
18
|
+
from pydantic import SkipValidation, Field
|
|
18
19
|
|
|
19
20
|
class RfidAccessKey(BaseModel):
|
|
20
21
|
"""
|
|
21
22
|
Structure is used to describe the contents of secure data access key within the context of the communication session with electronic document
|
|
22
23
|
""" # noqa: E501
|
|
23
|
-
access_key:
|
|
24
|
-
key_type: RfidPasswordType = Field(alias="KeyType")
|
|
25
|
-
access_type: RfidAccessControlProcedureType = Field(alias="AccessType")
|
|
26
|
-
check_full_key_matching:
|
|
24
|
+
access_key: SkipValidation[str] = Field(alias="AccessKey", description="Key contents")
|
|
25
|
+
key_type: SkipValidation[RfidPasswordType] = Field(alias="KeyType")
|
|
26
|
+
access_type: SkipValidation[RfidAccessControlProcedureType] = Field(alias="AccessType")
|
|
27
|
+
check_full_key_matching: SkipValidation[bool] = Field(alias="CheckFullKeyMatching", description="Logical sign of the need for a full comparison of AccessKey contents with the contents of DG1 (MRZ) data group")
|
|
27
28
|
__properties: ClassVar[List[str]] = ["AccessKey", "KeyType", "AccessType", "CheckFullKeyMatching"]
|
|
28
29
|
|
|
29
30
|
model_config = ConfigDict(
|
|
30
31
|
populate_by_name=True,
|
|
31
32
|
validate_assignment=True,
|
|
32
33
|
protected_namespaces=(),
|
|
34
|
+
arbitrary_types_allowed=True,
|
|
35
|
+
use_enum_values=True
|
|
33
36
|
)
|
|
34
37
|
|
|
35
38
|
|
|
@@ -16,24 +16,27 @@ from regula.documentreader.webclient.gen.models.rfid_data_file import RfidDataFi
|
|
|
16
16
|
from regula.documentreader.webclient.gen.models.rfid_error_codes import RFIDErrorCodes
|
|
17
17
|
from typing import Optional, Set
|
|
18
18
|
from typing_extensions import Self
|
|
19
|
+
from pydantic import SkipValidation, Field
|
|
19
20
|
|
|
20
21
|
class RfidApplication(BaseModel):
|
|
21
22
|
"""
|
|
22
23
|
Structure is used to describe the contents of a single LDS application and their analysis within the context of the communication session with electronic document
|
|
23
24
|
""" # noqa: E501
|
|
24
|
-
type: RfidApplicationType = Field(alias="Type")
|
|
25
|
-
status: RFIDErrorCodes = Field(alias="Status")
|
|
26
|
-
application_id:
|
|
27
|
-
version:
|
|
28
|
-
unicode_version:
|
|
29
|
-
data_hash_algorithm:
|
|
30
|
-
files: List[RfidDataFile] = Field(description="List of containers to store information about the read files of the application"
|
|
25
|
+
type: SkipValidation[RfidApplicationType] = Field(alias="Type")
|
|
26
|
+
status: SkipValidation[RFIDErrorCodes] = Field(alias="Status")
|
|
27
|
+
application_id: SkipValidation[str] = Field(alias="ApplicationID", description="Application identifier")
|
|
28
|
+
version: SkipValidation[str] = Field(alias="Version", description="Version of the application")
|
|
29
|
+
unicode_version: SkipValidation[str] = Field(alias="UnicodeVersion", description="Unicode version for application")
|
|
30
|
+
data_hash_algorithm: SkipValidation[str] = Field(alias="DataHashAlgorithm", description="Algorithm for calculating hash values for files for the procedure of PA")
|
|
31
|
+
files: SkipValidation[List[RfidDataFile]] = Field(alias="Files", description="List of containers to store information about the read files of the application")
|
|
31
32
|
__properties: ClassVar[List[str]] = ["Type", "Status", "ApplicationID", "Version", "UnicodeVersion", "DataHashAlgorithm", "Files"]
|
|
32
33
|
|
|
33
34
|
model_config = ConfigDict(
|
|
34
35
|
populate_by_name=True,
|
|
35
36
|
validate_assignment=True,
|
|
36
37
|
protected_namespaces=(),
|
|
38
|
+
arbitrary_types_allowed=True,
|
|
39
|
+
use_enum_values=True
|
|
37
40
|
)
|
|
38
41
|
|
|
39
42
|
|
|
@@ -18,7 +18,7 @@ class RfidApplicationType(int, Enum):
|
|
|
18
18
|
"""
|
|
19
19
|
allowed enum values
|
|
20
20
|
"""
|
|
21
|
-
|
|
21
|
+
ROOT_FILES = 0
|
|
22
22
|
E_PASSPORT = 1
|
|
23
23
|
E_ID = 2
|
|
24
24
|
E_SIGN = 3
|
|
@@ -27,7 +27,6 @@ class RfidApplicationType(int, Enum):
|
|
|
27
27
|
LDS2_VisaRecords = 6
|
|
28
28
|
LDS2_AddBiometrics = 7
|
|
29
29
|
eDTC_PC = 8
|
|
30
|
-
ROOT_FILES = 0
|
|
31
30
|
|
|
32
31
|
@classmethod
|
|
33
32
|
def from_json(cls, json_str: str) -> Self:
|
|
@@ -13,19 +13,22 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
|
|
|
13
13
|
from typing import Any, ClassVar, Dict, List
|
|
14
14
|
from typing import Optional, Set
|
|
15
15
|
from typing_extensions import Self
|
|
16
|
+
from pydantic import SkipValidation, Field
|
|
16
17
|
|
|
17
18
|
class RfidAttributeData(BaseModel):
|
|
18
19
|
"""
|
|
19
20
|
Structure contains the data of one attribute of the digital signature object.
|
|
20
21
|
""" # noqa: E501
|
|
21
|
-
type:
|
|
22
|
-
data:
|
|
22
|
+
type: SkipValidation[str] = Field(alias="Type", description="Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)")
|
|
23
|
+
data: SkipValidation[str] = Field(alias="Data", description="Attribute binary data. Base64 encoded.")
|
|
23
24
|
__properties: ClassVar[List[str]] = ["Type", "Data"]
|
|
24
25
|
|
|
25
26
|
model_config = ConfigDict(
|
|
26
27
|
populate_by_name=True,
|
|
27
28
|
validate_assignment=True,
|
|
28
29
|
protected_namespaces=(),
|
|
30
|
+
arbitrary_types_allowed=True,
|
|
31
|
+
use_enum_values=True
|
|
29
32
|
)
|
|
30
33
|
|
|
31
34
|
|
|
@@ -14,19 +14,22 @@ from typing import Any, ClassVar, Dict, List
|
|
|
14
14
|
from regula.documentreader.webclient.gen.models.trf_ft_string import TrfFtString
|
|
15
15
|
from typing import Optional, Set
|
|
16
16
|
from typing_extensions import Self
|
|
17
|
+
from pydantic import SkipValidation, Field
|
|
17
18
|
|
|
18
19
|
class RfidAttributeName(BaseModel):
|
|
19
20
|
"""
|
|
20
21
|
Structure contains information that serves as the distinguished name (identifier) of an object.
|
|
21
22
|
""" # noqa: E501
|
|
22
|
-
type:
|
|
23
|
-
value: TrfFtString = Field(alias="Value")
|
|
23
|
+
type: SkipValidation[str] = Field(alias="Type", description="Attribute identifier (OID ASCII string); contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)")
|
|
24
|
+
value: SkipValidation[TrfFtString] = Field(alias="Value")
|
|
24
25
|
__properties: ClassVar[List[str]] = ["Type", "Value"]
|
|
25
26
|
|
|
26
27
|
model_config = ConfigDict(
|
|
27
28
|
populate_by_name=True,
|
|
28
29
|
validate_assignment=True,
|
|
29
30
|
protected_namespaces=(),
|
|
31
|
+
arbitrary_types_allowed=True,
|
|
32
|
+
use_enum_values=True
|
|
30
33
|
)
|
|
31
34
|
|
|
32
35
|
|
|
@@ -16,31 +16,34 @@ from regula.documentreader.webclient.gen.models.rfid_baud_rate import RfidBaudRa
|
|
|
16
16
|
from regula.documentreader.webclient.gen.models.rfid_type import RfidType
|
|
17
17
|
from typing import Optional, Set
|
|
18
18
|
from typing_extensions import Self
|
|
19
|
+
from pydantic import SkipValidation, Field
|
|
19
20
|
|
|
20
21
|
class RfidCardPropertiesExt(BaseModel):
|
|
21
22
|
"""
|
|
22
23
|
Structure is used to store extended information about the characteristics of the RFID-chip located in the scope of the reader
|
|
23
24
|
""" # noqa: E501
|
|
24
|
-
rfid_type: RfidType = Field(alias="RFID_Type")
|
|
25
|
-
baudrate1:
|
|
26
|
-
baudrate2:
|
|
27
|
-
support_4:
|
|
28
|
-
chip_type_a: RfidAChip = Field(alias="ChipType_A")
|
|
29
|
-
support_mifare:
|
|
30
|
-
mifare_memory:
|
|
31
|
-
uid:
|
|
32
|
-
atq_a:
|
|
33
|
-
sak:
|
|
34
|
-
atq_b:
|
|
35
|
-
bit_rate_s: RfidBaudRate = Field(alias="BitRateS")
|
|
36
|
-
bit_rate_r: RfidBaudRate = Field(alias="BitRateR")
|
|
37
|
-
atr:
|
|
25
|
+
rfid_type: SkipValidation[RfidType] = Field(alias="RFID_Type")
|
|
26
|
+
baudrate1: SkipValidation[str] = Field(alias="Baudrate1", description="Numeric Baudrate1 value in hexadecimal format (e.g. 0x0000000F)")
|
|
27
|
+
baudrate2: SkipValidation[str] = Field(alias="Baudrate2", description="Numeric Baudrate2 value in hexadecimal format")
|
|
28
|
+
support_4: SkipValidation[bool] = Field(alias="Support_4", description="Boolean Support_4 value")
|
|
29
|
+
chip_type_a: SkipValidation[RfidAChip] = Field(alias="ChipType_A")
|
|
30
|
+
support_mifare: SkipValidation[bool] = Field(alias="Support_Mifare", description="Sign of support for ISO/IEC 14443-3 data exchange protocol")
|
|
31
|
+
mifare_memory: SkipValidation[float] = Field(alias="MifareMemory", description="Amount of operational memory MIFARE® of the chip, kilobytes")
|
|
32
|
+
uid: SkipValidation[str] = Field(alias="UID", description="UID contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. F9 4F 41 60)")
|
|
33
|
+
atq_a: SkipValidation[object] = Field(alias="ATQ_A", description="Reply of the «A» type chip to «REQA» command of ISO/IEC 14443-3 protocol (Answer To Request, Type A – ATQA) – for the internal use by the main control library")
|
|
34
|
+
sak: SkipValidation[object] = Field(alias="SAK", description="Response of type-A RFID-chip to SELECT command of ISO/IEC 14443-3 protocol (Select Acknowledge, SAK).")
|
|
35
|
+
atq_b: SkipValidation[object] = Field(alias="ATQ_B", description="ATQ_B contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. 50 F9 4F 41 60 00 00 00 00 77 81 81)")
|
|
36
|
+
bit_rate_s: SkipValidation[RfidBaudRate] = Field(alias="BitRateS")
|
|
37
|
+
bit_rate_r: SkipValidation[RfidBaudRate] = Field(alias="BitRateR")
|
|
38
|
+
atr: SkipValidation[str] = Field(alias="ATR", description="ATR-string of RFID-chip")
|
|
38
39
|
__properties: ClassVar[List[str]] = ["RFID_Type", "Baudrate1", "Baudrate2", "Support_4", "ChipType_A", "Support_Mifare", "MifareMemory", "UID", "ATQ_A", "SAK", "ATQ_B", "BitRateS", "BitRateR", "ATR"]
|
|
39
40
|
|
|
40
41
|
model_config = ConfigDict(
|
|
41
42
|
populate_by_name=True,
|
|
42
43
|
validate_assignment=True,
|
|
43
44
|
protected_namespaces=(),
|
|
45
|
+
arbitrary_types_allowed=True,
|
|
46
|
+
use_enum_values=True
|
|
44
47
|
)
|
|
45
48
|
|
|
46
49
|
|
|
@@ -20,30 +20,33 @@ from regula.documentreader.webclient.gen.models.rfid_validity import RfidValidit
|
|
|
20
20
|
from regula.documentreader.webclient.gen.models.trf_ft_string import TrfFtString
|
|
21
21
|
from typing import Optional, Set
|
|
22
22
|
from typing_extensions import Self
|
|
23
|
+
from pydantic import SkipValidation, Field
|
|
23
24
|
|
|
24
25
|
class RfidCertificateEx(BaseModel):
|
|
25
26
|
"""
|
|
26
27
|
Structure is used to describe the certificate contents used for the digital signature verification of the document security object within the context of the communication session with electronic document.
|
|
27
28
|
""" # noqa: E501
|
|
28
|
-
version:
|
|
29
|
-
serial_number:
|
|
30
|
-
signature_algorithm:
|
|
31
|
-
issuer: RfidDistinguishedName = Field(alias="Issuer")
|
|
32
|
-
validity: RfidValidity = Field(alias="Validity")
|
|
33
|
-
subject: RfidDistinguishedName = Field(alias="Subject")
|
|
34
|
-
subject_pk_algorithm:
|
|
35
|
-
extensions: List[RfidPkiExtension] = Field(description="List of the certificate extensions"
|
|
36
|
-
notifications: List[
|
|
37
|
-
origin: RfidCertificateOrigin = Field(alias="Origin")
|
|
38
|
-
type: RfidCertificateType = Field(alias="Type")
|
|
39
|
-
file_name: TrfFtString = Field(alias="FileName")
|
|
40
|
-
pa_status: RFIDErrorCodes = Field(alias="PA_Status")
|
|
29
|
+
version: SkipValidation[float] = Field(alias="Version", description="Version of Certificate ASN.1 structure")
|
|
30
|
+
serial_number: SkipValidation[str] = Field(alias="SerialNumber", description="Certificate serial number. Base64 encoded.")
|
|
31
|
+
signature_algorithm: SkipValidation[str] = Field(alias="SignatureAlgorithm", description="Certificate digital signature algorithm identifier (OID); String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string).")
|
|
32
|
+
issuer: SkipValidation[RfidDistinguishedName] = Field(alias="Issuer")
|
|
33
|
+
validity: SkipValidation[RfidValidity] = Field(alias="Validity")
|
|
34
|
+
subject: SkipValidation[RfidDistinguishedName] = Field(alias="Subject")
|
|
35
|
+
subject_pk_algorithm: SkipValidation[str] = Field(alias="SubjectPKAlgorithm", description="Certificate public key algorithm identifier (OID); String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string).")
|
|
36
|
+
extensions: SkipValidation[List[RfidPkiExtension]] = Field(alias="Extensions", description="List of the certificate extensions")
|
|
37
|
+
notifications: SkipValidation[List[int]] = Field(alias="Notifications", description="List of remarks arisen during the analysis of the certificate data structure and its validity verification. Can be ParsingErrorCodes or ParsingNotificationCodes enum.")
|
|
38
|
+
origin: SkipValidation[RfidCertificateOrigin] = Field(alias="Origin")
|
|
39
|
+
type: SkipValidation[RfidCertificateType] = Field(alias="Type")
|
|
40
|
+
file_name: SkipValidation[TrfFtString] = Field(alias="FileName")
|
|
41
|
+
pa_status: SkipValidation[RFIDErrorCodes] = Field(alias="PA_Status")
|
|
41
42
|
__properties: ClassVar[List[str]] = ["Version", "SerialNumber", "SignatureAlgorithm", "Issuer", "Validity", "Subject", "SubjectPKAlgorithm", "Extensions", "Notifications", "Origin", "Type", "FileName", "PA_Status"]
|
|
42
43
|
|
|
43
44
|
model_config = ConfigDict(
|
|
44
45
|
populate_by_name=True,
|
|
45
46
|
validate_assignment=True,
|
|
46
47
|
protected_namespaces=(),
|
|
48
|
+
arbitrary_types_allowed=True,
|
|
49
|
+
use_enum_values=True
|
|
47
50
|
)
|
|
48
51
|
|
|
49
52
|
|
|
@@ -20,29 +20,32 @@ from regula.documentreader.webclient.gen.models.text_field_type import TextField
|
|
|
20
20
|
from regula.documentreader.webclient.gen.models.trf_ft_bytes import TrfFtBytes
|
|
21
21
|
from typing import Optional, Set
|
|
22
22
|
from typing_extensions import Self
|
|
23
|
+
from pydantic import SkipValidation, Field
|
|
23
24
|
|
|
24
25
|
class RfidDataFile(BaseModel):
|
|
25
26
|
"""
|
|
26
27
|
Structure is used to describe the contents of a single file of the LDS of electronic document and the analysis of its contents within the context of the communication session with electronic document
|
|
27
28
|
""" # noqa: E501
|
|
28
|
-
file_id: Optional[
|
|
29
|
-
type: RfidDataFileType = Field(alias="Type")
|
|
30
|
-
file_data: Optional[TrfFtBytes] = Field(
|
|
31
|
-
reading_status: RFIDErrorCodes = Field(alias="ReadingStatus")
|
|
32
|
-
reading_time: Optional[
|
|
33
|
-
pa_status: Optional[RFIDErrorCodes] = Field(
|
|
34
|
-
notifications: Optional[List[
|
|
35
|
-
doc_fields_text: Optional[List[TextFieldType]] = Field(default=None, description="List of document text fields formed on the basis of the file contents"
|
|
36
|
-
doc_fields_graphics: Optional[List[GraphicFieldType]] = Field(default=None, description="List of document graphic fields formed on the basis of the file contents"
|
|
37
|
-
doc_fields_originals: Optional[List[GraphicFieldType]] = Field(default=None, description="List of the original binary representation of graphic document fields formed on the basis of the file contents"
|
|
38
|
-
parsed_data: Optional[ParsedData] = Field(
|
|
39
|
-
security_object_certificates: Optional[SecurityObjectCertificates] = Field(
|
|
29
|
+
file_id: SkipValidation[Optional[str]] = Field(alias="FileID", default=None, description="File identifier. Each byte of FileID represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. 01 1E)")
|
|
30
|
+
type: SkipValidation[RfidDataFileType] = Field(alias="Type")
|
|
31
|
+
file_data: SkipValidation[Optional[TrfFtBytes]] = Field(alias="FileData", default=None)
|
|
32
|
+
reading_status: SkipValidation[RFIDErrorCodes] = Field(alias="ReadingStatus")
|
|
33
|
+
reading_time: SkipValidation[Optional[float]] = Field(alias="ReadingTime", default=None, description="Time of reading, milliseconds")
|
|
34
|
+
pa_status: SkipValidation[Optional[RFIDErrorCodes]] = Field(alias="PA_Status", default=None)
|
|
35
|
+
notifications: SkipValidation[Optional[List[int]]] = Field(alias="Notifications", default=None, description="List of remarks arisen when reading data from the memory of the chip and analysing their ASN.1-structure. Can be ParsingErrorCodes or ParsingNotificationCodes enum.")
|
|
36
|
+
doc_fields_text: SkipValidation[Optional[List[TextFieldType]]] = Field(alias="DocFields_Text", default=None, description="List of document text fields formed on the basis of the file contents")
|
|
37
|
+
doc_fields_graphics: SkipValidation[Optional[List[GraphicFieldType]]] = Field(alias="DocFields_Graphics", default=None, description="List of document graphic fields formed on the basis of the file contents")
|
|
38
|
+
doc_fields_originals: SkipValidation[Optional[List[GraphicFieldType]]] = Field(alias="DocFields_Originals", default=None, description="List of the original binary representation of graphic document fields formed on the basis of the file contents")
|
|
39
|
+
parsed_data: SkipValidation[Optional[ParsedData]] = Field(alias="ParsedData", default=None)
|
|
40
|
+
security_object_certificates: SkipValidation[Optional[SecurityObjectCertificates]] = Field(alias="SecurityObject_Certificates", default=None)
|
|
40
41
|
__properties: ClassVar[List[str]] = ["FileID", "Type", "FileData", "ReadingStatus", "ReadingTime", "PA_Status", "Notifications", "DocFields_Text", "DocFields_Graphics", "DocFields_Originals", "ParsedData", "SecurityObject_Certificates"]
|
|
41
42
|
|
|
42
43
|
model_config = ConfigDict(
|
|
43
44
|
populate_by_name=True,
|
|
44
45
|
validate_assignment=True,
|
|
45
46
|
protected_namespaces=(),
|
|
47
|
+
arbitrary_types_allowed=True,
|
|
48
|
+
use_enum_values=True
|
|
46
49
|
)
|
|
47
50
|
|
|
48
51
|
|
|
@@ -12,36 +12,38 @@ import json
|
|
|
12
12
|
from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
|
|
13
13
|
from typing import Any, ClassVar, Dict, List, Union
|
|
14
14
|
from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
|
|
15
|
-
from regula.documentreader.webclient.gen.models.rfid_data_group_type_tag import RfidDataGroupTypeTag
|
|
16
15
|
from typing import Optional, Set
|
|
17
16
|
from typing_extensions import Self
|
|
17
|
+
from pydantic import SkipValidation, Field
|
|
18
18
|
|
|
19
19
|
class RfidDG1(BaseModel):
|
|
20
20
|
"""
|
|
21
21
|
Structure used to store the contents of EF.DG1 informational data group of ePassport application – document MRZ data
|
|
22
22
|
""" # noqa: E501
|
|
23
|
-
type:
|
|
24
|
-
document_id: DocumentFormat = Field(alias="DocumentID")
|
|
25
|
-
document_type:
|
|
26
|
-
state:
|
|
27
|
-
holder:
|
|
28
|
-
document_number:
|
|
29
|
-
check_digit_document_number:
|
|
30
|
-
nationality:
|
|
31
|
-
birthday:
|
|
32
|
-
check_digit_birthday:
|
|
33
|
-
sex:
|
|
34
|
-
expiry_date:
|
|
35
|
-
check_digit_expiry_date:
|
|
36
|
-
optional_data:
|
|
37
|
-
check_digit_optional_data:
|
|
38
|
-
check_digit_composite:
|
|
23
|
+
type: SkipValidation[int] = Field(alias="Type")
|
|
24
|
+
document_id: SkipValidation[DocumentFormat] = Field(alias="DocumentID")
|
|
25
|
+
document_type: SkipValidation[str] = Field(alias="DocumentType", description="Symbolic code of document type")
|
|
26
|
+
state: SkipValidation[str] = Field(alias="State", description="Symbolic code of document issuing state")
|
|
27
|
+
holder: SkipValidation[str] = Field(alias="Holder", description="DO’s name and surname")
|
|
28
|
+
document_number: SkipValidation[str] = Field(alias="DocumentNumber", description="Document number")
|
|
29
|
+
check_digit_document_number: SkipValidation[float] = Field(alias="CheckDigitDocumentNumber", description="Check digit of document number")
|
|
30
|
+
nationality: SkipValidation[str] = Field(alias="Nationality", description="Symbolic code of DO’s nationality")
|
|
31
|
+
birthday: SkipValidation[str] = Field(alias="Birthday", description="DO’s date of birth")
|
|
32
|
+
check_digit_birthday: SkipValidation[float] = Field(alias="CheckDigitBirthday", description="Check digit of DO’s date of birth")
|
|
33
|
+
sex: SkipValidation[str] = Field(alias="Sex", description="DO’s sex")
|
|
34
|
+
expiry_date: SkipValidation[str] = Field(alias="ExpiryDate", description="Term of validity of the document")
|
|
35
|
+
check_digit_expiry_date: SkipValidation[float] = Field(alias="CheckDigitExpiryDate", description="Check digit of term of validity of the document")
|
|
36
|
+
optional_data: SkipValidation[str] = Field(alias="OptionalData", description="DO’s personal number or other additional data")
|
|
37
|
+
check_digit_optional_data: SkipValidation[float] = Field(alias="CheckDigitOptionalData", description="Check digit of additional data")
|
|
38
|
+
check_digit_composite: SkipValidation[float] = Field(alias="CheckDigitComposite", description="General check digit")
|
|
39
39
|
__properties: ClassVar[List[str]] = ["Type", "DocumentID", "DocumentType", "State", "Holder", "DocumentNumber", "CheckDigitDocumentNumber", "Nationality", "Birthday", "CheckDigitBirthday", "Sex", "ExpiryDate", "CheckDigitExpiryDate", "OptionalData", "CheckDigitOptionalData", "CheckDigitComposite"]
|
|
40
40
|
|
|
41
41
|
model_config = ConfigDict(
|
|
42
42
|
populate_by_name=True,
|
|
43
43
|
validate_assignment=True,
|
|
44
44
|
protected_namespaces=(),
|
|
45
|
+
arbitrary_types_allowed=True,
|
|
46
|
+
use_enum_values=True
|
|
45
47
|
)
|
|
46
48
|
|
|
47
49
|
|
|
@@ -15,20 +15,23 @@ from regula.documentreader.webclient.gen.models.rfid_attribute_name import RfidA
|
|
|
15
15
|
from regula.documentreader.webclient.gen.models.trf_ft_string import TrfFtString
|
|
16
16
|
from typing import Optional, Set
|
|
17
17
|
from typing_extensions import Self
|
|
18
|
+
from pydantic import SkipValidation, Field
|
|
18
19
|
|
|
19
20
|
class RfidDistinguishedName(BaseModel):
|
|
20
21
|
"""
|
|
21
22
|
Contents of the identifier in binary form. Base64 encoded.
|
|
22
23
|
""" # noqa: E501
|
|
23
|
-
data:
|
|
24
|
-
friendly_name: TrfFtString = Field(alias="FriendlyName")
|
|
25
|
-
attributes: List[RfidAttributeName] = Field(description="List of individual attributes contained in the identifier"
|
|
24
|
+
data: SkipValidation[str] = Field(alias="Data", description="Contents of the identifier in binary form. Base64 encoded.")
|
|
25
|
+
friendly_name: SkipValidation[TrfFtString] = Field(alias="FriendlyName")
|
|
26
|
+
attributes: SkipValidation[List[RfidAttributeName]] = Field(alias="Attributes", description="List of individual attributes contained in the identifier")
|
|
26
27
|
__properties: ClassVar[List[str]] = ["Data", "FriendlyName", "Attributes"]
|
|
27
28
|
|
|
28
29
|
model_config = ConfigDict(
|
|
29
30
|
populate_by_name=True,
|
|
30
31
|
validate_assignment=True,
|
|
31
32
|
protected_namespaces=(),
|
|
33
|
+
arbitrary_types_allowed=True,
|
|
34
|
+
use_enum_values=True
|
|
32
35
|
)
|
|
33
36
|
|
|
34
37
|
|
|
@@ -16,33 +16,36 @@ from regula.documentreader.webclient.gen.models.string_recognition_result import
|
|
|
16
16
|
from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
|
|
17
17
|
from typing import Optional, Set
|
|
18
18
|
from typing_extensions import Self
|
|
19
|
+
from pydantic import SkipValidation, Field
|
|
19
20
|
|
|
20
21
|
class RFIDDocVisualExtendedField(BaseModel):
|
|
21
22
|
"""
|
|
22
23
|
RFIDDocVisualExtendedField
|
|
23
24
|
""" # noqa: E501
|
|
24
|
-
w_field_type: TextFieldType = Field(alias="wFieldType")
|
|
25
|
-
field_name:
|
|
26
|
-
strings_count:
|
|
27
|
-
strings_result: List[StringRecognitionResult] = Field(description="Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results."
|
|
28
|
-
buf_length:
|
|
29
|
-
buf_text:
|
|
30
|
-
field_mask: Optional[
|
|
31
|
-
validity: Optional[
|
|
32
|
-
in_comparison: Optional[
|
|
33
|
-
w_lcid: Optional[LCID] = Field(
|
|
34
|
-
reserved2: Optional[
|
|
35
|
-
reserved3: Optional[
|
|
36
|
-
origin_dg:
|
|
37
|
-
origin_dg_tag: Optional[
|
|
38
|
-
origin_tag_entry:
|
|
39
|
-
origin_entry_view: Optional[
|
|
25
|
+
w_field_type: SkipValidation[TextFieldType] = Field(alias="wFieldType")
|
|
26
|
+
field_name: SkipValidation[str] = Field(alias="FieldName", description="Field symbolic name (null-terminated string)")
|
|
27
|
+
strings_count: SkipValidation[float] = Field(alias="StringsCount", description="Number of StringsResult array elements")
|
|
28
|
+
strings_result: SkipValidation[List[StringRecognitionResult]] = Field(alias="StringsResult", description="Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.")
|
|
29
|
+
buf_length: SkipValidation[float] = Field(alias="Buf_Length", description="Buf_Text text string length")
|
|
30
|
+
buf_text: SkipValidation[Optional[str]] = Field(alias="Buf_Text", default=None, description="Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'")
|
|
31
|
+
field_mask: SkipValidation[Optional[str]] = Field(alias="FieldMask", default=None)
|
|
32
|
+
validity: SkipValidation[Optional[int]] = Field(alias="Validity", default=None)
|
|
33
|
+
in_comparison: SkipValidation[Optional[int]] = Field(alias="InComparison", default=None)
|
|
34
|
+
w_lcid: SkipValidation[Optional[LCID]] = Field(alias="wLCID", default=None)
|
|
35
|
+
reserved2: SkipValidation[Optional[int]] = Field(alias="Reserved2", default=None)
|
|
36
|
+
reserved3: SkipValidation[Optional[int]] = Field(alias="Reserved3", default=None)
|
|
37
|
+
origin_dg: SkipValidation[int] = Field(alias="OriginDG")
|
|
38
|
+
origin_dg_tag: SkipValidation[Optional[int]] = Field(alias="OriginDGTag", default=None)
|
|
39
|
+
origin_tag_entry: SkipValidation[float] = Field(alias="OriginTagEntry", description="Record index of the text field source in the data group")
|
|
40
|
+
origin_entry_view: SkipValidation[Optional[int]] = Field(alias="OriginEntryView", default=None)
|
|
40
41
|
__properties: ClassVar[List[str]] = ["wFieldType", "FieldName", "StringsCount", "StringsResult", "Buf_Length", "Buf_Text", "FieldMask", "Validity", "InComparison", "wLCID", "Reserved2", "Reserved3", "OriginDG", "OriginDGTag", "OriginTagEntry", "OriginEntryView"]
|
|
41
42
|
|
|
42
43
|
model_config = ConfigDict(
|
|
43
44
|
populate_by_name=True,
|
|
44
45
|
validate_assignment=True,
|
|
45
46
|
protected_namespaces=(),
|
|
47
|
+
arbitrary_types_allowed=True,
|
|
48
|
+
use_enum_values=True
|
|
46
49
|
)
|
|
47
50
|
|
|
48
51
|
|