add mrz filter (#19)

Author: hleb-albau

.openapi-generator/FILES

@@ -44,6 +44,7 @@ src/Regula.DocumentReader.WebClient/Model/ImagesFieldValue.cs
 src/Regula.DocumentReader.WebClient/Model/ImagesResult.cs
 src/Regula.DocumentReader.WebClient/Model/LexicalAnalysisResult.cs
 src/Regula.DocumentReader.WebClient/Model/ListVerifiedFields.cs
+src/Regula.DocumentReader.WebClient/Model/MRZFormat.cs
 src/Regula.DocumentReader.WebClient/Model/OCRSecurityTextResult.cs
 src/Regula.DocumentReader.WebClient/Model/OneCandidate.cs
 src/Regula.DocumentReader.WebClient/Model/OriginalSymbol.cs

src/Regula.DocumentReader.WebClient/Model/MRZFormat.cs

@@ -0,0 +1,49 @@
+/* 
+ * Regula Document Reader Web API
+ *
+ * Documents recognition as easy as reading two bytes.  # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core 
+ *
+ * The version of the OpenAPI document: 5.5.0
+ * 
+ * Generated by: https://github.com/openapitools/openapi-generator.git
+ */
+
+using System;
+using System.Linq;
+using System.IO;
+using System.Text;
+using System.Text.RegularExpressions;
+using System.Collections;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+using System.ComponentModel.DataAnnotations;
+using OpenAPIDateConverter = Regula.DocumentReader.WebClient.Client.OpenAPIDateConverter;
+
+namespace Regula.DocumentReader.WebClient.Model
+{
+    public class MRZFormat
+    {
+
+        
+        public const string IDL = "1x30";
+
+        
+        public const string ID1 = "3x30";
+
+        
+        public const string ID2 = "2x36";
+
+        
+        public const string ID3 = "2x44";
+
+        
+        public const string CAN = "1x6";
+
+        
+        public const string ID1_2_30 = "2x30";
+
+    }
+}

src/Regula.DocumentReader.WebClient/Model/ProcessParams.cs

@@ -65,7 +65,8 @@ protected ProcessParams() { }
         /// <param name="shiftExpiryDate">This option allows shifting the date of expiry into the future or past for number of months specified. This is useful, for example, in some cases when document might be still valid for some period after original expiration date to prevent negative validity status for such documents. Or by shifting the date to the past will set negative validity for the documents that is about to expire in a specified number of months..</param>
         /// <param name="minimalHolderAge">This options allows specifying the minimal age in years of the document holder for the document to be considered valid..</param>
         /// <param name="returnUncroppedImage">This option allows returning input images in output if enabled..</param>
-        public ProcessParams(string scenario = default(string), List<int> resultTypeOutput = default(List<int>), bool doublePageSpread = default(bool), bool generateDoublePageSpreadImage = default(bool), List<int> fieldTypesFilter = default(List<int>), string dateFormat = default(string), int measureSystem = default(int), int imageDpiOutMax = default(int), bool alreadyCropped = default(bool), Dictionary<string, Object> customParams = default(Dictionary<string, Object>), bool log = default(bool), string logLevel = default(string), int forceDocID = default(int), bool matchTextFieldMask = default(bool), bool fastDocDetect = default(bool), bool updateOCRValidityByGlare = default(bool), bool checkRequiredTextFields = default(bool), bool returnCroppedBarcode = default(bool), ImageQA imageQA = default(ImageQA), int forceDocFormat = default(int), bool noGraphics = default(bool), float documentAreaMin = default(float), bool depersonalizeLog = default(bool), bool multiDocOnImage = default(bool), int shiftExpiryDate = default(int), int minimalHolderAge = default(int), bool returnUncroppedImage = default(bool))
+        /// <param name="mrzFormatsFilter">This option allows limiting MRZ formats to be recognized by specifying them in array..</param>
+        public ProcessParams(string scenario = default(string), List<int> resultTypeOutput = default(List<int>), bool doublePageSpread = default(bool), bool generateDoublePageSpreadImage = default(bool), List<int> fieldTypesFilter = default(List<int>), string dateFormat = default(string), int measureSystem = default(int), int imageDpiOutMax = default(int), bool alreadyCropped = default(bool), Dictionary<string, Object> customParams = default(Dictionary<string, Object>), bool log = default(bool), string logLevel = default(string), int forceDocID = default(int), bool matchTextFieldMask = default(bool), bool fastDocDetect = default(bool), bool updateOCRValidityByGlare = default(bool), bool checkRequiredTextFields = default(bool), bool returnCroppedBarcode = default(bool), ImageQA imageQA = default(ImageQA), int forceDocFormat = default(int), bool noGraphics = default(bool), float documentAreaMin = default(float), bool depersonalizeLog = default(bool), bool multiDocOnImage = default(bool), int shiftExpiryDate = default(int), int minimalHolderAge = default(int), bool returnUncroppedImage = default(bool), List<MRZFormat> mrzFormatsFilter = default(List<MRZFormat>))
         {
             // to ensure "scenario" is required (not null)
             if (scenario == null)
@@ -103,6 +104,7 @@ protected ProcessParams() { }
             this.ShiftExpiryDate = shiftExpiryDate;
             this.MinimalHolderAge = minimalHolderAge;
             this.ReturnUncroppedImage = returnUncroppedImage;
+            this.MrzFormatsFilter = mrzFormatsFilter;
         }
 
         /// <summary>
@@ -289,6 +291,13 @@ protected ProcessParams() { }
         [DataMember(Name="returnUncroppedImage", EmitDefaultValue=false)]
         public bool ReturnUncroppedImage { get; set; }
 
+        /// <summary>
+        /// This option allows limiting MRZ formats to be recognized by specifying them in array.
+        /// </summary>
+        /// <value>This option allows limiting MRZ formats to be recognized by specifying them in array.</value>
+        [DataMember(Name="mrzFormatsFilter", EmitDefaultValue=false)]
+        public List<MRZFormat> MrzFormatsFilter { get; set; }
+
         /// <summary>
         /// Returns the string presentation of the object
         /// </summary>
@@ -324,6 +333,7 @@ public override string ToString()
             sb.Append("  ShiftExpiryDate: ").Append(ShiftExpiryDate).Append("\n");
             sb.Append("  MinimalHolderAge: ").Append(MinimalHolderAge).Append("\n");
             sb.Append("  ReturnUncroppedImage: ").Append(ReturnUncroppedImage).Append("\n");
+            sb.Append("  MrzFormatsFilter: ").Append(MrzFormatsFilter).Append("\n");
             sb.Append("}\n");
             return sb.ToString();
         }
