From e5bc56c61c3aad35777d57b2657c95f4b688a4bb Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Mon, 5 Oct 2026 08:02:11 +0000 Subject: [PATCH] Commit: d3fac7e8 --- .../webclient/model/ChosenDocumentType.java | 2 +- .../webclient/model/DetailsOptical.java | 14 +++++++------- .../webclient/model/DetailsRFID.java | 14 +++++++------- .../webclient/model/DocVisualExtendedField.java | 3 ++- .../model/DocVisualExtendedFieldItem.java | 3 ++- .../webclient/model/DocumentFormat.java | 5 ++++- .../webclient/model/DocumentTypesCandidates.java | 2 +- .../model/DocumentTypesCandidatesList.java | 2 +- .../documentreader/webclient/model/FiberItem.java | 4 ++-- .../webclient/model/FiberResult.java | 4 ++-- .../documentreader/webclient/model/IdentItem.java | 4 ++-- .../webclient/model/IdentResult.java | 4 ++-- .../webclient/model/ImageQualityCheckList.java | 2 +- .../webclient/model/ImagesFieldValue.java | 6 +++--- .../webclient/model/OneCandidate.java | 2 +- .../webclient/model/ProcessParams.java | 12 ++++++++---- .../webclient/model/RfidApplicationType.java | 4 ++-- .../documentreader/webclient/model/Status.java | 10 +++++----- .../webclient/model/SymbolRecognitionResult.java | 2 +- .../documentreader/webclient/model/Text.java | 6 +++--- .../webclient/model/TextAvailableSource.java | 2 +- .../documentreader/webclient/model/TextField.java | 6 +++--- .../webclient/model/TextFieldValue.java | 5 +++-- 23 files changed, 64 insertions(+), 54 deletions(-) diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/ChosenDocumentType.java b/client/src/main/generated/com/regula/documentreader/webclient/model/ChosenDocumentType.java index 8915d336..a6eec4a9 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/ChosenDocumentType.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/ChosenDocumentType.java @@ -191,7 +191,7 @@ public ChosenDocumentType rfIDPresence(@javax.annotation.Nonnull RfidLocation rf } /** - * Get rfIDPresence + * Indication of the presence of an RFID chip in the document (electronic document indicator) * * @return rfIDPresence */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsOptical.java b/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsOptical.java index 15051156..cd88a264 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsOptical.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsOptical.java @@ -94,7 +94,7 @@ public DetailsOptical overallStatus(@javax.annotation.Nonnull CheckResult overal } /** - * Get overallStatus + * Overall optical checks combined status * * @return overallStatus */ @@ -113,7 +113,7 @@ public DetailsOptical docType(@javax.annotation.Nonnull CheckResult docType) { } /** - * Get docType + * Status of document type recognition * * @return docType */ @@ -132,7 +132,7 @@ public DetailsOptical expiry(@javax.annotation.Nonnull CheckResult expiry) { } /** - * Get expiry + * Status of document expiration * * @return expiry */ @@ -151,7 +151,7 @@ public DetailsOptical imageQA(@javax.annotation.Nonnull CheckResult imageQA) { } /** - * Get imageQA + * Status of document image quality check * * @return imageQA */ @@ -170,7 +170,7 @@ public DetailsOptical mrz(@javax.annotation.Nonnull CheckResult mrz) { } /** - * Get mrz + * Status of document MRZ * * @return mrz */ @@ -208,7 +208,7 @@ public DetailsOptical security(@javax.annotation.Nonnull CheckResult security) { } /** - * Get security + * Authenticity verification status * * @return security */ @@ -227,7 +227,7 @@ public DetailsOptical text(@javax.annotation.Nonnull CheckResult text) { } /** - * Get text + * Status of text fields analysis * * @return text */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsRFID.java b/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsRFID.java index 3693b793..9146ac3a 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsRFID.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/DetailsRFID.java @@ -82,7 +82,7 @@ public DetailsRFID overallStatus(@javax.annotation.Nonnull CheckResult overallSt } /** - * Get overallStatus + * Overall RFID checks combined status * * @return overallStatus */ @@ -101,7 +101,7 @@ public DetailsRFID AA(@javax.annotation.Nonnull CheckResult AA) { } /** - * Get AA + * Active Authentication status * * @return AA */ @@ -120,7 +120,7 @@ public DetailsRFID BAC(@javax.annotation.Nonnull CheckResult BAC) { } /** - * Get BAC + * Basic Access Control (BAC) status * * @return BAC */ @@ -139,7 +139,7 @@ public DetailsRFID CA(@javax.annotation.Nonnull CheckResult CA) { } /** - * Get CA + * Chip Authentication status * * @return CA */ @@ -158,7 +158,7 @@ public DetailsRFID PA(@javax.annotation.Nonnull CheckResult PA) { } /** - * Get PA + * Passive Authentication status * * @return PA */ @@ -177,7 +177,7 @@ public DetailsRFID PACE(@javax.annotation.Nonnull CheckResult PACE) { } /** - * Get PACE + * Password Authenticated Connection Establishment (PACE) status * * @return PACE */ @@ -196,7 +196,7 @@ public DetailsRFID TA(@javax.annotation.Nonnull CheckResult TA) { } /** - * Get TA + * Terminal Authentication status * * @return TA */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedField.java b/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedField.java index f4ce23a7..62557235 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedField.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedField.java @@ -47,7 +47,8 @@ public DocVisualExtendedField fieldRect( } /** - * Get fieldRect + * Coordinates of the text field in the normalized image of the document. Only for + * Result.VISUAL_TEXT and Result.MRZ_TEXT results. * * @return fieldRect */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedFieldItem.java b/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedFieldItem.java index 6493692e..a16b293e 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedFieldItem.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/DocVisualExtendedFieldItem.java @@ -47,7 +47,8 @@ public DocVisualExtendedFieldItem fieldRect( } /** - * Get fieldRect + * Coordinates of the text field in the normalized image of the document. Only for + * Result.VISUAL_TEXT and Result.MRZ_TEXT results. * * @return fieldRect */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentFormat.java b/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentFormat.java index 86d61dc6..333da380 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentFormat.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentFormat.java @@ -44,6 +44,9 @@ public enum DocumentFormat { /** ID3 double document format */ ID3_X2(5), + /** Turkey ID2 card */ + ID2_TURKEY(6), + /** ID1 format document rotated 90 ° */ ID1_90(10), @@ -53,7 +56,7 @@ public enum DocumentFormat { /** ID1 format document rotated 270 ° */ ID1_270(12), - /** ID2 format document rotated 90 ° */ + /** ID2 format document rotated 180 ° */ ID2_180(13), /** ID3 format document rotated 180 ° */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidates.java b/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidates.java index 910c07fe..7280dfa3 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidates.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidates.java @@ -56,7 +56,7 @@ public DocumentTypesCandidates recResult( } /** - * Get recResult + * Overall recognition result * * @return recResult */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidatesList.java b/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidatesList.java index 0f2499f4..6422725f 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidatesList.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/DocumentTypesCandidatesList.java @@ -56,7 +56,7 @@ public DocumentTypesCandidatesList recResult( } /** - * Get recResult + * Overall recognition result * * @return recResult */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/FiberItem.java b/client/src/main/generated/com/regula/documentreader/webclient/model/FiberItem.java index 0504e45d..d1eaf6f0 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/FiberItem.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/FiberItem.java @@ -135,7 +135,7 @@ public FiberItem lightValue(@javax.annotation.Nullable Light lightValue) { } /** - * Get lightValue + * For UV_Background authentication result type * * @return lightValue */ @@ -289,7 +289,7 @@ public FiberItem addColorValuesItem(Integer colorValuesItem) { } /** - * Fibers color value + * Fibers color value. Example: [BLUE, GREEN, RED] * * @return colorValues */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/FiberResult.java b/client/src/main/generated/com/regula/documentreader/webclient/model/FiberResult.java index c85e2c32..78a77cb5 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/FiberResult.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/FiberResult.java @@ -134,7 +134,7 @@ public FiberResult lightValue(@javax.annotation.Nullable Light lightValue) { } /** - * Get lightValue + * For UV_Background authentication result type * * @return lightValue */ @@ -288,7 +288,7 @@ public FiberResult addColorValuesItem(Integer colorValuesItem) { } /** - * Fibers color value + * Fibers color value. Example: [BLUE, GREEN, RED] * * @return colorValues */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/IdentItem.java b/client/src/main/generated/com/regula/documentreader/webclient/model/IdentItem.java index c6a85b52..8c1c9b57 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/IdentItem.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/IdentItem.java @@ -139,7 +139,7 @@ public IdentItem image(@javax.annotation.Nonnull ImageData image) { } /** - * Get image + * Original image * * @return image */ @@ -158,7 +158,7 @@ public IdentItem etalonImage(@javax.annotation.Nonnull ImageData etalonImage) { } /** - * Get etalonImage + * Reference image * * @return etalonImage */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/IdentResult.java b/client/src/main/generated/com/regula/documentreader/webclient/model/IdentResult.java index 0da25729..9ad0acb0 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/IdentResult.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/IdentResult.java @@ -139,7 +139,7 @@ public IdentResult image(@javax.annotation.Nonnull ImageData image) { } /** - * Get image + * Original image * * @return image */ @@ -158,7 +158,7 @@ public IdentResult etalonImage(@javax.annotation.Nonnull ImageData etalonImage) } /** - * Get etalonImage + * Reference image * * @return etalonImage */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/ImageQualityCheckList.java b/client/src/main/generated/com/regula/documentreader/webclient/model/ImageQualityCheckList.java index 44f26dc4..2878a721 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/ImageQualityCheckList.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/ImageQualityCheckList.java @@ -62,7 +62,7 @@ public ImageQualityCheckList result(@javax.annotation.Nonnull CheckResult result } /** - * Get result + * Overall image quality status, combined from check statuses in the list. * * @return result */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/ImagesFieldValue.java b/client/src/main/generated/com/regula/documentreader/webclient/model/ImagesFieldValue.java index 063b2495..cbb41c6c 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/ImagesFieldValue.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/ImagesFieldValue.java @@ -132,7 +132,7 @@ public ImagesFieldValue originalValue(@javax.annotation.Nullable String original } /** - * Base64 encoded image + * Only for images from RFID. Image as was originally stored in the RFID chip. * * @return originalValue */ @@ -227,7 +227,7 @@ public ImagesFieldValue fieldRect(@javax.annotation.Nullable RectangleCoordinate } /** - * Get fieldRect + * Only for images from VISUAL. Coordinates of the image in the normalized image of the document. * * @return fieldRect */ @@ -246,7 +246,7 @@ public ImagesFieldValue rfidOrigin(@javax.annotation.Nullable RfidOrigin rfidOri } /** - * Get rfidOrigin + * Only for images from RFID. Image location in RFID chip. * * @return rfidOrigin */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/OneCandidate.java b/client/src/main/generated/com/regula/documentreader/webclient/model/OneCandidate.java index 014e081d..cc57e48a 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/OneCandidate.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/OneCandidate.java @@ -191,7 +191,7 @@ public OneCandidate rfIDPresence(@javax.annotation.Nonnull RfidLocation rfIDPres } /** - * Get rfIDPresence + * Indication of the presence of an RFID chip in the document (electronic document indicator) * * @return rfIDPresence */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/ProcessParams.java b/client/src/main/generated/com/regula/documentreader/webclient/model/ProcessParams.java index 8ca107b4..1de8b9ae 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/ProcessParams.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/ProcessParams.java @@ -840,7 +840,8 @@ public ProcessParams measureSystem(@javax.annotation.Nullable MeasureSystem meas } /** - * Get measureSystem + * This option allows you to set the system of measurement used for converting original values in + * document to output result values. Metric by default. * * @return measureSystem */ @@ -977,7 +978,8 @@ public ProcessParams logLevel(@javax.annotation.Nullable LogLevel logLevel) { } /** - * Get logLevel + * When used together with 'log' parameter enabled, sets the level of logs detalization. + * 'INFO' by default. * * @return logLevel */ @@ -1189,7 +1191,8 @@ public ProcessParams forceDocFormat(@javax.annotation.Nullable DocumentFormat fo } /** - * Get forceDocFormat + * Force use of specified document format when locating and recognizing document to reduce the + * number of candidates. * * @return forceDocFormat */ @@ -1376,7 +1379,8 @@ public ProcessParams convertCase(@javax.annotation.Nullable TextPostProcessing c } /** - * Get convertCase + * This option allows output text case transformation. No changes applied by default to original + * values. * * @return convertCase */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/RfidApplicationType.java b/client/src/main/generated/com/regula/documentreader/webclient/model/RfidApplicationType.java index d00bb1ce..93cc9d3d 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/RfidApplicationType.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/RfidApplicationType.java @@ -53,10 +53,10 @@ public enum RfidApplicationType { /** Digital Travel Credentials */ eDTC_PC(8), - /** Master File */ + /** Applet root */ APPLET_ROOT(50), - /** Applet root */ + /** User defined */ USER_DEFINED(100); private Integer value; diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/Status.java b/client/src/main/generated/com/regula/documentreader/webclient/model/Status.java index 8d86745b..a9ca2a65 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/Status.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/Status.java @@ -100,7 +100,7 @@ public Status overallStatus(@javax.annotation.Nonnull CheckResult overallStatus) } /** - * Get overallStatus + * Overall checks status. Rootx status * * @return overallStatus */ @@ -119,7 +119,7 @@ public Status optical(@javax.annotation.Nonnull CheckResult optical) { } /** - * Get optical + * Overall optical checks combined status * * @return optical */ @@ -138,7 +138,7 @@ public Status portrait(@javax.annotation.Nonnull CheckResult portrait) { } /** - * Get portrait + * Portrait comparison status * * @return portrait */ @@ -157,7 +157,7 @@ public Status rfid(@javax.annotation.Nonnull CheckResult rfid) { } /** - * Get rfid + * Overall RFID checks combined status * * @return rfid */ @@ -176,7 +176,7 @@ public Status stopList(@javax.annotation.Nonnull CheckResult stopList) { } /** - * Get stopList + * Stop list check status * * @return stopList */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/SymbolRecognitionResult.java b/client/src/main/generated/com/regula/documentreader/webclient/model/SymbolRecognitionResult.java index 08bc74b5..40227b55 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/SymbolRecognitionResult.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/SymbolRecognitionResult.java @@ -75,7 +75,7 @@ public SymbolRecognitionResult symbolRect( } /** - * Get symbolRect + * Coordinates of the symbol in the normalized image of the document * * @return symbolRect */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/Text.java b/client/src/main/generated/com/regula/documentreader/webclient/model/Text.java index 40f0e40b..5f039aac 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/Text.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/Text.java @@ -79,7 +79,7 @@ public Text status(@javax.annotation.Nonnull CheckResult status) { } /** - * Get status + * Overall status of all checks from all text fields * * @return status */ @@ -98,7 +98,7 @@ public Text validityStatus(@javax.annotation.Nonnull CheckResult validityStatus) } /** - * Get validityStatus + * Overall status of validity from all text fields from all sources * * @return validityStatus */ @@ -117,7 +117,7 @@ public Text comparisonStatus(@javax.annotation.Nonnull CheckResult comparisonSta } /** - * Get comparisonStatus + * Overall status of data comparison from different sources for each text field * * @return comparisonStatus */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/TextAvailableSource.java b/client/src/main/generated/com/regula/documentreader/webclient/model/TextAvailableSource.java index acaae53f..4152b067 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/TextAvailableSource.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/TextAvailableSource.java @@ -77,7 +77,7 @@ public TextAvailableSource validityStatus(@javax.annotation.Nonnull CheckResult } /** - * Get validityStatus + * Overall status of validity from all fields for given source * * @return validityStatus */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/TextField.java b/client/src/main/generated/com/regula/documentreader/webclient/model/TextField.java index 50324bbd..9a8bc7dd 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/TextField.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/TextField.java @@ -186,7 +186,7 @@ public TextField status(@javax.annotation.Nonnull CheckResult status) { } /** - * Get status + * Overall status of all checks from all values * * @return status */ @@ -205,7 +205,7 @@ public TextField validityStatus(@javax.annotation.Nonnull CheckResult validitySt } /** - * Get validityStatus + * Overall status of validity from all values * * @return validityStatus */ @@ -224,7 +224,7 @@ public TextField comparisonStatus(@javax.annotation.Nonnull CheckResult comparis } /** - * Get comparisonStatus + * Overall status of data comparison from different sources * * @return comparisonStatus */ diff --git a/client/src/main/generated/com/regula/documentreader/webclient/model/TextFieldValue.java b/client/src/main/generated/com/regula/documentreader/webclient/model/TextFieldValue.java index 841c13f3..5070d4b1 100644 --- a/client/src/main/generated/com/regula/documentreader/webclient/model/TextFieldValue.java +++ b/client/src/main/generated/com/regula/documentreader/webclient/model/TextFieldValue.java @@ -246,7 +246,8 @@ public TextFieldValue fieldRect(@javax.annotation.Nullable RectangleCoordinates } /** - * Get fieldRect + * Only for visual and mrz results. Coordinates of the rectangle region on a document image(result + * type 1). Represented by two points - (left, top) + (right, bottom) * * @return fieldRect */ @@ -265,7 +266,7 @@ public TextFieldValue rfidOrigin(@javax.annotation.Nullable RfidOrigin rfidOrigi } /** - * Get rfidOrigin + * Only for RFID images. Text location in RFID chip. * * @return rfidOrigin */