@regulaforensics/document-reader-webclient 6.5.2 → 6.6.1-beta.0

package/src/models/graphic-field-type.ts

@@ -1,126 +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.5.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 GraphicFieldType {
-    /**
-    * Document holder photo
-    */
-    PORTRAIT = 201,
-    /**
-    * Fingerprint of document holder
-    */
-    FINGERPRINT = 202,
-    /**
-    * Image of the iris of document holder
-    */
-    EYE = 203,
-    /**
-    * Signature of document holder
-    */
-    SIGNATURE = 204,
-    /**
-    * Barcode image
-    */
-    BAR_CODE = 205,
-    /**
-    * Image of document confirming owner citizenship
-    */
-    PROOF_OF_CITIZENSHIP = 206,
-    /**
-    * Cropped and rotated with perspective compensation (front side) of a document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most coordinates in other types defined on that image.
-    */
-    DOCUMENT_FRONT = 207,
-    /**
-    * Image of the rear side of the document
-    */
-    DOCUMENT_REAR = 208,
-    /**
-    * Area with dynamic color change
-    */
-    COLOR_DYNAMIC = 209,
-    /**
-    * Additional Portrait
-    */
-    GHOST_PORTRAIT = 210,
-    /**
-    * Stamp
-    */
-    STAMP = 211,
-    /**
-    * Undefined image type
-    */
-    OTHER = 250,
-    /**
-    * Fingerprint (thumb, left hand)
-    */
-    FINGER_LEFT_THUMB = 300,
-    /**
-    * Fingerprint (index, left hand)
-    */
-    FINGER_LEFT_INDEX = 301,
-    /**
-    * Fingerprint (middle, left hand)
-    */
-    FINGER_LEFT_MIDDLE = 302,
-    /**
-    * Fingerprint (ring, left hand)
-    */
-    FINGER_LEFT_RING = 303,
-    /**
-    * Fingerprint (little, left hand)
-    */
-    FINGER_LEFT_LITTLE = 304,
-    /**
-    * Fingerprint (thumb, right hand)
-    */
-    FINGER_RIGHT_THUMB = 305,
-    /**
-    * Fingerprint (index, right hand)
-    */
-    FINGER_RIGHT_INDEX = 306,
-    /**
-    * Fingerprint (middle, right hand)
-    */
-    FINGER_RIGHT_MIDDLE = 307,
-    /**
-    * Fingerprint (ring, right hand)
-    */
-    FINGER_RIGHT_RING = 308,
-    /**
-    * Fingerprint (little, right hand)
-    */
-    FINGER_RIGHT_LITTLE = 309,
-    /**
-    * Fingerprint (four without thumb on right hand)
-    */
-    FINGER_RIGHT_FOUR_FINGERS = 313,
-    /**
-    * Fingerprint (four without thumb on left hand
-    */
-    FINGER_LEFT_FOUR_FINGERS = 314,
-    /**
-    * Fingerprint (two thumbs)
-    */
-    FINGER_TWO_THUMBS = 315
-}
-
-
-

package/src/models/graphic-field.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.5.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 { GraphicFieldType } from './graphic-field-type';
-import { ImageData } from './image-data';
-import { RectangleCoordinates } from './rectangle-coordinates';
-
-/**
- * 
- * @export
- * @interface GraphicField
- */
-export interface GraphicField {
-    /**
-     * 
-     * @type {GraphicFieldType}
-     * @memberof GraphicField
-     */
-    FieldType: GraphicFieldType;
-    /**
-     * 
-     * @type {ImageData}
-     * @memberof GraphicField
-     */
-    image: ImageData;
-    /**
-     * 
-     * @type {RectangleCoordinates}
-     * @memberof GraphicField
-     */
-    FieldRect?: RectangleCoordinates;
-    /**
-     * Source data group file. Only for Result.RFID_GRAPHICS result.
-     * @type {number}
-     * @memberof GraphicField
-     */
-    RFID_OriginDG?: number;
-    /**
-     * Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result.
-     * @type {number}
-     * @memberof GraphicField
-     */
-    RFID_OriginDGTag?: number;
-    /**
-     * Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result.
-     * @type {number}
-     * @memberof GraphicField
-     */
-    RFID_OriginTagEntry?: number;
-    /**
-     * Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result.
-     * @type {number}
-     * @memberof GraphicField
-     */
-    RFID_OriginEntryView?: number;
-}
-
-

