Merge pull request #188 from regulaforensics/feature/sp-19783

SP-19783 - add TransactionInfo to the top level

Author: ArtsiomTsybulko

src/.openapi-generator/FILES

@@ -46,6 +46,7 @@ models/document-types-candidates-list.ts
 models/document-types-candidates-result-all-of.ts
 models/document-types-candidates-result.ts
 models/document-types-candidates.ts
+models/documents-database.ts
 models/encrypted-rclresult-all-of.ts
 models/encrypted-rclresult.ts
 models/face-api-search.ts

src/ext/process-response.ts

@@ -30,21 +30,27 @@ export class Response {
     status?: Status;
     text?: TextExt;
     images?: ImagesExt;
+    TransactionInfo: TransactionInfo;
 
     lowLvlResponse: LowLvlResponse;
     rawResponse: ProcessResponse | InlineResponse2001;
 
     constructor(original: ProcessResponse | InlineResponse2001) {
         const lowLvlResponse = new LowLvlResponse(original);
+        const statusResult = lowLvlResponse.statusResult()?.Status;
+        const textResult = lowLvlResponse.textResult();
+        const imagesResult = lowLvlResponse.imagesResult();
+
         this.lowLvlResponse = lowLvlResponse;
         this.rawResponse = original;
+        this.TransactionInfo = original.TransactionInfo || {};
 
-        this.status = lowLvlResponse.statusResult()?.Status;
-        const textResult = lowLvlResponse.textResult();
+        if (statusResult) {
+            this.status = statusResult;
+        }
         if (textResult) {
             this.text = new TextExt(textResult.Text);
         }
-        const imagesResult = lowLvlResponse.imagesResult();
         if (imagesResult) {
             this.images = new ImagesExt(imagesResult.Images);
         }

src/models/documents-database.ts

@@ -0,0 +1,49 @@
+/* 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.
+ */
+
+
+
+/**
+ * Document database information
+ * @export
+ * @interface DocumentsDatabase
+ */
+export interface DocumentsDatabase {
+    /**
+     * Document database description
+     * @type {string}
+     * @memberof DocumentsDatabase
+     */
+    Description?: string;
+    /**
+     * Date the document database was created
+     * @type {string}
+     * @memberof DocumentsDatabase
+     */
+    ExportDate?: string;
+    /**
+     * Document database identifier
+     * @type {string}
+     * @memberof DocumentsDatabase
+     */
+    ID?: string;
+    /**
+     * Document database version
+     * @type {string}
+     * @memberof DocumentsDatabase
+     */
+    Version?: string;
+}
+
+

src/models/index.ts

@@ -41,6 +41,7 @@ export * from './document-types-candidates';
 export * from './document-types-candidates-list';
 export * from './document-types-candidates-result';
 export * from './document-types-candidates-result-all-of';
+export * from './documents-database';
 export * from './encrypted-rclresult';
 export * from './encrypted-rclresult-all-of';
 export * from './fdsidlist';

src/models/process-params.ts

@@ -380,6 +380,12 @@ export interface ProcessParams {
      * @memberof ProcessParams
      */
     strictBarcodeDigitalSignatureCheck?: boolean;
+    /**
+     * Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    selectLongestNames?: boolean;
 }
 
 

src/models/transaction-info.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { DocumentsDatabase } from './documents-database';
 
 /**
  * 
@@ -21,29 +22,53 @@
  */
 export interface TransactionInfo {
     /**
-     * 
+     * Computer name
      * @type {string}
      * @memberof TransactionInfo
      */
     ComputerName?: string;
     /**
-     * 
+     * Date and time
      * @type {string}
      * @memberof TransactionInfo
      */
     DateTime?: string;
     /**
      * 
+     * @type {DocumentsDatabase}
+     * @memberof TransactionInfo
+     */
+    DocumentsDatabase?: DocumentsDatabase;
+    /**
+     * System information
+     * @type {string}
+     * @memberof TransactionInfo
+     */
+    SystemInfo?: string;
+    /**
+     * Transaction tag
+     * @type {string}
+     * @memberof TransactionInfo
+     */
+    Tag?: string;
+    /**
+     * Transaction identifier
      * @type {string}
      * @memberof TransactionInfo
      */
     TransactionID?: string;
     /**
-     * 
+     * User name
      * @type {string}
      * @memberof TransactionInfo
      */
     UserName?: string;
+    /**
+     * SDK version
+     * @type {string}
+     * @memberof TransactionInfo
+     */
+    Version?: string;
 }
 
 

src/models/transaction-process-request.ts

@@ -66,6 +66,12 @@ export interface TransactionProcessRequest {
      * @memberof TransactionProcessRequest
      */
     passBackObject?: { [key: string]: object; };
+    /**
+     * Digital Travel Credential (DTC-VC) data in base64 format for processing
+     * @type {string}
+     * @memberof TransactionProcessRequest
+     */
+    dtc?: string;
 }