diff --git a/generator-templates/lenient/model_generic.mustache b/generator-templates/lenient/model_generic.mustache index 552b32d..98bfd0c 100644 --- a/generator-templates/lenient/model_generic.mustache +++ b/generator-templates/lenient/model_generic.mustache @@ -29,7 +29,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}} {{#description}}{{{description}}}{{/description}}{{^description}}{{{classname}}}{{/description}} """ # noqa: E501 {{#vars}} - {{name}}: SkipValidation[{{^required}}Optional[{{/required}}{{dataType}}{{^required}}]{{/required}}] = Field(alias="{{baseName}}"{{^required}}, default=None{{/required}}{{#description}}, description="{{description}}"{{/description}}) + {{name}}: SkipValidation[{{^required}}Optional[{{/required}}{{dataType}}{{^required}}]{{/required}}] = Field(alias="{{baseName}}"{{^required}}, default=None{{/required}}{{#description}}, description="{{{description}}}"{{/description}}) {{/vars}} {{#isAdditionalPropertiesTrue}} additional_properties: Dict[str, Any] = {} diff --git a/regula/documentreader/webclient/gen/models/auth_params.py b/regula/documentreader/webclient/gen/models/auth_params.py index f0785da..1bf2e7a 100644 --- a/regula/documentreader/webclient/gen/models/auth_params.py +++ b/regula/documentreader/webclient/gen/models/auth_params.py @@ -32,7 +32,7 @@ class AuthParams(BaseModel): check_barcode_format: SkipValidation[Optional[bool]] = Field(alias="checkBarcodeFormat", default=None, description="This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)") check_ir_visibility: SkipValidation[Optional[bool]] = Field(alias="checkIRVisibility", default=None, description="This parameter is used to enable Document elements visibility check in IR light") check_ipi: SkipValidation[Optional[bool]] = Field(alias="checkIPI", default=None, description="This parameter is used to enable Invisible Personal Information (IPI) check") - check_photo_embedding: SkipValidation[Optional[bool]] = Field(alias="checkPhotoEmbedding", default=None, description="This parameter is used to enable Owner's photo embedding check (is photo printed or sticked)") + check_photo_embedding: SkipValidation[Optional[bool]] = Field(alias="checkPhotoEmbedding", default=None, description="This parameter is used to enable Owner's photo embedding check (is photo printed or sticked)") check_photo_comparison: SkipValidation[Optional[bool]] = Field(alias="checkPhotoComparison", default=None, description="This parameter is used to enable Portrait comparison check") check_letter_screen: SkipValidation[Optional[bool]] = Field(alias="checkLetterScreen", default=None, description="This parameter is used to enable LetterScreen check") check_security_text: SkipValidation[Optional[bool]] = Field(alias="checkSecurityText", default=None, description="This parameter is used to enable Security text check") diff --git a/regula/documentreader/webclient/gen/models/binary_data.py b/regula/documentreader/webclient/gen/models/binary_data.py index a698884..d9e9db4 100644 --- a/regula/documentreader/webclient/gen/models/binary_data.py +++ b/regula/documentreader/webclient/gen/models/binary_data.py @@ -86,7 +86,7 @@ class BinaryData(BaseModel): digital_signature: SkipValidation[Optional[Dict[str, object]]] = Field(alias="Digital_Signature", default=None) rfid_session_data: SkipValidation[Optional[RfidSessionData]] = Field(alias="RFID_Session_Data", default=None) rfid_session_data_status: SkipValidation[Optional[DetailsRFID]] = Field(alias="RFID_Session_Data_Status", default=None) - rfid_e_passp_directory: SkipValidation[Optional[List[RfidDataFileType]]] = Field(alias="RFID_ePassp_Directory", default=None, description="Indexes of groups that aren't read") + rfid_e_passp_directory: SkipValidation[Optional[List[RfidDataFileType]]] = Field(alias="RFID_ePassp_Directory", default=None, description="Indexes of groups that aren't read") __properties: ClassVar[List[str]] = ["RFID_Authentication_Info", "RFID_MIFARE_Data_Validity", "RFID_MIFARE_Data", "RFID_EF_COM", "RFID_DG1", "RFID_DG2", "RFID_DG3", "RFID_DG4", "RFID_DG5", "RFID_DG6", "RFID_DG7", "RFID_DG8", "RFID_DG9", "RFID_DG10", "RFID_DG11", "RFID_DG12", "RFID_DG13", "RFID_DG14", "RFID_DG15", "RFID_DG16", "RFID_EF_SOD", "eID_DG1", "eID_DG2", "eID_DG3", "eID_DG4", "eID_DG5", "eID_DG6", "eID_DG7", "eID_DG8", "eID_DG9", "eID_DG10", "eID_DG11", "eID_DG12", "eID_DG13", "eID_DG14", "eID_DG15", "eID_DG16", "eID_DG17", "eID_DG18", "eID_DG19", "eID_DG20", "eID_DG21", "eDL_COM", "eDL_SOD", "eDL_DG1", "eDL_DG2", "eDL_DG3", "eDL_DG4", "eDL_DG5", "eDL_DG6", "eDL_DG7", "eDL_DG8", "eDL_DG9", "eDL_DG10", "eDL_DG11", "eDL_DG12", "eDL_DG13", "eDL_DG14", "Visible_Digital_Seal", "Visible_Digital_Seal_NC", "Digital_Signature", "RFID_Session_Data", "RFID_Session_Data_Status", "RFID_ePassp_Directory"] model_config = ConfigDict( diff --git a/regula/documentreader/webclient/gen/models/chosen_document_type.py b/regula/documentreader/webclient/gen/models/chosen_document_type.py index af2ae24..5a29014 100644 --- a/regula/documentreader/webclient/gen/models/chosen_document_type.py +++ b/regula/documentreader/webclient/gen/models/chosen_document_type.py @@ -23,7 +23,7 @@ class ChosenDocumentType(BaseModel): Contains information about one document type candidate """ # noqa: E501 document_name: SkipValidation[Optional[str]] = Field(alias="DocumentName", default=None, description="Document name") - id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)") + id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)") p: SkipValidation[float] = Field(alias="P", description="A measure of the likelihood of correct recognition in the analysis of this type of document") rotated180: SkipValidation[int] = Field(alias="Rotated180", description="Indicates if the document of the given type is rotated by 180 degrees") rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence") diff --git a/regula/documentreader/webclient/gen/models/doc_visual_extended_field.py b/regula/documentreader/webclient/gen/models/doc_visual_extended_field.py index aa869f5..d0fa9b9 100644 --- a/regula/documentreader/webclient/gen/models/doc_visual_extended_field.py +++ b/regula/documentreader/webclient/gen/models/doc_visual_extended_field.py @@ -28,7 +28,7 @@ class DocVisualExtendedField(BaseModel): strings_count: SkipValidation[float] = Field(alias="StringsCount", description="Number of StringsResult array elements") 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.") buf_length: SkipValidation[float] = Field(alias="Buf_Length", description="Buf_Text text string length") - 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 '^'") + 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 '^'") field_mask: SkipValidation[Optional[str]] = Field(alias="FieldMask", default=None) validity: SkipValidation[Optional[int]] = Field(alias="Validity", default=None) in_comparison: SkipValidation[Optional[int]] = Field(alias="InComparison", default=None) diff --git a/regula/documentreader/webclient/gen/models/face_api.py b/regula/documentreader/webclient/gen/models/face_api.py index 7864f33..a103665 100644 --- a/regula/documentreader/webclient/gen/models/face_api.py +++ b/regula/documentreader/webclient/gen/models/face_api.py @@ -21,15 +21,15 @@ class FaceApi(BaseModel): FaceApi """ # noqa: E501 url: SkipValidation[Optional[str]] = Field(alias="url", default=None, description="The URL of the Regula Face Web service to be used.") - mode: SkipValidation[Optional[str]] = Field(alias="mode", default=None, description="The processing mode: \"match\" or \"match+search\".") + mode: SkipValidation[Optional[str]] = Field(alias="mode", default=None, description="The processing mode: \"match\" or \"match+search\".") search: SkipValidation[Optional[FaceApiSearch]] = Field(alias="search", default=None) - threshold: SkipValidation[Optional[int]] = Field(alias="threshold", default=None, description="The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not.") + threshold: SkipValidation[Optional[int]] = Field(alias="threshold", default=None, description="The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not.") service_timeout: SkipValidation[Optional[int]] = Field(alias="serviceTimeout", default=None, description="The Regula Face Web service requests timeout, ms.") - proxy: SkipValidation[Optional[str]] = Field(alias="proxy", default=None, description="Proxy to use, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXY.html\" target=\"_blank\">cURL standard</a>.") - proxy_userpwd: SkipValidation[Optional[str]] = Field(alias="proxy_userpwd", default=None, description="Username and password to use for proxy authentication, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXYUSERPWD.html\" target=\"_blank\">cURL standard</a>.") - proxy_type: SkipValidation[Optional[int]] = Field(alias="proxy_type", default=None, description="Proxy protocol type, should be set according to the <a href=\"https://curl.se/libcurl/c/CURLOPT_PROXYTYPE.html\" target=\"_blank\">cURL standard</a>.") + proxy: SkipValidation[Optional[str]] = Field(alias="proxy", default=None, description="Proxy to use, should be set according to the cURL standard.") + proxy_userpwd: SkipValidation[Optional[str]] = Field(alias="proxy_userpwd", default=None, description="Username and password to use for proxy authentication, should be set according to the cURL standard.") + proxy_type: SkipValidation[Optional[int]] = Field(alias="proxy_type", default=None, description="Proxy protocol type, should be set according to the cURL standard.") child_age_threshold: SkipValidation[Optional[int]] = Field(alias="childAgeThreshold", default=None, description="The age threshold for the portrait comparison. Default: 13.") - child_doc_validity_years: SkipValidation[Optional[int]] = Field(alias="childDocValidityYears", default=None, description="Estimated duration of validity for a child's passport, years. Default: 5.") + child_doc_validity_years: SkipValidation[Optional[int]] = Field(alias="childDocValidityYears", default=None, description="Estimated duration of validity for a child's passport, years. Default: 5.") __properties: ClassVar[List[str]] = ["url", "mode", "search", "threshold", "serviceTimeout", "proxy", "proxy_userpwd", "proxy_type", "childAgeThreshold", "childDocValidityYears"] model_config = ConfigDict( diff --git a/regula/documentreader/webclient/gen/models/fdsid_list.py b/regula/documentreader/webclient/gen/models/fdsid_list.py index 053fccf..2906a11 100644 --- a/regula/documentreader/webclient/gen/models/fdsid_list.py +++ b/regula/documentreader/webclient/gen/models/fdsid_list.py @@ -24,7 +24,7 @@ class FDSIDList(BaseModel): """ # noqa: E501 icao_code: SkipValidation[str] = Field(alias="ICAOCode", description="ICAO code of the issuing country") count: SkipValidation[Optional[float]] = Field(alias="Count", default=None, description="Number of elements in the List") - list: SkipValidation[Optional[List[int]]] = Field(alias="List", default=None, description="Document identifiers in 'Information Reference Systems'") + list: SkipValidation[Optional[List[int]]] = Field(alias="List", default=None, description="Document identifiers in 'Information Reference Systems'") d_type: SkipValidation[DocumentType] = Field(alias="dType") d_format: SkipValidation[DocumentFormat] = Field(alias="dFormat") d_mrz: SkipValidation[bool] = Field(alias="dMRZ", description="Flag indicating the presence of MRZ on the document") diff --git a/regula/documentreader/webclient/gen/models/glares_check_params.py b/regula/documentreader/webclient/gen/models/glares_check_params.py index 060ef19..5f836f0 100644 --- a/regula/documentreader/webclient/gen/models/glares_check_params.py +++ b/regula/documentreader/webclient/gen/models/glares_check_params.py @@ -19,8 +19,8 @@ class GlaresCheckParams(BaseModel): """ GlaresCheckParams """ # noqa: E501 - img_margin_part: SkipValidation[Optional[float]] = Field(alias="imgMarginPart", default=None, description="Margin from the edges of the image. 0.35 = 35%") - max_glaring_part: SkipValidation[Optional[float]] = Field(alias="maxGlaringPart", default=None, description="The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%") + img_margin_part: SkipValidation[Optional[float]] = Field(alias="imgMarginPart", default=None, description="Margin from the edges of the image. 0.35 = 35%") + max_glaring_part: SkipValidation[Optional[float]] = Field(alias="maxGlaringPart", default=None, description="The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%") __properties: ClassVar[List[str]] = ["imgMarginPart", "maxGlaringPart"] model_config = ConfigDict( diff --git a/regula/documentreader/webclient/gen/models/in_data_video.py b/regula/documentreader/webclient/gen/models/in_data_video.py index 6e16b43..3a7a889 100644 --- a/regula/documentreader/webclient/gen/models/in_data_video.py +++ b/regula/documentreader/webclient/gen/models/in_data_video.py @@ -19,7 +19,7 @@ class InDataVideo(BaseModel): """ Video """ # noqa: E501 - metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing video's extended attributes.") + metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing video's extended attributes.") url: SkipValidation[Optional[str]] = Field(alias="url", default=None, description="Video url") __properties: ClassVar[List[str]] = ["metadata", "url"] diff --git a/regula/documentreader/webclient/gen/models/one_candidate.py b/regula/documentreader/webclient/gen/models/one_candidate.py index c90f5e0..4fd41d7 100644 --- a/regula/documentreader/webclient/gen/models/one_candidate.py +++ b/regula/documentreader/webclient/gen/models/one_candidate.py @@ -23,7 +23,7 @@ class OneCandidate(BaseModel): Contains information about one document type candidate """ # noqa: E501 document_name: SkipValidation[Optional[str]] = Field(alias="DocumentName", default=None, description="Document name") - id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)") + id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)") p: SkipValidation[float] = Field(alias="P", description="A measure of the likelihood of correct recognition in the analysis of this type of document") rotated180: SkipValidation[int] = Field(alias="Rotated180", description="Indicates if the document of the given type is rotated by 180 degrees") rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence") diff --git a/regula/documentreader/webclient/gen/models/process_params.py b/regula/documentreader/webclient/gen/models/process_params.py index f67e339..2ee1a8e 100644 --- a/regula/documentreader/webclient/gen/models/process_params.py +++ b/regula/documentreader/webclient/gen/models/process_params.py @@ -40,19 +40,19 @@ class ProcessParams(BaseModel): lcid_filter: SkipValidation[Optional[List[LCID]]] = Field(alias="lcidFilter", default=None, description="The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.") check_liveness: SkipValidation[Optional[bool]] = Field(alias="checkLiveness", default=None, description="This parameter is used to enable document liveness check.") lcid_ignore_filter: SkipValidation[Optional[List[LCID]]] = Field(alias="lcidIgnoreFilter", default=None, description="The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default.") - one_shot_identification: SkipValidation[Optional[bool]] = Field(alias="oneShotIdentification", default=None, description="This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person's face") + one_shot_identification: SkipValidation[Optional[bool]] = Field(alias="oneShotIdentification", default=None, description="This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person's face") use_face_api: SkipValidation[Optional[bool]] = Field(alias="useFaceApi", default=None, description="This parameter allows comparing faces on Regula Face Web Service") face_api: SkipValidation[Optional[FaceApi]] = Field(alias="faceApi", default=None) do_detect_can: SkipValidation[Optional[bool]] = Field(alias="doDetectCan", default=None, description="This parameter allows enabling the CAN (Card Access Number) detection and recognition when using scenarios with document location and MRZ reading, such as the MrzAndLocate scenario.") image_output_max_height: SkipValidation[Optional[int]] = Field(alias="imageOutputMaxHeight", default=None, description="This parameter allows setting maximum height in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0.") image_output_max_width: SkipValidation[Optional[int]] = Field(alias="imageOutputMaxWidth", default=None, description="This parameter allows setting maximum width in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0.") scenario: SkipValidation[Scenario] = Field(alias="scenario") - result_type_output: SkipValidation[Optional[List[Result]]] = Field(alias="resultTypeOutput", default=None, description="Types of results to return in response. See 'Result' enum for available options") + result_type_output: SkipValidation[Optional[List[Result]]] = Field(alias="resultTypeOutput", default=None, description="Types of results to return in response. See 'Result' enum for available options") double_page_spread: SkipValidation[Optional[bool]] = Field(alias="doublePageSpread", default=None, description="Enable this option if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others. Disabled by default.") - generate_double_page_spread_image: SkipValidation[Optional[bool]] = Field(alias="generateDoublePageSpreadImage", default=None, description="When enabled together with \"doublePageSpread\" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner. Disabled by default.") + generate_double_page_spread_image: SkipValidation[Optional[bool]] = Field(alias="generateDoublePageSpreadImage", default=None, description="When enabled together with \"doublePageSpread\" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner. Disabled by default.") field_types_filter: SkipValidation[Optional[List[TextFieldType]]] = Field(alias="fieldTypesFilter", default=None, description="If a document contains Visual zone, you can set the list of field types to extract. In this case, other fields are skipped during the processing, i.e. document recognition becomes faster. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.") field_types_ignore_filter: SkipValidation[Optional[List[TextFieldType]]] = Field(alias="fieldTypesIgnoreFilter", default=None, description="If a document contains a Visual zone, you can specify a list of field types that should be excluded from extraction. All field types listed in this array are skipped during processing, while the remaining fields are recognized. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesIgnoreFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.") - date_format: SkipValidation[Optional[str]] = Field(alias="dateFormat", default=None, description="This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running).") + date_format: SkipValidation[Optional[str]] = Field(alias="dateFormat", default=None, description="This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running).") measure_system: SkipValidation[Optional[MeasureSystem]] = Field(alias="measureSystem", default=None) image_dpi_out_max: SkipValidation[Optional[int]] = Field(alias="imageDpiOutMax", default=None, description="This parameter controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi for all scenarios except FullAuth. In FullAuth scenario this limit is 1000 dpi by default.") already_cropped: SkipValidation[Optional[bool]] = Field(alias="alreadyCropped", default=None, description="This option can be enabled if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile. Disabled by default.") @@ -64,7 +64,7 @@ class ProcessParams(BaseModel): match_text_field_mask: SkipValidation[Optional[bool]] = Field(alias="matchTextFieldMask", default=None, description="When disabled, text field OCR will be done as is and then the recognized value will be matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask in the template. Enabled by default.") fast_doc_detect: SkipValidation[Optional[bool]] = Field(alias="fastDocDetect", default=None, description="When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds. Enabled by default.") update_ocr_validity_by_glare: SkipValidation[Optional[bool]] = Field(alias="updateOCRValidityByGlare", default=None, description="When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default.") - check_required_text_fields: SkipValidation[Optional[bool]] = Field(alias="checkRequiredTextFields", default=None, description="When enabled, each field in template will be checked for value presence and if the field is marked as required, but has no value, it will have 'error' in validity status. Disabled by default.") + check_required_text_fields: SkipValidation[Optional[bool]] = Field(alias="checkRequiredTextFields", default=None, description="When enabled, each field in template will be checked for value presence and if the field is marked as required, but has no value, it will have 'error' in validity status. Disabled by default.") return_cropped_barcode: SkipValidation[Optional[bool]] = Field(alias="returnCroppedBarcode", default=None, description="When enabled, returns cropped barcode images for unknown documents. Disabled by default.") image_qa: SkipValidation[Optional[ImageQA]] = Field(alias="imageQa", default=None) strict_image_quality: SkipValidation[Optional[bool]] = Field(alias="strictImageQuality", default=None, description="When enabled, the image quality check status affects the document optical and overall status. Disabled by default.") @@ -88,7 +88,7 @@ class ProcessParams(BaseModel): device_type: SkipValidation[Optional[int]] = Field(alias="deviceType", default=None, description="This parameter is used to specify the document reader device type from which input images were captured. Default 0.") device_type_hex: SkipValidation[Optional[str]] = Field(alias="deviceTypeHex", default=None, description="This parameter is used to specify the document reader device type from which input images were captured") ignore_device_id_from_image: SkipValidation[Optional[bool]] = Field(alias="ignoreDeviceIdFromImage", default=None, description="This parameter is used to tell the processing engine to ignore any parameters saved in the image when scanned from the document reader device. Default false") - document_id_list: SkipValidation[Optional[List[int]]] = Field(alias="documentIdList", default=None, description="List of the document ID's to process. All documents will be processed, if empty.") + document_id_list: SkipValidation[Optional[List[int]]] = Field(alias="documentIdList", default=None, description="List of the document ID's to process. All documents will be processed, if empty.") rfid: SkipValidation[Optional[ProcessParamsRfid]] = Field(alias="rfid", default=None) check_auth: SkipValidation[Optional[bool]] = Field(alias="checkAuth", default=None, description="This parameter is used to enable authenticity checks") auth_params: SkipValidation[Optional[AuthParams]] = Field(alias="authParams", default=None) @@ -101,7 +101,7 @@ class ProcessParams(BaseModel): generate_alpha2_codes: SkipValidation[Optional[bool]] = Field(alias="generateAlpha2Codes", default=None, description="Set to generate Alpha-2 codes for nationality and issuing state fields.") pdf_pages_limit: SkipValidation[Optional[int]] = Field(alias="pdfPagesLimit", default=None, description="Limits the number of pages to be processed from a PDF file.") disable_auth_resolution_filter: SkipValidation[Optional[bool]] = Field(alias="disableAuthResolutionFilter", default=None, description="This parameter if enabled will ignore the minimum barcode resolution needed to start processing.") - strict_security_checks: SkipValidation[Optional[bool]] = Field(alias="strictSecurityChecks", default=None, description="When enabled, this parameter marks security checks that don’t meet minimum requirements as 'Failed' (instead of 'WasNotDone'), which causes the overall security status to be 'Failed'.") + strict_security_checks: SkipValidation[Optional[bool]] = Field(alias="strictSecurityChecks", default=None, description="When enabled, this parameter marks security checks that don’t meet minimum requirements as 'Failed' (instead of 'WasNotDone'), which causes the overall security status to be 'Failed'.") return_transliterated_fields: SkipValidation[Optional[bool]] = Field(alias="returnTransliteratedFields", default=None, description="Allows transliteration to be turned on or off; by default, it is enabled.") __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "fieldTypesIgnoreFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry", "generateAlpha2Codes", "pdfPagesLimit", "disableAuthResolutionFilter", "strictSecurityChecks", "returnTransliteratedFields"] diff --git a/regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field.py b/regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field.py index eabce27..7891320 100644 --- a/regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field.py +++ b/regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field.py @@ -27,7 +27,7 @@ class RFIDDocVisualExtendedField(BaseModel): strings_count: SkipValidation[float] = Field(alias="StringsCount", description="Number of StringsResult array elements") 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.") buf_length: SkipValidation[float] = Field(alias="Buf_Length", description="Buf_Text text string length") - 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 '^'") + 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 '^'") field_mask: SkipValidation[Optional[str]] = Field(alias="FieldMask", default=None) validity: SkipValidation[Optional[int]] = Field(alias="Validity", default=None) in_comparison: SkipValidation[Optional[int]] = Field(alias="InComparison", default=None) diff --git a/regula/documentreader/webclient/gen/models/string_recognition_result.py b/regula/documentreader/webclient/gen/models/string_recognition_result.py index 1b7ec76..e9e87c8 100644 --- a/regula/documentreader/webclient/gen/models/string_recognition_result.py +++ b/regula/documentreader/webclient/gen/models/string_recognition_result.py @@ -23,7 +23,7 @@ class StringRecognitionResult(BaseModel): symbols_count: SkipValidation[float] = Field(alias="SymbolsCount", description="Number of StringResult array elements") string_result: SkipValidation[List[SymbolRecognitionResult]] = Field(alias="StringResult", description="Array of recognition results for individual characters of a string") buf_length: SkipValidation[Optional[float]] = Field(alias="Buf_Length", default=None, description="Buf_Text text string length") - 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 '^'") + 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 '^'") reserved: SkipValidation[Optional[int]] = Field(alias="Reserved", default=None) __properties: ClassVar[List[str]] = ["SymbolsCount", "StringResult", "Buf_Length", "Buf_Text", "Reserved"] diff --git a/regula/documentreader/webclient/gen/models/text_field.py b/regula/documentreader/webclient/gen/models/text_field.py index ea4ce65..8899855 100644 --- a/regula/documentreader/webclient/gen/models/text_field.py +++ b/regula/documentreader/webclient/gen/models/text_field.py @@ -26,7 +26,7 @@ class TextField(BaseModel): TextField """ # noqa: E501 field_type: SkipValidation[TextFieldType] = Field(alias="fieldType") - field_name: SkipValidation[str] = Field(alias="fieldName", description="Field name. Only use to search values for fields with fieldType=50(other). In general, use fieldType for lookup.") + field_name: SkipValidation[str] = Field(alias="fieldName", description="Field name. Only use to search values for fields with fieldType=50(other). In general, use fieldType for lookup.") lcid: SkipValidation[LCID] = Field(alias="lcid") lcid_name: SkipValidation[Optional[str]] = Field(alias="lcidName", default=None, description="LCID name") status: SkipValidation[CheckResult] = Field(alias="status") diff --git a/regula/documentreader/webclient/gen/models/visual_extended_field_item.py b/regula/documentreader/webclient/gen/models/visual_extended_field_item.py index e645297..f6158b6 100644 --- a/regula/documentreader/webclient/gen/models/visual_extended_field_item.py +++ b/regula/documentreader/webclient/gen/models/visual_extended_field_item.py @@ -27,7 +27,7 @@ class VisualExtendedFieldItem(BaseModel): strings_count: SkipValidation[float] = Field(alias="StringsCount", description="Number of StringsResult array elements") 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.") buf_length: SkipValidation[float] = Field(alias="Buf_Length", description="Buf_Text text string length") - 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 '^'") + 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 '^'") field_mask: SkipValidation[Optional[str]] = Field(alias="FieldMask", default=None) validity: SkipValidation[Optional[int]] = Field(alias="Validity", default=None) in_comparison: SkipValidation[Optional[int]] = Field(alias="InComparison", default=None)