From 2a61adb64470d1000f45bba61180da81749e7ced Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 20 Nov 2024 15:13:32 +0300 Subject: [PATCH] SP-19158 - add DTC --- src/.openapi-generator/FILES | 2 + src/models/authenticity-result.ts | 1 + src/models/byte-array-result-all-of.ts | 31 ++++++++++++++ src/models/byte-array-result.ts | 41 +++++++++++++++++++ src/models/chosen-document-type-result.ts | 1 + src/models/container-list.ts | 5 ++- src/models/doc-bar-code-info.ts | 1 + src/models/document-image-result.ts | 1 + src/models/document-position-result.ts | 1 + .../document-types-candidates-result.ts | 1 + src/models/encrypted-rclresult.ts | 1 + src/models/graphics-result.ts | 1 + src/models/image-quality-result.ts | 1 + src/models/images-result.ts | 1 + src/models/index.ts | 2 + src/models/lexical-analysis-result.ts | 1 + src/models/license-result.ts | 1 + src/models/process-params.ts | 6 +++ src/models/process-request.ts | 6 +++ src/models/result-item.ts | 1 + src/models/result.ts | 6 ++- src/models/status-result.ts | 1 + src/models/text-data-result.ts | 1 + src/models/text-result.ts | 1 + update-models.sh | 2 + 25 files changed, 114 insertions(+), 3 deletions(-) create mode 100644 src/models/byte-array-result-all-of.ts create mode 100644 src/models/byte-array-result.ts diff --git a/src/.openapi-generator/FILES b/src/.openapi-generator/FILES index 83740c1f..1f54ce62 100755 --- a/src/.openapi-generator/FILES +++ b/src/.openapi-generator/FILES @@ -14,6 +14,8 @@ models/authenticity-result-type.ts models/authenticity-result.ts models/bc-pdf417-info.ts models/bc-roidetect.ts +models/byte-array-result-all-of.ts +models/byte-array-result.ts models/check-diagnose.ts models/check-result.ts models/chosen-document-type-result-all-of.ts diff --git a/src/models/authenticity-result.ts b/src/models/authenticity-result.ts index 5486dc86..83ad1fa2 100644 --- a/src/models/authenticity-result.ts +++ b/src/models/authenticity-result.ts @@ -15,6 +15,7 @@ import { AuthenticityCheckList } from './authenticity-check-list'; import { AuthenticityResultAllOf } from './authenticity-result-all-of'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/byte-array-result-all-of.ts b/src/models/byte-array-result-all-of.ts new file mode 100644 index 00000000..39ab8e3b --- /dev/null +++ b/src/models/byte-array-result-all-of.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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: 7.2.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface ByteArrayResultAllOf + */ +export interface ByteArrayResultAllOf { + /** + * Byte array in base64 + * @type {string} + * @memberof ByteArrayResultAllOf + */ + ByteArray: string; +} + + diff --git a/src/models/byte-array-result.ts b/src/models/byte-array-result.ts new file mode 100644 index 00000000..023cca59 --- /dev/null +++ b/src/models/byte-array-result.ts @@ -0,0 +1,41 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * 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: 7.2.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResultAllOf } from './byte-array-result-all-of'; +import { ChosenDocumentTypeResult } from './chosen-document-type-result'; +import { DocBarCodeInfo } from './doc-bar-code-info'; +import { DocumentImageResult } from './document-image-result'; +import { DocumentPositionResult } from './document-position-result'; +import { DocumentTypesCandidatesResult } from './document-types-candidates-result'; +import { EncryptedRCLResult } from './encrypted-rclresult'; +import { GraphicsResult } from './graphics-result'; +import { ImageQualityResult } from './image-quality-result'; +import { ImagesResult } from './images-result'; +import { LexicalAnalysisResult } from './lexical-analysis-result'; +import { LicenseResult } from './license-result'; +import { ResultItem } from './result-item'; +import { StatusResult } from './status-result'; +import { TextDataResult } from './text-data-result'; +import { TextResult } from './text-result'; + +/** + * @type ByteArrayResult + * @export + */ +export type ByteArrayResult = ByteArrayResultAllOf & ResultItem; + + + diff --git a/src/models/chosen-document-type-result.ts b/src/models/chosen-document-type-result.ts index e7d54dfa..a6ffeb87 100644 --- a/src/models/chosen-document-type-result.ts +++ b/src/models/chosen-document-type-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResultAllOf } from './chosen-document-type-result-all-of'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/container-list.ts b/src/models/container-list.ts index 83968188..3c7a24af 100644 --- a/src/models/container-list.ts +++ b/src/models/container-list.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; @@ -43,10 +44,10 @@ export interface ContainerList { Count?: number; /** * - * @type {Array} + * @type {Array} * @memberof ContainerList */ - List: Array; + List: Array; } diff --git a/src/models/doc-bar-code-info.ts b/src/models/doc-bar-code-info.ts index 7df66387..dd6e87db 100644 --- a/src/models/doc-bar-code-info.ts +++ b/src/models/doc-bar-code-info.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfoAllOf } from './doc-bar-code-info-all-of'; import { DocBarCodeInfoFieldsList } from './doc-bar-code-info-fields-list'; diff --git a/src/models/document-image-result.ts b/src/models/document-image-result.ts index 0850c1ec..260b38ce 100644 --- a/src/models/document-image-result.ts +++ b/src/models/document-image-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResultAllOf } from './document-image-result-all-of'; diff --git a/src/models/document-position-result.ts b/src/models/document-position-result.ts index 5dc4d9ba..a0ed98a9 100644 --- a/src/models/document-position-result.ts +++ b/src/models/document-position-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/document-types-candidates-result.ts b/src/models/document-types-candidates-result.ts index 4c3665e8..b92ebb21 100644 --- a/src/models/document-types-candidates-result.ts +++ b/src/models/document-types-candidates-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/encrypted-rclresult.ts b/src/models/encrypted-rclresult.ts index ee9e5d6a..69f4a8cd 100644 --- a/src/models/encrypted-rclresult.ts +++ b/src/models/encrypted-rclresult.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/graphics-result.ts b/src/models/graphics-result.ts index 5975adfa..979b0d5b 100644 --- a/src/models/graphics-result.ts +++ b/src/models/graphics-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/image-quality-result.ts b/src/models/image-quality-result.ts index 444ea676..872d150e 100644 --- a/src/models/image-quality-result.ts +++ b/src/models/image-quality-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/images-result.ts b/src/models/images-result.ts index 0b758949..ba8830bc 100644 --- a/src/models/images-result.ts +++ b/src/models/images-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/index.ts b/src/models/index.ts index b6e3d031..79f9f7b4 100644 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -9,6 +9,8 @@ export * from './authenticity-result-all-of'; export * from './authenticity-result-type'; export * from './bc-pdf417-info'; export * from './bc-roidetect'; +export * from './byte-array-result'; +export * from './byte-array-result-all-of'; export * from './check-diagnose'; export * from './check-result'; export * from './chosen-document-type'; diff --git a/src/models/lexical-analysis-result.ts b/src/models/lexical-analysis-result.ts index a5d65068..dbd8c547 100644 --- a/src/models/lexical-analysis-result.ts +++ b/src/models/lexical-analysis-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/license-result.ts b/src/models/license-result.ts index 3a59456f..b9069df4 100644 --- a/src/models/license-result.ts +++ b/src/models/license-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/process-params.ts b/src/models/process-params.ts index f1e3a025..b5971d8b 100644 --- a/src/models/process-params.ts +++ b/src/models/process-params.ts @@ -35,6 +35,12 @@ import { TextPostProcessing } from './text-post-processing'; * @interface ProcessParams */ export interface ProcessParams { + /** + * This parameter is used to generate separate DTC-VC data container from RFID session data. + * @type {boolean} + * @memberof ProcessParams + */ + generateDTCVC?: boolean; /** * The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default. * @type {Array} diff --git a/src/models/process-request.ts b/src/models/process-request.ts index 775c5639..0502daa2 100644 --- a/src/models/process-request.ts +++ b/src/models/process-request.ts @@ -84,6 +84,12 @@ export interface ProcessRequest { * @memberof ProcessRequest */ passBackObject?: { [key: string]: object; }; + /** + * Digital Travel Credential (DTC-VC) data in base64 format for processing + * @type {string} + * @memberof ProcessRequest + */ + dtc?: string; /** * URLs to the document images for processing. * @type {Array} diff --git a/src/models/result-item.ts b/src/models/result-item.ts index ea670221..631e0611 100644 --- a/src/models/result-item.ts +++ b/src/models/result-item.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/result.ts b/src/models/result.ts index f37b180e..6419749e 100644 --- a/src/models/result.ts +++ b/src/models/result.ts @@ -123,7 +123,11 @@ export enum Result { /** * Contains RFID original graphics data */ - RFID_ORIGINAL_GRAPHICS = 105 + RFID_ORIGINAL_GRAPHICS = 105, + /** + * Digital Travel Credential data + */ + DTC_VC = 109 } diff --git a/src/models/status-result.ts b/src/models/status-result.ts index 64a7b857..dbb9abfc 100644 --- a/src/models/status-result.ts +++ b/src/models/status-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/src/models/text-data-result.ts b/src/models/text-data-result.ts index 87967dd1..5377c03d 100644 --- a/src/models/text-data-result.ts +++ b/src/models/text-data-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocVisualExtendedInfo } from './doc-visual-extended-info'; diff --git a/src/models/text-result.ts b/src/models/text-result.ts index e16b4876..3375891c 100644 --- a/src/models/text-result.ts +++ b/src/models/text-result.ts @@ -14,6 +14,7 @@ import { AuthenticityResult } from './authenticity-result'; +import { ByteArrayResult } from './byte-array-result'; import { ChosenDocumentTypeResult } from './chosen-document-type-result'; import { DocBarCodeInfo } from './doc-bar-code-info'; import { DocumentImageResult } from './document-image-result'; diff --git a/update-models.sh b/update-models.sh index 5c559323..7b377615 100755 --- a/update-models.sh +++ b/update-models.sh @@ -32,6 +32,7 @@ if [ "$(uname)" = "Darwin" ]; then sed -i '' '/import { OCRSecurityTextResult } /d' ./src/models/ocrsecurity-text-result.ts sed -i '' '/import { PhotoIdentResult } /d' ./src/models/photo-ident-result.ts sed -i '' '/import { SecurityFeatureResult } /d' ./src/models/security-feature-result.ts + sed -i '' '/import { ByteArrayResult } /d' ./src/models/byte-array-result.ts else sed -i '/import { TextResult } /d' ./src/models/text-result.ts sed -i '/import { AuthenticityResult } /d' ./src/models/authenticity-result.ts @@ -53,6 +54,7 @@ else sed -i '/import { OCRSecurityTextResult } /d' ./src/models/ocrsecurity-text-result.ts sed -i '/import { PhotoIdentResult } /d' ./src/models/photo-ident-result.ts sed -i '/import { SecurityFeatureResult } /d' ./src/models/security-feature-result.ts + sed -i '/import { ByteArrayResult } /d' ./src/models/byte-array-result.ts fi npm run format || exit 0