Skip to content

SP-22413 - update models #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2025
Merged

SP-22413 - update models #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ src/Regula.DocumentReader.WebClient/Model/OutData.cs
src/Regula.DocumentReader.WebClient/Model/OutDataTransactionImagesFieldValue.cs
src/Regula.DocumentReader.WebClient/Model/PArrayField.cs
src/Regula.DocumentReader.WebClient/Model/ParsedData.cs
src/Regula.DocumentReader.WebClient/Model/ParsingErrorCodes.cs
src/Regula.DocumentReader.WebClient/Model/ParsingNotificationCodes.cs
src/Regula.DocumentReader.WebClient/Model/PerDocumentConfig.cs
src/Regula.DocumentReader.WebClient/Model/PhotoIdentItem.cs
Expand Down
4 changes: 0 additions & 4 deletions src/Regula.DocumentReader.WebClient/Model/AuthenticityCheckResultItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,9 @@ namespace Regula.DocumentReader.WebClient.Model
[JsonSubtypes.KnownSubType(typeof(PhotoIdentResult), "128")]
[JsonSubtypes.KnownSubType(typeof(IdentResult), "131072")]
[JsonSubtypes.KnownSubType(typeof(FiberResult), "16")]
[JsonSubtypes.KnownSubType(typeof(FiberResult), "16384")]
[JsonSubtypes.KnownSubType(typeof(OCRSecurityTextResult), "16777216")]
[JsonSubtypes.KnownSubType(typeof(SecurityFeatureResult), "2")]
[JsonSubtypes.KnownSubType(typeof(IdentResult), "2048")]
[JsonSubtypes.KnownSubType(typeof(IdentResult), "2097152")]
[JsonSubtypes.KnownSubType(typeof(SecurityFeatureResult), "2147483648")]
[JsonSubtypes.KnownSubType(typeof(PhotoIdentResult), "256")]
[JsonSubtypes.KnownSubType(typeof(IdentResult), "262144")]
[JsonSubtypes.KnownSubType(typeof(IdentResult), "32")]
[JsonSubtypes.KnownSubType(typeof(IdentResult), "32768")]
Expand Down
27 changes: 1 addition & 26 deletions src/Regula.DocumentReader.WebClient/Model/AuthenticityResultType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,6 @@ namespace Regula.DocumentReader.WebClient.Model
/// <value>Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/.</value>
public enum AuthenticityResultType: long
{
/// <summary>
/// Enum NONE for value: 0
/// </summary>
NONE = 0,

/// <summary>
/// Enum UV_LUMINESCENCE for value: 1
/// </summary>
Expand Down Expand Up @@ -77,11 +72,6 @@ public enum AuthenticityResultType: long
/// </summary>
IPI = 128,

/// <summary>
/// Enum IR_PHOTO for value: 256
/// </summary>
IR_PHOTO = 256,

/// <summary>
/// Enum PHOTO_EMBED_TYPE for value: 512
/// </summary>
Expand All @@ -92,11 +82,6 @@ public enum AuthenticityResultType: long
/// </summary>
OVI = 1024,

/// <summary>
/// Enum IR_LUMINESCENCE for value: 2048
/// </summary>
IR_LUMINESCENCE = 2048,

/// <summary>
/// Enum HOLOGRAMS for value: 4096
/// </summary>
Expand All @@ -107,11 +92,6 @@ public enum AuthenticityResultType: long
/// </summary>
PHOTO_AREA = 8192,

/// <summary>
/// Enum UV_BACKGROUND for value: 16384
/// </summary>
UV_BACKGROUND = 16384,

/// <summary>
/// Enum PORTRAIT_COMPARISON for value: 32768
/// </summary>
Expand Down Expand Up @@ -160,12 +140,7 @@ public enum AuthenticityResultType: long
/// <summary>
/// Enum ENCRYPTED_IPI for value: 16777216
/// </summary>
ENCRYPTED_IPI = 16777216,

/// <summary>
/// Enum STATUS_ONLY for value: 2147483648
/// </summary>
STATUS_ONLY = 2147483648
ENCRYPTED_IPI = 16777216
}

}
7 changes: 1 addition & 6 deletions src/Regula.DocumentReader.WebClient/Model/BarcodeType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,12 +130,7 @@ public enum BarcodeType
/// <summary>
/// Enum JABCODE for value: 19
/// </summary>
JABCODE = 19,