package/src/models/graphic-fields-list.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.5.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 { GraphicField } from './graphic-field';
-
-/**
- * 
- * @export
- * @interface GraphicFieldsList
- */
-export interface GraphicFieldsList {
-    /**
-     * 
-     * @type {Array<GraphicField>}
-     * @memberof GraphicFieldsList
-     */
-    pArrayFields: Array<GraphicField>;
-}
-
-

package/src/models/graphics-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.5.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 { GraphicFieldsList } from './graphic-fields-list';
-
-/**
- * 
- * @export
- * @interface GraphicsResultAllOf
- */
-export interface GraphicsResultAllOf {
-    /**
-     * 
-     * @type {GraphicFieldsList}
-     * @memberof GraphicsResultAllOf
-     */
-    DocGraphicsInfo?: GraphicFieldsList;
-}
-
-

package/src/models/graphics-result.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.5.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 { GraphicFieldsList } from './graphic-fields-list';
-import { GraphicsResultAllOf } from './graphics-result-all-of';
-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 GraphicsResult
- * Graphic fields extracted from one of the document sources. Returns separate results for each provided page.
- * @export
- */
-export type GraphicsResult = GraphicsResultAllOf & ResultItem;
-
-
-

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

@@ -1,72 +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.5.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 { AreaContainer } from './area-container';
-import { ImageData } from './image-data';
-import { Light } from './light';
-import { RectangleCoordinates } from './rectangle-coordinates';
-import { SecurityFeatureType } from './security-feature-type';
-
-/**
- * 
- * @export
- * @interface IdentResultAllOf
- */
-export interface IdentResultAllOf {
-    /**
-     * 
-     * @type {SecurityFeatureType}
-     * @memberof IdentResultAllOf
-     */
-    ElementType?: SecurityFeatureType;
-    /**
-     * 
-     * @type {Light}
-     * @memberof IdentResultAllOf
-     */
-    LightIndex?: Light;
-    /**
-     * 
-     * @type {RectangleCoordinates}
-     * @memberof IdentResultAllOf
-     */
-    Area?: RectangleCoordinates;
-    /**
-     * 
-     * @type {ImageData}
-     * @memberof IdentResultAllOf
-     */
-    Image?: ImageData;
-    /**
-     * 
-     * @type {ImageData}
-     * @memberof IdentResultAllOf
-     */
-    EtalonImage?: ImageData;
-    /**
-     * Probability percent for IMAGE_PATTERN check or element\'s visibility for IR_VISIBILITY
-     * @type {number}
-     * @memberof IdentResultAllOf
-     */
-    PercentValue?: number;
-    /**
-     * 
-     * @type {AreaContainer}
-     * @memberof IdentResultAllOf
-     */
-    AreaList?: AreaContainer;
-}
-
-

package/src/models/ident-result.ts

@@ -1,37 +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.5.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 { AreaContainer } from './area-container';
-import { AuthenticityCheckResultItem } from './authenticity-check-result-item';
-import { CheckDiagnose } from './check-diagnose';
-import { CheckResult } from './check-result';
-import { FiberResult } from './fiber-result';
-import { IdentResultAllOf } from './ident-result-all-of';
-import { ImageData } from './image-data';
-import { Light } from './light';
-import { OCRSecurityTextResult } from './ocrsecurity-text-result';
-import { PhotoIdentResult } from './photo-ident-result';
-import { RectangleCoordinates } from './rectangle-coordinates';
-import { SecurityFeatureResult } from './security-feature-result';
-import { SecurityFeatureType } from './security-feature-type';
-
-/**
- * @type IdentResult
- * @export
- */
-export type IdentResult = AuthenticityCheckResultItem & IdentResultAllOf;
-
-
-

package/src/models/image-data.ts

