5.3.0.beta1 (#10)

Author: hleb-albau

src/.openapi-generator/FILES

@@ -7,6 +7,7 @@ models/container-list.ts
 models/cross-source-value-comparison.ts
 models/details-optical.ts
 models/details-rfid.ts
+models/device-info.ts
 models/doc-visual-extended-field.ts
 models/doc-visual-extended-info.ts
 models/document-format.ts
@@ -17,6 +18,7 @@ models/document-type.ts
 models/document-types-candidates-list.ts
 models/document-types-candidates-result-all-of.ts
 models/document-types-candidates-result.ts
+models/fdsidlist.ts
 models/graphic-field-type.ts
 models/graphic-field.ts
 models/graphic-fields-list.ts
@@ -66,7 +68,6 @@ models/text-field.ts
 models/text-result-all-of.ts
 models/text-result.ts
 models/text.ts
-models/tfdsidlist.ts
 models/transaction-info.ts
 models/verification-result.ts
 models/verified-field-map.ts

src/.openapi-generator/VERSION

@@ -1 +1 @@
-5.0.0-SNAPSHOT
+5.0.0-beta2

src/configuration.ts

@@ -17,7 +17,7 @@ export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
-    accessToken?: string | ((name?: string, scopes?: string[]) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     basePath?: string;
     baseOptions?: any;
 }
@@ -31,14 +31,14 @@ export class Configuration {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     * 
+     *
      * @type {string}
      * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     * 
+     *
      * @type {string}
      * @memberof Configuration
      */
@@ -49,10 +49,10 @@ export class Configuration {
      * @param scopes oauth2 scope
      * @memberof Configuration
      */
-    accessToken?: string | ((name?: string, scopes?: string[]) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     * 
+     *
      * @type {string}
      * @memberof Configuration
      */

src/ext/text-field.ts

@@ -11,6 +11,7 @@ export class TextField implements BaseTextField {
 
   // see BaseTextField for docs
   fieldType: TextFieldType;
+  fieldName: string;
   lcid?: number;
 
   status: CheckResult;
@@ -24,6 +25,7 @@ export class TextField implements BaseTextField {
 
   constructor(origin: BaseTextField) {
     this.fieldType = origin.fieldType
+    this.fieldName = origin.fieldName
     this.lcid = origin.lcid
     this.status = origin.status
     this.validityStatus = origin.validityStatus

src/models/device-info.ts

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula Document Reader Web API
+ * Regula Document Reader Web API
+ *
+ * The version of the OpenAPI document: 5.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 DeviceInfo
+ */
+export interface DeviceInfo {
+    /**
+     * 
+     * @type {string}
+     * @memberof DeviceInfo
+     */
+    app_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeviceInfo
+     */
+    version?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeviceInfo
+     */
+    license_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeviceInfo
+     */
+    license_serial?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeviceInfo
+     */
+    valid_until?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeviceInfo
+     */
+    server_time?: string;
+}
+
+

src/models/doc-visual-extended-field.ts

@@ -30,6 +30,12 @@ export interface DocVisualExtendedField {
      * @memberof DocVisualExtendedField
      */
     wFieldType: TextFieldType;
+    /**
+     * Field name. Only use to search values for fields with fieldType=50(other). In general, use wFieldType for lookup.
+     * @type {string}
+     * @memberof DocVisualExtendedField
+     */
+    FieldName: string;
     /**
      * 
      * @type {LCID}

src/models/fdsidlist.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Regula Document Reader Web API
+ * Regula Document Reader Web API
+ *
+ * The version of the OpenAPI document: 5.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 { DocumentFormat } from './document-format';
+import { DocumentType } from './document-type';
+
+/**
+ * Extended document type info and Regula\'s \'Information Reference Systems\' links
+ * @export
+ * @interface FDSIDList
+ */
+export interface FDSIDList {
+    /**
+     * ICAO code of the issuing country
+     * @type {string}
+     * @memberof FDSIDList
+     */
+    ICAO?: string;
+    /**
+     * Document identifiers in \'Information Reference Systems\'
+     * @type {Array<number>}
+     * @memberof FDSIDList
+     */
+    List?: Array<number>;
+    /**
+     * 
+     * @type {DocumentType}
+     * @memberof FDSIDList
+     */
+    dType?: DocumentType;
+    /**
+     * 
+     * @type {DocumentFormat}
+     * @memberof FDSIDList
+     */
+    dFormat?: DocumentFormat;
+    /**
+     * Flag indicating the presence of MRZ on the document
+     * @type {boolean}
+     * @memberof FDSIDList
+     */
+    dMRZ?: boolean;
+    /**
+     * Document description
+     * @type {string}
+     * @memberof FDSIDList
+     */
+    dDescription?: string;
+    /**
+     * Year of publication of the document
+     * @type {string}
+     * @memberof FDSIDList
+     */
+    dYear?: string;
+    /**
+     * Issuing country name
+     * @type {string}
+     * @memberof FDSIDList
+     */
+    dCountryName?: string;
+    /**
+     * Issuing state code
+     * @type {string}
+     * @memberof FDSIDList
+     */
+    dStateCode?: string;
+    /**
+     * Issuing state name
+     * @type {string}
+     * @memberof FDSIDList
+     */
+    dStateName?: string;
+}
+
+

src/models/index.ts

@@ -5,6 +5,7 @@ export * from './container-list.js';
 export * from './cross-source-value-comparison.js';
 export * from './details-optical.js';
 export * from './details-rfid.js';
+export * from './device-info.js';
 export * from './doc-visual-extended-field.js';
 export * from './doc-visual-extended-info.js';
 export * from './document-format.js';
@@ -15,6 +16,7 @@ export * from './document-type-recognition-result.js';
 export * from './document-types-candidates-list.js';
 export * from './document-types-candidates-result.js';
 export * from './document-types-candidates-result-all-of.js';
+export * from './fdsidlist.js';
 export * from './graphic-field.js';
 export * from './graphic-field-type.js';
 export * from './graphic-fields-list.js';
@@ -54,7 +56,6 @@ export * from './status-result-all-of.js';
 export * from './string-recognition-result.js';
 export * from './symbol-candidate.js';
 export * from './symbol-recognition-result.js';
-export * from './tfdsidlist.js';
 export * from './text.js';
 export * from './text-available-source.js';
 export * from './text-data-result.js';

src/models/one-candidate.ts

@@ -13,8 +13,8 @@
  */
 
 
+import { FDSIDList } from './fdsidlist';
 import { RfidLocation } from './rfid-location';
-import { TFDSIDList } from './tfdsidlist';
 
 /**
  * Contains information about one document type candidate
@@ -48,10 +48,10 @@ export interface OneCandidate {
     RFID_Presence?: RfidLocation;
     /**
      * 
-     * @type {TFDSIDList}
+     * @type {FDSIDList}
      * @memberof OneCandidate
      */
-    FDSIDList?: TFDSIDList;
+    FDSIDList?: FDSIDList;
     /**
      * Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document
      * @type {number}

src/models/process-params.ts

@@ -71,6 +71,18 @@ export interface ProcessParams {
      * @memberof ProcessParams
      */
     customParams?: { [key: string]: object; };
+    /**
+     * This option can be set to true if you need to get base64 string of transaction processing log.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    log?: boolean;
+    /**
+     * Force use of specific template ID and skip document type identification step.
+     * @type {number}
+     * @memberof ProcessParams
+     */
+    forceDocID?: number;
 }