/// <summary>
/// Enum END for value: 20
/// </summary>
END = 20
JABCODE = 19
}

}
16 changes: 3 additions & 13 deletions src/Regula.DocumentReader.WebClient/Model/DocumentImage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,10 @@ public partial class DocumentImage : IValidatableObject
/// <summary>
/// Initializes a new instance of the <see cref="DocumentImage" /> class.
/// </summary>
[JsonConstructorAttribute]
protected DocumentImage() { }
/// <summary>
/// Initializes a new instance of the <see cref="DocumentImage" /> class.
/// </summary>
/// <param name="image">Base64 encoded image (required).</param>
/// <param name="image">Base64 encoded image.</param>
/// <param name="format">Image format.</param>
public DocumentImage(string image = default(string), string format = default(string))
{
// to ensure "image" is required (not null)
if (image == null)
{
throw new ArgumentNullException("image is a required property for DocumentImage and cannot be null");
}
this.Image = image;
this.Format = format;
}
Expand All @@ -60,8 +50,8 @@ protected DocumentImage() { }
/*
<example>Base64 encoded image</example>
*/
[DataMember(Name = "image", IsRequired = true, EmitDefaultValue = true)]
public string Image { get; set; }
[DataMember(Name = "image", EmitDefaultValue = false)]
public string? Image { get; set; }

