Commit: d3901898

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

@@ -34,8 +34,9 @@ public partial class ChosenDocumentType : IValidatableObject
     {
 
         /// <summary>
-        /// Gets or Sets RFIDPresence
+        /// Indication of the presence of an RFID chip in the document (electronic document indicator)
         /// </summary>
+        /// <value>Indication of the presence of an RFID chip in the document (electronic document indicator)</value>
         [DataMember(Name = "RFID_Presence", IsRequired = true, EmitDefaultValue = true)]
         public RfidLocation RFIDPresence { get; set; }
         /// <summary>
@@ -50,7 +51,7 @@ protected ChosenDocumentType() { }
         /// <param name="iD">Unique document type template identifier (Regula&#39;s internal numeric code) (required).</param>
         /// <param name="p">A measure of the likelihood of correct recognition in the analysis of this type of document (required).</param>
         /// <param name="rotated180">Indicates if the document of the given type is rotated by 180 degrees (required).</param>
-        /// <param name="rFIDPresence">rFIDPresence (required).</param>
+        /// <param name="rFIDPresence">Indication of the presence of an RFID chip in the document (electronic document indicator) (required).</param>
         /// <param name="fDSIDList">fDSIDList.</param>
         /// <param name="necessaryLights">Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document (required).</param>
         /// <param name="checkAuthenticity">Set of authentication options provided for this type of document (combination of Authenticity enum) (required).</param>

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

@@ -34,44 +34,51 @@ public partial class DetailsOptical : IValidatableObject
     {
 
         /// <summary>
-        /// Gets or Sets OverallStatus
+        /// Overall optical checks combined status
         /// </summary>
+        /// <value>Overall optical checks combined status</value>
         [DataMember(Name = "overallStatus", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult OverallStatus { get; set; }
 
         /// <summary>
-        /// Gets or Sets DocType
+        /// Status of document type recognition
         /// </summary>
+        /// <value>Status of document type recognition</value>
         [DataMember(Name = "docType", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult DocType { get; set; }
 
         /// <summary>
-        /// Gets or Sets Expiry
+        /// Status of document expiration
         /// </summary>
+        /// <value>Status of document expiration</value>
         [DataMember(Name = "expiry", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult Expiry { get; set; }
 
         /// <summary>
-        /// Gets or Sets ImageQA
+        /// Status of document image quality check
         /// </summary>
+        /// <value>Status of document image quality check</value>
         [DataMember(Name = "imageQA", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult ImageQA { get; set; }
 
         /// <summary>
-        /// Gets or Sets Mrz
+        /// Status of document MRZ
         /// </summary>
+        /// <value>Status of document MRZ</value>
         [DataMember(Name = "mrz", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult Mrz { get; set; }
 
         /// <summary>
-        /// Gets or Sets Security
+        /// Authenticity verification status
         /// </summary>
+        /// <value>Authenticity verification status</value>
         [DataMember(Name = "security", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult Security { get; set; }
 
         /// <summary>
-        /// Gets or Sets Text
+        /// Status of text fields analysis
         /// </summary>
+        /// <value>Status of text fields analysis</value>
         [DataMember(Name = "text", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult Text { get; set; }
         /// <summary>
@@ -82,14 +89,14 @@ protected DetailsOptical() { }
         /// <summary>
         /// Initializes a new instance of the <see cref="DetailsOptical" /> class.
         /// </summary>
-        /// <param name="overallStatus">overallStatus (required).</param>
-        /// <param name="docType">docType (required).</param>
-        /// <param name="expiry">expiry (required).</param>
-        /// <param name="imageQA">imageQA (required).</param>
-        /// <param name="mrz">mrz (required).</param>
+        /// <param name="overallStatus">Overall optical checks combined status (required).</param>
+        /// <param name="docType">Status of document type recognition (required).</param>
+        /// <param name="expiry">Status of document expiration (required).</param>
+        /// <param name="imageQA">Status of document image quality check (required).</param>
+        /// <param name="mrz">Status of document MRZ (required).</param>
         /// <param name="pagesCount">Number of processed pages in the document (required).</param>
-        /// <param name="security">security (required).</param>
-        /// <param name="text">text (required).</param>
+        /// <param name="security">Authenticity verification status (required).</param>
+        /// <param name="text">Status of text fields analysis (required).</param>
         /// <param name="vds">vds.</param>
         public DetailsOptical(CheckResult overallStatus = default, CheckResult docType = default, CheckResult expiry = default, CheckResult imageQA = default, CheckResult mrz = default, int pagesCount = default, CheckResult security = default, CheckResult text = default, int? vds = default)
         {

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

@@ -34,44 +34,51 @@ public partial class DetailsRFID : IValidatableObject
     {
 
         /// <summary>
-        /// Gets or Sets OverallStatus
+        /// Overall RFID checks combined status
         /// </summary>
+        /// <value>Overall RFID checks combined status</value>
         [DataMember(Name = "overallStatus", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult OverallStatus { get; set; }
 
         /// <summary>
-        /// Gets or Sets AA
+        /// Active Authentication status
         /// </summary>
+        /// <value>Active Authentication status</value>
         [DataMember(Name = "AA", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult AA { get; set; }
 
         /// <summary>
-        /// Gets or Sets BAC
+        /// Basic Access Control (BAC) status
         /// </summary>
+        /// <value>Basic Access Control (BAC) status</value>
         [DataMember(Name = "BAC", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult BAC { get; set; }
 
         /// <summary>
-        /// Gets or Sets CA
+        /// Chip Authentication status
         /// </summary>
+        /// <value>Chip Authentication status</value>
         [DataMember(Name = "CA", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult CA { get; set; }
 
         /// <summary>
-        /// Gets or Sets PA
+        /// Passive Authentication status
         /// </summary>
+        /// <value>Passive Authentication status</value>
         [DataMember(Name = "PA", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult PA { get; set; }
 
         /// <summary>
-        /// Gets or Sets PACE
+        /// Password Authenticated Connection Establishment (PACE) status
         /// </summary>
+        /// <value>Password Authenticated Connection Establishment (PACE) status</value>
         [DataMember(Name = "PACE", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult PACE { get; set; }
 
         /// <summary>
-        /// Gets or Sets TA
+        /// Terminal Authentication status
         /// </summary>
+        /// <value>Terminal Authentication status</value>
         [DataMember(Name = "TA", IsRequired = true, EmitDefaultValue = true)]
         public CheckResult TA { get; set; }
         /// <summary>
@@ -82,13 +89,13 @@ protected DetailsRFID() { }
         /// <summary>
         /// Initializes a new instance of the <see cref="DetailsRFID" /> class.
         /// </summary>
-        /// <param name="overallStatus">overallStatus (required).</param>
-        /// <param name="aA">aA (required).</param>
-        /// <param name="bAC">bAC (required).</param>
-        /// <param name="cA">cA (required).</param>
-        /// <param name="pA">pA (required).</param>
-        /// <param name="pACE">pACE (required).</param>
-        /// <param name="tA">tA (required).</param>
+        /// <param name="overallStatus">Overall RFID checks combined status (required).</param>
+        /// <param name="aA">Active Authentication status (required).</param>
+        /// <param name="bAC">Basic Access Control (BAC) status (required).</param>
+        /// <param name="cA">Chip Authentication status (required).</param>
+        /// <param name="pA">Passive Authentication status (required).</param>
+        /// <param name="pACE">Password Authenticated Connection Establishment (PACE) status (required).</param>
+        /// <param name="tA">Terminal Authentication status (required).</param>
         public DetailsRFID(CheckResult overallStatus = default, CheckResult aA = default, CheckResult bAC = default, CheckResult cA = default, CheckResult pA = default, CheckResult pACE = default, CheckResult tA = default)
         {
             this.OverallStatus = overallStatus;

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

@@ -40,7 +40,7 @@ protected DocVisualExtendedField() { }
         /// <summary>
         /// Initializes a new instance of the <see cref="DocVisualExtendedField" /> class.
         /// </summary>
-        /// <param name="fieldRect">fieldRect (required).</param>
+        /// <param name="fieldRect">Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. (required).</param>
         /// <param name="wFieldType">wFieldType (required).</param>
         /// <param name="fieldName">Field symbolic name (null-terminated string) (required).</param>
         /// <param name="stringsCount">Number of StringsResult array elements (required).</param>
@@ -64,8 +64,9 @@ public DocVisualExtendedField(RectangleCoordinates fieldRect = default, TextFiel
         }
 
         /// <summary>
-        /// Gets or Sets FieldRect
+        /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.
         /// </summary>
+        /// <value>Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.</value>
         [DataMember(Name = "FieldRect", IsRequired = true, EmitDefaultValue = true)]
         public RectangleCoordinates FieldRect { get; set; }
 

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

@@ -40,7 +40,7 @@ protected DocVisualExtendedFieldItem() { }
         /// <summary>
         /// Initializes a new instance of the <see cref="DocVisualExtendedFieldItem" /> class.
         /// </summary>
-        /// <param name="fieldRect">fieldRect (required).</param>
+        /// <param name="fieldRect">Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. (required).</param>
         public DocVisualExtendedFieldItem(RectangleCoordinates fieldRect = default)
         {
             // to ensure "fieldRect" is required (not null)
@@ -52,8 +52,9 @@ public DocVisualExtendedFieldItem(RectangleCoordinates fieldRect = default)
         }
 
         /// <summary>
-        /// Gets or Sets FieldRect
+        /// Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.
         /// </summary>
+        /// <value>Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.</value>
         [DataMember(Name = "FieldRect", IsRequired = true, EmitDefaultValue = true)]
         public RectangleCoordinates FieldRect { get; set; }
 

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

@@ -67,6 +67,11 @@ public enum DocumentFormat
         /// </summary>
         ID3_X2 = 5,
 
+        /// <summary>
+        /// Enum ID2_TURKEY for value: 6
+        /// </summary>
+        ID2_TURKEY = 6,
+
         /// <summary>
         /// Enum ID1_90 for value: 10
         /// </summary>

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

@@ -34,14 +34,15 @@ public partial class DocumentTypesCandidates : IValidatableObject
     {
 
         /// <summary>
-        /// Gets or Sets RecResult
+        /// Overall recognition result
         /// </summary>
+        /// <value>Overall recognition result</value>
         [DataMember(Name = "RecResult", EmitDefaultValue = false)]
         public DocumentTypeRecognitionResult? RecResult { get; set; }
         /// <summary>
         /// Initializes a new instance of the <see cref="DocumentTypesCandidates" /> class.
         /// </summary>
-        /// <param name="recResult">recResult.</param>
+        /// <param name="recResult">Overall recognition result.</param>
         /// <param name="candidates">candidates.</param>
         public DocumentTypesCandidates(DocumentTypeRecognitionResult? recResult = default, List<OneCandidate> candidates = default)
         {

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

@@ -34,14 +34,15 @@ public partial class DocumentTypesCandidatesList : IValidatableObject
     {
 
         /// <summary>
-        /// Gets or Sets RecResult
+        /// Overall recognition result
         /// </summary>
+        /// <value>Overall recognition result</value>
         [DataMember(Name = "RecResult", EmitDefaultValue = false)]
         public DocumentTypeRecognitionResult? RecResult { get; set; }
         /// <summary>
         /// Initializes a new instance of the <see cref="DocumentTypesCandidatesList" /> class.
         /// </summary>
-        /// <param name="recResult">recResult.</param>
+        /// <param name="recResult">Overall recognition result.</param>
         /// <param name="candidates">candidates.</param>
         public DocumentTypesCandidatesList(DocumentTypeRecognitionResult? recResult = default, List<OneCandidate> candidates = default)
         {

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

@@ -56,7 +56,7 @@ public EncryptedRCLItem(byte[] encryptedRCL = default)
         /// </summary>
         /// <value>Base64 encoded data</value>
         /*
-        <example>[B@708d2ee3</example>
+        <example>[B@36e73f43</example>
         */
         [DataMember(Name = "EncryptedRCL", IsRequired = true, EmitDefaultValue = true)]
         public byte[] EncryptedRCL { get; set; }

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

@@ -62,7 +62,7 @@
         /// </summary>
         /// <value>Base64 encoded data</value>
         /*
-        <example>[B@708d2ee3</example>
+        <example>[B@36e73f43</example>
         */
         [DataMember(Name = "EncryptedRCL", IsRequired = true, EmitDefaultValue = true)]
         public byte[] EncryptedRCL { get; set; }
@@ -105,7 +105,7 @@
         /// </summary>
         /// <param name="validationContext">Validation context</param>
         /// <returns>Validation Result</returns>
         protected IEnumerable<ValidationResult> BaseValidate(ValidationContext validationContext)
         {
             foreach (var x in base.BaseValidate(validationContext))
             {

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

@@ -34,8 +34,9 @@ public partial class FiberItem : IValidatableObject
     {
 
         /// <summary>
-        /// Gets or Sets LightValue
+        /// For UV_Background authentication result type
         /// </summary>
+        /// <value>For UV_Background authentication result type</value>
         [DataMember(Name = "LightValue", EmitDefaultValue = false)]
         public Light? LightValue { get; set; }
         /// <summary>
@@ -48,13 +49,13 @@ protected FiberItem() { }
         /// </summary>
         /// <param name="rectCount">For UV_Fibers authenticity result type (required).</param>
         /// <param name="expectedCount">Expected fibers number. For UV_Fibers authentication result type (required).</param>
-        /// <param name="lightValue">lightValue.</param>
+        /// <param name="lightValue">For UV_Background authentication result type.</param>
         /// <param name="lightDisp">For UV_Background authentication result type.</param>
         /// <param name="rectArray">Coordinates of located areas for defined fibers type (required).</param>
         /// <param name="width">Fibers width value for located areas (in pixels) (required).</param>
         /// <param name="length">Fibers length value for located areas (in pixels) (required).</param>
         /// <param name="area">Fibers value for areas (in pixels) (required).</param>
-        /// <param name="colorValues">Fibers color value (required).</param>
+        /// <param name="colorValues">Fibers color value. Example: [BLUE, GREEN, RED] (required).</param>
         public FiberItem(int rectCount = default, int expectedCount = default, Light? lightValue = default, int? lightDisp = default, List<RectangleCoordinates> rectArray = default, List<int> width = default, List<int> length = default, List<int> area = default, List<int> colorValues = default)
         {
             this.RectCount = rectCount;
@@ -143,11 +144,11 @@ public FiberItem(int rectCount = default, int expectedCount = default, Light? li
         public List<int> Area { get; set; }
 
         /// <summary>
-        /// Fibers color value
+        /// Fibers color value. Example: [BLUE, GREEN, RED]
         /// </summary>
-        /// <value>Fibers color value</value>
+        /// <value>Fibers color value. Example: [BLUE, GREEN, RED]</value>
         /*
-        <example>[&quot;BLUE&quot;,&quot;GREEN&quot;,&quot;RED&quot;]</example>
+        <example>[233,120,201]</example>
         */
         [DataMember(Name = "ColorValues", IsRequired = true, EmitDefaultValue = true)]
         public List<int> ColorValues { get; set; }

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

@@ -35,8 +35,9 @@ public partial class FiberResult : AuthenticityCheckResultItem, IValidatableObje
     {
 
         /// <summary>
-        /// Gets or Sets LightValue
+        /// For UV_Background authentication result type
         /// </summary>
+        /// <value>For UV_Background authentication result type</value>
         [DataMember(Name = "LightValue", EmitDefaultValue = false)]
         public Light? LightValue { get; set; }
         /// <summary>
@@ -49,13 +50,13 @@ protected FiberResult() { }
         /// </summary>
         /// <param name="rectCount">For UV_Fibers authenticity result type (required).</param>
         /// <param name="expectedCount">Expected fibers number. For UV_Fibers authentication result type (required).</param>
-        /// <param name="lightValue">lightValue.</param>
+        /// <param name="lightValue">For UV_Background authentication result type.</param>
         /// <param name="lightDisp">For UV_Background authentication result type.</param>
         /// <param name="rectArray">Coordinates of located areas for defined fibers type (required).</param>
         /// <param name="width">Fibers width value for located areas (in pixels) (required).</param>
         /// <param name="length">Fibers length value for located areas (in pixels) (required).</param>
         /// <param name="area">Fibers value for areas (in pixels) (required).</param>
-        /// <param name="colorValues">Fibers color value (required).</param>
+        /// <param name="colorValues">Fibers color value. Example: [BLUE, GREEN, RED] (required).</param>
         /// <param name="type">type (required) (default to AuthenticityResultType.UV_FIBERS).</param>
         /// <param name="elementResult">elementResult.</param>
         /// <param name="elementDiagnose">elementDiagnose.</param>
@@ -148,11 +149,11 @@ public FiberResult(int rectCount = default, int expectedCount = default, Light?
         public List<int> Area { get; set; }
 
         /// <summary>
-        /// Fibers color value
+        /// Fibers color value. Example: [BLUE, GREEN, RED]
         /// </summary>
-        /// <value>Fibers color value</value>
+        /// <value>Fibers color value. Example: [BLUE, GREEN, RED]</value>
         /*
-        <example>[BLUE, GREEN, RED]</example>
+        <example>[233, 120, 201]</example>
         */
         [DataMember(Name = "ColorValues", IsRequired = true, EmitDefaultValue = true)]
         public List<int> ColorValues { get; set; }