@@ -495,6 +505,12 @@ public bool Equals(ProcessParams input)
                     this.ReturnUncroppedImage == input.ReturnUncroppedImage ||
                     (this.ReturnUncroppedImage != null &&
                     this.ReturnUncroppedImage.Equals(input.ReturnUncroppedImage))
+                ) && 
+                (
+                    this.MrzFormatsFilter == input.MrzFormatsFilter ||
+                    this.MrzFormatsFilter != null &&
+                    input.MrzFormatsFilter != null &&
+                    this.MrzFormatsFilter.SequenceEqual(input.MrzFormatsFilter)
                 );
         }
 
@@ -561,6 +577,8 @@ public override int GetHashCode()
                     hashCode = hashCode * 59 + this.MinimalHolderAge.GetHashCode();
                 if (this.ReturnUncroppedImage != null)
                     hashCode = hashCode * 59 + this.ReturnUncroppedImage.GetHashCode();
+                if (this.MrzFormatsFilter != null)
+                    hashCode = hashCode * 59 + this.MrzFormatsFilter.GetHashCode();
                 return hashCode;
             }
         }

update-models.sh

@@ -5,7 +5,7 @@ Light=int,Result=int,VerificationResult=int,RfidLocation=int,\
 DocumentTypeRecognitionResult=int,ProcessingStatus=int,Source=string,CheckResult=int,\
 LCID=int,DocumentType=int,MeasureSystem=int,SecurityFeatureType=int,CheckDiagnose=int,\
 Critical=int,Visibility=int,AuthenticityResultType=int,ImageQualityCheckType=int,\
-LogLevel=string"\
+LogLevel=string,MRZFormat=string"\
 \
 && docker run --user "$(id -u):$(id -g)" --rm -v "${PWD}:/client" -v "$DOCS_DEFINITION_FOLDER:/definitions" \
 openapitools/openapi-generator-cli:v5.0.0-beta2 generate \
@@ -16,4 +16,4 @@ openapitools/openapi-generator-cli:v5.0.0-beta2 generate \
 openapitools/openapi-generator-cli:v5.0.0-beta2 generate \
 -i /definitions/index.yml -g csharp -o /client/ \
 -c /client/csharp-generator-config.json -t /client/generator-templates/ \
---import-mappings $ENUM_MAPPINGS
+--import-mappings $ENUM_MAPPINGS