Merge pull request #187 from regulaforensics/feature/sp-19158

ArtsiomTsybulko · web-flow · commit fa41fc4da202 · 2024-11-20T15:19:56.000+03:00
SP-19158 - add DTC
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>}
+     * @type {Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult | ByteArrayResult>}
      * @memberof ContainerList
      */
-    List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>;
+    List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult | ByteArrayResult>;
 }
 
 
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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<number>}
diff --git 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<string>}
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