/// <summary>
/// Image format
Expand Down
2 changes: 1 addition & 1 deletion src/Regula.DocumentReader.WebClient/Model/EncryptedRCLItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ protected EncryptedRCLItem() { }
/// </summary>
/// <value>Base64 encoded data</value>
/*
<example>[B@2c674fca</example>
<example>[B@6dc09404</example>
*/
[DataMember(Name = "EncryptedRCL", IsRequired = true, EmitDefaultValue = true)]
public byte[] EncryptedRCL { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/Regula.DocumentReader.WebClient/Model/EncryptedRCLResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ protected EncryptedRCLResult() { }
/// </summary>
/// <value>Base64 encoded data</value>
/*
<example>[B@2c674fca</example>
<example>[B@6dc09404</example>
*/
[DataMember(Name = "EncryptedRCL", IsRequired = true, EmitDefaultValue = true)]
public byte[] EncryptedRCL { get; set; }
Expand Down
11 changes: 10 additions & 1 deletion src/Regula.DocumentReader.WebClient/Model/FiberItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ protected FiberItem() { }
/// <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>
public FiberItem(int rectCount = default(int), int expectedCount = default(int), Light? lightValue = default(Light?), int lightDisp = default(int), List<RectangleCoordinates> rectArray = default(List<RectangleCoordinates>), List<int> width = default(List<int>), List<int> length = default(List<int>), List<int> area = default(List<int>), List<int> colorValues = default(List<int>))
/// <param name="errorCode">errorCode.</param>
public FiberItem(int rectCount = default(int), int expectedCount = default(int), Light? lightValue = default(Light?), int lightDisp = default(int), List<RectangleCoordinates> rectArray = default(List<RectangleCoordinates>), List<int> width = default(List<int>), List<int> length = default(List<int>), List<int> area = default(List<int>), List<int> colorValues = default(List<int>), int errorCode = default(int))
{
this.RectCount = rectCount;
this.ExpectedCount = expectedCount;
Expand Down Expand Up @@ -91,6 +92,7 @@ protected FiberItem() { }
this.ColorValues = colorValues;
this.LightValue = lightValue;
this.LightDisp = lightDisp;
this.ErrorCode = errorCode;
}

/// <summary>
Expand Down Expand Up @@ -152,6 +154,12 @@ protected FiberItem() { }
[DataMember(Name = "ColorValues", IsRequired = true, EmitDefaultValue = true)]
public List<int> ColorValues { get; set; }

/// <summary>
/// Gets or Sets ErrorCode
/// </summary>
[DataMember(Name = "ErrorCode", EmitDefaultValue = false)]
public int? ErrorCode { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -169,6 +177,7 @@ public override string ToString()
sb.Append(" Length: ").Append(Length).Append("\n");
sb.Append(" Area: ").Append(Area).Append("\n");
sb.Append(" ColorValues: ").Append(ColorValues).Append("\n");
sb.Append(" ErrorCode: ").Append(ErrorCode).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
11 changes: 10 additions & 1 deletion src/Regula.DocumentReader.WebClient/Model/FiberResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@
/// <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="errorCode">errorCode.</param>
/// <param name="type">type (required) (default to AuthenticityResultType.UV_FIBERS).</param>
/// <param name="elementResult">elementResult.</param>
/// <param name="elementDiagnose">elementDiagnose.</param>
/// <param name="percentValue">percentValue.</param>
public FiberResult(int rectCount = default(int), int expectedCount = default(int), Light? lightValue = default(Light?), int lightDisp = default(int), List<RectangleCoordinates> rectArray = default(List<RectangleCoordinates>), List<int> width = default(List<int>), List<int> length = default(List<int>), List<int> area = default(List<int>), List<int> colorValues = default(List<int>), AuthenticityResultType type = AuthenticityResultType.UV_FIBERS, CheckResult? elementResult = default(CheckResult?), CheckDiagnose? elementDiagnose = default(CheckDiagnose?), int percentValue = default(int)) : base(type, elementResult, elementDiagnose, percentValue)
public FiberResult(int rectCount = default(int), int expectedCount = default(int), Light? lightValue = default(Light?), int lightDisp = default(int), List<RectangleCoordinates> rectArray = default(List<RectangleCoordinates>), List<int> width = default(List<int>), List<int> length = default(List<int>), List<int> area = default(List<int>), List<int> colorValues = default(List<int>), int errorCode = default(int), AuthenticityResultType type = AuthenticityResultType.UV_FIBERS, CheckResult? elementResult = default(CheckResult?), CheckDiagnose? elementDiagnose = default(CheckDiagnose?), int percentValue = default(int)) : base(type, elementResult, elementDiagnose, percentValue)
{
this.RectCount = rectCount;
this.ExpectedCount = expectedCount;
Expand Down Expand Up @@ -96,6 +97,7 @@
this.ColorValues = colorValues;
this.LightValue = lightValue;
this.LightDisp = lightDisp;
this.ErrorCode = errorCode;
}

/// <summary>
Expand Down Expand Up @@ -157,6 +159,12 @@
[DataMember(Name = "ColorValues", IsRequired = true, EmitDefaultValue = true)]
public List<int> ColorValues { get; set; }

/// <summary>
/// Gets or Sets ErrorCode
/// </summary>
[DataMember(Name = "ErrorCode", EmitDefaultValue = false)]
public int? ErrorCode { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -175,6 +183,7 @@
sb.Append(" Length: ").Append(Length).Append("\n");
sb.Append(" Area: ").Append(Area).Append("\n");
sb.Append(" ColorValues: ").Append(ColorValues).Append("\n");
sb.Append(" ErrorCode: ").Append(ErrorCode).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -203,7 +212,7 @@
/// </summary>
/// <param name="validationContext">Validation context</param>
/// <returns>Validation Result</returns>
protected IEnumerable<ValidationResult> BaseValidate(ValidationContext validationContext)

Check warning on line 215 in src/Regula.DocumentReader.WebClient/Model/FiberResult.cs

View workflow job for this annotation

GitHub Actions / run_smoke_test 

'FiberResult.BaseValidate(ValidationContext)' hides inherited member 'AuthenticityCheckResultItem.BaseValidate(ValidationContext)'. Use the new keyword if hiding was intended.
{
foreach (var x in base.BaseValidate(validationContext))
{
Expand Down
20 changes: 19 additions & 1 deletion src/Regula.DocumentReader.WebClient/Model/IdentItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ protected IdentItem() { }
/// <param name="image">image (required).</param>
/// <param name="etalonImage">etalonImage (required).</param>
/// <param name="areaList">areaList.</param>
public IdentItem(SecurityFeatureType elementType = default(SecurityFeatureType), Light lightIndex = default(Light), RectangleCoordinates area = default(RectangleCoordinates), ImageData image = default(ImageData), ImageData etalonImage = default(ImageData), AreaContainer areaList = default(AreaContainer))
/// <param name="elementID">elementID.</param>
/// <param name="result">result.</param>
public IdentItem(SecurityFeatureType elementType = default(SecurityFeatureType), Light lightIndex = default(Light), RectangleCoordinates area = default(RectangleCoordinates), ImageData image = default(ImageData), ImageData etalonImage = default(ImageData), AreaContainer areaList = default(AreaContainer), int elementID = default(int), int result = default(int))
{
this.ElementType = elementType;
this.LightIndex = lightIndex;
Expand All @@ -76,6 +78,8 @@ protected IdentItem() { }
this.EtalonImage = etalonImage;
this.Area = area;
this.AreaList = areaList;
this.ElementID = elementID;
this.Result = result;
}

/// <summary>
Expand All @@ -102,6 +106,18 @@ protected IdentItem() { }
[DataMember(Name = "AreaList", EmitDefaultValue = false)]
public AreaContainer? AreaList { get; set; }

/// <summary>
/// Gets or Sets ElementID
/// </summary>
[DataMember(Name = "ElementID", EmitDefaultValue = false)]
public int? ElementID { get; set; }

/// <summary>
/// Gets or Sets Result
/// </summary>
[DataMember(Name = "Result", EmitDefaultValue = false)]
public int? Result { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -116,6 +132,8 @@ public override string ToString()
sb.Append(" Image: ").Append(Image).Append("\n");
sb.Append(" EtalonImage: ").Append(EtalonImage).Append("\n");
sb.Append(" AreaList: ").Append(AreaList).Append("\n");
sb.Append(" ElementID: ").Append(ElementID).Append("\n");
sb.Append(" Result: ").Append(Result).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
20 changes: 19 additions & 1 deletion src/Regula.DocumentReader.WebClient/Model/IdentResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,13 @@
/// <param name="image">image (required).</param>
/// <param name="etalonImage">etalonImage (required).</param>
/// <param name="areaList">areaList.</param>
/// <param name="elementID">elementID.</param>
/// <param name="result">result.</param>
/// <param name="type">type (required) (default to AuthenticityResultType.IMAGE_PATTERN).</param>
/// <param name="elementResult">elementResult.</param>
/// <param name="elementDiagnose">elementDiagnose.</param>
/// <param name="percentValue">percentValue.</param>
public IdentResult(SecurityFeatureType elementType = default(SecurityFeatureType), Light lightIndex = default(Light), RectangleCoordinates area = default(RectangleCoordinates), ImageData image = default(ImageData), ImageData etalonImage = default(ImageData), AreaContainer areaList = default(AreaContainer), AuthenticityResultType type = AuthenticityResultType.IMAGE_PATTERN, CheckResult? elementResult = default(CheckResult?), CheckDiagnose? elementDiagnose = default(CheckDiagnose?), int percentValue = default(int)) : base(type, elementResult, elementDiagnose, percentValue)
public IdentResult(SecurityFeatureType elementType = default(SecurityFeatureType), Light lightIndex = default(Light), RectangleCoordinates area = default(RectangleCoordinates), ImageData image = default(ImageData), ImageData etalonImage = default(ImageData), AreaContainer areaList = default(AreaContainer), int elementID = default(int), int result = default(int), AuthenticityResultType type = AuthenticityResultType.IMAGE_PATTERN, CheckResult? elementResult = default(CheckResult?), CheckDiagnose? elementDiagnose = default(CheckDiagnose?), int percentValue = default(int)) : base(type, elementResult, elementDiagnose, percentValue)
{
this.ElementType = elementType;
this.LightIndex = lightIndex;
Expand All @@ -81,6 +83,8 @@
this.EtalonImage = etalonImage;
this.Area = area;
this.AreaList = areaList;
this.ElementID = elementID;
this.Result = result;
}

/// <summary>
Expand All @@ -107,6 +111,18 @@
[DataMember(Name = "AreaList", EmitDefaultValue = false)]
public AreaContainer? AreaList { get; set; }

/// <summary>
/// Gets or Sets ElementID
/// </summary>
[DataMember(Name = "ElementID", EmitDefaultValue = false)]
public int? ElementID { get; set; }

/// <summary>
/// Gets or Sets Result
/// </summary>
[DataMember(Name = "Result", EmitDefaultValue = false)]
public int? Result { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -122,6 +138,8 @@
sb.Append(" Image: ").Append(Image).Append("\n");
sb.Append(" EtalonImage: ").Append(EtalonImage).Append("\n");
sb.Append(" AreaList: ").Append(AreaList).Append("\n");
sb.Append(" ElementID: ").Append(ElementID).Append("\n");
sb.Append(" Result: ").Append(Result).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -150,7 +168,7 @@
/// </summary>
/// <param name="validationContext">Validation context</param>
/// <returns>Validation Result</returns>
protected IEnumerable<ValidationResult> BaseValidate(ValidationContext validationContext)

Check warning on line 171 in src/Regula.DocumentReader.WebClient/Model/IdentResult.cs

View workflow job for this annotation

GitHub Actions / run_smoke_test 

'IdentResult.BaseValidate(ValidationContext)' hides inherited member 'AuthenticityCheckResultItem.BaseValidate(ValidationContext)'. Use the new keyword if hiding was intended.
{
foreach (var x in base.BaseValidate(validationContext))
{
Expand Down
16 changes: 3 additions & 13 deletions src/Regula.DocumentReader.WebClient/Model/ImageData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,10 @@ public partial class ImageData : IValidatableObject
/// <summary>
/// Initializes a new instance of the <see cref="ImageData" /> class.
/// </summary>
[JsonConstructorAttribute]
protected ImageData() { }
/// <summary>
/// Initializes a new instance of the <see cref="ImageData" /> class.
/// </summary>
/// <param name="image">Base64 encoded image (required).</param>
/// <param name="image">Base64 encoded image.</param>
/// <param name="format">Image format.</param>
public ImageData(string image = default(string), string format = default(string))
{
// to ensure "image" is required (not null)
if (image == null)
{
throw new ArgumentNullException("image is a required property for ImageData and cannot be null");
}
this.Image = image;
this.Format = format;
}
Expand All @@ -60,8 +50,8 @@ protected ImageData() { }
/*
<example>Base64 encoded image</example>
*/
[DataMember(Name = "image", IsRequired = true, EmitDefaultValue = true)]
public string Image { get; set; }
[DataMember(Name = "image", EmitDefaultValue = false)]
public string? Image { get; set; }

/// <summary>
/// Image format
Expand Down
2 changes: 1 addition & 1 deletion src/Regula.DocumentReader.WebClient/Model/LicenseItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ protected LicenseItem() { }
/// </summary>
/// <value>Base64 encoded data</value>
/*
<example>[B@27d64419</example>
<example>[B@36bf430f</example>
*/
[DataMember(Name = "License", IsRequired = true, EmitDefaultValue = true)]
public byte[] License { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/Regula.DocumentReader.WebClient/Model/LicenseResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ protected LicenseResult() { }
/// </summary>
/// <value>Base64 encoded data</value>
/*
<example>[B@27d64419</example>
<example>[B@36bf430f</example>
*/
[DataMember(Name = "License", IsRequired = true, EmitDefaultValue = true)]
public byte[] License { get; set; }
Expand Down
Loading
Loading