@regulaforensics/document-reader-webclient 6.9.2 → 6.9.3

package/src/models/text-field-value.ts

@@ -1,77 +0,0 @@
-/* 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: 6.9.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 { OriginalSymbol } from './original-symbol';
-import { RectangleCoordinates } from './rectangle-coordinates';
-import { RfidOrigin } from './rfid-origin';
-import { Source } from './source';
-
-/**
- * 
- * @export
- * @interface TextFieldValue
- */
-export interface TextFieldValue {
-    /**
-     * 
-     * @type {Source}
-     * @memberof TextFieldValue
-     */
-    source: Source;
-    /**
-     * Parsed/processed value. Date format converted for output, delimiters removed
-     * @type {string}
-     * @memberof TextFieldValue
-     */
-    value: string;
-    /**
-     * Original value as seen in the document
-     * @type {string}
-     * @memberof TextFieldValue
-     */
-    originalValue?: string;
-    /**
-     * 
-     * @type {Array<OriginalSymbol>}
-     * @memberof TextFieldValue
-     */
-    originalSymbols?: Array<OriginalSymbol>;
-    /**
-     * Page index of the image from input list
-     * @type {number}
-     * @memberof TextFieldValue
-     */
-    pageIndex: number;
-    /**
-     * Min recognition probability. Combined minimum probability from single characters probabilities
-     * @type {number}
-     * @memberof TextFieldValue
-     */
-    probability?: number;
-    /**
-     * 
-     * @type {RectangleCoordinates}
-     * @memberof TextFieldValue
-     */
-    fieldRect?: RectangleCoordinates;
-    /**
-     * 
-     * @type {RfidOrigin}
-     * @memberof TextFieldValue
-     */
-    rfidOrigin?: RfidOrigin;
-}
-
-

package/src/models/text-field.ts

@@ -1,91 +0,0 @@
-/* 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: 6.9.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 { CheckResult } from './check-result';
-import { CrossSourceValueComparison } from './cross-source-value-comparison';
-import { LCID } from './lcid';
-import { SourceValidity } from './source-validity';
-import { TextFieldType } from './text-field-type';
-import { TextFieldValue } from './text-field-value';
-
-/**
- * 
- * @export
- * @interface TextField
- */
-export interface TextField {
-    /**
-     * 
-     * @type {TextFieldType}
-     * @memberof TextField
-     */
-    fieldType: TextFieldType;
-    /**
-     * Field name. Only use to search values for fields with fieldType=50(other). In general, use fieldType for lookup.
-     * @type {string}
-     * @memberof TextField
-     */
-    fieldName: string;
-    /**
-     * 
-     * @type {LCID}
-     * @memberof TextField
-     */
-    lcid?: LCID;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof TextField
-     */
-    status: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof TextField
-     */
-    validityStatus: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof TextField
-     */
-    comparisonStatus: CheckResult;
-    /**
-     * The most confidence value, selected from valueList
-     * @type {string}
-     * @memberof TextField
-     */
-    value: string;
-    /**
-     * 
-     * @type {Array<TextFieldValue>}
-     * @memberof TextField
-     */
-    valueList: Array<TextFieldValue>;
-    /**
-     * Validity of all field values for given source. If there are two values on different pages for one field-source pair, then validity also will include logical match checking. If such values do not match, validity will return error.
-     * @type {Array<SourceValidity>}
-     * @memberof TextField
-     */
-    validityList: Array<SourceValidity>;
-    /**
-     * 
-     * @type {Array<CrossSourceValueComparison>}
-     * @memberof TextField
-     */
-    comparisonList: Array<CrossSourceValueComparison>;
-}
-
-

package/src/models/text-post-processing.ts

@@ -1,42 +0,0 @@
-/* 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: 6.9.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
- * @enum {string}
- */
-export enum TextPostProcessing {
-    /**
-    * Do not change
-    */
-    NO_CHANGE = 0,
-    /**
-    * Uppercase
-    */
-    UPPERCASE = 1,
-    /**
-    * Lowercase
-    */
-    LOWERCASE = 2,
-    /**
-    * Capital
-    */
-    CAPITAL = 3
-}
-
-
-

package/src/models/text-result-all-of.ts

@@ -1,32 +0,0 @@
-/* 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: 6.9.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 { Text } from './text';
-
-/**
- * 
- * @export
- * @interface TextResultAllOf
- */
-export interface TextResultAllOf {
-    /**
-     * 
-     * @type {Text}
-     * @memberof TextResultAllOf
-     */
-    Text: Text;
-}
-
-

package/src/models/text-result.ts

@@ -1,41 +0,0 @@
-/* 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: 6.9.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 { 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 { Text } from './text';
-import { TextDataResult } from './text-data-result';
-import { TextResultAllOf } from './text-result-all-of';
-
-/**
- * @type TextResult
- * @export
- */
-export type TextResult = ResultItem & TextResultAllOf;
-
-
-

package/src/models/text.ts

@@ -1,58 +0,0 @@
-/* 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: 6.9.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 { CheckResult } from './check-result';
-import { TextAvailableSource } from './text-available-source';
-import { TextField } from './text-field';
-
-/**
- * Contains all document text fields data with validity and cross-source compare checks
- * @export
- * @interface Text
- */
-export interface Text {
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof Text
-     */
-    status: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof Text
-     */
-    validityStatus: CheckResult;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof Text
-     */
-    comparisonStatus: CheckResult;
-    /**
-     * 
-     * @type {Array<TextField>}
-     * @memberof Text
-     */
-    fieldList: Array<TextField>;
-    /**
-     * 
-     * @type {Array<TextAvailableSource>}
-     * @memberof Text
-     */
-    availableSourceList: Array<TextAvailableSource>;
-}
-
-