@@ -1,31 +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.5.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 ImageData
- */
-export interface ImageData {
-    /**
-     * Base64 encoded image
-     * @type {string}
-     * @memberof ImageData
-     */
-    image: string;
-}
-
-

package/src/models/image-qa.ts

@@ -1,61 +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.5.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 ImageQA
- */
-export interface ImageQA {
-    /**
-     * This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.
-     * @type {number}
-     * @memberof ImageQA
-     */
-    dpiThreshold?: number;
-    /**
-     * This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.
-     * @type {number}
-     * @memberof ImageQA
-     */
-    angleThreshold?: number;
-    /**
-     * This option enables focus check while performing image quality validation.
-     * @type {boolean}
-     * @memberof ImageQA
-     */
-    focusCheck?: boolean;
-    /**
-     * This option enables glares check while performing image quality validation.
-     * @type {boolean}
-     * @memberof ImageQA
-     */
-    glaresCheck?: boolean;
-    /**
-     * This option enables colorness check while performing image quality validation.
-     * @type {boolean}
-     * @memberof ImageQA
-     */
-    colornessCheck?: boolean;
-    /**
-     * This option enables screen capture (moire patterns) check while performing image quality validation.
-     * @type {boolean}
-     * @memberof ImageQA
-     */
-    moireCheck?: boolean;
-}
-
-

package/src/models/image-quality-check-list.ts

@@ -1,39 +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.5.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 { ImageQualityCheck } from './image-quality-check';
-
-/**
- * 
- * @export
- * @interface ImageQualityCheckList
- */
-export interface ImageQualityCheckList {
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof ImageQualityCheckList
-     */
-    result: CheckResult;
-    /**
-     * 
-     * @type {Array<ImageQualityCheck>}
-     * @memberof ImageQualityCheckList
-     */
-    List: Array<ImageQualityCheck>;
-}
-
-

package/src/models/image-quality-check-type.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.5.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-
-/**
- * Image quality check type
- * @export
- * @enum {string}
- */
-export enum ImageQualityCheckType {
-    /**
-    * Signals glare presence on the image
-    */
-    ImageGlares = 0,
-    /**
-    * Signals whether image is in focus
-    */
-    ImageFocus = 1,
-    /**
-    * Signals if image resolution is below threshold
-    */
-    ImageResolution = 2,
-    /**
-    * Signals if image is colorless
-    */
-    ImageColorness = 3,
-    /**
-    * Signals if document in the image has prespective distortion above threshold
-    */
-    Perspective = 4,
-    /**
-    * Signals if document is not fully present in the image
-    */
-    Bounds = 5,
-    /**
-    * Signals if an image is captured from screen
-    */
-    ScreenCapture = 6,
-    /**
-    * Signals if the portrait is present
-    */
-    Portrait = 7
-}
-
-
-

package/src/models/image-quality-check.ts

@@ -1,71 +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.5.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 { AreaArray } from './area-array';
-import { CheckResult } from './check-result';
-import { ImageQualityCheckType } from './image-quality-check-type';
-import { SecurityFeatureType } from './security-feature-type';
-
-/**
- * 
- * @export
- * @interface ImageQualityCheck
- */
-export interface ImageQualityCheck {
-    /**
-     * 
-     * @type {ImageQualityCheckType}
-     * @memberof ImageQualityCheck
-     */
-    type?: ImageQualityCheckType;
-    /**
-     * 
-     * @type {CheckResult}
-     * @memberof ImageQualityCheck
-     */
-    result?: CheckResult;
-    /**
-     * 
-     * @type {SecurityFeatureType}
-     * @memberof ImageQualityCheck
-     */
-    featureType?: SecurityFeatureType;
-    /**
-     * 
-     * @type {AreaArray}
-     * @memberof ImageQualityCheck
-     */
-    areas?: AreaArray;
-    /**
-     * 
-     * @type {number}
-     * @memberof ImageQualityCheck
-     */
-    mean?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof ImageQualityCheck
-     */
-    std_dev?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof ImageQualityCheck
-     */
-    probability?: number;
-}
-
-