package/src/models/tfdsidlist.ts

@@ -1,87 +0,0 @@
-/* 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 TFDSIDList
- */
-export interface TFDSIDList {
-    /**
-     * ICAO code of the issuing country
-     * @type {string}
-     * @memberof TFDSIDList
-     */
-    ICAO?: string;
-    /**
-     * Document identifiers in \'Information Reference Systems\'
-     * @type {Array<number>}
-     * @memberof TFDSIDList
-     */
-    List?: Array<number>;
-    /**
-     * 
-     * @type {DocumentType}
-     * @memberof TFDSIDList
-     */
-    dType?: DocumentType;
-    /**
-     * 
-     * @type {DocumentFormat}
-     * @memberof TFDSIDList
-     */
-    dFormat?: DocumentFormat;
-    /**
-     * Flag indicating the presence of MRZ on the document
-     * @type {boolean}
-     * @memberof TFDSIDList
-     */
-    dMRZ?: boolean;
-    /**
-     * Document description
-     * @type {string}
-     * @memberof TFDSIDList
-     */
-    dDescription?: string;
-    /**
-     * Year of publication of the document
-     * @type {string}
-     * @memberof TFDSIDList
-     */
-    dYear?: string;
-    /**
-     * Issuing country name
-     * @type {string}
-     * @memberof TFDSIDList
-     */
-    dCountryName?: string;
-    /**
-     * Issuing state code
-     * @type {string}
-     * @memberof TFDSIDList
-     */
-    dStateCode?: string;
-    /**
-     * Issuing state name
-     * @type {string}
-     * @memberof TFDSIDList
-     */
-    dStateName?: string;
-}
-
-

package/src/models/transaction-info.ts

@@ -1,49 +0,0 @@
-/* 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: 6.9.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 TransactionInfo
- */
-export interface TransactionInfo {
-    /**
-     * 
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    ComputerName?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    DateTime?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    TransactionID?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    UserName?: string;
-}
-
-

package/src/models/verification-result.ts

@@ -1,46 +0,0 @@
-/* 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: 6.9.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
- * @enum {string}
- */
-export enum VerificationResult {
-    /**
-    * Comparison result unknown
-    */
-    DISABLED = 0,
-    /**
-    * Verification passed
-    */
-    VERIFIED = 1,
-    /**
-    * Verification failed
-    */
-    NOT_VERIFIED = 2,
-    /**
-    * Positive comparison result
-    */
-    COMPARE_MATCH = 3,
-    /**
-    * Negative comparison result
-    */
-    COMPARE_NOT_MATCH = 4
-}
-
-
-

package/src/models/verified-field-map.ts

@@ -1,70 +0,0 @@
-/* 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: 6.9.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 { LCID } from './lcid';
-import { TextFieldType } from './text-field-type';
-import { VerificationResult } from './verification-result';
-
-/**
- * 
- * @export
- * @interface VerifiedFieldMap
- */
-export interface VerifiedFieldMap {
-    /**
-     * 
-     * @type {TextFieldType}
-     * @memberof VerifiedFieldMap
-     */
-    wFieldType?: TextFieldType;
-    /**
-     * 
-     * @type {LCID}
-     * @memberof VerifiedFieldMap
-     */
-    wLCID?: LCID;
-    /**
-     * Field data extracted from mrz(machine readable zone)
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_MRZ?: string;
-    /**
-     * Field data extracted from visual zone
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_Visual?: string;
-    /**
-     * Field data extracted from barcode
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_Barcode?: string;
-    /**
-     * Field data extracted from rfid chip
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_RFID?: string;
-    /**
-     * results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.
-     * @type {Array<VerificationResult>}
-     * @memberof VerifiedFieldMap
-     */
-    Matrix?: Array<VerificationResult>;
-}
-
-

package/src/models/visibility.ts

@@ -1,46 +0,0 @@
-/* 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: 6.9.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-
-/**
- * Enumeration contains visibility status of the security element
- * @export
- * @enum {string}
- */
-export enum Visibility {
-    /**
-    * Invisible
-    */
-    INVISIBLE = 0,
-    /**
-    * Visible
-    */
-    VISIBLE = 1,
-    /**
-    * Colored
-    */
-    COLORED = 2,
-    /**
-    * Grayscale
-    */
-    GRAYSCALE = 4,
-    /**
-    * Visible vs IR match
-    */
-    WHITE_IR_MATCHING = 8
-}
-
-
-

package/src/models/visual-ocr-extended-result.ts

@@ -1,38 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Regula Document Reader Web API
- * Regula Document Reader Web API
- *
- * The version of the OpenAPI document: 5.1.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 { BarcodeTextDataResult } from './barcode-text-data-result';
-import { ChosenDocumentTypeResult } from './chosen-document-type-result';
-import { DocVisualExtendedInfo } from './doc-visual-extended-info';
-import { DocumentTypesCandidatesResult } from './document-types-candidates-result';
-import { GraphicsResult } from './graphics-result';
-import { LexicalAnalysisResult } from './lexical-analysis-result';
-import { MrzOcrExtendedResult } from './mrz-ocr-extended-result';
-import { MrzOcrExtendedResultAllOf } from './mrz-ocr-extended-result-all-of';
-import { RawImageResult } from './raw-image-result';
-import { ResultItem } from './result-item';
-import { RfidTextDataResult } from './rfid-text-data-result';
-import { StatusResult } from './status-result';
-import { TextResult } from './text-result';
-
-/**
- * @type VisualOcrExtendedResult
- * Text fields from document OCR with symbol probabilities
- * @export
- */
-export type VisualOcrExtendedResult = MrzOcrExtendedResultAllOf & ResultItem;
-
-
-